@veramo/cli 5.0.1-next.11 → 5.0.1-next.13

package/package.json

@@ -1,9 +1,27 @@
 {
   "name": "@veramo/cli",
   "description": "Veramo command line application.",
-  "version": "5.0.1-next.11+672f92b1",
+  "version": "5.0.1-next.13+9c73d98f",
+  "exports": {
+    ".": {
+      "types": "./build/cli.d.ts",
+      "import": "./build/cli.js"
+    },
+    "./build/setup": {
+      "types": "./build/setup.d.ts",
+      "import": "./build/setup.js"
+    },
+    "./build/lib/objectCreator": {
+      "types": "./build/lib/objectCreator.d.ts",
+      "import": "./build/lib/objectCreator.js"
+    },
+    "./build/lib/agentCreator": {
+      "types": "./build/lib/agentCreator.d.ts",
+      "import": "./build/lib/agentCreator.js"
+    },
+    "./package.json": "./package.json"
+  },
   "main": "build/cli.js",
-  "exports": "./build/cli.js",
   "types": "build/cli.d.ts",
   "bin": {
     "veramo": "bin/veramo.js"
@@ -22,30 +40,30 @@
     "@transmute/credentials-context": "^0.7.0-unstable.79",
     "@types/blessed": "^0.1.19",
     "@types/swagger-ui-express": "^4.1.3",
-    "@veramo/core": "^5.0.1-next.11+672f92b1",
-    "@veramo/core-types": "^5.0.1-next.11+672f92b1",
-    "@veramo/credential-eip712": "^5.0.1-next.11+672f92b1",
-    "@veramo/credential-ld": "^5.0.1-next.11+672f92b1",
-    "@veramo/credential-w3c": "^5.0.1-next.11+672f92b1",
-    "@veramo/data-store": "^5.0.1-next.11+672f92b1",
-    "@veramo/did-comm": "^5.0.1-next.11+672f92b1",
-    "@veramo/did-discovery": "^5.0.1-next.11+672f92b1",
-    "@veramo/did-jwt": "^5.0.1-next.11+672f92b1",
-    "@veramo/did-manager": "^5.0.1-next.11+672f92b1",
-    "@veramo/did-provider-ethr": "^5.0.1-next.11+672f92b1",
-    "@veramo/did-provider-key": "^5.0.1-next.11+672f92b1",
-    "@veramo/did-provider-web": "^5.0.1-next.11+672f92b1",
-    "@veramo/did-resolver": "^5.0.1-next.11+672f92b1",
-    "@veramo/key-manager": "^5.0.1-next.11+672f92b1",
-    "@veramo/kms-local": "^5.0.1-next.11+672f92b1",
-    "@veramo/message-handler": "^5.0.1-next.11+672f92b1",
-    "@veramo/remote-client": "^5.0.1-next.11+672f92b1",
-    "@veramo/remote-server": "^5.0.1-next.11+672f92b1",
-    "@veramo/selective-disclosure": "^5.0.1-next.11+672f92b1",
-    "@veramo/url-handler": "^5.0.1-next.11+672f92b1",
-    "@veramo/utils": "^5.0.1-next.11+672f92b1",
+    "@veramo/core": "^5.0.1-next.13+9c73d98f",
+    "@veramo/core-types": "^5.0.1-next.13+9c73d98f",
+    "@veramo/credential-eip712": "^5.0.1-next.13+9c73d98f",
+    "@veramo/credential-ld": "^5.0.1-next.13+9c73d98f",
+    "@veramo/credential-w3c": "^5.0.1-next.13+9c73d98f",
+    "@veramo/data-store": "^5.0.1-next.13+9c73d98f",
+    "@veramo/did-comm": "^5.0.1-next.13+9c73d98f",
+    "@veramo/did-discovery": "^5.0.1-next.13+9c73d98f",
+    "@veramo/did-jwt": "^5.0.1-next.13+9c73d98f",
+    "@veramo/did-manager": "^5.0.1-next.13+9c73d98f",
+    "@veramo/did-provider-ethr": "^5.0.1-next.13+9c73d98f",
+    "@veramo/did-provider-key": "^5.0.1-next.13+9c73d98f",
+    "@veramo/did-provider-web": "^5.0.1-next.13+9c73d98f",
+    "@veramo/did-resolver": "^5.0.1-next.13+9c73d98f",
+    "@veramo/key-manager": "^5.0.1-next.13+9c73d98f",
+    "@veramo/kms-local": "^5.0.1-next.13+9c73d98f",
+    "@veramo/message-handler": "^5.0.1-next.13+9c73d98f",
+    "@veramo/remote-client": "^5.0.1-next.13+9c73d98f",
+    "@veramo/remote-server": "^5.0.1-next.13+9c73d98f",
+    "@veramo/selective-disclosure": "^5.0.1-next.13+9c73d98f",
+    "@veramo/url-handler": "^5.0.1-next.13+9c73d98f",
+    "@veramo/utils": "^5.0.1-next.13+9c73d98f",
     "blessed": "^0.1.81",
-    "commander": "^9.0.0",
+    "commander": "^10.0.0",
     "console-table-printer": "^2.10.0",
     "cors": "^2.8.5",
     "cross-fetch": "^3.1.4",
@@ -115,5 +133,5 @@
     "node_modules",
     "src"
   ],
-  "gitHead": "672f92b1bd3850c369cbef646c8ece8a58fafc16"
+  "gitHead": "9c73d98fd217ed9a612767f49a235cdbf43619cb"
 }

