@twin.org/identity-models 0.0.2-next.3 → 0.0.2-next.4

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

@@ -63,12 +63,17 @@ export interface IIdentityComponent extends IComponent {
      * @param verificationMethodId The verification method id to use.
      * @param id The id of the credential.
      * @param subject The credential subject to store in the verifiable credential.
-     * @param revocationIndex The bitmap revocation index of the credential, if undefined will not have revocation status.
+     * @param options Additional options for creating the verifiable credential.
+     * @param options.revocationIndex The bitmap revocation index of the credential, if undefined will not have revocation status.
+     * @param options.expirationDate The date the verifiable credential is valid until.
      * @param controller The controller of the identity who can make changes.
      * @returns The created verifiable credential and its token.
      * @throws NotFoundError if the id can not be resolved.
      */
-    verifiableCredentialCreate(verificationMethodId: string, id: string | undefined, subject: IJsonLdNodeObject, revocationIndex?: number, controller?: string): Promise<{
+    verifiableCredentialCreate(verificationMethodId: string, id: string | undefined, subject: IJsonLdNodeObject, options?: {
+        revocationIndex?: number;
+        expirationDate?: Date;
+    }, controller?: string): Promise<{
         verifiableCredential: IDidVerifiableCredential;
         jwt: string;
     }>;

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

@@ -63,11 +63,16 @@ export interface IIdentityConnector extends IComponent {
      * @param verificationMethodId The verification method id to use.
      * @param id The id of the credential.
      * @param subject The credential subject to store in the verifiable credential.
-     * @param revocationIndex The bitmap revocation index of the credential, if undefined will not have revocation status.
+     * @param options Additional options for creating the verifiable credential.
+     * @param options.revocationIndex The bitmap revocation index of the credential, if undefined will not have revocation status.
+     * @param options.expirationDate The date the verifiable credential is valid until.
      * @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, subject: IJsonLdNodeObject, revocationIndex?: number): Promise<{
+    createVerifiableCredential(controller: string, verificationMethodId: string, id: string | undefined, subject: IJsonLdNodeObject, options?: {
+        revocationIndex?: number;
+        expirationDate?: Date;
+    }): Promise<{
         verifiableCredential: IDidVerifiableCredential;
         jwt: string;
     }>;

package/dist/types/models/api/identity/IIdentityVerifiableCredentialCreateRequest.d.ts

@@ -32,5 +32,9 @@ export interface IIdentityVerifiableCredentialCreateRequest {
          * The bitmap revocation index of the credential, if undefined will not have revocation status.
          */
         revocationIndex?: number;
+        /**
+         * The date the verifiable credential is valid until.
+         */
+        expirationDate?: string;
     };
 }

package/docs/changelog.md

@@ -1,5 +1,12 @@
 # @twin.org/identity-service-models - Changelog
 
+## [0.0.2-next.4](https://github.com/twinfoundation/identity/compare/identity-models-v0.0.2-next.3...identity-models-v0.0.2-next.4) (2025-09-12)
+
+
+### Features
+
+* add expiration date option to vc creation ([73e05e1](https://github.com/twinfoundation/identity/commit/73e05e1ae61112c7e056889969751f4ff82d9f29))
+
 ## [0.0.2-next.3](https://github.com/twinfoundation/identity/compare/identity-models-v0.0.2-next.2...identity-models-v0.0.2-next.3) (2025-08-29)
 
 

package/docs/reference/interfaces/IIdentityComponent.md

@@ -232,7 +232,7 @@ NotFoundError if the id can not be resolved.
 
 ### verifiableCredentialCreate()
 
-> **verifiableCredentialCreate**(`verificationMethodId`, `id`, `subject`, `revocationIndex?`, `controller?`): `Promise`\<\{ `verifiableCredential`: `IDidVerifiableCredential`; `jwt`: `string`; \}\>
+> **verifiableCredentialCreate**(`verificationMethodId`, `id`, `subject`, `options?`, `controller?`): `Promise`\<\{ `verifiableCredential`: `IDidVerifiableCredential`; `jwt`: `string`; \}\>
 
 Create a verifiable credential for a verification method.
 
@@ -256,12 +256,22 @@ The id of the credential.
 
 The credential subject to store in the verifiable credential.
 
-##### revocationIndex?
+##### options?
+
+Additional options for creating the verifiable credential.
+
+###### revocationIndex?
 
 `number`
 
 The bitmap revocation index of the credential, if undefined will not have revocation status.
 
+###### expirationDate?
+
+`Date`
+
+The date the verifiable credential is valid until.
+
 ##### controller?
 
 `string`

package/docs/reference/interfaces/IIdentityConnector.md

@@ -226,7 +226,7 @@ NotFoundError if the id can not be resolved.
 
 ### createVerifiableCredential()
 
-> **createVerifiableCredential**(`controller`, `verificationMethodId`, `id`, `subject`, `revocationIndex?`): `Promise`\<\{ `verifiableCredential`: `IDidVerifiableCredential`; `jwt`: `string`; \}\>
+> **createVerifiableCredential**(`controller`, `verificationMethodId`, `id`, `subject`, `options?`): `Promise`\<\{ `verifiableCredential`: `IDidVerifiableCredential`; `jwt`: `string`; \}\>
 
 Create a verifiable credential for a verification method.
 
@@ -256,12 +256,22 @@ The id of the credential.
 
 The credential subject to store in the verifiable credential.
 
-##### revocationIndex?
+##### options?
+
+Additional options for creating the verifiable credential.
+
+###### revocationIndex?
 
 `number`
 
 The bitmap revocation index of the credential, if undefined will not have revocation status.
 
+###### expirationDate?
+
+`Date`
+
+The date the verifiable credential is valid until.
+
 #### Returns
 
 `Promise`\<\{ `verifiableCredential`: `IDidVerifiableCredential`; `jwt`: `string`; \}\>

package/docs/reference/interfaces/IIdentityVerifiableCredentialCreateRequest.md

@@ -47,3 +47,9 @@ The credential subject to store in the verifiable credential.
 > `optional` **revocationIndex**: `number`
 
 The bitmap revocation index of the credential, if undefined will not have revocation status.
+
+#### expirationDate?
+
+> `optional` **expirationDate**: `string`
+
+The date the verifiable credential is valid until.

package/package.json

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