Add verbosity to the command line

.github/workflows/release.yml

@@ -117,13 +117,15 @@ jobs:
       version: ${{ steps.get_version.outputs.VERSION }}
       build_date: ${{ steps.get_version.outputs.BUILD_DATE }}
       is_prerelease: ${{ steps.get_version.outputs.IS_PRERELEASE }}
+
     steps:
       - uses: actions/checkout@v3
       - name: Check version
         id: get_version
         uses: digicatapult/check-version@v1
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
+
   publish-gh:
     name: 'Publish Github package'
     needs:

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@digicatapult/dscp-process-management",
-  "version": "1.7.43",
+  "version": "1.7.44",
   "description": "DSCP Process Management Flow",
   "main": "./lib/index.js",
   "bin": {

src/index.ts

@@ -3,7 +3,7 @@
 import chalk from 'chalk'
 import { Command } from 'commander'
 
-import { loadProcesses, disableProcess } from './lib/process/index.js'
+import { loadProcesses, disableProcess, listTransforming } from './lib/process/index.js'
 import { getAll } from './lib/process/api.js'
 import cliVersion from './version.js'
 
@@ -42,46 +42,24 @@ program
 program
   .command('list')
   .description('A command for listing all active process flows')
+  .option('--verbose', 'Returns all information about the transation, default - false')
   .option('-h, --host <host>', 'substrate blockchain host address or FQDM, default - "localhost"', 'localhost')
   .option('-p, --port <port>', 'specify host port number if it is not a default, default - 9944', '9944')
   .option('--raw', 'print processes with hex values and extra keys such as "createdAtHash"')
   .option('--active', 'returns only active process flows')
   .option('--disabled', 'returns only disabled process flows')
-  .option('--print', 'print debugging info')
   .action(async (options: Process.CLIOptions) => {
+
     if (options.print)
       log(`
       retrieving all process flows from a chain...
       options: ${b(JSON.stringify(options))}
     `)
     try {
       const res: Process.RawPayload[] = await getAll(mapOptions(options))
-      const { raw, active, disabled } = options
-
       let processes: Process.RawPayload[]
-      if (active) {
-        processes = res.filter(({ status }) => status === 'Enabled')
-      } else if (disabled) {
-        processes = res.filter(({ status }) => status === 'Disabled')
-      } else {
-        processes = res
-      }
-
-      if (raw) {
-        dir(processes, { depth: null })
-      } else {
-        dir(
-          processes.map((p) => {
-            return {
-              id: p.id,
-              version: p.version,
-              status: p.status,
-              program: p.program,
-            }
-          }),
-          { depth: null }
-        )
-      }
+
+      listTransforming(res, processes, options)
 
       process.exit(0)
     } catch (err) {
@@ -94,9 +72,9 @@ program
   .command('create')
   .description('A command for persisting process flows onto the chain')
   .option('--dryRun', 'to validate process and response locally before persisting on the chain, default - false')
+  .option('--verbose', 'Returns all information about the transation, default - false')
   .option('-h, --host <host>', 'substrate blockchain host address or FQDM, default - "localhost"', 'localhost')
   .option('-p, --port <port>', 'specify host port number if it is not a default, default - 9944', '9944')
-  .option('--print', 'print debugging info')
   .requiredOption('-u, --user <user>', 'specify substrate blockchain user URI')
   .argument('<json>', `takes JSON as string example: '${example}'`)
   .action(async (data: string, options: Process.CLIOptions) => {
@@ -106,9 +84,9 @@ program
       options: ${b(JSON.stringify(options))}
       program: ${b(data)}
     `)
-    const { dryRun } = options
+    const { dryRun, verbose } = options
     try {
-      const res: Process.Response = await loadProcesses({ data, dryRun, options: mapOptions(options) })
+      const res: Process.Response = await loadProcesses({ data, dryRun, options: mapOptions(options), verbose })
       dir(res, { depth: null })
       process.exit(0)
     } catch (err) {
@@ -123,7 +101,6 @@ program
   .option('--dryRun', 'to validate process and response locally before persisting on the chain, default - false')
   .option('-h, --host <host>', 'substrate blockchain host address or FQDM, default - "localhost"', 'localhost')
   .option('-p, --port <port>', 'specify host port number if it is not a default, default - 9944', '9944')
-  .option('--print', 'print debugging info')
   .requiredOption('-u, --user <user>', 'specify substrate blockchain user URI')
   .argument('<id>', 'a valid process id that you would like to disable')
   .argument('<version>', 'a version number of a process')

src/lib/process/api.ts

@@ -19,7 +19,8 @@ export const createProcessTransaction = async (
   polkadot: Polkadot.Polkadot,
   processId: string,
   program: Process.Program,
-  options: Polkadot.Options
+  options: Polkadot.Options,
+  verbose?: boolean
 ): Promise<Process.Payload> => {
   const sudo = polkadot.keyring.addFromUri(options.USER_URI)
 
@@ -43,6 +44,11 @@ export const createProcessTransaction = async (
             program,
           }
 
+          if(verbose == false)
+          {
+            delete newProcess.program
+          }
+
           unsub()
           resolve(newProcess)
         }
@@ -125,7 +131,8 @@ export const getVersion = async (polkadot: Polkadot.Polkadot, processId: string)
 export const getProcess = async (
   polkadot: Polkadot.Polkadot,
   processId: string,
-  version: number
+  version: number,
+  verbose: boolean = false
 ): Promise<Process.Payload> => {
   const result = await polkadot.api.query.processValidation.processModel(processId, version)
   const data = Object(result.toHuman())

src/lib/process/index.ts

@@ -36,28 +36,59 @@ export const loadProcesses = async ({
   data,
   options,
   dryRun,
+  verbose,
 }: {
   data: string
   options?: Polkadot.Options
   dryRun?: boolean
+  verbose?: boolean
 }): Promise<Process.Response> => {
   const res: Process.Response = {}
   const processes: Process.CLIParsed = JSON.parse(data)
   // TODO more elegant promise.series way.
   for (let i = 0; i < processes.length; i++) {
     const { name, version, program } = processes[i]
-    res[name] = await createProcess(name, version, program, dryRun, options)
+    res[name] = await createProcess(name, version, program, dryRun, options, verbose)
   }
 
   return res
 }
 
+export const listTransforming = async (
+  res: Process.RawPayload[], 
+  processes: Process.RawPayload[], 
+  options: Process.CLIOptions) => {
+  if (options.active) {
+    processes = res.filter(({ status }) => status === 'Enabled')
+  } else if (options.disabled) {
+    processes = res.filter(({ status }) => status === 'Disabled')
+  } else {
+    processes = res
+  }
+
+  if (options.raw) {
+    return processes
+  } else{
+    return(
+      processes.map((p) => {
+        return {
+          id: p.id,
+          version: p.version,
+          status: p.status,
+          ...options.verbose ? { program: p.program } : { }
+        }
+      })
+    )
+  }
+}
+
 export const createProcess = async (
   name: string,
   version: number,
   userProgram: Process.Program,
   dryRun: boolean = false,
-  options: Polkadot.Options = defaultOptions
+  options: Polkadot.Options = defaultOptions,
+  verbose: boolean = false,
 ): Promise<Process.Result> => {
   try {
 
@@ -84,6 +115,7 @@ export const createProcess = async (
         process,
       }
     }
+
 
     if (dryRun)
       return {
@@ -96,14 +128,16 @@ export const createProcess = async (
 
     return {
       message: `Transaction for new process ${name} has been successfully submitted`,
-      process: await createProcessTransaction(polkadot, processId, program, options),
+      process: await createProcessTransaction(polkadot, processId, program, options, verbose),
     }
   } catch (err) {
     // err is basically from errors.ts or any exception
     // process errors will comntain specific messages and/or process
     // Promise<Process.Result> is in try {} and any exception is in catch {}
     return err
   }
+
+
 }
 
 export const disableProcess = async (

src/lib/types/process.d.ts

@@ -39,6 +39,7 @@ declare namespace Process {
     port: string
     user: string
     host: string
+    verbose?: boolean
   }
   export type CLIParsed = Core[]
   export type Program = ProgramStep[]