@twin.org/standards-w3c-did 0.0.1-next.25 → 0.0.1-next.26

package/docs/reference/index.md

@@ -1,16 +1,26 @@
 # @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)
 - [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
 
@@ -18,6 +28,7 @@
 - [DidCryptoSuites](type-aliases/DidCryptoSuites.md)
 - [DidTypes](type-aliases/DidTypes.md)
 - [DidVerificationMethodType](type-aliases/DidVerificationMethodType.md)
+- [ProofTypes](type-aliases/ProofTypes.md)
 
 ## Variables
 
@@ -25,3 +36,4 @@
 - [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,21 +1,33 @@
-# Interface: IDidProof
+# Interface: IDataIntegrityProof
 
 Interface describing a did proof.
 https://www.w3.org/TR/vc-data-integrity/
 
+## Extends
+
+- `IJsonLdNodeObject`
+
+## Indexable
+
+\[`key`: `string`\]: `undefined` \| `null` \| `string` \| `number` \| `boolean` \| `string`[] \| `IJsonLdContextDefinition` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdIdMap` \| `IJsonLdNodeObject` \| `IJsonLdListObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdSetObject` \| `IJsonLdJsonObject` \| `IJsonLdIndexMap` \| `IJsonLdLanguageMap` \| `IJsonLdGraphObject` \| `IJsonLdNodeObject`[] \| `IJsonLdJsonObject`[] \| \{\} \| `IJsonLdTypeMap` \| `IJsonLdNodePrimitive`[]
+
 ## Properties
 
 ### @context?
 
-> `optional` **@context**: `"https://w3id.org/security/data-integrity/v2"` \| \[`"https://w3id.org/security/data-integrity/v2"`, `...IJsonLdContextDefinitionElement[]`\]
+> `optional` **@context**: `"https://www.w3.org/ns/credentials/v2"` \| \[`"https://www.w3.org/ns/credentials/v2"`, `...IJsonLdContextDefinitionElement[]`\]
 
 JSON-LD Context.
 
+#### Overrides
+
+`IJsonLdNodeObject.@context`
+
 ***
 
 ### type
 
-> **type**: `string`
+> **type**: `"DataIntegrityProof"`
 
 JSON-LD Type.
 
@@ -45,9 +57,9 @@ The reason the proof was created.
 
 ***
 
-### proofValue
+### proofValue?
 
-> **proofValue**: `string`
+> `optional` **proofValue**: `string`
 
 Contains the base-encoded binary data necessary to verify the
 digital proof using the verificationMethod specified.

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` \| `string`[] \| `IJsonLdContextDefinition` \| `IJsonLdContextDefinitionElement`[] \| `IJsonLdIdMap` \| `IJsonLdNodeObject` \| `IJsonLdListObject` \| `object` & `object` \| `object` & `object` \| `object` & `object` \| `IJsonLdSetObject` \| `IJsonLdJsonObject` \| `IJsonLdIndexMap` \| `IJsonLdLanguageMap` \| `IJsonLdGraphObject` \| `IJsonLdNodeObject`[] \| `IJsonLdJsonObject`[] \| \{\} \| `IJsonLdTypeMap` \| `IJsonLdNodePrimitive`[]
+
 ## 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 .

package/docs/reference/interfaces/IDidVerifiableCredential.md

@@ -7,7 +7,7 @@ https://www.w3.org/TR/vc-data-model-2.0
 
 ### @context
 
-> **@context**: `"https://www.w3.org/ns/credentials/v2"` \| \[`"https://www.w3.org/ns/credentials/v2"`, `...IJsonLdContextDefinitionElement[]`\]
+> **@context**: `"https://www.w3.org/2018/credentials/v1"` \| `"https://www.w3.org/ns/credentials/v2"` \| \[`"https://www.w3.org/ns/credentials/v2"`, `...IJsonLdContextDefinitionElement[]`\] \| \[`"https://www.w3.org/2018/credentials/v1"`, `...IJsonLdContextDefinitionElement[]`\]
 
 The context for the verifiable credential.
 
@@ -112,7 +112,7 @@ Evidence associated with the Credential.
 
 ### proof?
 
-> `optional` **proof**: [`IDidProof`](IDidProof.md) \| [`IDidProof`](IDidProof.md)[]
+> `optional` **proof**: [`IDataIntegrityProof`](IDataIntegrityProof.md) \| [`IJsonWebSignature2020Proof`](IJsonWebSignature2020Proof.md) \| ([`IDataIntegrityProof`](IDataIntegrityProof.md) \| [`IJsonWebSignature2020Proof`](IJsonWebSignature2020Proof.md))[]
 
 Proofs that the verifiable credential is valid.
 Optional if a different proof method is used, such as JWT.

package/docs/reference/interfaces/IDidVerifiablePresentation.md

@@ -46,7 +46,7 @@ The entity generating the presentation.
 
 ### proof?
 
-> `optional` **proof**: [`IDidProof`](IDidProof.md) \| [`IDidProof`](IDidProof.md)[]
+> `optional` **proof**: [`IDataIntegrityProof`](IDataIntegrityProof.md) \| [`IJsonWebSignature2020Proof`](IJsonWebSignature2020Proof.md) \| ([`IDataIntegrityProof`](IDataIntegrityProof.md) \| [`IJsonWebSignature2020Proof`](IJsonWebSignature2020Proof.md))[]
 
 Proofs that the verifiable presentation is valid.
 Optional if a different proof method is used, such as JWT.

package/docs/reference/interfaces/IJsonWebSignature2020Proof.md

@@ -0,0 +1,52 @@
+# Interface: IJsonWebSignature2020Proof
+
+Interface describing a did proof in JSON Web Signature 2020 Format.
+https://www.w3.org/TR/vc-jws-2020/
+
+## Properties
+
+### @context?
+
+> `optional` **@context**: `"https://w3id.org/security/suites/jws-2020/v1"` \| \[`"https://w3id.org/security/suites/jws-2020/v1"`, `...IJsonLdContextDefinitionElement[]`\]
+
+JSON-LD Context.
+
+***
+
+### type
+
+> **type**: `"JsonWebSignature2020"`
+
+JSON-LD Type.
+
+***
+
+### proofPurpose
+
+> **proofPurpose**: `string`
+
+The reason the proof was created.
+
+***
+
+### verificationMethod?
+
+> `optional` **verificationMethod**: `string`
+
+The verification method of the proof.
+
+***
+
+### created?
+
+> `optional` **created**: `string`
+
+The iso date of when the proof was created.
+
+***
+
+### jws?
+
+> `optional` **jws**: `string`
+
+The JSON Web Signature.

package/docs/reference/interfaces/IMultikey.md

@@ -0,0 +1,68 @@
+# Interface: IMultikey
+
+Interface describing a Multikey.
+https://www.w3.org/TR/cid-1.0/
+
+## Properties
+
+### @context?
+
+> `optional` **@context**: `"https://www.w3.org/ns/cid/v1"` \| `"https://w3id.org/security/multikey/v1"` \| \[`"https://www.w3.org/ns/cid/v1"`, `...IJsonLdContextDefinitionElement[]`\] \| \[`"https://w3id.org/security/multikey/v1"`, `...IJsonLdContextDefinitionElement[]`\]
+
+JSON-LD Context.
+
+***
+
+### id?
+
+> `optional` **id**: `string`
+
+The id of the entry.
+
+***
+
+### type
+
+> **type**: `"Multikey"`
+
+The type of the entry.
+
+***
+
+### controller?
+
+> `optional` **controller**: `string`
+
+The controller for the entry.
+
+***
+
+### publicKeyMultibase
+
+> **publicKeyMultibase**: `string`
+
+The public key for the entry.
+
+***
+
+### secretKeyMultibase?
+
+> `optional` **secretKeyMultibase**: `string`
+
+The secret key for the entry.
+
+***
+
+### expires?
+
+> `optional` **expires**: `string`
+
+The date the entry expires.
+
+***
+
+### revoked?
+
+> `optional` **revoked**: `string`
+
+The date the entry was revoked.

package/docs/reference/interfaces/IProofSignerVerifier.md

@@ -0,0 +1,99 @@
+# Interface: IProofSignerVerifier
+
+Interface describing a proof signer and verifier.
+
+## Methods
+
+### createProof()
+
+> **createProof**(`unsecuredDocument`, `unsignedProof`, `signKey`): `Promise`\<`IJsonLdNodeObject`\>
+
+Create a proof for the given data.
+
+#### Parameters
+
+##### unsecuredDocument
+
+`IJsonLdNodeObject`
+
+The data to create the proof for.
+
+##### unsignedProof
+
+`IJsonLdNodeObject`
+
+The proof options.
+
+##### signKey
+
+`IJwk`
+
+The key to sign the proof with.
+
+#### Returns
+
+`Promise`\<`IJsonLdNodeObject`\>
+
+The created proof.
+
+***
+
+### verifyProof()
+
+> **verifyProof**(`securedDocument`, `signedProof`, `verifyKey`): `Promise`\<`boolean`\>
+
+Verify a proof for the given data.
+
+#### Parameters
+
+##### securedDocument
+
+`IJsonLdNodeObject`
+
+The credential to verify.
+
+##### signedProof
+
+`IJsonLdNodeObject`
+
+The proof to verify.
+
+##### verifyKey
+
+`IJwk`
+
+The public key to verify the proof with.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+True if the credential was verified.
+
+***
+
+### 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
+
+`IJsonLdNodeObject`
+
+The unsigned proof.
+
+#### Returns
+
+`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
+
+The created hash.

package/docs/reference/type-aliases/ProofTypes.md

@@ -0,0 +1,5 @@
+# Type Alias: ProofTypes
+
+> **ProofTypes**: *typeof* [`ProofTypes`](../variables/ProofTypes.md)\[keyof *typeof* [`ProofTypes`](../variables/ProofTypes.md)\]
+
+The types for proofs.

package/docs/reference/variables/DidContexts.md

@@ -36,8 +36,20 @@ The context root for security ed25519 suites.
 
 The context root for security jws-2020 suites.
 
-### ContextVCDataIntegrity
+### ContextDataIntegrity
 
-> `readonly` **ContextVCDataIntegrity**: `"https://w3id.org/security/data-integrity/v2"` = `"https://w3id.org/security/data-integrity/v2"`
+> `readonly` **ContextDataIntegrity**: `"https://www.w3.org/ns/credentials/v2"` = `"https://www.w3.org/ns/credentials/v2"`
 
 The context root for VC Data Integrity.
+
+### ContextControllerIdentifiers
+
+> `readonly` **ContextControllerIdentifiers**: `"https://www.w3.org/ns/cid/v1"` = `"https://www.w3.org/ns/cid/v1"`
+
+The context root for VC Data Integrity.
+
+### ContextSecurityMultikey
+
+> `readonly` **ContextSecurityMultikey**: `"https://w3id.org/security/multikey/v1"` = `"https://w3id.org/security/multikey/v1"`
+
+The context root for security multikey suites.

package/docs/reference/variables/DidTypes.md

@@ -18,12 +18,6 @@ The type for Verifiable Credential.
 
 The type for Verifiable Presentation.
 
-### DataIntegrityProof
-
-> `readonly` **DataIntegrityProof**: `"DataIntegrityProof"` = `"DataIntegrityProof"`
-
-The type for Data Integrity Proof.
-
 ### Ed25519VerificationKey2020
 
 > `readonly` **Ed25519VerificationKey2020**: `"Ed25519VerificationKey2020"` = `"Ed25519VerificationKey2020"`
@@ -41,3 +35,9 @@ The type for JsonWebKey2020.
 > `readonly` **LinkedDomains**: `"LinkedDomains"` = `"LinkedDomains"`
 
 The type for LinkedDomains.
+
+### Multikey
+
+> `readonly` **Multikey**: `"Multikey"` = `"Multikey"`
+
+The type for Multikey.

package/docs/reference/variables/ProofTypes.md

@@ -0,0 +1,19 @@
+# Variable: ProofTypes
+
+> `const` **ProofTypes**: `object`
+
+The types for proofs.
+
+## Type declaration
+
+### DataIntegrityProof
+
+> `readonly` **DataIntegrityProof**: `"DataIntegrityProof"` = `"DataIntegrityProof"`
+
+The type for Data Integrity Proof.
+
+### JsonWebSignature2020
+
+> `readonly` **JsonWebSignature2020**: `"JsonWebSignature2020"` = `"JsonWebSignature2020"`
+
+The type for Json Web Signature 2020.

package/locales/en.json

@@ -1 +1,27 @@
-{}
+{
+	"error": {
+		"proofHelper": {
+			"unsupportedProofType": "Proof type \"{proofType}\" not supported.",
+			"proofMissing": "Proof is missing."
+		},
+		"jsonWebSignature2020SignerVerifier": {
+			"missingPrivateKey": "Private key is missing.",
+			"missingPublicKey": "Public key is missing.",
+			"missingProofValue": "Proof value is missing."
+		},
+		"dataIntegrityProofSignerVerifier": {
+			"cryptosuiteNotSupported": "Cryptosuite \"{cryptosuite}\" is not supported.",
+			"missingPrivateKey": "Private key is missing.",
+			"missingPublicKey": "Public key is missing.",
+			"missingProofValue": "Proof value is missing."
+		},
+		"multikeyHelper": {
+			"invalidPublicKeyMultibase": "Public key multibase \"{publicKeyMultibase}\" is invalid.",
+			"invalidSecretKeyMultibase": "Secret key multibase \"{secretKeyMultibase}\" is invalid.",
+			"unsupportedCrv": "Curve \"{crv}\" is not supported.",
+			"unsupportedKty": "Key type \"{kty}\" is not supported.",
+			"publicKeyMultibaseMissingHeader": "Public key multibase \"{publicKeyMultibase}\" is missing the multi codec header",
+			"secretKeyMultibaseMissingHeader": "Secret key multibase \"{secretKeyMultibase}\" is missing the multi codec header"
+		}
+	}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/standards-w3c-did",
-	"version": "0.0.1-next.25",
+	"version": "0.0.1-next.26",
 	"description": "Models which define the structure of W3C DID Standard",
 	"repository": {
 		"type": "git",
@@ -14,7 +14,10 @@
 		"node": ">=20.0.0"
 	},
 	"dependencies": {
+		"@twin.org/core": "next",
+		"@twin.org/crypto": "next",
 		"@twin.org/data-json-ld": "next",
+		"@twin.org/nameof": "next",
 		"@twin.org/web": "next"
 	},
 	"main": "./dist/cjs/index.cjs",