Merge pull request #349 from uport-project/next

chore: new release

.github/stale.yml

@@ -0,0 +1,17 @@
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 60
+# Number of days of inactivity before a stale issue is closed
+daysUntilClose: 7
+# Issues with these labels will never be considered stale
+exemptLabels:
+  - pinned
+  - security
+# Label to use when marking an issue as stale
+staleLabel: wontfix
+# Comment to post when marking an issue as stale. Set to `false` to disable
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. Thank you
+  for your contributions.
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: false

.github/workflows/run-tests.yml

@@ -14,7 +14,7 @@ jobs:
         with:
           fetch-depth: 0
       - name: Use Node.js
-        uses: actions/setup-node@v1
+        uses: actions/setup-node@v2
         with:
           node-version: '12.x'
 

.gitignore

@@ -12,6 +12,7 @@ website/node_modules
 
 /packages/*/build/
 /packages/*/api/*.api.json
+/packages/*/api/*.api.md
 /packages/*/coverage/
 /packages/*/node_modules/
 coverage

README.md

@@ -1,6 +1,28 @@
-[![codecov](https://codecov.io/gh/uport-project/veramo/branch/master/graph/badge.svg)](https://codecov.io/gh/uport-project/veramo)
-
-# Veramo DID Agent Framework
+[![Build, Test and Publish](https://github.com/uport-project/veramo/workflows/Build,%20Test%20and%20Publish/badge.svg?branch=next)](https://github.com/uport-project/veramo/actions?query=workflow%3A%22Build%2C+Test+and+Publish%22)
+[![codecov](https://codecov.io/gh/uport-project/veramo/branch/next/graph/badge.svg)](https://codecov.io/gh/uport-project/veramo)
+
+# Veramo
+Veramo is a JavaScript Framework for Verifiable Data that was designed from the ground up to be flexible and modular which makes it highly scalable. Create an agent, add plugins, run on server or mobile. You can also expose your agent over REST.
+
+Veramo runs on Node, Browsers, and React Native straight out of the box. Save time by using the same API across all platforms.
+
+## Documentation
+
+See the full docs on [veramo.io](https://veramo.io)
+
+- Agent
+    - [Intro](https://veramo.io/docs/agent/introduction)
+    - [Plugins](https://veramo.io/docs/agent/plugins)
+    - [Plugins Directory](https://veramo.io/docs/agent/plugins_list)
+- Guides
+    - [CLI](https://veramo.io/docs/guides/cli)
+    - [Node](https://veramo.io/docs/guides/nodejs)
+    - [Create React App](https://veramo.io/docs/guides/browser)
+    - [React Native](https://veramo.io/docs/guides/react_native)
+    - [Custom Plugin](https://veramo.io/docs/guides/create_plugin)
+    - [Cloud Agent](https://veramo.io/docs/guides/cloud_agent)
+- Advanced
+    - [Event System](https://veramo.io/docs/advanced/event_system)
 
 
 ## Local development

package.json

@@ -4,11 +4,11 @@
   "scripts": {
     "build": "lerna run build && yarn build:schema-api",
     "bootstrap": "lerna bootstrap",
-    "build:schema-api":"lerna run extract-api && lerna run generate-plugin-schema",
+    "build:schema-api": "lerna run extract-api && lerna run generate-plugin-schema",
     "lint": "echo \"linting not yet enabled\"",
     "test:integration-build": "yarn test:integration-prepare && yarn test:integration-pretty",
     "test:integration-prepare": "ts-node --project packages/tsconfig.settings.json ./scripts/prepare-integration-tests.ts",
-    "test:integration-pretty":"prettier --write __tests__/shared/documentationExamples.ts",
+    "test:integration-pretty": "prettier --write __tests__/shared/documentationExamples.ts",
     "test:integration": "yarn test:integration-build && yarn test:ci",
     "test:ci": "jest --config=jest.json --maxWorkers=2",
     "test": "jest --config=jest.json --coverage=false",
@@ -29,30 +29,30 @@
     }
   },
   "devDependencies": {
-    "@commitlint/cli": "^8.3.5",
-    "@commitlint/config-conventional": "^8.3.4",
-    "@microsoft/api-documenter": "7.8.56",
-    "@microsoft/api-extractor": "7.9.22",
-    "@microsoft/api-extractor-model": "7.9.7",
-    "@types/jest": "^25.1.4",
-    "codecov": "^3.6.5",
-    "cross-fetch": "^3.0.5",
-    "husky": "^4.2.5",
-    "jest": "^26.4.2",
-    "jest-fetch-mock": "^3.0.3",
-    "json-schema": "^0.2.5",
-    "lerna": "^3.20.2",
-    "lerna-changelog": "^1.0.1",
-    "oas-resolver": "^2.5.1",
-    "openapi-types": "^7.0.0",
-    "prettier": "2.0.5",
-    "pretty-quick": "^2.0.1",
-    "rimraf": "^3.0.2",
-    "semantic-release": "^17.0.4",
-    "ts-jest": "^26.4.0",
-    "ts-json-schema-generator": "^0.71.1",
-    "ts-node": "^8.6.2",
-    "typescript": "^4.0.3"
+    "@commitlint/cli": "11.0.0",
+    "@commitlint/config-conventional": "11.0.0",
+    "@microsoft/api-documenter": "7.12.6",
+    "@microsoft/api-extractor": "7.13.0",
+    "@microsoft/api-extractor-model": "7.12.1",
+    "@types/jest": "26.0.20",
+    "codecov": "3.8.1",
+    "cross-fetch": "3.0.6",
+    "husky": "4.3.8",
+    "jest": "26.6.3",
+    "jest-fetch-mock": "3.0.3",
+    "json-schema": "0.3.0",
+    "lerna": "3.22.1",
+    "lerna-changelog": "1.0.1",
+    "oas-resolver": "2.5.4",
+    "openapi-types": "7.2.3",
+    "prettier": "2.2.1",
+    "pretty-quick": "3.1.0",
+    "rimraf": "3.0.2",
+    "semantic-release": "17.3.7",
+    "ts-jest": "26.4.4",
+    "ts-json-schema-generator": "0.83.2",
+    "ts-node": "9.1.1",
+    "typescript": "4.1.3"
   },
   "repository": {
     "type": "git",
@@ -71,6 +71,6 @@
     ]
   },
   "dependencies": {
-    "rimraf": "^3.0.2"
+    "rimraf": "3.0.2"
   }
 }

packages/cli/package.json

@@ -14,7 +14,7 @@
     "update-veramo-latest": "yarn add @veramo/core@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.12.1",
+    "@microsoft/api-extractor": "7.13.0",
     "@microsoft/api-extractor-model": "7.12.1",
     "@types/blessed": "^0.1.17",
     "@types/swagger-ui-express": "^4.1.2",
@@ -35,7 +35,7 @@
     "@veramo/selective-disclosure": "^1.0.1",
     "@veramo/url-handler": "^1.0.1",
     "blessed": "^0.1.81",
-    "commander": "^6.1.0",
+    "commander": "^7.0.0",
     "console-table-printer": "^2.0.0",
     "cors": "^2.8.5",
     "cross-fetch": "^3.0.6",
@@ -50,7 +50,7 @@
     "handlebars": "^4.7.6",
     "inquirer": "^7.0.0",
     "inquirer-autocomplete-prompt": "^1.2.0",
-    "json-schema": "^0.2.5",
+    "json-schema": "^0.3.0",
     "jsonpointer": "^4.1.0",
     "ngrok": "^3.3.0",
     "oas-resolver": "^2.5.2",
@@ -61,8 +61,8 @@
     "qrcode-terminal": "^0.12.0",
     "sqlite3": "^5.0.0",
     "swagger-ui-express": "^4.1.4",
-    "ts-json-schema-generator": "^0.80.0",
-    "typeorm": "0.2.24",
+    "ts-json-schema-generator": "^0.83.0",
+    "typeorm": "0.2.30",
     "url-parse": "^1.4.7",
     "web-did-resolver": "^1.3.5",
     "ws": "^7.2.0",
@@ -71,10 +71,10 @@
   "devDependencies": {
     "@types/debug": "4.1.5",
     "@types/inquirer": "7.3.1",
-    "@types/node-fetch": "2.5.7",
-    "@types/passport-http-bearer": "^1.0.36",
-    "@types/ws": "7.2.6",
-    "typescript": "^4.0.3"
+    "@types/node-fetch": "2.5.8",
+    "@types/passport-http-bearer": "1.0.36",
+    "@types/ws": "7.4.0",
+    "typescript": "4.1.3"
   },
   "files": [
     "bin/**/*",

