@twin.org/standards-w3c-did 0.0.1-next.4 → 0.0.1-next.40

package/docs/reference/interfaces/IDidLabel.md

@@ -0,0 +1,27 @@
+# Interface: IDidLabel
+
+Interface describing a DID Label.
+
+## Properties
+
+### @value
+
+> **@value**: `string`
+
+The value for the label.
+
+***
+
+### @language
+
+> **@language**: `string`
+
+The language for the label.
+
+***
+
+### @direction?
+
+> `optional` **@direction**: `string`
+
+The direction of the label.

package/docs/reference/interfaces/IDidVerifiableCredential.md

@@ -1,16 +1,13 @@
-# Interface: IDidVerifiableCredential\<T\>
+# Interface: IDidVerifiableCredential
 
 Interface describing a verifiable credential.
-
-## Type Parameters
-
-• **T** = `unknown`
+https://www.w3.org/TR/vc-data-model-2.0
 
 ## Properties
 
 ### @context
 
-> **@context**: `IJsonLdContextDefinitionRoot`
+> **@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.
 
@@ -26,15 +23,15 @@ The identifier for the verifiable credential.
 
 ### type
 
-> **type**: `string`[]
+> **type**: `string` \| `string`[]
 
 The types of the data stored in the verifiable credential.
 
 ***
 
-### credentialSubject
+### credentialSubject?
 
-> **credentialSubject**: `T` \| `T`[]
+> `optional` **credentialSubject**: `IJsonLdNodeObject` \| `IJsonLdNodeObject`[]
 
 The data for the verifiable credential.
 
@@ -42,16 +39,24 @@ The data for the verifiable credential.
 
 ### credentialStatus?
 
-> `optional` **credentialStatus**: [`IDidCredentialStatus`](IDidCredentialStatus.md)
+> `optional` **credentialStatus**: [`IDidCredentialStatus`](IDidCredentialStatus.md) \| [`IDidCredentialStatus`](IDidCredentialStatus.md)[]
 
 Used to discover information about the current status of the
 verifiable credential, such as whether it is suspended or revoked.
 
 ***
 
+### credentialSchema?
+
+> `optional` **credentialSchema**: [`IDidCredentialSchema`](IDidCredentialSchema.md) \| [`IDidCredentialSchema`](IDidCredentialSchema.md)[]
+
+Annotate type definitions or lock them to specific versions of the vocabulary.
+
+***
+
 ### issuer?
 
-> `optional` **issuer**: `string`
+> `optional` **issuer**: `string` \| \{ `id`: `string`; `name`: `string` \| [`IDidLabel`](IDidLabel.md)[]; `description`: `string` \| [`IDidLabel`](IDidLabel.md)[]; \}
 
 The issuing identity.
 
@@ -65,9 +70,49 @@ The date the verifiable credential was issued.
 
 ***
 
+### name?
+
+> `optional` **name**: `string` \| [`IDidLabel`](IDidLabel.md)[]
+
+The name of the credential.
+
+***
+
+### description?
+
+> `optional` **description**: `string` \| [`IDidLabel`](IDidLabel.md)[]
+
+The description of the credential.
+
+***
+
+### validFrom?
+
+> `optional` **validFrom**: `string`
+
+The date the verifiable credential is valid from.
+
+***
+
+### validUntil?
+
+> `optional` **validUntil**: `string`
+
+The date the verifiable credential is valid until.
+
+***
+
+### evidence?
+
+> `optional` **evidence**: `IJsonLdNodeObject` \| `IJsonLdNodeObject`[]
+
+Evidence associated with the Credential.
+
+***
+
 ### proof?
 
