feat(cli): export new agent methods and request LD DIDDocument by def…

…ault (#617) * refactor(core): fix param & return types for getDIDComponentById * feat(cli): export new agent methods by default * `getDIDComponentById` from did-resolver * `packDIDCommMessage` from did-comm * `unpackDIDCommMessage` from did-comm * `sendDIDCommMessage` from did-comm * fix(deps): update builders-and-testers * fix(did-resolver): request LD DIDDocument by default
decentralized-identity · Jul 14, 2021 · 26d088b · 26d088b
1 parent 3c33265
commit 26d088b
Show file tree

Hide file tree

Showing 12 changed files with 2,200 additions and 4,104 deletions.
diff --git a/__tests__/localAgent.test.ts b/__tests__/localAgent.test.ts
@@ -159,7 +159,7 @@ const setup = async (options?: IAgentOptions): Promise<boolean> => {
       new DIDDiscovery({
         providers: [new AliasDiscoveryProvider(), new ProfileDiscoveryProvider()],
       }),
-      ...options?.plugins || [],
+      ...(options?.plugins || []),
     ],
   })
   return true

diff --git a/__tests__/localMemoryStoreAgent.test.ts b/__tests__/localMemoryStoreAgent.test.ts
@@ -142,7 +142,7 @@ const setup = async (options?: IAgentOptions): Promise<boolean> => {
       new DIDComm(),
       new CredentialIssuer(),
       new SelectiveDisclosure(),
-      ...options?.plugins || [],
+      ...(options?.plugins || []),
     ],
   })
   return true

diff --git a/__tests__/restAgent.test.ts b/__tests__/restAgent.test.ts
@@ -169,7 +169,7 @@ const setup = async (options?: IAgentOptions): Promise<boolean> => {
       new DIDDiscovery({
         providers: [new AliasDiscoveryProvider(), new ProfileDiscoveryProvider()],
       }),
-      ...options?.plugins || [],
+      ...(options?.plugins || []),
     ],
   })
 

