@twin.org/identity-rest-client 0.0.2-next.3 → 0.0.2-next.5

package/dist/cjs/index.cjs

@@ -146,15 +146,17 @@ class IdentityClient extends apiCore.BaseRestClient {
      * @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.
      */
-    async verifiableCredentialCreate(verificationMethodId, id, subject, revocationIndex) {
+    async verifiableCredentialCreate(verificationMethodId, id, subject, options) {
         core.Guards.stringValue(this.CLASS_NAME, "verificationMethodId", verificationMethodId);
         core.Guards.object(this.CLASS_NAME, "subject", subject);
-        if (!core.Is.undefined(revocationIndex)) {
-            core.Guards.number(this.CLASS_NAME, "revocationIndex", revocationIndex);
+        if (!core.Is.undefined(options?.revocationIndex)) {
+            core.Guards.number(this.CLASS_NAME, "options.revocationIndex", options?.revocationIndex);
         }
         const idParts = identityModels.DocumentHelper.parseId(verificationMethodId);
         const response = await this.fetch("/:identity/verifiable-credential", "POST", {
@@ -165,7 +167,8 @@ class IdentityClient extends apiCore.BaseRestClient {
             body: {
                 credentialId: id,
                 subject,
-                revocationIndex
+                revocationIndex: options?.revocationIndex,
+                expirationDate: options?.expirationDate?.toISOString()
             }
         });
         return response.body;

package/dist/esm/index.mjs

@@ -144,15 +144,17 @@ class IdentityClient extends BaseRestClient {
      * @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.
      */
-    async verifiableCredentialCreate(verificationMethodId, id, subject, revocationIndex) {
+    async verifiableCredentialCreate(verificationMethodId, id, subject, options) {
         Guards.stringValue(this.CLASS_NAME, "verificationMethodId", verificationMethodId);
         Guards.object(this.CLASS_NAME, "subject", subject);
-        if (!Is.undefined(revocationIndex)) {
-            Guards.number(this.CLASS_NAME, "revocationIndex", revocationIndex);
+        if (!Is.undefined(options?.revocationIndex)) {
+            Guards.number(this.CLASS_NAME, "options.revocationIndex", options?.revocationIndex);
         }
         const idParts = DocumentHelper.parseId(verificationMethodId);
         const response = await this.fetch("/:identity/verifiable-credential", "POST", {
@@ -163,7 +165,8 @@ class IdentityClient extends BaseRestClient {
             body: {
                 credentialId: id,
                 subject,
-                revocationIndex
+                revocationIndex: options?.revocationIndex,
+                expirationDate: options?.expirationDate?.toISOString()
             }
         });
         return response.body;

package/dist/types/identityClient.d.ts

@@ -68,11 +68,16 @@ export declare class IdentityClient extends BaseRestClient implements IIdentityC
      * @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.
      */
-    verifiableCredentialCreate(verificationMethodId: string, id: string | undefined, subject: IJsonLdNodeObject, revocationIndex?: number): Promise<{
+    verifiableCredentialCreate(verificationMethodId: string, id: string | undefined, subject: IJsonLdNodeObject, options?: {
+        revocationIndex?: number;
+        expirationDate?: Date;
+    }): Promise<{
         verifiableCredential: IDidVerifiableCredential;
         jwt: string;
     }>;

package/docs/changelog.md

@@ -1,5 +1,33 @@
 # @twin.org/identity-rest-client - Changelog
 
+## [0.0.2-next.5](https://github.com/twinfoundation/identity/compare/identity-rest-client-v0.0.2-next.4...identity-rest-client-v0.0.2-next.5) (2025-09-15)
+
+
+### Miscellaneous Chores
+
+* **identity-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/identity-models bumped from 0.0.2-next.4 to 0.0.2-next.5
+
+## [0.0.2-next.4](https://github.com/twinfoundation/identity/compare/identity-rest-client-v0.0.2-next.3...identity-rest-client-v0.0.2-next.4) (2025-09-12)
+
+
+### Features
+
+* add expiration date option to vc creation ([73e05e1](https://github.com/twinfoundation/identity/commit/73e05e1ae61112c7e056889969751f4ff82d9f29))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/identity-models bumped from 0.0.2-next.3 to 0.0.2-next.4
+
 ## [0.0.2-next.3](https://github.com/twinfoundation/identity/compare/identity-rest-client-v0.0.2-next.2...identity-rest-client-v0.0.2-next.3) (2025-08-29)
 
 

package/docs/reference/classes/IdentityClient.md

@@ -260,7 +260,7 @@ NotFoundError if the id can not be resolved.
 
 ### verifiableCredentialCreate()
 
-> **verifiableCredentialCreate**(`verificationMethodId`, `id`, `subject`, `revocationIndex?`): `Promise`\<\{ `verifiableCredential`: `IDidVerifiableCredential`; `jwt`: `string`; \}\>
+> **verifiableCredentialCreate**(`verificationMethodId`, `id`, `subject`, `options?`): `Promise`\<\{ `verifiableCredential`: `IDidVerifiableCredential`; `jwt`: `string`; \}\>
 
 Create a verifiable credential for a verification method.
 
@@ -284,12 +284,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/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/identity-rest-client",
-	"version": "0.0.2-next.3",
+	"version": "0.0.2-next.5",
 	"description": "Identity contract implementation which can connect to REST endpoints",
 	"repository": {
 		"type": "git",
@@ -20,7 +20,7 @@
 		"@twin.org/data-core": "next",
 		"@twin.org/data-json-ld": "next",
 		"@twin.org/entity": "next",
-		"@twin.org/identity-models": "0.0.2-next.3",
+		"@twin.org/identity-models": "0.0.2-next.5",
 		"@twin.org/nameof": "next",
 		"@twin.org/standards-w3c-did": "next"
 	},