-> `optional` **proof**: [`IDidProof`](IDidProof.md) \| [`IDidProof`](IDidProof.md)[]
+> `optional` **proof**: [`IProof`](../type-aliases/IProof.md) \| [`IProof`](../type-aliases/IProof.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

@@ -6,9 +6,9 @@ Interface describing a verifiable presentation.
 
 ### @context
 
-> **@context**: `IJsonLdContextDefinitionRoot`
+> **@context**: `"https://www.w3.org/ns/credentials/v2"` \| \[`"https://www.w3.org/ns/credentials/v2"`, `...IJsonLdContextDefinitionElement[]`\]
 
-The context for the verifiable credential.
+The context for the verifiable presentation.
 
 ***
 
@@ -22,15 +22,15 @@ Provide a unique identifier for the presentation.
 
 ### type
 
-> **type**: `string`[]
+> **type**: `string` \| `string`[]
 
 The types of the data stored in the verifiable credential.
 
 ***
 
-### verifiableCredential
+### verifiableCredential?
 
-> **verifiableCredential**: `string`[]
+> `optional` **verifiableCredential**: (`string` \| [`IDidVerifiableCredential`](IDidVerifiableCredential.md))[]
 
 The data for the verifiable credentials.
 
@@ -46,7 +46,7 @@ The entity generating the presentation.
 
 ### proof?
 
-> `optional` **proof**: [`IDidProof`](IDidProof.md) \| [`IDidProof`](IDidProof.md)[]
+> `optional` **proof**: [`IProof`](../type-aliases/IProof.md) \| [`IProof`](../type-aliases/IProof.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`\<[`IProof`](../type-aliases/IProof.md)\>
+
+Create a proof for the given data.
+
+#### Parameters
+
+##### 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()
+
+> **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.
+
+***
+
+### 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
+
+[`IProof`](../type-aliases/IProof.md)
+
+The unsigned proof.
+
+#### Returns
+
+`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
+
+The created hash.

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

@@ -0,0 +1,5 @@
+# Type Alias: DidContexts
+
+> **DidContexts** = *typeof* [`DidContexts`](../variables/DidContexts.md)\[keyof *typeof* [`DidContexts`](../variables/DidContexts.md)\]
+
+The contexts for DIDs.

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

@@ -0,0 +1,5 @@
+# Type Alias: DidCryptoSuites
+
+> **DidCryptoSuites** = *typeof* [`DidCryptoSuites`](../variables/DidCryptoSuites.md)\[keyof *typeof* [`DidCryptoSuites`](../variables/DidCryptoSuites.md)\]
+
+The types for DID Proof crypto suites.

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

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

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

@@ -1,5 +1,5 @@
 # Type Alias: DidVerificationMethodType
 
-> **DidVerificationMethodType**: *typeof* [`DidVerificationMethodType`](../variables/DidVerificationMethodType.md)\[keyof *typeof* [`DidVerificationMethodType`](../variables/DidVerificationMethodType.md)\]
+> **DidVerificationMethodType** = *typeof* [`DidVerificationMethodType`](../variables/DidVerificationMethodType.md)\[keyof *typeof* [`DidVerificationMethodType`](../variables/DidVerificationMethodType.md)\]
 
 The types of verification method.

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

@@ -0,0 +1,5 @@
+# Type Alias: IProof
+
+> **IProof** = [`IDataIntegrityProof`](../interfaces/IDataIntegrityProof.md) \| [`IJsonWebSignature2020Proof`](../interfaces/IJsonWebSignature2020Proof.md)
+
+Interface describing a proof.

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

@@ -0,0 +1,55 @@
+# Variable: DidContexts
+
+> `const` **DidContexts**: `object`
+
+The contexts for DIDs.
+
+## Type declaration
+
+### Context
+
+> `readonly` **Context**: `"https://www.w3.org/ns/did/v1"` = `"https://www.w3.org/ns/did/v1"`
+
+The context root for DID.
+
+### ContextVCv1
+
+> `readonly` **ContextVCv1**: `"https://www.w3.org/2018/credentials/v1"` = `"https://www.w3.org/2018/credentials/v1"`
+
+The context root for DID VC v1.
+
+### ContextVCv2
+
+> `readonly` **ContextVCv2**: `"https://www.w3.org/ns/credentials/v2"` = `"https://www.w3.org/ns/credentials/v2"`
+
+The context root for DID VC v2.
+
+### ContextSecurityEd25519
+
+> `readonly` **ContextSecurityEd25519**: `"https://w3id.org/security/suites/ed25519-2020/v1"` = `"https://w3id.org/security/suites/ed25519-2020/v1"`
+
+The context root for security ed25519 suites.
+
+### ContextSecurityJws2020
+
+> `readonly` **ContextSecurityJws2020**: `"https://w3id.org/security/suites/jws-2020/v1"` = `"https://w3id.org/security/suites/jws-2020/v1"`
+
+The context root for security jws-2020 suites.
+
+### ContextDataIntegrity
+
+> `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/DidCryptoSuites.md

@@ -0,0 +1,21 @@
+# Variable: DidCryptoSuites
+
+> `const` **DidCryptoSuites**: `object`
+
+The types for DID Proof crypto suites.
+
+## Type declaration
+
+### EdDSAJcs2022
+
+> `readonly` **EdDSAJcs2022**: `"eddsa-jcs-2022"` = `"eddsa-jcs-2022"`
+
+The type for EdDSA crypto suite for JSON Canonicalization Scheme [RFC8785].
+https://www.w3.org/TR/vc-di-eddsa/#eddsa-jcs-2022
+
+### EdDSARdfc2022
+
+> `readonly` **EdDSARdfc2022**: `"eddsa-rdfc-2022"` = `"eddsa-rdfc-2022"`
+
+The type for EdDSA crypto suite for RDF Dataset Canonicalization.
+https://www.w3.org/TR/vc-di-eddsa/#eddsa-rdfc-2022

package/docs/reference/variables/DidTypes.md

@@ -0,0 +1,43 @@
+# Variable: DidTypes
+
+> `const` **DidTypes**: `object`
+
+The types for DIDs.
+
+## Type declaration
+
+### VerifiableCredential
+
+> `readonly` **VerifiableCredential**: `"VerifiableCredential"` = `"VerifiableCredential"`
+
+The type for Verifiable Credential.
+
+### VerifiablePresentation
+
+> `readonly` **VerifiablePresentation**: `"VerifiablePresentation"` = `"VerifiablePresentation"`
+
+The type for Verifiable Presentation.
+
+### Ed25519VerificationKey2020
+
+> `readonly` **Ed25519VerificationKey2020**: `"Ed25519VerificationKey2020"` = `"Ed25519VerificationKey2020"`
+
+The type for Ed25519VerificationKey2020.
+
+### JsonWebKey2020
+
+> `readonly` **JsonWebKey2020**: `"JsonWebKey2020"` = `"JsonWebKey2020"`
+
+The type for JsonWebKey2020.
+
+### LinkedDomains
+
+> `readonly` **LinkedDomains**: `"LinkedDomains"` = `"LinkedDomains"`
+
+The type for LinkedDomains.
+
+### Multikey
+
+> `readonly` **Multikey**: `"Multikey"` = `"Multikey"`
+
+The type for Multikey.

package/docs/reference/variables/DidVerificationMethodType.md

@@ -6,4 +6,4 @@ The types of verification method.
 
 ## Index Signature
 
- \[`id`: `string`\]: keyof `Pick`\<[`IDidDocument`](../interfaces/IDidDocument.md), `"verificationMethod"` \| `"authentication"` \| `"assertionMethod"` \| `"keyAgreement"` \| `"capabilityInvocation"` \| `"capabilityDelegation"`\>
+\[`id`: `string`\]: `"verificationMethod"` \| `"authentication"` \| `"assertionMethod"` \| `"keyAgreement"` \| `"capabilityInvocation"` \| `"capabilityDelegation"`

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.4",
+	"version": "0.0.1-next.40",
 	"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",
@@ -22,11 +25,11 @@
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
+			"types": "./dist/types/index.d.ts",
 			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs",
-			"types": "./dist/types/index.d.ts"
+			"import": "./dist/esm/index.mjs"
 		},
-		"./locales": "./locales"
+		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
 		"dist/cjs",