package/src/__tests__/cli.test.ts

@@ -0,0 +1,42 @@
+import { veramo } from '../createCommand.js'
+import { jest } from '@jest/globals'
+import { createObjects } from '../lib/objectCreator'
+import { getConfig } from '../setup'
+
+jest.useFakeTimers()
+
+describe('cli version', () => {
+  const writeMock = jest.fn()
+
+  beforeAll(() => {
+    // veramo
+    //   .exitOverride()
+    //   .configureOutput({ writeOut: writeMock })
+  })
+
+  afterAll(() => {
+    jest.clearAllMocks()
+  })
+
+  it.skip('should list version number', async () => {
+    expect(() => {
+      // veramo.parse(['--version'], { from: 'user' })
+    }).toThrow()
+    expect(writeMock).toHaveBeenCalledWith(expect.stringMatching(/^\d\.\d\.\d\n?$/))
+  })
+
+  it.skip('should load the dbConnection', async () => {
+    // this seems to fail because of some timing issues or an incompatibility with the `chalk` transitive dependency
+    // all other tests that need to load the dbConnection fail similarly
+    const res = await createObjects(getConfig('./packages/cli/default/default.yml'), {
+      my: '/dbConnection',
+    })
+  })
+
+  it.skip('should check the default config', async () => {
+    expect(() => {
+      // veramo.parse(['config', 'check', '-f', './packages/cli/default/default.yml'], { from: 'user' })
+    }).toThrow(/hello/)
+    expect(writeMock).toHaveBeenCalledWith(expect.stringMatching(/^\d\.\d\.\d\n?$/))
+  })
+})

package/src/cli.ts

@@ -1,25 +1,11 @@
-import { program } from 'commander'
 import inquirer from 'inquirer'
 import inquirerAutoPrompt from 'inquirer-autocomplete-prompt'
 
 inquirer.registerPrompt('autocomplete', inquirerAutoPrompt)
-
-import './did.js'
-import './credential.js'
-import './presentation.js'
-import './explore/index.js'
-import './sdr.js'
-import './message.js'
-import './discover.js'
-import './version.js'
-import './execute.js'
-import './server.js'
-import './setup.js'
-import './config.js'
-import './dev.js'
+import { veramo } from './createCommand.js'
 
 if (!process.argv.slice(2).length) {
-  program.outputHelp()
+  veramo.outputHelp()
 } else {
-  program.parse(process.argv)
+  veramo.parse(process.argv)
 }

package/src/config.ts

@@ -1,15 +1,14 @@
-import { program } from 'commander'
+import { Command } from 'commander'
 import { SecretBox } from '@veramo/kms-local'
 import { getAgent } from './setup.js'
