@twin.org/immutable-proof-rest-client 0.0.3-next.10 → 0.0.3-next.11

package/README.md

@@ -1,6 +1,6 @@
 # TWIN Immutable Proof REST Client
 
-Immutable Proof contract implementation which can connect to REST endpoints.
+This package delivers a dedicated client for immutable proof HTTP endpoints. It provides a simple interface for creating proofs, loading proof credentials, and running verification calls without reimplementing request handling in each consuming project.
 
 ## Installation
 

package/docs/changelog.md

@@ -1,4 +1,18 @@
-# @twin.org/immutable-proof-rest-client - Changelog
+# Changelog
+
+## [0.0.3-next.11](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-rest-client-v0.0.3-next.10...immutable-proof-rest-client-v0.0.3-next.11) (2026-03-25)
+
+
+### 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.3-next.10 to 0.0.3-next.11
 
 ## [0.0.3-next.10](https://github.com/twinfoundation/immutable-proof/compare/immutable-proof-rest-client-v0.0.3-next.9...immutable-proof-rest-client-v0.0.3-next.10) (2026-02-25)
 

package/docs/examples.md

@@ -1 +1,59 @@
-# @twin.org/immutable-proof-rest-client - Examples
+# Immutable Proof REST Client Examples
+
+Use these snippets to connect to an API, create and retrieve proofs, and validate proofs through REST endpoints.
+
+## ImmutableProofRestClient
+
+```typescript
+import { ImmutableProofRestClient } from '@twin.org/immutable-proof-rest-client';
+
+const client = new ImmutableProofRestClient({
+  endpoint: 'http://localhost:8080'
+});
+
+console.log(client.className()); // ImmutableProofRestClient
+```
+
+```typescript
+import { ImmutableProofRestClient } from '@twin.org/immutable-proof-rest-client';
+
+const client = new ImmutableProofRestClient({
+  endpoint: 'http://localhost:8080'
+});
+
+const proofId = await client.create({
+  '@context': 'https://schema.org',
+  type: 'Person',
+  name: 'Alice Example'
+});
+
+console.log(proofId); // immutable-proof:01JABCDEF1234567890
+```
+
+```typescript
+import { ImmutableProofRestClient } from '@twin.org/immutable-proof-rest-client';
+
+const client = new ImmutableProofRestClient({
+  endpoint: 'http://localhost:8080'
+});
+
+const proof = await client.get('immutable-proof:01JABCDEF1234567890');
+const verification = await client.verify('immutable-proof:01JABCDEF1234567890');
+
+console.log(proof.id); // immutable-proof:01JABCDEF1234567890
+console.log(verification.verified); // true
+```
+
+```typescript
+import { ImmutableProofRestClient } from '@twin.org/immutable-proof-rest-client';
+
+const client = new ImmutableProofRestClient({
+  endpoint: 'http://localhost:8080'
+});
+
+try {
+  await client.removeVerifiable('immutable-proof:01JABCDEF1234567890');
+} catch (error) {
+  console.log(error instanceof Error); // true
+}
+```

package/docs/reference/classes/ImmutableProofRestClient.md

@@ -36,7 +36,7 @@ The configuration for the client.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -44,7 +44,7 @@ Runtime name for the class.
 
 ## Methods
 
-### className()
+### className() {#classname}
 
 > **className**(): `string`
 
@@ -62,7 +62,7 @@ The class name of the component.
 
 ***
 
-### create()
+### create() {#create}
 
 > **create**(`document`): `Promise`\<`string`\>
 
@@ -88,7 +88,7 @@ The id of the new proof.
 
 ***
 
-### get()
+### get() {#get}
 
 > **get**(`id`): `Promise`\<`IDidVerifiableCredential`\>
 
@@ -118,7 +118,7 @@ NotFoundError if the proof is not found.
 
 ***
 
-### verify()
+### verify() {#verify}
 
 > **verify**(`id`): `Promise`\<`IImmutableProofVerification`\>
 
@@ -148,7 +148,7 @@ NotFoundError if the proof is not found.
 
 ***
 
-### removeVerifiable()
+### removeVerifiable() {#removeverifiable}
 
 > **removeVerifiable**(`id`): `Promise`\<`void`\>
 

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@twin.org/immutable-proof-rest-client",
-	"version": "0.0.3-next.10",
-	"description": "Immutable Proof contract implementation which can connect to REST endpoints",
+	"version": "0.0.3-next.11",
+	"description": "HTTP client for calling immutable proof service endpoints from external components",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/twinfoundation/immutable-proof.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.3-next.10",
+		"@twin.org/immutable-proof-models": "0.0.3-next.11",
 		"@twin.org/nameof": "next",
 		"@twin.org/web": "next"
 	},