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

package/dist/cjs/index.cjs

@@ -92,6 +92,8 @@ class DocumentManagementClient extends apiCore.BaseRestClient {
      * @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.
      * @returns The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
@@ -107,12 +109,44 @@ class DocumentManagementClient extends apiCore.BaseRestClient {
                 includeBlobStorageData: options?.includeBlobStorageData,
                 includeAttestation: options?.includeAttestation,
                 includeRemoved: options?.includeRemoved,
+                extractRuleGroupId: options?.extractRuleGroupId,
+                extractMimeType: options?.extractMimeType,
                 cursor,
                 pageSize: core.Coerce.string(pageSize)
             }
         });
         return response.body;
     }
+    /**
+     * 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 for 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.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.
+     * @returns The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
+     */
+    async getRevision(auditableItemGraphDocumentId, revision, options) {
+        core.Urn.guard(this.CLASS_NAME, "auditableItemGraphDocumentId", auditableItemGraphDocumentId);
+        core.Guards.integer(this.CLASS_NAME, "revision", revision);
+        const response = await this.fetch("/:auditableItemGraphDocumentId/:revision", "GET", {
+            pathParams: {
+                auditableItemGraphDocumentId,
+                revision: revision.toString()
+            },
+            query: {
+                includeBlobStorageMetadata: options?.includeBlobStorageMetadata,
+                includeBlobStorageData: options?.includeBlobStorageData,
+                includeAttestation: options?.includeAttestation,
+                extractRuleGroupId: options?.extractRuleGroupId,
+                extractMimeType: options?.extractMimeType
+            }
+        });
+        return response.body;
+    }
     /**
      * 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/esm/index.mjs

@@ -90,6 +90,8 @@ class DocumentManagementClient extends BaseRestClient {
      * @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.
      * @returns The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
@@ -105,12 +107,44 @@ class DocumentManagementClient extends BaseRestClient {
                 includeBlobStorageData: options?.includeBlobStorageData,
                 includeAttestation: options?.includeAttestation,
                 includeRemoved: options?.includeRemoved,
+                extractRuleGroupId: options?.extractRuleGroupId,
+                extractMimeType: options?.extractMimeType,
                 cursor,
                 pageSize: Coerce.string(pageSize)
             }
         });
         return response.body;
     }
+    /**
+     * 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 for 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.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.
+     * @returns The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
+     */
+    async getRevision(auditableItemGraphDocumentId, revision, options) {
+        Urn.guard(this.CLASS_NAME, "auditableItemGraphDocumentId", auditableItemGraphDocumentId);
+        Guards.integer(this.CLASS_NAME, "revision", revision);
+        const response = await this.fetch("/:auditableItemGraphDocumentId/:revision", "GET", {
+            pathParams: {
+                auditableItemGraphDocumentId,
+                revision: revision.toString()
+            },
+            query: {
+                includeBlobStorageMetadata: options?.includeBlobStorageMetadata,
+                includeBlobStorageData: options?.includeBlobStorageData,
+                includeAttestation: options?.includeAttestation,
+                extractRuleGroupId: options?.extractRuleGroupId,
+                extractMimeType: options?.extractMimeType
+            }
+        });
+        return response.body;
+    }
     /**
      * 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/documentManagementClient.d.ts

@@ -2,7 +2,7 @@ import { BaseRestClient } from "@twin.org/api-core";
 import type { IBaseRestClientConfig } from "@twin.org/api-models";
 import type { IAuditableItemGraphVertexList } from "@twin.org/auditable-item-graph-models";
 import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
-import type { IDocumentList, IDocumentManagementComponent } from "@twin.org/document-management-models";
+import type { IDocument, IDocumentList, IDocumentManagementComponent } from "@twin.org/document-management-models";
 import { UneceDocumentCodes } from "@twin.org/standards-unece";
 /**
  * Client for performing document management through to REST endpoints.
@@ -65,6 +65,8 @@ export declare class DocumentManagementClient extends BaseRestClient implements
      * @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.
      * @returns The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
@@ -74,7 +76,28 @@ export declare class DocumentManagementClient extends BaseRestClient implements
         includeBlobStorageData?: boolean;
         includeAttestation?: boolean;
         includeRemoved?: boolean;
+        extractRuleGroupId?: string;
+        extractMimeType?: string;
     }, cursor?: string, pageSize?: number): 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 for 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.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.
+     * @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;
+    }): 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/docs/changelog.md

@@ -1,5 +1,33 @@
 # @twin.org/document-management-rest-client - Changelog
 
+## [0.0.1-next.12](https://github.com/twinfoundation/document-management/compare/document-management-rest-client-v0.0.1-next.11...document-management-rest-client-v0.0.1-next.12) (2025-04-30)
+
+
+### Features
+
+* get document revision ([080eddc](https://github.com/twinfoundation/document-management/commit/080eddcc024c622dda6bb36f60f5fa80a86cf5bb))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/document-management-models bumped from 0.0.1-next.11 to 0.0.1-next.12
+
+## [0.0.1-next.11](https://github.com/twinfoundation/document-management/compare/document-management-rest-client-v0.0.1-next.10...document-management-rest-client-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))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/document-management-models bumped from 0.0.1-next.10 to 0.0.1-next.11
+
 ## [0.0.1-next.10](https://github.com/twinfoundation/document-management/compare/document-management-rest-client-v0.0.1-next.9...document-management-rest-client-v0.0.1-next.10) (2025-04-25)
 
 

package/docs/reference/classes/DocumentManagementClient.md

@@ -216,6 +216,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`
@@ -240,6 +252,72 @@ The documents and revisions if requested, ordered by revision descending, cursor
 
 ***
 
+### getRevision()
+
+> **getRevision**(`auditableItemGraphDocumentId`, `revision`, `options?`): `Promise`\<`IDocument`\>
+
+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 for the document.
+
+##### 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.
+
+#### Returns
+
+`Promise`\<`IDocument`\>
+
+The documents and revisions if requested, ordered by revision descending, cursor is set if there are more document revisions.
+
+#### Implementation of
+
+`IDocumentManagementComponent.getRevision`
+
+***
+
 ### removeRevision()
 
 > **removeRevision**(`auditableItemGraphDocumentId`, `revision`): `Promise`\<`void`\>

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/document-management-rest-client",
-	"version": "0.0.1-next.10",
+	"version": "0.0.1-next.12",
 	"description": "Document management contract implementation which can connect to REST endpoints",
 	"repository": {
 		"type": "git",
@@ -19,7 +19,7 @@
 		"@twin.org/auditable-item-graph-models": "next",
 		"@twin.org/core": "next",
 		"@twin.org/data-json-ld": "next",
-		"@twin.org/document-management-models": "0.0.1-next.10",
+		"@twin.org/document-management-models": "0.0.1-next.12",
 		"@twin.org/entity": "next",
 		"@twin.org/nameof": "next",
 		"@twin.org/standards-unece": "next",