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

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

@@ -1,23 +1,29 @@
-import { BaseRestClient } from '@twin.org/api-core';
-import { Guards, NotSupportedError } from '@twin.org/core';
-import { HeaderTypes, MimeTypes } from '@twin.org/web';
-
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
+import { BaseRestClient } from "@twin.org/api-core";
+import { Guards, NotSupportedError } from "@twin.org/core";
+import { HeaderTypes, MimeTypes } from "@twin.org/web";
 /**
  * Client for performing immutable proof through to REST endpoints.
  */
-class ImmutableProofClient extends BaseRestClient {
+export 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");
+    }
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return ImmutableProofRestClient.CLASS_NAME;
     }
     /**
      * Create a new proof.
@@ -25,7 +31,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 +46,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 +64,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 +82,9 @@ 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 };
+//# sourceMappingURL=immutableProofRestClient.js.map

package/dist/es/immutableProofRestClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"immutableProofRestClient.js","sourceRoot":"","sources":["../../src/immutableProofRestClient.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEpD,OAAO,EAAE,MAAM,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAa3D,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAEvD;;GAEG;AACH,MAAM,OAAO,wBAAyB,SAAQ,cAAc;IAC3D;;OAEG;IACI,MAAM,CAAU,UAAU,8BAA8C;IAE/E;;;OAGG;IACH,YAAY,MAA6B;QACxC,KAAK,6BAAqC,MAAM,EAAE,iBAAiB,CAAC,CAAC;IACtE,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,wBAAwB,CAAC,UAAU,CAAC;IAC5C,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,MAAM,CAAC,QAA2B;QAC9C,MAAM,CAAC,MAAM,CAAC,wBAAwB,CAAC,UAAU,cAAoB,QAAQ,CAAC,CAAC;QAE/E,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAiD,GAAG,EAAE,MAAM,EAAE;YAC9F,IAAI,EAAE;gBACL,QAAQ;aACR;SACD,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,GAAG,CAAC,EAAU;QAC1B,MAAM,CAAC,WAAW,CAAC,wBAAwB,CAAC,UAAU,QAAc,EAAE,CAAC,CAAC;QAExE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAChC,MAAM,EACN,KAAK,EACL;YACC,OAAO,EAAE;gBACR,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,SAAS,CAAC,MAAM;aACtC;YACD,UAAU,EAAE;gBACX,EAAE;aACF;SACD,CACD,CAAC;QAEF,OAAO,QAAQ,CAAC,IAAI,CAAC;IACtB,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAC,EAAU;QAC7B,MAAM,CAAC,WAAW,CAAC,wBAAwB,CAAC,UAAU,QAAc,EAAE,CAAC,CAAC;QAExE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAChC,aAAa,EACb,KAAK,EACL;YACC,OAAO,EAAE;gBACR,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,SAAS,CAAC,MAAM;aACtC;YACD,UAAU,EAAE;gBACX,EAAE;aACF;SACD,CACD,CAAC;QAEF,OAAO,QAAQ,CAAC,IAAI,CAAC;IACtB,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,gBAAgB,CAAC,EAAU;QACvC,MAAM,IAAI,iBAAiB,CAAC,wBAAwB,CAAC,UAAU,EAAE,sBAAsB,EAAE;YACxF,UAAU,EAAE,kBAAkB;SAC9B,CAAC,CAAC;IACJ,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { BaseRestClient } from \"@twin.org/api-core\";\nimport type { IBaseRestClientConfig, ICreatedResponse } from \"@twin.org/api-models\";\nimport { Guards, NotSupportedError } from \"@twin.org/core\";\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport type {\n\tIImmutableProof,\n\tIImmutableProofComponent,\n\tIImmutableProofCreateRequest,\n\tIImmutableProofGetRequest,\n\tIImmutableProofGetResponse,\n\tIImmutableProofVerification,\n\tIImmutableProofVerifyRequest,\n\tIImmutableProofVerifyResponse\n} from \"@twin.org/immutable-proof-models\";\nimport { nameof } from \"@twin.org/nameof\";\nimport { HeaderTypes, MimeTypes } from \"@twin.org/web\";\n\n/**\n * Client for performing immutable proof through to REST endpoints.\n */\nexport class ImmutableProofRestClient extends BaseRestClient implements IImmutableProofComponent {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<ImmutableProofRestClient>();\n\n\t/**\n\t * Create a new instance of ImmutableProofRestClient.\n\t * @param config The configuration for the client.\n\t */\n\tconstructor(config: IBaseRestClientConfig) {\n\t\tsuper(nameof<ImmutableProofRestClient>(), config, \"immutable-proof\");\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 ImmutableProofRestClient.CLASS_NAME;\n\t}\n\n\t/**\n\t * Create a new proof.\n\t * @param document The document to create the proof for.\n\t * @returns The id of the new proof.\n\t */\n\tpublic async create(document: IJsonLdNodeObject): Promise<string> {\n\t\tGuards.object(ImmutableProofRestClient.CLASS_NAME, nameof(document), document);\n\n\t\tconst response = await this.fetch<IImmutableProofCreateRequest, ICreatedResponse>(\"/\", \"POST\", {\n\t\t\tbody: {\n\t\t\t\tdocument\n\t\t\t}\n\t\t});\n\n\t\treturn response.headers[HeaderTypes.Location];\n\t}\n\n\t/**\n\t * Get a proof.\n\t * @param id The id of the proof to get.\n\t * @returns The proof.\n\t * @throws NotFoundError if the proof is not found.\n\t */\n\tpublic async get(id: string): Promise<IImmutableProof> {\n\t\tGuards.stringValue(ImmutableProofRestClient.CLASS_NAME, nameof(id), id);\n\n\t\tconst response = await this.fetch<IImmutableProofGetRequest, IImmutableProofGetResponse>(\n\t\t\t\"/:id\",\n\t\t\t\"GET\",\n\t\t\t{\n\t\t\t\theaders: {\n\t\t\t\t\t[HeaderTypes.Accept]: MimeTypes.JsonLd\n\t\t\t\t},\n\t\t\t\tpathParams: {\n\t\t\t\t\tid\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 a proof.\n\t * @param id The id of the proof to verify.\n\t * @returns The result of the verification and any failures.\n\t * @throws NotFoundError if the proof is not found.\n\t */\n\tpublic async verify(id: string): Promise<IImmutableProofVerification> {\n\t\tGuards.stringValue(ImmutableProofRestClient.CLASS_NAME, nameof(id), id);\n\n\t\tconst response = await this.fetch<IImmutableProofVerifyRequest, IImmutableProofVerifyResponse>(\n\t\t\t\"/:id/verify\",\n\t\t\t\"GET\",\n\t\t\t{\n\t\t\t\theaders: {\n\t\t\t\t\t[HeaderTypes.Accept]: MimeTypes.JsonLd\n\t\t\t\t},\n\t\t\t\tpathParams: {\n\t\t\t\t\tid\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 the verifiable storage for the proof.\n\t * @param id The id of the proof to remove the storage from.\n\t * @returns Nothing.\n\t * @throws NotFoundError if the proof is not found.\n\t */\n\tpublic async removeVerifiable(id: string): Promise<void> {\n\t\tthrow new NotSupportedError(ImmutableProofRestClient.CLASS_NAME, \"notSupportedOnClient\", {\n\t\t\tmethodName: \"removeVerifiable\"\n\t\t});\n\t}\n}\n"]}

package/dist/es/index.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./immutableProofRestClient.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,+BAA+B,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./immutableProofRestClient.js\";\n"]}

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

