@twin.org/identity-rest-client 0.0.2-next.9 → 0.0.3-next.1

package/dist/es/identityProfileRestClient.js

@@ -0,0 +1,125 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { BaseRestClient } from "@twin.org/api-core";
+import { HttpParameterHelper } from "@twin.org/api-models";
+import { Coerce, Guards } from "@twin.org/core";
+/**
+ * Client for performing identity through to REST endpoints.
+ */
+export class IdentityProfileRestClient extends BaseRestClient {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "IdentityProfileRestClient";
+    /**
+     * Create a new instance of IdentityProfileRestClient.
+     * @param config The configuration for the client.
+     */
+    constructor(config) {
+        super("IdentityProfileRestClient", config, "identity/profile");
+    }
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return IdentityProfileRestClient.CLASS_NAME;
+    }
+    /**
+     * Create the profile properties for an identity.
+     * @param publicProfile The public profile data as JSON-LD.
+     * @param privateProfile The private profile data as JSON-LD.
+     * @returns Nothing.
+     */
+    async create(publicProfile, privateProfile) {
+        await this.fetch("", "POST", {
+            body: {
+                publicProfile,
+                privateProfile
+            }
+        });
+    }
+    /**
+     * Get the profile properties for an identity.
+     * @param publicPropertyNames The public properties to get for the profile, defaults to all.
+     * @param privatePropertyNames The private properties to get for the profile, defaults to all.
+     * @returns The identity and the items properties.
+     */
+    async get(publicPropertyNames, privatePropertyNames) {
+        const response = await this.fetch("/", "GET", {
+            query: {
+                publicPropertyNames: HttpParameterHelper.arrayToString(publicPropertyNames),
+                privatePropertyNames: HttpParameterHelper.arrayToString(privatePropertyNames)
+            }
+        });
+        return {
+            identity: response.body.identity,
+            publicProfile: response.body.publicProfile,
+            privateProfile: response.body.privateProfile
+        };
+    }
+    /**
+     * Get the public profile properties for an identity.
+     * @param identity The identity to perform the profile operation on.
+     * @param propertyNames The public properties to get for the profile, defaults to all.
+     * @returns The items properties.
+     */
+    async getPublic(identity, propertyNames) {
+        Guards.string(IdentityProfileRestClient.CLASS_NAME, "identity", identity);
+        const response = await this.fetch("/:identity/public", "GET", {
+            pathParams: {
+                identity
+            },
+            query: {
+                propertyNames: HttpParameterHelper.arrayToString(propertyNames)
+            }
+        });
+        return response.body;
+    }
+    /**
+     * Update the profile properties of an identity.
+     * @param publicProfile The public profile data as JSON-LD.
+     * @param privateProfile The private profile data as JSON-LD.
+     * @returns Nothing.
+     */
+    async update(publicProfile, privateProfile) {
+        await this.fetch("/", "PUT", {
+            body: {
+                publicProfile,
+                privateProfile
+            }
+        });
+    }
+    /**
+     * Delete the profile for an identity.
+     * @returns Nothing.
+     */
+    async remove() {
+        await this.fetch("/", "DELETE");
+    }
+    /**
+     * Get a list of the requested identities.
+     * @param publicFilters The filters to apply to the identities public profiles.
+     * @param publicPropertyNames The public properties to get for the profile, defaults to all.
+     * @param cursor The cursor for paged requests.
+     * @param limit The maximum number of items in a page.
+     * @returns The list of items and cursor for paging.
+     */
+    async list(publicFilters, publicPropertyNames, cursor, limit) {
+        const response = await this.fetch("/query", "GET", {
+            query: {
+                publicFilters: HttpParameterHelper.arrayToString(
+                // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
+                publicFilters?.map(f => `${f.propertyName}:${f.propertyValue}`)),
+                publicPropertyNames: HttpParameterHelper.arrayToString(publicPropertyNames),
+                cursor,
+                limit: Coerce.string(limit)
+            }
+        });
+        return {
+            items: response.body.items,
+            cursor: response.body.cursor
+        };
+    }
+}
+//# sourceMappingURL=identityProfileRestClient.js.map

package/dist/es/identityProfileRestClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"identityProfileRestClient.js","sourceRoot":"","sources":["../../src/identityProfileRestClient.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AACpD,OAAO,EAAE,mBAAmB,EAA8B,MAAM,sBAAsB,CAAC;AACvF,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAehD;;GAEG;AACH,MAAM,OAAO,yBAIZ,SAAQ,cAAc;IAGtB;;OAEG;IACI,MAAM,CAAU,UAAU,+BAA+C;IAEhF;;;OAGG;IACH,YAAY,MAA6B;QACxC,KAAK,8BAAsC,MAAM,EAAE,kBAAkB,CAAC,CAAC;IACxE,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,yBAAyB,CAAC,UAAU,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAC,aAAiB,EAAE,cAAkB;QACxD,MAAM,IAAI,CAAC,KAAK,CAAuC,EAAE,EAAE,MAAM,EAAE;YAClE,IAAI,EAAE;gBACL,aAAa;gBACb,cAAc;aACd;SACD,CAAC,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,GAAG,CACf,mBAAiC,EACjC,oBAAkC;QAMlC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAChC,GAAG,EACH,KAAK,EACL;YACC,KAAK,EAAE;gBACN,mBAAmB,EAAE,mBAAmB,CAAC,aAAa,CAAC,mBAAmB,CAAC;gBAC3E,oBAAoB,EAAE,mBAAmB,CAAC,aAAa,CAAC,oBAAoB,CAAC;aAC7E;SACD,CACD,CAAC;QAEF,OAAO;YACN,QAAQ,EAAE,QAAQ,CAAC,IAAI,CAAC,QAAQ;YAChC,aAAa,EAAE,QAAQ,CAAC,IAAI,CAAC,aAAkB;YAC/C,cAAc,EAAE,QAAQ,CAAC,IAAI,CAAC,cAAmB;SACjD,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,SAAS,CAAC,QAAgB,EAAE,aAA2B;QACnE,MAAM,CAAC,MAAM,CAAC,yBAAyB,CAAC,UAAU,cAAoB,QAAQ,CAAC,CAAC;QAEhF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAG/B,mBAAmB,EAAE,KAAK,EAAE;YAC7B,UAAU,EAAE;gBACX,QAAQ;aACR;YACD,KAAK,EAAE;gBACN,aAAa,EAAE,mBAAmB,CAAC,aAAa,CAAC,aAAa,CAAC;aAC/D;SACD,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC,IAAkB,CAAC;IACpC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAC,aAAiB,EAAE,cAAkB;QACxD,MAAM,IAAI,CAAC,KAAK,CAAuC,GAAG,EAAE,KAAK,EAAE;YAClE,IAAI,EAAE;gBACL,aAAa;gBACb,cAAc;aACd;SACD,CAAC,CAAC;IACJ,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,MAAM;QAClB,MAAM,IAAI,CAAC,KAAK,CAAe,GAAG,EAAE,QAAQ,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,IAAI,CAChB,aAGG,EACH,mBAAiC,EACjC,MAAe,EACf,KAAc;QAcd,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAChC,QAAQ,EACR,KAAK,EACL;YACC,KAAK,EAAE;gBACN,aAAa,EAAE,mBAAmB,CAAC,aAAa;gBAC/C,4EAA4E;gBAC5E,aAAa,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,YAAY,IAAI,CAAC,CAAC,aAAa,EAAE,CAAC,CAC/D;gBACD,mBAAmB,EAAE,mBAAmB,CAAC,aAAa,CAAC,mBAAmB,CAAC;gBAC3E,MAAM;gBACN,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC;aAC3B;SACD,CACD,CAAC;QACF,OAAO;YACN,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,KAGlB;YACH,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC,MAAM;SAC5B,CAAC;IACH,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { BaseRestClient } from \"@twin.org/api-core\";\nimport { HttpParameterHelper, type IBaseRestClientConfig } from \"@twin.org/api-models\";\nimport { Coerce, Guards } from \"@twin.org/core\";\nimport type { IJsonLdDocument } from \"@twin.org/data-json-ld\";\nimport type {\n\tIIdentityProfileComponent,\n\tIIdentityProfileCreateRequest,\n\tIIdentityProfileGetPublicRequest,\n\tIIdentityProfileGetPublicResponse,\n\tIIdentityProfileGetRequest,\n\tIIdentityProfileGetResponse,\n\tIIdentityProfileListRequest,\n\tIIdentityProfileListResponse,\n\tIIdentityProfileUpdateRequest\n} from \"@twin.org/identity-models\";\nimport { nameof } from \"@twin.org/nameof\";\n\n/**\n * Client for performing identity through to REST endpoints.\n */\nexport class IdentityProfileRestClient<\n\t\tT extends IJsonLdDocument = IJsonLdDocument,\n\t\tU extends IJsonLdDocument = IJsonLdDocument\n\t>\n\textends BaseRestClient\n\timplements IIdentityProfileComponent<T, U>\n{\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<IdentityProfileRestClient>();\n\n\t/**\n\t * Create a new instance of IdentityProfileRestClient.\n\t * @param config The configuration for the client.\n\t */\n\tconstructor(config: IBaseRestClientConfig) {\n\t\tsuper(nameof<IdentityProfileRestClient>(), config, \"identity/profile\");\n\t}\n\n\t/**\n\t * Returns the class name of the component.\n\t * @returns The class name of the component.\n\t */\n\tpublic className(): string {\n\t\treturn IdentityProfileRestClient.CLASS_NAME;\n\t}\n\n\t/**\n\t * Create the profile properties for an identity.\n\t * @param publicProfile The public profile data as JSON-LD.\n\t * @param privateProfile The private profile data as JSON-LD.\n\t * @returns Nothing.\n\t */\n\tpublic async create(publicProfile?: T, privateProfile?: U): Promise<void> {\n\t\tawait this.fetch<IIdentityProfileCreateRequest, never>(\"\", \"POST\", {\n\t\t\tbody: {\n\t\t\t\tpublicProfile,\n\t\t\t\tprivateProfile\n\t\t\t}\n\t\t});\n\t}\n\n\t/**\n\t * Get the profile properties for an identity.\n\t * @param publicPropertyNames The public properties to get for the profile, defaults to all.\n\t * @param privatePropertyNames The private properties to get for the profile, defaults to all.\n\t * @returns The identity and the items properties.\n\t */\n\tpublic async get(\n\t\tpublicPropertyNames?: (keyof T)[],\n\t\tprivatePropertyNames?: (keyof U)[]\n\t): Promise<{\n\t\tidentity: string;\n\t\tpublicProfile?: Partial<T>;\n\t\tprivateProfile?: Partial<U>;\n\t}> {\n\t\tconst response = await this.fetch<IIdentityProfileGetRequest, IIdentityProfileGetResponse>(\n\t\t\t\"/\",\n\t\t\t\"GET\",\n\t\t\t{\n\t\t\t\tquery: {\n\t\t\t\t\tpublicPropertyNames: HttpParameterHelper.arrayToString(publicPropertyNames),\n\t\t\t\t\tprivatePropertyNames: HttpParameterHelper.arrayToString(privatePropertyNames)\n\t\t\t\t}\n\t\t\t}\n\t\t);\n\n\t\treturn {\n\t\t\tidentity: response.body.identity,\n\t\t\tpublicProfile: response.body.publicProfile as T,\n\t\t\tprivateProfile: response.body.privateProfile as U\n\t\t};\n\t}\n\n\t/**\n\t * Get the public profile properties for an identity.\n\t * @param identity The identity to perform the profile operation on.\n\t * @param propertyNames The public properties to get for the profile, defaults to all.\n\t * @returns The items properties.\n\t */\n\tpublic async getPublic(identity: string, propertyNames?: (keyof T)[]): Promise<Partial<T>> {\n\t\tGuards.string(IdentityProfileRestClient.CLASS_NAME, nameof(identity), identity);\n\n\t\tconst response = await this.fetch<\n\t\t\tIIdentityProfileGetPublicRequest,\n\t\t\tIIdentityProfileGetPublicResponse\n\t\t>(\"/:identity/public\", \"GET\", {\n\t\t\tpathParams: {\n\t\t\t\tidentity\n\t\t\t},\n\t\t\tquery: {\n\t\t\t\tpropertyNames: HttpParameterHelper.arrayToString(propertyNames)\n\t\t\t}\n\t\t});\n\n\t\treturn response.body as Partial<T>;\n\t}\n\n\t/**\n\t * Update the profile properties of an identity.\n\t * @param publicProfile The public profile data as JSON-LD.\n\t * @param privateProfile The private profile data as JSON-LD.\n\t * @returns Nothing.\n\t */\n\tpublic async update(publicProfile?: T, privateProfile?: U): Promise<void> {\n\t\tawait this.fetch<IIdentityProfileUpdateRequest, never>(\"/\", \"PUT\", {\n\t\t\tbody: {\n\t\t\t\tpublicProfile,\n\t\t\t\tprivateProfile\n\t\t\t}\n\t\t});\n\t}\n\n\t/**\n\t * Delete the profile for an identity.\n\t * @returns Nothing.\n\t */\n\tpublic async remove(): Promise<void> {\n\t\tawait this.fetch<never, never>(\"/\", \"DELETE\");\n\t}\n\n\t/**\n\t * Get a list of the requested identities.\n\t * @param publicFilters The filters to apply to the identities public profiles.\n\t * @param publicPropertyNames The public properties to get for the profile, defaults to all.\n\t * @param cursor The cursor for paged requests.\n\t * @param limit The maximum number of items in a page.\n\t * @returns The list of items and cursor for paging.\n\t */\n\tpublic async list(\n\t\tpublicFilters?: {\n\t\t\tpropertyName: string;\n\t\t\tpropertyValue: unknown;\n\t\t}[],\n\t\tpublicPropertyNames?: (keyof T)[],\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<{\n\t\t/**\n\t\t * The identities.\n\t\t */\n\t\titems: {\n\t\t\tidentity: string;\n\t\t\tpublicProfile?: Partial<T>;\n\t\t}[];\n\t\t/**\n\t\t * An optional cursor, when defined can be used to call find to get more entities.\n\t\t */\n\t\tcursor?: string;\n\t}> {\n\t\tconst response = await this.fetch<IIdentityProfileListRequest, IIdentityProfileListResponse>(\n\t\t\t\"/query\",\n\t\t\t\"GET\",\n\t\t\t{\n\t\t\t\tquery: {\n\t\t\t\t\tpublicFilters: HttpParameterHelper.arrayToString(\n\t\t\t\t\t\t// eslint-disable-next-line @typescript-eslint/restrict-template-expressions\n\t\t\t\t\t\tpublicFilters?.map(f => `${f.propertyName}:${f.propertyValue}`)\n\t\t\t\t\t),\n\t\t\t\t\tpublicPropertyNames: HttpParameterHelper.arrayToString(publicPropertyNames),\n\t\t\t\t\tcursor,\n\t\t\t\t\tlimit: Coerce.string(limit)\n\t\t\t\t}\n\t\t\t}\n\t\t);\n\t\treturn {\n\t\t\titems: response.body.items as {\n\t\t\t\tidentity: string;\n\t\t\t\tpublicProfile?: Partial<T>;\n\t\t\t}[],\n\t\t\tcursor: response.body.cursor\n\t\t};\n\t}\n}\n"]}

