@veramo/cli 4.0.1-unstable.2 → 4.0.1-unstable.4

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@veramo/cli",
   "description": "Veramo command line application.",
-  "version": "4.0.1-unstable.2+cff1765e",
+  "version": "4.0.1-unstable.4+a20894d6",
   "main": "build/cli.js",
+  "exports": "./build/cli.js",
   "types": "build/cli.d.ts",
   "bin": {
     "veramo": "bin/veramo.js"
@@ -14,28 +15,28 @@
     "update-veramo-latest": "yarn add @veramo/core@latest @veramo/discovery@latest @veramo/remote-client@latest @veramo/remote-server@latest @veramo/did-provider-key@latest @veramo/did-resolver@latest @veramo/did-jwt@latest @veramo/credential-w3c@latest @veramo/did-provider-ethr@latest @veramo/did-provider-web@latest @veramo/did-comm@latest @veramo/kms-local@latest @veramo/selective-disclosure@latest @veramo/data-store@latest @veramo/key-manager@latest @veramo/message-handler@latest @veramo/did-manager@latest @veramo/url-handler@latest"
   },
   "dependencies": {
-    "@microsoft/api-extractor": "7.25.0",
-    "@microsoft/api-extractor-model": "7.18.0",
+    "@microsoft/api-extractor": "7.30.0",
+    "@microsoft/api-extractor-model": "7.24.0",
     "@types/blessed": "^0.1.17",
     "@types/swagger-ui-express": "^4.1.3",
-    "@veramo/core": "^4.0.1-unstable.2+cff1765e",
-    "@veramo/credential-w3c": "^4.0.1-unstable.2+cff1765e",
-    "@veramo/data-store": "^4.0.1-unstable.2+cff1765e",
-    "@veramo/did-comm": "^4.0.1-unstable.2+cff1765e",
-    "@veramo/did-discovery": "^4.0.1-unstable.2+cff1765e",
-    "@veramo/did-jwt": "^4.0.1-unstable.2+cff1765e",
-    "@veramo/did-manager": "^4.0.1-unstable.2+cff1765e",
-    "@veramo/did-provider-ethr": "^4.0.1-unstable.2+cff1765e",
-    "@veramo/did-provider-key": "^4.0.1-unstable.2+cff1765e",
-    "@veramo/did-provider-web": "^4.0.1-unstable.2+cff1765e",
-    "@veramo/did-resolver": "^4.0.1-unstable.2+cff1765e",
-    "@veramo/key-manager": "^4.0.1-unstable.2+cff1765e",
-    "@veramo/kms-local": "^4.0.1-unstable.2+cff1765e",
-    "@veramo/message-handler": "^4.0.1-unstable.2+cff1765e",
-    "@veramo/remote-client": "^4.0.1-unstable.2+cff1765e",
-    "@veramo/remote-server": "^4.0.1-unstable.2+cff1765e",
-    "@veramo/selective-disclosure": "^4.0.1-unstable.2+cff1765e",
-    "@veramo/url-handler": "^4.0.1-unstable.2+cff1765e",
+    "@veramo/core": "^4.0.1-unstable.4+a20894d6",
+    "@veramo/credential-w3c": "^4.0.1-unstable.4+a20894d6",
+    "@veramo/data-store": "^4.0.1-unstable.4+a20894d6",
+    "@veramo/did-comm": "^4.0.1-unstable.4+a20894d6",
+    "@veramo/did-discovery": "^4.0.1-unstable.4+a20894d6",
+    "@veramo/did-jwt": "^4.0.1-unstable.4+a20894d6",
+    "@veramo/did-manager": "^4.0.1-unstable.4+a20894d6",
+    "@veramo/did-provider-ethr": "^4.0.1-unstable.4+a20894d6",
+    "@veramo/did-provider-key": "^4.0.1-unstable.4+a20894d6",
+    "@veramo/did-provider-web": "^4.0.1-unstable.4+a20894d6",
+    "@veramo/did-resolver": "^4.0.1-unstable.4+a20894d6",
+    "@veramo/key-manager": "^4.0.1-unstable.4+a20894d6",
+    "@veramo/kms-local": "^4.0.1-unstable.4+a20894d6",
+    "@veramo/message-handler": "^4.0.1-unstable.4+a20894d6",
+    "@veramo/remote-client": "^4.0.1-unstable.4+a20894d6",
+    "@veramo/remote-server": "^4.0.1-unstable.4+a20894d6",
+    "@veramo/selective-disclosure": "^4.0.1-unstable.4+a20894d6",
+    "@veramo/url-handler": "^4.0.1-unstable.4+a20894d6",
     "blessed": "^0.1.81",
     "commander": "^9.0.0",
     "console-table-printer": "^2.10.0",
@@ -45,7 +46,7 @@
     "debug": "^4.3.3",
     "did-resolver": "^4.0.0",
     "dotenv": "^16.0.0",
-    "ethr-did-resolver": "^6.1.0",
+    "ethr-did-resolver": "^6.2.1",
     "express": "^4.17.2",
     "express-handlebars": "^6.0.2",
     "fuzzy": "^0.1.3",
@@ -100,5 +101,10 @@
   ],
   "license": "Apache-2.0",
   "keywords": [],
