@twin.org/identity-connector-entity-storage 0.0.1-next.13 → 0.0.1-next.15

package/dist/cjs/index.cjs

@@ -421,7 +421,7 @@ class EntityStorageIdentityConnector {
                 finalTypes.push(credType);
             }
             const verifiableCredential = {
-                "@context": dataJsonLd.JsonLdProcessor.combineContexts(standardsW3cDid.DidContexts.ContextVCv1, credContext) ?? null,
+                "@context": dataJsonLd.JsonLdProcessor.combineContexts(standardsW3cDid.DidContexts.ContextVCv2, credContext),
                 id,
                 type: finalTypes,
                 credentialSubject: credentialClone,
@@ -542,9 +542,7 @@ class EntityStorageIdentityConnector {
             const revoked = await this.checkRevocation(issuerDidDocument, verifiableCredential.credentialStatus?.revocationBitmapIndex);
             return {
                 revoked,
-                verifiableCredential: revoked
-                    ? undefined
-                    : verifiableCredential
+                verifiableCredential: revoked ? undefined : verifiableCredential
             };
         }
         catch (error) {
@@ -689,7 +687,7 @@ class EntityStorageIdentityConnector {
                 finalTypes.push(types);
             }
             const verifiablePresentation = {
-                "@context": dataJsonLd.JsonLdProcessor.combineContexts(standardsW3cDid.DidContexts.ContextVCv1, contexts) ?? null,
+                "@context": dataJsonLd.JsonLdProcessor.combineContexts(standardsW3cDid.DidContexts.ContextVCv2, contexts),
                 id: presentationId,
                 type: finalTypes,
                 verifiableCredential: verifiableCredentials,
@@ -801,7 +799,7 @@ class EntityStorageIdentityConnector {
      * @param controller The controller of the identity who can make changes.
      * @param verificationMethodId The verification method id to use.
      * @param bytes The data bytes to sign.
-     * @returns The proof signature type and value.
+     * @returns The proof.
      */
     async createProof(controller, verificationMethodId, bytes) {
         core.Guards.stringValue(this.CLASS_NAME, "controller", controller);
@@ -834,8 +832,13 @@ class EntityStorageIdentityConnector {
             }
             const signature = await this._vaultConnector.sign(this.buildVaultKey(didDocument.id, verificationMethodId), bytes);
             return {
-                type: "Ed25519",
-                value: signature
+                "@context": standardsW3cDid.DidContexts.ContextVCDataIntegrity,
+                type: standardsW3cDid.DidTypes.DataIntegrityProof,
+                cryptosuite: "eddsa-jcs-2022",
+                created: new Date(Date.now()).toISOString(),
+                verificationMethod: verificationMethodId,
+                proofPurpose: "assertionMethod",
+                proofValue: core.Converter.bytesToBase58(signature)
             };
         }
         catch (error) {
@@ -844,21 +847,27 @@ class EntityStorageIdentityConnector {
     }
     /**
      * Verify proof for arbitrary data with the specified verification method.
-     * @param verificationMethodId The verification method id to use.
      * @param bytes The data bytes to verify.
-     * @param signatureType The type of the signature for the proof.
-     * @param signatureValue The value of the signature for the proof.
-     * @returns True if the signature is valid.
+     * @param proof The proof to verify.
+     * @returns True if the proof is verified.
      */
-    async verifyProof(verificationMethodId, bytes, signatureType, signatureValue) {
-        core.Guards.stringValue(this.CLASS_NAME, "verificationMethodId", verificationMethodId);
+    async verifyProof(bytes, proof) {
         core.Guards.uint8Array(this.CLASS_NAME, "bytes", bytes);
-        core.Guards.stringValue(this.CLASS_NAME, "signatureType", signatureType);
-        core.Guards.uint8Array(this.CLASS_NAME, "signatureValue", signatureValue);
+        core.Guards.object(this.CLASS_NAME, "proof", proof);
+        core.Guards.stringValue(this.CLASS_NAME, "proof.type", proof.type);
+        core.Guards.stringValue(this.CLASS_NAME, "proof.cryptosuite", proof.cryptosuite);
+        core.Guards.stringValue(this.CLASS_NAME, "proof.verificationMethod", proof.verificationMethod);
+        core.Guards.stringBase58(this.CLASS_NAME, "proof.proofValue", proof.proofValue);
         try {
-            const idParts = identityModels.DocumentHelper.parse(verificationMethodId);
+            if (proof.type !== standardsW3cDid.DidTypes.DataIntegrityProof) {
+                throw new core.GeneralError(this.CLASS_NAME, "proofType", { proofType: proof.type });
+            }
+            if (proof.cryptosuite !== "eddsa-jcs-2022") {
+                throw new core.GeneralError(this.CLASS_NAME, "cryptoSuite", { cryptosuite: proof.cryptosuite });
+            }
+            const idParts = identityModels.DocumentHelper.parse(proof.verificationMethod);
             if (core.Is.empty(idParts.hash)) {
-                throw new core.NotFoundError(this.CLASS_NAME, "missingDid", verificationMethodId);
+                throw new core.NotFoundError(this.CLASS_NAME, "missingDid", proof.verificationMethod);
             }
             const didIdentityDocument = await this._didDocumentEntityStorage.get(idParts.id);
             if (core.Is.undefined(didIdentityDocument)) {
@@ -869,9 +878,9 @@ class EntityStorageIdentityConnector {
             const methods = this.getAllMethods(didDocument);
             const methodAndArray = methods.find(m => {
                 if (core.Is.string(m.method)) {
-                    return m.method === verificationMethodId;
+                    return m.method === proof.verificationMethod;
                 }
-                return m.method.id === verificationMethodId;
+                return m.method.id === proof.verificationMethod;
             });
             if (!methodAndArray) {
                 throw new core.GeneralError(this.CLASS_NAME, "methodMissing");
@@ -880,7 +889,7 @@ class EntityStorageIdentityConnector {
             if (!core.Is.stringValue(didMethod.publicKeyJwk?.x)) {
                 throw new core.GeneralError(this.CLASS_NAME, "publicKeyJwkMissing");
             }
-            return this._vaultConnector.verify(this.buildVaultKey(didIdentityDocument.id, verificationMethodId), bytes, signatureValue);
+            return this._vaultConnector.verify(this.buildVaultKey(didIdentityDocument.id, proof.verificationMethod), bytes, core.Converter.base58ToBytes(proof.proofValue));
         }
         catch (error) {
             throw new core.GeneralError(this.CLASS_NAME, "verifyProofFailed", undefined, error);

package/dist/esm/index.mjs

@@ -419,7 +419,7 @@ class EntityStorageIdentityConnector {
                 finalTypes.push(credType);
             }
             const verifiableCredential = {
-                "@context": JsonLdProcessor.combineContexts(DidContexts.ContextVCv1, credContext) ?? null,
+                "@context": JsonLdProcessor.combineContexts(DidContexts.ContextVCv2, credContext),
                 id,
                 type: finalTypes,
                 credentialSubject: credentialClone,
@@ -540,9 +540,7 @@ class EntityStorageIdentityConnector {
             const revoked = await this.checkRevocation(issuerDidDocument, verifiableCredential.credentialStatus?.revocationBitmapIndex);
             return {
                 revoked,
-                verifiableCredential: revoked
-                    ? undefined
-                    : verifiableCredential
+                verifiableCredential: revoked ? undefined : verifiableCredential
             };
         }
         catch (error) {
@@ -687,7 +685,7 @@ class EntityStorageIdentityConnector {
                 finalTypes.push(types);
             }
             const verifiablePresentation = {
-                "@context": JsonLdProcessor.combineContexts(DidContexts.ContextVCv1, contexts) ?? null,
+                "@context": JsonLdProcessor.combineContexts(DidContexts.ContextVCv2, contexts),
                 id: presentationId,
                 type: finalTypes,
                 verifiableCredential: verifiableCredentials,
@@ -799,7 +797,7 @@ class EntityStorageIdentityConnector {
      * @param controller The controller of the identity who can make changes.
      * @param verificationMethodId The verification method id to use.
      * @param bytes The data bytes to sign.
-     * @returns The proof signature type and value.
+     * @returns The proof.
      */
     async createProof(controller, verificationMethodId, bytes) {
         Guards.stringValue(this.CLASS_NAME, "controller", controller);
@@ -832,8 +830,13 @@ class EntityStorageIdentityConnector {
             }
             const signature = await this._vaultConnector.sign(this.buildVaultKey(didDocument.id, verificationMethodId), bytes);
             return {
-                type: "Ed25519",
-                value: signature
+                "@context": DidContexts.ContextVCDataIntegrity,
+                type: DidTypes.DataIntegrityProof,
+                cryptosuite: "eddsa-jcs-2022",
+                created: new Date(Date.now()).toISOString(),
+                verificationMethod: verificationMethodId,
+                proofPurpose: "assertionMethod",
+                proofValue: Converter.bytesToBase58(signature)
             };
         }
         catch (error) {
@@ -842,21 +845,27 @@ class EntityStorageIdentityConnector {
     }
     /**
      * Verify proof for arbitrary data with the specified verification method.
-     * @param verificationMethodId The verification method id to use.
      * @param bytes The data bytes to verify.
-     * @param signatureType The type of the signature for the proof.
-     * @param signatureValue The value of the signature for the proof.
-     * @returns True if the signature is valid.
+     * @param proof The proof to verify.
+     * @returns True if the proof is verified.
      */
-    async verifyProof(verificationMethodId, bytes, signatureType, signatureValue) {
-        Guards.stringValue(this.CLASS_NAME, "verificationMethodId", verificationMethodId);
+    async verifyProof(bytes, proof) {
         Guards.uint8Array(this.CLASS_NAME, "bytes", bytes);
-        Guards.stringValue(this.CLASS_NAME, "signatureType", signatureType);
-        Guards.uint8Array(this.CLASS_NAME, "signatureValue", signatureValue);
+        Guards.object(this.CLASS_NAME, "proof", proof);
+        Guards.stringValue(this.CLASS_NAME, "proof.type", proof.type);
+        Guards.stringValue(this.CLASS_NAME, "proof.cryptosuite", proof.cryptosuite);
+        Guards.stringValue(this.CLASS_NAME, "proof.verificationMethod", proof.verificationMethod);
+        Guards.stringBase58(this.CLASS_NAME, "proof.proofValue", proof.proofValue);
         try {
-            const idParts = DocumentHelper.parse(verificationMethodId);
+            if (proof.type !== DidTypes.DataIntegrityProof) {
+                throw new GeneralError(this.CLASS_NAME, "proofType", { proofType: proof.type });
+            }
+            if (proof.cryptosuite !== "eddsa-jcs-2022") {
+                throw new GeneralError(this.CLASS_NAME, "cryptoSuite", { cryptosuite: proof.cryptosuite });
+            }
+            const idParts = DocumentHelper.parse(proof.verificationMethod);
             if (Is.empty(idParts.hash)) {
-                throw new NotFoundError(this.CLASS_NAME, "missingDid", verificationMethodId);
+                throw new NotFoundError(this.CLASS_NAME, "missingDid", proof.verificationMethod);
             }
             const didIdentityDocument = await this._didDocumentEntityStorage.get(idParts.id);
             if (Is.undefined(didIdentityDocument)) {
@@ -867,9 +876,9 @@ class EntityStorageIdentityConnector {
             const methods = this.getAllMethods(didDocument);
             const methodAndArray = methods.find(m => {
                 if (Is.string(m.method)) {
-                    return m.method === verificationMethodId;
+                    return m.method === proof.verificationMethod;
                 }
-                return m.method.id === verificationMethodId;
+                return m.method.id === proof.verificationMethod;
             });
             if (!methodAndArray) {
                 throw new GeneralError(this.CLASS_NAME, "methodMissing");
@@ -878,7 +887,7 @@ class EntityStorageIdentityConnector {
             if (!Is.stringValue(didMethod.publicKeyJwk?.x)) {
                 throw new GeneralError(this.CLASS_NAME, "publicKeyJwkMissing");
             }
-            return this._vaultConnector.verify(this.buildVaultKey(didIdentityDocument.id, verificationMethodId), bytes, signatureValue);
+            return this._vaultConnector.verify(this.buildVaultKey(didIdentityDocument.id, proof.verificationMethod), bytes, Converter.base58ToBytes(proof.proofValue));
         }
         catch (error) {
             throw new GeneralError(this.CLASS_NAME, "verifyProofFailed", undefined, error);

package/dist/types/entityStorageIdentityConnector.d.ts

@@ -1,6 +1,6 @@
-import { type IJsonLdContextDefinitionRoot, type IJsonLdObject } from "@twin.org/data-json-ld";
+import { type IJsonLdContextDefinitionRoot, type IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import { type IIdentityConnector } from "@twin.org/identity-models";
-import { DidVerificationMethodType, type IDidDocument, type IDidDocumentVerificationMethod, type IDidService, type IDidVerifiableCredential, type IDidVerifiablePresentation } from "@twin.org/standards-w3c-did";
+import { DidVerificationMethodType, type IDidDocument, type IDidDocumentVerificationMethod, type IDidProof, type IDidService, type IDidVerifiableCredential, type IDidVerifiablePresentation } from "@twin.org/standards-w3c-did";
 /**
  * Class for performing identity operations using entity storage.
  */
@@ -85,8 +85,8 @@ export declare class EntityStorageIdentityConnector implements IIdentityConnecto
      * @returns The created verifiable credential and its token.
      * @throws NotFoundError if the id can not be resolved.
      */
-    createVerifiableCredential<T extends IJsonLdObject>(controller: string, verificationMethodId: string, id: string | undefined, credential: T, revocationIndex?: number): Promise<{
-        verifiableCredential: IDidVerifiableCredential<T>;
+    createVerifiableCredential(controller: string, verificationMethodId: string, id: string | undefined, credential: IJsonLdNodeObject, revocationIndex?: number): Promise<{
+        verifiableCredential: IDidVerifiableCredential;
         jwt: string;
     }>;
     /**
@@ -94,9 +94,9 @@ export declare class EntityStorageIdentityConnector implements IIdentityConnecto
      * @param credentialJwt The credential to verify.
      * @returns The credential stored in the jwt and the revocation status.
      */
-    checkVerifiableCredential<T extends IJsonLdObject>(credentialJwt: string): Promise<{
+    checkVerifiableCredential(credentialJwt: string): Promise<{
         revoked: boolean;
-        verifiableCredential?: IDidVerifiableCredential<T>;
+        verifiableCredential?: IDidVerifiableCredential;
     }>;
     /**
      * Revoke verifiable credential(s).
@@ -126,8 +126,8 @@ export declare class EntityStorageIdentityConnector implements IIdentityConnecto
      * @returns The created verifiable presentation and its token.
      * @throws NotFoundError if the id can not be resolved.
      */
-    createVerifiablePresentation<T extends IJsonLdObject>(controller: string, presentationMethodId: string, presentationId: string | undefined, contexts: IJsonLdContextDefinitionRoot | undefined, types: string | string[] | undefined, verifiableCredentials: (string | IDidVerifiableCredential<T>)[], expiresInMinutes?: number): Promise<{
-        verifiablePresentation: IDidVerifiablePresentation<T>;
+    createVerifiablePresentation(controller: string, presentationMethodId: string, presentationId: string | undefined, contexts: IJsonLdContextDefinitionRoot | undefined, types: string | string[] | undefined, verifiableCredentials: (string | IDidVerifiableCredential)[], expiresInMinutes?: number): Promise<{
+        verifiablePresentation: IDidVerifiablePresentation;
         jwt: string;
     }>;
     /**
@@ -135,9 +135,9 @@ export declare class EntityStorageIdentityConnector implements IIdentityConnecto
      * @param presentationJwt The presentation to verify.
      * @returns The presentation stored in the jwt and the revocation status.
      */
-    checkVerifiablePresentation<T extends IJsonLdObject>(presentationJwt: string): Promise<{
+    checkVerifiablePresentation(presentationJwt: string): Promise<{
         revoked: boolean;
-        verifiablePresentation?: IDidVerifiablePresentation<T>;
+        verifiablePresentation?: IDidVerifiablePresentation;
         issuers?: IDidDocument[];
     }>;
     /**
@@ -145,19 +145,14 @@ export declare class EntityStorageIdentityConnector implements IIdentityConnecto
      * @param controller The controller of the identity who can make changes.
      * @param verificationMethodId The verification method id to use.
      * @param bytes The data bytes to sign.
-     * @returns The proof signature type and value.
+     * @returns The proof.
      */
-    createProof(controller: string, verificationMethodId: string, bytes: Uint8Array): Promise<{
-        type: string;
-        value: Uint8Array;
-    }>;
+    createProof(controller: string, verificationMethodId: string, bytes: Uint8Array): Promise<IDidProof>;
     /**
      * Verify proof for arbitrary data with the specified verification method.
-     * @param verificationMethodId The verification method id to use.
      * @param bytes The data bytes to verify.
-     * @param signatureType The type of the signature for the proof.
-     * @param signatureValue The value of the signature for the proof.
-     * @returns True if the signature is valid.
+     * @param proof The proof to verify.
+     * @returns True if the proof is verified.
      */
-    verifyProof(verificationMethodId: string, bytes: Uint8Array, signatureType: string, signatureValue: Uint8Array): Promise<boolean>;
+    verifyProof(bytes: Uint8Array, proof: IDidProof): Promise<boolean>;
 }

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/identity-connector-entity-storage- Changelog
 
-## v0.0.1-next.13
+## v0.0.1-next.15
 
 - Initial Release

package/docs/reference/classes/EntityStorageIdentityConnector.md

@@ -264,14 +264,10 @@ NotFoundError if the id can not be resolved.
 
 ### createVerifiableCredential()
 
-> **createVerifiableCredential**\<`T`\>(`controller`, `verificationMethodId`, `id`, `credential`, `revocationIndex`?): `Promise`\<`object`\>
+> **createVerifiableCredential**(`controller`, `verificationMethodId`, `id`, `credential`, `revocationIndex`?): `Promise`\<`object`\>
 
 Create a verifiable credential for a verification method.
 
-#### Type Parameters
-
-• **T** *extends* `IJsonLdObject`
-
 #### Parameters
 
 • **controller**: `string`
@@ -286,7 +282,7 @@ The verification method id to use.
 
 The id of the credential.
 
-• **credential**: `T`
+• **credential**: `IJsonLdNodeObject`
 
 The credential to store in the verifiable credential.
 
@@ -302,7 +298,7 @@ The created verifiable credential and its token.
 
 ##### verifiableCredential
 
-> **verifiableCredential**: `IDidVerifiableCredential`\<`T`\>
+> **verifiableCredential**: `IDidVerifiableCredential`
 
 ##### jwt
 
@@ -320,14 +316,10 @@ NotFoundError if the id can not be resolved.
 
 ### checkVerifiableCredential()
 
-> **checkVerifiableCredential**\<`T`\>(`credentialJwt`): `Promise`\<`object`\>
+> **checkVerifiableCredential**(`credentialJwt`): `Promise`\<`object`\>
 
 Check a verifiable credential is valid.
 
-#### Type Parameters
-
-• **T** *extends* `IJsonLdObject`
-
 #### Parameters
 
 • **credentialJwt**: `string`
@@ -346,7 +338,7 @@ The credential stored in the jwt and the revocation status.
 
 ##### verifiableCredential?
 
-> `optional` **verifiableCredential**: `IDidVerifiableCredential`\<`T`\>
+> `optional` **verifiableCredential**: `IDidVerifiableCredential`
 
 #### Implementation of
 
@@ -420,14 +412,10 @@ Nothing.
 
 ### createVerifiablePresentation()
 
-> **createVerifiablePresentation**\<`T`\>(`controller`, `presentationMethodId`, `presentationId`, `contexts`, `types`, `verifiableCredentials`, `expiresInMinutes`?): `Promise`\<`object`\>
+> **createVerifiablePresentation**(`controller`, `presentationMethodId`, `presentationId`, `contexts`, `types`, `verifiableCredentials`, `expiresInMinutes`?): `Promise`\<`object`\>
 
 Create a verifiable presentation from the supplied verifiable credentials.
 
-#### Type Parameters
-
-• **T** *extends* `IJsonLdObject`
-
 #### Parameters
 
 • **controller**: `string`
@@ -450,7 +438,7 @@ The contexts for the data stored in the verifiable credential.
 
 The types for the data stored in the verifiable credential.
 
-• **verifiableCredentials**: (`string` \| `IDidVerifiableCredential`\<`T`\>)[]
+• **verifiableCredentials**: (`string` \| `IDidVerifiableCredential`)[]
 
 The credentials to use for creating the presentation in jwt format.
 
@@ -466,7 +454,7 @@ The created verifiable presentation and its token.
 
 ##### verifiablePresentation
 
-> **verifiablePresentation**: `IDidVerifiablePresentation`\<`T`\>
+> **verifiablePresentation**: `IDidVerifiablePresentation`
 
 ##### jwt
 
@@ -484,14 +472,10 @@ NotFoundError if the id can not be resolved.
 
 ### checkVerifiablePresentation()
 
-> **checkVerifiablePresentation**\<`T`\>(`presentationJwt`): `Promise`\<`object`\>
+> **checkVerifiablePresentation**(`presentationJwt`): `Promise`\<`object`\>
 
 Check a verifiable presentation is valid.
 
-#### Type Parameters
-
-• **T** *extends* `IJsonLdObject`
-
 #### Parameters
 
 • **presentationJwt**: `string`
@@ -510,7 +494,7 @@ The presentation stored in the jwt and the revocation status.
 
 ##### verifiablePresentation?
 
-> `optional` **verifiablePresentation**: `IDidVerifiablePresentation`\<`T`\>
+> `optional` **verifiablePresentation**: `IDidVerifiablePresentation`
 
 ##### issuers?
 
@@ -524,7 +508,7 @@ The presentation stored in the jwt and the revocation status.
 
 ### createProof()
 
-> **createProof**(`controller`, `verificationMethodId`, `bytes`): `Promise`\<`object`\>
+> **createProof**(`controller`, `verificationMethodId`, `bytes`): `Promise`\<`IDidProof`\>
 
 Create a proof for arbitrary data with the specified verification method.
 
@@ -544,17 +528,9 @@ The data bytes to sign.
 
 #### Returns
 
-`Promise`\<`object`\>
-
-The proof signature type and value.
+`Promise`\<`IDidProof`\>
 
-##### type
-
-> **type**: `string`
-
-##### value
-
-> **value**: `Uint8Array`
+The proof.
 
 #### Implementation of
 
@@ -564,33 +540,25 @@ The proof signature type and value.
 
 ### verifyProof()
 
-> **verifyProof**(`verificationMethodId`, `bytes`, `signatureType`, `signatureValue`): `Promise`\<`boolean`\>
+> **verifyProof**(`bytes`, `proof`): `Promise`\<`boolean`\>
 
 Verify proof for arbitrary data with the specified verification method.
 
 #### Parameters
 
-• **verificationMethodId**: `string`
-
-The verification method id to use.
-
 • **bytes**: `Uint8Array`
 
 The data bytes to verify.
 
-• **signatureType**: `string`
-
-The type of the signature for the proof.
-
-• **signatureValue**: `Uint8Array`
+• **proof**: `IDidProof`
 
-The value of the signature for the proof.
+The proof to verify.
 
 #### Returns
 
 `Promise`\<`boolean`\>
 
-True if the signature is valid.
+True if the proof is verified.
 
 #### Implementation of
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/identity-connector-entity-storage",
-	"version": "0.0.1-next.13",
+	"version": "0.0.1-next.15",
 	"description": "Identity connector implementation using entity storage",
 	"repository": {
 		"type": "git",
@@ -19,7 +19,7 @@
 		"@twin.org/data-core": "next",
 		"@twin.org/data-json-ld": "next",
 		"@twin.org/entity": "next",
-		"@twin.org/identity-models": "0.0.1-next.13",
+		"@twin.org/identity-models": "0.0.1-next.15",
 		"@twin.org/nameof": "next",
 		"@twin.org/standards-w3c-did": "next",
 		"@twin.org/vault-models": "next",