packages/cli/src/credential.ts

@@ -12,7 +12,7 @@ credential
   .option('-s, --send', 'Send')
   .option('-q, --qrcode', 'Show qrcode')
   .action(async (cmd) => {
-    const agent = getAgent(program.config)
+    const agent = getAgent(program.opts().config)
     const identifiers = await agent.didManagerFind()
     if (identifiers.length === 0) {
       console.error('No dids')

packages/cli/src/did.ts

@@ -10,7 +10,7 @@ did
   .command('providers')
   .description('list available identifier providers')
   .action(async (cmd) => {
-    const agent = getAgent(program.config)
+    const agent = 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.config)
+    const agent = 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.config)
+    const agent = getAgent(program.opts().config)
 
     try {
       const providers = await agent.didManagerGetProviders()
@@ -80,7 +80,7 @@ did
   .command('delete')
   .description('create an identifier')
   .action(async (cmd) => {
-    const agent = getAgent(program.config)
+    const agent = 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.config)
+    const agent = 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.config)
+    const agent = 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.config)
+    const agent = 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.config)
+    const agent = 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.config)
+    const agent = 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.config)
+    const agent = 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.config)
+    const agent = getAgent(program.opts().config)
     try {
       const ddo = await agent.resolveDid({ didUrl })
       console.log(ddo)

packages/cli/src/execute.ts

@@ -14,7 +14,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.config)
+    const agent = getAgent(program.opts().config)
 
     try {
       let method = options.method

packages/cli/src/explore/index.ts

@@ -6,6 +6,6 @@ program
   .command('explore')
   .description('launch Verifiable Data explorer')
   .action(async (cmd) => {
-    const agent = getAgent(program.config)
+    const agent = getAgent(program.opts().config)
     await renderMainScreen(agent)
   })

packages/cli/src/message.ts

@@ -12,7 +12,7 @@ message
   .option('--save <boolean>', 'Save message', true)
 
   .action(async (options) => {
-    const agent = getAgent(program.config)
+    const agent = getAgent(program.opts().config)
     try {
       let raw
 

packages/cli/src/presentation.ts

@@ -12,7 +12,7 @@ presentation
   .option('-s, --send', 'Send')
   .option('-q, --qrcode', 'Show qrcode')
   .action(async (cmd) => {
-    const agent = getAgent(program.config)
+    const agent = getAgent(program.opts().config)
     const myIdentifiers = await agent.didManagerFind()
     if (myIdentifiers.length === 0) {
       console.error('No dids')

packages/cli/src/sdr.ts

@@ -13,7 +13,7 @@ sdr
   .command('create', { isDefault: true })
   .description('create Selective Disclosure Request')
   .action(async (cmd) => {
-    const agent = getAgent(program.config)
+    const agent = getAgent(program.opts().config)
     const identifiers = await agent.didManagerFind()
 
     const knownDids = await agent.dataStoreORMGetIdentifiers()
@@ -253,7 +253,7 @@ sdr
   .command('respond')
   .description('respond to Selective Disclosure Request')
   .action(async (cmd) => {
-    const agent = getAgent(program.config)
+    const agent = getAgent(program.opts().config)
     const sdrMessages = await agent.dataStoreORMGetMessages({
       where: [{ column: 'type', value: ['sdr'] }],
       order: [{ column: 'createdAt', direction: 'DESC' }],

packages/cli/src/server.ts

@@ -26,8 +26,8 @@ program
   .action(async (cmd) => {
     const app = express()
     app.use(cors())
-    const agent = getAgent(program.config)
-    const { server: options } = createObjects(getConfig(program.config), { server: '/server' })
+    const agent = getAgent(program.opts().config)
+    const { server: options } = createObjects(getConfig(program.opts().config), { server: '/server' })
 
     /**
      * Ngrok configuration