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

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

@@ -59,6 +59,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,6 +72,8 @@ 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>;
     /**
      * Remove an auditable item graph vertex using it's id.

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/docs/changelog.md

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

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/package.json

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