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

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

@@ -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(controller: string, verificationMethodId: string, id: string | undefined, credential: IJsonLdNodeObject, revocationIndex?: number): Promise<{
-        verifiableCredential: IDidVerifiableCredential;
+    createVerifiableCredential<T extends IJsonLdNodeObject = IJsonLdNodeObject>(controller: string, verificationMethodId: string, id: string | undefined, credential: T, revocationIndex?: number): Promise<{
+        verifiableCredential: IDidVerifiableCredential<T>;
         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(credentialJwt: string): Promise<{
+    checkVerifiableCredential<T extends IJsonLdNodeObject = IJsonLdNodeObject>(credentialJwt: string): Promise<{
         revoked: boolean;
-        verifiableCredential?: IDidVerifiableCredential;
+        verifiableCredential?: IDidVerifiableCredential<T>;
     }>;
     /**
      * 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(controller: string, presentationMethodId: string, presentationId: string | undefined, contexts: IJsonLdContextDefinitionRoot | undefined, types: string | string[] | undefined, verifiableCredentials: (string | IDidVerifiableCredential)[], expiresInMinutes?: number): Promise<{
-        verifiablePresentation: IDidVerifiablePresentation;
+    createVerifiablePresentation<T extends IJsonLdNodeObject = IJsonLdNodeObject>(controller: string, presentationMethodId: string, presentationId: string | undefined, contexts: IJsonLdContextDefinitionRoot | undefined, types: string | string[] | undefined, verifiableCredentials: (string | IDidVerifiableCredential<T>)[], expiresInMinutes?: number): Promise<{
+        verifiablePresentation: IDidVerifiablePresentation<T>;
         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(presentationJwt: string): Promise<{
+    checkVerifiablePresentation<T extends IJsonLdNodeObject = IJsonLdNodeObject>(presentationJwt: string): Promise<{
         revoked: boolean;
-        verifiablePresentation?: IDidVerifiablePresentation;
+        verifiablePresentation?: IDidVerifiablePresentation<T>;
         issuers?: IDidDocument[];
     }>;
     /**

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/identity-service-models - Changelog
 
-## v0.0.1-next.6
+## v0.0.1-next.8
 
 - Initial Release

package/docs/reference/interfaces/IIdentityConnector.md

@@ -194,10 +194,14 @@ NotFoundError if the id can not be resolved.
 
 ### createVerifiableCredential()
 
-> **createVerifiableCredential**(`controller`, `verificationMethodId`, `id`, `credential`, `revocationIndex`?): `Promise`\<`object`\>
+> **createVerifiableCredential**\<`T`\>(`controller`, `verificationMethodId`, `id`, `credential`, `revocationIndex`?): `Promise`\<`object`\>
 
 Create a verifiable credential for a verification method.
 
+#### Type Parameters
+
+• **T** *extends* `IJsonLdNodeObject` = `IJsonLdNodeObject`
+
 #### Parameters
 
 • **controller**: `string`
@@ -212,7 +216,7 @@ The verification method id to use.
 
 The id of the credential.
 
-• **credential**: `IJsonLdNodeObject`
+• **credential**: `T`
 
 The credential to store in the verifiable credential.
 
@@ -228,7 +232,7 @@ The created verifiable credential and its token.
 
 ##### verifiableCredential
 
-> **verifiableCredential**: `IDidVerifiableCredential`
+> **verifiableCredential**: `IDidVerifiableCredential`\<`T`\>
 
 ##### jwt
 
@@ -242,10 +246,14 @@ NotFoundError if the id can not be resolved.
 
 ### checkVerifiableCredential()
 
-> **checkVerifiableCredential**(`credentialJwt`): `Promise`\<`object`\>
+> **checkVerifiableCredential**\<`T`\>(`credentialJwt`): `Promise`\<`object`\>
 
 Check a verifiable credential is valid.
 
+#### Type Parameters
+
+• **T** *extends* `IJsonLdNodeObject` = `IJsonLdNodeObject`
+
 #### Parameters
 
 • **credentialJwt**: `string`
@@ -264,7 +272,7 @@ The credential stored in the jwt and the revocation status.
 
 ##### verifiableCredential?
 
-> `optional` **verifiableCredential**: `IDidVerifiableCredential`
+> `optional` **verifiableCredential**: `IDidVerifiableCredential`\<`T`\>
 
 ***
 
@@ -326,10 +334,14 @@ Nothing.
 
 ### createVerifiablePresentation()
 
-> **createVerifiablePresentation**(`controller`, `presentationMethodId`, `presentationId`, `contexts`, `types`, `verifiableCredentials`, `expiresInMinutes`?): `Promise`\<`object`\>
+> **createVerifiablePresentation**\<`T`\>(`controller`, `presentationMethodId`, `presentationId`, `contexts`, `types`, `verifiableCredentials`, `expiresInMinutes`?): `Promise`\<`object`\>
 
 Create a verifiable presentation from the supplied verifiable credentials.
 
+#### Type Parameters
+
+• **T** *extends* `IJsonLdNodeObject` = `IJsonLdNodeObject`
+
 #### Parameters
 
 • **controller**: `string`
@@ -352,7 +364,7 @@ The contexts for the data stored in the verifiable credential.
 
 The types for the data stored in the verifiable credential.
 
-• **verifiableCredentials**: (`string` \| `IDidVerifiableCredential`)[]
+• **verifiableCredentials**: (`string` \| `IDidVerifiableCredential`\<`T`\>)[]
 
 The credentials to use for creating the presentation in jwt format.
 
@@ -368,7 +380,7 @@ The created verifiable presentation and its token.
 
 ##### verifiablePresentation
 
-> **verifiablePresentation**: `IDidVerifiablePresentation`
+> **verifiablePresentation**: `IDidVerifiablePresentation`\<`T`\>
 
 ##### jwt
 
@@ -382,10 +394,14 @@ NotFoundError if the id can not be resolved.
 
 ### checkVerifiablePresentation()
 
-> **checkVerifiablePresentation**(`presentationJwt`): `Promise`\<`object`\>
+> **checkVerifiablePresentation**\<`T`\>(`presentationJwt`): `Promise`\<`object`\>
 
 Check a verifiable presentation is valid.
 
+#### Type Parameters
+
+• **T** *extends* `IJsonLdNodeObject` = `IJsonLdNodeObject`
+
 #### Parameters
 
 • **presentationJwt**: `string`
@@ -404,7 +420,7 @@ The presentation stored in the jwt and the revocation status.
 
 ##### verifiablePresentation?
 
-> `optional` **verifiablePresentation**: `IDidVerifiablePresentation`
+> `optional` **verifiablePresentation**: `IDidVerifiablePresentation`\<`T`\>
 
 ##### issuers?
 

package/package.json

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