@twin.org/document-management-models 0.0.1-next.8 → 0.0.1-next.9

package/dist/types/index.d.ts

@@ -1,9 +1,10 @@
+export * from "./models/api/IDocumentManagementCreateRequest";
 export * from "./models/api/IDocumentManagementGetRequest";
 export * from "./models/api/IDocumentManagementGetResponse";
 export * from "./models/api/IDocumentManagementQueryRequest";
 export * from "./models/api/IDocumentManagementQueryResponse";
 export * from "./models/api/IDocumentManagementRemoveRequest";
-export * from "./models/api/IDocumentManagementSetRequest";
+export * from "./models/api/IDocumentManagementUpdateRequest";
 export * from "./models/documentContexts";
 export * from "./models/documentTypes";
 export * from "./models/IDocument";

package/dist/types/models/IDocument.d.ts

@@ -86,12 +86,4 @@ export interface IDocument {
      * The user who added the document to the graph.
      */
     userIdentity: string;
-    /**
-     * The previous revisions of the document.
-     */
-    revisions?: IDocument[];
-    /**
-     * The cursor to get the next chunk of revisions.
-     */
-    revisionCursor?: string;
 }

package/dist/types/models/IDocumentList.d.ts

@@ -22,6 +22,10 @@ export interface IDocumentList {
      * The list of documents.
      */
     documents: IDocument[];
+    /**
+     * The ids of the other vertices which are connected to the document.
+     */
+    edges?: string[];
     /**
      * The cursor to get the next chunk of documents.
      */

package/dist/types/models/IDocumentManagementComponent.d.ts

@@ -1,85 +1,94 @@
+import type { IAuditableItemGraphVertexList } from "@twin.org/auditable-item-graph-models";
 import type { IComponent } from "@twin.org/core";
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import type { UneceDocumentCodes } from "@twin.org/standards-unece";
-import type { IDocument } from "./IDocument";
 import type { IDocumentList } from "./IDocumentList";
 /**
  * Interface describing an document management contract.
  */
 export interface IDocumentManagementComponent extends IComponent {
     /**
-     * Store a document in an auditable item graph vertex and add its content to blob storage.
+     * Create 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 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.includeIdAsAlias Include the document id as an alias to the aig vertex, defaults to false.
-     * @param options.aliasAnnotationObject Additional information to associate with the alias.
+     * @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.
      * @param userIdentity The identity to perform the auditable item graph operation with.
      * @param nodeIdentity The node identity to use for vault operations.
-     * @returns The identifier for the document which includes the auditable item graph identifier.
+     * @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, options?: {
+    create(documentId: string, documentIdFormat: string | undefined, documentCode: UneceDocumentCodes, blob: Uint8Array, annotationObject?: IJsonLdNodeObject, auditableItemGraphEdges?: {
+        id: string;
+        addAlias?: boolean;
+        aliasAnnotationObject?: IJsonLdNodeObject;
+    }[], options?: {
         createAttestation?: boolean;
-        includeIdAsAlias?: boolean;
+        addAlias?: boolean;
         aliasAnnotationObject?: IJsonLdNodeObject;
     }, userIdentity?: string, nodeIdentity?: string): 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.
+     * @param userIdentity The identity to perform the auditable item graph operation with.
+     * @param nodeIdentity The node identity to use for vault operations.
+     * @returns Nothing.
+     */
+    update(auditableItemGraphDocumentId: string, blob?: Uint8Array, annotationObject?: IJsonLdNodeObject, auditableItemGraphEdges?: {
+        id: string;
+        addAlias?: boolean;
+        aliasAnnotationObject?: IJsonLdNodeObject;
+    }[], userIdentity?: string, nodeIdentity?: string): 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 cursor The cursor to get the next chunk of revisions.
+     * @param pageSize Page size of items to return, defaults to 1 so only most recent is returned.
      * @param userIdentity The identity to perform the auditable item graph operation with.
      * @param nodeIdentity The node identity to use for vault operations.
      * @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, userIdentity?: string, nodeIdentity?: string): Promise<IDocument>;
+    }, cursor?: string, pageSize?: number, userIdentity?: string, nodeIdentity?: string): 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.
+     * 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.
      * @param userIdentity The identity to perform the auditable item graph operation with.
      * @param nodeIdentity The node identity to use for vault operations.
      * @returns Nothing.
      */
