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

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 { IJsonLdContextDefinitionRoot, IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { DidVerificationMethodType, IDidDocument, IDidDocumentVerificationMethod, IDidProof, IDidService, IDidVerifiableCredential, IDidVerifiablePresentation } from "@twin.org/standards-w3c-did";
 /**
  * Interface describing an identity connector.
  */
@@ -67,8 +67,8 @@ export interface IIdentityConnector extends IComponent {
      * @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;
     }>;
     /**
@@ -76,9 +76,9 @@ export interface IIdentityConnector extends IComponent {
      * @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).
@@ -108,8 +108,8 @@ export interface IIdentityConnector extends IComponent {
      * @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;
     }>;
     /**
@@ -117,9 +117,9 @@ export interface IIdentityConnector extends IComponent {
      * @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[];
     }>;
     /**
@@ -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.15
 
 - Initial Release

package/docs/reference/interfaces/IIdentityConnector.md

@@ -194,14 +194,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`
@@ -216,7 +212,7 @@ The verification method id to use.
 
 The id of the credential.
 
-• **credential**: `T`
+• **credential**: `IJsonLdNodeObject`
 
 The credential to store in the verifiable credential.
 
@@ -232,7 +228,7 @@ The created verifiable credential and its token.
 
 ##### verifiableCredential
 
-> **verifiableCredential**: `IDidVerifiableCredential`\<`T`\>
+> **verifiableCredential**: `IDidVerifiableCredential`
 
 ##### jwt
 
@@ -246,14 +242,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`
@@ -272,7 +264,7 @@ The credential stored in the jwt and the revocation status.
 
 ##### verifiableCredential?
 
-> `optional` **verifiableCredential**: `IDidVerifiableCredential`\<`T`\>
+> `optional` **verifiableCredential**: `IDidVerifiableCredential`
 
 ***
 
@@ -334,14 +326,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`
@@ -364,7 +352,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.
 
@@ -380,7 +368,7 @@ The created verifiable presentation and its token.
 
 ##### verifiablePresentation
 
-> **verifiablePresentation**: `IDidVerifiablePresentation`\<`T`\>
+> **verifiablePresentation**: `IDidVerifiablePresentation`
 
 ##### jwt
 
@@ -394,14 +382,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`
@@ -420,7 +404,7 @@ The presentation stored in the jwt and the revocation status.
 
 ##### verifiablePresentation?
 
-> `optional` **verifiablePresentation**: `IDidVerifiablePresentation`\<`T`\>
+> `optional` **verifiablePresentation**: `IDidVerifiablePresentation`
 
 ##### issuers?
 
@@ -430,7 +414,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 +434,30 @@ The data bytes to sign.
 
 #### Returns
 
-`Promise`\<`object`\>
-
-The proof signature type and value.
+`Promise`\<`IDidProof`\>
 
-##### type
-
-> **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.15",
 	"description": "Models which define the structure of the contracts and connectors",
 	"repository": {
 		"type": "git",