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

package/dist/cjs/index.cjs

@@ -1,5 +1,7 @@
 'use strict';
 
+var dataCore = require('@twin.org/data-core');
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -31,12 +33,158 @@ const DocumentTypes = {
     /**
      * Represents a document attestation.
      */
-    DocumentAttestation: "DocumentAttestation",
+    DocumentAttestation: "DocumentAttestation"
+};
+
+var $schema = "https://json-schema.org/draft/2020-12/schema";
+var $id = "https://schema.twindev.org/documents/Document";
+var description = "Interface describing a document.";
+var type = "object";
+var properties = {
+	"@context": {
+		type: "array",
+		minItems: 3,
+		items: {
+			$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+		},
+		description: "JSON-LD Context.",
+		prefixItems: [
+			{
+				type: "string",
+				"const": "https://schema.twindev.org/documents/"
+			},
+			{
+				type: "string",
+				"const": "https://schema.twindev.org/common/"
+			},
+			{
+				type: "string",
+				"const": "https://schema.org"
+			}
+		]
+	},
+	type: {
+		type: "string",
+		"const": "Document",
+		description: "JSON-LD Type."
+	},
+	id: {
+		type: "string",
+		description: "The full id of the document."
+	},
+	documentId: {
+		type: "string",
+		description: "The id of the document."
+	},
+	documentIdFormat: {
+		type: "string",
+		description: "The format of the document id."
+	},
+	documentCode: {
+		$ref: "https://vocabulary.uncefact.org/DocumentCodeList",
+		description: "The code for the document type."
+	},
+	documentRevision: {
+		type: "number",
+		description: "The revision of the document as a 0 based index."
+	},
+	annotationObject: {
+		$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject",
+		description: "Additional annotation information for the document."
+	},
+	blobStorageId: {
+		type: "string",
+		description: "The blob storage id for the document."
+	},
+	blobHash: {
+		type: "string",
+		description: "The hash of the blob data."
+	},
+	blobStorageEntry: {
+		$ref: "https://schema.twindev.org/blob-storage/BlobStorageEntry",
+		description: "The additional JSON-LD for blob storage if it was requested."
+	},
+	extractedData: {
+		description: "The data extracted from the document using data extraction services."
+	},
+	attestationId: {
+		type: "string",
+		description: "The attestation for the document if one was created."
+	},
+	attestationInformation: {
+		$ref: "https://schema.twindev.org/attestation/AttestationInformation",
+		description: "The additional JSON-LD for attestation storage if it was requested."
+	},
+	dateCreated: {
+		type: "string",
+		description: "The date/time of when the document was created."
+	},
+	dateModified: {
+		type: "string",
+		description: "The date/time of when the document was modified."
+	},
+	dateDeleted: {
+		type: "string",
+		description: "The date/time of when the document was deleted, as we never actually remove items."
+	},
+	nodeIdentity: {
+		type: "string",
+		description: "The node which added the document to the graph."
+	},
+	userIdentity: {
+		type: "string",
+		description: "The user who added the document to the graph."
+	}
+};
+var required = [
+	"@context",
+	"type",
+	"id",
+	"documentId",
+	"documentCode",
+	"documentRevision",
+	"blobStorageId",
+	"blobHash",
+	"dateCreated",
+	"nodeIdentity",
+	"userIdentity"
+];
+var additionalProperties = false;
+var DocumentSchema = {
+	$schema: $schema,
+	$id: $id,
+	description: description,
+	type: type,
+	properties: properties,
+	required: required,
+	additionalProperties: additionalProperties
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Handle all the data types for document management.
+ */
+class DocumentManagementDataTypes {
     /**
-     * Represents a document list.
+     * Register all the data types.
      */
-    DocumentList: "DocumentList"
-};
+    static registerTypes() {
+        dataCore.DataTypeHandlerFactory.register(`${DocumentContexts.ContextRoot}${DocumentTypes.Document}`, () => ({
+            context: DocumentContexts.ContextRoot,
+            type: DocumentTypes.Document,
+            defaultValue: {},
+            jsonSchema: async () => DocumentSchema
+        }));
+        dataCore.DataTypeHandlerFactory.register(`${DocumentContexts.ContextRoot}${DocumentTypes.DocumentAttestation}`, () => ({
+            context: DocumentContexts.ContextRoot,
+            type: DocumentTypes.DocumentAttestation,
+            defaultValue: {},
+            jsonSchema: async () => DocumentSchema
+        }));
+    }
+}
 
 exports.DocumentContexts = DocumentContexts;
