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

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.
@@ -30,30 +26,38 @@ export interface IDocumentManagementGetRequest {
          * Include the blob storage metadata in the response.
          * @default false
          */
-        includeBlobStorageMetadata?: boolean;
+        includeBlobStorageMetadata?: boolean | string;
         /**
          * Include the blob storage data in the response.
          * @default false
          */
-        includeBlobStorageData?: boolean;
+        includeBlobStorageData?: boolean | string;
         /**
          * Include the attestation information in the response.
          * @default false
          */
-        includeAttestation?: boolean;
+        includeAttestation?: boolean | string;
         /**
          * Include deleted documents in the response.
          * @default false
          */
-        includeRemoved?: boolean;
+        includeRemoved?: boolean | string;
+        /**
+         * If provided will extract data from the document using the specified rule group id.
+         */
+        extractRuleGroupId?: string;
+        /**
+         * By default extraction will auto detect the mime type of the document, this can be used to override the detection.
+         */
+        extractMimeType?: string;
         /**
-         * 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?: number | 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/IDocumentManagementGetRevisionRequest.d.ts

@@ -0,0 +1,53 @@
+import type { HeaderTypes, MimeTypes } from "@twin.org/web";
+/**
+ * Request to get a document revision from an auditable item graph vertex.
+ */
+export interface IDocumentManagementGetRevisionRequest {
+    /**
+     * The headers which can be used to determine the response data type.
+     */
+    headers?: {
+        [HeaderTypes.Accept]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+    };
+    /**
+     * The path parameters.
+     */
+    pathParams: {
+        /**
+         * The full id of the document to get.
+         */
+        auditableItemGraphDocumentId: string;
+        /**
+         * The revision of the document to get.
+         */
+        revision: string;
+    };
+    /**
+     * The query parameters.
+     */
+    query?: {
+        /**
+         * Include the blob storage metadata in the response.
+         * @default false
+         */
+        includeBlobStorageMetadata?: boolean | string;
+        /**
+         * Include the blob storage data in the response.
+         * @default false
+         */
+        includeBlobStorageData?: boolean | string;
+        /**
+         * Include the attestation information in the response.
+         * @default false
+         */
+        includeAttestation?: boolean | string;
+        /**
+         * If provided will extract data from the document using the specified rule group id.
+         */
+        extractRuleGroupId?: string;
+        /**
+         * By default extraction will auto detect the mime type of the document, this can be used to override the detection.
+         */
+        extractMimeType?: string;
+    };
+}

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

@@ -0,0 +1,17 @@
+import type { HeaderTypes, MimeTypes } from "@twin.org/web";
+import type { IDocument } from "../IDocument";
+/**
+ * Response to get a document revision from an auditable item graph vertex.
+ */
+export interface IDocumentManagementGetRevisionResponse {
+    /**
+     * The headers which can be used to determine the response data type.
+     */
+    headers?: {
+        [HeaderTypes.ContentType]: typeof MimeTypes.Json | typeof MimeTypes.JsonLd;
+    };
+    /**
+     * The body parameters.
+     */
+    body: IDocument;
+}

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?: number | 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/dist/types/models/documentTypes.d.ts

@@ -10,10 +10,6 @@ export declare const DocumentTypes: {
      * Represents a document attestation.
      */
     readonly DocumentAttestation: "DocumentAttestation";
-    /**
-     * Represents a document list.
-     */
-    readonly DocumentList: "DocumentList";
 };
 /**
  * The types of document management objects.

package/docs/changelog.md

@@ -1,5 +1,108 @@
 # @twin.org/document-management-models - Changelog
 
+## 0.0.1 (2025-07-09)
+
+
+### Features
+
+* release to production ([a009526](https://github.com/twinfoundation/document-management/commit/a009526032a0ee6e6b74f476a01fbe5f4c7fd4da))
+
+## [0.0.1-next.20](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.1-next.19...document-management-models-v0.0.1-next.20) (2025-06-20)
+
+
+### Features
+
+* data type registration use fully qualified names ([18d27d0](https://github.com/twinfoundation/document-management/commit/18d27d0c21d0f652b7df4b409bb2d3c66cf22f84))
+* 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))
+* improve comments ([4d2f094](https://github.com/twinfoundation/document-management/commit/4d2f094b23e3320cb739917246c1ee5f6ad41c11))
+* 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))
+* update ts-to-schema generation ([01a5335](https://github.com/twinfoundation/document-management/commit/01a5335372f6a4764a74d56c446d669724a308aa))
+* use standard list json ld types ([20ea04b](https://github.com/twinfoundation/document-management/commit/20ea04b05fd4bc4fcedce8f66958942c3c2fa303))
+
+
+### Bug Fixes
+
+* query params force coercion ([d667d0f](https://github.com/twinfoundation/document-management/commit/d667d0f195accca2887a5ca732e9790063763996))
+
+## [0.0.1-next.19](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.1-next.18...document-management-models-v0.0.1-next.19) (2025-06-20)
+
+
+### Bug Fixes
+
+* query params force coercion ([d667d0f](https://github.com/twinfoundation/document-management/commit/d667d0f195accca2887a5ca732e9790063763996))
+
+## [0.0.1-next.18](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.1-next.17...document-management-models-v0.0.1-next.18) (2025-06-18)
+
+
+### Miscellaneous Chores
+
+* **document-management-models:** Synchronize repo versions
+
+## [0.0.1-next.17](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.1-next.16...document-management-models-v0.0.1-next.17) (2025-06-12)
+
+
+### Features
+
+* update dependencies ([f9d8641](https://github.com/twinfoundation/document-management/commit/f9d86417dba24027699225ec7473296e361dcb00))
+
+## [0.0.1-next.16](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.1-next.15...document-management-models-v0.0.1-next.16) (2025-06-03)
+
+
+### Features
+
+* update ts-to-schema generation ([01a5335](https://github.com/twinfoundation/document-management/commit/01a5335372f6a4764a74d56c446d669724a308aa))
+
+## [0.0.1-next.15](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.1-next.14...document-management-models-v0.0.1-next.15) (2025-05-28)
+
+
+### Features
+
+* data type registration use fully qualified names ([18d27d0](https://github.com/twinfoundation/document-management/commit/18d27d0c21d0f652b7df4b409bb2d3c66cf22f84))
+
+## [0.0.1-next.14](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.1-next.13...document-management-models-v0.0.1-next.14) (2025-05-08)
+
+
+### Features
+
+* use standard list json ld types ([20ea04b](https://github.com/twinfoundation/document-management/commit/20ea04b05fd4bc4fcedce8f66958942c3c2fa303))
+
+## [0.0.1-next.13](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.1-next.12...document-management-models-v0.0.1-next.13) (2025-04-30)
+
+
+### Miscellaneous Chores
+
+* **document-management-models:** Synchronize repo versions
+
+## [0.0.1-next.12](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.1-next.11...document-management-models-v0.0.1-next.12) (2025-04-30)
+
+
+### Features
+
+* get document revision ([080eddc](https://github.com/twinfoundation/document-management/commit/080eddcc024c622dda6bb36f60f5fa80a86cf5bb))
+
+## [0.0.1-next.11](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.1-next.10...document-management-models-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))
+
+## [0.0.1-next.10](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.1-next.9...document-management-models-v0.0.1-next.10) (2025-04-25)
+
+
+### Miscellaneous Chores
+
+* **document-management-models:** Synchronize repo versions
+
+## [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/classes/DocumentManagementDataTypes.md

@@ -0,0 +1,25 @@
+# Class: DocumentManagementDataTypes
+
+Handle all the data types for document management.
+
+## Constructors
+
+### Constructor
+
+> **new DocumentManagementDataTypes**(): `DocumentManagementDataTypes`
+
+#### Returns
+
+`DocumentManagementDataTypes`
+
+## Methods
+
+### registerTypes()
+
+> `static` **registerTypes**(): `void`
+
+Register all the data types.
+
+#### Returns
+
+`void`

package/docs/reference/index.md

@@ -1,17 +1,24 @@
 # @twin.org/document-management-models
 
+## Classes
+
+- [DocumentManagementDataTypes](classes/DocumentManagementDataTypes.md)
+
 ## Interfaces
 
 - [IDocument](interfaces/IDocument.md)
 - [IDocumentAttestation](interfaces/IDocumentAttestation.md)
 - [IDocumentList](interfaces/IDocumentList.md)
 - [IDocumentManagementComponent](interfaces/IDocumentManagementComponent.md)
+- [IDocumentManagementCreateRequest](interfaces/IDocumentManagementCreateRequest.md)
 - [IDocumentManagementGetRequest](interfaces/IDocumentManagementGetRequest.md)
 - [IDocumentManagementGetResponse](interfaces/IDocumentManagementGetResponse.md)
+- [IDocumentManagementGetRevisionRequest](interfaces/IDocumentManagementGetRevisionRequest.md)
+- [IDocumentManagementGetRevisionResponse](interfaces/IDocumentManagementGetRevisionResponse.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

@@ -92,6 +92,14 @@ The additional JSON-LD for blob storage if it was requested.
 
 ***
 
+### extractedData?
+
+> `optional` **extractedData**: `unknown`
+
+The data extracted from the document using data extraction services.
+
+***
+
 ### attestationId?
 
 > `optional` **attestationId**: `string`
@@ -145,19 +153,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

@@ -6,7 +6,7 @@ Interface describing a list of document entries.
 
 ### @context
 
-> **@context**: \[`"https://schema.twindev.org/documents/"`, `"https://schema.twindev.org/common/"`, `...IJsonLdContextDefinitionElement[]`\]
+> **@context**: \[`"https://schema.org"`, `"https://schema.twindev.org/documents/"`, `"https://schema.twindev.org/common/"`, `...IJsonLdContextDefinitionElement[]`\]
 
 JSON-LD Context.
 
@@ -14,22 +14,30 @@ JSON-LD Context.
 
 ### type
 
-> **type**: `"DocumentList"`
+> **type**: `"ItemList"`
 
 JSON-LD Type.
 
 ***
 
-### documents
+### itemListElement
 
-> **documents**: [`IDocument`](IDocument.md)[]
+> **itemListElement**: [`IDocument`](IDocument.md)[]
 
 The list of documents.
 
 ***
 
-### cursor?
+### edges?
 
-> `optional` **cursor**: `string`
+> `optional` **edges**: `string`[]
+
+The ids of the other vertices which are connected to the document.
+
+***
+
+### nextItem?
+
+> `optional` **nextItem**: `string`
 
 The cursor to get the next chunk of documents.