diff --git a/package.json b/package.json
@@ -32,9 +32,9 @@
   "devDependencies": {
     "@commitlint/cli": "12.1.4",
     "@commitlint/config-conventional": "12.1.4",
-    "@microsoft/api-documenter": "7.13.30",
-    "@microsoft/api-extractor": "7.18.1",
-    "@microsoft/api-extractor-model": "7.13.3",
+    "@microsoft/api-documenter": "7.13.31",
+    "@microsoft/api-extractor": "7.18.2",
+    "@microsoft/api-extractor-model": "7.13.4",
     "@types/jest": "26.0.24",
     "codecov": "3.8.2",
     "cross-fetch": "3.1.4",

diff --git a/packages/cli/default/default.yml b/packages/cli/default/default.yml
@@ -3,6 +3,7 @@ version: 2.0
 constants:
   baseUrl: http://localhost:3332
   port: 3332
+  # please use your own X25519 key, this is only an example
   secretKey: 29739248cad1bd1a0fc4d9b75cd4d2990de535baf5caadfdf8d8f86664aa830c
   databaseFile: ./database.sqlite
   methods:
@@ -28,6 +29,7 @@ constants:
     - didManagerAddService
     - didManagerRemoveService
     - resolveDid
+    - getDIDComponentById
     - discoverDid
     - dataStoreGetMessage
     - dataStoreSaveMessage
@@ -46,6 +48,9 @@ constants:
     - dataStoreORMGetVerifiablePresentations
     - dataStoreORMGetVerifiablePresentationsCount
     - handleMessage
+    - packDIDCommMessage
+    - unpackDIDCommMessage
+    - sendDIDCommMessage
     - sendMessageDIDCommAlpha1
     - createVerifiablePresentation
     - createVerifiableCredential

diff --git a/packages/cli/package.json b/packages/cli/package.json
@@ -14,8 +14,8 @@
     "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.18.1",
-    "@microsoft/api-extractor-model": "7.13.3",
+    "@microsoft/api-extractor": "7.18.2",
+    "@microsoft/api-extractor-model": "7.13.4",
     "@types/blessed": "^0.1.17",
     "@types/swagger-ui-express": "^4.1.2",
     "@veramo/core": "^1.2.0",
@@ -54,7 +54,6 @@
     "inquirer-autocomplete-prompt": "^1.2.0",
     "json-schema": "^0.3.0",
     "jsonpointer": "^4.1.0",
-    "ngrok": "^4.0.0",
     "oas-resolver": "^2.5.3",
     "openapi-types": "^9.0.0",
     "passport": "^0.4.1",

diff --git a/packages/core/plugin.schema.json b/packages/core/plugin.schema.json
@@ -2,67 +2,27 @@
   "IResolver": {
     "components": {
       "schemas": {
-        "ResolveDidArgs": {
+        "GetDIDComponentArgs": {
           "type": "object",
           "properties": {
+            "didDocument": {
+              "$ref": "#/components/schemas/DIDDocument",
+              "description": "the DID document from which to extract the fragment. This MUST be the document resolved by  {@link  resolveDid }"
+            },
             "didUrl": {
               "type": "string",
-              "description": "DID URL"
+              "description": "The DID URI that refers to the subsection by #fragment. Example: did:example:identifier#controller"
             },
-            "options": {
-              "$ref": "#/components/schemas/DIDResolutionOptions",
-              "description": "DID resolution options that will be passed to the method specific resolver. See: https://w3c.github.io/did-spec-registries/#did-resolution-input-metadata See: https://www.w3.org/TR/did-core/#did-resolution-options"
+            "section": {
+              "$ref": "#/components/schemas/DIDDocumentSection",
+              "description": "The section of the DID document where to search for the fragment. Example 'keyAgreement', or 'assertionMethod', or 'authentication', etc"
             }
           },
           "required": [
+            "didDocument",
             "didUrl"
           ],
-          "description": "Input arguments for  {@link  IResolver.resolveDid | resolveDid }"
-        },
-        "DIDResolutionOptions": {
-          "type": "object",
-          "properties": {
-            "accept": {
-              "type": "string"
-            }
-          }
-        },
-        "DIDResolutionResult": {
-          "type": "object",
-          "properties": {
-            "didResolutionMetadata": {
-              "$ref": "#/components/schemas/DIDResolutionMetadata"
-            },
-            "didDocument": {
-              "anyOf": [
-                {
-                  "$ref": "#/components/schemas/DIDDocument"
-                },
-                {
-                  "type": "null"
-                }
-              ]
-            },
-            "didDocumentMetadata": {
-              "$ref": "#/components/schemas/DIDDocumentMetadata"
-            }
-          },
-          "required": [
-            "didResolutionMetadata",
-            "didDocument",
-            "didDocumentMetadata"
-          ]
-        },
-        "DIDResolutionMetadata": {
-          "type": "object",
-          "properties": {
-            "contentType": {
-              "type": "string"
-            },
-            "error": {
-              "type": "string"
-            }
-          }
+          "description": "Input arguments for  {@link  IResolver.getDIDComponentById | getDIDComponentById }"
         },
         "DIDDocument": {
           "type": "object",
@@ -291,6 +251,92 @@
             "serviceEndpoint"
           ]
         },
+        "DIDDocumentSection": {
+          "type": "string",
+          "enum": [
+            "verificationMethod",
+            "publicKey",
+            "service",
+            "authentication",
+            "assertionMethod",
+            "keyAgreement",
+            "capabilityInvocation",
+            "capabilityDelegation"
+          ]
+        },
+        "DIDDocComponent": {
+          "anyOf": [
+            {
+              "$ref": "#/components/schemas/VerificationMethod"
+            },
+            {
+              "$ref": "#/components/schemas/ServiceEndpoint"
+            }
+          ],
+          "description": "Return type of  {@link  IResolver.getDIDComponentById | getDIDComponentById } \nrepresents a `VerificationMethod` or a `ServiceEndpoint` entry from a  {@link  did-resolver#DIDDocument | DIDDocument }"
+        },
+        "ResolveDidArgs": {
+          "type": "object",
+          "properties": {
+            "didUrl": {
+              "type": "string",
+              "description": "DID URL"
+            },
+            "options": {
+              "$ref": "#/components/schemas/DIDResolutionOptions",
+              "description": "DID resolution options that will be passed to the method specific resolver. See: https://w3c.github.io/did-spec-registries/#did-resolution-input-metadata See: https://www.w3.org/TR/did-core/#did-resolution-options"
+            }
+          },
+          "required": [
+            "didUrl"
+          ],
+          "description": "Input arguments for  {@link  IResolver.resolveDid | resolveDid }"
+        },
+        "DIDResolutionOptions": {
+          "type": "object",
+          "properties": {
+            "accept": {
+              "type": "string"
+            }
+          }
+        },
+        "DIDResolutionResult": {
+          "type": "object",
+          "properties": {
+            "didResolutionMetadata": {
+              "$ref": "#/components/schemas/DIDResolutionMetadata"
+            },
+            "didDocument": {
+              "anyOf": [
+                {
+                  "$ref": "#/components/schemas/DIDDocument"
+                },
+                {
+                  "type": "null"
+                }
+              ]
+            },
+            "didDocumentMetadata": {
+              "$ref": "#/components/schemas/DIDDocumentMetadata"
+            }
+          },
+          "required": [
+            "didResolutionMetadata",
+            "didDocument",
+            "didDocumentMetadata"
+          ]
+        },
+        "DIDResolutionMetadata": {
+          "type": "object",
+          "properties": {
+            "contentType": {
+              "type": "string"
+            },
+            "error": {
+              "type": "string"
+            }
+          }
+        },
         "DIDDocumentMetadata": {
           "type": "object",
           "properties": {
@@ -322,8 +368,17 @@
         }
       },
       "methods": {
+        "getDIDComponentById": {
+          "description": "Dereferences a DID URL fragment and returns the corresponding DID document entry.",
+          "arguments": {
+            "$ref": "#/components/schemas/GetDIDComponentArgs"
+          },
+          "returnType": {
+            "$ref": "#/components/schemas/DIDDocComponent"
+          }
+        },
         "resolveDid": {
-          "description": "Resolves DID and returns DID Document",
+          "description": "Resolves DID and returns DID Resolution Result",
           "arguments": {
             "$ref": "#/components/schemas/ResolveDidArgs"
           },

diff --git a/packages/core/src/types/IResolver.ts b/packages/core/src/types/IResolver.ts
@@ -29,6 +29,33 @@ export interface ResolveDidArgs {
   options?: DIDResolutionOptions
 }
 
+/**
+ * Input arguments for {@link IResolver.getDIDComponentById | getDIDComponentById}
+ * @beta
+ */
+export interface GetDIDComponentArgs {
+  /**
+   * the DID document from which to extract the fragment. This MUST be the document resolved by {@link resolveDid}
+   */
+  didDocument: DIDDocument
+  /**
+   * The DID URI that refers to the subsection by #fragment. Example: did:example:identifier#controller
+   */
+  didUrl: string
+  /**
+   * The section of the DID document where to search for the fragment. Example 'keyAgreement', or 'assertionMethod',
+   * or 'authentication', etc
+   */
+  section?: DIDDocumentSection
+}
+
+/**
+ * Return type of {@link IResolver.getDIDComponentById | getDIDComponentById}
+ * represents a `VerificationMethod` or a `ServiceEndpoint` entry from a {@link did-resolver#DIDDocument | DIDDocument}
+ * @beta
+ */
+export type DIDDocComponent = VerificationMethod | ServiceEndpoint
+
 /**
  * DID Resolver interface
  * @public
@@ -98,20 +125,7 @@ export interface IResolver extends IPluginMethodMap {
    *
    * @beta
    */
-  getDIDComponentById(args: {
-    /**
-     * the DID document from which to extract the fragment. This MUST be the document resolved by {@link resolveDid}
-     */
-    didDocument: DIDDocument
-    /**
-     * The DID URI that refers to the subsection by #fragment. Example: did:example:identifier#controller
-     */
-    didUrl: string
-    /**
-     * The section of the DID document where to search for the fragment. Example 'keyAgreement'
-     */
-    section?: DIDDocumentSection
-  }): Promise<VerificationMethod | ServiceEndpoint>
+  getDIDComponentById(args: GetDIDComponentArgs): Promise<DIDDocComponent>
 }
 
 export type DIDDocumentSection =

diff --git a/packages/did-provider-key/package.json b/packages/did-provider-key/package.json
@@ -9,7 +9,7 @@
     "extract-api": "yarn veramo dev extract-api"
   },
   "dependencies": {
-    "@transmute/did-key.js": "^0.2.1-unstable",
+    "@transmute/did-key.js": "^0.3.0-unstable",
     "@veramo/core": "^1.2.0",
     "@veramo/did-manager": "^1.2.0",
     "debug": "^4.1.1",

diff --git a/packages/did-provider-key/src/resolver.ts b/packages/did-provider-key/src/resolver.ts
@@ -1,14 +1,14 @@
-import { resolver } from '@transmute/did-key.js'
+import { resolve } from '@transmute/did-key.js'
 import { DIDResolutionOptions, DIDResolutionResult, DIDResolver, ParsedDID, Resolvable } from 'did-resolver'
 
-const resolve: DIDResolver = async (
+const resolveDidKey: DIDResolver = async (
   didUrl: string,
   _parsed: ParsedDID,
   _resolver: Resolvable,
   options: DIDResolutionOptions,
 ): Promise<DIDResolutionResult> => {
   try {
-    const didResolution = (await resolver.resolve(didUrl, options)) as DIDResolutionResult
+    const didResolution = (await resolve(didUrl, options as any)) as DIDResolutionResult
     return didResolution
   } catch (err) {
     return {
@@ -20,5 +20,5 @@ const resolve: DIDResolver = async (
 }
 
 export function getDidKeyResolver() {
-  return { key: resolve }
+  return { key: resolveDidKey }
 }
diff --git a/packages/did-resolver/src/resolver.ts b/packages/did-resolver/src/resolver.ts
@@ -40,7 +40,11 @@ export class DIDResolverPlugin implements IAgentPlugin {
     options?: DIDResolutionOptions
   }): Promise<DIDResolutionResult> {
     debug('Resolving %s', didUrl)
-    return this.didResolver.resolve(didUrl, options)
+    const resolverOptions = {
+      accept: 'application/did+ld+json',
+      ...options,
+    }
+    return this.didResolver.resolve(didUrl, resolverOptions)
   }
 
   /** {@inheritDoc @veramo/core#IResolver.getDIDComponentById} */