refactor: Refactor and add inline documentation to daf-w3c package

BREAKING CHANGE: the `IW3c` type and `W3c` class have been renamed to `ICredentialIssuer` and `CredentialIssuer` fix(deps): update `did-resolver` and `did-jwt` libs for all packages to maintain type consistency
decentralized-identity · Sep 7, 2020 · f0e2cb9 · f0e2cb9
1 parent 72d6da2
commit f0e2cb9
Show file tree

Hide file tree

Showing 61 changed files with 540 additions and 323 deletions.
diff --git a/__tests__/graphqlAgent.test.ts b/__tests__/graphqlAgent.test.ts
@@ -15,7 +15,7 @@ import { IdentityManager } from 'daf-identity-manager'
 import { createConnection, Connection } from 'typeorm'
 import { DafResolver } from 'daf-resolver'
 import { JwtMessageHandler } from 'daf-did-jwt'
-import { W3c, IW3c, W3cMessageHandler } from 'daf-w3c'
+import { CredentialIssuer, ICredentialIssuer, W3cMessageHandler } from 'daf-w3c'
 import { EthrIdentityProvider } from 'daf-ethr-did'
 import { WebIdentityProvider } from 'daf-web-did'
 import { DIDComm, DIDCommMessageHandler, IDIDComm } from 'daf-did-comm'
@@ -47,7 +47,7 @@ const agent = createAgent<
     IResolveDid &
     IMessageHandler &
     IDIDComm &
-    IW3c &
+    ICredentialIssuer &
     ISdr
 >({
   plugins: [
@@ -106,7 +106,7 @@ const setup = async (): Promise<boolean> => {
         ],
       }),
       new DIDComm(),
-      new W3c(),
+      new CredentialIssuer(),
       new Sdr(),
     ],
   })

diff --git a/__tests__/localAgent.test.ts b/__tests__/localAgent.test.ts
@@ -13,7 +13,7 @@ import { IdentityManager } from 'daf-identity-manager'
 import { createConnection, Connection } from 'typeorm'
 import { DafResolver } from 'daf-resolver'
 import { JwtMessageHandler } from 'daf-did-jwt'
-import { W3c, IW3c, W3cMessageHandler } from 'daf-w3c'
+import { CredentialIssuer, ICredentialIssuer, W3cMessageHandler } from 'daf-w3c'
 import { EthrIdentityProvider } from 'daf-ethr-did'
 import { WebIdentityProvider } from 'daf-web-did'
 import { DIDComm, DIDCommMessageHandler, IDIDComm } from 'daf-did-comm'
@@ -41,7 +41,7 @@ let agent: TAgent<
     IResolveDid &
     IMessageHandler &
     IDIDComm &
-    IW3c &
+    ICredentialIssuer &
     ISdr
 >
 let dbConnection: Promise<Connection>
@@ -63,7 +63,7 @@ const setup = async (): Promise<boolean> => {
       IResolveDid &
       IMessageHandler &
       IDIDComm &
-      IW3c &
+      ICredentialIssuer &
       ISdr
   >({
     context: {
@@ -104,7 +104,7 @@ const setup = async (): Promise<boolean> => {
         ],
       }),
       new DIDComm(),
-      new W3c(),
+      new CredentialIssuer(),
       new Sdr(),
     ],
   })

diff --git a/__tests__/restAgent.test.ts b/__tests__/restAgent.test.ts
@@ -14,7 +14,7 @@ import { IdentityManager } from 'daf-identity-manager'
 import { createConnection, Connection } from 'typeorm'
 import { DafResolver } from 'daf-resolver'
 import { JwtMessageHandler } from 'daf-did-jwt'
-import { W3c, IW3c, W3cMessageHandler } from 'daf-w3c'
+import { CredentialIssuer, ICredentialIssuer, W3cMessageHandler } from 'daf-w3c'
 import { EthrIdentityProvider } from 'daf-ethr-did'
 import { WebIdentityProvider } from 'daf-web-did'
 import { DIDComm, DIDCommMessageHandler, IDIDComm } from 'daf-did-comm'
