@twin.org/data-processing-rest-client 0.0.1-next.13 → 0.0.1-next.15

package/dist/cjs/index.cjs

@@ -77,16 +77,18 @@ class DataProcessingClient extends apiCore.BaseRestClient {
      * @param ruleGroupId The id of the rule group to use to extract data.
      * @param data The data to extract from.
      * @param overrideExtractorType An optional override for the extractor type.
+     * @param overrideMimeType An optional override for the mime type for conversion, will auto detect if not provided.
      * @returns The extracted data.
      */
-    async extract(ruleGroupId, data, overrideExtractorType) {
+    async extract(ruleGroupId, data, overrideExtractorType, overrideMimeType) {
         core.Guards.stringValue(this.CLASS_NAME, "ruleGroupId", ruleGroupId);
         core.Guards.uint8Array(this.CLASS_NAME, "data", data);
         const result = await this.fetch("/extract", "POST", {
             body: {
                 ruleGroupId,
                 data: core.Converter.bytesToBase64(data),
-                overrideExtractorType
+                overrideExtractorType,
+                overrideMimeType
             }
         });
         return core.ObjectHelper.fromExtended(result.body);

package/dist/esm/index.mjs

@@ -75,16 +75,18 @@ class DataProcessingClient extends BaseRestClient {
      * @param ruleGroupId The id of the rule group to use to extract data.
      * @param data The data to extract from.
      * @param overrideExtractorType An optional override for the extractor type.
+     * @param overrideMimeType An optional override for the mime type for conversion, will auto detect if not provided.
      * @returns The extracted data.
      */
-    async extract(ruleGroupId, data, overrideExtractorType) {
+    async extract(ruleGroupId, data, overrideExtractorType, overrideMimeType) {
         Guards.stringValue(this.CLASS_NAME, "ruleGroupId", ruleGroupId);
         Guards.uint8Array(this.CLASS_NAME, "data", data);
         const result = await this.fetch("/extract", "POST", {
             body: {
                 ruleGroupId,
                 data: Converter.bytesToBase64(data),
-                overrideExtractorType
+                overrideExtractorType,
+                overrideMimeType
             }
         });
         return ObjectHelper.fromExtended(result.body);

package/dist/types/dataProcessingClient.d.ts

@@ -37,9 +37,10 @@ export declare class DataProcessingClient extends BaseRestClient implements IDat
      * @param ruleGroupId The id of the rule group to use to extract data.
      * @param data The data to extract from.
      * @param overrideExtractorType An optional override for the extractor type.
+     * @param overrideMimeType An optional override for the mime type for conversion, will auto detect if not provided.
      * @returns The extracted data.
      */
-    extract(ruleGroupId: string, data: Uint8Array, overrideExtractorType?: string): Promise<unknown>;
+    extract(ruleGroupId: string, data: Uint8Array, overrideExtractorType?: string, overrideMimeType?: string): Promise<unknown>;
     /**
      * Converts data from the provided input to a structured JSON document.
      * @param data The data to convert.

package/docs/changelog.md

@@ -1,5 +1,33 @@
 # @twin.org/data-processing-rest-client - Changelog
 
+## [0.0.1-next.15](https://github.com/twinfoundation/data-processing/compare/data-processing-rest-client-v0.0.1-next.14...data-processing-rest-client-v0.0.1-next.15) (2025-06-12)
+
+
+### Features
+
+* update dependencies ([21b8e80](https://github.com/twinfoundation/data-processing/commit/21b8e8007c87136a09f0a8e35ffde13a07ff4711))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/data-processing-models bumped from 0.0.1-next.14 to 0.0.1-next.15
+
+## [0.0.1-next.14](https://github.com/twinfoundation/data-processing/compare/data-processing-rest-client-v0.0.1-next.13...data-processing-rest-client-v0.0.1-next.14) (2025-04-28)
+
+
+### Features
+
+* pass the mimeTypeOverride through the component extract method ([#9](https://github.com/twinfoundation/data-processing/issues/9)) ([a2b36de](https://github.com/twinfoundation/data-processing/commit/a2b36de5c19c56e4172d3f22b176aa83e1df84c8))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/data-processing-models bumped from 0.0.1-next.13 to 0.0.1-next.14
+
 ## [0.0.1-next.13](https://github.com/twinfoundation/data-processing/compare/data-processing-rest-client-v0.0.1-next.12...data-processing-rest-client-v0.0.1-next.13) (2025-04-24)
 
 

package/docs/reference/classes/DataProcessingClient.md

@@ -128,7 +128,7 @@ Nothing.
 
 ### extract()
 
-> **extract**(`ruleGroupId`, `data`, `overrideExtractorType?`): `Promise`\<`unknown`\>
+> **extract**(`ruleGroupId`, `data`, `overrideExtractorType?`, `overrideMimeType?`): `Promise`\<`unknown`\>
 
 Extracts data from the provided input.
 
@@ -152,6 +152,12 @@ The data to extract from.
 
 An optional override for the extractor type.
 
+##### overrideMimeType?
+
+`string`
+
+An optional override for the mime type for conversion, will auto detect if not provided.
+
 #### Returns
 
 `Promise`\<`unknown`\>
@@ -198,7 +204,7 @@ The converted data.
 
 ### query()
 
-> **query**(`cursor?`, `pageSize?`): `Promise`\<\{ `entities`: `IRuleGroup`[]; `cursor`: `string`; \}\>
+> **query**(`cursor?`, `pageSize?`): `Promise`\<\{ `entities`: `IRuleGroup`[]; `cursor?`: `string`; \}\>
 
 Query the rule group entries.
 
@@ -218,7 +224,7 @@ The maximum number of entities in a page.
 
 #### Returns
 
-`Promise`\<\{ `entities`: `IRuleGroup`[]; `cursor`: `string`; \}\>
+`Promise`\<\{ `entities`: `IRuleGroup`[]; `cursor?`: `string`; \}\>
 
 All the entities for the storage matching the conditions,
 and a cursor which can be used to request more entities.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/data-processing-rest-client",
-	"version": "0.0.1-next.13",
+	"version": "0.0.1-next.15",
 	"description": "Data processing contract implementation which can connect to REST endpoints",
 	"repository": {
 		"type": "git",
@@ -17,7 +17,7 @@
 		"@twin.org/api-core": "next",
 		"@twin.org/api-models": "next",
 		"@twin.org/core": "next",
-		"@twin.org/data-processing-models": "0.0.1-next.13",
+		"@twin.org/data-processing-models": "0.0.1-next.15",
 		"@twin.org/entity": "next",
 		"@twin.org/nameof": "next",
 		"@twin.org/web": "next"