@twin.org/document-management-rest-client 0.0.1-next.2 → 0.0.1-next.20

package/dist/cjs/index.cjs

@@ -1,7 +1,6 @@
 'use strict';
 
 var apiCore = require('@twin.org/api-core');
-var apiModels = require('@twin.org/api-models');
 var core = require('@twin.org/core');
 var standardsUnece = require('@twin.org/standards-unece');
 
@@ -25,118 +24,160 @@ class DocumentManagementClient extends apiCore.BaseRestClient {
      * @param config The configuration for the client.
      */
     constructor(config) {
-        super(DocumentManagementClient._CLASS_NAME, config, "documents");
+        super(DocumentManagementClient._CLASS_NAME, config, "document-management");
     }
     /**
-     * Store a document in an auditable item graph vertex and add its content to blob storage.
+     * 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 auditableItemGraphId The auditable item graph vertex id to create the document on.
      * @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.
+     * @param blob The data to create the document with.
      * @param annotationObject Additional information to associate with the document.
-     * @param createAttestation Flag to create an attestation for the document, defaults to false.
-     * @returns The identifier for the document which includes the auditable item graph identifier.
+     * @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 set(auditableItemGraphId, documentId, documentIdFormat, documentCode, blob, annotationObject, createAttestation) {
-        core.Guards.stringValue(this.CLASS_NAME, "auditableItemGraphId", auditableItemGraphId);
+    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("/:auditableItemGraphId", "POST", {
-            pathParams: {
-                auditableItemGraphId
-            },
+        const response = await this.fetch("/", "POST", {
             body: {
                 documentId,
                 documentIdFormat,
                 documentCode,
                 blob: core.Converter.bytesToBase64(blob),
                 annotationObject,
-                createAttestation
+                auditableItemGraphEdges,
+                createAttestation: options?.createAttestation,
+                addAlias: options?.addAlias,
+                aliasAnnotationObject: options?.aliasAnnotationObject
             }
         });
         return response.headers.location;
     }
     /**
-     * Get a specific document from an auditable item graph vertex.
-     * @param auditableItemGraphId The auditable item graph vertex id to get the document from.
-     * @param identifier The identifier of the document to get.
+     * 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 options.maxRevisionCount Max number of revisions to return, defaults to 0.
-     * @param revisionCursor The cursor to get the next chunk of revisions.
+     * @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.
      * @returns The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
      */
-    async get(auditableItemGraphId, identifier, options, revisionCursor) {
-        core.Urn.guard(this.CLASS_NAME, "auditableItemGraphId", auditableItemGraphId);
-        core.Urn.guard(this.CLASS_NAME, "identifier", identifier);
-        const response = await this.fetch("/:auditableItemGraphId/:documentId", "GET", {
+    async get(auditableItemGraphDocumentId, options, cursor, pageSize) {
+        core.Urn.guard(this.CLASS_NAME, "auditableItemGraphDocumentId", auditableItemGraphDocumentId);
+        const response = await this.fetch("/:auditableItemGraphDocumentId", "GET", {
             pathParams: {
-                auditableItemGraphId,
-                documentId: identifier
+                auditableItemGraphDocumentId
             },
             query: {
                 includeBlobStorageMetadata: options?.includeBlobStorageMetadata,
                 includeBlobStorageData: options?.includeBlobStorageData,
                 includeAttestation: options?.includeAttestation,
                 includeRemoved: options?.includeRemoved,
-                maxRevisionCount: options?.maxRevisionCount,
-                revisionCursor
+                extractRuleGroupId: options?.extractRuleGroupId,
+                extractMimeType: options?.extractMimeType,
+                cursor,
+                pageSize: core.Coerce.string(pageSize)
             }
         });
         return response.body;
     }
     /**
-     * Remove a specific document from an auditable item graph vertex.
-     * The documents dateDeleted will be set, but can still be queried with the includeRemoved flag.
-     * @param auditableItemGraphId The auditable item graph vertex id to remove the document from.
-     * @param identifier The identifier of the document to remove.
-     * @param options Additional options for the remove operation.
-     * @param options.removeAllRevisions Flag to remove all revisions of the document, defaults to false.
-     * @returns Nothing.
+     * Get a document revision using it's auditable item graph vertex id.
+     * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.
+     * @param revision The revision id for 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.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.
+     * @returns The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
      */
-    async remove(auditableItemGraphId, identifier, options) {
-        core.Urn.guard(this.CLASS_NAME, "auditableItemGraphId", auditableItemGraphId);
-        core.Urn.guard(this.CLASS_NAME, "identifier", identifier);
-        await this.fetch("/:auditableItemGraphId/:documentId", "DELETE", {
+    async getRevision(auditableItemGraphDocumentId, revision, options) {
+        core.Urn.guard(this.CLASS_NAME, "auditableItemGraphDocumentId", auditableItemGraphDocumentId);
+        core.Guards.integer(this.CLASS_NAME, "revision", revision);
+        const response = await this.fetch("/:auditableItemGraphDocumentId/:revision", "GET", {
             pathParams: {
-                auditableItemGraphId,
-                documentId: identifier
+                auditableItemGraphDocumentId,
+                revision: revision.toString()
             },
             query: {
-                removeAllRevisions: options?.removeAllRevisions
+                includeBlobStorageMetadata: options?.includeBlobStorageMetadata,
+                includeBlobStorageData: options?.includeBlobStorageData,
+                includeAttestation: options?.includeAttestation,
+                extractRuleGroupId: options?.extractRuleGroupId,
+                extractMimeType: options?.extractMimeType
             }
         });
+        return response.body;
     }
     /**
-     * Query an auditable item graph vertex for documents.
-     * @param auditableItemGraphId The auditable item graph vertex to get the documents from.
-     * @param documentCodes The document codes to query for, if undefined gets all document codes.
-     * @param options Additional options for the query operation.
-     * @param options.includeMostRecentRevisions Include the most recent 5 revisions, use the individual get to retrieve more.
-     * @param options.includeRemoved Flag to include deleted documents, defaults to false.
-     * @param cursor The cursor to get the next chunk of documents.
-     * @returns The most recent revisions of each document, cursor is set if there are more documents.
+     * 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 query(auditableItemGraphId, documentCodes, options, cursor) {
-        core.Urn.guard(this.CLASS_NAME, "auditableItemGraphId", auditableItemGraphId);
-        const response = await this.fetch("/:auditableItemGraphId", "GET", {
+    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: {
-                auditableItemGraphId
-            },
+                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: {
-                documentCodes: core.Is.arrayValue(documentCodes)
-                    ? apiModels.HttpParameterHelper.arrayToString(documentCodes)
-                    : undefined,
-                includeMostRecentRevisions: options?.includeMostRecentRevisions,
-                includeRemoved: options?.includeRemoved,
-                cursor
+                documentId,
+                cursor,
+                pageSize: core.Coerce.string(pageSize)
             }
         });
         return response.body;

package/dist/esm/index.mjs

@@ -1,6 +1,5 @@
 import { BaseRestClient } from '@twin.org/api-core';
-import { HttpParameterHelper } from '@twin.org/api-models';
-import { Guards, Converter, Urn, Is } from '@twin.org/core';
+import { Guards, Converter, Urn, Is, Coerce } from '@twin.org/core';
 import { UneceDocumentCodes } from '@twin.org/standards-unece';
 
 // Copyright 2024 IOTA Stiftung.
@@ -23,118 +22,160 @@ class DocumentManagementClient extends BaseRestClient {
      * @param config The configuration for the client.
      */
     constructor(config) {
-        super(DocumentManagementClient._CLASS_NAME, config, "documents");
+        super(DocumentManagementClient._CLASS_NAME, config, "document-management");
     }
     /**
-     * Store a document in an auditable item graph vertex and add its content to blob storage.
+     * 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 auditableItemGraphId The auditable item graph vertex id to create the document on.
      * @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.
+     * @param blob The data to create the document with.
      * @param annotationObject Additional information to associate with the document.
-     * @param createAttestation Flag to create an attestation for the document, defaults to false.
-     * @returns The identifier for the document which includes the auditable item graph identifier.
+     * @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 set(auditableItemGraphId, documentId, documentIdFormat, documentCode, blob, annotationObject, createAttestation) {
-        Guards.stringValue(this.CLASS_NAME, "auditableItemGraphId", auditableItemGraphId);
+    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("/:auditableItemGraphId", "POST", {
-            pathParams: {
-                auditableItemGraphId
-            },
+        const response = await this.fetch("/", "POST", {
             body: {
                 documentId,
                 documentIdFormat,
                 documentCode,
                 blob: Converter.bytesToBase64(blob),
                 annotationObject,
-                createAttestation
+                auditableItemGraphEdges,
+                createAttestation: options?.createAttestation,
+                addAlias: options?.addAlias,
+                aliasAnnotationObject: options?.aliasAnnotationObject
             }
         });
         return response.headers.location;
     }
     /**
-     * Get a specific document from an auditable item graph vertex.
-     * @param auditableItemGraphId The auditable item graph vertex id to get the document from.
-     * @param identifier The identifier of the document to get.
+     * 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 options.maxRevisionCount Max number of revisions to return, defaults to 0.
-     * @param revisionCursor The cursor to get the next chunk of revisions.
+     * @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.
      * @returns The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
      */
-    async get(auditableItemGraphId, identifier, options, revisionCursor) {
-        Urn.guard(this.CLASS_NAME, "auditableItemGraphId", auditableItemGraphId);
-        Urn.guard(this.CLASS_NAME, "identifier", identifier);
-        const response = await this.fetch("/:auditableItemGraphId/:documentId", "GET", {
+    async get(auditableItemGraphDocumentId, options, cursor, pageSize) {
+        Urn.guard(this.CLASS_NAME, "auditableItemGraphDocumentId", auditableItemGraphDocumentId);
+        const response = await this.fetch("/:auditableItemGraphDocumentId", "GET", {
             pathParams: {
-                auditableItemGraphId,
-                documentId: identifier
+                auditableItemGraphDocumentId
             },
             query: {
                 includeBlobStorageMetadata: options?.includeBlobStorageMetadata,
                 includeBlobStorageData: options?.includeBlobStorageData,
                 includeAttestation: options?.includeAttestation,
                 includeRemoved: options?.includeRemoved,
-                maxRevisionCount: options?.maxRevisionCount,
-                revisionCursor
+                extractRuleGroupId: options?.extractRuleGroupId,
+                extractMimeType: options?.extractMimeType,
+                cursor,
+                pageSize: Coerce.string(pageSize)
             }
         });
         return response.body;
     }
     /**
-     * Remove a specific document from an auditable item graph vertex.
-     * The documents dateDeleted will be set, but can still be queried with the includeRemoved flag.
-     * @param auditableItemGraphId The auditable item graph vertex id to remove the document from.
-     * @param identifier The identifier of the document to remove.
-     * @param options Additional options for the remove operation.
-     * @param options.removeAllRevisions Flag to remove all revisions of the document, defaults to false.
-     * @returns Nothing.
+     * Get a document revision using it's auditable item graph vertex id.
+     * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.
+     * @param revision The revision id for 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.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.
+     * @returns The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
      */
-    async remove(auditableItemGraphId, identifier, options) {
-        Urn.guard(this.CLASS_NAME, "auditableItemGraphId", auditableItemGraphId);
-        Urn.guard(this.CLASS_NAME, "identifier", identifier);
-        await this.fetch("/:auditableItemGraphId/:documentId", "DELETE", {
+    async getRevision(auditableItemGraphDocumentId, revision, options) {
+        Urn.guard(this.CLASS_NAME, "auditableItemGraphDocumentId", auditableItemGraphDocumentId);
+        Guards.integer(this.CLASS_NAME, "revision", revision);
+        const response = await this.fetch("/:auditableItemGraphDocumentId/:revision", "GET", {
             pathParams: {
-                auditableItemGraphId,
-                documentId: identifier
+                auditableItemGraphDocumentId,
+                revision: revision.toString()
             },
             query: {
-                removeAllRevisions: options?.removeAllRevisions
+                includeBlobStorageMetadata: options?.includeBlobStorageMetadata,
+                includeBlobStorageData: options?.includeBlobStorageData,
+                includeAttestation: options?.includeAttestation,
+                extractRuleGroupId: options?.extractRuleGroupId,
+                extractMimeType: options?.extractMimeType
             }
         });
+        return response.body;
     }
     /**
-     * Query an auditable item graph vertex for documents.
-     * @param auditableItemGraphId The auditable item graph vertex to get the documents from.
-     * @param documentCodes The document codes to query for, if undefined gets all document codes.
-     * @param options Additional options for the query operation.
-     * @param options.includeMostRecentRevisions Include the most recent 5 revisions, use the individual get to retrieve more.
-     * @param options.includeRemoved Flag to include deleted documents, defaults to false.
-     * @param cursor The cursor to get the next chunk of documents.
-     * @returns The most recent revisions of each document, cursor is set if there are more documents.
+     * 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 query(auditableItemGraphId, documentCodes, options, cursor) {
-        Urn.guard(this.CLASS_NAME, "auditableItemGraphId", auditableItemGraphId);
-        const response = await this.fetch("/:auditableItemGraphId", "GET", {
+    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: {
-                auditableItemGraphId
-            },
+                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: {
-                documentCodes: Is.arrayValue(documentCodes)
-                    ? HttpParameterHelper.arrayToString(documentCodes)
-                    : undefined,
-                includeMostRecentRevisions: options?.includeMostRecentRevisions,
-                includeRemoved: options?.includeRemoved,
-                cursor
+                documentId,
+                cursor,
+                pageSize: Coerce.string(pageSize)
             }
         });
         return response.body;

package/dist/types/documentManagementClient.d.ts

@@ -1,5 +1,6 @@
 import { BaseRestClient } from "@twin.org/api-core";
-import { type IBaseRestClientConfig } from "@twin.org/api-models";
+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 { IDocument, IDocumentList, IDocumentManagementComponent } from "@twin.org/document-management-models";
 import { UneceDocumentCodes } from "@twin.org/standards-unece";
@@ -17,63 +18,100 @@ export declare class DocumentManagementClient extends BaseRestClient implements
      */
     constructor(config: IBaseRestClientConfig);
     /**
-     * Store a document in an auditable item graph vertex and add its content to blob storage.
+     * 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 auditableItemGraphId The auditable item graph vertex id to create the document on.
      * @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.
+     * @param blob The data to create the document with.
      * @param annotationObject Additional information to associate with the document.
-     * @param createAttestation Flag to create an attestation for the document, defaults to false.
-     * @returns The identifier for the document which includes the auditable item graph identifier.
+     * @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.
      */
-    set(auditableItemGraphId: string, documentId: string, documentIdFormat: string | undefined, documentCode: UneceDocumentCodes, blob: Uint8Array, annotationObject?: IJsonLdNodeObject, createAttestation?: boolean): Promise<string>;
+    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>;
     /**
-     * Get a specific document from an auditable item graph vertex.
-     * @param auditableItemGraphId The auditable item graph vertex id to get the document from.
-     * @param identifier The identifier of the document to get.
+     * 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 options.maxRevisionCount Max number of revisions to return, defaults to 0.
-     * @param revisionCursor The cursor to get the next chunk of revisions.
+     * @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.
      * @returns The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
      */
-    get(auditableItemGraphId: string, identifier: string, options?: {
+    get(auditableItemGraphDocumentId: string, options?: {
         includeBlobStorageMetadata?: boolean;
         includeBlobStorageData?: boolean;
         includeAttestation?: boolean;
         includeRemoved?: boolean;
-        maxRevisionCount?: number;
-    }, revisionCursor?: string): Promise<IDocument>;
+        extractRuleGroupId?: string;
+        extractMimeType?: string;
+    }, cursor?: string, pageSize?: number): Promise<IDocumentList>;
     /**
-     * Remove a specific document from an auditable item graph vertex.
-     * The documents dateDeleted will be set, but can still be queried with the includeRemoved flag.
-     * @param auditableItemGraphId The auditable item graph vertex id to remove the document from.
-     * @param identifier The identifier of the document to remove.
-     * @param options Additional options for the remove operation.
-     * @param options.removeAllRevisions Flag to remove all revisions of the document, defaults to false.
+     * Get a document revision using it's auditable item graph vertex id.
+     * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.
+     * @param revision The revision id for 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.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.
+     * @returns The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
+     */
+    getRevision(auditableItemGraphDocumentId: string, revision: number, options?: {
+        includeBlobStorageMetadata?: boolean;
+        includeBlobStorageData?: boolean;
+        includeAttestation?: boolean;
+        extractRuleGroupId?: string;
+        extractMimeType?: string;
+    }): Promise<IDocument>;
+    /**
+     * 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.
      */
-    remove(auditableItemGraphId: string, identifier: string, options?: {
-        removeAllRevisions?: boolean;
-    }): Promise<void>;
+    removeRevision(auditableItemGraphDocumentId: string, revision: number): Promise<void>;
     /**
-     * Query an auditable item graph vertex for documents.
-     * @param auditableItemGraphId The auditable item graph vertex to get the documents from.
-     * @param documentCodes The document codes to query for, if undefined gets all document codes.
-     * @param options Additional options for the query operation.
-     * @param options.includeMostRecentRevisions Include the most recent 5 revisions, use the individual get to retrieve more.
-     * @param options.includeRemoved Flag to include deleted documents, defaults to false.
+     * 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.
-     * @returns The most recent revisions of each document, cursor is set if there are more 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(auditableItemGraphId: string, documentCodes?: UneceDocumentCodes[], options?: {
-        includeMostRecentRevisions?: boolean;
-        includeRemoved?: boolean;
-    }, cursor?: string): Promise<IDocumentList>;
+    query(documentId: string, cursor?: string, pageSize?: number): Promise<IAuditableItemGraphVertexList>;
 }

package/docs/changelog.md

@@ -1,5 +1,195 @@
 # @twin.org/document-management-rest-client - Changelog
 
-## v0.0.1-next.2
+## [0.0.1-next.20](https://github.com/twinfoundation/document-management/compare/document-management-rest-client-v0.0.1-next.19...document-management-rest-client-v0.0.1-next.20) (2025-06-20)
+
+
+### Features
+
+* document get can perform extraction ([#6](https://github.com/twinfoundation/document-management/issues/6)) ([5ce6d37](https://github.com/twinfoundation/document-management/commit/5ce6d37432ad271ca5783f422846f4be98ec2215))
+* get document revision ([080eddc](https://github.com/twinfoundation/document-management/commit/080eddcc024c622dda6bb36f60f5fa80a86cf5bb))
+* store document as a vertex ([#2](https://github.com/twinfoundation/document-management/issues/2)) ([7febedc](https://github.com/twinfoundation/document-management/commit/7febedc3fb31de9c19565d6326341046834f2c74))
+* update dependencies ([f9d8641](https://github.com/twinfoundation/document-management/commit/f9d86417dba24027699225ec7473296e361dcb00))
+
+
+### 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.19 to 0.0.1-next.20
+
+## [0.0.1-next.19](https://github.com/twinfoundation/document-management/compare/document-management-rest-client-v0.0.1-next.18...document-management-rest-client-v0.0.1-next.19) (2025-06-20)
+
+
+### 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.18 to 0.0.1-next.19
+
+## [0.0.1-next.18](https://github.com/twinfoundation/document-management/compare/document-management-rest-client-v0.0.1-next.17...document-management-rest-client-v0.0.1-next.18) (2025-06-18)
+
+
+### 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.17 to 0.0.1-next.18
+
+## [0.0.1-next.17](https://github.com/twinfoundation/document-management/compare/document-management-rest-client-v0.0.1-next.16...document-management-rest-client-v0.0.1-next.17) (2025-06-12)
+
+
+### Features
+
+* update dependencies ([f9d8641](https://github.com/twinfoundation/document-management/commit/f9d86417dba24027699225ec7473296e361dcb00))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/document-management-models bumped from 0.0.1-next.16 to 0.0.1-next.17
+
+## [0.0.1-next.16](https://github.com/twinfoundation/document-management/compare/document-management-rest-client-v0.0.1-next.15...document-management-rest-client-v0.0.1-next.16) (2025-06-03)
+
+
+### 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.15 to 0.0.1-next.16
+
+## [0.0.1-next.15](https://github.com/twinfoundation/document-management/compare/document-management-rest-client-v0.0.1-next.14...document-management-rest-client-v0.0.1-next.15) (2025-05-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.14 to 0.0.1-next.15
+
+## [0.0.1-next.14](https://github.com/twinfoundation/document-management/compare/document-management-rest-client-v0.0.1-next.13...document-management-rest-client-v0.0.1-next.14) (2025-05-08)
+
+
+### 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.13 to 0.0.1-next.14
+
+## [0.0.1-next.13](https://github.com/twinfoundation/document-management/compare/document-management-rest-client-v0.0.1-next.12...document-management-rest-client-v0.0.1-next.13) (2025-04-30)
+
+
+### 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.12 to 0.0.1-next.13
+
+## [0.0.1-next.12](https://github.com/twinfoundation/document-management/compare/document-management-rest-client-v0.0.1-next.11...document-management-rest-client-v0.0.1-next.12) (2025-04-30)
+
+
+### Features
+
+* get document revision ([080eddc](https://github.com/twinfoundation/document-management/commit/080eddcc024c622dda6bb36f60f5fa80a86cf5bb))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/document-management-models bumped from 0.0.1-next.11 to 0.0.1-next.12
+
+## [0.0.1-next.11](https://github.com/twinfoundation/document-management/compare/document-management-rest-client-v0.0.1-next.10...document-management-rest-client-v0.0.1-next.11) (2025-04-28)
+
+
+### Features
+
+* document get can perform extraction ([#6](https://github.com/twinfoundation/document-management/issues/6)) ([5ce6d37](https://github.com/twinfoundation/document-management/commit/5ce6d37432ad271ca5783f422846f4be98ec2215))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/document-management-models bumped from 0.0.1-next.10 to 0.0.1-next.11
+
+## [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/reference/classes/DocumentManagementClient.md

@@ -12,9 +12,9 @@ Client for performing document management through to REST endpoints.
 
 ## Constructors
 
-### new DocumentManagementClient()
+### Constructor
 
-> **new DocumentManagementClient**(`config`): [`DocumentManagementClient`](DocumentManagementClient.md)
+> **new DocumentManagementClient**(`config`): `DocumentManagementClient`
 
 Create a new instance of DocumentManagementClient.
 
@@ -28,7 +28,7 @@ The configuration for the client.
 
 #### Returns
 
-[`DocumentManagementClient`](DocumentManagementClient.md)
+`DocumentManagementClient`
 
 #### Overrides
 
@@ -48,22 +48,16 @@ Runtime name for the class.
 
 ## Methods
 
-### set()
+### create()
 
-> **set**(`auditableItemGraphId`, `documentId`, `documentIdFormat`, `documentCode`, `blob`, `annotationObject`?, `createAttestation`?): `Promise`\<`string`\>
+> **create**(`documentId`, `documentIdFormat`, `documentCode`, `blob`, `annotationObject?`, `auditableItemGraphEdges?`, `options?`): `Promise`\<`string`\>
 
-Store a document in an auditable item graph vertex and add its content to blob storage.
+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
 
-##### auditableItemGraphId
-
-`string`
-
-The auditable item graph vertex id to create the document on.
-
 ##### documentId
 
 `string`
@@ -86,7 +80,7 @@ The code for the document type.
 
 `Uint8Array`
 
-The data to create the document.
+The data to create the document with.
 
 ##### annotationObject?
 
@@ -94,87 +88,161 @@ The data to create the document.
 
 Additional information to associate with the document.
 
-##### createAttestation?
+##### 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 identifier for the document which includes the auditable item graph identifier.
+The auditable item graph vertex created for the document including its revision.
 
 #### Implementation of
 
-`IDocumentManagementComponent.set`
+`IDocumentManagementComponent.create`
 
 ***
 
-### get()
+### update()
 
-> **get**(`auditableItemGraphId`, `identifier`, `options`?, `revisionCursor`?): `Promise`\<`IDocument`\>
+> **update**(`auditableItemGraphDocumentId`, `blob?`, `annotationObject?`, `auditableItemGraphEdges?`): `Promise`\<`void`\>
 
-Get a specific document from an auditable item graph vertex.
+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
 
-##### auditableItemGraphId
+##### auditableItemGraphDocumentId
 
 `string`
 
-The auditable item graph vertex id to get the document from.
+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.
 
-##### identifier
+##### 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 identifier of the document to get.
+The auditable item graph vertex id which contains the document.
 
 ##### options?
 
 Additional options for the get operation.
 
-###### includeBlobStorageMetadata
+###### includeBlobStorageMetadata?
 
 `boolean`
 
 Flag to include the blob storage metadata for the document, defaults to false.
 
-###### includeBlobStorageData
+###### includeBlobStorageData?
 
 `boolean`
 
 Flag to include the blob storage data for the document, defaults to false.
 
-###### includeAttestation
+###### includeAttestation?
 
 `boolean`
 
 Flag to include the attestation information for the document, defaults to false.
 
-###### includeRemoved
+###### includeRemoved?
 
 `boolean`
 
 Flag to include deleted documents, defaults to false.
 
-###### maxRevisionCount
+###### extractRuleGroupId?
 
-`number`
+`string`
 
-Max number of revisions to return, defaults to 0.
+If provided will extract data from the document using the specified rule group id.
 
-##### revisionCursor?
+###### extractMimeType?
+
+`string`
+
+By default extraction will auto detect the mime type of the document, this can be used to override the detection.
+
+##### 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`\<`IDocument`\>
+`Promise`\<`IDocumentList`\>
 
 The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
 
@@ -184,84 +252,118 @@ The documents and revisions if requested, ordered by revision descending, cursor
 
 ***
 
-### remove()
+### getRevision()
 
-> **remove**(`auditableItemGraphId`, `identifier`, `options`?): `Promise`\<`void`\>
+> **getRevision**(`auditableItemGraphDocumentId`, `revision`, `options?`): `Promise`\<`IDocument`\>
 
-Remove a specific document from an auditable item graph vertex.
-The documents dateDeleted will be set, but can still be queried with the includeRemoved flag.
+Get a document revision using it's auditable item graph vertex id.
 
 #### Parameters
 
-##### auditableItemGraphId
+##### auditableItemGraphDocumentId
 
 `string`
 
-The auditable item graph vertex id to remove the document from.
+The auditable item graph vertex id which contains the document.
 
-##### identifier
+##### revision
 
-`string`
+`number`
 
-The identifier of the document to remove.
+The revision id for the document.
 
 ##### options?
 
-Additional options for the remove operation.
+Additional options for the get operation.
+
+###### includeBlobStorageMetadata?
+
+`boolean`
+
+Flag to include the blob storage metadata for the document, defaults to false.
+
+###### includeBlobStorageData?
 
-###### removeAllRevisions
+`boolean`
+
+Flag to include the blob storage data for the document, defaults to false.
+
+###### includeAttestation?
 
 `boolean`
 
-Flag to remove all revisions of the document, defaults to false.
+Flag to include the attestation information for the document, defaults to false.
+
+###### extractRuleGroupId?
+
+`string`
+
+If provided will extract data from the document using the specified rule group id.
+
+###### extractMimeType?
+
+`string`
+
+By default extraction will auto detect the mime type of the document, this can be used to override the detection.
 
 #### Returns
 
-`Promise`\<`void`\>
+`Promise`\<`IDocument`\>
 
-Nothing.
+The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
 
 #### Implementation of
 
-`IDocumentManagementComponent.remove`
+`IDocumentManagementComponent.getRevision`
 
 ***
 
-### query()
+### removeRevision()
 
-> **query**(`auditableItemGraphId`, `documentCodes`?, `options`?, `cursor`?): `Promise`\<`IDocumentList`\>
+> **removeRevision**(`auditableItemGraphDocumentId`, `revision`): `Promise`\<`void`\>
 
-Query an auditable item graph vertex for documents.
+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
 
-##### auditableItemGraphId
+##### auditableItemGraphDocumentId
 
 `string`
 
-The auditable item graph vertex to get the documents from.
+The auditable item graph vertex id which contains the document.
 
-##### documentCodes?
+##### revision
 
-`string`[]
+`number`
 
-The document codes to query for, if undefined gets all document codes.
+The revision of the document to remove.
 
-##### options?
+#### Returns
 
-Additional options for the query operation.
+`Promise`\<`void`\>
 
-###### includeMostRecentRevisions
+Nothing.
 
-`boolean`
+#### Implementation of
 
-Include the most recent 5 revisions, use the individual get to retrieve more.
+`IDocumentManagementComponent.removeRevision`
 
-###### includeRemoved
+***
 
-`boolean`
+### query()
 
-Flag to include deleted documents, defaults to false.
+> **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?
 
@@ -269,11 +371,17 @@ Flag to include deleted documents, defaults to false.
 
 The cursor to get the next chunk of documents.
 
+##### pageSize?
+
+`number`
+
+The page size to get the next chunk of documents.
+
 #### Returns
 
-`Promise`\<`IDocumentList`\>
+`Promise`\<`IAuditableItemGraphVertexList`\>
 
-The most recent revisions of each document, cursor is set if there are more documents.
+The graph vertices that contain documents referencing the specified document id.
 
 #### Implementation of
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/document-management-rest-client",
-	"version": "0.0.1-next.2",
+	"version": "0.0.1-next.20",
 	"description": "Document management contract implementation which can connect to REST endpoints",
 	"repository": {
 		"type": "git",
@@ -16,9 +16,10 @@
 	"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.2",
+		"@twin.org/document-management-models": "0.0.1-next.20",
 		"@twin.org/entity": "next",
 		"@twin.org/nameof": "next",
 		"@twin.org/standards-unece": "next",