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

package/dist/cjs/index.cjs

@@ -11,17 +11,17 @@ var apiModels = require('@twin.org/api-models');
 /**
  * Client for performing identity through to REST endpoints.
  */
-class IdentityClient extends apiCore.BaseRestClient {
+class IdentityRestClient extends apiCore.BaseRestClient {
     /**
      * Runtime name for the class.
      */
-    CLASS_NAME = "IdentityClient";
+    static CLASS_NAME = "IdentityRestClient";
     /**
      * Create a new instance of IdentityClient.
      * @param config The configuration for the client.
      */
     constructor(config) {
-        super("IdentityClient", config, "identity");
+        super("IdentityRestClient", config, "identity");
     }
     /**
      * Create a new identity.
@@ -42,7 +42,7 @@ class IdentityClient extends apiCore.BaseRestClient {
      * @returns Nothing.
      */
     async identityRemove(identity) {
-        core.Guards.stringValue(this.CLASS_NAME, "identity", identity);
+        core.Guards.stringValue(IdentityRestClient.CLASS_NAME, "identity", identity);
         await this.fetch("/:identity", "DELETE", {
             pathParams: {
                 identity
@@ -59,8 +59,8 @@ class IdentityClient extends apiCore.BaseRestClient {
      * @throws NotSupportedError if the platform does not support multiple keys.
      */
     async verificationMethodCreate(identity, verificationMethodType, verificationMethodId) {
-        core.Guards.stringValue(this.CLASS_NAME, "identity", identity);
-        core.Guards.arrayOneOf(this.CLASS_NAME, "verificationMethodType", verificationMethodType, Object.values(standardsW3cDid.DidVerificationMethodType));
+        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
@@ -80,7 +80,7 @@ class IdentityClient extends apiCore.BaseRestClient {
      * @throws NotSupportedError if the platform does not support multiple revocable keys.
      */
     async verificationMethodRemove(verificationMethodId) {
-        core.Guards.stringValue(this.CLASS_NAME, "verificationMethodId", verificationMethodId);
+        core.Guards.stringValue(IdentityRestClient.CLASS_NAME, "verificationMethodId", verificationMethodId);
         const idParts = identityModels.DocumentHelper.parseId(verificationMethodId);
         await this.fetch("/:identity/verification-method/:verificationMethodId", "DELETE", {
             pathParams: {
@@ -99,19 +99,19 @@ class IdentityClient extends apiCore.BaseRestClient {
      * @throws NotFoundError if the id can not be resolved.
      */
     async serviceCreate(identity, serviceId, serviceType, serviceEndpoint) {
-        core.Guards.stringValue(this.CLASS_NAME, "identity", identity);
-        core.Guards.stringValue(this.CLASS_NAME, "serviceId", serviceId);
+        core.Guards.stringValue(IdentityRestClient.CLASS_NAME, "identity", identity);
+        core.Guards.stringValue(IdentityRestClient.CLASS_NAME, "serviceId", serviceId);
         if (core.Is.array(serviceType)) {
-            core.Guards.arrayValue(this.CLASS_NAME, "serviceType", serviceType);
+            core.Guards.arrayValue(IdentityRestClient.CLASS_NAME, "serviceType", serviceType);
         }
         else {
-            core.Guards.stringValue(this.CLASS_NAME, "serviceType", serviceType);
+            core.Guards.stringValue(IdentityRestClient.CLASS_NAME, "serviceType", serviceType);
         }
         if (core.Is.array(serviceEndpoint)) {
-            core.Guards.arrayValue(this.CLASS_NAME, "serviceEndpoint", serviceEndpoint);
+            core.Guards.arrayValue(IdentityRestClient.CLASS_NAME, "serviceEndpoint", serviceEndpoint);
         }
         else {
-            core.Guards.stringValue(this.CLASS_NAME, "serviceEndpoint", serviceEndpoint);
+            core.Guards.stringValue(IdentityRestClient.CLASS_NAME, "serviceEndpoint", serviceEndpoint);
         }
         const response = await this.fetch("/:identity/service", "POST", {
             pathParams: {
@@ -132,7 +132,7 @@ class IdentityClient extends apiCore.BaseRestClient {
      * @throws NotFoundError if the id can not be resolved.
      */
     async serviceRemove(serviceId) {
-        core.Guards.stringValue(this.CLASS_NAME, "serviceId", serviceId);
+        core.Guards.stringValue(IdentityRestClient.CLASS_NAME, "serviceId", serviceId);
         const idParts = identityModels.DocumentHelper.parseId(serviceId);
         await this.fetch("/:identity/service/:serviceId", "DELETE", {
             pathParams: {
@@ -153,10 +153,10 @@ class IdentityClient extends apiCore.BaseRestClient {
      * @throws NotFoundError if the id can not be resolved.
      */
     async verifiableCredentialCreate(verificationMethodId, id, subject, options) {
-        core.Guards.stringValue(this.CLASS_NAME, "verificationMethodId", verificationMethodId);
-        core.Guards.object(this.CLASS_NAME, "subject", subject);
+        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(this.CLASS_NAME, "options.revocationIndex", 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", {
@@ -179,7 +179,7 @@ class IdentityClient extends apiCore.BaseRestClient {
      * @returns The credential stored in the jwt and the revocation status.
      */
     async verifiableCredentialVerify(credentialJwt) {
-        core.Guards.stringValue(this.CLASS_NAME, "credentialJwt", credentialJwt);
+        core.Guards.stringValue(IdentityRestClient.CLASS_NAME, "credentialJwt", credentialJwt);
         const response = await this.fetch("/verifiable-credential/verify", "POST", {
             query: {
                 jwt: credentialJwt
@@ -194,8 +194,8 @@ class IdentityClient extends apiCore.BaseRestClient {
      * @returns Nothing.
      */
     async verifiableCredentialRevoke(issuerId, credentialIndex) {
-        core.Guards.stringValue(this.CLASS_NAME, "issuerId", issuerId);
-        core.Guards.integer(this.CLASS_NAME, "credentialIndex", 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,
@@ -210,8 +210,8 @@ class IdentityClient extends apiCore.BaseRestClient {
      * @returns Nothing.
      */
     async verifiableCredentialUnrevoke(issuerId, credentialIndex) {
-        core.Guards.stringValue(this.CLASS_NAME, "issuerId", issuerId);
-        core.Guards.integer(this.CLASS_NAME, "credentialIndex", 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,
@@ -231,16 +231,16 @@ class IdentityClient extends apiCore.BaseRestClient {
      * @throws NotFoundError if the id can not be resolved.
      */
     async verifiablePresentationCreate(verificationMethodId, presentationId, contexts, types, verifiableCredentials, expiresInMinutes) {
-        core.Guards.stringValue(this.CLASS_NAME, "verificationMethodId", verificationMethodId);
+        core.Guards.stringValue(IdentityRestClient.CLASS_NAME, "verificationMethodId", verificationMethodId);
         if (core.Is.array(types)) {
-            core.Guards.arrayValue(this.CLASS_NAME, "types", types);
+            core.Guards.arrayValue(IdentityRestClient.CLASS_NAME, "types", types);
         }
         else if (core.Is.string(types)) {
-            core.Guards.stringValue(this.CLASS_NAME, "types", types);
+            core.Guards.stringValue(IdentityRestClient.CLASS_NAME, "types", types);
         }
-        core.Guards.arrayValue(this.CLASS_NAME, "verifiableCredentials", verifiableCredentials);
+        core.Guards.arrayValue(IdentityRestClient.CLASS_NAME, "verifiableCredentials", verifiableCredentials);
         if (!core.Is.undefined(expiresInMinutes)) {
-            core.Guards.integer(this.CLASS_NAME, "expiresInMinutes", expiresInMinutes);
+            core.Guards.integer(IdentityRestClient.CLASS_NAME, "expiresInMinutes", expiresInMinutes);
         }
         const idParts = identityModels.DocumentHelper.parseId(verificationMethodId);
         const response = await this.fetch("/:identity/verifiable-presentation", "POST", {
@@ -264,7 +264,7 @@ class IdentityClient extends apiCore.BaseRestClient {
      * @returns The presentation stored in the jwt and the revocation status.
      */
     async verifiablePresentationVerify(presentationJwt) {
-        core.Guards.stringValue(this.CLASS_NAME, "presentationJwt", presentationJwt);
+        core.Guards.stringValue(IdentityRestClient.CLASS_NAME, "presentationJwt", presentationJwt);
         const response = await this.fetch("/verifiable-presentation/verify", "POST", {
             query: {
                 jwt: presentationJwt
@@ -280,9 +280,9 @@ class IdentityClient extends apiCore.BaseRestClient {
      * @returns The proof.
      */
     async proofCreate(verificationMethodId, proofType, unsecureDocument) {
-        core.Guards.stringValue(this.CLASS_NAME, "verificationMethodId", verificationMethodId);
-        core.Guards.arrayOneOf(this.CLASS_NAME, "proofType", proofType, Object.values(standardsW3cDid.ProofTypes));
-        core.Guards.object(this.CLASS_NAME, "unsecureDocument", 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: {
@@ -303,9 +303,9 @@ class IdentityClient extends apiCore.BaseRestClient {
      * @returns True if the proof is verified.
      */
     async proofVerify(document, proof) {
-        core.Guards.object(this.CLASS_NAME, "document", document);
-        core.Guards.object(this.CLASS_NAME, "proof", proof);
-        core.Guards.stringValue(this.CLASS_NAME, "proof.verificationMethod", proof.verificationMethod);
+        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,
@@ -321,17 +321,17 @@ class IdentityClient extends apiCore.BaseRestClient {
 /**
  * Client for performing identity through to REST endpoints.
  */
-class IdentityProfileClient extends apiCore.BaseRestClient {
+class IdentityProfileRestClient extends apiCore.BaseRestClient {
     /**
      * Runtime name for the class.
      */
-    CLASS_NAME = "IdentityProfileClient";
+    static CLASS_NAME = "IdentityProfileRestClient";
     /**
      * Create a new instance of IdentityClient.
      * @param config The configuration for the client.
      */
     constructor(config) {
-        super("IdentityProfileClient", config, "identity/profile");
+        super("IdentityProfileRestClient", config, "identity/profile");
     }
     /**
      * Create the profile properties for an identity.
@@ -373,7 +373,7 @@ class IdentityProfileClient extends apiCore.BaseRestClient {
      * @returns The items properties.
      */
     async getPublic(identity, propertyNames) {
-        core.Guards.string(this.CLASS_NAME, "identity", identity);
+        core.Guards.string(IdentityProfileRestClient.CLASS_NAME, "identity", identity);
         const response = await this.fetch("/:identity/public", "GET", {
             pathParams: {
                 identity
@@ -410,10 +410,10 @@ class IdentityProfileClient extends apiCore.BaseRestClient {
      * @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 pageSize The maximum number of items in a page.
+     * @param limit The maximum number of items in a page.
      * @returns The list of items and cursor for paging.
      */
-    async list(publicFilters, publicPropertyNames, cursor, pageSize) {
+    async list(publicFilters, publicPropertyNames, cursor, limit) {
         const response = await this.fetch("/query", "GET", {
             query: {
                 publicFilters: apiModels.HttpParameterHelper.arrayToString(
@@ -421,7 +421,7 @@ class IdentityProfileClient extends apiCore.BaseRestClient {
                 publicFilters?.map(f => `${f.propertyName}:${f.propertyValue}`)),
                 publicPropertyNames: apiModels.HttpParameterHelper.arrayToString(publicPropertyNames),
                 cursor,
-                pageSize
+                limit: core.Coerce.string(limit)
             }
         });
         return {
@@ -436,17 +436,17 @@ class IdentityProfileClient extends apiCore.BaseRestClient {
 /**
  * Client for performing identity through to REST endpoints.
  */
-class IdentityResolverClient extends apiCore.BaseRestClient {
+class IdentityResolverRestClient extends apiCore.BaseRestClient {
     /**
      * Runtime name for the class.
      */
-    CLASS_NAME = "IdentityResolverClient";
+    static CLASS_NAME = "IdentityResolverRestClient";
     /**
      * Create a new instance of IdentityClient.
      * @param config The configuration for the client.
      */
     constructor(config) {
-        super("IdentityResolverClient", config, "identity");
+        super("IdentityResolverRestClient", config, "identity");
     }
     /**
      * Resolve an identity.
@@ -454,7 +454,7 @@ class IdentityResolverClient extends apiCore.BaseRestClient {
      * @returns The resolved document.
      */
     async identityResolve(documentId) {
-        core.Urn.guard(this.CLASS_NAME, "documentId", documentId);
+        core.Urn.guard(IdentityResolverRestClient.CLASS_NAME, "documentId", documentId);
         const response = await this.fetch("/:identity", "GET", {
             pathParams: {
                 identity: documentId
@@ -464,6 +464,6 @@ class IdentityResolverClient extends apiCore.BaseRestClient {
     }
 }
 
-exports.IdentityClient = IdentityClient;
-exports.IdentityProfileClient = IdentityProfileClient;
-exports.IdentityResolverClient = IdentityResolverClient;
+exports.IdentityProfileRestClient = IdentityProfileRestClient;
+exports.IdentityResolverRestClient = IdentityResolverRestClient;
+exports.IdentityRestClient = IdentityRestClient;

package/dist/esm/index.mjs

@@ -1,5 +1,5 @@
 import { BaseRestClient } from '@twin.org/api-core';
-import { Guards, Is, Urn } from '@twin.org/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';
@@ -9,17 +9,17 @@ import { HttpParameterHelper } from '@twin.org/api-models';
 /**
  * Client for performing identity through to REST endpoints.
  */
-class IdentityClient extends BaseRestClient {
+class IdentityRestClient extends BaseRestClient {
     /**
      * Runtime name for the class.
      */
-    CLASS_NAME = "IdentityClient";
+    static CLASS_NAME = "IdentityRestClient";
     /**
      * Create a new instance of IdentityClient.
      * @param config The configuration for the client.
      */
     constructor(config) {
-        super("IdentityClient", config, "identity");
+        super("IdentityRestClient", config, "identity");
     }
     /**
      * Create a new identity.
@@ -40,7 +40,7 @@ class IdentityClient extends BaseRestClient {
      * @returns Nothing.
      */
     async identityRemove(identity) {
-        Guards.stringValue(this.CLASS_NAME, "identity", identity);
+        Guards.stringValue(IdentityRestClient.CLASS_NAME, "identity", identity);
         await this.fetch("/:identity", "DELETE", {
             pathParams: {
                 identity
@@ -57,8 +57,8 @@ class IdentityClient extends BaseRestClient {
      * @throws NotSupportedError if the platform does not support multiple keys.
      */
     async verificationMethodCreate(identity, verificationMethodType, verificationMethodId) {
-        Guards.stringValue(this.CLASS_NAME, "identity", identity);
-        Guards.arrayOneOf(this.CLASS_NAME, "verificationMethodType", verificationMethodType, Object.values(DidVerificationMethodType));
+        Guards.stringValue(IdentityRestClient.CLASS_NAME, "identity", identity);
+        Guards.arrayOneOf(IdentityRestClient.CLASS_NAME, "verificationMethodType", verificationMethodType, Object.values(DidVerificationMethodType));
         const response = await this.fetch("/:identity/verification-method", "POST", {
             pathParams: {
                 identity
@@ -78,7 +78,7 @@ class IdentityClient extends BaseRestClient {
      * @throws NotSupportedError if the platform does not support multiple revocable keys.
      */
     async verificationMethodRemove(verificationMethodId) {
-        Guards.stringValue(this.CLASS_NAME, "verificationMethodId", verificationMethodId);
+        Guards.stringValue(IdentityRestClient.CLASS_NAME, "verificationMethodId", verificationMethodId);
         const idParts = DocumentHelper.parseId(verificationMethodId);
         await this.fetch("/:identity/verification-method/:verificationMethodId", "DELETE", {
             pathParams: {
@@ -97,19 +97,19 @@ class IdentityClient extends BaseRestClient {
      * @throws NotFoundError if the id can not be resolved.
      */
     async serviceCreate(identity, serviceId, serviceType, serviceEndpoint) {
-        Guards.stringValue(this.CLASS_NAME, "identity", identity);
-        Guards.stringValue(this.CLASS_NAME, "serviceId", serviceId);
+        Guards.stringValue(IdentityRestClient.CLASS_NAME, "identity", identity);
+        Guards.stringValue(IdentityRestClient.CLASS_NAME, "serviceId", serviceId);
         if (Is.array(serviceType)) {
-            Guards.arrayValue(this.CLASS_NAME, "serviceType", serviceType);
+            Guards.arrayValue(IdentityRestClient.CLASS_NAME, "serviceType", serviceType);
         }
         else {
-            Guards.stringValue(this.CLASS_NAME, "serviceType", serviceType);
+            Guards.stringValue(IdentityRestClient.CLASS_NAME, "serviceType", serviceType);
         }
         if (Is.array(serviceEndpoint)) {
-            Guards.arrayValue(this.CLASS_NAME, "serviceEndpoint", serviceEndpoint);
+            Guards.arrayValue(IdentityRestClient.CLASS_NAME, "serviceEndpoint", serviceEndpoint);
         }
         else {
-            Guards.stringValue(this.CLASS_NAME, "serviceEndpoint", serviceEndpoint);
+            Guards.stringValue(IdentityRestClient.CLASS_NAME, "serviceEndpoint", serviceEndpoint);
         }
         const response = await this.fetch("/:identity/service", "POST", {
             pathParams: {
@@ -130,7 +130,7 @@ class IdentityClient extends BaseRestClient {
      * @throws NotFoundError if the id can not be resolved.
      */
     async serviceRemove(serviceId) {
-        Guards.stringValue(this.CLASS_NAME, "serviceId", serviceId);
+        Guards.stringValue(IdentityRestClient.CLASS_NAME, "serviceId", serviceId);
         const idParts = DocumentHelper.parseId(serviceId);
         await this.fetch("/:identity/service/:serviceId", "DELETE", {
             pathParams: {
@@ -151,10 +151,10 @@ class IdentityClient extends BaseRestClient {
      * @throws NotFoundError if the id can not be resolved.
      */
     async verifiableCredentialCreate(verificationMethodId, id, subject, options) {
-        Guards.stringValue(this.CLASS_NAME, "verificationMethodId", verificationMethodId);
-        Guards.object(this.CLASS_NAME, "subject", subject);
+        Guards.stringValue(IdentityRestClient.CLASS_NAME, "verificationMethodId", verificationMethodId);
+        Guards.object(IdentityRestClient.CLASS_NAME, "subject", subject);
         if (!Is.undefined(options?.revocationIndex)) {
-            Guards.number(this.CLASS_NAME, "options.revocationIndex", options?.revocationIndex);
+            Guards.number(IdentityRestClient.CLASS_NAME, "options.revocationIndex", options?.revocationIndex);
         }
         const idParts = DocumentHelper.parseId(verificationMethodId);
         const response = await this.fetch("/:identity/verifiable-credential", "POST", {
@@ -177,7 +177,7 @@ class IdentityClient extends BaseRestClient {
      * @returns The credential stored in the jwt and the revocation status.
      */
     async verifiableCredentialVerify(credentialJwt) {
-        Guards.stringValue(this.CLASS_NAME, "credentialJwt", credentialJwt);
+        Guards.stringValue(IdentityRestClient.CLASS_NAME, "credentialJwt", credentialJwt);
         const response = await this.fetch("/verifiable-credential/verify", "POST", {
             query: {
                 jwt: credentialJwt
@@ -192,8 +192,8 @@ class IdentityClient extends BaseRestClient {
      * @returns Nothing.
      */
     async verifiableCredentialRevoke(issuerId, credentialIndex) {
-        Guards.stringValue(this.CLASS_NAME, "issuerId", issuerId);
-        Guards.integer(this.CLASS_NAME, "credentialIndex", credentialIndex);
+        Guards.stringValue(IdentityRestClient.CLASS_NAME, "issuerId", issuerId);
+        Guards.integer(IdentityRestClient.CLASS_NAME, "credentialIndex", credentialIndex);
         await this.fetch("/:identity/verifiable-credential/revoke/:revocationIndex", "GET", {
             pathParams: {
                 identity: issuerId,
@@ -208,8 +208,8 @@ class IdentityClient extends BaseRestClient {
      * @returns Nothing.
      */
     async verifiableCredentialUnrevoke(issuerId, credentialIndex) {
-        Guards.stringValue(this.CLASS_NAME, "issuerId", issuerId);
-        Guards.integer(this.CLASS_NAME, "credentialIndex", credentialIndex);
+        Guards.stringValue(IdentityRestClient.CLASS_NAME, "issuerId", issuerId);
+        Guards.integer(IdentityRestClient.CLASS_NAME, "credentialIndex", credentialIndex);
         await this.fetch("/:identity/verifiable-credential/unrevoke/:revocationIndex", "GET", {
             pathParams: {
                 identity: issuerId,
@@ -229,16 +229,16 @@ class IdentityClient extends BaseRestClient {
      * @throws NotFoundError if the id can not be resolved.
      */
     async verifiablePresentationCreate(verificationMethodId, presentationId, contexts, types, verifiableCredentials, expiresInMinutes) {
-        Guards.stringValue(this.CLASS_NAME, "verificationMethodId", verificationMethodId);
+        Guards.stringValue(IdentityRestClient.CLASS_NAME, "verificationMethodId", verificationMethodId);
         if (Is.array(types)) {
-            Guards.arrayValue(this.CLASS_NAME, "types", types);
+            Guards.arrayValue(IdentityRestClient.CLASS_NAME, "types", types);
         }
         else if (Is.string(types)) {
-            Guards.stringValue(this.CLASS_NAME, "types", types);
+            Guards.stringValue(IdentityRestClient.CLASS_NAME, "types", types);
         }
-        Guards.arrayValue(this.CLASS_NAME, "verifiableCredentials", verifiableCredentials);
+        Guards.arrayValue(IdentityRestClient.CLASS_NAME, "verifiableCredentials", verifiableCredentials);
         if (!Is.undefined(expiresInMinutes)) {
-            Guards.integer(this.CLASS_NAME, "expiresInMinutes", expiresInMinutes);
+            Guards.integer(IdentityRestClient.CLASS_NAME, "expiresInMinutes", expiresInMinutes);
         }
         const idParts = DocumentHelper.parseId(verificationMethodId);
         const response = await this.fetch("/:identity/verifiable-presentation", "POST", {
@@ -262,7 +262,7 @@ class IdentityClient extends BaseRestClient {
      * @returns The presentation stored in the jwt and the revocation status.
      */
     async verifiablePresentationVerify(presentationJwt) {
-        Guards.stringValue(this.CLASS_NAME, "presentationJwt", presentationJwt);
+        Guards.stringValue(IdentityRestClient.CLASS_NAME, "presentationJwt", presentationJwt);
         const response = await this.fetch("/verifiable-presentation/verify", "POST", {
             query: {
                 jwt: presentationJwt
@@ -278,9 +278,9 @@ class IdentityClient extends BaseRestClient {
      * @returns The proof.
      */
     async proofCreate(verificationMethodId, proofType, unsecureDocument) {
-        Guards.stringValue(this.CLASS_NAME, "verificationMethodId", verificationMethodId);
-        Guards.arrayOneOf(this.CLASS_NAME, "proofType", proofType, Object.values(ProofTypes));
-        Guards.object(this.CLASS_NAME, "unsecureDocument", unsecureDocument);
+        Guards.stringValue(IdentityRestClient.CLASS_NAME, "verificationMethodId", verificationMethodId);
+        Guards.arrayOneOf(IdentityRestClient.CLASS_NAME, "proofType", proofType, Object.values(ProofTypes));
+        Guards.object(IdentityRestClient.CLASS_NAME, "unsecureDocument", unsecureDocument);
         const idParts = DocumentHelper.parseId(verificationMethodId);
         const response = await this.fetch("/:identity/proof", "POST", {
             pathParams: {
@@ -301,9 +301,9 @@ class IdentityClient extends BaseRestClient {
      * @returns True if the proof is verified.
      */
     async proofVerify(document, proof) {
-        Guards.object(this.CLASS_NAME, "document", document);
-        Guards.object(this.CLASS_NAME, "proof", proof);
-        Guards.stringValue(this.CLASS_NAME, "proof.verificationMethod", proof.verificationMethod);
+        Guards.object(IdentityRestClient.CLASS_NAME, "document", document);
+        Guards.object(IdentityRestClient.CLASS_NAME, "proof", proof);
+        Guards.stringValue(IdentityRestClient.CLASS_NAME, "proof.verificationMethod", proof.verificationMethod);
         const response = await this.fetch("/proof/verify", "POST", {
             body: {
                 document,
@@ -319,17 +319,17 @@ class IdentityClient extends BaseRestClient {
 /**
  * Client for performing identity through to REST endpoints.
  */
-class IdentityProfileClient extends BaseRestClient {
+class IdentityProfileRestClient extends BaseRestClient {
     /**
      * Runtime name for the class.
      */
-    CLASS_NAME = "IdentityProfileClient";
+    static CLASS_NAME = "IdentityProfileRestClient";
     /**
      * Create a new instance of IdentityClient.
      * @param config The configuration for the client.
      */
     constructor(config) {
-        super("IdentityProfileClient", config, "identity/profile");
+        super("IdentityProfileRestClient", config, "identity/profile");
     }
     /**
      * Create the profile properties for an identity.
@@ -371,7 +371,7 @@ class IdentityProfileClient extends BaseRestClient {
      * @returns The items properties.
      */
     async getPublic(identity, propertyNames) {
-        Guards.string(this.CLASS_NAME, "identity", identity);
+        Guards.string(IdentityProfileRestClient.CLASS_NAME, "identity", identity);
         const response = await this.fetch("/:identity/public", "GET", {
             pathParams: {
                 identity
@@ -408,10 +408,10 @@ class IdentityProfileClient extends BaseRestClient {
      * @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 pageSize The maximum number of items in a page.
+     * @param limit The maximum number of items in a page.
      * @returns The list of items and cursor for paging.
      */
-    async list(publicFilters, publicPropertyNames, cursor, pageSize) {
+    async list(publicFilters, publicPropertyNames, cursor, limit) {
         const response = await this.fetch("/query", "GET", {
             query: {
                 publicFilters: HttpParameterHelper.arrayToString(
@@ -419,7 +419,7 @@ class IdentityProfileClient extends BaseRestClient {
                 publicFilters?.map(f => `${f.propertyName}:${f.propertyValue}`)),
                 publicPropertyNames: HttpParameterHelper.arrayToString(publicPropertyNames),
                 cursor,
-                pageSize
+                limit: Coerce.string(limit)
             }
         });
         return {
@@ -434,17 +434,17 @@ class IdentityProfileClient extends BaseRestClient {
 /**
  * Client for performing identity through to REST endpoints.
  */
-class IdentityResolverClient extends BaseRestClient {
+class IdentityResolverRestClient extends BaseRestClient {
     /**
      * Runtime name for the class.
      */
-    CLASS_NAME = "IdentityResolverClient";
+    static CLASS_NAME = "IdentityResolverRestClient";
     /**
      * Create a new instance of IdentityClient.
      * @param config The configuration for the client.
      */
     constructor(config) {
-        super("IdentityResolverClient", config, "identity");
+        super("IdentityResolverRestClient", config, "identity");
     }
     /**
      * Resolve an identity.
@@ -452,7 +452,7 @@ class IdentityResolverClient extends BaseRestClient {
      * @returns The resolved document.
      */
     async identityResolve(documentId) {
-        Urn.guard(this.CLASS_NAME, "documentId", documentId);
+        Urn.guard(IdentityResolverRestClient.CLASS_NAME, "documentId", documentId);
         const response = await this.fetch("/:identity", "GET", {
             pathParams: {
                 identity: documentId
@@ -462,4 +462,4 @@ class IdentityResolverClient extends BaseRestClient {
     }
 }
 
-export { IdentityClient, IdentityProfileClient, IdentityResolverClient };
+export { IdentityProfileRestClient, IdentityResolverRestClient, IdentityRestClient };

package/dist/types/{identityProfileClient.d.ts → identityProfileRestClient.d.ts}

@@ -5,11 +5,11 @@ import type { IIdentityProfileComponent } from "@twin.org/identity-models";
 /**
  * Client for performing identity through to REST endpoints.
  */
-export declare class IdentityProfileClient<T extends IJsonLdDocument = IJsonLdDocument, U extends IJsonLdDocument = IJsonLdDocument> extends BaseRestClient implements IIdentityProfileComponent<T, U> {
+export declare class IdentityProfileRestClient<T extends IJsonLdDocument = IJsonLdDocument, U extends IJsonLdDocument = IJsonLdDocument> extends BaseRestClient implements IIdentityProfileComponent<T, U> {
     /**
      * Runtime name for the class.
      */
-    readonly CLASS_NAME: string;
+    static readonly CLASS_NAME: string;
     /**
      * Create a new instance of IdentityClient.
      * @param config The configuration for the client.
@@ -57,13 +57,13 @@ export declare class IdentityProfileClient<T extends IJsonLdDocument = IJsonLdDo
      * @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 pageSize The maximum number of items in a page.
+     * @param limit The maximum number of items in a page.
      * @returns The list of items and cursor for paging.
      */
     list(publicFilters?: {
         propertyName: string;
         propertyValue: unknown;
-    }[], publicPropertyNames?: (keyof T)[], cursor?: string, pageSize?: number): Promise<{
+    }[], publicPropertyNames?: (keyof T)[], cursor?: string, limit?: number): Promise<{
         /**
          * The identities.
          */

package/dist/types/{identityResolverClient.d.ts → identityResolverRestClient.d.ts}

@@ -5,11 +5,11 @@ import type { IDidDocument } from "@twin.org/standards-w3c-did";
 /**
  * Client for performing identity through to REST endpoints.
  */
-export declare class IdentityResolverClient extends BaseRestClient implements IIdentityResolverComponent {
+export declare class IdentityResolverRestClient extends BaseRestClient implements IIdentityResolverComponent {
     /**
      * Runtime name for the class.
      */
-    readonly CLASS_NAME: string;
+    static readonly CLASS_NAME: string;
     /**
      * Create a new instance of IdentityClient.
      * @param config The configuration for the client.

package/dist/types/{identityClient.d.ts → identityRestClient.d.ts}

@@ -6,11 +6,11 @@ import { DidVerificationMethodType, type IDidDocument, type IDidDocumentVerifica
 /**
  * Client for performing identity through to REST endpoints.
  */
-export declare class IdentityClient extends BaseRestClient implements IIdentityComponent {
+export declare class IdentityRestClient extends BaseRestClient implements IIdentityComponent {
     /**
      * Runtime name for the class.
      */
-    readonly CLASS_NAME: string;
+    static readonly CLASS_NAME: string;
     /**
      * Create a new instance of IdentityClient.
      * @param config The configuration for the client.

package/dist/types/index.d.ts

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

package/docs/changelog.md

@@ -1,5 +1,33 @@
 # @twin.org/identity-rest-client - Changelog
 
+## [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)
+
+
+### Features
+
+* add validate-locales ([04d74b4](https://github.com/twinfoundation/identity/commit/04d74b4d1ebe42672e8ca75a7bdb8e3556afd0be))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/identity-models bumped from 0.0.2-next.8 to 0.0.2-next.9
+
+## [0.0.2-next.8](https://github.com/twinfoundation/identity/compare/identity-rest-client-v0.0.2-next.7...identity-rest-client-v0.0.2-next.8) (2025-09-25)
+
+
+### 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.7 to 0.0.2-next.8
+
 ## [0.0.2-next.7](https://github.com/twinfoundation/identity/compare/identity-rest-client-v0.0.2-next.6...identity-rest-client-v0.0.2-next.7) (2025-09-23)
 
 

package/docs/reference/classes/{IdentityProfileClient.md → IdentityProfileRestClient.md}

@@ -1,4 +1,4 @@
-# Class: IdentityProfileClient\<T, U\>
+# Class: IdentityProfileRestClient\<T, U\>
 
 Client for performing identity through to REST endpoints.
 
@@ -24,7 +24,7 @@ Client for performing identity through to REST endpoints.
 
 ### Constructor
 
-> **new IdentityProfileClient**\<`T`, `U`\>(`config`): `IdentityProfileClient`\<`T`, `U`\>
+> **new IdentityProfileRestClient**\<`T`, `U`\>(`config`): `IdentityProfileRestClient`\<`T`, `U`\>
 
 Create a new instance of IdentityClient.
 
@@ -38,7 +38,7 @@ The configuration for the client.
 
 #### Returns
 
-`IdentityProfileClient`\<`T`, `U`\>
+`IdentityProfileRestClient`\<`T`, `U`\>
 
 #### Overrides
 
@@ -48,14 +48,10 @@ The configuration for the client.
 
 ### CLASS\_NAME
 
-> `readonly` **CLASS\_NAME**: `string`
+> `readonly` `static` **CLASS\_NAME**: `string`
 
 Runtime name for the class.
 
-#### Implementation of
-
-`IIdentityProfileComponent.CLASS_NAME`
-
 ## Methods
 
 ### create()
@@ -206,7 +202,7 @@ Nothing.
 
 ### list()
 
-> **list**(`publicFilters?`, `publicPropertyNames?`, `cursor?`, `pageSize?`): `Promise`\<\{ `items`: `object`[]; `cursor?`: `string`; \}\>
+> **list**(`publicFilters?`, `publicPropertyNames?`, `cursor?`, `limit?`): `Promise`\<\{ `items`: `object`[]; `cursor?`: `string`; \}\>
 
 Get a list of the requested identities.
 
@@ -230,7 +226,7 @@ The public properties to get for the profile, defaults to all.
 
 The cursor for paged requests.
 
-##### pageSize?
+##### limit?
 
 `number`
 

package/docs/reference/classes/{IdentityResolverClient.md → IdentityResolverRestClient.md}

@@ -1,4 +1,4 @@
-# Class: IdentityResolverClient
+# Class: IdentityResolverRestClient
 
 Client for performing identity through to REST endpoints.
 
@@ -14,7 +14,7 @@ Client for performing identity through to REST endpoints.
 
 ### Constructor
 
-> **new IdentityResolverClient**(`config`): `IdentityResolverClient`
+> **new IdentityResolverRestClient**(`config`): `IdentityResolverRestClient`
 
 Create a new instance of IdentityClient.
 
@@ -28,7 +28,7 @@ The configuration for the client.
 
 #### Returns
 
-`IdentityResolverClient`
+`IdentityResolverRestClient`
 
 #### Overrides
 
@@ -38,14 +38,10 @@ The configuration for the client.
 
 ### CLASS\_NAME
 
-> `readonly` **CLASS\_NAME**: `string`
+> `readonly` `static` **CLASS\_NAME**: `string`
 
 Runtime name for the class.
 
-#### Implementation of
-
-`IIdentityResolverComponent.CLASS_NAME`
-
 ## Methods
 
 ### identityResolve()

package/docs/reference/classes/{IdentityClient.md → IdentityRestClient.md}

@@ -1,4 +1,4 @@
-# Class: IdentityClient
+# Class: IdentityRestClient
 
 Client for performing identity through to REST endpoints.
 
@@ -14,7 +14,7 @@ Client for performing identity through to REST endpoints.
 
 ### Constructor
 
-> **new IdentityClient**(`config`): `IdentityClient`
+> **new IdentityRestClient**(`config`): `IdentityRestClient`
 
 Create a new instance of IdentityClient.
 
@@ -28,7 +28,7 @@ The configuration for the client.
 
 #### Returns
 
-`IdentityClient`
+`IdentityRestClient`
 
 #### Overrides
 
@@ -38,14 +38,10 @@ The configuration for the client.
 
 ### CLASS\_NAME
 
-> `readonly` **CLASS\_NAME**: `string`
+> `readonly` `static` **CLASS\_NAME**: `string`
 
 Runtime name for the class.
 
-#### Implementation of
-
-`IIdentityComponent.CLASS_NAME`
-
 ## Methods
 
 ### identityCreate()

package/docs/reference/index.md

@@ -2,6 +2,6 @@
 
 ## Classes
 
-- [IdentityClient](classes/IdentityClient.md)
-- [IdentityProfileClient](classes/IdentityProfileClient.md)
-- [IdentityResolverClient](classes/IdentityResolverClient.md)
+- [IdentityProfileRestClient](classes/IdentityProfileRestClient.md)
+- [IdentityResolverRestClient](classes/IdentityResolverRestClient.md)
+- [IdentityRestClient](classes/IdentityRestClient.md)

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/identity-rest-client",
-	"version": "0.0.2-next.7",
+	"version": "0.0.2-next.9",
 	"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.7",
+		"@twin.org/identity-models": "0.0.2-next.9",
 		"@twin.org/nameof": "next",
 		"@twin.org/standards-w3c-did": "next"
 	},
@@ -41,5 +41,20 @@
 		"dist/types",
 		"locales",
 		"docs"
-	]
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"identity",
+		"did",
+		"credentials",
+		"authentication"
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/identity/issues"
+	},
+	"homepage": "https://twindev.org"
 }