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

package/dist/types/index.d.ts

@@ -1,6 +1,8 @@
 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/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

@@ -42,6 +42,14 @@ export interface IDocumentManagementGetRequest {
          * @default false
          */
         includeRemoved?: boolean;
+        /**
+         * 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

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;
+        /**
+         * Include the blob storage data in the response.
+         * @default false
+         */
+        includeBlobStorageData?: boolean;
+        /**
+         * Include the attestation information in the response.
+         * @default false
+         */
+        includeAttestation?: boolean;
+        /**
+         * 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/docs/changelog.md

@@ -1,5 +1,19 @@
 # @twin.org/document-management-models - Changelog
 
+## [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)
 
 

package/docs/reference/index.md

@@ -9,6 +9,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/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

@@ -84,6 +84,18 @@ 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`

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**: `boolean`
+
+Include the blob storage metadata in the response.
+
+##### Default
+
+```ts
+false
+```
+
+#### includeBlobStorageData?
+
+> `optional` **includeBlobStorageData**: `boolean`
+
+Include the blob storage data in the response.
+
+##### Default
+
+```ts
+false
+```
+
+#### includeAttestation?
+
+> `optional` **includeAttestation**: `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/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/document-management-models",
-	"version": "0.0.1-next.10",
+	"version": "0.0.1-next.12",
 	"description": "Models which define the structure of the document management connectors and services",
 	"repository": {
 		"type": "git",