-    remove(auditableItemGraphId: string, identifier: string, options?: {
-        removeAllRevisions?: boolean;
-    }, userIdentity?: string, nodeIdentity?: string): Promise<void>;
+    removeRevision(auditableItemGraphDocumentId: string, revision: number, userIdentity?: string, nodeIdentity?: string): 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.
+     * @param pageSize The page size to get the next chunk of documents.
      * @param userIdentity The identity to perform the auditable item graph operation with.
      * @param nodeIdentity The node identity to use for vault operations.
-     * @returns The most recent revisions of each document, cursor is set if there are more 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, userIdentity?: string, nodeIdentity?: string): Promise<IDocumentList>;
+    query(documentId: string, cursor?: string, pageSize?: number, userIdentity?: string, nodeIdentity?: string): Promise<IAuditableItemGraphVertexList>;
 }

package/dist/types/models/api/{IDocumentManagementSetRequest.d.ts → IDocumentManagementCreateRequest.d.ts}

@@ -1,18 +1,9 @@
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
 import type { UneceDocumentCodes } from "@twin.org/standards-unece";
 /**
- * Request to set a document in an auditable item graph vertex.
+ * Request to create a document as an auditable item graph vertex.
  */
-export interface IDocumentManagementSetRequest {
-    /**
-     * The path parameters.
-     */
-    pathParams: {
-        /**
-         * The id of the auditable item graph vertex to store the document on.
-         */
-        auditableItemGraphId: string;
-    };
+export interface IDocumentManagementCreateRequest {
     /**
      * The body parameters.
      */
@@ -38,15 +29,23 @@ export interface IDocumentManagementSetRequest {
          */
         annotationObject?: IJsonLdNodeObject;
         /**
-         * Flag to create an attestation for the document, defaults to false
+         * The auditable item graph vertices to connect the document to.
+         */
+        auditableItemGraphEdges?: {
+            id: string;
+            addAlias?: boolean;
+            aliasAnnotationObject?: IJsonLdNodeObject;
+        }[];
+        /**
+         * Flag to create an attestation for the document, defaults to false.
          */
         createAttestation?: boolean;
         /**
-         * Include the document id as an alias to the aig vertex, defaults to false.
+         * Flag to add the document id as an alias to the aig vertex, defaults to true.
          */
-        includeIdAsAlias?: boolean;
+        addAlias?: boolean;
         /**
-         * Additional information to associate with the alias.
+         * Annotation object for the alias.
          */
         aliasAnnotationObject?: IJsonLdNodeObject;
     };

package/dist/types/models/api/IDocumentManagementGetRequest.d.ts

@@ -13,14 +13,10 @@ export interface IDocumentManagementGetRequest {
      * The path parameters.
      */
     pathParams: {
-        /**
-         * The id of the auditable item graph vertex to store the document on.
-         */
-        auditableItemGraphId: string;
         /**
          * The full id of the document to get.
          */
-        documentId: string;
+        auditableItemGraphDocumentId: string;
     };
     /**
      * The query parameters.
@@ -47,13 +43,13 @@ export interface IDocumentManagementGetRequest {
          */
         includeRemoved?: boolean;
         /**
-         * Max number of revisions to return.
-         * @default 0
+         * Page size of items to return, defaults to 1 so only most recent is returned.
+         * @default 1
          */
-        maxRevisionCount?: number;
+        pageSize?: string;
         /**
          * The cursor to get the next chunk of revisions.
          */
-        revisionCursor?: string;
+        cursor?: string;
     };
 }

package/dist/types/models/api/IDocumentManagementGetResponse.d.ts

@@ -1,5 +1,5 @@
 import type { HeaderTypes, MimeTypes } from "@twin.org/web";
-import type { IDocument } from "../IDocument";
+import type { IDocumentList } from "../IDocumentList";
 /**
  * Response to get a document and optionally revisions from an auditable item graph vertex.
  */
@@ -13,5 +13,5 @@ export interface IDocumentManagementGetResponse {
     /**
      * The body parameters.
      */
-    body: IDocument;
+    body: IDocumentList;
 }

package/dist/types/models/api/IDocumentManagementQueryRequest.d.ts

@@ -9,36 +9,21 @@ export interface IDocumentManagementQueryRequest {
     headers?: {
         [HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
     };
-    /**
-     * The path parameters.
-     */
-    pathParams: {
-        /**
-         * The id of the auditable item graph vertex which contains the documents.
-         */
-        auditableItemGraphId: string;
-    };
     /**
      * The query parameters.
      */
-    query?: {
+    query: {
         /**
-         * List of comma separated document codes to filter the query.
+         * The id of the document id we are trying to find.
          */
-        documentCodes?: string;
-        /**
-         * Include deleted documents in the response.
-         * @default false
-         */
-        includeRemoved?: boolean;
-        /**
-         * Include the most recent 5 revisions, use the individual get to retrieve more.
-         * @default false
-         */
-        includeMostRecentRevisions?: boolean;
+        documentId: string;
         /**
          * The cursor to get the next chunk of documents.
          */
         cursor?: string;
+        /**
+         * The number of documents to return.
+         */
+        pageSize?: string;
     };
 }

package/dist/types/models/api/IDocumentManagementQueryResponse.d.ts

@@ -1,5 +1,5 @@
+import type { IAuditableItemGraphVertexList } from "@twin.org/auditable-item-graph-models";
 import type { HeaderTypes, MimeTypes } from "@twin.org/web";
-import type { IDocumentList } from "../IDocumentList";
 /**
  * Response to query the documents from an auditable item graph vertex.
  */
@@ -13,5 +13,5 @@ export interface IDocumentManagementQueryResponse {
     /**
      * The body parameters.
      */
-    body: IDocumentList;
+    body: IAuditableItemGraphVertexList;
 }

package/dist/types/models/api/IDocumentManagementRemoveRequest.d.ts

@@ -1,5 +1,5 @@
 /**
- * Request to remove a document from an auditable item graph.
+ * Request to remove a document revision from an auditable item graph.
  */
 export interface IDocumentManagementRemoveRequest {
     /**
@@ -7,22 +7,12 @@ export interface IDocumentManagementRemoveRequest {
      */
     pathParams: {
         /**
-         * The id of the auditable item graph vertex to remove the document from.
+         * The id of the auditable item graph vertex to remove the revision from.
          */
-        auditableItemGraphId: string;
+        auditableItemGraphDocumentId: string;
         /**
-         * The full id of the document to remove.
+         * The revision of the document to remove.
          */
-        documentId: string;
-    };
-    /**
-     * The query parameters.
-     */
-    query?: {
-        /**
-         * Flag to remove all revisions of the document.
-         * @default false
-         */
-        removeAllRevisions?: boolean;
+        revision: string;
     };
 }

package/dist/types/models/api/IDocumentManagementUpdateRequest.d.ts

@@ -0,0 +1,36 @@
+import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
+/**
+ * Request to update a document as an auditable item graph vertex.
+ */
+export interface IDocumentManagementUpdateRequest {
+    /**
+     * The path parameters.
+     */
+    pathParams: {
+        /**
+         * The full id of the document to get.
+         */
+        auditableItemGraphDocumentId: string;
+    };
+    /**
+     * The body parameters.
+     */
+    body: {
+        /**
+         * The data to create the document with, in base64.
+         */
+        blob?: string;
+        /**
+         * Additional information to associate with the document.
+         */
+        annotationObject?: IJsonLdNodeObject;
+        /**
+         * The auditable item graph vertices to connect the document to.
+         */
+        auditableItemGraphEdges?: {
+            id: string;
+            addAlias?: boolean;
+            aliasAnnotationObject?: IJsonLdNodeObject;
+        }[];
+    };
+}

package/docs/changelog.md

@@ -1,5 +1,12 @@
 # @twin.org/document-management-models - Changelog
 
+## [0.0.1-next.9](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.1-next.8...document-management-models-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))
+
 ## [0.0.1-next.8](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.1-next.7...document-management-models-v0.0.1-next.8) (2025-03-28)
 
 

package/docs/reference/index.md

@@ -6,12 +6,13 @@
 - [IDocumentAttestation](interfaces/IDocumentAttestation.md)
 - [IDocumentList](interfaces/IDocumentList.md)
 - [IDocumentManagementComponent](interfaces/IDocumentManagementComponent.md)
+- [IDocumentManagementCreateRequest](interfaces/IDocumentManagementCreateRequest.md)
 - [IDocumentManagementGetRequest](interfaces/IDocumentManagementGetRequest.md)
 - [IDocumentManagementGetResponse](interfaces/IDocumentManagementGetResponse.md)
 - [IDocumentManagementQueryRequest](interfaces/IDocumentManagementQueryRequest.md)
 - [IDocumentManagementQueryResponse](interfaces/IDocumentManagementQueryResponse.md)
 - [IDocumentManagementRemoveRequest](interfaces/IDocumentManagementRemoveRequest.md)
-- [IDocumentManagementSetRequest](interfaces/IDocumentManagementSetRequest.md)
+- [IDocumentManagementUpdateRequest](interfaces/IDocumentManagementUpdateRequest.md)
 
 ## Type Aliases
 

package/docs/reference/interfaces/IDocument.md

@@ -145,19 +145,3 @@ The node which added the document to the graph.
 > **userIdentity**: `string`
 
 The user who added the document to the graph.
-
-***
-
-### revisions?
-
-> `optional` **revisions**: [`IDocument`](IDocument.md)[]
-
-The previous revisions of the document.
-
-***
-
-### revisionCursor?
-
-> `optional` **revisionCursor**: `string`
-
-The cursor to get the next chunk of revisions.

package/docs/reference/interfaces/IDocumentList.md

@@ -28,6 +28,14 @@ The list of documents.
 
 ***
 
+### edges?
+
+> `optional` **edges**: `string`[]
+
+The ids of the other vertices which are connected to the document.
+
+***
+
 ### cursor?
 
 > `optional` **cursor**: `string`

package/docs/reference/interfaces/IDocumentManagementComponent.md

@@ -8,22 +8,16 @@ Interface describing an document management contract.
 
 ## Methods
 
-### set()
+### create()
 
-> **set**(`auditableItemGraphId`, `documentId`, `documentIdFormat`, `documentCode`, `blob`, `annotationObject`?, `options`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`string`\>
+> **create**(`documentId`, `documentIdFormat`, `documentCode`, `blob`, `annotationObject?`, `auditableItemGraphEdges?`, `options?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`string`\>
 
-Store a document in an auditable item graph vertex and add its content to blob storage.
+Create 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`
@@ -54,6 +48,12 @@ The data to create the document with.
 
 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.
@@ -64,17 +64,17 @@ Additional options for the set operation.
 
 Flag to create an attestation for the document, defaults to false.
 
-###### includeIdAsAlias?
+###### addAlias?
 
 `boolean`
 
-Include the document id as an alias to the aig vertex, defaults to false.
+Flag to add the document id as an alias to the aig vertex, defaults to true.
 
 ###### aliasAnnotationObject?
 
 `IJsonLdNodeObject`
 
-Additional information to associate with the alias.
+Annotation object for the alias.
 
 ##### userIdentity?
 
@@ -92,29 +92,77 @@ The node identity to use for vault operations.
 
 `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.
 
 ***
 
-### get()
+### update()
 
-> **get**(`auditableItemGraphId`, `identifier`, `options`?, `revisionCursor`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<[`IDocument`](IDocument.md)\>
+> **update**(`auditableItemGraphDocumentId`, `blob?`, `annotationObject?`, `auditableItemGraphEdges?`, `userIdentity?`, `nodeIdentity?`): `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.
+
+##### auditableItemGraphEdges?
+
+`object`[]
+
+The auditable item graph vertices to connect the document to, if undefined retains current connections.
+
+##### userIdentity?
+
+`string`
+
+The identity to perform the auditable item graph operation with.
+
+##### nodeIdentity?
+
+`string`
+
+The node identity to use for vault operations.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+Nothing.
+
+***
+
+### get()
+
+> **get**(`auditableItemGraphDocumentId`, `options?`, `cursor?`, `pageSize?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<[`IDocumentList`](IDocumentList.md)\>
+
+Get a document using it's auditable item graph vertex id and optional revision.
+
+#### Parameters
 
-##### identifier
+##### auditableItemGraphDocumentId
 
 `string`
 
-The identifier of the document to get.
+The auditable item graph vertex id which contains the document.
 
 ##### options?
 
@@ -144,17 +192,17 @@ Flag to include the attestation information for the document, defaults to false.
 
 Flag to include deleted documents, defaults to false.
 
-###### maxRevisionCount?
+##### cursor?
 
-`number`
+`string`
 
-Max number of revisions to return, defaults to 0.
+The cursor to get the next chunk of revisions.
 
-##### revisionCursor?
+##### pageSize?
 
-`string`
+`number`
 
-The cursor to get the next chunk of revisions.
+Page size of items to return, defaults to 1 so only most recent is returned.
 
 ##### userIdentity?
 
@@ -170,42 +218,32 @@ The node identity to use for vault operations.
 
 #### Returns
 
-`Promise`\<[`IDocument`](IDocument.md)\>
+`Promise`\<[`IDocumentList`](IDocumentList.md)\>
 
 The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
 
 ***
 
-### remove()
+### removeRevision()
 
-> **remove**(`auditableItemGraphId`, `identifier`, `options`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<`void`\>
+> **removeRevision**(`auditableItemGraphDocumentId`, `revision`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`void`\>
 
-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.
+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
-
-`string`
-
-The auditable item graph vertex id to remove the document from.
-
-##### identifier
+##### auditableItemGraphDocumentId
 
 `string`
 
-The identifier of the document to remove.
+The auditable item graph vertex id which contains the document.
 
-##### options?
+##### revision
 
-Additional options for the remove operation.
-
-###### removeAllRevisions?
-
-`boolean`
+`number`
 
-Flag to remove all revisions of the document, defaults to false.
+The revision of the document to remove.
 
 ##### userIdentity?
 
@@ -229,39 +267,17 @@ Nothing.
 
 ### query()
 
-> **query**(`auditableItemGraphId`, `documentCodes`?, `options`?, `cursor`?, `userIdentity`?, `nodeIdentity`?): `Promise`\<[`IDocumentList`](IDocumentList.md)\>
+> **query**(`documentId`, `cursor?`, `pageSize?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`IAuditableItemGraphVertexList`\>
 
-Query an auditable item graph vertex for documents.
+Find all the document with a specific id.
 
 #### Parameters
 
-##### auditableItemGraphId
+##### documentId
 
 `string`
 
-The auditable item graph vertex to get the documents from.
-
-##### documentCodes?
-
-`string`[]
-
-The document codes to query for, if undefined gets all document codes.
-
-##### options?
-
-Additional options for the query operation.
-
-###### includeMostRecentRevisions?
-
-`boolean`
-
-Include the most recent 5 revisions, use the individual get to retrieve more.
-
-###### includeRemoved?
-
-`boolean`
-
-Flag to include deleted documents, defaults to false.
+The document id to find in the graph.
 
 ##### cursor?
 
@@ -269,6 +285,12 @@ 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.
+
 ##### userIdentity?
 
 `string`
@@ -283,6 +305,6 @@ The node identity to use for vault operations.
 
 #### Returns
 
-`Promise`\<[`IDocumentList`](IDocumentList.md)\>
+`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.

package/docs/reference/interfaces/{IDocumentManagementSetRequest.md → IDocumentManagementCreateRequest.md}

@@ -1,23 +1,9 @@
-# Interface: IDocumentManagementSetRequest
+# Interface: IDocumentManagementCreateRequest
 
-Request to set a document in an auditable item graph vertex.
+Request to create a document as an auditable item graph vertex.
 
 ## Properties
 
-### pathParams
-
-> **pathParams**: `object`
-
-The path parameters.
-
-#### auditableItemGraphId
-
-> **auditableItemGraphId**: `string`
-
-The id of the auditable item graph vertex to store the document on.
-
-***
-
 ### body
 
 > **body**: `object`
@@ -54,20 +40,26 @@ The data to create the document with, in base64.
 
 Additional information to associate with the document.
 
+#### auditableItemGraphEdges?
+
+> `optional` **auditableItemGraphEdges**: `object`[]
+
+The auditable item graph vertices to connect the document to.
+
 #### createAttestation?
 
 > `optional` **createAttestation**: `boolean`
 
-Flag to create an attestation for the document, defaults to false
+Flag to create an attestation for the document, defaults to false.
 
-#### includeIdAsAlias?
+#### addAlias?
 
-> `optional` **includeIdAsAlias**: `boolean`
+> `optional` **addAlias**: `boolean`
 
-Include the document id as an alias to the aig vertex, defaults to false.
+Flag to add the document id as an alias to the aig vertex, defaults to true.
 
 #### aliasAnnotationObject?
 
 > `optional` **aliasAnnotationObject**: `IJsonLdNodeObject`
 
-Additional information to associate with the alias.
+Annotation object for the alias.

package/docs/reference/interfaces/IDocumentManagementGetRequest.md

@@ -22,15 +22,9 @@ The headers which can be used to determine the response data type.
 
 The path parameters.
 
-#### auditableItemGraphId
+#### auditableItemGraphDocumentId
 
-> **auditableItemGraphId**: `string`
-
-The id of the auditable item graph vertex to store the document on.
-
-#### documentId
-
-> **documentId**: `string`
+> **auditableItemGraphDocumentId**: `string`
 
 The full id of the document to get.
 
@@ -90,20 +84,20 @@ Include deleted documents in the response.
 false
 ```
 
-#### maxRevisionCount?
+#### pageSize?
 
-> `optional` **maxRevisionCount**: `number`
+> `optional` **pageSize**: `string`
 
-Max number of revisions to return.
+Page size of items to return, defaults to 1 so only most recent is returned.
 
 ##### Default
 
 ```ts
-0
+1
 ```
 
-#### revisionCursor?
+#### cursor?
 
-> `optional` **revisionCursor**: `string`
+> `optional` **cursor**: `string`
 
 The cursor to get the next chunk of revisions.

package/docs/reference/interfaces/IDocumentManagementGetResponse.md

@@ -18,6 +18,6 @@ The headers which can be used to determine the response data type.
 
 ### body
 
-> **body**: [`IDocument`](IDocument.md)
+> **body**: [`IDocumentList`](IDocumentList.md)
 
 The body parameters.

package/docs/reference/interfaces/IDocumentManagementQueryRequest.md

@@ -16,58 +16,26 @@ The headers which can be used to determine the response data type.
 
 ***
 
-### pathParams
+### query
 
-> **pathParams**: `object`
-
-The path parameters.
-
-#### auditableItemGraphId
-
-> **auditableItemGraphId**: `string`
-
-The id of the auditable item graph vertex which contains the documents.
-
-***
-
-### query?
-
-> `optional` **query**: `object`
+> **query**: `object`
 
 The query parameters.
 
-#### documentCodes?
-
-> `optional` **documentCodes**: `string`
-
-List of comma separated document codes to filter the query.
-
-#### includeRemoved?
+#### documentId
 
-> `optional` **includeRemoved**: `boolean`
+> **documentId**: `string`
 
-Include deleted documents in the response.
-
-##### Default
-
-```ts
-false
-```
-
-#### includeMostRecentRevisions?
-
-> `optional` **includeMostRecentRevisions**: `boolean`
-
-Include the most recent 5 revisions, use the individual get to retrieve more.
-
-##### Default
-
-```ts
-false
-```
+The id of the document id we are trying to find.
 
 #### cursor?
 
 > `optional` **cursor**: `string`
 
 The cursor to get the next chunk of documents.
+
+#### pageSize?
+
+> `optional` **pageSize**: `string`
+
+The number of documents to return.

package/docs/reference/interfaces/IDocumentManagementQueryResponse.md

@@ -18,6 +18,6 @@ The headers which can be used to determine the response data type.
 
 ### body
 
-> **body**: [`IDocumentList`](IDocumentList.md)
+> **body**: `IAuditableItemGraphVertexList`
 
 The body parameters.

package/docs/reference/interfaces/IDocumentManagementRemoveRequest.md

@@ -1,6 +1,6 @@
 # Interface: IDocumentManagementRemoveRequest
 
-Request to remove a document from an auditable item graph.
+Request to remove a document revision from an auditable item graph.
 
 ## Properties
 
@@ -10,34 +10,14 @@ Request to remove a document from an auditable item graph.
 
 The path parameters.
 
-#### auditableItemGraphId
+#### auditableItemGraphDocumentId
 
-> **auditableItemGraphId**: `string`
+> **auditableItemGraphDocumentId**: `string`
 
-The id of the auditable item graph vertex to remove the document from.
+The id of the auditable item graph vertex to remove the revision from.
 
-#### documentId
+#### revision
 
-> **documentId**: `string`
+> **revision**: `string`
 
-The full id of the document to remove.
-
-***
-
-### query?
-
-> `optional` **query**: `object`
-
-The query parameters.
-
-#### removeAllRevisions?
-
-> `optional` **removeAllRevisions**: `boolean`
-
-Flag to remove all revisions of the document.
-
-##### Default
-
-```ts
-false
-```
+The revision of the document to remove.

package/docs/reference/interfaces/IDocumentManagementUpdateRequest.md

@@ -0,0 +1,43 @@
+# Interface: IDocumentManagementUpdateRequest
+
+Request to update a document as an auditable item graph vertex.
+
+## Properties
+
+### pathParams
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### auditableItemGraphDocumentId
+
+> **auditableItemGraphDocumentId**: `string`
+
+The full id of the document to get.
+
+***
+
+### body
+
+> **body**: `object`
+
+The body parameters.
+
+#### blob?
+
+> `optional` **blob**: `string`
+
+The data to create the document with, in base64.
+
+#### annotationObject?
+
+> `optional` **annotationObject**: `IJsonLdNodeObject`
+
+Additional information to associate with the document.
+
+#### auditableItemGraphEdges?
+
+> `optional` **auditableItemGraphEdges**: `object`[]
+
+The auditable item graph vertices to connect the document to.

package/docs/reference/type-aliases/DocumentContexts.md

@@ -1,5 +1,5 @@
 # Type Alias: DocumentContexts
 
-> **DocumentContexts**: *typeof* [`DocumentContexts`](../variables/DocumentContexts.md)\[keyof *typeof* [`DocumentContexts`](../variables/DocumentContexts.md)\]
+> **DocumentContexts** = *typeof* [`DocumentContexts`](../variables/DocumentContexts.md)\[keyof *typeof* [`DocumentContexts`](../variables/DocumentContexts.md)\]
 
 The contexts of document management objects.

package/docs/reference/type-aliases/DocumentTypes.md

@@ -1,5 +1,5 @@
 # Type Alias: DocumentTypes
 
-> **DocumentTypes**: *typeof* [`DocumentTypes`](../variables/DocumentTypes.md)\[keyof *typeof* [`DocumentTypes`](../variables/DocumentTypes.md)\]
+> **DocumentTypes** = *typeof* [`DocumentTypes`](../variables/DocumentTypes.md)\[keyof *typeof* [`DocumentTypes`](../variables/DocumentTypes.md)\]
 
 The types of document management objects.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/document-management-models",
-	"version": "0.0.1-next.8",
+	"version": "0.0.1-next.9",
 	"description": "Models which define the structure of the document management connectors and services",
 	"repository": {
 		"type": "git",
@@ -15,6 +15,7 @@
 	},
 	"dependencies": {
 		"@twin.org/attestation-models": "next",
+		"@twin.org/auditable-item-graph-models": "next",
 		"@twin.org/blob-storage-models": "next",
 		"@twin.org/core": "next",
 		"@twin.org/data-json-ld": "next",