+exports.DocumentManagementDataTypes = DocumentManagementDataTypes;
 exports.DocumentTypes = DocumentTypes;

package/dist/esm/index.mjs

@@ -1,3 +1,5 @@
+import { DataTypeHandlerFactory } from '@twin.org/data-core';
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -29,11 +31,156 @@ const DocumentTypes = {
     /**
      * Represents a document attestation.
      */
-    DocumentAttestation: "DocumentAttestation",
+    DocumentAttestation: "DocumentAttestation"
+};
+
+var $schema = "https://json-schema.org/draft/2020-12/schema";
+var $id = "https://schema.twindev.org/documents/Document";
+var description = "Interface describing a document.";
+var type = "object";
+var properties = {
+	"@context": {
+		type: "array",
+		minItems: 3,
+		items: {
+			$ref: "https://schema.twindev.org/json-ld/JsonLdContextDefinitionElement"
+		},
+		description: "JSON-LD Context.",
+		prefixItems: [
+			{
+				type: "string",
+				"const": "https://schema.twindev.org/documents/"
+			},
+			{
+				type: "string",
+				"const": "https://schema.twindev.org/common/"
+			},
+			{
+				type: "string",
+				"const": "https://schema.org"
+			}
+		]
+	},
+	type: {
+		type: "string",
+		"const": "Document",
+		description: "JSON-LD Type."
+	},
+	id: {
+		type: "string",
+		description: "The full id of the document."
+	},
+	documentId: {
+		type: "string",
+		description: "The id of the document."
+	},
+	documentIdFormat: {
+		type: "string",
+		description: "The format of the document id."
+	},
+	documentCode: {
+		$ref: "https://vocabulary.uncefact.org/DocumentCodeList",
+		description: "The code for the document type."
+	},
+	documentRevision: {
+		type: "number",
+		description: "The revision of the document as a 0 based index."
+	},
+	annotationObject: {
+		$ref: "https://schema.twindev.org/json-ld/JsonLdNodeObject",
+		description: "Additional annotation information for the document."
+	},
+	blobStorageId: {
+		type: "string",
+		description: "The blob storage id for the document."
+	},
+	blobHash: {
+		type: "string",
+		description: "The hash of the blob data."
+	},
+	blobStorageEntry: {
+		$ref: "https://schema.twindev.org/blob-storage/BlobStorageEntry",
+		description: "The additional JSON-LD for blob storage if it was requested."
+	},
+	extractedData: {
+		description: "The data extracted from the document using data extraction services."
+	},
+	attestationId: {
+		type: "string",
+		description: "The attestation for the document if one was created."
+	},
+	attestationInformation: {
+		$ref: "https://schema.twindev.org/attestation/AttestationInformation",
+		description: "The additional JSON-LD for attestation storage if it was requested."
+	},
+	dateCreated: {
+		type: "string",
+		description: "The date/time of when the document was created."
+	},
+	dateModified: {
+		type: "string",
+		description: "The date/time of when the document was modified."
+	},
+	dateDeleted: {
+		type: "string",
+		description: "The date/time of when the document was deleted, as we never actually remove items."
+	},
+	nodeIdentity: {
+		type: "string",
+		description: "The node which added the document to the graph."
+	},
+	userIdentity: {
+		type: "string",
+		description: "The user who added the document to the graph."
+	}
+};
+var required = [
+	"@context",
+	"type",
+	"id",
+	"documentId",
+	"documentCode",
+	"documentRevision",
+	"blobStorageId",
+	"blobHash",
+	"dateCreated",
+	"nodeIdentity",
+	"userIdentity"
+];
+var additionalProperties = false;
+var DocumentSchema = {
+	$schema: $schema,
+	$id: $id,
+	description: description,
+	type: type,
+	properties: properties,
+	required: required,
+	additionalProperties: additionalProperties
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Handle all the data types for document management.
+ */
+class DocumentManagementDataTypes {
     /**
-     * Represents a document list.
+     * Register all the data types.
      */
-    DocumentList: "DocumentList"
-};
+    static registerTypes() {
+        DataTypeHandlerFactory.register(`${DocumentContexts.ContextRoot}${DocumentTypes.Document}`, () => ({
+            context: DocumentContexts.ContextRoot,
+            type: DocumentTypes.Document,
+            defaultValue: {},
+            jsonSchema: async () => DocumentSchema
+        }));
+        DataTypeHandlerFactory.register(`${DocumentContexts.ContextRoot}${DocumentTypes.DocumentAttestation}`, () => ({
+            context: DocumentContexts.ContextRoot,
+            type: DocumentTypes.DocumentAttestation,
+            defaultValue: {},
+            jsonSchema: async () => DocumentSchema
+        }));
+    }
+}
 