-import fs from "fs"
+import fs from 'fs'
 import { dirname } from 'path'
 
-import * as url from 'url';
-const __dirname = url.fileURLToPath(new URL('.', import.meta.url));
+import * as url from 'url'
 
-program.option('--config <path>', 'Configuration file', './agent.yml')
+const __dirname = url.fileURLToPath(new URL('.', import.meta.url))
 
-const config = program.command('config').description('Agent configuration')
+const config = new Command('config').description('Agent configuration')
 
 config
   .command('create', { isDefault: true })
@@ -43,6 +42,8 @@ config
   .command('create-secret-key')
   .alias('gen-key')
   .alias('key-gen')
+  .alias('keygen')
+  .alias('genkey')
   .description('generate secret key')
   .option('-q, --quiet', 'Only print the raw key, no instructions', false)
   .action(async (options) => {
@@ -89,3 +90,5 @@ config
       }
     }
   })
+
+export { config }

package/src/createCommand.ts

@@ -0,0 +1,34 @@
+import { Command } from 'commander'
+import module from 'module'
+
+import { config } from './config.js'
+import { credential } from './credential.js'
+import { dev } from './dev.js'
+import { did } from './did.js'
+import { discover } from './discover.js'
+import { execute } from './execute.js'
+import { message } from './message.js'
+import { presentation } from './presentation.js'
+import { explore } from './explore/index.js'
+import { sdr } from './sdr.js'
+import { server } from './server.js'
+
+const requireCjs = module.createRequire(import.meta.url)
+const { version } = requireCjs('../package.json')
+
+const veramo = new Command('veramo')
+  .version(version, '-v, --version')
+  .option('--config <string>', 'Configuration file', './agent.yml')
+  .addCommand(config)
+  .addCommand(credential)
+  .addCommand(dev)
+  .addCommand(did)
+  .addCommand(discover)
+  .addCommand(execute)
+  .addCommand(explore)
+  .addCommand(message)
+  .addCommand(presentation)
+  .addCommand(sdr)
+  .addCommand(server)
+
+export { veramo }

package/src/credential.ts

@@ -1,5 +1,5 @@
 import { getAgent } from './setup.js'
-import { program } from 'commander'
+import { Command } from 'commander'
 import inquirer from 'inquirer'
 import qrcode from 'qrcode-terminal'
 import * as fs from 'fs'
@@ -9,7 +9,7 @@ import { CredentialPayload } from '@veramo/core-types'
 
 import fuzzy from 'fuzzy'
 
-const credential = program.command('credential').description('W3C Verifiable Credential')
+const credential = new Command('credential').description('W3C Verifiable Credential')
 
 credential
   .command('create', { isDefault: true })
@@ -17,8 +17,8 @@ credential
   .option('-s, --send', 'Send')
   .option('-j, --json', 'Output in JSON')
   .option('-q, --qrcode', 'Show qrcode')