@@ -46,7 +46,7 @@ const agent = createAgent<
     IResolveDid &
     IMessageHandler &
     IDIDComm &
-    IW3c &
+    ICredentialIssuer &
     ISdr
 >({
   plugins: [
@@ -105,7 +105,7 @@ const setup = async (): Promise<boolean> => {
         ],
       }),
       new DIDComm(),
-      new W3c(),
+      new CredentialIssuer(),
       new Sdr(),
     ],
   })

diff --git a/__tests__/shared/createVerifiableCredential.ts b/__tests__/shared/createVerifiableCredential.ts
@@ -1,7 +1,7 @@
 import { TAgent, IIdentityManager, IIdentity } from 'daf-core'
-import { IW3c } from 'daf-w3c'
+import { ICredentialIssuer } from 'daf-w3c'
 
-type ConfiguredAgent = TAgent<IIdentityManager & IW3c>
+type ConfiguredAgent = TAgent<IIdentityManager & ICredentialIssuer>
 
 export default (testContext: {
   getAgent: () => ConfiguredAgent

diff --git a/__tests__/shared/handleSdrMessage.ts b/__tests__/shared/handleSdrMessage.ts
@@ -1,9 +1,11 @@
 import { TAgent, IIdentityManager, IIdentity, IDataStore, IMessageHandler } from 'daf-core'
-import { IW3c } from 'daf-w3c'
+import { ICredentialIssuer } from 'daf-w3c'
 import { ISdr } from 'daf-selective-disclosure'
 import { IDataStoreORM } from 'daf-typeorm'
 
-type ConfiguredAgent = TAgent<IIdentityManager & IW3c & IDataStoreORM & IDataStore & IMessageHandler & ISdr>
+type ConfiguredAgent = TAgent<
+  IIdentityManager & ICredentialIssuer & IDataStoreORM & IDataStore & IMessageHandler & ISdr
+>
 
 export default (testContext: {
   getAgent: () => ConfiguredAgent

diff --git a/__tests__/shared/saveClaims.ts b/__tests__/shared/saveClaims.ts
@@ -1,9 +1,11 @@
 import { TAgent, IIdentityManager, IIdentity, IDataStore, IMessageHandler } from 'daf-core'
-import { IW3c } from 'daf-w3c'
+import { ICredentialIssuer } from 'daf-w3c'
 import { ISdr } from 'daf-selective-disclosure'
 import { IDataStoreORM } from 'daf-typeorm'
 
-type ConfiguredAgent = TAgent<IIdentityManager & IW3c & IDataStoreORM & IDataStore & IMessageHandler & ISdr>
+type ConfiguredAgent = TAgent<
+  IIdentityManager & ICredentialIssuer & IDataStoreORM & IDataStore & IMessageHandler & ISdr
+>
 
 export default (testContext: {
   getAgent: () => ConfiguredAgent

diff --git a/__tests__/shared/webDidFlow.ts b/__tests__/shared/webDidFlow.ts
@@ -1,7 +1,7 @@
 import { TAgent, IIdentityManager, IIdentity, IKey } from 'daf-core'
-import { IW3c } from 'daf-w3c'
+import { ICredentialIssuer } from 'daf-w3c'
 
-type ConfiguredAgent = TAgent<IIdentityManager & IW3c>
+type ConfiguredAgent = TAgent<IIdentityManager & ICredentialIssuer>
 
 export default (testContext: {
   getAgent: () => ConfiguredAgent

diff --git a/docs/api/daf-core.createagent.md b/docs/api/daf-core.createagent.md
@@ -34,10 +34,10 @@ Use [TAgent](./daf-core.tagent.md) to configure agent type (list of available me
 ```typescript
 import { createAgent, IResolveDid, IMessageHandler } from 'daf-core'
 import { AgentRestClient } from 'daf-rest'
-import { W3c, IW3c } from 'daf-w3c'
-const agent = createAgent<IResolveDid & IMessageHandler & IW3c>({
+import { CredentialIssuer, ICredentialIssuer } from 'daf-w3c'
+const agent = createAgent<IResolveDid & IMessageHandler & ICredentialIssuer>({
   plugins: [
-    new W3c(),
+    new CredentialIssuer(),
     new AgentRestClient({
       url: 'http://localhost:3002/agent',
       enabledMethods: [

diff --git a/docs/api/daf-typeorm.entities.md b/docs/api/daf-typeorm.entities.md
@@ -7,5 +7,5 @@
 <b>Signature:</b>
 
 ```typescript
-Entities: (typeof Key | typeof Identity | typeof Service | typeof Claim | typeof Credential | typeof Presentation | typeof Message)[]
+Entities: (typeof Credential | typeof Identity | typeof Claim | typeof Presentation | typeof Message | typeof Key | typeof Service)[]
 ```
diff --git a/docs/api/daf-w3c.credentialissuer._constructor_.md b/docs/api/daf-w3c.credentialissuer._constructor_.md
@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [daf-w3c](./daf-w3c.md) &gt; [CredentialIssuer](./daf-w3c.credentialissuer.md) &gt; [(constructor)](./daf-w3c.credentialissuer._constructor_.md)
+
+## CredentialIssuer.(constructor)
+
+Constructs a new instance of the `CredentialIssuer` class
+
+<b>Signature:</b>
+
+```typescript
+constructor();
+```
diff --git a/docs/api/daf-w3c.credentialissuer.createverifiablecredential.md b/docs/api/daf-w3c.credentialissuer.createverifiablecredential.md
@@ -0,0 +1,31 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [daf-w3c](./daf-w3c.md) &gt; [CredentialIssuer](./daf-w3c.credentialissuer.md) &gt; [createVerifiableCredential](./daf-w3c.credentialissuer.createverifiablecredential.md)
+
+## CredentialIssuer.createVerifiableCredential() method
+
+Creates a Verifiable Credential. The payload, signer and format are chosen based on the `args` parameter.
+
+<b>Signature:</b>
+
+```typescript
+createVerifiableCredential(args: ICreateVerifiableCredentialArgs, context: IContext): Promise<VerifiableCredential>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  args | [ICreateVerifiableCredentialArgs](./daf-w3c.icreateverifiablecredentialargs.md) | Arguments necessary to create the Presentation. |
+|  context | IContext | This reserved param is automatically added and handled by the framework, \*do not override\* |
+
+<b>Returns:</b>
+
+Promise&lt;[VerifiableCredential](./daf-core.verifiablecredential.md)<!-- -->&gt;
+
+- a promise that resolves to the [VerifiableCredential](./daf-core.verifiablecredential.md) that was requested or rejects with an error if there was a problem with the input or while getting the key to sign
+
+## Remarks
+
+Please see [Verifiable Credential data model](https://www.w3.org/TR/vc-data-model/#credentials)
+
diff --git a/docs/api/daf-w3c.credentialissuer.createverifiablepresentation.md b/docs/api/daf-w3c.credentialissuer.createverifiablepresentation.md
@@ -0,0 +1,31 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [daf-w3c](./daf-w3c.md) &gt; [CredentialIssuer](./daf-w3c.credentialissuer.md) &gt; [createVerifiablePresentation](./daf-w3c.credentialissuer.createverifiablepresentation.md)
+
+## CredentialIssuer.createVerifiablePresentation() method
+
+Creates a Verifiable Presentation. The payload, signer and format are chosen based on the `args` parameter.
+
+<b>Signature:</b>
+
+```typescript
+createVerifiablePresentation(args: ICreateVerifiablePresentationArgs, context: IContext): Promise<VerifiablePresentation>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  args | [ICreateVerifiablePresentationArgs](./daf-w3c.icreateverifiablepresentationargs.md) | Arguments necessary to create the Presentation. |
+|  context | IContext | This reserved param is automatically added and handled by the framework, \*do not override\* |
+
+<b>Returns:</b>
+
+Promise&lt;[VerifiablePresentation](./daf-core.verifiablepresentation.md)<!-- -->&gt;
+
+- a promise that resolves to the [VerifiablePresentation](./daf-core.verifiablepresentation.md) that was requested or rejects with an error if there was a problem with the input or while getting the key to sign
+
+## Remarks
+
+Please see [Verifiable Presentation data model](https://www.w3.org/TR/vc-data-model/#presentations)
+
diff --git a/docs/api/daf-w3c.credentialissuer.md b/docs/api/daf-w3c.credentialissuer.md
@@ -0,0 +1,34 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [daf-w3c](./daf-w3c.md) &gt; [CredentialIssuer](./daf-w3c.credentialissuer.md)
+
+## CredentialIssuer class
+
+A DAF plugin that implements the [ICredentialIssuer](./daf-w3c.icredentialissuer.md) methods.
+
+<b>Signature:</b>
+
+```typescript
+export declare class CredentialIssuer implements IAgentPlugin 
+```
+<b>Implements:</b> [IAgentPlugin](./daf-core.iagentplugin.md)
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)()](./daf-w3c.credentialissuer._constructor_.md) |  | Constructs a new instance of the <code>CredentialIssuer</code> class |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [methods](./daf-w3c.credentialissuer.methods.md) |  | [ICredentialIssuer](./daf-w3c.icredentialissuer.md) |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [createVerifiableCredential(args, context)](./daf-w3c.credentialissuer.createverifiablecredential.md) |  | Creates a Verifiable Credential. The payload, signer and format are chosen based on the <code>args</code> parameter. |
+|  [createVerifiablePresentation(args, context)](./daf-w3c.credentialissuer.createverifiablepresentation.md) |  | Creates a Verifiable Presentation. The payload, signer and format are chosen based on the <code>args</code> parameter. |
+
diff --git a/docs/api/daf-w3c.credentialissuer.methods.md b/docs/api/daf-w3c.credentialissuer.methods.md
@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [daf-w3c](./daf-w3c.md) &gt; [CredentialIssuer](./daf-w3c.credentialissuer.md) &gt; [methods](./daf-w3c.credentialissuer.methods.md)
+
+## CredentialIssuer.methods property
+
+<b>Signature:</b>
+
+```typescript
+readonly methods: ICredentialIssuer;
+```
diff --git a/docs/api/daf-w3c.icreateverifiablecredentialargs.credential.md b/docs/api/daf-w3c.icreateverifiablecredentialargs.credential.md
@@ -4,6 +4,10 @@
 
 ## ICreateVerifiableCredentialArgs.credential property
 
+The json payload of the Credential according to the [canonical model](https://www.w3.org/TR/vc-data-model/#credentials)
+
+The signer of the Credential is chosen based on the `issuer.id` property of the `credential`
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/api/daf-w3c.icreateverifiablecredentialargs.md b/docs/api/daf-w3c.icreateverifiablecredentialargs.md
@@ -4,6 +4,8 @@
 
 ## ICreateVerifiableCredentialArgs interface
 
+Encapsulates the parameters required to create a [W3C Verifiable Credential](https://www.w3.org/TR/vc-data-model/#credentials)
+
 <b>Signature:</b>
 
 ```typescript
@@ -14,7 +16,7 @@ export interface ICreateVerifiableCredentialArgs
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [credential](./daf-w3c.icreateverifiablecredentialargs.credential.md) | W3CCredential |  |
-|  [proofFormat](./daf-w3c.icreateverifiablecredentialargs.proofformat.md) | 'jwt' |  |
-|  [save](./daf-w3c.icreateverifiablecredentialargs.save.md) | boolean |  |
+|  [credential](./daf-w3c.icreateverifiablecredentialargs.credential.md) | W3CCredential | The json payload of the Credential according to the [canonical model](https://www.w3.org/TR/vc-data-model/#credentials)<!-- -->The signer of the Credential is chosen based on the <code>issuer.id</code> property of the <code>credential</code> |
+|  [proofFormat](./daf-w3c.icreateverifiablecredentialargs.proofformat.md) | EncodingFormat | The desired format for the VerifiablePresentation to be created. Currently, only JWT is supported |
+|  [save](./daf-w3c.icreateverifiablecredentialargs.save.md) | boolean | If this parameter is true, the resulting VerifiablePresentation is sent to the [storage plugin](./daf-core.idatastore.md) to be saved |
 
diff --git a/docs/api/daf-w3c.icreateverifiablecredentialargs.proofformat.md b/docs/api/daf-w3c.icreateverifiablecredentialargs.proofformat.md
@@ -4,8 +4,10 @@
 
 ## ICreateVerifiableCredentialArgs.proofFormat property
 
+The desired format for the VerifiablePresentation to be created. Currently, only JWT is supported
+
 <b>Signature:</b>
 
 ```typescript
-proofFormat: 'jwt';
+proofFormat: EncodingFormat;
 ```
diff --git a/docs/api/daf-w3c.icreateverifiablecredentialargs.save.md b/docs/api/daf-w3c.icreateverifiablecredentialargs.save.md
@@ -4,6 +4,8 @@
 
 ## ICreateVerifiableCredentialArgs.save property
 
+If this parameter is true, the resulting VerifiablePresentation is sent to the [storage plugin](./daf-core.idatastore.md) to be saved
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/api/daf-w3c.icreateverifiablepresentationargs.md b/docs/api/daf-w3c.icreateverifiablepresentationargs.md
@@ -4,6 +4,8 @@
 
 ## ICreateVerifiablePresentationArgs interface
 
+Encapsulates the parameters required to create a [W3C Verifiable Presentation](https://www.w3.org/TR/vc-data-model/#presentations)
+
 <b>Signature:</b>
 
 ```typescript
@@ -14,7 +16,7 @@ export interface ICreateVerifiablePresentationArgs
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [presentation](./daf-w3c.icreateverifiablepresentationargs.presentation.md) | W3CPresentation |  |
-|  [proofFormat](./daf-w3c.icreateverifiablepresentationargs.proofformat.md) | 'jwt' |  |
-|  [save](./daf-w3c.icreateverifiablepresentationargs.save.md) | boolean |  |
+|  [presentation](./daf-w3c.icreateverifiablepresentationargs.presentation.md) | W3CPresentation | The json payload of the Presentation according to the [canonical model](https://www.w3.org/TR/vc-data-model/#presentations)<!-- -->.<!-- -->The signer of the Presentation is chosen based on the <code>holder</code> property of the <code>presentation</code> |
+|  [proofFormat](./daf-w3c.icreateverifiablepresentationargs.proofformat.md) | EncodingFormat | The desired format for the VerifiablePresentation to be created. Currently, only JWT is supported |
+|  [save](./daf-w3c.icreateverifiablepresentationargs.save.md) | boolean | If this parameter is true, the resulting VerifiablePresentation is sent to the [storage plugin](./daf-core.idatastore.md) to be saved |
 
diff --git a/docs/api/daf-w3c.icreateverifiablepresentationargs.presentation.md b/docs/api/daf-w3c.icreateverifiablepresentationargs.presentation.md
@@ -4,6 +4,10 @@
 
 ## ICreateVerifiablePresentationArgs.presentation property
 
+The json payload of the Presentation according to the [canonical model](https://www.w3.org/TR/vc-data-model/#presentations)<!-- -->.
+
+The signer of the Presentation is chosen based on the `holder` property of the `presentation`
+
 <b>Signature:</b>
 
 ```typescript

diff --git a/docs/api/daf-w3c.icreateverifiablepresentationargs.proofformat.md b/docs/api/daf-w3c.icreateverifiablepresentationargs.proofformat.md
@@ -4,8 +4,10 @@
 
 ## ICreateVerifiablePresentationArgs.proofFormat property
 
+The desired format for the VerifiablePresentation to be created. Currently, only JWT is supported
+
 <b>Signature:</b>
 
 ```typescript
-proofFormat: 'jwt';
+proofFormat: EncodingFormat;
 ```
diff --git a/docs/api/daf-w3c.icreateverifiablepresentationargs.save.md b/docs/api/daf-w3c.icreateverifiablepresentationargs.save.md
@@ -4,6 +4,8 @@
 
 ## ICreateVerifiablePresentationArgs.save property
 
+If this parameter is true, the resulting VerifiablePresentation is sent to the [storage plugin](./daf-core.idatastore.md) to be saved
+
 <b>Signature:</b>
 
 ```typescript