-export { DocumentContexts, DocumentTypes };
+export { DocumentContexts, DocumentManagementDataTypes, DocumentTypes };

package/dist/types/dataTypes/documentManagementDataTypes.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Handle all the data types for document management.
+ */
+export declare class DocumentManagementDataTypes {
+    /**
+     * Register all the data types.
+     */
+    static registerTypes(): void;
+}

package/dist/types/index.d.ts

@@ -1,6 +1,9 @@
+export * from "./dataTypes/documentManagementDataTypes";
 export * from "./models/api/IDocumentManagementCreateRequest";
 export * from "./models/api/IDocumentManagementGetRequest";
 export * from "./models/api/IDocumentManagementGetResponse";
+export * from "./models/api/IDocumentManagementGetRevisionRequest";
+export * from "./models/api/IDocumentManagementGetRevisionResponse";
 export * from "./models/api/IDocumentManagementQueryRequest";
 export * from "./models/api/IDocumentManagementQueryResponse";
 export * from "./models/api/IDocumentManagementRemoveRequest";

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

@@ -58,6 +58,10 @@ export interface IDocument {
      * The additional JSON-LD for blob storage if it was requested.
      */
     blobStorageEntry?: IBlobStorageEntry;
+    /**
+     * The data extracted from the document using data extraction services.
+     */
+    extractedData?: unknown;
     /**
      * The attestation for the document if one was created.
      */

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

@@ -1,6 +1,6 @@
 import type { IJsonLdContextDefinitionElement } from "@twin.org/data-json-ld";
+import type { SchemaOrgContexts, SchemaOrgTypes } from "@twin.org/standards-schema-org";
 import type { DocumentContexts } from "./documentContexts";
-import type { DocumentTypes } from "./documentTypes";
 import type { IDocument } from "./IDocument";
 /**
  * Interface describing a list of document entries.
@@ -10,6 +10,7 @@ export interface IDocumentList {
      * JSON-LD Context.
      */
     "@context": [
+        typeof SchemaOrgContexts.ContextRoot,
         typeof DocumentContexts.ContextRoot,
         typeof DocumentContexts.ContextRootCommon,
         ...IJsonLdContextDefinitionElement[]
@@ -17,11 +18,11 @@ export interface IDocumentList {
     /**
      * JSON-LD Type.
      */
-    type: typeof DocumentTypes.DocumentList;
+    type: typeof SchemaOrgTypes.ItemList;
     /**
      * The list of documents.
      */
-    documents: IDocument[];
+    [SchemaOrgTypes.ItemListElement]: IDocument[];
     /**
      * The ids of the other vertices which are connected to the document.
      */
@@ -29,5 +30,5 @@ export interface IDocumentList {
     /**
      * The cursor to get the next chunk of documents.
      */
-    cursor?: string;
+    [SchemaOrgTypes.NextItem]?: string;
 }

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

@@ -2,6 +2,7 @@ import type { IAuditableItemGraphVertexList } from "@twin.org/auditable-item-gra
 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.
@@ -59,6 +60,8 @@ export interface IDocumentManagementComponent extends IComponent {
      * @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.extractRuleGroupId If provided will extract data from the document using the specified rule group id.
+     * @param options.extractMimeType By default extraction will auto detect the mime type of the document, this can be used to override the detection.
      * @param cursor The cursor to get the next chunk of revisions.
      * @param pageSize Page size of items to return, defaults to 1 so only most recent is returned.
      * @param userIdentity The identity to perform the auditable item graph operation with.
@@ -70,7 +73,30 @@ export interface IDocumentManagementComponent extends IComponent {
         includeBlobStorageData?: boolean;
         includeAttestation?: boolean;
         includeRemoved?: boolean;
+        extractRuleGroupId?: string;
+        extractMimeType?: string;
     }, cursor?: string, pageSize?: number, userIdentity?: string, nodeIdentity?: string): Promise<IDocumentList>;
+    /**
+     * Get a document revision using it's auditable item graph vertex id.
+     * @param auditableItemGraphDocumentId The auditable item graph vertex id which contains the document.
+     * @param revision The revision id of the document to get.
+     * @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.
+     * @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.
+     */
+    getRevision(auditableItemGraphDocumentId: string, revision: number, options?: {
+        includeBlobStorageMetadata?: boolean;
+        includeBlobStorageData?: boolean;
+        includeAttestation?: boolean;
+        extractRuleGroupId?: string;
+        extractMimeType?: string;
+    }, userIdentity?: string, nodeIdentity?: 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.

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

@@ -26,27 +26,35 @@ 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;
         /**
          * Page size of items to return, defaults to 1 so only most recent is returned.
          * @default 1
          */
-        pageSize?: string;
+        pageSize?: number | string;
         /**
          * The cursor to get the next chunk of revisions.
          */

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

@@ -24,6 +24,6 @@ export interface IDocumentManagementQueryRequest {
         /**
          * The number of documents to return.
          */
-        pageSize?: string;
+        pageSize?: number | string;
     };
 }

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,101 @@
 # @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)
 
 

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,5 +1,9 @@
 # @twin.org/document-management-models
 
+## Classes
+
+- [DocumentManagementDataTypes](classes/DocumentManagementDataTypes.md)
+
 ## Interfaces
 
 - [IDocument](interfaces/IDocument.md)
@@ -9,6 +13,8 @@
 - [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)

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`

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,15 +14,15 @@ 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.
 
@@ -36,8 +36,8 @@ The ids of the other vertices which are connected to the document.
 
 ***
 
-### cursor?
+### nextItem?
 
-> `optional` **cursor**: `string`
+> `optional` **nextItem**: `string`
 
 The cursor to get the next chunk of documents.

package/docs/reference/interfaces/IDocumentManagementComponent.md

@@ -192,6 +192,18 @@ Flag to include the attestation information for the document, defaults to false.
 
 Flag to include deleted documents, 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.
+
 ##### cursor?
 
 `string`
@@ -224,6 +236,80 @@ The documents and revisions if requested, ordered by revision descending, cursor
 
 ***
 
+### getRevision()
+
+> **getRevision**(`auditableItemGraphDocumentId`, `revision`, `options?`, `userIdentity?`, `nodeIdentity?`): `Promise`\<[`IDocument`](IDocument.md)\>
+
+Get a document revision using it's auditable item graph vertex id.
+
+#### Parameters
+
+##### auditableItemGraphDocumentId
+
+`string`
+
+The auditable item graph vertex id which contains the document.
+
+##### revision
+
+`number`
+
+The revision id of the document to get.
+
+##### options?
+
+Additional options for the get operation.
+
+###### includeBlobStorageMetadata?
+
+`boolean`
+
+Flag to include the blob storage metadata for the document, defaults to false.
+
+###### includeBlobStorageData?
+
+`boolean`
+
+Flag to include the blob storage data for the document, defaults to false.
+
+###### includeAttestation?
+
+`boolean`
+
+Flag to include the attestation information for the document, defaults to false.
+
+###### 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.
+
+##### userIdentity?
+
+`string`
+
+The identity to perform the auditable item graph operation with.
+
+##### nodeIdentity?
+
+`string`
+
+The node identity to use for vault operations.
+
+#### Returns
+
+`Promise`\<[`IDocument`](IDocument.md)\>
+
+The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
+
+***
+
 ### removeRevision()
 
 > **removeRevision**(`auditableItemGraphDocumentId`, `revision`, `userIdentity?`, `nodeIdentity?`): `Promise`\<`void`\>

package/docs/reference/interfaces/IDocumentManagementGetRequest.md

@@ -38,7 +38,7 @@ The query parameters.
 
 #### includeBlobStorageMetadata?
 
-> `optional` **includeBlobStorageMetadata**: `boolean`
+> `optional` **includeBlobStorageMetadata**: `string` \| `boolean`
 
 Include the blob storage metadata in the response.
 
@@ -50,7 +50,7 @@ false
 
 #### includeBlobStorageData?
 
-> `optional` **includeBlobStorageData**: `boolean`
+> `optional` **includeBlobStorageData**: `string` \| `boolean`
 
 Include the blob storage data in the response.
 
@@ -62,7 +62,7 @@ false
 
 #### includeAttestation?
 
-> `optional` **includeAttestation**: `boolean`
+> `optional` **includeAttestation**: `string` \| `boolean`
 
 Include the attestation information in the response.
 
@@ -74,7 +74,7 @@ false
 
 #### includeRemoved?
 
-> `optional` **includeRemoved**: `boolean`
+> `optional` **includeRemoved**: `string` \| `boolean`
 
 Include deleted documents in the response.
 
@@ -84,9 +84,21 @@ Include deleted documents in the response.
 false
 ```
 
+#### extractRuleGroupId?
+
+> `optional` **extractRuleGroupId**: `string`
+
+If provided will extract data from the document using the specified rule group id.
+
+#### extractMimeType?
+
+> `optional` **extractMimeType**: `string`
+
+By default extraction will auto detect the mime type of the document, this can be used to override the detection.
+
 #### pageSize?
 
-> `optional` **pageSize**: `string`
+> `optional` **pageSize**: `string` \| `number`
 
 Page size of items to return, defaults to 1 so only most recent is returned.
 

package/docs/reference/interfaces/IDocumentManagementGetRevisionRequest.md

@@ -0,0 +1,91 @@
+# Interface: IDocumentManagementGetRevisionRequest
+
+Request to get a document revision from an auditable item graph vertex.
+
+## Properties
+
+### headers?
+
+> `optional` **headers**: `object`
+
+The headers which can be used to determine the response data type.
+
+#### accept
+
+> **accept**: `"application/json"` \| `"application/ld+json"`
+
+***
+
+### pathParams
+
+> **pathParams**: `object`
+
+The path parameters.
+
+#### auditableItemGraphDocumentId
+
+> **auditableItemGraphDocumentId**: `string`
+
+The full id of the document to get.
+
+#### revision
+
+> **revision**: `string`
+
+The revision of the document to get.
+
+***
+
+### query?
+
+> `optional` **query**: `object`
+
+The query parameters.
+
+#### includeBlobStorageMetadata?
+
+> `optional` **includeBlobStorageMetadata**: `string` \| `boolean`
+
+Include the blob storage metadata in the response.
+
+##### Default
+
+```ts
+false
+```
+
+#### includeBlobStorageData?
+
+> `optional` **includeBlobStorageData**: `string` \| `boolean`
+
+Include the blob storage data in the response.
+
+##### Default
+
+```ts
+false
+```
+
+#### includeAttestation?
+
+> `optional` **includeAttestation**: `string` \| `boolean`
+
+Include the attestation information in the response.
+
+##### Default
+
+```ts
+false
+```
+
+#### extractRuleGroupId?
+
+> `optional` **extractRuleGroupId**: `string`
+
+If provided will extract data from the document using the specified rule group id.
+
+#### extractMimeType?
+
+> `optional` **extractMimeType**: `string`
+
+By default extraction will auto detect the mime type of the document, this can be used to override the detection.

package/docs/reference/interfaces/IDocumentManagementGetRevisionResponse.md

@@ -0,0 +1,23 @@
+# Interface: IDocumentManagementGetRevisionResponse
+
+Response to get a document revision from an auditable item graph vertex.
+
+## Properties
+
+### headers?
+
+> `optional` **headers**: `object`
+
+The headers which can be used to determine the response data type.
+
+#### content-type
+
+> **content-type**: `"application/json"` \| `"application/ld+json"`
+
+***
+
+### body
+
+> **body**: [`IDocument`](IDocument.md)
+
+The body parameters.

package/docs/reference/interfaces/IDocumentManagementQueryRequest.md

@@ -36,6 +36,6 @@ The cursor to get the next chunk of documents.
 
 #### pageSize?
 
-> `optional` **pageSize**: `string`
+> `optional` **pageSize**: `string` \| `number`
 
 The number of documents to return.

package/docs/reference/variables/DocumentTypes.md

@@ -17,9 +17,3 @@ Represents a document.
 > `readonly` **DocumentAttestation**: `"DocumentAttestation"` = `"DocumentAttestation"`
 
 Represents a document attestation.
-
-### DocumentList
-
-> `readonly` **DocumentList**: `"DocumentList"` = `"DocumentList"`
-
-Represents a document list.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/document-management-models",
-	"version": "0.0.1-next.9",
+	"version": "0.0.1",
 	"description": "Models which define the structure of the document management connectors and services",
 	"repository": {
 		"type": "git",
@@ -14,14 +14,15 @@
 		"node": ">=20.0.0"
 	},
 	"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",
-		"@twin.org/nameof": "next",
-		"@twin.org/standards-schema-org": "next",
-		"@twin.org/standards-unece": "next"
+		"@twin.org/attestation-models": "^0.0.1",
+		"@twin.org/auditable-item-graph-models": "^0.0.1",
+		"@twin.org/blob-storage-models": "^0.0.1",
+		"@twin.org/core": "^0.0.1",
+		"@twin.org/data-core": "^0.0.1",
+		"@twin.org/data-json-ld": "^0.0.1",
+		"@twin.org/nameof": "^0.0.1",
+		"@twin.org/standards-schema-org": "^0.0.1",
+		"@twin.org/standards-unece": "^0.0.1"
 	},
 	"main": "./dist/cjs/index.cjs",
 	"module": "./dist/esm/index.mjs",