@@ -5,16 +5,21 @@ 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);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
     /**
      * Create a new proof.
      * @param document The document to create the proof for.

package/dist/types/index.d.ts

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

package/docs/changelog.md

@@ -1,5 +1,38 @@
 # @twin.org/immutable-proof-rest-client - Changelog
 
+## [0.0.3-next.1](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-rest-client-v0.0.3-next.0...immutable-proof-rest-client-v0.0.3-next.1) (2025-11-12)
+
+
+### Features
+
+* add context id features ([#14](https://github.com/twinfoundation/immutable-proof/issues/14)) ([ed5a594](https://github.com/twinfoundation/immutable-proof/commit/ed5a594eaa7d50f74b1c09a7a560d48b33a4ecd1))
+* add validate-locales ([d6a7c07](https://github.com/twinfoundation/immutable-proof/commit/d6a7c0794a1922981a42f56cc24724d7cee727f6))
+* eslint migration to flat config ([c8536f2](https://github.com/twinfoundation/immutable-proof/commit/c8536f219c7709c6c08b9266e537831f9054dda9))
+* update dependencies ([7d6b321](https://github.com/twinfoundation/immutable-proof/commit/7d6b321928ca0434ee530816b1440f1687b94a6e))
+* update framework core ([e708d4d](https://github.com/twinfoundation/immutable-proof/commit/e708d4dd3febcfbcd64663d5be004eab1d26c0fb))
+* use shared store mechanism ([#3](https://github.com/twinfoundation/immutable-proof/issues/3)) ([7042a40](https://github.com/twinfoundation/immutable-proof/commit/7042a40f0ef8b01463f07aeb1efae4f417162fa1))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/immutable-proof-models bumped from 0.0.3-next.0 to 0.0.3-next.1
+
+## [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)
 
 

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,15 +38,29 @@ The configuration for the client.
 
 ### CLASS\_NAME
 
-> `readonly` **CLASS\_NAME**: `string`
+> `readonly` `static` **CLASS\_NAME**: `string`
 
 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
 
-`IImmutableProofComponent.CLASS_NAME`
+`IImmutableProofComponent.className`
 
-## 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.2",
+	"version": "0.0.3-next.1",
 	"description": "Immutable Proof contract implementation which can connect to REST endpoints",
 	"repository": {
 		"type": "git",
@@ -19,26 +19,36 @@
 		"@twin.org/core": "next",
 		"@twin.org/data-json-ld": "next",
 		"@twin.org/entity": "next",
-		"@twin.org/immutable-proof-models": "0.0.2-next.2",
+		"@twin.org/immutable-proof-models": "0.0.3-next.1",
 		"@twin.org/nameof": "next",
 		"@twin.org/web": "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"
-	]
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"immutable-proof"
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/immutable-proof/issues"
+	},
+	"homepage": "https://twindev.org"
 }

package/dist/cjs/index.cjs

@@ -1,85 +0,0 @@
-'use strict';
-
-var apiCore = require('@twin.org/api-core');
-var core = require('@twin.org/core');
-var web = require('@twin.org/web');
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Client for performing immutable proof through to REST endpoints.
- */
-class ImmutableProofClient extends apiCore.BaseRestClient {
-    /**
-     * Runtime name for the class.
-     */
-    CLASS_NAME = "ImmutableProofClient";
-    /**
-     * Create a new instance of ImmutableProofClient.
-     * @param config The configuration for the client.
-     */
-    constructor(config) {
-        super("ImmutableProofClient", config, "immutable-proof");
-    }
-    /**
-     * Create a new proof.
-     * @param document The document to create the proof for.
-     * @returns The id of the new proof.
-     */
-    async create(document) {
-        core.Guards.object(this.CLASS_NAME, "document", document);
-        const response = await this.fetch("/", "POST", {
-            body: {
-                document
-            }
-        });
-        return response.headers[web.HeaderTypes.Location];
-    }
-    /**
-     * Get a proof.
-     * @param id The id of the proof to get.
-     * @returns The proof.
-     * @throws NotFoundError if the proof is not found.
-     */
-    async get(id) {
-        core.Guards.stringValue(this.CLASS_NAME, "id", id);
-        const response = await this.fetch("/:id", "GET", {
-            headers: {
-                [web.HeaderTypes.Accept]: web.MimeTypes.JsonLd
-            },
-            pathParams: {
-                id
-            }
-        });
-        return response.body;
-    }
-    /**
-     * Verify a proof.
-     * @param id The id of the proof to verify.
-     * @returns The result of the verification and any failures.
-     * @throws NotFoundError if the proof is not found.
-     */
-    async verify(id) {
-        core.Guards.stringValue(this.CLASS_NAME, "id", id);
-        const response = await this.fetch("/:id/verify", "GET", {
-            headers: {
-                [web.HeaderTypes.Accept]: web.MimeTypes.JsonLd
-            },
-            pathParams: {
-                id
-            }
-        });
-        return response.body;
-    }
-    /**
-     * Remove the verifiable storage for the proof.
-     * @param id The id of the proof to remove the storage from.
-     * @returns Nothing.
-     * @throws NotFoundError if the proof is not found.
-     */
-    async removeVerifiable(id) {
-        throw new core.NotSupportedError(this.CLASS_NAME, "removeVerifiable");
-    }
-}
-
-exports.ImmutableProofClient = ImmutableProofClient;