package/dist/es/identityResolverRestClient.js

@@ -0,0 +1,42 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { BaseRestClient } from "@twin.org/api-core";
+import { Urn } from "@twin.org/core";
+/**
+ * Client for performing identity through to REST endpoints.
+ */
+export class IdentityResolverRestClient extends BaseRestClient {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "IdentityResolverRestClient";
+    /**
+     * Create a new instance of IdentityResolverRestClient.
+     * @param config The configuration for the client.
+     */
+    constructor(config) {
+        super("IdentityResolverRestClient", config, "identity");
+    }
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return IdentityResolverRestClient.CLASS_NAME;
+    }
+    /**
+     * Resolve an identity.
+     * @param documentId The id of the document to resolve.
+     * @returns The resolved document.
+     */
+    async identityResolve(documentId) {
+        Urn.guard(IdentityResolverRestClient.CLASS_NAME, "documentId", documentId);
+        const response = await this.fetch("/:identity", "GET", {
+            pathParams: {
+                identity: documentId
+            }
+        });
+        return response.body;
+    }
+}
+//# sourceMappingURL=identityResolverRestClient.js.map

package/dist/es/identityResolverRestClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"identityResolverRestClient.js","sourceRoot":"","sources":["../../src/identityResolverRestClient.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEpD,OAAO,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AASrC;;GAEG;AACH,MAAM,OAAO,0BACZ,SAAQ,cAAc;IAGtB;;OAEG;IACI,MAAM,CAAU,UAAU,gCAAgD;IAEjF;;;OAGG;IACH,YAAY,MAA6B;QACxC,KAAK,+BAAuC,MAAM,EAAE,UAAU,CAAC,CAAC;IACjE,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,0BAA0B,CAAC,UAAU,CAAC;IAC9C,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,eAAe,CAAC,UAAkB;QAC9C,GAAG,CAAC,KAAK,CAAC,0BAA0B,CAAC,UAAU,gBAAsB,UAAU,CAAC,CAAC;QAEjF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAChC,YAAY,EACZ,KAAK,EACL;YACC,UAAU,EAAE;gBACX,QAAQ,EAAE,UAAU;aACpB;SACD,CACD,CAAC;QAEF,OAAO,QAAQ,CAAC,IAAI,CAAC;IACtB,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { BaseRestClient } from \"@twin.org/api-core\";\nimport type { IBaseRestClientConfig } from \"@twin.org/api-models\";\nimport { Urn } from \"@twin.org/core\";\nimport type {\n\tIIdentityResolverComponent,\n\tIIdentityResolveRequest,\n\tIIdentityResolveResponse\n} from \"@twin.org/identity-models\";\nimport { nameof } from \"@twin.org/nameof\";\nimport type { IDidDocument } from \"@twin.org/standards-w3c-did\";\n\n/**\n * Client for performing identity through to REST endpoints.\n */\nexport class IdentityResolverRestClient\n\textends BaseRestClient\n\timplements IIdentityResolverComponent\n{\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<IdentityResolverRestClient>();\n\n\t/**\n\t * Create a new instance of IdentityResolverRestClient.\n\t * @param config The configuration for the client.\n\t */\n\tconstructor(config: IBaseRestClientConfig) {\n\t\tsuper(nameof<IdentityResolverRestClient>(), config, \"identity\");\n\t}\n\n\t/**\n\t * Returns the class name of the component.\n\t * @returns The class name of the component.\n\t */\n\tpublic className(): string {\n\t\treturn IdentityResolverRestClient.CLASS_NAME;\n\t}\n\n\t/**\n\t * Resolve an identity.\n\t * @param documentId The id of the document to resolve.\n\t * @returns The resolved document.\n\t */\n\tpublic async identityResolve(documentId: string): Promise<IDidDocument> {\n\t\tUrn.guard(IdentityResolverRestClient.CLASS_NAME, nameof(documentId), documentId);\n\n\t\tconst response = await this.fetch<IIdentityResolveRequest, IIdentityResolveResponse>(\n\t\t\t\"/:identity\",\n\t\t\t\"GET\",\n\t\t\t{\n\t\t\t\tpathParams: {\n\t\t\t\t\tidentity: documentId\n\t\t\t\t}\n\t\t\t}\n\t\t);\n\n\t\treturn response.body;\n\t}\n}\n"]}

package/dist/{esm/index.mjs → es/identityRestClient.js}

@@ -1,26 +1,31 @@
-import { BaseRestClient } from '@twin.org/api-core';
-import { Guards, Is, Coerce, Urn } from '@twin.org/core';
-import { DocumentHelper } from '@twin.org/identity-models';
-import { DidVerificationMethodType, ProofTypes } from '@twin.org/standards-w3c-did';
-import { HttpParameterHelper } from '@twin.org/api-models';
-
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
+import { BaseRestClient } from "@twin.org/api-core";
+import { Guards, Is } from "@twin.org/core";
+import { DocumentHelper } from "@twin.org/identity-models";
+import { DidVerificationMethodType, ProofTypes } from "@twin.org/standards-w3c-did";
 /**
  * Client for performing identity through to REST endpoints.
  */
