@twin.org/standards-w3c-did 0.0.1-next.9 → 0.0.2-next.1

package/docs/reference/classes/DataIntegrityProofSignerVerifier.md

@@ -0,0 +1,134 @@
+# Class: DataIntegrityProofSignerVerifier
+
+Helper methods for creating and verifying proofs.
+https://www.w3.org/TR/vc-di-eddsa/#eddsa-jcs-2022
+
+## Implements
+
+- [`IProofSignerVerifier`](../interfaces/IProofSignerVerifier.md)
+
+## Constructors
+
+### Constructor
+
+> **new DataIntegrityProofSignerVerifier**(): `DataIntegrityProofSignerVerifier`
+
+#### Returns
+
+`DataIntegrityProofSignerVerifier`
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### createProof()
+
+> **createProof**(`unsecuredDocument`, `unsignedProof`, `signKey`): `Promise`\<[`IProof`](../type-aliases/IProof.md)\>
+
+Create a proof for the given data.
+
+#### Parameters
+
+##### unsecuredDocument
+
+`IJsonLdNodeObject`
+
+The data to create the proof for.
+
+##### unsignedProof
+
+[`IDataIntegrityProof`](../interfaces/IDataIntegrityProof.md)
+
+The proof options.
+
+##### signKey
+
+`IJwk`
+
+The key to sign the proof with.
+
+#### Returns
+
+`Promise`\<[`IProof`](../type-aliases/IProof.md)\>
+
+The created proof.
+
+#### Implementation of
+
+[`IProofSignerVerifier`](../interfaces/IProofSignerVerifier.md).[`createProof`](../interfaces/IProofSignerVerifier.md#createproof)
+
+***
+
+### verifyProof()
+
+> **verifyProof**(`securedDocument`, `signedProof`, `verifyKey`): `Promise`\<`boolean`\>
+
+Verify a proof for the given data in format.
+
+#### Parameters
+
+##### securedDocument
+
+`IJsonLdNodeObject`
+
+The credential to verify.
+
+##### signedProof
+
+[`IDataIntegrityProof`](../interfaces/IDataIntegrityProof.md)
+
+The proof to verify.
+
+##### verifyKey
+
+`IJwk`
+
+The public key to verify the proof with.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+True if the credential was verified.
+
+#### Implementation of
+
+[`IProofSignerVerifier`](../interfaces/IProofSignerVerifier.md).[`verifyProof`](../interfaces/IProofSignerVerifier.md#verifyproof)
+
+***
+
+### createHash()
+
+> **createHash**(`unsecuredDocument`, `unsignedProof`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
+
+Create a hash for the given data.
+
+#### Parameters
+
+##### unsecuredDocument
+
+`IJsonLdNodeObject`
+
+The data to create the proof for.
+
+##### unsignedProof
+
+[`IDataIntegrityProof`](../interfaces/IDataIntegrityProof.md)
+
+The unsigned proof.
+
+#### Returns
+
+`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
+
+The created hash.
+
+#### Implementation of
+
+[`IProofSignerVerifier`](../interfaces/IProofSignerVerifier.md).[`createHash`](../interfaces/IProofSignerVerifier.md#createhash)

package/docs/reference/classes/JsonWebSignature2020SignerVerifier.md

@@ -0,0 +1,133 @@
+# Class: JsonWebSignature2020SignerVerifier
+
+Helper methods for creating and verifying proofs.
+
+## Implements
+
+- [`IProofSignerVerifier`](../interfaces/IProofSignerVerifier.md)
+
+## Constructors
+
+### Constructor
+
+> **new JsonWebSignature2020SignerVerifier**(): `JsonWebSignature2020SignerVerifier`
+
+#### Returns
+
+`JsonWebSignature2020SignerVerifier`
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### createProof()
+
+> **createProof**(`unsecuredDocument`, `unsignedProof`, `signKey`): `Promise`\<[`IJsonWebSignature2020Proof`](../interfaces/IJsonWebSignature2020Proof.md)\>
+
+Create a proof for the given data.
+
+#### Parameters
+
+##### unsecuredDocument
+
+`IJsonLdNodeObject`
+
+The data to create the proof for.
+
+##### unsignedProof
+
+[`IJsonWebSignature2020Proof`](../interfaces/IJsonWebSignature2020Proof.md)
+
+The proof options.
+
+##### signKey
+
+`IJwk`
+
+The key to sign the proof with.
+
+#### Returns
+
+`Promise`\<[`IJsonWebSignature2020Proof`](../interfaces/IJsonWebSignature2020Proof.md)\>
+
+The created proof.
+
+#### Implementation of
+
+[`IProofSignerVerifier`](../interfaces/IProofSignerVerifier.md).[`createProof`](../interfaces/IProofSignerVerifier.md#createproof)
+
+***
+
+### verifyProof()
+
+> **verifyProof**(`securedDocument`, `signedProof`, `verifyKey`): `Promise`\<`boolean`\>
+
+Verify a proof for the given data in format.
+
+#### Parameters
+
+##### securedDocument
+
+`IJsonLdNodeObject`
+
+The credential to verify.
+
+##### signedProof
+
+[`IJsonWebSignature2020Proof`](../interfaces/IJsonWebSignature2020Proof.md)
+
+The proof to verify.
+
+##### verifyKey
+
+`IJwk`
+
+The public key to verify the proof with.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+True if the credential was verified.
+
+#### Implementation of
+
+[`IProofSignerVerifier`](../interfaces/IProofSignerVerifier.md).[`verifyProof`](../interfaces/IProofSignerVerifier.md#verifyproof)
+
+***
+
+### createHash()
+
+> **createHash**(`unsecuredDocument`, `unsignedProof`): `Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
+
+Create a hash for the given data.
+
+#### Parameters
+
+##### unsecuredDocument
+
+`IJsonLdNodeObject`
+
+The data to create the proof for.
+
+##### unsignedProof
+
+[`IJsonWebSignature2020Proof`](../interfaces/IJsonWebSignature2020Proof.md)
+
+The unsigned proof.
+
+#### Returns
+
+`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
+
+The created hash.
+
+#### Implementation of
+
+[`IProofSignerVerifier`](../interfaces/IProofSignerVerifier.md).[`createHash`](../interfaces/IProofSignerVerifier.md#createhash)

package/docs/reference/classes/MultikeyHelper.md

@@ -0,0 +1,119 @@
+# Class: MultikeyHelper
+
+Helper methods for multikey.
+
+## Constructors
+
+### Constructor
+
+> **new MultikeyHelper**(): `MultikeyHelper`
+
+#### Returns
+
+`MultikeyHelper`
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### toJwk()
+
+> `static` **toJwk**(`multikey`): `IJwk`
+
+Convert a multikey to a JWK.
+
+#### Parameters
+
+##### multikey
+
+[`IMultikey`](../interfaces/IMultikey.md)
+
+The multikey to convert.
+
+#### Returns
+
+`IJwk`
+
+The JWK.
+
+#### Throws
+
+GeneralError if the multikey is invalid.
+
+***
+
+### fromJwk()
+
+> `static` **fromJwk**(`controller`, `id`, `jwk`): [`IMultikey`](../interfaces/IMultikey.md)
+
+Convert a JWK to a Multikey.
+
+#### Parameters
+
+##### controller
+
+`string`
+
+The controller of the multikey.
+
+##### id
+
+`string`
+
+The id of the multikey.
+
+##### jwk
+
+`IJwk`
+
+The jwk to convert.
+
+#### Returns
+
+[`IMultikey`](../interfaces/IMultikey.md)
+
+The multikey.
+
+#### Throws
+
+GeneralError if the jwk is invalid.
+
+***
+
+### toRaw()
+
+> `static` **toRaw**(`multikey`): `object`
+
+Convert a multikey to raw keys.
+
+#### Parameters
+
+##### multikey
+
+[`IMultikey`](../interfaces/IMultikey.md)
+
+The multikey to convert.
+
+#### Returns
+
+`object`
+
+The JWK.
+
+##### publicKey
+
+> **publicKey**: `Uint8Array`
+
+##### privateKey
+
+> **privateKey**: `Uint8Array`
+
+#### Throws
+
+GeneralError if the multikey is invalid.

package/docs/reference/classes/ProofHelper.md

@@ -0,0 +1,159 @@
+# Class: ProofHelper
+
+Helper methods for creating and verifying proofs.
+
+## Constructors
+
+### Constructor
+
+> **new ProofHelper**(): `ProofHelper`
+
+#### Returns
+
+`ProofHelper`
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` `static` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## Methods
+
+### createSignerVerifier()
+
+> `static` **createSignerVerifier**(`proofType`): [`IProofSignerVerifier`](../interfaces/IProofSignerVerifier.md)
+
+Create a signer verifier.
+
+#### Parameters
+
+##### proofType
+
+[`ProofTypes`](../type-aliases/ProofTypes.md)
+
+The type of proof to create.
+
+#### Returns
+
+[`IProofSignerVerifier`](../interfaces/IProofSignerVerifier.md)
+
+The created signer verifier.
+
+#### Throws
+
+GeneralError if the proof type is not supported.
+
+***
+
+### createProof()
+
+> `static` **createProof**(`proofType`, `unsecuredDocument`, `unsignedProof`, `signKey`): `Promise`\<[`IProof`](../type-aliases/IProof.md)\>
+
+Create a proof for the given data.
+
+#### Parameters
+
+##### proofType
+
+[`ProofTypes`](../type-aliases/ProofTypes.md)
+
+The type of proof to create.
+
+##### unsecuredDocument
+
+`IJsonLdNodeObject`
+
+The data to create the proof for.
+
+##### unsignedProof
+
+[`IProof`](../type-aliases/IProof.md)
+
+The proof options.
+
+##### signKey
+
+`IJwk`
+
+The key to sign the proof with.
+
+#### Returns
+
+`Promise`\<[`IProof`](../type-aliases/IProof.md)\>
+
+The created proof.
+
+***
+
+### verifyProof()
+
+> `static` **verifyProof**(`securedDocument`, `signedProof`, `verifyKey`): `Promise`\<`boolean`\>
+
+Verify a proof for the given data.
+
+#### Parameters
+
+##### securedDocument
+
+`IJsonLdNodeObject`
+
+The credential to verify.
+
+##### signedProof
+
+[`IProof`](../type-aliases/IProof.md)
+
+The proof to verify.
+
+##### verifyKey
+
+`IJwk`
+
+The public key to verify the proof with.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+True if the credential was verified.
+
+***
+
+### createUnsignedProof()
+
+> `static` **createUnsignedProof**(`proofType`, `verificationMethodId`, `otherParams?`): [`IProof`](../type-aliases/IProof.md)
+
+Create an unsigned proof.
+
+#### Parameters
+
+##### proofType
+
+[`ProofTypes`](../type-aliases/ProofTypes.md)
+
+The type of proof to create.
+
+##### verificationMethodId
+
+`string`
+
+The verification method id.
+
+##### otherParams?
+
+`any`
+
+Other parameters for the proof.
+
+#### Returns
+
+[`IProof`](../type-aliases/IProof.md)
+
+The created proof.
+
+#### Throws
+
+GeneralError if the proof type is not supported.

package/docs/reference/index.md

@@ -1,24 +1,41 @@
 # @twin.org/standards-w3c-did
 
+## Classes
+
+- [DataIntegrityProofSignerVerifier](classes/DataIntegrityProofSignerVerifier.md)
+- [JsonWebSignature2020SignerVerifier](classes/JsonWebSignature2020SignerVerifier.md)
+- [MultikeyHelper](classes/MultikeyHelper.md)
+- [ProofHelper](classes/ProofHelper.md)
+
 ## Interfaces
 
+- [IDataIntegrityProof](interfaces/IDataIntegrityProof.md)
+- [IDidCredentialSchema](interfaces/IDidCredentialSchema.md)
 - [IDidCredentialStatus](interfaces/IDidCredentialStatus.md)
 - [IDidDocument](interfaces/IDidDocument.md)
 - [IDidDocumentVerificationMethod](interfaces/IDidDocumentVerificationMethod.md)
+- [IDidLabel](interfaces/IDidLabel.md)
 - [IDidPresentationVerification](interfaces/IDidPresentationVerification.md)
-- [IDidProof](interfaces/IDidProof.md)
 - [IDidService](interfaces/IDidService.md)
 - [IDidVerifiableCredential](interfaces/IDidVerifiableCredential.md)
 - [IDidVerifiablePresentation](interfaces/IDidVerifiablePresentation.md)
+- [IJsonWebSignature2020Proof](interfaces/IJsonWebSignature2020Proof.md)
+- [IMultikey](interfaces/IMultikey.md)
+- [IProofSignerVerifier](interfaces/IProofSignerVerifier.md)
 
 ## Type Aliases
 
+- [IProof](type-aliases/IProof.md)
 - [DidContexts](type-aliases/DidContexts.md)
+- [DidCryptoSuites](type-aliases/DidCryptoSuites.md)
 - [DidTypes](type-aliases/DidTypes.md)
 - [DidVerificationMethodType](type-aliases/DidVerificationMethodType.md)
+- [ProofTypes](type-aliases/ProofTypes.md)
 
 ## Variables
 
 - [DidContexts](variables/DidContexts.md)
+- [DidCryptoSuites](variables/DidCryptoSuites.md)
 - [DidTypes](variables/DidTypes.md)
 - [DidVerificationMethodType](variables/DidVerificationMethodType.md)
+- [ProofTypes](variables/ProofTypes.md)

package/docs/reference/interfaces/{IDidProof.md → IDataIntegrityProof.md}

@@ -1,23 +1,39 @@
-# Interface: IDidProof
+# Interface: IDataIntegrityProof
 
 Interface describing a did proof.
 https://www.w3.org/TR/vc-data-integrity/
 
 ## Properties
 
-### id?
+### @context?
 
-> `optional` **id**: `string`
+> `optional` **@context**: `"https://www.w3.org/ns/credentials/v2"` \| \[`"https://www.w3.org/ns/credentials/v2"`, `...IJsonLdContextDefinitionElement[]`\]
 
-The id of the proof.
+JSON-LD Context.
 
 ***
 
 ### type
 
-> **type**: `string`
+> **type**: `"DataIntegrityProof"`
+
+JSON-LD Type.
+
+***
+
+### cryptosuite
+
+> **cryptosuite**: `string`
 
-The type of the proof.
+An identifier for the cryptographic suite that can be used to verify the proof.
+
+***
+
+### id?
+
+> `optional` **id**: `string`
+
+The id of the proof.
 
 ***
 
@@ -25,7 +41,7 @@ The type of the proof.
 
 > **proofPurpose**: `string`
 
-The purpose of the proof.
+The reason the proof was created.
 
 ***
 

package/docs/reference/interfaces/IDidCredentialSchema.md

@@ -0,0 +1,19 @@
+# Interface: IDidCredentialSchema
+
+Interface describing a DID credential schema.
+
+## Properties
+
+### id
+
+> **id**: `string`
+
+The URI id.
+
+***
+
+### type
+
+> **type**: `string`
+
+The credential schema type.

package/docs/reference/interfaces/IDidCredentialStatus.md

@@ -4,7 +4,9 @@ Interface describing a DID credential status.
 
 ## Indexable
 
- \[`key`: `string`\]: `unknown`
+\[`key`: `string`\]: `unknown`
+
+Additional properties.
 
 ## Properties
 

package/docs/reference/interfaces/IDidDocument.md

@@ -5,6 +5,14 @@ Spec https://www.w3.org/TR/did-core/#did-document-properties.
 
 ## Properties
 
+### @context
+
+> **@context**: `"https://www.w3.org/ns/did/v1"` \| \[`"https://www.w3.org/ns/did/v1"`, `...IJsonLdContextDefinitionElement[]`\]
+
+The context for the document.
+
+***
+
 ### id
 
 > **id**: `string`

package/docs/reference/interfaces/IDidDocumentVerificationMethod.md

@@ -2,6 +2,14 @@
 
 Interface describing a DID document verification method.
 
+## Extends
+
+- `IJsonLdNodeObject`
+
+## Indexable
+
+\[`key`: `string`\]: `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `IJsonLdNodeObject` \| `IJsonLdGraphObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdListObject` \| `IJsonLdSetObject` \| `IJsonLdNodePrimitive`[] \| `IJsonLdLanguageMap` \| `IJsonLdIndexMap` \| `IJsonLdNodeObject`[] \| `IJsonLdIdMap` \| `IJsonLdTypeMap` \| `IJsonLdContextDefinition` \| `IJsonLdContextDefinitionElement`[] \| `string`[] \| `IJsonLdJsonObject` \| `IJsonLdJsonObject`[] \| \{[`key`: `string`]: `string`; \}
+
 ## Properties
 
 ### id
@@ -39,7 +47,7 @@ Spec https://datatracker.ietf.org/doc/html/draft-multiformats-multibase-03 .
 
 ### publicKeyJwk?
 
-> `optional` **publicKeyJwk**: `IJwk`
+> `optional` **publicKeyJwk**: `IJwk` & `IJsonLdNodeObject`
 
 The public key for the entry as a JWK.
 Spec https://datatracker.ietf.org/doc/html/rfc7517 .