-  "gitHead": "cff1765ea052960d2e0ca88042c4b9a9d4db7fad"
+  "type": "module",
+  "moduleDirectories": [
+    "node_modules",
+    "src"
+  ],
+  "gitHead": "a20894d60b23ab098391dd9d8ff6f96474081dc5"
 }

package/src/cli.ts

@@ -1,21 +1,22 @@
 import { program } from 'commander'
 import inquirer from 'inquirer'
+import inquirer2 from 'inquirer-autocomplete-prompt'
 
-inquirer.registerPrompt('autocomplete', require('inquirer-autocomplete-prompt'))
+inquirer.registerPrompt('autocomplete', inquirer2)
 
-import './did'
-import './credential'
-import './presentation'
-import './explore'
-import './sdr'
-import './message'
-import './discover'
-import './version'
-import './execute'
-import './server'
-import './setup'
-import './config'
-import './dev'
+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'
 
 if (!process.argv.slice(2).length) {
   program.outputHelp()

package/src/config.ts

@@ -1,10 +1,11 @@
-import 'cross-fetch/polyfill'
 import { program } from 'commander'
 import { SecretBox } from '@veramo/kms-local'
-import { getAgent } from './setup'
+import { getAgent } from './setup.js'
+import fs from "fs"
+import { dirname } from 'path'
 
-const fs = require('fs')
-const { dirname } = require('path')
+import * as url from 'url';
+const __dirname = url.fileURLToPath(new URL('.', import.meta.url));
 
 program.option('--config <path>', 'Configuration file', './agent.yml')
 
@@ -71,7 +72,7 @@ config
   .option('-f, --filename <string>', 'Config file name', './agent.yml')
   .option('-m, --method <string>', 'Check that a specific method is exposed by the agent.', 'execute')
   .action(async (options) => {
-    const agent = getAgent(options.filename)
+    const agent = await getAgent(options.filename)
     if (!agent) {
       console.error(
         'unknown error while creating the agent from your config. Consider running `veramo config create` to generate a new configuration file, or to manually compare differences.',

package/src/credential.ts

@@ -1,13 +1,12 @@
-import { getAgent } from './setup'
+import { getAgent } from './setup.js'
 import { program } from 'commander'
 import inquirer from 'inquirer'
 import qrcode from 'qrcode-terminal'
 import * as fs from 'fs'
 import * as json5 from 'json5'
-import { readStdin } from './util'
+import { readStdin } from './util.js'
 import { CredentialPayload } from '@veramo/core'
-
-const fuzzy = require('fuzzy')
+import fuzzy from 'fuzzy'
 
 const credential = program.command('credential').description('W3C Verifiable Credential')
 
@@ -18,7 +17,7 @@ credential
   .option('-j, --json', 'Output in JSON')
   .option('-q, --qrcode', 'Show qrcode')
   .action(async (cmd) => {
-    const agent = getAgent(program.opts().config)
+    const agent = await getAgent(program.opts().config)
     const identifiers = await agent.didManagerFind()
 
     const knownDids = await agent.dataStoreORMGetIdentifiers()
@@ -110,7 +109,8 @@ credential
           type: 'input',
           name: 'id',
           message: 'Credential status ID',
-          default: 'rinkeby:0x97fd27892cdcD035dAe1fe71235c636044B59348',
+          // TODO(nickreynolds): deploy
+          default: 'goerli:0x97fd27892cdcD035dAe1fe71235c636044B59348',
         },
       ])
 
@@ -169,7 +169,7 @@ credential
   .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 = getAgent(program.opts().config)
+    const agent = await getAgent(program.opts().config)
     let raw: string = ''
     if (options.raw) {
       raw = options.raw
@@ -205,7 +205,7 @@ credential
   .command('output')
   .description('Print W3C Verifiable Credential to stdout')
   .action(async (cmd) => {
-    const agent = getAgent(program.opts().config)
+    const agent = await getAgent(program.opts().config)
 
     const credentials = await agent.dataStoreORMGetVerifiableCredentials()
 

package/src/dev.ts

@@ -10,7 +10,10 @@ import { writeFileSync } from 'fs'
 import { OpenAPIV3 } from 'openapi-types'
 import { resolve } from 'path'
 import * as TJS from 'ts-json-schema-generator'
-const fs = require('fs')
+import fs from 'fs'
+
+import { createRequire } from "module";
+const require = createRequire(import.meta.url);
 
 interface Method {
   packageName: string
@@ -90,7 +93,7 @@ dev
     './package.json',
   )
 
-  .action(async (options) => {
+  .action(async (options: any) => {
     const apiExtractorJsonPath: string = resolve(options.extractorConfig)
     const extractorConfig: ExtractorConfig = ExtractorConfig.loadFileAndPrepare(apiExtractorJsonPath)
 
@@ -123,6 +126,7 @@ dev
         path: resolve(entryFile),
         encodeRefs: false,
         additionalProperties: true,
+        skipTypeCheck: true,
       })
 
       const apiModel: ApiModel = new ApiModel()
@@ -177,7 +181,7 @@ dev
       interfaces[pluginInterfaceName] = api
     }
 
-    writeFileSync(resolve('./plugin.schema.json'), JSON.stringify(interfaces, null, 2))
+    writeFileSync(resolve('./src/plugin.schema.json'), JSON.stringify(interfaces, null, 2))
   })
 
 dev

package/src/did.ts

@@ -1,5 +1,5 @@
 import { IDIDManagerCreateArgs } from '@veramo/core'
-import { getAgent } from './setup'
+import { getAgent } from './setup.js'
 import inquirer from 'inquirer'
 import { program } from 'commander'
 import { printTable } from 'console-table-printer'
@@ -10,7 +10,7 @@ did
   .command('providers')
   .description('list available identifier providers')
   .action(async (cmd) => {
-    const agent = getAgent(program.opts().config)
+    const agent = await getAgent(program.opts().config)
 
     const providers = await agent.didManagerGetProviders()
     const list = providers.map((provider) => ({ provider }))
@@ -26,7 +26,7 @@ did
   .command('list', { isDefault: true })
   .description('list managed identifiers')
   .action(async (cmd) => {
-    const agent = getAgent(program.opts().config)
+    const agent = await getAgent(program.opts().config)
 
     const list = await agent.didManagerFind()
 
@@ -42,7 +42,7 @@ did
   .command('create')
   .description('create an identifier')
   .action(async (cmd) => {
-    const agent = getAgent(program.opts().config)
+    const agent = await getAgent(program.opts().config)
 
     try {
       const providers = await agent.didManagerGetProviders()
@@ -80,7 +80,7 @@ did
   .command('delete')
   .description('delete an identifier')
   .action(async (cmd) => {
-    const agent = getAgent(program.opts().config)
+    const agent = await getAgent(program.opts().config)
 
     try {
       const identifiers = await agent.didManagerFind()
@@ -107,7 +107,7 @@ did
   .command('add-service')
   .description('add a service endpoint to did document')
   .action(async (cmd) => {
-    const agent = getAgent(program.opts().config)
+    const agent = await getAgent(program.opts().config)
 
     try {
       const identifiers = await agent.didManagerFind()
@@ -155,7 +155,7 @@ did
   .command('remove-service')
   .description('remove a service endpoint from did document')
   .action(async (cmd) => {
-    const agent = getAgent(program.opts().config)
+    const agent = await getAgent(program.opts().config)
 
     try {
       const identifiers = await agent.didManagerFind()
@@ -188,7 +188,7 @@ did
   .command('add-key')
   .description('create and add a public key to did document')
   .action(async (cmd) => {
-    const agent = getAgent(program.opts().config)
+    const agent = await getAgent(program.opts().config)
 
     try {
       const identifiers = await agent.didManagerFind()
@@ -234,7 +234,7 @@ did
   .command('remove-key')
   .description('remove a key from did document')
   .action(async (cmd) => {
-    const agent = getAgent(program.opts().config)
+    const agent = await getAgent(program.opts().config)
 
     try {
       const identifiers = await agent.didManagerFind()
@@ -267,7 +267,7 @@ did
   .command('export')
   .description('export an identifier')
   .action(async (cmd) => {
-    const agent = getAgent(program.opts().config)
+    const agent = await getAgent(program.opts().config)
 
     try {
       const identifiers = await agent.didManagerFind()
@@ -295,7 +295,7 @@ did
   .command('import')
   .description('import an identifier')
   .action(async (cmd) => {
-    const agent = getAgent(program.opts().config)
+    const agent = await getAgent(program.opts().config)
 
     try {
       const answers = await inquirer.prompt([
@@ -317,7 +317,7 @@ did
   .command('resolve <didUrl>')
   .description('Resolve DID Document')
   .action(async (didUrl) => {
-    const agent = getAgent(program.opts().config)
+    const agent = await getAgent(program.opts().config)
     try {
       const ddo = await agent.resolveDid({ didUrl })
       console.log(JSON.stringify(ddo, null, 2))

package/src/discover.ts

@@ -1,4 +1,4 @@
-import { getAgent } from './setup'
+import { getAgent } from './setup.js'
 import { program } from 'commander'
 import { printTable } from 'console-table-printer'
 
@@ -10,7 +10,7 @@ discover
   .option('-q, --query <string>', 'Query string')
 
   .action(async (cmd) => {
-    const agent = getAgent(program.opts().config)
+    const agent = await getAgent(program.opts().config)
 
     const response = await agent.discoverDid({ query: cmd.query })
     const list: any = []

package/src/execute.ts

@@ -1,9 +1,9 @@
 import { program } from 'commander'
 import inquirer from 'inquirer'
-import { getAgent } from './setup'
-const fs = require('fs')
-const OasResolver = require('oas-resolver')
-const fuzzy = require('fuzzy')
+import { getAgent } from './setup.js'
+import fs from 'fs'
+import OasResolver from 'oas-resolver'
+import fuzzy from 'fuzzy'
 
 program
   .command('execute')
@@ -12,7 +12,7 @@ program
   .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 = getAgent(program.opts().config)
+    const agent = await getAgent(program.opts().config)
 
     try {
       let method = options.method

package/src/explore/credentials.ts

@@ -1,8 +1,8 @@
 import blessed, { Widgets } from 'blessed'
 import { UniqueVerifiableCredential } from '@veramo/core'
-import { shortDate, shortDid, copyToClipboard } from './utils'
-import { ConfiguredAgent } from '../setup'
-import { styles } from './styles'
+import { shortDate, shortDid, copyToClipboard } from './utils.js'
+import { ConfiguredAgent } from '../setup.js'
+import { styles } from './styles.js'
 import { asArray, extractIssuer } from '@veramo/utils'
 
 export const getCredentialsTable = async (agent: ConfiguredAgent, screen: Widgets.Screen) => {

package/src/explore/index.ts

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

package/src/explore/main.ts

@@ -1,11 +1,11 @@
 import blessed from 'blessed'
-import { ConfiguredAgent } from '../setup'
-import { styles } from './styles'
+import { ConfiguredAgent } from '../setup.js'
+import { styles } from './styles.js'
 
-import { getManagedIdentifiersTable } from './managed-identifiers'
-import { getMessagesTable } from './messages'
-import { getCredentialsTable } from './credentials'
-import { getPresentationsTable } from './presentations'
+import { getManagedIdentifiersTable } from './managed-identifiers.js'
+import { getMessagesTable } from './messages.js'
+import { getCredentialsTable } from './credentials.js'
+import { getPresentationsTable } from './presentations.js'
 
 const defaultScreenTitle = 'Agent'
 

package/src/explore/managed-identifiers.ts

@@ -1,8 +1,8 @@
 import blessed, { Widgets } from 'blessed'
 import { IIdentifier } from '@veramo/core'
-import { copyToClipboard } from './utils'
-import { ConfiguredAgent } from '../setup'
-import { styles } from './styles'
+import { copyToClipboard } from './utils.js'
+import { ConfiguredAgent } from '../setup.js'
+import { styles } from './styles.js'
 
 export const getManagedIdentifiersTable = async (agent: ConfiguredAgent, screen: Widgets.Screen) => {
   screen.title = 'Managed identifiers'

package/src/explore/messages.ts

@@ -1,8 +1,8 @@
 import blessed, { Widgets } from 'blessed'
 import { IMessage } from '@veramo/core'
-import { shortDate, shortDid } from './utils'
-import { ConfiguredAgent } from '../setup'
-import { styles } from './styles'
+import { shortDate, shortDid } from './utils.js'
+import { ConfiguredAgent } from '../setup.js'
+import { styles } from './styles.js'
 
 export const getMessagesTable = async (agent: ConfiguredAgent, screen: Widgets.Screen) => {
   screen.title = 'Messages'

package/src/explore/presentations.ts

@@ -1,8 +1,8 @@
 import blessed, { Widgets } from 'blessed'
 import { UniqueVerifiablePresentation } from '@veramo/core'
-import { shortDate, shortDid, copyToClipboard } from './utils'
-import { ConfiguredAgent } from '../setup'
-import { styles } from './styles'
+import { shortDate, shortDid, copyToClipboard } from './utils.js'
+import { ConfiguredAgent } from '../setup.js'
+import { styles } from './styles.js'
 import { asArray } from '@veramo/utils'
 
 export const getPresentationsTable = async (agent: ConfiguredAgent, screen: Widgets.Screen) => {

package/src/lib/agentCreator.ts

@@ -1,8 +1,8 @@
 import { TAgent, IPluginMethodMap } from '@veramo/core'
-import { createObjects } from './objectCreator'
+import { createObjects } from './objectCreator.js'
 
-export function createAgentFromConfig<T extends IPluginMethodMap>(config: object): TAgent<T> {
+export async function createAgentFromConfig<T extends IPluginMethodMap>(config: object): Promise<TAgent<T>> {
   //@ts-ignore
-  const { agent } = createObjects(config, { agent: '/agent' })
+  const { agent } = await createObjects(config, { agent: '/agent' })
   return agent
 }

package/src/lib/objectCreator.ts

@@ -1,15 +1,15 @@
 import { set, get } from 'jsonpointer'
 import parse from 'url-parse'
-const { resolve } = require('path')
+import { resolve } from 'path'
 
-export function createObjects(config: object, pointers: Record<string, string>): any {
+export async function createObjects(config: object, pointers: Record<string, string>): Promise<any> {
   const objects = {}
 
-  function resolveRefs(input: any): any {
+  async function resolveRefs(input: any): Promise<any> {
     if (Array.isArray(input)) {
       const resolved = []
       for (const item of input) {
-        resolved.push(resolveRefs(item))
+        resolved.push(await resolveRefs(item))
       }
       return resolved
     }
@@ -20,13 +20,13 @@ export function createObjects(config: object, pointers: Record<string, string>):
         if (input.hasOwnProperty(property)) {
           if (property === '$ref') {
             const pointer = input[property]
-            return objectFromPointer(pointer)
+            return await objectFromPointer(pointer)
           } else if (property === '$require') {
-            return objectFromConfig(input)
+            return await objectFromConfig(input)
           } else if (property === '$env') {
             return process.env[input[property]]
           } else {
-            resolved[property] = resolveRefs(input[property])
+            resolved[property] = await resolveRefs(input[property])
           }
         }
       }
@@ -36,7 +36,7 @@ export function createObjects(config: object, pointers: Record<string, string>):
     return input
   }
 
-  function objectFromConfig(objectConfig: any) {
+  async function objectFromConfig(objectConfig: any) {
     let object
     // console.log('Requiring', objectConfig['$require'])
     const parsed = parse(objectConfig['$require'], {}, true)
@@ -45,15 +45,15 @@ export function createObjects(config: object, pointers: Record<string, string>):
     const type = parsed.query['t'] || 'class'
     const pointer = parsed.query['p']
     const args = objectConfig['$args']
-    // console.log({module, member, type, query: parsed.query})
+    // console.log({module, member, type, query: parsed.query, args, pointer})
 
     if (module.slice(0, 2) === './') {
       module = resolve(module)
     }
 
-    const resolvedArgs = args !== undefined ? resolveRefs(args) : []
+    const resolvedArgs = args !== undefined ? await resolveRefs(args) : []
     try {
-      let required = member ? require(module)[member] : require(module)
+      let required = member ? (await import(module))[member] : (await import(module)).default
       if (type === 'class') {
         object = new required(...resolvedArgs)
       } else if (type === 'function') {
@@ -70,7 +70,7 @@ export function createObjects(config: object, pointers: Record<string, string>):
     return object
   }
 
-  function objectFromPointer(pointer: string) {
+  async function objectFromPointer(pointer: string) {
     const existingObject = get(objects, pointer)
     if (existingObject) {
       // console.log('Existing', pointer)
@@ -82,11 +82,11 @@ export function createObjects(config: object, pointers: Record<string, string>):
       try {
         let object
         if (objectConfig['$require']) {
-          object = objectFromConfig(objectConfig)
+          object = await objectFromConfig(objectConfig)
         } else if (objectConfig['$env']) {
           object = process.env[objectConfig['$env']]
         } else {
-          object = resolveRefs(objectConfig)
+          object = await resolveRefs(objectConfig)
         }
         set(objects, pointer, object)
         return object
@@ -99,7 +99,7 @@ export function createObjects(config: object, pointers: Record<string, string>):
   const result: any = {}
   for (const key of Object.keys(pointers)) {
     if (pointers.hasOwnProperty(key)) {
-      result[key] = objectFromPointer(pointers[key])
+      result[key] = await objectFromPointer(pointers[key])
     }
   }
   return result

package/src/message.ts

@@ -1,6 +1,6 @@
-import { getAgent } from './setup'
+import { getAgent } from './setup.js'
 import { program } from 'commander'
-const fs = require('fs')
+import fs from 'fs'
 
 const message = program.command('message').description('Messages')
 
@@ -12,7 +12,7 @@ message
   .option('--save <boolean>', 'Save message', true)
 
   .action(async (options) => {
-    const agent = getAgent(program.opts().config)
+    const agent = await getAgent(program.opts().config)
     try {
       let raw