@twin.org/standards-w3c-did 0.0.1-next.28 → 0.0.1-next.29

package/dist/cjs/index.cjs

@@ -188,14 +188,12 @@ class DataIntegrityProofSignerVerifier {
     async verifyProof(securedDocument, signedProof, verifyKey) {
         core.Guards.object(this.CLASS_NAME, "securedDocument", securedDocument);
         core.Guards.object(this.CLASS_NAME, "signedProof", signedProof);
+        core.Guards.stringValue(this.CLASS_NAME, "signedProof.proofValue", signedProof.proofValue);
         core.Guards.object(this.CLASS_NAME, "verifyKey", verifyKey);
         const rawKeys = await web.Jwk.toRaw(verifyKey);
         if (!core.Is.uint8Array(rawKeys.publicKey)) {
             throw new core.GeneralError(this.CLASS_NAME, "missingPublicKey");
         }
-        if (!core.Is.stringValue(signedProof.proofValue) || !signedProof.proofValue.startsWith("z")) {
-            throw new core.GeneralError(this.CLASS_NAME, "missingProofValue");
-        }
         const combinedHash = await this.createHash(securedDocument, signedProof);
         return crypto.Ed25519.verify(rawKeys.publicKey, combinedHash, core.Converter.base58ToBytes(signedProof.proofValue.slice(1)));
     }

package/dist/esm/index.mjs

@@ -186,14 +186,12 @@ class DataIntegrityProofSignerVerifier {
     async verifyProof(securedDocument, signedProof, verifyKey) {
         Guards.object(this.CLASS_NAME, "securedDocument", securedDocument);
         Guards.object(this.CLASS_NAME, "signedProof", signedProof);
+        Guards.stringValue(this.CLASS_NAME, "signedProof.proofValue", signedProof.proofValue);
         Guards.object(this.CLASS_NAME, "verifyKey", verifyKey);
         const rawKeys = await Jwk.toRaw(verifyKey);
         if (!Is.uint8Array(rawKeys.publicKey)) {
             throw new GeneralError(this.CLASS_NAME, "missingPublicKey");
         }
-        if (!Is.stringValue(signedProof.proofValue) || !signedProof.proofValue.startsWith("z")) {
-            throw new GeneralError(this.CLASS_NAME, "missingProofValue");
-        }
         const combinedHash = await this.createHash(securedDocument, signedProof);
         return Ed25519.verify(rawKeys.publicKey, combinedHash, Converter.base58ToBytes(signedProof.proofValue.slice(1)));
     }

package/dist/types/index.d.ts

@@ -14,6 +14,7 @@ export * from "./models/IDidVerifiableCredential";
 export * from "./models/IDidVerifiablePresentation";
 export * from "./models/IJsonWebSignature2020Proof";
 export * from "./models/IMultikey";
+export * from "./models/IProof";
 export * from "./models/IProofSignerVerifier";
 export * from "./models/proofTypes";
 export * from "./signerVerifiers/dataIntegrityProofSignerVerifier";

package/dist/types/models/IDataIntegrityProof.d.ts

@@ -1,4 +1,4 @@
-import type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
 import type { DidContexts } from "./didContexts";
 import type { DidCryptoSuites } from "./didCryptoSuites";
 import type { ProofTypes } from "./proofTypes";
@@ -6,7 +6,7 @@ import type { ProofTypes } from "./proofTypes";
  * Interface describing a did proof.
  * https://www.w3.org/TR/vc-data-integrity/
  */
-export interface IDataIntegrityProof extends IJsonLdNodeObject {
+export interface IDataIntegrityProof {
     /**
      * JSON-LD Context.
      */

package/dist/types/models/IDidVerifiableCredential.d.ts

@@ -1,10 +1,9 @@
 import type { IJsonLdContextDefinitionElement, IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import type { DidContexts } from "./didContexts";
-import type { IDataIntegrityProof } from "./IDataIntegrityProof";
 import type { IDidCredentialSchema } from "./IDidCredentialSchema";
 import type { IDidCredentialStatus } from "./IDidCredentialStatus";
 import type { IDidLabel } from "./IDidLabel";
-import type { IJsonWebSignature2020Proof } from "./IJsonWebSignature2020Proof";
+import type { IProof } from "./IProof";
 /**
  * Interface describing a verifiable credential.
  * https://www.w3.org/TR/vc-data-model-2.0
@@ -71,5 +70,5 @@ export interface IDidVerifiableCredential {
      * Proofs that the verifiable credential is valid.
      * Optional if a different proof method is used, such as JWT.
      */
-    proof?: IDataIntegrityProof | IJsonWebSignature2020Proof | (IDataIntegrityProof | IJsonWebSignature2020Proof)[];
+    proof?: IProof | IProof[];
 }

package/dist/types/models/IDidVerifiablePresentation.d.ts

@@ -1,8 +1,7 @@
 import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
 import type { DidContexts } from "./didContexts";
-import type { IDataIntegrityProof } from "./IDataIntegrityProof";
 import type { IDidVerifiableCredential } from "./IDidVerifiableCredential";
-import type { IJsonWebSignature2020Proof } from "./IJsonWebSignature2020Proof";
+import type { IProof } from "./IProof";
 /**
  * Interface describing a verifiable presentation.
  */
@@ -31,5 +30,5 @@ export interface IDidVerifiablePresentation {
      * Proofs that the verifiable presentation is valid.
      * Optional if a different proof method is used, such as JWT.
      */
-    proof?: IDataIntegrityProof | IJsonWebSignature2020Proof | (IDataIntegrityProof | IJsonWebSignature2020Proof)[];
+    proof?: IProof | IProof[];
 }

package/dist/types/models/IProof.d.ts

@@ -0,0 +1,6 @@
+import type { IDataIntegrityProof } from "./IDataIntegrityProof";
+import type { IJsonWebSignature2020Proof } from "./IJsonWebSignature2020Proof";
+/**
+ * Interface describing a proof.
+ */
+export type IProof = IDataIntegrityProof | IJsonWebSignature2020Proof;

package/dist/types/models/IProofSignerVerifier.d.ts

@@ -1,5 +1,6 @@
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import type { IJwk } from "@twin.org/web";
+import type { IProof } from "./IProof";
 /**
  * Interface describing a proof signer and verifier.
  */
@@ -11,7 +12,7 @@ export interface IProofSignerVerifier {
      * @param signKey The key to sign the proof with.
      * @returns The created proof.
      */
-    createProof(unsecuredDocument: IJsonLdNodeObject, unsignedProof: IJsonLdNodeObject, signKey: IJwk): Promise<IJsonLdNodeObject>;
+    createProof(unsecuredDocument: IJsonLdNodeObject, unsignedProof: IProof, signKey: IJwk): Promise<IProof>;
     /**
      * Verify a proof for the given data.
      * @param securedDocument The credential to verify.
@@ -19,12 +20,12 @@ export interface IProofSignerVerifier {
      * @param verifyKey The public key to verify the proof with.
      * @returns True if the credential was verified.
      */
-    verifyProof(securedDocument: IJsonLdNodeObject, signedProof: IJsonLdNodeObject, verifyKey: IJwk): Promise<boolean>;
+    verifyProof(securedDocument: IJsonLdNodeObject, signedProof: IProof, verifyKey: IJwk): Promise<boolean>;
     /**
      * Create a hash for the given data.
      * @param unsecuredDocument The data to create the proof for.
      * @param unsignedProof The unsigned proof.
      * @returns The created hash.
      */
-    createHash(unsecuredDocument: IJsonLdNodeObject, unsignedProof: IJsonLdNodeObject): Promise<Uint8Array>;
+    createHash(unsecuredDocument: IJsonLdNodeObject, unsignedProof: IProof): Promise<Uint8Array>;
 }

package/dist/types/signerVerifiers/dataIntegrityProofSignerVerifier.d.ts

@@ -1,5 +1,7 @@
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import { type IJwk } from "@twin.org/web";
+import type { IDataIntegrityProof } from "../models/IDataIntegrityProof";
+import type { IProof } from "../models/IProof";
 import type { IProofSignerVerifier } from "../models/IProofSignerVerifier";
 /**
  * Helper methods for creating and verifying proofs.
@@ -17,7 +19,7 @@ export declare class DataIntegrityProofSignerVerifier implements IProofSignerVer
      * @param signKey The key to sign the proof with.
      * @returns The created proof.
      */
-    createProof(unsecuredDocument: IJsonLdNodeObject, unsignedProof: IJsonLdNodeObject, signKey: IJwk): Promise<IJsonLdNodeObject>;
+    createProof(unsecuredDocument: IJsonLdNodeObject, unsignedProof: IDataIntegrityProof, signKey: IJwk): Promise<IProof>;
     /**
      * Verify a proof for the given data in format.
      * @param securedDocument The credential to verify.
@@ -25,12 +27,12 @@ export declare class DataIntegrityProofSignerVerifier implements IProofSignerVer
      * @param verifyKey The public key to verify the proof with.
      * @returns True if the credential was verified.
      */
-    verifyProof(securedDocument: IJsonLdNodeObject, signedProof: IJsonLdNodeObject, verifyKey: IJwk): Promise<boolean>;
+    verifyProof(securedDocument: IJsonLdNodeObject, signedProof: IDataIntegrityProof, verifyKey: IJwk): Promise<boolean>;
     /**
      * Create a hash for the given data.
      * @param unsecuredDocument The data to create the proof for.
      * @param unsignedProof The unsigned proof.
      * @returns The created hash.
      */
-    createHash(unsecuredDocument: IJsonLdNodeObject, unsignedProof: IJsonLdNodeObject): Promise<Uint8Array>;
+    createHash(unsecuredDocument: IJsonLdNodeObject, unsignedProof: IDataIntegrityProof): Promise<Uint8Array>;
 }

package/dist/types/signerVerifiers/jsonWebSignature2020SignerVerifier.d.ts

@@ -1,5 +1,6 @@
 import { type IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import { type IJwk } from "@twin.org/web";
+import type { IJsonWebSignature2020Proof } from "../models/IJsonWebSignature2020Proof";
 import type { IProofSignerVerifier } from "../models/IProofSignerVerifier";
 /**
  * Helper methods for creating and verifying proofs.
@@ -16,7 +17,7 @@ export declare class JsonWebSignature2020SignerVerifier implements IProofSignerV
      * @param signKey The key to sign the proof with.
      * @returns The created proof.
      */
-    createProof(unsecuredDocument: IJsonLdNodeObject, unsignedProof: IJsonLdNodeObject, signKey: IJwk): Promise<IJsonLdNodeObject>;
+    createProof(unsecuredDocument: IJsonLdNodeObject, unsignedProof: IJsonWebSignature2020Proof, signKey: IJwk): Promise<IJsonWebSignature2020Proof>;
     /**
      * Verify a proof for the given data in format.
      * @param securedDocument The credential to verify.
@@ -24,12 +25,12 @@ export declare class JsonWebSignature2020SignerVerifier implements IProofSignerV
      * @param verifyKey The public key to verify the proof with.
      * @returns True if the credential was verified.
      */
-    verifyProof(securedDocument: IJsonLdNodeObject, signedProof: IJsonLdNodeObject, verifyKey: IJwk): Promise<boolean>;
+    verifyProof(securedDocument: IJsonLdNodeObject, signedProof: IJsonWebSignature2020Proof, verifyKey: IJwk): Promise<boolean>;
     /**
      * Create a hash for the given data.
      * @param unsecuredDocument The data to create the proof for.
      * @param unsignedProof The unsigned proof.
      * @returns The created hash.
      */
-    createHash(unsecuredDocument: IJsonLdNodeObject, unsignedProof: IJsonLdNodeObject): Promise<Uint8Array>;
+    createHash(unsecuredDocument: IJsonLdNodeObject, unsignedProof: IJsonWebSignature2020Proof): Promise<Uint8Array>;
 }

package/dist/types/utils/proofHelper.d.ts

@@ -1,5 +1,6 @@
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import type { IJwk } from "@twin.org/web";
+import type { IProof } from "../models/IProof";
 import type { IProofSignerVerifier } from "../models/IProofSignerVerifier";
 import { ProofTypes } from "../models/proofTypes";
 /**
@@ -25,7 +26,7 @@ export declare class ProofHelper {
      * @param signKey The key to sign the proof with.
      * @returns The created proof.
      */
-    static createProof(proofType: ProofTypes, unsecuredDocument: IJsonLdNodeObject, unsignedProof: IJsonLdNodeObject, signKey: IJwk): Promise<IJsonLdNodeObject>;
+    static createProof(proofType: ProofTypes, unsecuredDocument: IJsonLdNodeObject, unsignedProof: IProof, signKey: IJwk): Promise<IProof>;
     /**
      * Verify a proof for the given data.
      * @param securedDocument The credential to verify.
@@ -33,5 +34,5 @@ export declare class ProofHelper {
      * @param verifyKey The public key to verify the proof with.
      * @returns True if the credential was verified.
      */
-    static verifyProof(securedDocument: IJsonLdNodeObject, signedProof: IJsonLdNodeObject, verifyKey: IJwk): Promise<boolean>;
+    static verifyProof(securedDocument: IJsonLdNodeObject, signedProof: IProof, verifyKey: IJwk): Promise<boolean>;
 }

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/standards-w3c-did - Changelog
 
-## v0.0.1-next.28
+## v0.0.1-next.29
 
 - Initial Release

package/docs/reference/classes/DataIntegrityProofSignerVerifier.md

@@ -29,7 +29,7 @@ Runtime name for the class.
 
 ### createProof()
 
-> **createProof**(`unsecuredDocument`, `unsignedProof`, `signKey`): `Promise`\<`IJsonLdNodeObject`\>
+> **createProof**(`unsecuredDocument`, `unsignedProof`, `signKey`): `Promise`\<[`IProof`](../type-aliases/IProof.md)\>
 
 Create a proof for the given data.
 
@@ -43,7 +43,7 @@ The data to create the proof for.
 
 ##### unsignedProof
 
-`IJsonLdNodeObject`
+[`IDataIntegrityProof`](../interfaces/IDataIntegrityProof.md)
 
 The proof options.
 
@@ -55,7 +55,7 @@ The key to sign the proof with.
 
 #### Returns
 
-`Promise`\<`IJsonLdNodeObject`\>
+`Promise`\<[`IProof`](../type-aliases/IProof.md)\>
 
 The created proof.
 
@@ -81,7 +81,7 @@ The credential to verify.
 
 ##### signedProof
 
-`IJsonLdNodeObject`
+[`IDataIntegrityProof`](../interfaces/IDataIntegrityProof.md)
 
 The proof to verify.
 
@@ -119,7 +119,7 @@ The data to create the proof for.
 
 ##### unsignedProof
 
-`IJsonLdNodeObject`
+[`IDataIntegrityProof`](../interfaces/IDataIntegrityProof.md)
 
 The unsigned proof.
 

package/docs/reference/classes/JsonWebSignature2020SignerVerifier.md

@@ -28,7 +28,7 @@ Runtime name for the class.
 
 ### createProof()
 
-> **createProof**(`unsecuredDocument`, `unsignedProof`, `signKey`): `Promise`\<`IJsonLdNodeObject`\>
+> **createProof**(`unsecuredDocument`, `unsignedProof`, `signKey`): `Promise`\<[`IJsonWebSignature2020Proof`](../interfaces/IJsonWebSignature2020Proof.md)\>
 
 Create a proof for the given data.
 
@@ -42,7 +42,7 @@ The data to create the proof for.
 
 ##### unsignedProof
 
-`IJsonLdNodeObject`
+[`IJsonWebSignature2020Proof`](../interfaces/IJsonWebSignature2020Proof.md)
 
 The proof options.
 
@@ -54,7 +54,7 @@ The key to sign the proof with.
 
 #### Returns
 
-`Promise`\<`IJsonLdNodeObject`\>
+`Promise`\<[`IJsonWebSignature2020Proof`](../interfaces/IJsonWebSignature2020Proof.md)\>
 
 The created proof.
 
@@ -80,7 +80,7 @@ The credential to verify.
 
 ##### signedProof
 
-`IJsonLdNodeObject`
+[`IJsonWebSignature2020Proof`](../interfaces/IJsonWebSignature2020Proof.md)
 
 The proof to verify.
 
@@ -118,7 +118,7 @@ The data to create the proof for.
 
 ##### unsignedProof
 
-`IJsonLdNodeObject`
+[`IJsonWebSignature2020Proof`](../interfaces/IJsonWebSignature2020Proof.md)
 
 The unsigned proof.
 

package/docs/reference/classes/ProofHelper.md

@@ -50,7 +50,7 @@ GeneralError if the proof type is not supported.
 
 ### createProof()
 
-> `static` **createProof**(`proofType`, `unsecuredDocument`, `unsignedProof`, `signKey`): `Promise`\<`IJsonLdNodeObject`\>
+> `static` **createProof**(`proofType`, `unsecuredDocument`, `unsignedProof`, `signKey`): `Promise`\<[`IProof`](../type-aliases/IProof.md)\>
 
 Create a proof for the given data.
 
@@ -70,7 +70,7 @@ The data to create the proof for.
 
 ##### unsignedProof
 
-`IJsonLdNodeObject`
+[`IProof`](../type-aliases/IProof.md)
 
 The proof options.
 
@@ -82,7 +82,7 @@ The key to sign the proof with.
 
 #### Returns
 
-`Promise`\<`IJsonLdNodeObject`\>
+`Promise`\<[`IProof`](../type-aliases/IProof.md)\>
 
 The created proof.
 
@@ -104,7 +104,7 @@ The credential to verify.
 
 ##### signedProof
 
-`IJsonLdNodeObject`
+[`IProof`](../type-aliases/IProof.md)
 
 The proof to verify.
 

package/docs/reference/index.md

@@ -25,6 +25,7 @@
 
 ## Type Aliases
 
+- [IProof](type-aliases/IProof.md)
 - [DidContexts](type-aliases/DidContexts.md)
 - [DidCryptoSuites](type-aliases/DidCryptoSuites.md)
 - [DidTypes](type-aliases/DidTypes.md)

package/docs/reference/interfaces/IDataIntegrityProof.md

@@ -3,14 +3,6 @@
 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?
@@ -19,10 +11,6 @@ https://www.w3.org/TR/vc-data-integrity/
 
 JSON-LD Context.
 
-#### Overrides
-
-`IJsonLdNodeObject.@context`
-
 ***
 
 ### type

package/docs/reference/interfaces/IDidVerifiableCredential.md

@@ -112,7 +112,7 @@ Evidence associated with the Credential.
 
 ### proof?
 
-> `optional` **proof**: [`IDataIntegrityProof`](IDataIntegrityProof.md) \| [`IJsonWebSignature2020Proof`](IJsonWebSignature2020Proof.md) \| ([`IDataIntegrityProof`](IDataIntegrityProof.md) \| [`IJsonWebSignature2020Proof`](IJsonWebSignature2020Proof.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

@@ -46,7 +46,7 @@ The entity generating the presentation.
 
 ### proof?
 
-> `optional` **proof**: [`IDataIntegrityProof`](IDataIntegrityProof.md) \| [`IJsonWebSignature2020Proof`](IJsonWebSignature2020Proof.md) \| ([`IDataIntegrityProof`](IDataIntegrityProof.md) \| [`IJsonWebSignature2020Proof`](IJsonWebSignature2020Proof.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/IProofSignerVerifier.md

@@ -6,7 +6,7 @@ Interface describing a proof signer and verifier.
 
 ### createProof()
 
-> **createProof**(`unsecuredDocument`, `unsignedProof`, `signKey`): `Promise`\<`IJsonLdNodeObject`\>
+> **createProof**(`unsecuredDocument`, `unsignedProof`, `signKey`): `Promise`\<[`IProof`](../type-aliases/IProof.md)\>
 
 Create a proof for the given data.
 
@@ -20,7 +20,7 @@ The data to create the proof for.
 
 ##### unsignedProof
 
-`IJsonLdNodeObject`
+[`IProof`](../type-aliases/IProof.md)
 
 The proof options.
 
@@ -32,7 +32,7 @@ The key to sign the proof with.
 
 #### Returns
 
-`Promise`\<`IJsonLdNodeObject`\>
+`Promise`\<[`IProof`](../type-aliases/IProof.md)\>
 
 The created proof.
 
@@ -54,7 +54,7 @@ The credential to verify.
 
 ##### signedProof
 
-`IJsonLdNodeObject`
+[`IProof`](../type-aliases/IProof.md)
 
 The proof to verify.
 
@@ -88,7 +88,7 @@ The data to create the proof for.
 
 ##### unsignedProof
 
-`IJsonLdNodeObject`
+[`IProof`](../type-aliases/IProof.md)
 
 The unsigned proof.
 

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/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/standards-w3c-did",
-	"version": "0.0.1-next.28",
+	"version": "0.0.1-next.29",
 	"description": "Models which define the structure of W3C DID Standard",
 	"repository": {
 		"type": "git",