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

package/src/lib/objectCreator.ts

@@ -2,6 +2,50 @@ import { set, get } from 'jsonpointer'
 import parse from 'url-parse'
 import { resolve } from 'path'
 
+/**
+ * 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:
+ * ```json5
+ * {
+ *   rpcUrl: "http://localhost:8545",
+ *   endpoint: {
+ *     url: {
+ *       "$ref": "/rpcUrl"
+ *     }
+ *   }
+ * }
+ *
+ * The config object can also contain references to NPM modules using the `$require` property.
+ * Example:
+ * ```json5
+ * {
+ *   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
+ */
 export async function createObjects(config: object, pointers: Record<string, string>): Promise<any> {
   const objects = {}
 
@@ -51,9 +95,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 }

package/src/sdr.ts

@@ -1,6 +1,6 @@
 import { ICredentialRequestInput } from '@veramo/selective-disclosure'
 import { getAgent } from './setup.js'
-import { program } from 'commander'
+import { Command } from 'commander'
 import inquirer from 'inquirer'
 import qrcode from 'qrcode-terminal'
 import { shortDate, shortDid } from './explore/utils.js'
@@ -9,13 +9,14 @@ import { asArray, extractIssuer } from '@veramo/utils'
 
 import fuzzy from 'fuzzy'
 
-const sdr = program.command('sdr').description('Selective Disclosure Request')
+const sdr = new Command('sdr').description('Selective Disclosure Request')
 
 sdr
   .command('create', { isDefault: true })
   .description('create Selective Disclosure Request')
-  .action(async (cmd) => {
-    const agent = await getAgent(program.opts().config)
+  .option('-q, --qrcode', 'Show qrcode')
+  .action(async (opts: { qrcode: boolean }, cmd: Command) => {
+    const agent = await getAgent(cmd.optsWithGlobals().config)
     const identifiers = await agent.didManagerFind()
 
     const knownDids = await agent.dataStoreORMGetIdentifiers()
@@ -253,7 +254,7 @@ sdr
       console.log('Subject not specified')
     }
 
-    if (cmd.qrcode) {
+    if (opts.qrcode) {
       qrcode.generate(jwt)
     } else {
       console.dir(data, { depth: 10 })
@@ -264,8 +265,8 @@ sdr
 sdr
   .command('respond')
   .description('respond to Selective Disclosure Request')
-  .action(async (cmd) => {
-    const agent = await getAgent(program.opts().config)
+  .action(async (opts: {}, cmd: Command) => {
+    const agent = await getAgent(cmd.optsWithGlobals().config)
     const sdrMessages = await agent.dataStoreORMGetMessages({
       where: [{ column: 'type', value: ['sdr'] }],
       order: [{ column: 'createdAt', direction: 'DESC' }],
@@ -354,3 +355,5 @@ sdr
 
     console.dir(verifiablePresentation, { depth: 10 })
   })
+
+export { sdr }

package/src/server.ts

@@ -1,30 +1,34 @@
 import express from 'express'
-import { program } from 'commander'
+import { Command } from 'commander'
 import { getConfig } from './setup.js'
 import { createObjects } from './lib/objectCreator.js'
 
-program
-  .command('server')
+const server = new Command('server')
   .description('Launch OpenAPI server')
   .option('-p, --port <number>', 'Optionally set port to override config')
-  .action(async (cmd) => {
+  .action(async (opts: { port: number }, cmd: Command) => {
     const app = express()
 
     let server: any
 
     try {
-      const config = await createObjects(getConfig(program.opts().config), { server: '/server' })
+      const config = await createObjects(getConfig(cmd.optsWithGlobals().config), { server: '/server' })
       server = config.server
     } catch (e: any) {
-      console.log(e.message)
+      console.error(e.message)
       process.exit(1)
     }
 
     for (let router of server.use) {
       app.use(...router)
+      if (typeof router[0] === 'string') {
+        console.log(`Listening to route: ${server.baseUrl}${router[0]}`)
+      }
     }
 
-    app.listen(cmd.port || server.port, async () => {
+    app.listen(opts.port || server.port, async () => {
       console.log(`🚀 Cloud Agent ready at ${server.baseUrl}`)
     })
   })
+
+export { server }

package/build/version.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=version.d.ts.map

package/build/version.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,CAAA"}

package/build/version.js

@@ -1,7 +0,0 @@
-import { program } from 'commander';
-import module from "module";
-const requireCjs = module.createRequire(import.meta.url);
-const data = requireCjs("../package.json");
-const { version } = data;
-program.version(version, '-v, --version');
-//# sourceMappingURL=version.js.map

package/build/version.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"version.js","sourceRoot":"","sources":["../src/version.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AACnC,OAAO,MAAM,MAAM,QAAQ,CAAC;AAC5B,MAAM,UAAU,GAAG,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACzD,MAAM,IAAI,GAAG,UAAU,CAAC,iBAAiB,CAAC,CAAC;AAC3C,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAA;AAExB,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,eAAe,CAAC,CAAA"}

package/src/__tests__/default.test.ts

@@ -1,6 +0,0 @@
-describe('veramo-cli', () => {
-  const a = 100
-  it('should run a dummy test', () => {
-    expect(a).toEqual(100)
-  })
-})

package/src/version.ts

@@ -1,9 +0,0 @@
-import { program } from 'commander'
-import module from "module";
-const requireCjs = module.createRequire(import.meta.url);
-const data = requireCjs("../package.json");
-const { version } = data
-
-program.version(version, '-v, --version')
-
-export {}