@twin.org/identity-models 0.0.1-next.4 → 0.0.1-next.6

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

@@ -1,4 +1,5 @@
 import type { IComponent } from "@twin.org/core";
+import type { IJsonLdContextDefinitionRoot, IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import type { DidVerificationMethodType, IDidDocument, IDidDocumentVerificationMethod, IDidService, IDidVerifiableCredential, IDidVerifiablePresentation } from "@twin.org/standards-w3c-did";
 /**
  * Interface describing an identity connector.
@@ -60,16 +61,14 @@ export interface IIdentityConnector extends IComponent {
      * Create a verifiable credential for a verification method.
      * @param controller The controller of the identity who can make changes.
      * @param verificationMethodId The verification method id to use.
-     * @param credentialId The id of the credential.
-     * @param types The type for the data stored in the verifiable credential.
-     * @param subject The subject data to store for the credential.
-     * @param contexts Additional contexts to include in the credential.
+     * @param id The id of the credential.
+     * @param credential The credential to store in the verifiable credential.
      * @param revocationIndex The bitmap revocation index of the credential, if undefined will not have revocation status.
      * @returns The created verifiable credential and its token.
      * @throws NotFoundError if the id can not be resolved.
      */
-    createVerifiableCredential<T>(controller: string, verificationMethodId: string, credentialId: string | undefined, types: string | string[] | undefined, subject: T | T[], contexts?: string | string[], revocationIndex?: number): Promise<{
-        verifiableCredential: IDidVerifiableCredential<T>;
+    createVerifiableCredential(controller: string, verificationMethodId: string, id: string | undefined, credential: IJsonLdNodeObject, revocationIndex?: number): Promise<{
+        verifiableCredential: IDidVerifiableCredential;
         jwt: string;
     }>;
     /**
@@ -77,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>(credentialJwt: string): Promise<{
+    checkVerifiableCredential(credentialJwt: string): Promise<{
         revoked: boolean;
-        verifiableCredential?: IDidVerifiableCredential<T>;
+        verifiableCredential?: IDidVerifiableCredential;
     }>;
     /**
      * Revoke verifiable credential(s).
@@ -101,14 +100,15 @@ export interface IIdentityConnector extends IComponent {
      * Create a verifiable presentation from the supplied verifiable credentials.
      * @param controller The controller of the identity who can make changes.
      * @param presentationMethodId The method to associate with the presentation.
+     * @param presentationId The id of the presentation.
+     * @param contexts The contexts for the data stored in the verifiable credential.
      * @param types The types for the data stored in the verifiable credential.
      * @param verifiableCredentials The credentials to use for creating the presentation in jwt format.
-     * @param contexts Additional contexts to include in the presentation.
      * @param expiresInMinutes The time in minutes for the presentation to expire.
      * @returns The created verifiable presentation and its token.
      * @throws NotFoundError if the id can not be resolved.
      */
-    createVerifiablePresentation(controller: string, presentationMethodId: string, types: string | string[] | undefined, verifiableCredentials: string[], contexts?: string | string[], expiresInMinutes?: number): Promise<{
+    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;
     }>;

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/identity-service-models - Changelog
 
-## v0.0.1-next.4
+## v0.0.1-next.6
 
 - 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`, `credentialId`, `types`, `subject`, `contexts`?, `revocationIndex`?): `Promise`\<`object`\>
+> **createVerifiableCredential**(`controller`, `verificationMethodId`, `id`, `credential`, `revocationIndex`?): `Promise`\<`object`\>
 
 Create a verifiable credential for a verification method.
 
-#### Type Parameters
-
-• **T**
-
 #### Parameters
 
 • **controller**: `string`
@@ -212,21 +208,13 @@ The controller of the identity who can make changes.
 
 The verification method id to use.
 
-• **credentialId**: `undefined` \| `string`
+• **id**: `undefined` \| `string`
 
 The id of the credential.
 
-• **types**: `undefined` \| `string` \| `string`[]
-
-The type for the data stored in the verifiable credential.
+• **credential**: `IJsonLdNodeObject`
 
-• **subject**: `T` \| `T`[]
-
-The subject data to store for the credential.
-
-• **contexts?**: `string` \| `string`[]
-
-Additional contexts to include in the credential.
+The credential to store in the verifiable credential.
 
 • **revocationIndex?**: `number`
 
@@ -240,7 +228,7 @@ The created verifiable credential and its token.
 
 ##### verifiableCredential
 
-> **verifiableCredential**: `IDidVerifiableCredential`\<`T`\>
+> **verifiableCredential**: `IDidVerifiableCredential`
 
 ##### jwt
 
@@ -254,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**
-
 #### Parameters
 
 • **credentialJwt**: `string`
@@ -280,7 +264,7 @@ The credential stored in the jwt and the revocation status.
 
 ##### verifiableCredential?
 
-> `optional` **verifiableCredential**: `IDidVerifiableCredential`\<`T`\>
+> `optional` **verifiableCredential**: `IDidVerifiableCredential`
 
 ***
 
@@ -342,7 +326,7 @@ Nothing.
 
 ### createVerifiablePresentation()
 
-> **createVerifiablePresentation**(`controller`, `presentationMethodId`, `types`, `verifiableCredentials`, `contexts`?, `expiresInMinutes`?): `Promise`\<`object`\>
+> **createVerifiablePresentation**(`controller`, `presentationMethodId`, `presentationId`, `contexts`, `types`, `verifiableCredentials`, `expiresInMinutes`?): `Promise`\<`object`\>
 
 Create a verifiable presentation from the supplied verifiable credentials.
 
@@ -356,18 +340,22 @@ The controller of the identity who can make changes.
 
 The method to associate with the presentation.
 
+• **presentationId**: `undefined` \| `string`
+
+The id of the presentation.
+
+• **contexts**: `undefined` \| `IJsonLdContextDefinitionRoot`
+
+The contexts for the data stored in the verifiable credential.
+
 • **types**: `undefined` \| `string` \| `string`[]
 
 The types for the data stored in the verifiable credential.
 
-• **verifiableCredentials**: `string`[]
+• **verifiableCredentials**: (`string` \| `IDidVerifiableCredential`)[]
 
 The credentials to use for creating the presentation in jwt format.
 
-• **contexts?**: `string` \| `string`[]
-
-Additional contexts to include in the presentation.
-
 • **expiresInMinutes?**: `number`
 
 The time in minutes for the presentation to expire.

package/package.json

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