@veramo/cli 5.0.1-next.8 → 5.1.1-next.2

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) {
@@ -77,14 +77,14 @@ function getReference(response: string): OpenAPIV3.ReferenceObject | OpenAPIV3.S
   }
 
   if (['string', 'number', 'boolean', 'object', 'integer'].includes(response)) {
-    //@ts-ignore
+    // @ts-ignore
     return { type: response }
   } else {
     return { $ref: '#/components/schemas/' + response }
   }
 }
 
-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()
@@ -152,28 +152,28 @@ dev
         const methodSignature = member as ApiMethodSignature
         method.description = methodSignature.tsdocComment?.summarySection
           ?.getChildNodes()[0]
-          //@ts-ignore
+          // @ts-ignore
           ?.getChildNodes()[0]?.text
 
         method.description = method.description || ''
 
         if (method.parameters) {
-          //@ts-ignore
+          // @ts-ignore
           api.components.schemas = {
-            //@ts-ignore
+            // @ts-ignore
             ...api.components.schemas,
             ...createSchema(generator, method.parameters).components.schemas,
           }
         }
 
-        //@ts-ignore
+        // @ts-ignore
         api.components.schemas = {
-          //@ts-ignore
+          // @ts-ignore
           ...api.components.schemas,
           ...createSchema(generator, method.response).components.schemas,
         }
 
