@twin.org/document-management-rest-client 0.0.3-next.10 → 0.0.3-next.12

package/README.md

@@ -1,6 +1,6 @@
 # TWIN Document Management REST Client
 
-Document management processing contract implementation which can connect to REST endpoints.
+This package provides a client for invoking document lifecycle endpoints over HTTP with a stable, contract-led API. It is intended for consumers that need to create, update, fetch revisions, remove revisions, and query document records from remote services.
 
 ## Installation
 

package/docs/changelog.md

@@ -1,4 +1,32 @@
-# @twin.org/document-management-rest-client - Changelog
+# Changelog
+
+## [0.0.3-next.12](https://github.com/twinfoundation/document-management/compare/document-management-rest-client-v0.0.3-next.11...document-management-rest-client-v0.0.3-next.12) (2026-03-26)
+
+
+### Features
+
+* update to latest aig method shapes ([497e895](https://github.com/twinfoundation/document-management/commit/497e8954f24774db628e057ebb9d158a1fd9d92a))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/document-management-models bumped from 0.0.3-next.11 to 0.0.3-next.12
+
+## [0.0.3-next.11](https://github.com/twinfoundation/document-management/compare/document-management-rest-client-v0.0.3-next.10...document-management-rest-client-v0.0.3-next.11) (2026-02-25)
+
+
+### Miscellaneous Chores
+
+* **document-management-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/document-management-models bumped from 0.0.3-next.10 to 0.0.3-next.11
 
 ## [0.0.3-next.10](https://github.com/twinfoundation/document-management/compare/document-management-rest-client-v0.0.3-next.9...document-management-rest-client-v0.0.3-next.10) (2026-02-11)
 

package/docs/examples.md

@@ -1 +1,118 @@
-# @twin.org/document-management-rest-client - Examples
+# Document Management REST Client Examples
+
+These examples walk through common client calls for creating, updating, reading, and finding documents from a remote service.
+
+## DocumentManagementRestClient
+
+```typescript
+import { DocumentManagementRestClient } from '@twin.org/document-management-rest-client';
+import { Converter } from '@twin.org/core';
+import { UneceDocumentCodeList } from '@twin.org/standards-unece';
+
+const client = new DocumentManagementRestClient({
+  endpoint: 'http://localhost:3000'
+});
+
+const blobBytes = Converter.utf8ToBytes('Updated bill of lading payload');
+const edgeTargetId = 'aig:shipment-vertex';
+```
+
+```typescript
+const componentName = client.className();
+console.log(componentName); // DocumentManagementRestClient
+```
+
+```typescript
+const createdVertexId = await client.create(
+  'BOL-2026-0001',
+  'bol',
+  UneceDocumentCodeList.BillOfLading,
+  blobBytes,
+  {
+    '@context': 'https://schema.org',
+    '@type': 'DigitalDocument',
+    name: 'bol-2026-0001.pdf'
+  },
+  [
+    {
+      targetId: edgeTargetId,
+      addAlias: true,
+      aliasAnnotationObject: {
+        '@context': 'https://schema.org',
+        '@type': 'Thing',
+        name: 'Shipment link'
+      }
+    }
+  ],
+  {
+    createAttestation: true,
+    addAlias: true,
+    aliasAnnotationObject: {
+      '@context': 'https://schema.org',
+      '@type': 'Thing',
+      name: 'Primary alias'
+    }
+  }
+);
+
+console.log(createdVertexId); // aig:document-vertex-1
+```
+
+```typescript
+await client.update(
+  'aig:document-vertex-1',
+  Converter.utf8ToBytes('Second revision payload'),
+  {
+    '@context': 'https://schema.org',
+    '@type': 'CreativeWork',
+    name: 'bol-2026-0001-rev1.pdf'
+  },
+  [
+    {
+      targetId: edgeTargetId,
+      addAlias: true,
+      aliasAnnotationObject: {
+        '@context': 'https://schema.org',
+        '@type': 'Thing',
+        name: 'Shipment alias'
+      }
+    }
+  ]
+);
+```
+
+```typescript
+const latest = await client.get(
+  'aig:document-vertex-1',
+  {
+    includeBlobStorageMetadata: true,
+    includeAttestation: true
+  },
+  '0',
+  2
+);
+
+console.log(latest.entries.itemListElement.length); // 2
+console.log(latest.cursor); // 2
+```
+
+```typescript
+const revisionOne = await client.getRevision('aig:document-vertex-1', 1, {
+  includeBlobStorageData: true,
+  includeAttestation: true
+});
+
+console.log(revisionOne.documentRevision); // 1
+console.log(revisionOne.documentId); // BOL-2026-0001
+```
+
+```typescript
+await client.removeRevision('aig:document-vertex-1', 1);
+```
+
+```typescript
+const matches = await client.query('BOL-2026-0001', '0', 10);
+
+console.log(matches.entries.vertices.length); // 1
+console.log(matches.cursor); // undefined
+```

package/docs/reference/classes/DocumentManagementRestClient.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**(`documentId`, `documentIdFormat`, `documentCode`, `blob`, `annotationObject?`, `auditableItemGraphEdges?`, `options?`): `Promise`\<`string`\>
 
@@ -80,9 +80,9 @@ The document id to create.
 
 ##### documentIdFormat
 
-The format of the document identifier.
+`string` \| `undefined`
 
-`string` | `undefined`
+The format of the document identifier.
 
 ##### documentCode
 
@@ -142,7 +142,7 @@ The auditable item graph vertex created for the document including its revision.
 
 ***
 
-### update()
+### update() {#update}
 
 > **update**(`auditableItemGraphDocumentId`, `blob?`, `annotationObject?`, `auditableItemGraphEdges?`): `Promise`\<`void`\>
 
@@ -188,7 +188,7 @@ Nothing.
 
 ***
 
-### get()
+### get() {#get}
 
 > **get**(`auditableItemGraphDocumentId`, `options?`, `cursor?`, `limit?`): `Promise`\<\{ `entries`: `IDocumentList`; `cursor?`: `string`; \}\>
 
@@ -266,7 +266,7 @@ The documents and revisions if requested, ordered by revision descending, cursor
 
 ***
 
-### getRevision()
+### getRevision() {#getrevision}
 
 > **getRevision**(`auditableItemGraphDocumentId`, `revision`, `options?`): `Promise`\<`IDocument`\>
 
@@ -332,7 +332,7 @@ The documents and revisions if requested, ordered by revision descending, cursor
 
 ***
 
-### removeRevision()
+### removeRevision() {#removerevision}
 
 > **removeRevision**(`auditableItemGraphDocumentId`, `revision`): `Promise`\<`void`\>
 
@@ -365,7 +365,7 @@ Nothing.
 
 ***
 
-### query()
+### query() {#query}
 
 > **query**(`documentId`, `cursor?`, `limit?`): `Promise`\<\{ `entries`: `IAuditableItemGraphVertexList`; `cursor?`: `string`; \}\>
 

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@twin.org/document-management-rest-client",
-	"version": "0.0.3-next.10",
-	"description": "Document management contract implementation which can connect to REST endpoints",
+	"version": "0.0.3-next.12",
+	"description": "REST client operations for creating, updating, retrieving, and querying managed documents.",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/twinfoundation/document-management.git",
@@ -19,7 +19,7 @@
 		"@twin.org/auditable-item-graph-models": "next",
 		"@twin.org/core": "next",
 		"@twin.org/data-json-ld": "next",
-		"@twin.org/document-management-models": "0.0.3-next.10",
+		"@twin.org/document-management-models": "0.0.3-next.12",
 		"@twin.org/entity": "next",
 		"@twin.org/nameof": "next",
 		"@twin.org/standards-unece": "next",