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

package/dist/cjs/index.cjs

@@ -22,28 +22,28 @@ class ImmutableProofClient extends apiCore.BaseRestClient {
         super("ImmutableProofClient", config, "immutable-proof");
     }
     /**
-     * Create a new authentication proof.
-     * @param proofObject The object for the proof as JSON-LD.
-     * @returns The id of the new authentication proof.
+     * Create a new proof.
+     * @param document The document to create the proof for.
+     * @returns The id of the new proof.
      */
-    async create(proofObject) {
-        core.Guards.object(this.CLASS_NAME, "proofObject", proofObject);
+    async create(document) {
+        core.Guards.object(this.CLASS_NAME, "document", document);
         const response = await this.fetch("/", "POST", {
             body: {
-                proofObject
+                document
             }
         });
         return response.headers[web.HeaderTypes.Location];
     }
     /**
-     * Get an authentication proof.
+     * 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/:entryId", "GET", {
+        const response = await this.fetch("/:id", "GET", {
             headers: {
                 [web.HeaderTypes.Accept]: web.MimeTypes.JsonLd
             },
@@ -54,36 +54,31 @@ class ImmutableProofClient extends apiCore.BaseRestClient {
         return response.body;
     }
     /**
-     * Verify an authentication proof.
+     * Verify a proof.
      * @param id The id of the proof to verify.
-     * @param proofObject The object to verify as JSON-LD.
      * @returns The result of the verification and any failures.
      * @throws NotFoundError if the proof is not found.
      */
-    async verify(id, proofObject) {
+    async verify(id) {
         core.Guards.stringValue(this.CLASS_NAME, "id", id);
-        core.Guards.object(this.CLASS_NAME, "proofObject", proofObject);
-        const response = await this.fetch("/:id", "POST", {
+        const response = await this.fetch("/:id/verify", "GET", {
             headers: {
                 [web.HeaderTypes.Accept]: web.MimeTypes.JsonLd
             },
             pathParams: {
                 id
-            },
-            body: {
-                proofObject
             }
         });
         return response.body;
     }
     /**
-     * Remove the immutable storage for the proof.
+     * 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 removeImmutable(id) {
-        throw new core.NotSupportedError(this.CLASS_NAME, "removeImmutable");
+    async removeVerifiable(id) {
+        throw new core.NotSupportedError(this.CLASS_NAME, "removeVerifiable");
     }
 }
 

package/dist/esm/index.mjs

@@ -20,28 +20,28 @@ class ImmutableProofClient extends BaseRestClient {
         super("ImmutableProofClient", config, "immutable-proof");
     }
     /**
-     * Create a new authentication proof.
-     * @param proofObject The object for the proof as JSON-LD.
-     * @returns The id of the new authentication proof.
+     * Create a new proof.
+     * @param document The document to create the proof for.
+     * @returns The id of the new proof.
      */
-    async create(proofObject) {
-        Guards.object(this.CLASS_NAME, "proofObject", proofObject);
+    async create(document) {
+        Guards.object(this.CLASS_NAME, "document", document);
         const response = await this.fetch("/", "POST", {
             body: {
-                proofObject
+                document
             }
         });
         return response.headers[HeaderTypes.Location];
     }
     /**
-     * Get an authentication proof.
+     * 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) {
         Guards.stringValue(this.CLASS_NAME, "id", id);
-        const response = await this.fetch("/:id/:entryId", "GET", {
+        const response = await this.fetch("/:id", "GET", {
             headers: {
                 [HeaderTypes.Accept]: MimeTypes.JsonLd
             },
@@ -52,36 +52,31 @@ class ImmutableProofClient extends BaseRestClient {
         return response.body;
     }
     /**
-     * Verify an authentication proof.
+     * Verify a proof.
      * @param id The id of the proof to verify.
-     * @param proofObject The object to verify as JSON-LD.
      * @returns The result of the verification and any failures.
      * @throws NotFoundError if the proof is not found.
      */
-    async verify(id, proofObject) {
+    async verify(id) {
         Guards.stringValue(this.CLASS_NAME, "id", id);
-        Guards.object(this.CLASS_NAME, "proofObject", proofObject);
-        const response = await this.fetch("/:id", "POST", {
+        const response = await this.fetch("/:id/verify", "GET", {
             headers: {
                 [HeaderTypes.Accept]: MimeTypes.JsonLd
             },
             pathParams: {
                 id
-            },
-            body: {
-                proofObject
             }
         });
         return response.body;
     }
     /**
-     * Remove the immutable storage for the proof.
+     * 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 removeImmutable(id) {
-        throw new NotSupportedError(this.CLASS_NAME, "removeImmutable");
+    async removeVerifiable(id) {
+        throw new NotSupportedError(this.CLASS_NAME, "removeVerifiable");
     }
 }
 

package/dist/types/immutableProofClient.d.ts

@@ -16,31 +16,30 @@ export declare class ImmutableProofClient extends BaseRestClient implements IImm
      */
     constructor(config: IBaseRestClientConfig);
     /**
-     * Create a new authentication proof.
-     * @param proofObject The object for the proof as JSON-LD.
-     * @returns The id of the new authentication proof.
+     * Create a new proof.
+     * @param document The document to create the proof for.
+     * @returns The id of the new proof.
      */
-    create(proofObject: IJsonLdNodeObject): Promise<string>;
+    create(document: IJsonLdNodeObject): Promise<string>;
     /**
-     * Get an authentication proof.
+     * Get a proof.
      * @param id The id of the proof to get.
      * @returns The proof.
      * @throws NotFoundError if the proof is not found.
      */
     get(id: string): Promise<IImmutableProof>;
     /**
-     * Verify an authentication proof.
+     * Verify a proof.
      * @param id The id of the proof to verify.
-     * @param proofObject The object to verify as JSON-LD.
      * @returns The result of the verification and any failures.
      * @throws NotFoundError if the proof is not found.
      */
-    verify(id: string, proofObject: IJsonLdNodeObject): Promise<IImmutableProofVerification>;
+    verify(id: string): Promise<IImmutableProofVerification>;
     /**
-     * Remove the immutable storage for the proof.
+     * 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.
      */
-    removeImmutable(id: string): Promise<void>;
+    removeVerifiable(id: string): Promise<void>;
 }

package/docs/changelog.md

@@ -1,5 +1,105 @@
 # @twin.org/immutable-proof-rest-client - Changelog
 
-## v0.0.1-next.9
+## [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)
+
+
+### Features
+
+* 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.2-next.0 to 0.0.2-next.1
+
+## 0.0.1 (2025-07-09)
+
+
+### Features
+
+* release to production ([cb7ecff](https://github.com/twinfoundation/immutable-proof/commit/cb7ecff3e9a1ec8b4391d7efea4a58057b8b66c6))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/immutable-proof-models bumped from ^0.0.0 to ^0.0.1
+
+## [0.0.1-next.35](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-rest-client-v0.0.1-next.34...immutable-proof-rest-client-v0.0.1-next.35) (2025-06-12)
+
+
+### Features
+
+* update dependencies ([7d6b321](https://github.com/twinfoundation/immutable-proof/commit/7d6b321928ca0434ee530816b1440f1687b94a6e))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/immutable-proof-models bumped from 0.0.1-next.34 to 0.0.1-next.35
+
+## [0.0.1-next.34](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-rest-client-v0.0.1-next.33...immutable-proof-rest-client-v0.0.1-next.34) (2025-06-03)
+
+
+### Miscellaneous Chores
+
+* **immutable-proof-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/immutable-proof-models bumped from 0.0.1-next.33 to 0.0.1-next.34
+
+## [0.0.1-next.33](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-rest-client-v0.0.1-next.32...immutable-proof-rest-client-v0.0.1-next.33) (2025-05-28)
+
+
+### Miscellaneous Chores
+
+* **immutable-proof-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/immutable-proof-models bumped from 0.0.1-next.32 to 0.0.1-next.33
+
+## [0.0.1-next.32](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-rest-client-v0.0.1-next.31...immutable-proof-rest-client-v0.0.1-next.32) (2025-04-17)
+
+
+### Features
+
+* 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.1-next.31 to 0.0.1-next.32
+
+## [0.0.1-next.31](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-rest-client-v0.0.1-next.30...immutable-proof-rest-client-v0.0.1-next.31) (2025-03-28)
+
+
+### Miscellaneous Chores
+
+* **immutable-proof-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/immutable-proof-models bumped from 0.0.1-next.30 to 0.0.1-next.31
+
+## v0.0.1-next.30
 
 - Initial Release

package/docs/reference/classes/ImmutableProofClient.md

@@ -12,21 +12,23 @@ Client for performing immutable proof through to REST endpoints.
 
 ## Constructors
 
-### new ImmutableProofClient()
+### Constructor
 
-> **new ImmutableProofClient**(`config`): [`ImmutableProofClient`](ImmutableProofClient.md)
+> **new ImmutableProofClient**(`config`): `ImmutableProofClient`
 
 Create a new instance of ImmutableProofClient.
 
 #### Parameters
 
-• **config**: `IBaseRestClientConfig`
+##### config
+
+`IBaseRestClientConfig`
 
 The configuration for the client.
 
 #### Returns
 
-[`ImmutableProofClient`](ImmutableProofClient.md)
+`ImmutableProofClient`
 
 #### Overrides
 
@@ -48,21 +50,23 @@ Runtime name for the class.
 
 ### create()
 
-> **create**(`proofObject`): `Promise`\<`string`\>
+> **create**(`document`): `Promise`\<`string`\>
 
-Create a new authentication proof.
+Create a new proof.
 
 #### Parameters
 
-• **proofObject**: `IJsonLdNodeObject`
+##### document
+
+`IJsonLdNodeObject`
 
-The object for the proof as JSON-LD.
+The document to create the proof for.
 
 #### Returns
 
 `Promise`\<`string`\>
 
-The id of the new authentication proof.
+The id of the new proof.
 
 #### Implementation of
 
@@ -74,11 +78,13 @@ The id of the new authentication proof.
 
 > **get**(`id`): `Promise`\<`IImmutableProof`\>
 
-Get an authentication proof.
+Get a proof.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the proof to get.
 
@@ -100,19 +106,17 @@ NotFoundError if the proof is not found.
 
 ### verify()
 
-> **verify**(`id`, `proofObject`): `Promise`\<`IImmutableProofVerification`\>
+> **verify**(`id`): `Promise`\<`IImmutableProofVerification`\>
 
-Verify an authentication proof.
+Verify a proof.
 
 #### Parameters
 
-• **id**: `string`
+##### id
 
-The id of the proof to verify.
+`string`
 
-• **proofObject**: `IJsonLdNodeObject`
-
-The object to verify as JSON-LD.
+The id of the proof to verify.
 
 #### Returns
 
@@ -130,15 +134,17 @@ NotFoundError if the proof is not found.
 
 ***
 
-### removeImmutable()
+### removeVerifiable()
 
-> **removeImmutable**(`id`): `Promise`\<`void`\>
+> **removeVerifiable**(`id`): `Promise`\<`void`\>
 
-Remove the immutable storage for the proof.
+Remove the verifiable storage for the proof.
 
 #### Parameters
 
-• **id**: `string`
+##### id
+
+`string`
 
 The id of the proof to remove the storage from.
 
@@ -154,4 +160,4 @@ NotFoundError if the proof is not found.
 
 #### Implementation of
 
-`IImmutableProofComponent.removeImmutable`
+`IImmutableProofComponent.removeVerifiable`

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/immutable-proof-rest-client",
-	"version": "0.0.1-next.9",
+	"version": "0.0.2-next.1",
 	"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.1-next.9",
+		"@twin.org/immutable-proof-models": "0.0.2-next.1",
 		"@twin.org/nameof": "next",
 		"@twin.org/web": "next"
 	},
@@ -28,9 +28,9 @@
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
+			"types": "./dist/types/index.d.ts",
 			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs",
-			"types": "./dist/types/index.d.ts"
+			"import": "./dist/esm/index.mjs"
 		},
 		"./locales/*.json": "./locales/*.json"
 	},