@twin.org/immutable-proof-rest-client 0.0.2-next.1 → 0.0.2-next.3

package/dist/cjs/index.cjs

@@ -9,17 +9,17 @@ var web = require('@twin.org/web');
 /**
  * Client for performing immutable proof through to REST endpoints.
  */
-class ImmutableProofClient extends apiCore.BaseRestClient {
+class ImmutableProofRestClient extends apiCore.BaseRestClient {
     /**
      * Runtime name for the class.
      */
-    CLASS_NAME = "ImmutableProofClient";
+    static CLASS_NAME = "ImmutableProofRestClient";
     /**
-     * Create a new instance of ImmutableProofClient.
+     * Create a new instance of ImmutableProofRestClient.
      * @param config The configuration for the client.
      */
     constructor(config) {
-        super("ImmutableProofClient", config, "immutable-proof");
+        super("ImmutableProofRestClient", config, "immutable-proof");
     }
     /**
      * Create a new proof.
@@ -27,7 +27,7 @@ class ImmutableProofClient extends apiCore.BaseRestClient {
      * @returns The id of the new proof.
      */
     async create(document) {
-        core.Guards.object(this.CLASS_NAME, "document", document);
+        core.Guards.object(ImmutableProofRestClient.CLASS_NAME, "document", document);
         const response = await this.fetch("/", "POST", {
             body: {
                 document
@@ -42,7 +42,7 @@ class ImmutableProofClient extends apiCore.BaseRestClient {
      * @throws NotFoundError if the proof is not found.
      */
     async get(id) {
-        core.Guards.stringValue(this.CLASS_NAME, "id", id);
+        core.Guards.stringValue(ImmutableProofRestClient.CLASS_NAME, "id", id);
         const response = await this.fetch("/:id", "GET", {
             headers: {
                 [web.HeaderTypes.Accept]: web.MimeTypes.JsonLd
@@ -60,7 +60,7 @@ class ImmutableProofClient extends apiCore.BaseRestClient {
      * @throws NotFoundError if the proof is not found.
      */
     async verify(id) {
-        core.Guards.stringValue(this.CLASS_NAME, "id", id);
+        core.Guards.stringValue(ImmutableProofRestClient.CLASS_NAME, "id", id);
         const response = await this.fetch("/:id/verify", "GET", {
             headers: {
                 [web.HeaderTypes.Accept]: web.MimeTypes.JsonLd
@@ -78,8 +78,10 @@ class ImmutableProofClient extends apiCore.BaseRestClient {
      * @throws NotFoundError if the proof is not found.
      */
     async removeVerifiable(id) {
-        throw new core.NotSupportedError(this.CLASS_NAME, "removeVerifiable");
+        throw new core.NotSupportedError(ImmutableProofRestClient.CLASS_NAME, "notSupportedOnClient", {
+            methodName: "removeVerifiable"
+        });
     }
 }
 
-exports.ImmutableProofClient = ImmutableProofClient;
+exports.ImmutableProofRestClient = ImmutableProofRestClient;

package/dist/esm/index.mjs

@@ -7,17 +7,17 @@ import { HeaderTypes, MimeTypes } from '@twin.org/web';
 /**
  * Client for performing immutable proof through to REST endpoints.
  */
-class ImmutableProofClient extends BaseRestClient {
+class ImmutableProofRestClient extends BaseRestClient {
     /**
      * Runtime name for the class.
      */
-    CLASS_NAME = "ImmutableProofClient";
+    static CLASS_NAME = "ImmutableProofRestClient";
     /**
-     * Create a new instance of ImmutableProofClient.
+     * Create a new instance of ImmutableProofRestClient.
      * @param config The configuration for the client.
      */
     constructor(config) {
-        super("ImmutableProofClient", config, "immutable-proof");
+        super("ImmutableProofRestClient", config, "immutable-proof");
     }
     /**
      * Create a new proof.
@@ -25,7 +25,7 @@ class ImmutableProofClient extends BaseRestClient {
      * @returns The id of the new proof.
      */
     async create(document) {
-        Guards.object(this.CLASS_NAME, "document", document);
+        Guards.object(ImmutableProofRestClient.CLASS_NAME, "document", document);
         const response = await this.fetch("/", "POST", {
             body: {
                 document
@@ -40,7 +40,7 @@ class ImmutableProofClient extends BaseRestClient {
      * @throws NotFoundError if the proof is not found.
      */
     async get(id) {
-        Guards.stringValue(this.CLASS_NAME, "id", id);
+        Guards.stringValue(ImmutableProofRestClient.CLASS_NAME, "id", id);
         const response = await this.fetch("/:id", "GET", {
             headers: {
                 [HeaderTypes.Accept]: MimeTypes.JsonLd
@@ -58,7 +58,7 @@ class ImmutableProofClient extends BaseRestClient {
      * @throws NotFoundError if the proof is not found.
      */
     async verify(id) {
-        Guards.stringValue(this.CLASS_NAME, "id", id);
+        Guards.stringValue(ImmutableProofRestClient.CLASS_NAME, "id", id);
         const response = await this.fetch("/:id/verify", "GET", {
             headers: {
                 [HeaderTypes.Accept]: MimeTypes.JsonLd
@@ -76,8 +76,10 @@ class ImmutableProofClient extends BaseRestClient {
      * @throws NotFoundError if the proof is not found.
      */
     async removeVerifiable(id) {
-        throw new NotSupportedError(this.CLASS_NAME, "removeVerifiable");
+        throw new NotSupportedError(ImmutableProofRestClient.CLASS_NAME, "notSupportedOnClient", {
+            methodName: "removeVerifiable"
+        });
     }
 }
 
-export { ImmutableProofClient };
+export { ImmutableProofRestClient };

package/dist/types/{immutableProofClient.d.ts → immutableProofRestClient.d.ts}

@@ -5,13 +5,13 @@ import type { IImmutableProof, IImmutableProofComponent, IImmutableProofVerifica
 /**
  * Client for performing immutable proof through to REST endpoints.
  */
-export declare class ImmutableProofClient extends BaseRestClient implements IImmutableProofComponent {
+export declare class ImmutableProofRestClient extends BaseRestClient implements IImmutableProofComponent {
     /**
      * Runtime name for the class.
      */
-    readonly CLASS_NAME: string;
+    static readonly CLASS_NAME: string;
     /**
-     * Create a new instance of ImmutableProofClient.
+     * Create a new instance of ImmutableProofRestClient.
      * @param config The configuration for the client.
      */
     constructor(config: IBaseRestClientConfig);

package/dist/types/index.d.ts

@@ -1 +1 @@
-export * from "./immutableProofClient";
+export * from "./immutableProofRestClient";

package/docs/changelog.md

@@ -1,5 +1,33 @@
 # @twin.org/immutable-proof-rest-client - Changelog
 
+## [0.0.2-next.3](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-rest-client-v0.0.2-next.2...immutable-proof-rest-client-v0.0.2-next.3) (2025-10-09)
+
+
+### Features
+
+* add validate-locales ([d6a7c07](https://github.com/twinfoundation/immutable-proof/commit/d6a7c0794a1922981a42f56cc24724d7cee727f6))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/immutable-proof-models bumped from 0.0.2-next.2 to 0.0.2-next.3
+
+## [0.0.2-next.2](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-rest-client-v0.0.2-next.1...immutable-proof-rest-client-v0.0.2-next.2) (2025-08-29)
+
+
+### Features
+
+* eslint migration to flat config ([c8536f2](https://github.com/twinfoundation/immutable-proof/commit/c8536f219c7709c6c08b9266e537831f9054dda9))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/immutable-proof-models bumped from 0.0.2-next.1 to 0.0.2-next.2
+
 ## [0.0.2-next.1](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-rest-client-v0.0.2-next.0...immutable-proof-rest-client-v0.0.2-next.1) (2025-08-20)
 
 

package/docs/reference/classes/{ImmutableProofClient.md → ImmutableProofRestClient.md}

@@ -1,4 +1,4 @@
-# Class: ImmutableProofClient
+# Class: ImmutableProofRestClient
 
 Client for performing immutable proof through to REST endpoints.
 
@@ -14,9 +14,9 @@ Client for performing immutable proof through to REST endpoints.
 
 ### Constructor
 
-> **new ImmutableProofClient**(`config`): `ImmutableProofClient`
+> **new ImmutableProofRestClient**(`config`): `ImmutableProofRestClient`
 
-Create a new instance of ImmutableProofClient.
+Create a new instance of ImmutableProofRestClient.
 
 #### Parameters
 
@@ -28,7 +28,7 @@ The configuration for the client.
 
 #### Returns
 
-`ImmutableProofClient`
+`ImmutableProofRestClient`
 
 #### 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
-
-`IImmutableProofComponent.CLASS_NAME`
-
 ## Methods
 
 ### create()

package/docs/reference/index.md

@@ -2,4 +2,4 @@
 
 ## Classes
 
-- [ImmutableProofClient](classes/ImmutableProofClient.md)
+- [ImmutableProofRestClient](classes/ImmutableProofRestClient.md)

package/locales/en.json

@@ -1 +1,7 @@
-{}
+{
+	"error": {
+		"immutableProofRestClient": {
+			"notSupportedOnClient": "The method \"{methodName}\" is not supported on the REST client, it can only be used on a server side component"
+		}
+	}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/immutable-proof-rest-client",
-	"version": "0.0.2-next.1",
+	"version": "0.0.2-next.3",
 	"description": "Immutable Proof contract implementation which can connect to REST endpoints",
 	"repository": {
 		"type": "git",
@@ -19,7 +19,7 @@
 		"@twin.org/core": "next",
 		"@twin.org/data-json-ld": "next",
 		"@twin.org/entity": "next",
-		"@twin.org/immutable-proof-models": "0.0.2-next.1",
+		"@twin.org/immutable-proof-models": "0.0.2-next.3",
 		"@twin.org/nameof": "next",
 		"@twin.org/web": "next"
 	},
@@ -40,5 +40,17 @@
 		"dist/types",
 		"locales",
 		"docs"
-	]
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"immutable-proof"
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/immutable-proof/issues"
+	},
+	"homepage": "https://twindev.org"
 }