@twin.org/identity-models 0.0.1-next.13 → 0.0.1-next.14

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

@@ -1,6 +1,6 @@
 import type { IComponent } from "@twin.org/core";
 import type { IJsonLdContextDefinitionRoot, IJsonLdObject } from "@twin.org/data-json-ld";
-import type { DidVerificationMethodType, IDidDocument, IDidDocumentVerificationMethod, IDidService, IDidVerifiableCredential, IDidVerifiablePresentation } from "@twin.org/standards-w3c-did";
+import type { DidVerificationMethodType, IDidDocument, IDidDocumentVerificationMethod, IDidProof, IDidService, IDidVerifiableCredential, IDidVerifiablePresentation } from "@twin.org/standards-w3c-did";
 /**
  * Interface describing an identity connector.
  */
@@ -127,19 +127,14 @@ export interface IIdentityConnector extends IComponent {
      * @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-service-models - Changelog
 
-## v0.0.1-next.13
+## v0.0.1-next.14
 
 - Initial Release

package/docs/reference/interfaces/IIdentityConnector.md

@@ -430,7 +430,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.
 
@@ -450,46 +450,30 @@ The data bytes to sign.
 
 #### Returns
 
-`Promise`\<`object`\>
-
-The proof signature type and value.
-
-##### type
+`Promise`\<`IDidProof`\>
 
-> **type**: `string`
-
-##### value
-
-> **value**: `Uint8Array`
+The proof.
 
 ***
 
 ### 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.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/identity-models",
-	"version": "0.0.1-next.13",
+	"version": "0.0.1-next.14",
 	"description": "Models which define the structure of the contracts and connectors",
 	"repository": {
 		"type": "git",