@twin.org/document-management-rest-client 0.0.1-next.10

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 IOTA Stiftung.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,21 @@
+# TWIN Document Management REST Client
+
+Document management processing contract implementation which can connect to REST endpoints.
+
+## Installation
+
+```shell
+npm install @twin.org/document-management-rest-client
+```
+
+## Examples
+
+Usage of the APIs is shown in the examples [docs/examples.md](docs/examples.md)
+
+## Reference
+
+Detailed reference documentation for the API can be found in [docs/reference/index.md](docs/reference/index.md)
+
+## Changelog
+
+The changes between each version can be found in [docs/changelog.md](docs/changelog.md)

package/dist/cjs/index.cjs

@@ -0,0 +1,153 @@
+'use strict';
+
+var apiCore = require('@twin.org/api-core');
+var core = require('@twin.org/core');
+var standardsUnece = require('@twin.org/standards-unece');
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Client for performing document management through to REST endpoints.
+ */
+class DocumentManagementClient extends apiCore.BaseRestClient {
+    /**
+     * Runtime name for the class.
+     * @internal
+     */
+    static _CLASS_NAME = "DocumentManagementClient";
+    /**
+     * Runtime name for the class.
+     */
+    CLASS_NAME = DocumentManagementClient._CLASS_NAME;
+    /**
+     * Create a new instance of DocumentManagementClient.
+     * @param config The configuration for the client.
+     */
+    constructor(config) {
+        super(DocumentManagementClient._CLASS_NAME, config, "document-management");
+    }
+    /**
+     * Store a document as an auditable item graph vertex and add its content to blob storage.
+     * If the document id already exists and the blob data is different a new revision will be created.
+     * For any other changes the current revision will be updated.
+     * @param documentId The document id to create.
+     * @param documentIdFormat The format of the document identifier.
+     * @param documentCode The code for the document type.
+     * @param blob The data to create the document with.
+     * @param annotationObject Additional information to associate with the document.
+     * @param auditableItemGraphEdges The auditable item graph vertices to connect the document to.
+     * @param options Additional options for the set operation.
+     * @param options.createAttestation Flag to create an attestation for the document, defaults to false.
+     * @param options.addAlias Flag to add the document id as an alias to the aig vertex, defaults to true.
+     * @param options.aliasAnnotationObject Annotation object for the alias.
+     * @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);
+        const response = await this.fetch("/", "POST", {
+            body: {
+                documentId,
+                documentIdFormat,
+                documentCode,
+                blob: core.Converter.bytesToBase64(blob),
+                annotationObject,
+                auditableItemGraphEdges,
+                createAttestation: options?.createAttestation,
+                addAlias: options?.addAlias,
+                aliasAnnotationObject: options?.aliasAnnotationObject
+            }
+        });
+        return response.headers.location;
+    }
+    /**
+     * Update a document as an auditable item graph vertex and add its content to blob storage.
+     * If the blob data is different a new revision will be created.
+     * For any other changes the current revision will be updated.
+     * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.
+     * @param blob The data to update the document with.
+     * @param annotationObject Additional information to associate with the document.
+     * @param auditableItemGraphEdges The auditable item graph vertices to connect the document to, if undefined retains current connections.
+     * @returns Nothing.
+     */
+    async update(auditableItemGraphDocumentId, blob, annotationObject, auditableItemGraphEdges) {
+        core.Urn.guard(this.CLASS_NAME, "auditableItemGraphDocumentId", auditableItemGraphDocumentId);
+        await this.fetch("/:auditableItemGraphDocumentId", "PUT", {
+            pathParams: {
+                auditableItemGraphDocumentId
+            },
+            body: {
+                blob: core.Is.uint8Array(blob) ? core.Converter.bytesToBase64(blob) : undefined,
+                annotationObject,
+                auditableItemGraphEdges
+            }
+        });
+    }
+    /**
+     * Get a document using it's auditable item graph vertex id and optional revision.
+     * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.
+     * @param options Additional options for the get operation.
+     * @param options.includeBlobStorageMetadata Flag to include the blob storage metadata for the document, defaults to false.
+     * @param options.includeBlobStorageData Flag to include the blob storage data for the document, defaults to false.
+     * @param options.includeAttestation Flag to include the attestation information for the document, defaults to false.
+     * @param options.includeRemoved Flag to include deleted documents, defaults to false.
+     * @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.
+     * @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);
+        const response = await this.fetch("/:auditableItemGraphDocumentId", "GET", {
+            pathParams: {
+                auditableItemGraphDocumentId
+            },
+            query: {
+                includeBlobStorageMetadata: options?.includeBlobStorageMetadata,
+                includeBlobStorageData: options?.includeBlobStorageData,
+                includeAttestation: options?.includeAttestation,
+                includeRemoved: options?.includeRemoved,
+                cursor,
+                pageSize: core.Coerce.string(pageSize)
+            }
+        });
+        return response.body;
+    }
+    /**
+     * Remove an auditable item graph vertex using it's id.
+     * The document dateDeleted will be set, but can still be queried with the includeRemoved flag.
+     * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.
+     * @param revision The revision of the document to remove.
+     * @returns Nothing.
+     */
+    async removeRevision(auditableItemGraphDocumentId, revision) {
+        core.Urn.guard(this.CLASS_NAME, "auditableItemGraphDocumentId", auditableItemGraphDocumentId);
+        core.Guards.number(this.CLASS_NAME, "revision", revision);
+        await this.fetch("/:auditableItemGraphDocumentId/:revision", "DELETE", {
+            pathParams: {
+                auditableItemGraphDocumentId,
+                revision: revision.toString()
+            }
+        });
+    }
+    /**
+     * 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.
+     * @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);
+        const response = await this.fetch("/", "GET", {
+            query: {
+                documentId,
+                cursor,
+                pageSize: core.Coerce.string(pageSize)
+            }
+        });
+        return response.body;
+    }
+}
+
+exports.DocumentManagementClient = DocumentManagementClient;

package/dist/esm/index.mjs

@@ -0,0 +1,151 @@
+import { BaseRestClient } from '@twin.org/api-core';
+import { Guards, Converter, Urn, Is, Coerce } from '@twin.org/core';
+import { UneceDocumentCodes } from '@twin.org/standards-unece';
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Client for performing document management through to REST endpoints.
+ */
+class DocumentManagementClient extends BaseRestClient {
+    /**
+     * Runtime name for the class.
+     * @internal
+     */
+    static _CLASS_NAME = "DocumentManagementClient";
+    /**
+     * Runtime name for the class.
+     */
+    CLASS_NAME = DocumentManagementClient._CLASS_NAME;
+    /**
+     * Create a new instance of DocumentManagementClient.
+     * @param config The configuration for the client.
+     */
+    constructor(config) {
+        super(DocumentManagementClient._CLASS_NAME, config, "document-management");
+    }
+    /**
+     * Store a document as an auditable item graph vertex and add its content to blob storage.
+     * If the document id already exists and the blob data is different a new revision will be created.
+     * For any other changes the current revision will be updated.
+     * @param documentId The document id to create.
+     * @param documentIdFormat The format of the document identifier.
+     * @param documentCode The code for the document type.
+     * @param blob The data to create the document with.
+     * @param annotationObject Additional information to associate with the document.
+     * @param auditableItemGraphEdges The auditable item graph vertices to connect the document to.
+     * @param options Additional options for the set operation.
+     * @param options.createAttestation Flag to create an attestation for the document, defaults to false.
+     * @param options.addAlias Flag to add the document id as an alias to the aig vertex, defaults to true.
+     * @param options.aliasAnnotationObject Annotation object for the alias.
+     * @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);
+        const response = await this.fetch("/", "POST", {
+            body: {
+                documentId,
+                documentIdFormat,
+                documentCode,
+                blob: Converter.bytesToBase64(blob),
+                annotationObject,
+                auditableItemGraphEdges,
+                createAttestation: options?.createAttestation,
+                addAlias: options?.addAlias,
+                aliasAnnotationObject: options?.aliasAnnotationObject
+            }
+        });
+        return response.headers.location;
+    }
+    /**
+     * Update a document as an auditable item graph vertex and add its content to blob storage.
+     * If the blob data is different a new revision will be created.
+     * For any other changes the current revision will be updated.
+     * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.
+     * @param blob The data to update the document with.
+     * @param annotationObject Additional information to associate with the document.
+     * @param auditableItemGraphEdges The auditable item graph vertices to connect the document to, if undefined retains current connections.
+     * @returns Nothing.
+     */
+    async update(auditableItemGraphDocumentId, blob, annotationObject, auditableItemGraphEdges) {
+        Urn.guard(this.CLASS_NAME, "auditableItemGraphDocumentId", auditableItemGraphDocumentId);
+        await this.fetch("/:auditableItemGraphDocumentId", "PUT", {
+            pathParams: {
+                auditableItemGraphDocumentId
+            },
+            body: {
+                blob: Is.uint8Array(blob) ? Converter.bytesToBase64(blob) : undefined,
+                annotationObject,
+                auditableItemGraphEdges
+            }
+        });
+    }
+    /**
+     * Get a document using it's auditable item graph vertex id and optional revision.
+     * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.
+     * @param options Additional options for the get operation.
+     * @param options.includeBlobStorageMetadata Flag to include the blob storage metadata for the document, defaults to false.
+     * @param options.includeBlobStorageData Flag to include the blob storage data for the document, defaults to false.
+     * @param options.includeAttestation Flag to include the attestation information for the document, defaults to false.
+     * @param options.includeRemoved Flag to include deleted documents, defaults to false.
+     * @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.
+     * @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);
+        const response = await this.fetch("/:auditableItemGraphDocumentId", "GET", {
+            pathParams: {
+                auditableItemGraphDocumentId
+            },
+            query: {
+                includeBlobStorageMetadata: options?.includeBlobStorageMetadata,
+                includeBlobStorageData: options?.includeBlobStorageData,
+                includeAttestation: options?.includeAttestation,
+                includeRemoved: options?.includeRemoved,
+                cursor,
+                pageSize: Coerce.string(pageSize)
+            }
+        });
+        return response.body;
+    }
+    /**
+     * Remove an auditable item graph vertex using it's id.
+     * The document dateDeleted will be set, but can still be queried with the includeRemoved flag.
+     * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.
+     * @param revision The revision of the document to remove.
+     * @returns Nothing.
+     */
+    async removeRevision(auditableItemGraphDocumentId, revision) {
+        Urn.guard(this.CLASS_NAME, "auditableItemGraphDocumentId", auditableItemGraphDocumentId);
+        Guards.number(this.CLASS_NAME, "revision", revision);
+        await this.fetch("/:auditableItemGraphDocumentId/:revision", "DELETE", {
+            pathParams: {
+                auditableItemGraphDocumentId,
+                revision: revision.toString()
+            }
+        });
+    }
+    /**
+     * 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.
+     * @returns The graph vertices that contain documents referencing the specified document id.
+     */
+    async query(documentId, cursor, pageSize) {
+        Guards.stringValue(this.CLASS_NAME, "documentId", documentId);
+        const response = await this.fetch("/", "GET", {
+            query: {
+                documentId,
+                cursor,
+                pageSize: Coerce.string(pageSize)
+            }
+        });
+        return response.body;
+    }
+}
+
+export { DocumentManagementClient };

package/dist/types/documentManagementClient.d.ts

@@ -0,0 +1,94 @@
+import { BaseRestClient } from "@twin.org/api-core";
+import type { IBaseRestClientConfig } from "@twin.org/api-models";
+import type { IAuditableItemGraphVertexList } from "@twin.org/auditable-item-graph-models";
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+import type { IDocumentList, IDocumentManagementComponent } from "@twin.org/document-management-models";
+import { UneceDocumentCodes } from "@twin.org/standards-unece";
+/**
+ * Client for performing document management through to REST endpoints.
+ */
+export declare class DocumentManagementClient extends BaseRestClient implements IDocumentManagementComponent {
+    /**
+     * Runtime name for the class.
+     */
+    readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of DocumentManagementClient.
+     * @param config The configuration for the client.
+     */
+    constructor(config: IBaseRestClientConfig);
+    /**
+     * Store a document as an auditable item graph vertex and add its content to blob storage.
+     * If the document id already exists and the blob data is different a new revision will be created.
+     * For any other changes the current revision will be updated.
+     * @param documentId The document id to create.
+     * @param documentIdFormat The format of the document identifier.
+     * @param documentCode The code for the document type.
+     * @param blob The data to create the document with.
+     * @param annotationObject Additional information to associate with the document.
+     * @param auditableItemGraphEdges The auditable item graph vertices to connect the document to.
+     * @param options Additional options for the set operation.
+     * @param options.createAttestation Flag to create an attestation for the document, defaults to false.
+     * @param options.addAlias Flag to add the document id as an alias to the aig vertex, defaults to true.
+     * @param options.aliasAnnotationObject Annotation object for the alias.
+     * @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;
+        addAlias?: boolean;
+        aliasAnnotationObject?: IJsonLdNodeObject;
+    }[], options?: {
+        createAttestation?: boolean;
+        addAlias?: boolean;
+        aliasAnnotationObject?: IJsonLdNodeObject;
+    }): Promise<string>;
+    /**
+     * Update a document as an auditable item graph vertex and add its content to blob storage.
+     * If the blob data is different a new revision will be created.
+     * For any other changes the current revision will be updated.
+     * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.
+     * @param blob The data to update the document with.
+     * @param annotationObject Additional information to associate with the document.
+     * @param auditableItemGraphEdges The auditable item graph vertices to connect the document to, if undefined retains current connections.
+     * @returns Nothing.
+     */
+    update(auditableItemGraphDocumentId: string, blob?: Uint8Array, annotationObject?: IJsonLdNodeObject, auditableItemGraphEdges?: {
+        id: string;
+        addAlias?: boolean;
+        aliasAnnotationObject?: IJsonLdNodeObject;
+    }[]): Promise<void>;
+    /**
+     * Get a document using it's auditable item graph vertex id and optional revision.
+     * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.
+     * @param options Additional options for the get operation.
+     * @param options.includeBlobStorageMetadata Flag to include the blob storage metadata for the document, defaults to false.
+     * @param options.includeBlobStorageData Flag to include the blob storage data for the document, defaults to false.
+     * @param options.includeAttestation Flag to include the attestation information for the document, defaults to false.
+     * @param options.includeRemoved Flag to include deleted documents, defaults to false.
+     * @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.
+     * @returns The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
+     */
+    get(auditableItemGraphDocumentId: string, options?: {
+        includeBlobStorageMetadata?: boolean;
+        includeBlobStorageData?: boolean;
+        includeAttestation?: boolean;
+        includeRemoved?: boolean;
+    }, cursor?: string, pageSize?: number): Promise<IDocumentList>;
+    /**
+     * Remove an auditable item graph vertex using it's id.
+     * The document dateDeleted will be set, but can still be queried with the includeRemoved flag.
+     * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.
+     * @param revision The revision of the document to remove.
+     * @returns Nothing.
+     */
+    removeRevision(auditableItemGraphDocumentId: string, revision: number): Promise<void>;
+    /**
+     * 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.
+     * @returns The graph vertices that contain documents referencing the specified document id.
+     */
+    query(documentId: string, cursor?: string, pageSize?: number): Promise<IAuditableItemGraphVertexList>;
+}

package/dist/types/index.d.ts

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

package/docs/changelog.md

@@ -0,0 +1,47 @@
+# @twin.org/document-management-rest-client - Changelog
+
+## [0.0.1-next.10](https://github.com/twinfoundation/document-management/compare/document-management-rest-client-v0.0.1-next.9...document-management-rest-client-v0.0.1-next.10) (2025-04-25)
+
+
+### Bug Fixes
+
+* adding missing route for the document management ([#4](https://github.com/twinfoundation/document-management/issues/4)) ([fd3292e](https://github.com/twinfoundation/document-management/commit/fd3292ede5014847ae2f2bcadb174b6552486154))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/document-management-models bumped from 0.0.1-next.9 to 0.0.1-next.10
+
+## [0.0.1-next.9](https://github.com/twinfoundation/document-management/compare/document-management-rest-client-v0.0.1-next.8...document-management-rest-client-v0.0.1-next.9) (2025-04-17)
+
+
+### Features
+
+* store document as a vertex ([#2](https://github.com/twinfoundation/document-management/issues/2)) ([7febedc](https://github.com/twinfoundation/document-management/commit/7febedc3fb31de9c19565d6326341046834f2c74))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/document-management-models bumped from 0.0.1-next.8 to 0.0.1-next.9
+
+## [0.0.1-next.8](https://github.com/twinfoundation/document-management/compare/document-management-rest-client-v0.0.1-next.7...document-management-rest-client-v0.0.1-next.8) (2025-03-28)
+
+
+### 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.1-next.7 to 0.0.1-next.8
+
+## v0.0.1-next.7
+
+- Initial Release

package/docs/examples.md

@@ -0,0 +1 @@
+# @twin.org/document-management-rest-client - Examples

package/docs/reference/classes/DocumentManagementClient.md

@@ -0,0 +1,310 @@
+# Class: DocumentManagementClient
+
+Client for performing document management through to REST endpoints.
+
+## Extends
+
+- `BaseRestClient`
+
+## Implements
+
+- `IDocumentManagementComponent`
+
+## Constructors
+
+### Constructor
+
+> **new DocumentManagementClient**(`config`): `DocumentManagementClient`
+
+Create a new instance of DocumentManagementClient.
+
+#### Parameters
+
+##### config
+
+`IBaseRestClientConfig`
+
+The configuration for the client.
+
+#### Returns
+
+`DocumentManagementClient`
+
+#### Overrides
+
+`BaseRestClient.constructor`
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` **CLASS\_NAME**: `string` = `DocumentManagementClient._CLASS_NAME`
+
+Runtime name for the class.
+
+#### Implementation of
+
+`IDocumentManagementComponent.CLASS_NAME`
+
+## Methods
+
+### create()
+
+> **create**(`documentId`, `documentIdFormat`, `documentCode`, `blob`, `annotationObject?`, `auditableItemGraphEdges?`, `options?`): `Promise`\<`string`\>
+
+Store a document as an auditable item graph vertex and add its content to blob storage.
+If the document id already exists and the blob data is different a new revision will be created.
+For any other changes the current revision will be updated.
+
+#### Parameters
+
+##### documentId
+
+`string`
+
+The document id to create.
+
+##### documentIdFormat
+
+The format of the document identifier.
+
+`undefined` | `string`
+
+##### documentCode
+
+`string`
+
+The code for the document type.
+
+##### blob
+
+`Uint8Array`
+
+The data to create the document with.
+
+##### annotationObject?
+
+`IJsonLdNodeObject`
+
+Additional information to associate with the document.
+
+##### auditableItemGraphEdges?
+
+`object`[]
+
+The auditable item graph vertices to connect the document to.
+
+##### options?
+
+Additional options for the set operation.
+
+###### createAttestation?
+
+`boolean`
+
+Flag to create an attestation for the document, defaults to false.
+
+###### addAlias?
+
+`boolean`
+
+Flag to add the document id as an alias to the aig vertex, defaults to true.
+
+###### aliasAnnotationObject?
+
+`IJsonLdNodeObject`
+
+Annotation object for the alias.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The auditable item graph vertex created for the document including its revision.
+
+#### Implementation of
+
+`IDocumentManagementComponent.create`
+
+***
+
+### update()
+
+> **update**(`auditableItemGraphDocumentId`, `blob?`, `annotationObject?`, `auditableItemGraphEdges?`): `Promise`\<`void`\>
+
+Update a document as an auditable item graph vertex and add its content to blob storage.
+If the blob data is different a new revision will be created.
+For any other changes the current revision will be updated.
+
+#### Parameters
+
+##### auditableItemGraphDocumentId
+
+`string`
+
+The auditable item graph vertex id which contains the document.
+
+##### blob?
+
+`Uint8Array`\<`ArrayBufferLike`\>
+
+The data to update the document with.
+
+##### annotationObject?
+
+`IJsonLdNodeObject`
+
+Additional information to associate with the document.
+
+##### auditableItemGraphEdges?
+
+`object`[]
+
+The auditable item graph vertices to connect the document to, if undefined retains current connections.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IDocumentManagementComponent.update`
+
+***
+
+### get()
+
+> **get**(`auditableItemGraphDocumentId`, `options?`, `cursor?`, `pageSize?`): `Promise`\<`IDocumentList`\>
+
+Get a document using it's auditable item graph vertex id and optional revision.
+
+#### Parameters
+
+##### auditableItemGraphDocumentId
+
+`string`
+
+The auditable item graph vertex id which contains the document.
+
+##### options?
+
+Additional options for the get operation.
+
+###### includeBlobStorageMetadata?
+
+`boolean`
+
+Flag to include the blob storage metadata for the document, defaults to false.
+
+###### includeBlobStorageData?
+
+`boolean`
+
+Flag to include the blob storage data for the document, defaults to false.
+
+###### includeAttestation?
+
+`boolean`
+
+Flag to include the attestation information for the document, defaults to false.
+
+###### includeRemoved?
+
+`boolean`
+
+Flag to include deleted documents, defaults to false.
+
+##### cursor?
+
+`string`
+
+The cursor to get the next chunk of revisions.
+
+##### pageSize?
+
+`number`
+
+Page size of items to return, defaults to 1 so only most recent is returned.
+
+#### Returns
+
+`Promise`\<`IDocumentList`\>
+
+The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
+
+#### Implementation of
+
+`IDocumentManagementComponent.get`
+
+***
+
+### removeRevision()
+
+> **removeRevision**(`auditableItemGraphDocumentId`, `revision`): `Promise`\<`void`\>
+
+Remove an auditable item graph vertex using it's id.
+The document dateDeleted will be set, but can still be queried with the includeRemoved flag.
+
+#### Parameters
+
+##### auditableItemGraphDocumentId
+
+`string`
+
+The auditable item graph vertex id which contains the document.
+
+##### revision
+
+`number`
+
+The revision of the document to remove.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IDocumentManagementComponent.removeRevision`
+
+***
+
+### query()
+
+> **query**(`documentId`, `cursor?`, `pageSize?`): `Promise`\<`IAuditableItemGraphVertexList`\>
+
+Find all the document with a specific id.
+
+#### Parameters
+
+##### documentId
+
+`string`
+
+The document id to find in the graph.
+
+##### cursor?
+
+`string`
+
+The cursor to get the next chunk of documents.
+
+##### pageSize?
+
+`number`
+
+The page size to get the next chunk of documents.
+
+#### Returns
+
+`Promise`\<`IAuditableItemGraphVertexList`\>
+
+The graph vertices that contain documents referencing the specified document id.
+
+#### Implementation of
+
+`IDocumentManagementComponent.query`

package/docs/reference/index.md

@@ -0,0 +1,5 @@
+# @twin.org/document-management-rest-client
+
+## Classes
+
+- [DocumentManagementClient](classes/DocumentManagementClient.md)

package/locales/en.json

@@ -0,0 +1 @@
+{}

package/package.json

@@ -0,0 +1,46 @@
+{
+	"name": "@twin.org/document-management-rest-client",
+	"version": "0.0.1-next.10",
+	"description": "Document management contract implementation which can connect to REST endpoints",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/document-management.git",
+		"directory": "packages/document-management-rest-client"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"dependencies": {
+		"@twin.org/api-core": "next",
+		"@twin.org/api-models": "next",
+		"@twin.org/auditable-item-graph-models": "next",
+		"@twin.org/core": "next",
+		"@twin.org/data-json-ld": "next",
+		"@twin.org/document-management-models": "0.0.1-next.10",
+		"@twin.org/entity": "next",
+		"@twin.org/nameof": "next",
+		"@twin.org/standards-unece": "next",
+		"@twin.org/web": "next"
+	},
+	"main": "./dist/cjs/index.cjs",
+	"module": "./dist/esm/index.mjs",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/types/index.d.ts",
+			"require": "./dist/cjs/index.cjs",
+			"import": "./dist/esm/index.mjs"
+		},
+		"./locales/*.json": "./locales/*.json"
+	},
+	"files": [
+		"dist/cjs",
+		"dist/esm",
+		"dist/types",
+		"locales",
+		"docs"
+	]
+}