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

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

@@ -0,0 +1,17 @@
+/**
+ * The types for proofs.
+ */
+export declare const ProofTypes: {
+    /**
+     * The type for Data Integrity Proof.
+     */
+    readonly DataIntegrityProof: "DataIntegrityProof";
+    /**
+     * The type for Json Web Signature 2020.
+     */
+    readonly JsonWebSignature2020: "JsonWebSignature2020";
+};
+/**
+ * The types for proofs.
+ */
+export type ProofTypes = (typeof ProofTypes)[keyof typeof ProofTypes];

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

@@ -0,0 +1,36 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import { type IJwk } from "@twin.org/web";
+import type { IProofSignerVerifier } from "../models/IProofSignerVerifier";
+/**
+ * Helper methods for creating and verifying proofs.
+ * https://www.w3.org/TR/vc-di-eddsa/#eddsa-jcs-2022
+ */
+export declare class DataIntegrityProofSignerVerifier implements IProofSignerVerifier {
+    /**
+     * Runtime name for the class.
+     */
+    readonly CLASS_NAME: string;
+    /**
+     * Create a proof for the given data.
+     * @param unsecuredDocument The data to create the proof for.
+     * @param unsignedProof The proof options.
+     * @param signKey The key to sign the proof with.
+     * @returns The created proof.
+     */
+    createProof(unsecuredDocument: IJsonLdNodeObject, unsignedProof: IJsonLdNodeObject, signKey: IJwk): Promise<IJsonLdNodeObject>;
+    /**
+     * Verify a proof for the given data in format.
+     * @param securedDocument The credential to verify.
+     * @param signedProof The proof to verify.
+     * @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>;
+    /**
+     * 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>;
+}

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

@@ -0,0 +1,35 @@
+import { type IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import { type IJwk } from "@twin.org/web";
+import type { IProofSignerVerifier } from "../models/IProofSignerVerifier";
+/**
+ * Helper methods for creating and verifying proofs.
+ */
+export declare class JsonWebSignature2020SignerVerifier implements IProofSignerVerifier {
+    /**
+     * Runtime name for the class.
+     */
+    readonly CLASS_NAME: string;
+    /**
+     * Create a proof for the given data.
+     * @param unsecuredDocument The data to create the proof for.
+     * @param unsignedProof The proof options.
+     * @param signKey The key to sign the proof with.
+     * @returns The created proof.
+     */
+    createProof(unsecuredDocument: IJsonLdNodeObject, unsignedProof: IJsonLdNodeObject, signKey: IJwk): Promise<IJsonLdNodeObject>;
+    /**
+     * Verify a proof for the given data in format.
+     * @param securedDocument The credential to verify.
+     * @param signedProof The proof to verify.
+     * @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>;
+    /**
+     * 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>;
+}

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

@@ -0,0 +1,37 @@
+import type { IJwk } from "@twin.org/web";
+import type { IMultikey } from "../models/IMultikey";
+/**
+ * Helper methods for multikey.
+ */
+export declare class MultikeyHelper {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Convert a multikey to a JWK.
+     * @param multikey The multikey to convert.
+     * @returns The JWK.
+     * @throws GeneralError if the multikey is invalid.
+     */
+    static toJwk(multikey: IMultikey): IJwk;
+    /**
+     * Convert a JWK to a Multikey.
+     * @param controller The controller of the multikey.
+     * @param id The id of the multikey.
+     * @param jwk The jwk to convert.
+     * @returns The multikey.
+     * @throws GeneralError if the jwk is invalid.
+     */
+    static fromJwk(controller: string, id: string, jwk: IJwk): IMultikey;
+    /**
+     * Convert a multikey to raw keys.
+     * @param multikey The multikey to convert.
+     * @returns The JWK.
+     * @throws GeneralError if the multikey is invalid.
+     */
+    static toRaw(multikey: IMultikey): {
+        publicKey: Uint8Array;
+        privateKey: Uint8Array;
+    };
+}

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

@@ -0,0 +1,37 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { IJwk } from "@twin.org/web";
+import type { IProofSignerVerifier } from "../models/IProofSignerVerifier";
+import { ProofTypes } from "../models/proofTypes";
+/**
+ * Helper methods for creating and verifying proofs.
+ */
+export declare class ProofHelper {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
+    /**
+     * Create a signer verifier.
+     * @param proofType The type of proof to create.
+     * @returns The created signer verifier.
+     * @throws GeneralError if the proof type is not supported.
+     */
+    static createSignerVerifier(proofType: ProofTypes): IProofSignerVerifier;
+    /**
+     * Create a proof for the given data.
+     * @param proofType The type of proof to create.
+     * @param unsecuredDocument The data to create the proof for.
+     * @param unsignedProof The proof options.
+     * @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>;
+    /**
+     * Verify a proof for the given data.
+     * @param securedDocument The credential to verify.
+     * @param signedProof The proof to verify.
+     * @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>;
+}

package/docs/changelog.md

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

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
+
+### new DataIntegrityProofSignerVerifier()
+
+> **new DataIntegrityProofSignerVerifier**(): [`DataIntegrityProofSignerVerifier`](DataIntegrityProofSignerVerifier.md)
+
+#### Returns
+
+[`DataIntegrityProofSignerVerifier`](DataIntegrityProofSignerVerifier.md)
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## 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.
+
+#### 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
+
+`IJsonLdNodeObject`
+
+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
+
+`IJsonLdNodeObject`
+
+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
+
+### new JsonWebSignature2020SignerVerifier()
+
+> **new JsonWebSignature2020SignerVerifier**(): [`JsonWebSignature2020SignerVerifier`](JsonWebSignature2020SignerVerifier.md)
+
+#### Returns
+
+[`JsonWebSignature2020SignerVerifier`](JsonWebSignature2020SignerVerifier.md)
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+## 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.
+
+#### 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
+
+`IJsonLdNodeObject`
+
+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
+
+`IJsonLdNodeObject`
+
+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
+
+### new MultikeyHelper()
+
+> **new MultikeyHelper**(): [`MultikeyHelper`](MultikeyHelper.md)
+
+#### Returns
+
+[`MultikeyHelper`](MultikeyHelper.md)
+
+## 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,121 @@
+# Class: ProofHelper
+
+Helper methods for creating and verifying proofs.
+
+## Constructors
+
+### new ProofHelper()
+
+> **new ProofHelper**(): [`ProofHelper`](ProofHelper.md)
+
+#### Returns
+
+[`ProofHelper`](ProofHelper.md)
+
+## 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`\<`IJsonLdNodeObject`\>
+
+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
+
+`IJsonLdNodeObject`
+
+The proof options.
+
+##### signKey
+
+`IJwk`
+
+The key to sign the proof with.
+
+#### Returns
+
+`Promise`\<`IJsonLdNodeObject`\>
+
+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
+
+`IJsonLdNodeObject`
+
+The proof to verify.
+
+##### verifyKey
+
+`IJwk`
+
+The public key to verify the proof with.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+True if the credential was verified.