-        //@ts-ignore
+        // @ts-ignore
         api.components.methods[method.operationId] = {
           description: method.description,
           arguments: getReference(method.parameters),
@@ -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
@@ -24,7 +23,7 @@ program
 
       if (!method) {
         const answers = await inquirer.prompt({
-          //@ts-ignore
+          // @ts-ignore
           type: 'autocomplete',
           name: 'method',
           pageSize: 15,
@@ -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,8 +1,17 @@
 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 - This API may change without a major version bump
+ */
 export async function createAgentFromConfig<T extends IPluginMethodMap>(config: object): Promise<TAgent<T>> {
-  //@ts-ignore
+  // @ts-ignore
   const { agent } = await createObjects(config, { agent: '/agent' })
   return agent
 }

package/src/lib/objectCreator.ts

@@ -2,7 +2,53 @@ import { set, get } from 'jsonpointer'
 import parse from 'url-parse'
 import { resolve } from 'path'
 
-export async function createObjects(config: object, pointers: Record<string, string>): Promise<any> {
+/**
+ * Creates objects from a configuration object and a set of pointers.
+ *
+ * Example:
+ * ```ts
+ * const { url } = createObjects({ "rpcUrl": "http://localhost:8545", }, { url: '/rpcUrl' })
+ * ```
+ *
+ * The config can contain references (`$ref`) to other objects within using JSON pointers.
+ * Example:
+ * ```json
+ * {
+ *   "rpcUrl": "http://localhost:8545",
+ *   "endpoint": {
+ *     "url": {
+ *       "$ref": "/rpcUrl"
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * The config object can also contain references to NPM modules using the `$require` property.
+ * Example:
+ * ```json
+ * {
+ *   "agent": {
+ *     "$require": "@veramo/core#Agent",
+ *     "$args": {
+ *       "plugins": [
+ *         { "$require": "@veramo/did-comm#DIDComm" },
+ *       ]
+ *     }
+ *   }
+ * }
+ * ```
+ *
+ * Environment variables can also be specified using the `$env` property.
+ *
+ * @see Please see {@link https://veramo.io/docs/veramo_agent/configuration_internals | Configuration Internals} for
+ *   more information.
+ *
+ * @param config - The configuration object
+ * @param pointers - A map of JSON pointers to objects within that config that you wish to create
+ *
+ * @beta - This API may change without a major version bump
+ */
+export async function createObjects(config: object, pointers: Record<string, string>): Promise<Record<string, any>> {
   const objects = {}
 
   async function resolveRefs(input: any): Promise<any> {
@@ -51,9 +97,9 @@ export async function createObjects(config: object, pointers: Record<string, str
       module = resolve(module)
     }
 
-    const resolvedArgs = args !== undefined ? (await resolveRefs(args)) : []
+    const resolvedArgs = args !== undefined ? await resolveRefs(args) : []
     try {
-      let required = member ? (await import(module))[member] : (await import(module))
+      let required = member ? (await import(module))[member] : await import(module)
       if (type === 'class') {
         object = new required(...resolvedArgs)
       } else if (type === 'function') {

package/src/message.ts

@@ -1,8 +1,8 @@
 import { getAgent } from './setup.js'
-import { program } from 'commander'
+import { Command } from 'commander'
 import fs from 'fs'
 
-const message = program.command('message').description('Messages')
+const message = new Command('message').description('Messages')
 
 message
   .command('handle', { isDefault: true })
@@ -11,8 +11,8 @@ message
   .option('-f, --file <string>', 'Path to a file containing raw message')
   .option('--save <boolean>', 'Save message', true)
 
-  .action(async (options) => {
-    const agent = await getAgent(program.opts().config)
+  .action(async (options: { file: string; raw: string; save: boolean }, cmd: Command) => {
+    const agent = await getAgent(cmd.optsWithGlobals().config)
     try {
       let raw
 
@@ -35,3 +35,5 @@ message
       console.error(e.message)
     }
   })
+
+export { message }

package/src/presentation.ts

@@ -1,22 +1,22 @@
 import { getAgent } from './setup.js'
-import { program } from 'commander'
+import { Command } from 'commander'
 import inquirer from 'inquirer'
 import qrcode from 'qrcode-terminal'
 import { readStdin } from './util.js'
 import * as fs from 'fs'
 import * as json5 from 'json5'
 import { extractIssuer } from '@veramo/utils'
-import { PartialIdentifier, UniqueVerifiablePresentation } from "@veramo/core-types";
+import { PartialIdentifier, UniqueVerifiablePresentation } from '@veramo/core-types'
 
-const presentation = program.command('presentation').description('W3C Verifiable Presentation')
+const presentation = new Command('presentation').description('W3C Verifiable Presentation')
 
 presentation
   .command('create', { isDefault: true })
   .description('Create W3C Verifiable Presentation')
   .option('-s, --send', 'Send')
   .option('-q, --qrcode', 'Show qrcode')
-  .action(async (cmd) => {
-    const agent = await getAgent(program.opts().config)
+  .action(async (opts: { send: boolean; qrcode: boolean }, cmd: Command) => {
+    const agent = await getAgent(cmd.optsWithGlobals().config)
     const myIdentifiers = await agent.didManagerFind()
     if (myIdentifiers.length === 0) {
       console.error('No dids')
@@ -33,7 +33,7 @@ presentation
       ...ids.map((id: PartialIdentifier) => id.did),
     ]
 
-    let aud:string[] = []
+    let aud: string[] = []
     const answers = await inquirer.prompt([
       {
         type: 'list',
@@ -72,8 +72,8 @@ presentation
           type: 'list',
           name: 'aud',
           message: 'Select Verifier or enter manually',
-          choices: identifiers
-        }
+          choices: identifiers,
+        },
       ])
       answer = audAnswer.aud
       if (answer === 'manual') {
@@ -144,8 +144,8 @@ presentation
         proofFormat: 'jwt',
       })
 
-      if (cmd.send) {
-        for(var verifier in aud) {
+      if (opts.send) {
+        for (var verifier in aud) {
           try {
             const message = await agent.sendMessageDIDCommAlpha1({
               save: true,
@@ -163,7 +163,7 @@ presentation
         }
       }
 
-      if (cmd.qrcode) {
+      if (opts.qrcode) {
         qrcode.generate(verifiablePresentation.proof.jwt)
       } else {
         console.dir(verifiablePresentation, { depth: 10 })
@@ -178,54 +178,57 @@ presentation
   .option('-d, --domain <string>', 'Optional. Specify a domain that the presentation should match.')
   .option('-f, --filename <string>', 'Optional. Read the presentation from a file instead of stdin')
   .option('-r, --raw <string>', 'Optional. Presentation as a parameter string instead of a file or stdin.')
-  .action(async (options) => {
-    const agent = await getAgent(program.opts().config)
-    let raw: string = ''
-    if (options.raw) {
-      raw = options.raw
-    } else if (options.filename) {
-      raw = await fs.promises.readFile(options.filename, 'utf-8')
-    } else {
-      raw = await readStdin()
-    }
-    let presentationAsJSON: any
-    try {
-      presentationAsJSON = json5.parse(raw)
-    } catch (e: any) {
-      presentationAsJSON = {
-        proof: {
-          type: 'JwtProof2020',
-          jwt: raw,
-        },
-      } as any
-    }
-    const result = await agent.verifyPresentation({
-      presentation: presentationAsJSON,
-      challenge: options.challenge,
-      domain: options.domain,
-    })
-    if (result.verified === true) {
-      console.log('Presentation was verified successfully.')
-    } else {
-      console.error('Presentation could not be verified.')
-    }
-  })
+  .action(
+    async (options: { challenge: string; domain: string; filename: string; raw: string }, cmd: Command) => {
+      const agent = await getAgent(cmd.optsWithGlobals().config)
+      let raw: string = ''
+      if (options.raw) {
+        raw = options.raw
+      } else if (options.filename) {
+        raw = await fs.promises.readFile(options.filename, 'utf-8')
+      } else {
+        raw = await readStdin()
+      }
+      let presentationAsJSON: any
+      try {
+        presentationAsJSON = json5.parse(raw)
+      } catch (e: any) {
+        presentationAsJSON = {
+          proof: {
+            type: 'JwtProof2020',
+            jwt: raw,
+          },
+        } as any
+      }
+      const result = await agent.verifyPresentation({
+        presentation: presentationAsJSON,
+        challenge: options.challenge,
+        domain: options.domain,
+      })
+      if (result.verified === true) {
+        console.log('Presentation was verified successfully.')
+      } else {
+        console.error('Presentation could not be verified.')
+      }
+    },
+  )
 
 presentation
   .command('output')
   .description('Print W3C Verifiable Presentation to stdout')
   .option('-t, --tag <string>', 'Optional. Specify the tag for the presentation.')
-  .action(async (options) => {
-    const agent = await getAgent(program.opts().config)
+  .action(async (options: { tag: string }, cmd: Command) => {
+    const agent = await getAgent(cmd.optsWithGlobals().config)
 
-    const presentations: UniqueVerifiablePresentation[] = await agent.dataStoreORMGetVerifiablePresentations({})
+    const presentations: UniqueVerifiablePresentation[] = await agent.dataStoreORMGetVerifiablePresentations(
+      {},
+    )
 
     if (presentations.length > 0) {
-
       let selected = null
       const list: any = []
       if (options.tag) {
-        const matches = presentations.filter(pres => pres.verifiablePresentation.tag === options.tag)
+        const matches = presentations.filter((pres) => pres.verifiablePresentation.tag === options.tag)
         if (matches.length > 1) {
           console.log('Found multiple matching presentations. Only showing the first one.')
         }
@@ -263,3 +266,5 @@ presentation
       console.log('No presentations found.')
     }
   })
+
+export { presentation }