-class IdentityRestClient extends BaseRestClient {
+export class IdentityRestClient extends BaseRestClient {
     /**
      * Runtime name for the class.
      */
     static CLASS_NAME = "IdentityRestClient";
     /**
-     * Create a new instance of IdentityClient.
+     * Create a new instance of IdentityRestClient.
      * @param config The configuration for the client.
      */
     constructor(config) {
         super("IdentityRestClient", config, "identity");
     }
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return IdentityRestClient.CLASS_NAME;
+    }
     /**
      * Create a new identity.
      * @param namespace The namespace of the connector to use for the identity, defaults to service configured namespace.
@@ -313,153 +318,4 @@ class IdentityRestClient extends BaseRestClient {
         return response.body.verified;
     }
 }
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Client for performing identity through to REST endpoints.
- */
-class IdentityProfileRestClient extends BaseRestClient {
-    /**
-     * Runtime name for the class.
-     */
-    static CLASS_NAME = "IdentityProfileRestClient";
-    /**
-     * Create a new instance of IdentityClient.
-     * @param config The configuration for the client.
-     */
-    constructor(config) {
-        super("IdentityProfileRestClient", config, "identity/profile");
-    }
-    /**
-     * Create the profile properties for an identity.
-     * @param publicProfile The public profile data as JSON-LD.
-     * @param privateProfile The private profile data as JSON-LD.
-     * @returns Nothing.
-     */
-    async create(publicProfile, privateProfile) {
-        await this.fetch("", "POST", {
-            body: {
-                publicProfile,
-                privateProfile
-            }
-        });
-    }
-    /**
-     * Get the profile properties for an identity.
-     * @param publicPropertyNames The public properties to get for the profile, defaults to all.
-     * @param privatePropertyNames The private properties to get for the profile, defaults to all.
-     * @returns The identity and the items properties.
-     */
-    async get(publicPropertyNames, privatePropertyNames) {
-        const response = await this.fetch("/", "GET", {
-            query: {
-                publicPropertyNames: HttpParameterHelper.arrayToString(publicPropertyNames),
-                privatePropertyNames: HttpParameterHelper.arrayToString(privatePropertyNames)
-            }
-        });
-        return {
-            identity: response.body.identity,
-            publicProfile: response.body.publicProfile,
-            privateProfile: response.body.privateProfile
-        };
-    }
-    /**
-     * Get the public profile properties for an identity.
-     * @param identity The identity to perform the profile operation on.
-     * @param propertyNames The public properties to get for the profile, defaults to all.
-     * @returns The items properties.
-     */
-    async getPublic(identity, propertyNames) {
-        Guards.string(IdentityProfileRestClient.CLASS_NAME, "identity", identity);
-        const response = await this.fetch("/:identity/public", "GET", {
-            pathParams: {
-                identity
-            },
-            query: {
-                propertyNames: HttpParameterHelper.arrayToString(propertyNames)
-            }
-        });
-        return response.body;
-    }
-    /**
-     * Update the profile properties of an identity.
-     * @param publicProfile The public profile data as JSON-LD.
-     * @param privateProfile The private profile data as JSON-LD.
-     * @returns Nothing.
-     */
-    async update(publicProfile, privateProfile) {
-        await this.fetch("/", "PUT", {
-            body: {
-                publicProfile,
-                privateProfile
-            }
-        });
-    }
-    /**
-     * Delete the profile for an identity.
-     * @returns Nothing.
-     */
-    async remove() {
-        await this.fetch("/", "DELETE");
-    }
-    /**
-     * Get a list of the requested identities.
-     * @param publicFilters The filters to apply to the identities public profiles.
-     * @param publicPropertyNames The public properties to get for the profile, defaults to all.
-     * @param cursor The cursor for paged requests.
-     * @param limit The maximum number of items in a page.
-     * @returns The list of items and cursor for paging.
-     */
-    async list(publicFilters, publicPropertyNames, cursor, limit) {
-        const response = await this.fetch("/query", "GET", {
-            query: {
-                publicFilters: HttpParameterHelper.arrayToString(
-                // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
-                publicFilters?.map(f => `${f.propertyName}:${f.propertyValue}`)),
-                publicPropertyNames: HttpParameterHelper.arrayToString(publicPropertyNames),
-                cursor,
-                limit: Coerce.string(limit)
-            }
-        });
-        return {
-            items: response.body.items,
-            cursor: response.body.cursor
-        };
-    }
-}
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Client for performing identity through to REST endpoints.
- */
-class IdentityResolverRestClient extends BaseRestClient {
-    /**
-     * Runtime name for the class.
-     */
-    static CLASS_NAME = "IdentityResolverRestClient";
-    /**
-     * Create a new instance of IdentityClient.
-     * @param config The configuration for the client.
-     */
-    constructor(config) {
-        super("IdentityResolverRestClient", config, "identity");
-    }
-    /**
-     * Resolve an identity.
-     * @param documentId The id of the document to resolve.
-     * @returns The resolved document.
-     */
-    async identityResolve(documentId) {
-        Urn.guard(IdentityResolverRestClient.CLASS_NAME, "documentId", documentId);
-        const response = await this.fetch("/:identity", "GET", {
-            pathParams: {
-                identity: documentId
-            }
-        });
-        return response.body;
-    }
-}
-
-export { IdentityProfileRestClient, IdentityResolverRestClient, IdentityRestClient };
+//# sourceMappingURL=identityRestClient.js.map

package/dist/es/identityRestClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"identityRestClient.js","sourceRoot":"","sources":["../../src/identityRestClient.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEpD,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAC;AAE5C,OAAO,EACN,cAAc,EAyBd,MAAM,2BAA2B,CAAC;AAEnC,OAAO,EACN,yBAAyB,EAOzB,UAAU,EACV,MAAM,6BAA6B,CAAC;AAErC;;GAEG;AACH,MAAM,OAAO,kBAAmB,SAAQ,cAAc;IACrD;;OAEG;IACI,MAAM,CAAU,UAAU,wBAAwC;IAEzE;;;OAGG;IACH,YAAY,MAA6B;QACxC,KAAK,uBAA+B,MAAM,EAAE,UAAU,CAAC,CAAC;IACzD,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,kBAAkB,CAAC,UAAU,CAAC;IACtC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,cAAc,CAAC,SAAkB;QAC7C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAChC,GAAG,EACH,MAAM,EACN;YACC,IAAI,EAAE;gBACL,SAAS;aACT;SACD,CACD,CAAC;QAEF,OAAO,QAAQ,CAAC,IAAI,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,cAAc,CAAC,QAAgB;QAC3C,MAAM,CAAC,WAAW,CAAC,kBAAkB,CAAC,UAAU,cAAoB,QAAQ,CAAC,CAAC;QAC9E,MAAM,IAAI,CAAC,KAAK,CAA6C,YAAY,EAAE,QAAQ,EAAE;YACpF,UAAU,EAAE;gBACX,QAAQ;aACR;SACD,CAAC,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,wBAAwB,CACpC,QAAgB,EAChB,sBAAiD,EACjD,oBAA6B;QAE7B,MAAM,CAAC,WAAW,CAAC,kBAAkB,CAAC,UAAU,cAAoB,QAAQ,CAAC,CAAC;QAC9E,MAAM,CAAC,UAAU,CAChB,kBAAkB,CAAC,UAAU,4BAE7B,sBAAsB,EACtB,MAAM,CAAC,MAAM,CAAC,yBAAyB,CAAC,CACxC,CAAC;QACF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAG/B,gCAAgC,EAAE,MAAM,EAAE;YAC3C,UAAU,EAAE;gBACX,QAAQ;aACR;YACD,IAAI,EAAE;gBACL,sBAAsB;gBACtB,oBAAoB;aACpB;SACD,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC,IAAI,CAAC;IACtB,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,wBAAwB,CAAC,oBAA4B;QACjE,MAAM,CAAC,WAAW,CACjB,kBAAkB,CAAC,UAAU,0BAE7B,oBAAoB,CACpB,CAAC;QAEF,MAAM,OAAO,GAAG,cAAc,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;QAE7D,MAAM,IAAI,CAAC,KAAK,CACf,sDAAsD,EACtD,QAAQ,EACR;YACC,UAAU,EAAE;gBACX,QAAQ,EAAE,OAAO,CAAC,EAAE;gBACpB,oBAAoB,EAAE,OAAO,CAAC,QAAQ,IAAI,EAAE;aAC5C;SACD,CACD,CAAC;IACH,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,aAAa,CACzB,QAAgB,EAChB,SAAiB,EACjB,WAA8B,EAC9B,eAAkC;QAElC,MAAM,CAAC,WAAW,CAAC,kBAAkB,CAAC,UAAU,cAAoB,QAAQ,CAAC,CAAC;QAC9E,MAAM,CAAC,WAAW,CAAC,kBAAkB,CAAC,UAAU,eAAqB,SAAS,CAAC,CAAC;QAChF,IAAI,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC;YAC3B,MAAM,CAAC,UAAU,CAAS,kBAAkB,CAAC,UAAU,iBAAuB,WAAW,CAAC,CAAC;QAC5F,CAAC;aAAM,CAAC;YACP,MAAM,CAAC,WAAW,CAAC,kBAAkB,CAAC,UAAU,iBAAuB,WAAW,CAAC,CAAC;QACrF,CAAC;QACD,IAAI,EAAE,CAAC,KAAK,CAAC,eAAe,CAAC,EAAE,CAAC;YAC/B,MAAM,CAAC,UAAU,CAChB,kBAAkB,CAAC,UAAU,qBAE7B,eAAe,CACf,CAAC;QACH,CAAC;aAAM,CAAC;YACP,MAAM,CAAC,WAAW,CAAC,kBAAkB,CAAC,UAAU,qBAA2B,eAAe,CAAC,CAAC;QAC7F,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAG/B,oBAAoB,EAAE,MAAM,EAAE;YAC/B,UAAU,EAAE;gBACX,QAAQ;aACR;YACD,IAAI,EAAE;gBACL,SAAS;gBACT,IAAI,EAAE,WAAW;gBACjB,QAAQ,EAAE,eAAe;aACzB;SACD,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC,IAAI,CAAC;IACtB,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,aAAa,CAAC,SAAiB;QAC3C,MAAM,CAAC,WAAW,CAAC,kBAAkB,CAAC,UAAU,eAAqB,SAAS,CAAC,CAAC;QAEhF,MAAM,OAAO,GAAG,cAAc,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAElD,MAAM,IAAI,CAAC,KAAK,CACf,+BAA+B,EAC/B,QAAQ,EACR;YACC,UAAU,EAAE;gBACX,QAAQ,EAAE,OAAO,CAAC,EAAE;gBACpB,SAAS,EAAE,OAAO,CAAC,QAAQ,IAAI,EAAE;aACjC;SACD,CACD,CAAC;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,0BAA0B,CACtC,oBAA4B,EAC5B,EAAsB,EACtB,OAA0B,EAC1B,OAGC;QAKD,MAAM,CAAC,WAAW,CACjB,kBAAkB,CAAC,UAAU,0BAE7B,oBAAoB,CACpB,CAAC;QACF,MAAM,CAAC,MAAM,CAAoB,kBAAkB,CAAC,UAAU,aAAmB,OAAO,CAAC,CAAC;QAC1F,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,OAAO,EAAE,eAAe,CAAC,EAAE,CAAC;YAC7C,MAAM,CAAC,MAAM,CACZ,kBAAkB,CAAC,UAAU,6BAE7B,OAAO,EAAE,eAAe,CACxB,CAAC;QACH,CAAC;QAED,MAAM,OAAO,GAAG,cAAc,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;QAE7D,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAG/B,kCAAkC,EAAE,MAAM,EAAE;YAC7C,UAAU,EAAE;gBACX,QAAQ,EAAE,OAAO,CAAC,EAAE;gBACpB,oBAAoB,EAAE,OAAO,CAAC,QAAQ,IAAI,EAAE;aAC5C;YACD,IAAI,EAAE;gBACL,YAAY,EAAE,EAAE;gBAChB,OAAO;gBACP,eAAe,EAAE,OAAO,EAAE,eAAe;gBACzC,cAAc,EAAE,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE;aACtD;SACD,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC,IAAI,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,0BAA0B,CAAC,aAAqB;QAI5D,MAAM,CAAC,WAAW,CAAC,kBAAkB,CAAC,UAAU,mBAAyB,aAAa,CAAC,CAAC;QAExF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAG/B,+BAA+B,EAAE,MAAM,EAAE;YAC1C,KAAK,EAAE;gBACN,GAAG,EAAE,aAAa;aAClB;SACD,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC,IAAI,CAAC;IACtB,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,0BAA0B,CACtC,QAAgB,EAChB,eAAuB;QAEvB,MAAM,CAAC,WAAW,CAAC,kBAAkB,CAAC,UAAU,cAAoB,QAAQ,CAAC,CAAC;QAC9E,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,UAAU,qBAA2B,eAAe,CAAC,CAAC;QAExF,MAAM,IAAI,CAAC,KAAK,CACf,0DAA0D,EAC1D,KAAK,EACL;YACC,UAAU,EAAE;gBACX,QAAQ,EAAE,QAAQ;gBAClB,eAAe,EAAE,eAAe;aAChC;SACD,CACD,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,4BAA4B,CACxC,QAAgB,EAChB,eAAuB;QAEvB,MAAM,CAAC,WAAW,CAAC,kBAAkB,CAAC,UAAU,cAAoB,QAAQ,CAAC,CAAC;QAC9E,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,UAAU,qBAA2B,eAAe,CAAC,CAAC;QAExF,MAAM,IAAI,CAAC,KAAK,CACf,4DAA4D,EAC5D,KAAK,EACL;YACC,UAAU,EAAE;gBACX,QAAQ,EAAE,QAAQ;gBAClB,eAAe,EAAE,eAAe;aAChC;SACD,CACD,CAAC;IACH,CAAC;IAED;;;;;;;;;;OAUG;IACI,KAAK,CAAC,4BAA4B,CACxC,oBAA4B,EAC5B,cAAkC,EAClC,QAAkD,EAClD,KAAoC,EACpC,qBAA4D,EAC5D,gBAAyB;QAKzB,MAAM,CAAC,WAAW,CACjB,kBAAkB,CAAC,UAAU,0BAE7B,oBAAoB,CACpB,CAAC;QACF,IAAI,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;YACrB,MAAM,CAAC,UAAU,CAAC,kBAAkB,CAAC,UAAU,WAAiB,KAAK,CAAC,CAAC;QACxE,CAAC;aAAM,IAAI,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;YAC7B,MAAM,CAAC,WAAW,CAAC,kBAAkB,CAAC,UAAU,WAAiB,KAAK,CAAC,CAAC;QACzE,CAAC;QACD,MAAM,CAAC,UAAU,CAChB,kBAAkB,CAAC,UAAU,2BAE7B,qBAAqB,CACrB,CAAC;QACF,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,gBAAgB,CAAC,EAAE,CAAC;YACrC,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,UAAU,sBAA4B,gBAAgB,CAAC,CAAC;QAC3F,CAAC;QAED,MAAM,OAAO,GAAG,cAAc,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;QAE7D,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAG/B,oCAAoC,EAAE,MAAM,EAAE;YAC/C,UAAU,EAAE;gBACX,QAAQ,EAAE,OAAO,CAAC,EAAE;gBACpB,oBAAoB,EAAE,OAAO,CAAC,QAAQ,IAAI,EAAE;aAC5C;YACD,IAAI,EAAE;gBACL,cAAc;gBACd,QAAQ;gBACR,KAAK;gBACL,qBAAqB;gBACrB,gBAAgB;aAChB;SACD,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC,IAAI,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,4BAA4B,CAAC,eAAuB;QAKhE,MAAM,CAAC,WAAW,CAAC,kBAAkB,CAAC,UAAU,qBAA2B,eAAe,CAAC,CAAC;QAE5F,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAG/B,iCAAiC,EAAE,MAAM,EAAE;YAC5C,KAAK,EAAE;gBACN,GAAG,EAAE,eAAe;aACpB;SACD,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC,IAAI,CAAC;IACtB,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,WAAW,CACvB,oBAA4B,EAC5B,SAAqB,EACrB,gBAAmC;QAEnC,MAAM,CAAC,WAAW,CACjB,kBAAkB,CAAC,UAAU,0BAE7B,oBAAoB,CACpB,CAAC;QACF,MAAM,CAAC,UAAU,CAChB,kBAAkB,CAAC,UAAU,eAE7B,SAAS,EACT,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CACzB,CAAC;QACF,MAAM,CAAC,MAAM,CACZ,kBAAkB,CAAC,UAAU,sBAE7B,gBAAgB,CAChB,CAAC;QAEF,MAAM,OAAO,GAAG,cAAc,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;QAE7D,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAChC,kBAAkB,EAClB,MAAM,EACN;YACC,UAAU,EAAE;gBACX,QAAQ,EAAE,OAAO,CAAC,EAAE;gBACpB,oBAAoB,EAAE,OAAO,CAAC,QAAQ,IAAI,EAAE;aAC5C;YACD,IAAI,EAAE;gBACL,QAAQ,EAAE,gBAAgB;gBAC1B,SAAS;aACT;SACD,CACD,CAAC;QAEF,OAAO,QAAQ,CAAC,IAAI,CAAC;IACtB,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,WAAW,CAAC,QAA2B,EAAE,KAAa;QAClE,MAAM,CAAC,MAAM,CAAoB,kBAAkB,CAAC,UAAU,cAAoB,QAAQ,CAAC,CAAC;QAC5F,MAAM,CAAC,MAAM,CAAS,kBAAkB,CAAC,UAAU,WAAiB,KAAK,CAAC,CAAC;QAC3E,MAAM,CAAC,WAAW,CACjB,kBAAkB,CAAC,UAAU,8BAE7B,KAAK,CAAC,kBAAkB,CACxB,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAChC,eAAe,EACf,MAAM,EACN;YACC,IAAI,EAAE;gBACL,QAAQ;gBACR,KAAK;aACL;SACD,CACD,CAAC;QAEF,OAAO,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC;IAC/B,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { BaseRestClient } from \"@twin.org/api-core\";\nimport type { IBaseRestClientConfig, INoContentResponse } from \"@twin.org/api-models\";\nimport { Guards, Is } from \"@twin.org/core\";\nimport type { IJsonLdContextDefinitionRoot, IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport {\n\tDocumentHelper,\n\ttype IIdentityRemoveRequest,\n\ttype IIdentityComponent,\n\ttype IIdentityCreateRequest,\n\ttype IIdentityCreateResponse,\n\ttype IIdentityProofCreateRequest,\n\ttype IIdentityProofCreateResponse,\n\ttype IIdentityProofVerifyRequest,\n\ttype IIdentityProofVerifyResponse,\n\ttype IIdentityServiceCreateRequest,\n\ttype IIdentityServiceCreateResponse,\n\ttype IIdentityServiceRemoveRequest,\n\ttype IIdentityVerifiableCredentialCreateRequest,\n\ttype IIdentityVerifiableCredentialCreateResponse,\n\ttype IIdentityVerifiableCredentialRevokeRequest,\n\ttype IIdentityVerifiableCredentialUnrevokeRequest,\n\ttype IIdentityVerifiableCredentialVerifyRequest,\n\ttype IIdentityVerifiableCredentialVerifyResponse,\n\ttype IIdentityVerifiablePresentationCreateRequest,\n\ttype IIdentityVerifiablePresentationCreateResponse,\n\ttype IIdentityVerifiablePresentationVerifyRequest,\n\ttype IIdentityVerifiablePresentationVerifyResponse,\n\ttype IIdentityVerificationMethodCreateRequest,\n\ttype IIdentityVerificationMethodCreateResponse,\n\ttype IIdentityVerificationMethodRemoveRequest\n} from \"@twin.org/identity-models\";\nimport { nameof } from \"@twin.org/nameof\";\nimport {\n\tDidVerificationMethodType,\n\ttype IDidDocument,\n\ttype IDidDocumentVerificationMethod,\n\ttype IDidService,\n\ttype IDidVerifiableCredential,\n\ttype IDidVerifiablePresentation,\n\ttype IProof,\n\tProofTypes\n} from \"@twin.org/standards-w3c-did\";\n\n/**\n * Client for performing identity through to REST endpoints.\n */\nexport class IdentityRestClient extends BaseRestClient implements IIdentityComponent {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<IdentityRestClient>();\n\n\t/**\n\t * Create a new instance of IdentityRestClient.\n\t * @param config The configuration for the client.\n\t */\n\tconstructor(config: IBaseRestClientConfig) {\n\t\tsuper(nameof<IdentityRestClient>(), config, \"identity\");\n\t}\n\n\t/**\n\t * Returns the class name of the component.\n\t * @returns The class name of the component.\n\t */\n\tpublic className(): string {\n\t\treturn IdentityRestClient.CLASS_NAME;\n\t}\n\n\t/**\n\t * Create a new identity.\n\t * @param namespace The namespace of the connector to use for the identity, defaults to service configured namespace.\n\t * @returns The created identity document.\n\t */\n\tpublic async identityCreate(namespace?: string): Promise<IDidDocument> {\n\t\tconst response = await this.fetch<IIdentityCreateRequest, IIdentityCreateResponse>(\n\t\t\t\"/\",\n\t\t\t\"POST\",\n\t\t\t{\n\t\t\t\tbody: {\n\t\t\t\t\tnamespace\n\t\t\t\t}\n\t\t\t}\n\t\t);\n\n\t\treturn response.body;\n\t}\n\n\t/**\n\t * Remove an identity.\n\t * @param identity The id of the document to remove.\n\t * @returns Nothing.\n\t */\n\tpublic async identityRemove(identity: string): Promise<void> {\n\t\tGuards.stringValue(IdentityRestClient.CLASS_NAME, nameof(identity), identity);\n\t\tawait this.fetch<IIdentityRemoveRequest, INoContentResponse>(\"/:identity\", \"DELETE\", {\n\t\t\tpathParams: {\n\t\t\t\tidentity\n\t\t\t}\n\t\t});\n\t}\n\n\t/**\n\t * Add a verification method to the document in JSON Web key Format.\n\t * @param identity The id of the document to add the verification method to.\n\t * @param verificationMethodType The type of the verification method to add.\n\t * @param verificationMethodId The id of the verification method, if undefined uses the kid of the generated JWK.\n\t * @returns The verification method.\n\t * @throws NotFoundError if the id can not be resolved.\n\t * @throws NotSupportedError if the platform does not support multiple keys.\n\t */\n\tpublic async verificationMethodCreate(\n\t\tidentity: string,\n\t\tverificationMethodType: DidVerificationMethodType,\n\t\tverificationMethodId?: string\n\t): Promise<IDidDocumentVerificationMethod> {\n\t\tGuards.stringValue(IdentityRestClient.CLASS_NAME, nameof(identity), identity);\n\t\tGuards.arrayOneOf<DidVerificationMethodType>(\n\t\t\tIdentityRestClient.CLASS_NAME,\n\t\t\tnameof(verificationMethodType),\n\t\t\tverificationMethodType,\n\t\t\tObject.values(DidVerificationMethodType)\n\t\t);\n\t\tconst response = await this.fetch<\n\t\t\tIIdentityVerificationMethodCreateRequest,\n\t\t\tIIdentityVerificationMethodCreateResponse\n\t\t>(\"/:identity/verification-method\", \"POST\", {\n\t\t\tpathParams: {\n\t\t\t\tidentity\n\t\t\t},\n\t\t\tbody: {\n\t\t\t\tverificationMethodType,\n\t\t\t\tverificationMethodId\n\t\t\t}\n\t\t});\n\n\t\treturn response.body;\n\t}\n\n\t/**\n\t * Remove a verification method from the document.\n\t * @param verificationMethodId The id of the verification method.\n\t * @returns Nothing.\n\t * @throws NotFoundError if the id can not be resolved.\n\t * @throws NotSupportedError if the platform does not support multiple revocable keys.\n\t */\n\tpublic async verificationMethodRemove(verificationMethodId: string): Promise<void> {\n\t\tGuards.stringValue(\n\t\t\tIdentityRestClient.CLASS_NAME,\n\t\t\tnameof(verificationMethodId),\n\t\t\tverificationMethodId\n\t\t);\n\n\t\tconst idParts = DocumentHelper.parseId(verificationMethodId);\n\n\t\tawait this.fetch<IIdentityVerificationMethodRemoveRequest, INoContentResponse>(\n\t\t\t\"/:identity/verification-method/:verificationMethodId\",\n\t\t\t\"DELETE\",\n\t\t\t{\n\t\t\t\tpathParams: {\n\t\t\t\t\tidentity: idParts.id,\n\t\t\t\t\tverificationMethodId: idParts.fragment ?? \"\"\n\t\t\t\t}\n\t\t\t}\n\t\t);\n\t}\n\n\t/**\n\t * Add a service to the document.\n\t * @param identity The id of the document to add the service to.\n\t * @param serviceId The id of the service.\n\t * @param serviceType The type of the service.\n\t * @param serviceEndpoint The endpoint for the service.\n\t * @returns The service.\n\t * @throws NotFoundError if the id can not be resolved.\n\t */\n\tpublic async serviceCreate(\n\t\tidentity: string,\n\t\tserviceId: string,\n\t\tserviceType: string | string[],\n\t\tserviceEndpoint: string | string[]\n\t): Promise<IDidService> {\n\t\tGuards.stringValue(IdentityRestClient.CLASS_NAME, nameof(identity), identity);\n\t\tGuards.stringValue(IdentityRestClient.CLASS_NAME, nameof(serviceId), serviceId);\n\t\tif (Is.array(serviceType)) {\n\t\t\tGuards.arrayValue<string>(IdentityRestClient.CLASS_NAME, nameof(serviceType), serviceType);\n\t\t} else {\n\t\t\tGuards.stringValue(IdentityRestClient.CLASS_NAME, nameof(serviceType), serviceType);\n\t\t}\n\t\tif (Is.array(serviceEndpoint)) {\n\t\t\tGuards.arrayValue<string>(\n\t\t\t\tIdentityRestClient.CLASS_NAME,\n\t\t\t\tnameof(serviceEndpoint),\n\t\t\t\tserviceEndpoint\n\t\t\t);\n\t\t} else {\n\t\t\tGuards.stringValue(IdentityRestClient.CLASS_NAME, nameof(serviceEndpoint), serviceEndpoint);\n\t\t}\n\n\t\tconst response = await this.fetch<\n\t\t\tIIdentityServiceCreateRequest,\n\t\t\tIIdentityServiceCreateResponse\n\t\t>(\"/:identity/service\", \"POST\", {\n\t\t\tpathParams: {\n\t\t\t\tidentity\n\t\t\t},\n\t\t\tbody: {\n\t\t\t\tserviceId,\n\t\t\t\ttype: serviceType,\n\t\t\t\tendpoint: serviceEndpoint\n\t\t\t}\n\t\t});\n\n\t\treturn response.body;\n\t}\n\n\t/**\n\t * Remove a service from the document.\n\t * @param serviceId The id of the service.\n\t * @returns Nothing.\n\t * @throws NotFoundError if the id can not be resolved.\n\t */\n\tpublic async serviceRemove(serviceId: string): Promise<void> {\n\t\tGuards.stringValue(IdentityRestClient.CLASS_NAME, nameof(serviceId), serviceId);\n\n\t\tconst idParts = DocumentHelper.parseId(serviceId);\n\n\t\tawait this.fetch<IIdentityServiceRemoveRequest, INoContentResponse>(\n\t\t\t\"/:identity/service/:serviceId\",\n\t\t\t\"DELETE\",\n\t\t\t{\n\t\t\t\tpathParams: {\n\t\t\t\t\tidentity: idParts.id,\n\t\t\t\t\tserviceId: idParts.fragment ?? \"\"\n\t\t\t\t}\n\t\t\t}\n\t\t);\n\t}\n\n\t/**\n\t * Create a verifiable credential for a verification method.\n\t * @param verificationMethodId The verification method id to use.\n\t * @param id The id of the credential.\n\t * @param subject The credential subject to store in the verifiable credential.\n\t * @param options Additional options for creating the verifiable credential.\n\t * @param options.revocationIndex The bitmap revocation index of the credential, if undefined will not have revocation status.\n\t * @param options.expirationDate The date the verifiable credential is valid until.\n\t * @returns The created verifiable credential and its token.\n\t * @throws NotFoundError if the id can not be resolved.\n\t */\n\tpublic async verifiableCredentialCreate(\n\t\tverificationMethodId: string,\n\t\tid: string | undefined,\n\t\tsubject: IJsonLdNodeObject,\n\t\toptions?: {\n\t\t\trevocationIndex?: number;\n\t\t\texpirationDate?: Date;\n\t\t}\n\t): Promise<{\n\t\tverifiableCredential: IDidVerifiableCredential;\n\t\tjwt: string;\n\t}> {\n\t\tGuards.stringValue(\n\t\t\tIdentityRestClient.CLASS_NAME,\n\t\t\tnameof(verificationMethodId),\n\t\t\tverificationMethodId\n\t\t);\n\t\tGuards.object<IJsonLdNodeObject>(IdentityRestClient.CLASS_NAME, nameof(subject), subject);\n\t\tif (!Is.undefined(options?.revocationIndex)) {\n\t\t\tGuards.number(\n\t\t\t\tIdentityRestClient.CLASS_NAME,\n\t\t\t\tnameof(options?.revocationIndex),\n\t\t\t\toptions?.revocationIndex\n\t\t\t);\n\t\t}\n\n\t\tconst idParts = DocumentHelper.parseId(verificationMethodId);\n\n\t\tconst response = await this.fetch<\n\t\t\tIIdentityVerifiableCredentialCreateRequest,\n\t\t\tIIdentityVerifiableCredentialCreateResponse\n\t\t>(\"/:identity/verifiable-credential\", \"POST\", {\n\t\t\tpathParams: {\n\t\t\t\tidentity: idParts.id,\n\t\t\t\tverificationMethodId: idParts.fragment ?? \"\"\n\t\t\t},\n\t\t\tbody: {\n\t\t\t\tcredentialId: id,\n\t\t\t\tsubject,\n\t\t\t\trevocationIndex: options?.revocationIndex,\n\t\t\t\texpirationDate: options?.expirationDate?.toISOString()\n\t\t\t}\n\t\t});\n\n\t\treturn response.body;\n\t}\n\n\t/**\n\t * Verify a verifiable credential is valid.\n\t * @param credentialJwt The credential to verify.\n\t * @returns The credential stored in the jwt and the revocation status.\n\t */\n\tpublic async verifiableCredentialVerify(credentialJwt: string): Promise<{\n\t\trevoked: boolean;\n\t\tverifiableCredential?: IDidVerifiableCredential;\n\t}> {\n\t\tGuards.stringValue(IdentityRestClient.CLASS_NAME, nameof(credentialJwt), credentialJwt);\n\n\t\tconst response = await this.fetch<\n\t\t\tIIdentityVerifiableCredentialVerifyRequest,\n\t\t\tIIdentityVerifiableCredentialVerifyResponse\n\t\t>(\"/verifiable-credential/verify\", \"POST\", {\n\t\t\tquery: {\n\t\t\t\tjwt: credentialJwt\n\t\t\t}\n\t\t});\n\n\t\treturn response.body;\n\t}\n\n\t/**\n\t * Revoke verifiable credential.\n\t * @param issuerId The id of the document to update the revocation list for.\n\t * @param credentialIndex The revocation bitmap index revoke.\n\t * @returns Nothing.\n\t */\n\tpublic async verifiableCredentialRevoke(\n\t\tissuerId: string,\n\t\tcredentialIndex: number\n\t): Promise<void> {\n\t\tGuards.stringValue(IdentityRestClient.CLASS_NAME, nameof(issuerId), issuerId);\n\t\tGuards.integer(IdentityRestClient.CLASS_NAME, nameof(credentialIndex), credentialIndex);\n\n\t\tawait this.fetch<IIdentityVerifiableCredentialRevokeRequest, INoContentResponse>(\n\t\t\t\"/:identity/verifiable-credential/revoke/:revocationIndex\",\n\t\t\t\"GET\",\n\t\t\t{\n\t\t\t\tpathParams: {\n\t\t\t\t\tidentity: issuerId,\n\t\t\t\t\trevocationIndex: credentialIndex\n\t\t\t\t}\n\t\t\t}\n\t\t);\n\t}\n\n\t/**\n\t * Unrevoke verifiable credential.\n\t * @param issuerId The id of the document to update the revocation list for.\n\t * @param credentialIndex The revocation bitmap index to un revoke.\n\t * @returns Nothing.\n\t */\n\tpublic async verifiableCredentialUnrevoke(\n\t\tissuerId: string,\n\t\tcredentialIndex: number\n\t): Promise<void> {\n\t\tGuards.stringValue(IdentityRestClient.CLASS_NAME, nameof(issuerId), issuerId);\n\t\tGuards.integer(IdentityRestClient.CLASS_NAME, nameof(credentialIndex), credentialIndex);\n\n\t\tawait this.fetch<IIdentityVerifiableCredentialUnrevokeRequest, INoContentResponse>(\n\t\t\t\"/:identity/verifiable-credential/unrevoke/:revocationIndex\",\n\t\t\t\"GET\",\n\t\t\t{\n\t\t\t\tpathParams: {\n\t\t\t\t\tidentity: issuerId,\n\t\t\t\t\trevocationIndex: credentialIndex\n\t\t\t\t}\n\t\t\t}\n\t\t);\n\t}\n\n\t/**\n\t * Create a verifiable presentation from the supplied verifiable credentials.\n\t * @param verificationMethodId The method to associate with the presentation.\n\t * @param presentationId The id of the presentation.\n\t * @param contexts The contexts for the data stored in the verifiable credential.\n\t * @param types The types for the data stored in the verifiable credential.\n\t * @param verifiableCredentials The credentials to use for creating the presentation in jwt format.\n\t * @param expiresInMinutes The time in minutes for the presentation to expire.\n\t * @returns The created verifiable presentation and its token.\n\t * @throws NotFoundError if the id can not be resolved.\n\t */\n\tpublic async verifiablePresentationCreate(\n\t\tverificationMethodId: string,\n\t\tpresentationId: string | undefined,\n\t\tcontexts: IJsonLdContextDefinitionRoot | undefined,\n\t\ttypes: string | string[] | undefined,\n\t\tverifiableCredentials: (string | IDidVerifiableCredential)[],\n\t\texpiresInMinutes?: number\n\t): Promise<{\n\t\tverifiablePresentation: IDidVerifiablePresentation;\n\t\tjwt: string;\n\t}> {\n\t\tGuards.stringValue(\n\t\t\tIdentityRestClient.CLASS_NAME,\n\t\t\tnameof(verificationMethodId),\n\t\t\tverificationMethodId\n\t\t);\n\t\tif (Is.array(types)) {\n\t\t\tGuards.arrayValue(IdentityRestClient.CLASS_NAME, nameof(types), types);\n\t\t} else if (Is.string(types)) {\n\t\t\tGuards.stringValue(IdentityRestClient.CLASS_NAME, nameof(types), types);\n\t\t}\n\t\tGuards.arrayValue(\n\t\t\tIdentityRestClient.CLASS_NAME,\n\t\t\tnameof(verifiableCredentials),\n\t\t\tverifiableCredentials\n\t\t);\n\t\tif (!Is.undefined(expiresInMinutes)) {\n\t\t\tGuards.integer(IdentityRestClient.CLASS_NAME, nameof(expiresInMinutes), expiresInMinutes);\n\t\t}\n\n\t\tconst idParts = DocumentHelper.parseId(verificationMethodId);\n\n\t\tconst response = await this.fetch<\n\t\t\tIIdentityVerifiablePresentationCreateRequest,\n\t\t\tIIdentityVerifiablePresentationCreateResponse\n\t\t>(\"/:identity/verifiable-presentation\", \"POST\", {\n\t\t\tpathParams: {\n\t\t\t\tidentity: idParts.id,\n\t\t\t\tverificationMethodId: idParts.fragment ?? \"\"\n\t\t\t},\n\t\t\tbody: {\n\t\t\t\tpresentationId,\n\t\t\t\tcontexts,\n\t\t\t\ttypes,\n\t\t\t\tverifiableCredentials,\n\t\t\t\texpiresInMinutes\n\t\t\t}\n\t\t});\n\n\t\treturn response.body;\n\t}\n\n\t/**\n\t * Verify a verifiable presentation is valid.\n\t * @param presentationJwt The presentation to verify.\n\t * @returns The presentation stored in the jwt and the revocation status.\n\t */\n\tpublic async verifiablePresentationVerify(presentationJwt: string): Promise<{\n\t\trevoked: boolean;\n\t\tverifiablePresentation?: IDidVerifiablePresentation;\n\t\tissuers?: IDidDocument[];\n\t}> {\n\t\tGuards.stringValue(IdentityRestClient.CLASS_NAME, nameof(presentationJwt), presentationJwt);\n\n\t\tconst response = await this.fetch<\n\t\t\tIIdentityVerifiablePresentationVerifyRequest,\n\t\t\tIIdentityVerifiablePresentationVerifyResponse\n\t\t>(\"/verifiable-presentation/verify\", \"POST\", {\n\t\t\tquery: {\n\t\t\t\tjwt: presentationJwt\n\t\t\t}\n\t\t});\n\n\t\treturn response.body;\n\t}\n\n\t/**\n\t * Create a proof for a document with the specified verification method.\n\t * @param verificationMethodId The verification method id to use.\n\t * @param proofType The type of proof to create.\n\t * @param unsecureDocument The unsecure document to create the proof for.\n\t * @returns The proof.\n\t */\n\tpublic async proofCreate(\n\t\tverificationMethodId: string,\n\t\tproofType: ProofTypes,\n\t\tunsecureDocument: IJsonLdNodeObject\n\t): Promise<IProof> {\n\t\tGuards.stringValue(\n\t\t\tIdentityRestClient.CLASS_NAME,\n\t\t\tnameof(verificationMethodId),\n\t\t\tverificationMethodId\n\t\t);\n\t\tGuards.arrayOneOf<ProofTypes>(\n\t\t\tIdentityRestClient.CLASS_NAME,\n\t\t\tnameof(proofType),\n\t\t\tproofType,\n\t\t\tObject.values(ProofTypes)\n\t\t);\n\t\tGuards.object<IJsonLdNodeObject>(\n\t\t\tIdentityRestClient.CLASS_NAME,\n\t\t\tnameof(unsecureDocument),\n\t\t\tunsecureDocument\n\t\t);\n\n\t\tconst idParts = DocumentHelper.parseId(verificationMethodId);\n\n\t\tconst response = await this.fetch<IIdentityProofCreateRequest, IIdentityProofCreateResponse>(\n\t\t\t\"/:identity/proof\",\n\t\t\t\"POST\",\n\t\t\t{\n\t\t\t\tpathParams: {\n\t\t\t\t\tidentity: idParts.id,\n\t\t\t\t\tverificationMethodId: idParts.fragment ?? \"\"\n\t\t\t\t},\n\t\t\t\tbody: {\n\t\t\t\t\tdocument: unsecureDocument,\n\t\t\t\t\tproofType\n\t\t\t\t}\n\t\t\t}\n\t\t);\n\n\t\treturn response.body;\n\t}\n\n\t/**\n\t * Verify proof for a document with the specified verification method.\n\t * @param document The document to verify.\n\t * @param proof The proof to verify.\n\t * @returns True if the proof is verified.\n\t */\n\tpublic async proofVerify(document: IJsonLdNodeObject, proof: IProof): Promise<boolean> {\n\t\tGuards.object<IJsonLdNodeObject>(IdentityRestClient.CLASS_NAME, nameof(document), document);\n\t\tGuards.object<IProof>(IdentityRestClient.CLASS_NAME, nameof(proof), proof);\n\t\tGuards.stringValue(\n\t\t\tIdentityRestClient.CLASS_NAME,\n\t\t\tnameof(proof.verificationMethod),\n\t\t\tproof.verificationMethod\n\t\t);\n\n\t\tconst response = await this.fetch<IIdentityProofVerifyRequest, IIdentityProofVerifyResponse>(\n\t\t\t\"/proof/verify\",\n\t\t\t\"POST\",\n\t\t\t{\n\t\t\t\tbody: {\n\t\t\t\t\tdocument,\n\t\t\t\t\tproof\n\t\t\t\t}\n\t\t\t}\n\t\t);\n\n\t\treturn response.body.verified;\n\t}\n}\n"]}