-  .action(async (cmd) => {
-    const agent = await getAgent(program.opts().config)
+  .action(async (opts: { send: boolean; qrcode: boolean; json: boolean }, cmd: Command) => {
+    const agent = await getAgent(cmd.optsWithGlobals().config)
     const identifiers = await agent.didManagerFind()
 
     const knownDids = await agent.dataStoreORMGetIdentifiers()
@@ -127,7 +127,7 @@ credential
       proofFormat: answers.proofFormat,
     })
 
-    if (cmd.send) {
+    if (opts.send) {
       let body
       let type
       if (answers.proofFormat == 'jwt') {
@@ -153,10 +153,10 @@ credential
       }
     }
 
-    if (cmd.qrcode) {
+    if (opts.qrcode) {
       qrcode.generate(verifiableCredential.proof.jwt)
     } else {
-      if (cmd.json) {
+      if (opts.json) {
         console.log(JSON.stringify(verifiableCredential, null, 2))
       } else {
         console.dir(verifiableCredential, { depth: 10 })
@@ -169,8 +169,8 @@ credential
   .description('Verify a W3C Verifiable Credential provided as raw string, file or stdin')
   .option('-f, --filename <string>', 'Optional. Read the credential from a file instead of stdin')
   .option('-r, --raw <string>', 'Optional. Specify the credential as a parameter instead of file or stdin')
-  .action(async (options) => {
-    const agent = await getAgent(program.opts().config)
+  .action(async (options: { raw: string; filename: string }, cmd: Command) => {
+    const agent = await getAgent(cmd.optsWithGlobals().config)
     let raw: string = ''
     if (options.raw) {
       raw = options.raw
@@ -205,8 +205,8 @@ credential
 credential
   .command('output')
   .description('Print W3C Verifiable Credential to stdout')
-  .action(async (cmd) => {
-    const agent = await getAgent(program.opts().config)
+  .action(async (opts: {}, cmd: Command) => {
+    const agent = await getAgent(cmd.optsWithGlobals().config)
 
     const credentials = await agent.dataStoreORMGetVerifiableCredentials()
 
@@ -236,3 +236,5 @@ credential
       console.log('No credentials found.')
     }
   })
+
+export { credential }

package/src/dev.ts

@@ -5,16 +5,15 @@ import {
   ApiParameterListMixin,
   ApiReturnTypeMixin,
 } from '@microsoft/api-extractor-model'
-import { program } from 'commander'
+import { Command } from 'commander'
 import { writeFileSync } from 'fs'
 import { OpenAPIV3 } from 'openapi-types'
 import { resolve } from 'path'
 import * as TJS from 'ts-json-schema-generator'
-import fs from 'fs'
 
-import module from "module"
-const requireCjs = module.createRequire(import.meta.url);
+import module from 'module'
 
+const requireCjs = module.createRequire(import.meta.url)
 
 interface Method {
   packageName: string
@@ -24,6 +23,7 @@ interface Method {
   parameters?: string
   response: string
 }
+
 const genericTypes = ['boolean', 'string', 'number', 'any', 'Array<string>']
 
 function createSchema(generator: TJS.SchemaGenerator, symbol: string) {
@@ -84,7 +84,7 @@ function getReference(response: string): OpenAPIV3.ReferenceObject | OpenAPIV3.S
   }
 }
 
-const dev = program.command('dev').description('Plugin developer tools')
+const dev = new Command('dev').description('Plugin developer tools')
 
 dev
   .command('generate-plugin-schema')
@@ -129,7 +129,7 @@ dev
         path: resolve(entryFile),
         encodeRefs: false,
         additionalProperties: true,
-        skipTypeCheck: true
+        skipTypeCheck: true,
       })
 
       const apiModel: ApiModel = new ApiModel()
@@ -208,3 +208,5 @@ dev
       process.exitCode = 1
     }
   })
+
+export { dev }

package/src/did.ts

@@ -1,19 +1,19 @@
-import { IDIDManagerCreateArgs } from '@veramo/core-types'
+import { IDIDManagerCreateArgs, IIdentifier } from '@veramo/core-types'
 import { getAgent } from './setup.js'
 import inquirer from 'inquirer'
-import { program } from 'commander'
+import { Command } from 'commander'
 import { printTable } from 'console-table-printer'
 
-const did = program.command('did').description('Decentralized identifiers')
+const did = new Command('did').description('Decentralized identifiers')
 
 did
   .command('providers')
   .description('list available identifier providers')
-  .action(async (cmd) => {
-    const agent = await getAgent(program.opts().config)
+  .action(async (opts: {}, cmd: Command) => {
+    const agent = await getAgent(cmd.optsWithGlobals().config)
 
     const providers = await agent.didManagerGetProviders()
-    const list = providers.map((provider) => ({ provider }))
+    const list = providers.map((provider: string) => ({ provider }))
 
     if (list.length > 0) {
       printTable(list)
@@ -25,13 +25,17 @@ did
 did
   .command('list', { isDefault: true })
   .description('list managed identifiers')
-  .action(async (cmd) => {
-    const agent = await getAgent(program.opts().config)
+  .action(async (opts: {}, cmd: Command) => {
+    const agent = await getAgent(cmd.optsWithGlobals().config)
 
     const list = await agent.didManagerFind()
 
     if (list.length > 0) {
-      const dids = list.map((item) => ({ provider: item.provider, alias: item.alias, did: item.did }))
+      const dids = list.map((item: IIdentifier) => ({
+        provider: item.provider,
+        alias: item.alias,
+        did: item.did,
+      }))
       printTable(dids)
     } else {
       console.log('No dids')
@@ -41,8 +45,9 @@ did
 did
   .command('create')
   .description('create an identifier')
-  .action(async (cmd) => {
-    const agent = await getAgent(program.opts().config)
+  .action(async (opts: {}, cmd: Command) => {
+    // FIXME: CLI add arguments for provider, kms, alias
+    const agent = await getAgent(cmd.optsWithGlobals().config)
 
     try {
       const providers = await agent.didManagerGetProviders()
@@ -79,8 +84,8 @@ did
 did
   .command('delete')
   .description('delete an identifier')
-  .action(async (cmd) => {
-    const agent = await getAgent(program.opts().config)
+  .action(async (opts: {}, cmd: Command) => {
+    const agent = await getAgent(cmd.optsWithGlobals().config)
 
     try {
       const identifiers = await agent.didManagerFind()
@@ -106,8 +111,8 @@ did
 did
   .command('add-service')
   .description('add a service endpoint to did document')
-  .action(async (cmd) => {
-    const agent = await getAgent(program.opts().config)
+  .action(async (opts: {}, cmd: Command) => {
+    const agent = await getAgent(cmd.optsWithGlobals().config)
 
     try {
       const identifiers = await agent.didManagerFind()
@@ -154,8 +159,8 @@ did
 did
   .command('remove-service')
   .description('remove a service endpoint from did document')
-  .action(async (cmd) => {
-    const agent = await getAgent(program.opts().config)
+  .action(async (opts: {}, cmd: Command) => {
+    const agent = await getAgent(cmd.optsWithGlobals().config)
 
     try {
       const identifiers = await agent.didManagerFind()
@@ -187,8 +192,8 @@ did
 did
   .command('add-key')
   .description('create and add a public key to did document')
-  .action(async (cmd) => {
-    const agent = await getAgent(program.opts().config)
+  .action(async (opts: {}, cmd: Command) => {
+    const agent = await getAgent(cmd.optsWithGlobals().config)
 
     try {
       const identifiers = await agent.didManagerFind()
@@ -233,8 +238,8 @@ did
 did
   .command('remove-key')
   .description('remove a key from did document')
-  .action(async (cmd) => {
-    const agent = await getAgent(program.opts().config)
+  .action(async (opts: {}, cmd: Command) => {
+    const agent = await getAgent(cmd.optsWithGlobals().config)
 
     try {
       const identifiers = await agent.didManagerFind()
@@ -266,8 +271,8 @@ did
 did
   .command('export')
   .description('export an identifier')
-  .action(async (cmd) => {
-    const agent = await getAgent(program.opts().config)
+  .action(async (opts: {}, cmd: Command) => {
+    const agent = await getAgent(cmd.optsWithGlobals().config)
 
     try {
       const identifiers = await agent.didManagerFind()
@@ -294,8 +299,8 @@ did
 did
   .command('import')
   .description('import an identifier')
-  .action(async (cmd) => {
-    const agent = await getAgent(program.opts().config)
+  .action(async (opts: {}, cmd: Command) => {
+    const agent = await getAgent(cmd.optsWithGlobals().config)
 
     try {
       const answers = await inquirer.prompt([
@@ -316,8 +321,8 @@ did
 did
   .command('resolve <didUrl>')
   .description('Resolve DID Document')
-  .action(async (didUrl) => {
-    const agent = await getAgent(program.opts().config)
+  .action(async (didUrl: string, opts: {}, cmd: Command) => {
+    const agent = await getAgent(cmd.optsWithGlobals().config)
     try {
       const ddo = await agent.resolveDid({ didUrl })
       console.log(JSON.stringify(ddo, null, 2))
@@ -325,3 +330,5 @@ did
       console.error(e.message)
     }
   })
+
+export { did }

package/src/discover.ts

@@ -1,18 +1,18 @@
 import { getAgent } from './setup.js'
-import { program } from 'commander'
+import { Command } from 'commander'
 import { printTable } from 'console-table-printer'
 
-const discover = program.command('discover').description('Discovery')
+const discover = new Command('discover').description('Discovery')
 
 discover
   .command('did')
   .description('did discovery')
   .option('-q, --query <string>', 'Query string')
 
-  .action(async (cmd) => {
-    const agent = await getAgent(program.opts().config)
+  .action(async (opts: { query: string }, cmd: Command) => {
+    const agent = await getAgent(cmd.optsWithGlobals().config)
 
-    const response = await agent.discoverDid({ query: cmd.query })
+    const response = await agent.discoverDid({ query: opts.query })
     const list: any = []
 
     response.results.forEach((r: any) => {
@@ -30,3 +30,5 @@ discover
       console.log('No dids discovered')
     }
   })
+
+export { discover }

package/src/execute.ts

@@ -1,18 +1,17 @@
-import { program } from 'commander'
+import { Command } from 'commander'
 import inquirer from 'inquirer'
 import { getAgent } from './setup.js'
 import fs from 'fs'
 import OasResolver from 'oas-resolver'
 import fuzzy from 'fuzzy'
 
-program
-  .command('execute')
-  .description('Executes agent method')
+const execute = new Command('execute')
+  .description('Execute agent method')
   .option('-m, --method <string>', 'Method name')
   .option('-a, --argsJSON <string>', 'Method arguments')
   .option('-f, --argsFile <string>', 'Path to a file containing method arguments in a JSON string')
-  .action(async (options) => {
-    const agent = await getAgent(program.opts().config)
+  .action(async (options: { method: string; argsJSON?: string; argsFile?: string }, cmd: Command) => {
+    const agent = await getAgent(cmd.optsWithGlobals().config)
 
     try {
       let method = options.method
@@ -92,9 +91,13 @@ program
       } else {
         if (argsFile) {
           console.log({ argsFile })
-          argsString = fs.readFileSync(argsFile)
+          argsString = fs.readFileSync(argsFile).toString('utf-8')
+        }
+        try {
+          argsObj = JSON.parse(argsString!)
+        } catch (e: any) {
+          console.error('could not parse arguments JSON')
         }
-        argsObj = JSON.parse(argsString)
       }
 
       console.log('\nMethod: ', method)
@@ -111,3 +114,5 @@ program
       console.error(e.message)
     }
   })
+
+export { execute }

package/src/explore/index.ts

@@ -1,12 +1,12 @@
 import { getAgent } from '../setup.js'
 import { Command } from 'commander'
-const program = new Command();
 import { renderMainScreen } from './main.js'
 
-program
-  .command('explore')
+const explore = new Command('explore')
   .description('launch Verifiable Data explorer')
-  .action(async (cmd) => {
-    const agent = await getAgent(program.opts().config)
+  .action(async (opts: {}, cmd: Command) => {
+    const agent = await getAgent(cmd.optsWithGlobals().config)
     await renderMainScreen(agent)
   })
+
+export { explore }

package/src/lib/agentCreator.ts

@@ -1,6 +1,15 @@
 import { TAgent, IPluginMethodMap } from '@veramo/core-types'
 import { createObjects } from './objectCreator.js'
 
+/**
+ * Creates a Veramo agent from a config object containing an `/agent` pointer.
+ * @param config - The configuration object
+ *
+ * @see {@link https://veramo.io/docs/veramo_agent/configuration_internals | Configuration Internals} for details on
+ *   the configuration options.
+ *
+ * @beta
+ */
 export async function createAgentFromConfig<T extends IPluginMethodMap>(config: object): Promise<TAgent<T>> {
   // @ts-ignore
   const { agent } = await createObjects(config, { agent: '/agent' })