@twin.org/document-management-rest-client 0.0.2-next.2 → 0.0.2-next.4

package/dist/cjs/index.cjs

@@ -9,22 +9,17 @@ var standardsUnece = require('@twin.org/standards-unece');
 /**
  * Client for performing document management through to REST endpoints.
  */
-class DocumentManagementClient extends apiCore.BaseRestClient {
+class DocumentManagementRestClient extends apiCore.BaseRestClient {
     /**
      * Runtime name for the class.
-     * @internal
      */
-    static _CLASS_NAME = "DocumentManagementClient";
+    static CLASS_NAME = "DocumentManagementRestClient";
     /**
-     * Runtime name for the class.
-     */
-    CLASS_NAME = DocumentManagementClient._CLASS_NAME;
-    /**
-     * Create a new instance of DocumentManagementClient.
+     * Create a new instance of DocumentManagementRestClient.
      * @param config The configuration for the client.
      */
     constructor(config) {
-        super(DocumentManagementClient._CLASS_NAME, config, "document-management");
+        super(DocumentManagementRestClient.CLASS_NAME, config, "document-management");
     }
     /**
      * Store a document as an auditable item graph vertex and add its content to blob storage.
@@ -43,9 +38,9 @@ class DocumentManagementClient extends apiCore.BaseRestClient {
      * @returns The auditable item graph vertex created for the document including its revision.
      */
     async create(documentId, documentIdFormat, documentCode, blob, annotationObject, auditableItemGraphEdges, options) {
-        core.Guards.stringValue(this.CLASS_NAME, "documentId", documentId);
-        core.Guards.arrayOneOf(this.CLASS_NAME, "documentCode", documentCode, Object.values(standardsUnece.UneceDocumentCodes));
-        core.Guards.uint8Array(this.CLASS_NAME, "blob", blob);
+        core.Guards.stringValue(DocumentManagementRestClient.CLASS_NAME, "documentId", documentId);
+        core.Guards.arrayOneOf(DocumentManagementRestClient.CLASS_NAME, "documentCode", documentCode, Object.values(standardsUnece.UneceDocumentCodes));
+        core.Guards.uint8Array(DocumentManagementRestClient.CLASS_NAME, "blob", blob);
         const response = await this.fetch("/", "POST", {
             body: {
                 documentId,
@@ -72,7 +67,7 @@ class DocumentManagementClient extends apiCore.BaseRestClient {
      * @returns Nothing.
      */
     async update(auditableItemGraphDocumentId, blob, annotationObject, auditableItemGraphEdges) {
-        core.Urn.guard(this.CLASS_NAME, "auditableItemGraphDocumentId", auditableItemGraphDocumentId);
+        core.Urn.guard(DocumentManagementRestClient.CLASS_NAME, "auditableItemGraphDocumentId", auditableItemGraphDocumentId);
         await this.fetch("/:auditableItemGraphDocumentId", "PUT", {
             pathParams: {
                 auditableItemGraphDocumentId
@@ -95,11 +90,11 @@ class DocumentManagementClient extends apiCore.BaseRestClient {
      * @param options.extractRuleGroupId If provided will extract data from the document using the specified rule group id.
      * @param options.extractMimeType By default extraction will auto detect the mime type of the document, this can be used to override the detection.
      * @param cursor The cursor to get the next chunk of revisions.
-     * @param pageSize Page size of items to return, defaults to 1 so only most recent is returned.
+     * @param limit The limit of items to return, defaults to 1 so only most recent is returned.
      * @returns The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
      */
-    async get(auditableItemGraphDocumentId, options, cursor, pageSize) {
-        core.Urn.guard(this.CLASS_NAME, "auditableItemGraphDocumentId", auditableItemGraphDocumentId);
+    async get(auditableItemGraphDocumentId, options, cursor, limit) {
+        core.Urn.guard(DocumentManagementRestClient.CLASS_NAME, "auditableItemGraphDocumentId", auditableItemGraphDocumentId);
         const response = await this.fetch("/:auditableItemGraphDocumentId", "GET", {
             pathParams: {
                 auditableItemGraphDocumentId
@@ -112,7 +107,7 @@ class DocumentManagementClient extends apiCore.BaseRestClient {
                 extractRuleGroupId: options?.extractRuleGroupId,
                 extractMimeType: options?.extractMimeType,
                 cursor,
-                pageSize: core.Coerce.string(pageSize)
+                limit: core.Coerce.string(limit)
             }
         });
         return response.body;
@@ -130,8 +125,8 @@ class DocumentManagementClient extends apiCore.BaseRestClient {
      * @returns The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
      */
     async getRevision(auditableItemGraphDocumentId, revision, options) {
-        core.Urn.guard(this.CLASS_NAME, "auditableItemGraphDocumentId", auditableItemGraphDocumentId);
-        core.Guards.integer(this.CLASS_NAME, "revision", revision);
+        core.Urn.guard(DocumentManagementRestClient.CLASS_NAME, "auditableItemGraphDocumentId", auditableItemGraphDocumentId);
+        core.Guards.integer(DocumentManagementRestClient.CLASS_NAME, "revision", revision);
         const response = await this.fetch("/:auditableItemGraphDocumentId/:revision", "GET", {
             pathParams: {
                 auditableItemGraphDocumentId,
@@ -155,8 +150,8 @@ class DocumentManagementClient extends apiCore.BaseRestClient {
      * @returns Nothing.
      */
     async removeRevision(auditableItemGraphDocumentId, revision) {
-        core.Urn.guard(this.CLASS_NAME, "auditableItemGraphDocumentId", auditableItemGraphDocumentId);
-        core.Guards.number(this.CLASS_NAME, "revision", revision);
+        core.Urn.guard(DocumentManagementRestClient.CLASS_NAME, "auditableItemGraphDocumentId", auditableItemGraphDocumentId);
+        core.Guards.number(DocumentManagementRestClient.CLASS_NAME, "revision", revision);
         await this.fetch("/:auditableItemGraphDocumentId/:revision", "DELETE", {
             pathParams: {
                 auditableItemGraphDocumentId,
@@ -168,20 +163,20 @@ class DocumentManagementClient extends apiCore.BaseRestClient {
      * Find all the document with a specific id.
      * @param documentId The document id to find in the graph.
      * @param cursor The cursor to get the next chunk of documents.
-     * @param pageSize The page size to get the next chunk of documents.
+     * @param limit The limit to get the next chunk of documents.
      * @returns The graph vertices that contain documents referencing the specified document id.
      */
-    async query(documentId, cursor, pageSize) {
-        core.Guards.stringValue(this.CLASS_NAME, "documentId", documentId);
+    async query(documentId, cursor, limit) {
+        core.Guards.stringValue(DocumentManagementRestClient.CLASS_NAME, "documentId", documentId);
         const response = await this.fetch("/", "GET", {
             query: {
                 documentId,
                 cursor,
-                pageSize: core.Coerce.string(pageSize)
+                limit: core.Coerce.string(limit)
             }
         });
         return response.body;
     }
 }
 
-exports.DocumentManagementClient = DocumentManagementClient;
+exports.DocumentManagementRestClient = DocumentManagementRestClient;

package/dist/esm/index.mjs

@@ -7,22 +7,17 @@ import { UneceDocumentCodes } from '@twin.org/standards-unece';
 /**
  * Client for performing document management through to REST endpoints.
  */
-class DocumentManagementClient extends BaseRestClient {
+class DocumentManagementRestClient extends BaseRestClient {
     /**
      * Runtime name for the class.
-     * @internal
      */
-    static _CLASS_NAME = "DocumentManagementClient";
+    static CLASS_NAME = "DocumentManagementRestClient";
     /**
-     * Runtime name for the class.
-     */
-    CLASS_NAME = DocumentManagementClient._CLASS_NAME;
-    /**
-     * Create a new instance of DocumentManagementClient.
+     * Create a new instance of DocumentManagementRestClient.
      * @param config The configuration for the client.
      */
     constructor(config) {
-        super(DocumentManagementClient._CLASS_NAME, config, "document-management");
+        super(DocumentManagementRestClient.CLASS_NAME, config, "document-management");
     }
     /**
      * Store a document as an auditable item graph vertex and add its content to blob storage.
@@ -41,9 +36,9 @@ class DocumentManagementClient extends BaseRestClient {
      * @returns The auditable item graph vertex created for the document including its revision.
      */
     async create(documentId, documentIdFormat, documentCode, blob, annotationObject, auditableItemGraphEdges, options) {
-        Guards.stringValue(this.CLASS_NAME, "documentId", documentId);
-        Guards.arrayOneOf(this.CLASS_NAME, "documentCode", documentCode, Object.values(UneceDocumentCodes));
-        Guards.uint8Array(this.CLASS_NAME, "blob", blob);
+        Guards.stringValue(DocumentManagementRestClient.CLASS_NAME, "documentId", documentId);
+        Guards.arrayOneOf(DocumentManagementRestClient.CLASS_NAME, "documentCode", documentCode, Object.values(UneceDocumentCodes));
+        Guards.uint8Array(DocumentManagementRestClient.CLASS_NAME, "blob", blob);
         const response = await this.fetch("/", "POST", {
             body: {
                 documentId,
@@ -70,7 +65,7 @@ class DocumentManagementClient extends BaseRestClient {
      * @returns Nothing.
      */
     async update(auditableItemGraphDocumentId, blob, annotationObject, auditableItemGraphEdges) {
-        Urn.guard(this.CLASS_NAME, "auditableItemGraphDocumentId", auditableItemGraphDocumentId);
+        Urn.guard(DocumentManagementRestClient.CLASS_NAME, "auditableItemGraphDocumentId", auditableItemGraphDocumentId);
         await this.fetch("/:auditableItemGraphDocumentId", "PUT", {
             pathParams: {
                 auditableItemGraphDocumentId
@@ -93,11 +88,11 @@ class DocumentManagementClient extends BaseRestClient {
      * @param options.extractRuleGroupId If provided will extract data from the document using the specified rule group id.
      * @param options.extractMimeType By default extraction will auto detect the mime type of the document, this can be used to override the detection.
      * @param cursor The cursor to get the next chunk of revisions.
-     * @param pageSize Page size of items to return, defaults to 1 so only most recent is returned.
+     * @param limit The limit of items to return, defaults to 1 so only most recent is returned.
      * @returns The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
      */
-    async get(auditableItemGraphDocumentId, options, cursor, pageSize) {
-        Urn.guard(this.CLASS_NAME, "auditableItemGraphDocumentId", auditableItemGraphDocumentId);
+    async get(auditableItemGraphDocumentId, options, cursor, limit) {
+        Urn.guard(DocumentManagementRestClient.CLASS_NAME, "auditableItemGraphDocumentId", auditableItemGraphDocumentId);
         const response = await this.fetch("/:auditableItemGraphDocumentId", "GET", {
             pathParams: {
                 auditableItemGraphDocumentId
@@ -110,7 +105,7 @@ class DocumentManagementClient extends BaseRestClient {
                 extractRuleGroupId: options?.extractRuleGroupId,
                 extractMimeType: options?.extractMimeType,
                 cursor,
-                pageSize: Coerce.string(pageSize)
+                limit: Coerce.string(limit)
             }
         });
         return response.body;
@@ -128,8 +123,8 @@ class DocumentManagementClient extends BaseRestClient {
      * @returns The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
      */
     async getRevision(auditableItemGraphDocumentId, revision, options) {
-        Urn.guard(this.CLASS_NAME, "auditableItemGraphDocumentId", auditableItemGraphDocumentId);
-        Guards.integer(this.CLASS_NAME, "revision", revision);
+        Urn.guard(DocumentManagementRestClient.CLASS_NAME, "auditableItemGraphDocumentId", auditableItemGraphDocumentId);
+        Guards.integer(DocumentManagementRestClient.CLASS_NAME, "revision", revision);
         const response = await this.fetch("/:auditableItemGraphDocumentId/:revision", "GET", {
             pathParams: {
                 auditableItemGraphDocumentId,
@@ -153,8 +148,8 @@ class DocumentManagementClient extends BaseRestClient {
      * @returns Nothing.
      */
     async removeRevision(auditableItemGraphDocumentId, revision) {
-        Urn.guard(this.CLASS_NAME, "auditableItemGraphDocumentId", auditableItemGraphDocumentId);
-        Guards.number(this.CLASS_NAME, "revision", revision);
+        Urn.guard(DocumentManagementRestClient.CLASS_NAME, "auditableItemGraphDocumentId", auditableItemGraphDocumentId);
+        Guards.number(DocumentManagementRestClient.CLASS_NAME, "revision", revision);
         await this.fetch("/:auditableItemGraphDocumentId/:revision", "DELETE", {
             pathParams: {
                 auditableItemGraphDocumentId,
@@ -166,20 +161,20 @@ class DocumentManagementClient extends BaseRestClient {
      * Find all the document with a specific id.
      * @param documentId The document id to find in the graph.
      * @param cursor The cursor to get the next chunk of documents.
-     * @param pageSize The page size to get the next chunk of documents.
+     * @param limit The limit to get the next chunk of documents.
      * @returns The graph vertices that contain documents referencing the specified document id.
      */
-    async query(documentId, cursor, pageSize) {
-        Guards.stringValue(this.CLASS_NAME, "documentId", documentId);
+    async query(documentId, cursor, limit) {
+        Guards.stringValue(DocumentManagementRestClient.CLASS_NAME, "documentId", documentId);
         const response = await this.fetch("/", "GET", {
             query: {
                 documentId,
                 cursor,
-                pageSize: Coerce.string(pageSize)
+                limit: Coerce.string(limit)
             }
         });
         return response.body;
     }
 }
 
-export { DocumentManagementClient };
+export { DocumentManagementRestClient };

package/dist/types/{documentManagementClient.d.ts → documentManagementRestClient.d.ts}

@@ -7,13 +7,13 @@ import { UneceDocumentCodes } from "@twin.org/standards-unece";
 /**
  * Client for performing document management through to REST endpoints.
  */
-export declare class DocumentManagementClient extends BaseRestClient implements IDocumentManagementComponent {
+export declare class DocumentManagementRestClient extends BaseRestClient implements IDocumentManagementComponent {
     /**
      * Runtime name for the class.
      */
-    readonly CLASS_NAME: string;
+    static readonly CLASS_NAME: string;
     /**
-     * Create a new instance of DocumentManagementClient.
+     * Create a new instance of DocumentManagementRestClient.
      * @param config The configuration for the client.
      */
     constructor(config: IBaseRestClientConfig);
@@ -34,7 +34,7 @@ export declare class DocumentManagementClient extends BaseRestClient implements
      * @returns The auditable item graph vertex created for the document including its revision.
      */
     create(documentId: string, documentIdFormat: string | undefined, documentCode: UneceDocumentCodes, blob: Uint8Array, annotationObject?: IJsonLdNodeObject, auditableItemGraphEdges?: {
-        id: string;
+        targetId: string;
         addAlias?: boolean;
         aliasAnnotationObject?: IJsonLdNodeObject;
     }[], options?: {
@@ -53,7 +53,7 @@ export declare class DocumentManagementClient extends BaseRestClient implements
      * @returns Nothing.
      */
     update(auditableItemGraphDocumentId: string, blob?: Uint8Array, annotationObject?: IJsonLdNodeObject, auditableItemGraphEdges?: {
-        id: string;
+        targetId: string;
         addAlias?: boolean;
         aliasAnnotationObject?: IJsonLdNodeObject;
     }[]): Promise<void>;
@@ -68,7 +68,7 @@ export declare class DocumentManagementClient extends BaseRestClient implements
      * @param options.extractRuleGroupId If provided will extract data from the document using the specified rule group id.
      * @param options.extractMimeType By default extraction will auto detect the mime type of the document, this can be used to override the detection.
      * @param cursor The cursor to get the next chunk of revisions.
-     * @param pageSize Page size of items to return, defaults to 1 so only most recent is returned.
+     * @param limit The limit of items to return, defaults to 1 so only most recent is returned.
      * @returns The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
      */
     get(auditableItemGraphDocumentId: string, options?: {
@@ -78,7 +78,7 @@ export declare class DocumentManagementClient extends BaseRestClient implements
         includeRemoved?: boolean;
         extractRuleGroupId?: string;
         extractMimeType?: string;
-    }, cursor?: string, pageSize?: number): Promise<IDocumentList>;
+    }, cursor?: string, limit?: number): Promise<IDocumentList>;
     /**
      * Get a document revision using it's auditable item graph vertex id.
      * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.
@@ -110,8 +110,8 @@ export declare class DocumentManagementClient extends BaseRestClient implements
      * Find all the document with a specific id.
      * @param documentId The document id to find in the graph.
      * @param cursor The cursor to get the next chunk of documents.
-     * @param pageSize The page size to get the next chunk of documents.
+     * @param limit The limit to get the next chunk of documents.
      * @returns The graph vertices that contain documents referencing the specified document id.
      */
-    query(documentId: string, cursor?: string, pageSize?: number): Promise<IAuditableItemGraphVertexList>;
+    query(documentId: string, cursor?: string, limit?: number): Promise<IAuditableItemGraphVertexList>;
 }

package/dist/types/index.d.ts

@@ -1 +1 @@
-export * from "./documentManagementClient";
+export * from "./documentManagementRestClient";

package/docs/changelog.md

@@ -1,5 +1,33 @@
 # @twin.org/document-management-rest-client - Changelog
 
+## [0.0.2-next.4](https://github.com/twinfoundation/document-management/compare/document-management-rest-client-v0.0.2-next.3...document-management-rest-client-v0.0.2-next.4) (2025-10-09)
+
+
+### Features
+
+* add validate-locales ([b6b6f9e](https://github.com/twinfoundation/document-management/commit/b6b6f9e9d66c17af3d030247ca168ac0b5844bdc))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/document-management-models bumped from 0.0.2-next.3 to 0.0.2-next.4
+
+## [0.0.2-next.3](https://github.com/twinfoundation/document-management/compare/document-management-rest-client-v0.0.2-next.2...document-management-rest-client-v0.0.2-next.3) (2025-09-29)
+
+
+### Features
+
+* use targetId in AIG for edges ([82dec81](https://github.com/twinfoundation/document-management/commit/82dec8190d8b523b350ef133bdcf648cab1023b0))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/document-management-models bumped from 0.0.2-next.2 to 0.0.2-next.3
+
 ## [0.0.2-next.2](https://github.com/twinfoundation/document-management/compare/document-management-rest-client-v0.0.2-next.1...document-management-rest-client-v0.0.2-next.2) (2025-08-29)
 
 

package/docs/reference/classes/{DocumentManagementClient.md → DocumentManagementRestClient.md}

@@ -1,4 +1,4 @@
-# Class: DocumentManagementClient
+# Class: DocumentManagementRestClient
 
 Client for performing document management through to REST endpoints.
 
@@ -14,9 +14,9 @@ Client for performing document management through to REST endpoints.
 
 ### Constructor
 
-> **new DocumentManagementClient**(`config`): `DocumentManagementClient`
+> **new DocumentManagementRestClient**(`config`): `DocumentManagementRestClient`
 
-Create a new instance of DocumentManagementClient.
+Create a new instance of DocumentManagementRestClient.
 
 #### Parameters
 
@@ -28,7 +28,7 @@ The configuration for the client.
 
 #### Returns
 
-`DocumentManagementClient`
+`DocumentManagementRestClient`
 
 #### Overrides
 
@@ -38,14 +38,10 @@ The configuration for the client.
 
 ### CLASS\_NAME
 
-> `readonly` **CLASS\_NAME**: `string` = `DocumentManagementClient._CLASS_NAME`
+> `readonly` `static` **CLASS\_NAME**: `string`
 
 Runtime name for the class.
 
-#### Implementation of
-
-`IDocumentManagementComponent.CLASS_NAME`
-
 ## Methods
 
 ### create()
@@ -176,7 +172,7 @@ Nothing.
 
 ### get()
 
-> **get**(`auditableItemGraphDocumentId`, `options?`, `cursor?`, `pageSize?`): `Promise`\<`IDocumentList`\>
+> **get**(`auditableItemGraphDocumentId`, `options?`, `cursor?`, `limit?`): `Promise`\<`IDocumentList`\>
 
 Get a document using it's auditable item graph vertex id and optional revision.
 
@@ -234,11 +230,11 @@ By default extraction will auto detect the mime type of the document, this can b
 
 The cursor to get the next chunk of revisions.
 
-##### pageSize?
+##### limit?
 
 `number`
 
-Page size of items to return, defaults to 1 so only most recent is returned.
+The limit of items to return, defaults to 1 so only most recent is returned.
 
 #### Returns
 
@@ -353,7 +349,7 @@ Nothing.
 
 ### query()
 
-> **query**(`documentId`, `cursor?`, `pageSize?`): `Promise`\<`IAuditableItemGraphVertexList`\>
+> **query**(`documentId`, `cursor?`, `limit?`): `Promise`\<`IAuditableItemGraphVertexList`\>
 
 Find all the document with a specific id.
 
@@ -371,11 +367,11 @@ The document id to find in the graph.
 
 The cursor to get the next chunk of documents.
 
-##### pageSize?
+##### limit?
 
 `number`
 
-The page size to get the next chunk of documents.
+The limit to get the next chunk of documents.
 
 #### Returns
 

package/docs/reference/index.md

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

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/document-management-rest-client",
-	"version": "0.0.2-next.2",
+	"version": "0.0.2-next.4",
 	"description": "Document management contract implementation which can connect to REST endpoints",
 	"repository": {
 		"type": "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.2-next.2",
+		"@twin.org/document-management-models": "0.0.2-next.4",
 		"@twin.org/entity": "next",
 		"@twin.org/nameof": "next",
 		"@twin.org/standards-unece": "next",
@@ -42,5 +42,21 @@
 		"dist/types",
 		"locales",
 		"docs"
-	]
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"document-management",
+		"documents",
+		"management",
+		"storage",
+		"rest-api"
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/document-management/issues"
+	},
+	"homepage": "https://twindev.org"
 }