package/dist/es/index.js

@@ -0,0 +1,6 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./identityRestClient.js";
+export * from "./identityProfileRestClient.js";
+export * from "./identityResolverRestClient.js";
+//# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,yBAAyB,CAAC;AACxC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,iCAAiC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./identityRestClient.js\";\nexport * from \"./identityProfileRestClient.js\";\nexport * from \"./identityResolverRestClient.js\";\n"]}

package/dist/types/identityProfileRestClient.d.ts

@@ -11,10 +11,15 @@ export declare class IdentityProfileRestClient<T extends IJsonLdDocument = IJson
      */
     static readonly CLASS_NAME: string;
     /**
-     * Create a new instance of IdentityClient.
+     * Create a new instance of IdentityProfileRestClient.
      * @param config The configuration for the client.
      */
     constructor(config: IBaseRestClientConfig);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
     /**
      * Create the profile properties for an identity.
      * @param publicProfile The public profile data as JSON-LD.

package/dist/types/identityResolverRestClient.d.ts

@@ -11,10 +11,15 @@ export declare class IdentityResolverRestClient extends BaseRestClient implement
      */
     static readonly CLASS_NAME: string;
     /**
-     * Create a new instance of IdentityClient.
+     * Create a new instance of IdentityResolverRestClient.
      * @param config The configuration for the client.
      */
     constructor(config: IBaseRestClientConfig);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
     /**
      * Resolve an identity.
      * @param documentId The id of the document to resolve.

package/dist/types/identityRestClient.d.ts

@@ -12,10 +12,15 @@ export declare class IdentityRestClient extends BaseRestClient implements IIdent
      */
     static readonly CLASS_NAME: string;
     /**
-     * Create a new instance of IdentityClient.
+     * Create a new instance of IdentityRestClient.
      * @param config The configuration for the client.
      */
     constructor(config: IBaseRestClientConfig);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
     /**
      * Create a new identity.
      * @param namespace The namespace of the connector to use for the identity, defaults to service configured namespace.

package/dist/types/index.d.ts

@@ -1,3 +1,3 @@
-export * from "./identityRestClient";
-export * from "./identityProfileRestClient";
-export * from "./identityResolverRestClient";
+export * from "./identityRestClient.js";
+export * from "./identityProfileRestClient.js";
+export * from "./identityResolverRestClient.js";

package/docs/changelog.md

@@ -1,5 +1,47 @@
 # @twin.org/identity-rest-client - Changelog
 
+## [0.0.3-next.1](https://github.com/twinfoundation/identity/compare/identity-rest-client-v0.0.3-next.0...identity-rest-client-v0.0.3-next.1) (2025-11-11)
+
+
+### Features
+
+* add context id features ([#62](https://github.com/twinfoundation/identity/issues/62)) ([e02ecca](https://github.com/twinfoundation/identity/commit/e02ecca9c45a849104bfbf7bc18a1f44e6eea8a1))
+* add expiration date option to vc creation ([73e05e1](https://github.com/twinfoundation/identity/commit/73e05e1ae61112c7e056889969751f4ff82d9f29))
+* add identity remove ([eebc13f](https://github.com/twinfoundation/identity/commit/eebc13f4c2cd994d2d9cce4da2128fb346c80ba7))
+* add validate-locales ([04d74b4](https://github.com/twinfoundation/identity/commit/04d74b4d1ebe42672e8ca75a7bdb8e3556afd0be))
+* eslint migration to flat config ([fd6246d](https://github.com/twinfoundation/identity/commit/fd6246d566280b6d5d10a108eb1e92c4b510f2f2))
+* identity key separator use slash ([1319d0d](https://github.com/twinfoundation/identity/commit/1319d0d07164a36b3ec279e6421b8835ffefc3d3))
+* update framework core ([c824497](https://github.com/twinfoundation/identity/commit/c82449709af0215eb7af496cf687c93fb30b5ae0))
+* use shared store mechanism ([#27](https://github.com/twinfoundation/identity/issues/27)) ([ce41f3f](https://github.com/twinfoundation/identity/commit/ce41f3fc3da1b206ec06da7ea5b2c968f788804d))
+
+
+### Bug Fixes
+
+* Import path and bump version ([#21](https://github.com/twinfoundation/identity/issues/21)) ([ccea845](https://github.com/twinfoundation/identity/commit/ccea845bf32562267280bc1b3dde1c9af1a00360))
+* Install sdk-wasm ([#20](https://github.com/twinfoundation/identity/issues/20)) ([75ec14e](https://github.com/twinfoundation/identity/commit/75ec14e072f8c219863a1c028a3b0783802086e9))
+* query params force coercion ([d9347d2](https://github.com/twinfoundation/identity/commit/d9347d29d4a9cc58759f30f5d8526de864ea7522))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/identity-models bumped from 0.0.3-next.0 to 0.0.3-next.1
+
+## [0.0.2-next.10](https://github.com/twinfoundation/identity/compare/identity-rest-client-v0.0.2-next.9...identity-rest-client-v0.0.2-next.10) (2025-10-27)
+
+
+### 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.9 to 0.0.2-next.10
+
 ## [0.0.2-next.9](https://github.com/twinfoundation/identity/compare/identity-rest-client-v0.0.2-next.8...identity-rest-client-v0.0.2-next.9) (2025-10-09)
 
 

package/docs/reference/classes/IdentityProfileRestClient.md

@@ -26,7 +26,7 @@ Client for performing identity through to REST endpoints.
 
 > **new IdentityProfileRestClient**\<`T`, `U`\>(`config`): `IdentityProfileRestClient`\<`T`, `U`\>
 
-Create a new instance of IdentityClient.
+Create a new instance of IdentityProfileRestClient.
 
 #### Parameters
 
@@ -54,6 +54,24 @@ Runtime name for the class.
 
 ## Methods
 
+### className()
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IIdentityProfileComponent.className`
+
+***
+
 ### create()
 
 > **create**(`publicProfile?`, `privateProfile?`): `Promise`\<`void`\>

package/docs/reference/classes/IdentityResolverRestClient.md

@@ -16,7 +16,7 @@ Client for performing identity through to REST endpoints.
 
 > **new IdentityResolverRestClient**(`config`): `IdentityResolverRestClient`
 
-Create a new instance of IdentityClient.
+Create a new instance of IdentityResolverRestClient.
 
 #### Parameters
 
@@ -44,6 +44,24 @@ Runtime name for the class.
 
 ## Methods
 
+### className()
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IIdentityResolverComponent.className`
+
+***
+
 ### identityResolve()
 
 > **identityResolve**(`documentId`): `Promise`\<`IDidDocument`\>

package/docs/reference/classes/IdentityRestClient.md

@@ -16,7 +16,7 @@ Client for performing identity through to REST endpoints.
 
 > **new IdentityRestClient**(`config`): `IdentityRestClient`
 
-Create a new instance of IdentityClient.
+Create a new instance of IdentityRestClient.
 
 #### Parameters
 
@@ -44,6 +44,24 @@ Runtime name for the class.
 
 ## Methods
 
+### className()
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IIdentityComponent.className`
+
+***
+
 ### identityCreate()
 
 > **identityCreate**(`namespace?`): `Promise`\<`IDidDocument`\>
@@ -272,7 +290,7 @@ The verification method id to use.
 
 The id of the credential.
 
-`undefined` | `string`
+`string` | `undefined`
 
 ##### subject
 
@@ -420,19 +438,19 @@ The method to associate with the presentation.
 
 The id of the presentation.
 
-`undefined` | `string`
+`string` | `undefined`
 
 ##### contexts
 
 The contexts for the data stored in the verifiable credential.
 
-`undefined` | `IJsonLdContextDefinitionRoot`
+`IJsonLdContextDefinitionRoot` | `undefined`
 
 ##### types
 
 The types for the data stored in the verifiable credential.
 
-`undefined` | `string` | `string`[]
+`string` | `string`[] | `undefined`
 
 ##### verifiableCredentials
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/identity-rest-client",
-	"version": "0.0.2-next.9",
+	"version": "0.0.3-next.1",
 	"description": "Identity contract implementation which can connect to REST endpoints",
 	"repository": {
 		"type": "git",
@@ -20,24 +20,22 @@
 		"@twin.org/data-core": "next",
 		"@twin.org/data-json-ld": "next",
 		"@twin.org/entity": "next",
-		"@twin.org/identity-models": "0.0.2-next.9",
+		"@twin.org/identity-models": "0.0.3-next.1",
 		"@twin.org/nameof": "next",
 		"@twin.org/standards-w3c-did": "next"
 	},
-	"main": "./dist/cjs/index.cjs",
-	"module": "./dist/esm/index.mjs",
+	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
 			"types": "./dist/types/index.d.ts",
-			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs"
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
 		},
 		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
-		"dist/cjs",
-		"dist/esm",
+		"dist/es",
 		"dist/types",
 		"locales",
 		"docs"

package/dist/cjs/index.cjs

@@ -1,469 +0,0 @@
-'use strict';
-
-var apiCore = require('@twin.org/api-core');
-var core = require('@twin.org/core');
-var identityModels = require('@twin.org/identity-models');
-var standardsW3cDid = require('@twin.org/standards-w3c-did');
-var apiModels = require('@twin.org/api-models');
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Client for performing identity through to REST endpoints.
- */
-class IdentityRestClient extends apiCore.BaseRestClient {
-    /**
-     * Runtime name for the class.
-     */
-    static CLASS_NAME = "IdentityRestClient";
-    /**
-     * Create a new instance of IdentityClient.
-     * @param config The configuration for the client.
-     */
-    constructor(config) {
-        super("IdentityRestClient", config, "identity");
-    }
-    /**
-     * Create a new identity.
-     * @param namespace The namespace of the connector to use for the identity, defaults to service configured namespace.
-     * @returns The created identity document.
-     */
-    async identityCreate(namespace) {
-        const response = await this.fetch("/", "POST", {
-            body: {
-                namespace
-            }
-        });
-        return response.body;
-    }
-    /**
-     * Remove an identity.
-     * @param identity The id of the document to remove.
-     * @returns Nothing.
-     */
-    async identityRemove(identity) {
-        core.Guards.stringValue(IdentityRestClient.CLASS_NAME, "identity", identity);
-        await this.fetch("/:identity", "DELETE", {
-            pathParams: {
-                identity
-            }
-        });
-    }
-    /**
-     * Add a verification method to the document in JSON Web key Format.
-     * @param identity The id of the document to add the verification method to.
-     * @param verificationMethodType The type of the verification method to add.
-     * @param verificationMethodId The id of the verification method, if undefined uses the kid of the generated JWK.
-     * @returns The verification method.
-     * @throws NotFoundError if the id can not be resolved.
-     * @throws NotSupportedError if the platform does not support multiple keys.
-     */
-    async verificationMethodCreate(identity, verificationMethodType, verificationMethodId) {
-        core.Guards.stringValue(IdentityRestClient.CLASS_NAME, "identity", identity);
-        core.Guards.arrayOneOf(IdentityRestClient.CLASS_NAME, "verificationMethodType", verificationMethodType, Object.values(standardsW3cDid.DidVerificationMethodType));
-        const response = await this.fetch("/:identity/verification-method", "POST", {
-            pathParams: {
-                identity
-            },
-            body: {
-                verificationMethodType,
-                verificationMethodId
-            }
-        });
-        return response.body;
-    }
-    /**
-     * Remove a verification method from the document.
-     * @param verificationMethodId The id of the verification method.
-     * @returns Nothing.
-     * @throws NotFoundError if the id can not be resolved.
-     * @throws NotSupportedError if the platform does not support multiple revocable keys.
-     */
-    async verificationMethodRemove(verificationMethodId) {
-        core.Guards.stringValue(IdentityRestClient.CLASS_NAME, "verificationMethodId", verificationMethodId);
-        const idParts = identityModels.DocumentHelper.parseId(verificationMethodId);
-        await this.fetch("/:identity/verification-method/:verificationMethodId", "DELETE", {
-            pathParams: {
-                identity: idParts.id,
-                verificationMethodId: idParts.fragment ?? ""
-            }
-        });
-    }
-    /**
-     * Add a service to the document.
-     * @param identity The id of the document to add the service to.
-     * @param serviceId The id of the service.
-     * @param serviceType The type of the service.
-     * @param serviceEndpoint The endpoint for the service.
-     * @returns The service.
-     * @throws NotFoundError if the id can not be resolved.
-     */
-    async serviceCreate(identity, serviceId, serviceType, serviceEndpoint) {
-        core.Guards.stringValue(IdentityRestClient.CLASS_NAME, "identity", identity);
-        core.Guards.stringValue(IdentityRestClient.CLASS_NAME, "serviceId", serviceId);
-        if (core.Is.array(serviceType)) {
-            core.Guards.arrayValue(IdentityRestClient.CLASS_NAME, "serviceType", serviceType);
-        }
-        else {
-            core.Guards.stringValue(IdentityRestClient.CLASS_NAME, "serviceType", serviceType);
-        }
-        if (core.Is.array(serviceEndpoint)) {
-            core.Guards.arrayValue(IdentityRestClient.CLASS_NAME, "serviceEndpoint", serviceEndpoint);
-        }
-        else {
-            core.Guards.stringValue(IdentityRestClient.CLASS_NAME, "serviceEndpoint", serviceEndpoint);
-        }
-        const response = await this.fetch("/:identity/service", "POST", {
-            pathParams: {
-                identity
-            },
-            body: {
-                serviceId,
-                type: serviceType,
-                endpoint: serviceEndpoint
-            }
-        });
-        return response.body;
-    }
-    /**
-     * Remove a service from the document.
-     * @param serviceId The id of the service.
-     * @returns Nothing.
-     * @throws NotFoundError if the id can not be resolved.
-     */
-    async serviceRemove(serviceId) {
-        core.Guards.stringValue(IdentityRestClient.CLASS_NAME, "serviceId", serviceId);
-        const idParts = identityModels.DocumentHelper.parseId(serviceId);
-        await this.fetch("/:identity/service/:serviceId", "DELETE", {
-            pathParams: {
-                identity: idParts.id,
-                serviceId: idParts.fragment ?? ""
-            }
-        });
-    }
-    /**
-     * Create a verifiable credential for a verification method.
-     * @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 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, options) {
-        core.Guards.stringValue(IdentityRestClient.CLASS_NAME, "verificationMethodId", verificationMethodId);
-        core.Guards.object(IdentityRestClient.CLASS_NAME, "subject", subject);
-        if (!core.Is.undefined(options?.revocationIndex)) {
-            core.Guards.number(IdentityRestClient.CLASS_NAME, "options.revocationIndex", options?.revocationIndex);
-        }
-        const idParts = identityModels.DocumentHelper.parseId(verificationMethodId);
-        const response = await this.fetch("/:identity/verifiable-credential", "POST", {
-            pathParams: {
-                identity: idParts.id,
-                verificationMethodId: idParts.fragment ?? ""
-            },
-            body: {
-                credentialId: id,
-                subject,
-                revocationIndex: options?.revocationIndex,
-                expirationDate: options?.expirationDate?.toISOString()
-            }
-        });
-        return response.body;
-    }
-    /**
-     * Verify a verifiable credential is valid.
-     * @param credentialJwt The credential to verify.
-     * @returns The credential stored in the jwt and the revocation status.
-     */
-    async verifiableCredentialVerify(credentialJwt) {
-        core.Guards.stringValue(IdentityRestClient.CLASS_NAME, "credentialJwt", credentialJwt);
-        const response = await this.fetch("/verifiable-credential/verify", "POST", {
-            query: {
-                jwt: credentialJwt
-            }
-        });
-        return response.body;
-    }
-    /**
-     * Revoke verifiable credential.
-     * @param issuerId The id of the document to update the revocation list for.
-     * @param credentialIndex The revocation bitmap index revoke.
-     * @returns Nothing.
-     */
-    async verifiableCredentialRevoke(issuerId, credentialIndex) {
-        core.Guards.stringValue(IdentityRestClient.CLASS_NAME, "issuerId", issuerId);
-        core.Guards.integer(IdentityRestClient.CLASS_NAME, "credentialIndex", credentialIndex);
-        await this.fetch("/:identity/verifiable-credential/revoke/:revocationIndex", "GET", {
-            pathParams: {
-                identity: issuerId,
-                revocationIndex: credentialIndex
-            }
-        });
-    }
-    /**
-     * Unrevoke verifiable credential.
-     * @param issuerId The id of the document to update the revocation list for.
-     * @param credentialIndex The revocation bitmap index to un revoke.
-     * @returns Nothing.
-     */
-    async verifiableCredentialUnrevoke(issuerId, credentialIndex) {
-        core.Guards.stringValue(IdentityRestClient.CLASS_NAME, "issuerId", issuerId);
-        core.Guards.integer(IdentityRestClient.CLASS_NAME, "credentialIndex", credentialIndex);
-        await this.fetch("/:identity/verifiable-credential/unrevoke/:revocationIndex", "GET", {
-            pathParams: {
-                identity: issuerId,
-                revocationIndex: credentialIndex
-            }
-        });
-    }
-    /**
-     * Create a verifiable presentation from the supplied verifiable credentials.
-     * @param verificationMethodId 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 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.
-     */
-    async verifiablePresentationCreate(verificationMethodId, presentationId, contexts, types, verifiableCredentials, expiresInMinutes) {
-        core.Guards.stringValue(IdentityRestClient.CLASS_NAME, "verificationMethodId", verificationMethodId);
-        if (core.Is.array(types)) {
-            core.Guards.arrayValue(IdentityRestClient.CLASS_NAME, "types", types);
-        }
-        else if (core.Is.string(types)) {
-            core.Guards.stringValue(IdentityRestClient.CLASS_NAME, "types", types);
-        }
-        core.Guards.arrayValue(IdentityRestClient.CLASS_NAME, "verifiableCredentials", verifiableCredentials);
-        if (!core.Is.undefined(expiresInMinutes)) {
-            core.Guards.integer(IdentityRestClient.CLASS_NAME, "expiresInMinutes", expiresInMinutes);
-        }
-        const idParts = identityModels.DocumentHelper.parseId(verificationMethodId);
-        const response = await this.fetch("/:identity/verifiable-presentation", "POST", {
-            pathParams: {
-                identity: idParts.id,
-                verificationMethodId: idParts.fragment ?? ""
-            },
-            body: {
-                presentationId,
-                contexts,
-                types,
-                verifiableCredentials,
-                expiresInMinutes
-            }
-        });
-        return response.body;
-    }
-    /**
-     * Verify a verifiable presentation is valid.
-     * @param presentationJwt The presentation to verify.
-     * @returns The presentation stored in the jwt and the revocation status.
-     */
-    async verifiablePresentationVerify(presentationJwt) {
-        core.Guards.stringValue(IdentityRestClient.CLASS_NAME, "presentationJwt", presentationJwt);
-        const response = await this.fetch("/verifiable-presentation/verify", "POST", {
-            query: {
-                jwt: presentationJwt
-            }
-        });
-        return response.body;
-    }
-    /**
-     * Create a proof for a document with the specified verification method.
-     * @param verificationMethodId The verification method id to use.
-     * @param proofType The type of proof to create.
-     * @param unsecureDocument The unsecure document to create the proof for.
-     * @returns The proof.
-     */
-    async proofCreate(verificationMethodId, proofType, unsecureDocument) {
-        core.Guards.stringValue(IdentityRestClient.CLASS_NAME, "verificationMethodId", verificationMethodId);
-        core.Guards.arrayOneOf(IdentityRestClient.CLASS_NAME, "proofType", proofType, Object.values(standardsW3cDid.ProofTypes));
-        core.Guards.object(IdentityRestClient.CLASS_NAME, "unsecureDocument", unsecureDocument);
-        const idParts = identityModels.DocumentHelper.parseId(verificationMethodId);
-        const response = await this.fetch("/:identity/proof", "POST", {
-            pathParams: {
-                identity: idParts.id,
-                verificationMethodId: idParts.fragment ?? ""
-            },
-            body: {
-                document: unsecureDocument,
-                proofType
-            }
-        });
-        return response.body;
-    }
-    /**
-     * Verify proof for a document with the specified verification method.
-     * @param document The document to verify.
-     * @param proof The proof to verify.
-     * @returns True if the proof is verified.
-     */
-    async proofVerify(document, proof) {
-        core.Guards.object(IdentityRestClient.CLASS_NAME, "document", document);
-        core.Guards.object(IdentityRestClient.CLASS_NAME, "proof", proof);
-        core.Guards.stringValue(IdentityRestClient.CLASS_NAME, "proof.verificationMethod", proof.verificationMethod);
-        const response = await this.fetch("/proof/verify", "POST", {
-            body: {
-                document,
-                proof
-            }
-        });
-        return response.body.verified;
-    }
-}
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Client for performing identity through to REST endpoints.
- */
-class IdentityProfileRestClient extends apiCore.BaseRestClient {
-    /**
-     * Runtime name for the class.
-     */
-    static CLASS_NAME = "IdentityProfileRestClient";
-    /**
-     * Create a new instance of IdentityClient.
-     * @param config The configuration for the client.
-     */
-    constructor(config) {
-        super("IdentityProfileRestClient", config, "identity/profile");
-    }
-    /**
-     * Create the profile properties for an identity.
-     * @param publicProfile The public profile data as JSON-LD.
-     * @param privateProfile The private profile data as JSON-LD.
-     * @returns Nothing.
-     */
-    async create(publicProfile, privateProfile) {
-        await this.fetch("", "POST", {
-            body: {
-                publicProfile,
-                privateProfile
-            }
-        });
-    }
-    /**
-     * Get the profile properties for an identity.
-     * @param publicPropertyNames The public properties to get for the profile, defaults to all.
-     * @param privatePropertyNames The private properties to get for the profile, defaults to all.
-     * @returns The identity and the items properties.
-     */
-    async get(publicPropertyNames, privatePropertyNames) {
-        const response = await this.fetch("/", "GET", {
-            query: {
-                publicPropertyNames: apiModels.HttpParameterHelper.arrayToString(publicPropertyNames),
-                privatePropertyNames: apiModels.HttpParameterHelper.arrayToString(privatePropertyNames)
-            }
-        });
-        return {
-            identity: response.body.identity,
-            publicProfile: response.body.publicProfile,
-            privateProfile: response.body.privateProfile
-        };
-    }
-    /**
-     * Get the public profile properties for an identity.
-     * @param identity The identity to perform the profile operation on.
-     * @param propertyNames The public properties to get for the profile, defaults to all.
-     * @returns The items properties.
-     */
-    async getPublic(identity, propertyNames) {
-        core.Guards.string(IdentityProfileRestClient.CLASS_NAME, "identity", identity);
-        const response = await this.fetch("/:identity/public", "GET", {
-            pathParams: {
-                identity
-            },
-            query: {
-                propertyNames: apiModels.HttpParameterHelper.arrayToString(propertyNames)
-            }
-        });
-        return response.body;
-    }
-    /**
-     * Update the profile properties of an identity.
-     * @param publicProfile The public profile data as JSON-LD.
-     * @param privateProfile The private profile data as JSON-LD.
-     * @returns Nothing.
-     */
-    async update(publicProfile, privateProfile) {
-        await this.fetch("/", "PUT", {
-            body: {
-                publicProfile,
-                privateProfile
-            }
-        });
-    }
-    /**
-     * Delete the profile for an identity.
-     * @returns Nothing.
-     */
-    async remove() {
-        await this.fetch("/", "DELETE");
-    }
-    /**
-     * Get a list of the requested identities.
-     * @param publicFilters The filters to apply to the identities public profiles.
-     * @param publicPropertyNames The public properties to get for the profile, defaults to all.
-     * @param cursor The cursor for paged requests.
-     * @param limit The maximum number of items in a page.
-     * @returns The list of items and cursor for paging.
-     */
-    async list(publicFilters, publicPropertyNames, cursor, limit) {
-        const response = await this.fetch("/query", "GET", {
-            query: {
-                publicFilters: apiModels.HttpParameterHelper.arrayToString(
-                // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
-                publicFilters?.map(f => `${f.propertyName}:${f.propertyValue}`)),
-                publicPropertyNames: apiModels.HttpParameterHelper.arrayToString(publicPropertyNames),
-                cursor,
-                limit: core.Coerce.string(limit)
-            }
-        });
-        return {
-            items: response.body.items,
-            cursor: response.body.cursor
-        };
-    }
-}
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Client for performing identity through to REST endpoints.
- */
-class IdentityResolverRestClient extends apiCore.BaseRestClient {
-    /**
-     * Runtime name for the class.
-     */
-    static CLASS_NAME = "IdentityResolverRestClient";
-    /**
-     * Create a new instance of IdentityClient.
-     * @param config The configuration for the client.
-     */
-    constructor(config) {
-        super("IdentityResolverRestClient", config, "identity");
-    }
-    /**
-     * Resolve an identity.
-     * @param documentId The id of the document to resolve.
-     * @returns The resolved document.
-     */
-    async identityResolve(documentId) {
-        core.Urn.guard(IdentityResolverRestClient.CLASS_NAME, "documentId", documentId);
-        const response = await this.fetch("/:identity", "GET", {
-            pathParams: {
-                identity: documentId
-            }
-        });
-        return response.body;
-    }
-}
-
-exports.IdentityProfileRestClient = IdentityProfileRestClient;
-exports.IdentityResolverRestClient = IdentityResolverRestClient;
-exports.IdentityRestClient = IdentityRestClient;