@twin.org/data-processing-rest-client 0.0.2-next.4 → 0.0.3-next.2

package/README.md

@@ -1,6 +1,6 @@
 # TWIN Data Processing REST Client
 
-Data processing contract implementation which can connect to REST endpoints.
+REST client for calling data processing service endpoints from applications.
 
 ## Installation
 

package/dist/{esm/index.mjs → es/dataProcessingRestClient.js}

@@ -1,12 +1,11 @@
-import { BaseRestClient } from '@twin.org/api-core';
-import { Guards, Converter, ObjectHelper, Coerce } from '@twin.org/core';
-
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
+import { BaseRestClient } from "@twin.org/api-core";
+import { Coerce, Converter, Guards, ObjectHelper } from "@twin.org/core";
 /**
  * Client for performing data processing through to REST endpoints.
  */
-class DataProcessingRestClient extends BaseRestClient {
+export class DataProcessingRestClient extends BaseRestClient {
     /**
      * Runtime name for the class.
      */
@@ -18,6 +17,13 @@ class DataProcessingRestClient extends BaseRestClient {
     constructor(config) {
         super(DataProcessingRestClient.CLASS_NAME, config, "data-processing");
     }
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return DataProcessingRestClient.CLASS_NAME;
+    }
     /**
      * Set an extraction rule group.
      * @param ruleGroup The rule group to store.
@@ -119,5 +125,4 @@ class DataProcessingRestClient extends BaseRestClient {
         return response.body;
     }
 }
-
-export { DataProcessingRestClient };
+//# sourceMappingURL=dataProcessingRestClient.js.map

package/dist/es/dataProcessingRestClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dataProcessingRestClient.js","sourceRoot":"","sources":["../../src/dataProcessingRestClient.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEpD,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAkBzE;;GAEG;AACH,MAAM,OAAO,wBAAyB,SAAQ,cAAc;IAC3D;;OAEG;IACI,MAAM,CAAU,UAAU,8BAA8C;IAE/E;;;OAGG;IACH,YAAY,MAA6B;QACxC,KAAK,CAAC,wBAAwB,CAAC,UAAU,EAAE,MAAM,EAAE,iBAAiB,CAAC,CAAC;IACvE,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,wBAAwB,CAAC,UAAU,CAAC;IAC5C,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,YAAY,CAAC,SAAqB;QAC9C,MAAM,CAAC,MAAM,CAAa,wBAAwB,CAAC,UAAU,eAAqB,SAAS,CAAC,CAAC;QAC7F,MAAM,CAAC,WAAW,CAAC,wBAAwB,CAAC,UAAU,kBAAwB,SAAS,CAAC,EAAE,CAAC,CAAC;QAC5F,MAAM,CAAC,WAAW,CACjB,wBAAwB,CAAC,UAAU,qBAEnC,SAAS,CAAC,KAAK,CACf,CAAC;QACF,MAAM,CAAC,KAAK,CACX,wBAAwB,CAAC,UAAU,qBAEnC,SAAS,CAAC,KAAK,CACf,CAAC;QAEF,MAAM,IAAI,CAAC,KAAK,CACf,iBAAiB,EACjB,KAAK,EACL;YACC,UAAU,EAAE;gBACX,EAAE,EAAE,SAAS,CAAC,EAAE;aAChB;YACD,IAAI,EAAE;gBACL,KAAK,EAAE,SAAS,CAAC,KAAK;gBACtB,KAAK,EAAE,SAAS,CAAC,KAAK;aACtB;SACD,CACD,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,YAAY,CAAC,WAAmB;QAC5C,MAAM,CAAC,WAAW,CAAC,wBAAwB,CAAC,UAAU,iBAAuB,WAAW,CAAC,CAAC;QAE1F,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAG/B,iBAAiB,EAAE,KAAK,EAAE;YAC3B,UAAU,EAAE;gBACX,EAAE,EAAE,WAAW;aACf;SACD,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC,IAAI,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,eAAe,CAAC,WAAmB;QAC/C,MAAM,CAAC,WAAW,CAAC,wBAAwB,CAAC,UAAU,iBAAuB,WAAW,CAAC,CAAC;QAE1F,MAAM,IAAI,CAAC,KAAK,CACf,iBAAiB,EACjB,QAAQ,EACR;YACC,UAAU,EAAE;gBACX,EAAE,EAAE,WAAW;aACf;SACD,CACD,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,OAAO,CACnB,WAAmB,EACnB,IAAgB,EAChB,qBAA8B,EAC9B,gBAAyB;QAEzB,MAAM,CAAC,WAAW,CAAC,wBAAwB,CAAC,UAAU,iBAAuB,WAAW,CAAC,CAAC;QAC1F,MAAM,CAAC,UAAU,CAAC,wBAAwB,CAAC,UAAU,UAAgB,IAAI,CAAC,CAAC;QAE3E,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,KAAK,CAC9B,UAAU,EACV,MAAM,EACN;YACC,IAAI,EAAE;gBACL,WAAW;gBACX,IAAI,EAAE,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC;gBACnC,qBAAqB;gBACrB,gBAAgB;aAChB;SACD,CACD,CAAC;QAEF,OAAO,YAAY,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,OAAO,CAAC,IAAgB,EAAE,gBAAyB;QAC/D,MAAM,CAAC,UAAU,CAAC,wBAAwB,CAAC,UAAU,UAAgB,IAAI,CAAC,CAAC;QAE3E,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,KAAK,CAC9B,UAAU,EACV,MAAM,EACN;YACC,IAAI,EAAE;gBACL,IAAI,EAAE,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC;gBACnC,gBAAgB;aAChB;SACD,CACD,CAAC;QAEF,OAAO,YAAY,CAAC,YAAY,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC/C,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,KAAK,CACjB,MAAe,EACf,KAAc;QAWd,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAG/B,aAAa,EAAE,KAAK,EAAE;YACvB,KAAK,EAAE;gBACN,MAAM;gBACN,KAAK,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC;aAC3B;SACD,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC,IAAI,CAAC;IACtB,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { BaseRestClient } from \"@twin.org/api-core\";\nimport type { IBaseRestClientConfig, INoContentResponse } from \"@twin.org/api-models\";\nimport { Coerce, Converter, Guards, ObjectHelper } from \"@twin.org/core\";\nimport type {\n\tIDataProcessingComponent,\n\tIDataProcessingConvertRequest,\n\tIDataProcessingConvertResponse,\n\tIDataProcessingExtractRequest,\n\tIDataProcessingExtractResponse,\n\tIDataProcessingRuleGroupGetRequest,\n\tIDataProcessingRuleGroupGetResponse,\n\tIDataProcessingRuleGroupListRequest,\n\tIDataProcessingRuleGroupListResponse,\n\tIDataProcessingRuleGroupRemoveRequest,\n\tIDataProcessingRuleGroupSetRequest,\n\tIRule,\n\tIRuleGroup\n} from \"@twin.org/data-processing-models\";\nimport { nameof } from \"@twin.org/nameof\";\n\n/**\n * Client for performing data processing through to REST endpoints.\n */\nexport class DataProcessingRestClient extends BaseRestClient implements IDataProcessingComponent {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<DataProcessingRestClient>();\n\n\t/**\n\t * Create a new instance of DataProcessingRestClient.\n\t * @param config The configuration for the client.\n\t */\n\tconstructor(config: IBaseRestClientConfig) {\n\t\tsuper(DataProcessingRestClient.CLASS_NAME, config, \"data-processing\");\n\t}\n\n\t/**\n\t * Returns the class name of the component.\n\t * @returns The class name of the component.\n\t */\n\tpublic className(): string {\n\t\treturn DataProcessingRestClient.CLASS_NAME;\n\t}\n\n\t/**\n\t * Set an extraction rule group.\n\t * @param ruleGroup The rule group to store.\n\t * @returns Nothing.\n\t */\n\tpublic async ruleGroupSet(ruleGroup: IRuleGroup): Promise<void> {\n\t\tGuards.object<IRuleGroup>(DataProcessingRestClient.CLASS_NAME, nameof(ruleGroup), ruleGroup);\n\t\tGuards.stringValue(DataProcessingRestClient.CLASS_NAME, nameof(ruleGroup.id), ruleGroup.id);\n\t\tGuards.stringValue(\n\t\t\tDataProcessingRestClient.CLASS_NAME,\n\t\t\tnameof(ruleGroup.label),\n\t\t\truleGroup.label\n\t\t);\n\t\tGuards.array<IRule>(\n\t\t\tDataProcessingRestClient.CLASS_NAME,\n\t\t\tnameof(ruleGroup.rules),\n\t\t\truleGroup.rules\n\t\t);\n\n\t\tawait this.fetch<IDataProcessingRuleGroupSetRequest, INoContentResponse>(\n\t\t\t\"/rule-group/:id\",\n\t\t\t\"PUT\",\n\t\t\t{\n\t\t\t\tpathParams: {\n\t\t\t\t\tid: ruleGroup.id\n\t\t\t\t},\n\t\t\t\tbody: {\n\t\t\t\t\tlabel: ruleGroup.label,\n\t\t\t\t\trules: ruleGroup.rules\n\t\t\t\t}\n\t\t\t}\n\t\t);\n\t}\n\n\t/**\n\t * Get a rule group for extraction.\n\t * @param ruleGroupId The id of the rule group to get.\n\t * @returns The rule group.\n\t */\n\tpublic async ruleGroupGet(ruleGroupId: string): Promise<IRuleGroup> {\n\t\tGuards.stringValue(DataProcessingRestClient.CLASS_NAME, nameof(ruleGroupId), ruleGroupId);\n\n\t\tconst response = await this.fetch<\n\t\t\tIDataProcessingRuleGroupGetRequest,\n\t\t\tIDataProcessingRuleGroupGetResponse\n\t\t>(\"/rule-group/:id\", \"GET\", {\n\t\t\tpathParams: {\n\t\t\t\tid: ruleGroupId\n\t\t\t}\n\t\t});\n\n\t\treturn response.body;\n\t}\n\n\t/**\n\t * Remove a rule group.\n\t * @param ruleGroupId The id of the rule group to remove.\n\t * @returns Nothing.\n\t */\n\tpublic async ruleGroupRemove(ruleGroupId: string): Promise<void> {\n\t\tGuards.stringValue(DataProcessingRestClient.CLASS_NAME, nameof(ruleGroupId), ruleGroupId);\n\n\t\tawait this.fetch<IDataProcessingRuleGroupRemoveRequest, INoContentResponse>(\n\t\t\t\"/rule-group/:id\",\n\t\t\t\"DELETE\",\n\t\t\t{\n\t\t\t\tpathParams: {\n\t\t\t\t\tid: ruleGroupId\n\t\t\t\t}\n\t\t\t}\n\t\t);\n\t}\n\n\t/**\n\t * Extracts data from the provided input.\n\t * @param ruleGroupId The id of the rule group to use to extract data.\n\t * @param data The data to extract from.\n\t * @param overrideExtractorType An optional override for the extractor type.\n\t * @param overrideMimeType An optional override for the mime type for conversion, will auto detect if not provided.\n\t * @returns The extracted data.\n\t */\n\tpublic async extract(\n\t\truleGroupId: string,\n\t\tdata: Uint8Array,\n\t\toverrideExtractorType?: string,\n\t\toverrideMimeType?: string\n\t): Promise<unknown> {\n\t\tGuards.stringValue(DataProcessingRestClient.CLASS_NAME, nameof(ruleGroupId), ruleGroupId);\n\t\tGuards.uint8Array(DataProcessingRestClient.CLASS_NAME, nameof(data), data);\n\n\t\tconst result = await this.fetch<IDataProcessingExtractRequest, IDataProcessingExtractResponse>(\n\t\t\t\"/extract\",\n\t\t\t\"POST\",\n\t\t\t{\n\t\t\t\tbody: {\n\t\t\t\t\truleGroupId,\n\t\t\t\t\tdata: Converter.bytesToBase64(data),\n\t\t\t\t\toverrideExtractorType,\n\t\t\t\t\toverrideMimeType\n\t\t\t\t}\n\t\t\t}\n\t\t);\n\n\t\treturn ObjectHelper.fromExtended(result.body);\n\t}\n\n\t/**\n\t * Converts data from the provided input to a structured JSON document.\n\t * @param data The data to convert.\n\t * @param overrideMimeType An optional override for the mime type, will auto detect if empty.\n\t * @returns The converted data.\n\t */\n\tpublic async convert(data: Uint8Array, overrideMimeType?: string): Promise<unknown> {\n\t\tGuards.uint8Array(DataProcessingRestClient.CLASS_NAME, nameof(data), data);\n\n\t\tconst result = await this.fetch<IDataProcessingConvertRequest, IDataProcessingConvertResponse>(\n\t\t\t\"/convert\",\n\t\t\t\"POST\",\n\t\t\t{\n\t\t\t\tbody: {\n\t\t\t\t\tdata: Converter.bytesToBase64(data),\n\t\t\t\t\toverrideMimeType\n\t\t\t\t}\n\t\t\t}\n\t\t);\n\n\t\treturn ObjectHelper.fromExtended(result.body);\n\t}\n\n\t/**\n\t * Query the rule group entries.\n\t * @param cursor The cursor to request the next chunk of entities.\n\t * @param limit Limit the number of entities to return.\n\t * @returns All the entities for the storage matching the conditions,\n\t * and a cursor which can be used to request more entities.\n\t */\n\tpublic async query(\n\t\tcursor?: string,\n\t\tlimit?: number\n\t): Promise<{\n\t\t/**\n\t\t * The entities, which can be partial if a limited keys list was provided.\n\t\t */\n\t\tentities: IRuleGroup[];\n\t\t/**\n\t\t * An optional cursor, when defined can be used to call find to get more entities.\n\t\t */\n\t\tcursor?: string;\n\t}> {\n\t\tconst response = await this.fetch<\n\t\t\tIDataProcessingRuleGroupListRequest,\n\t\t\tIDataProcessingRuleGroupListResponse\n\t\t>(\"/rule-group\", \"GET\", {\n\t\t\tquery: {\n\t\t\t\tcursor,\n\t\t\t\tlimit: Coerce.string(limit)\n\t\t\t}\n\t\t});\n\n\t\treturn response.body;\n\t}\n}\n"]}

package/dist/es/index.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./dataProcessingRestClient.js";
+//# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,+BAA+B,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./dataProcessingRestClient.js\";\n"]}

package/dist/types/dataProcessingRestClient.d.ts

@@ -14,6 +14,11 @@ export declare class DataProcessingRestClient extends BaseRestClient implements
      * @param config The configuration for the client.
      */
     constructor(config: IBaseRestClientConfig);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
     /**
      * Set an extraction rule group.
      * @param ruleGroup The rule group to store.

package/dist/types/index.d.ts

@@ -1 +1 @@
-export * from "./dataProcessingRestClient";
+export * from "./dataProcessingRestClient.js";

package/docs/changelog.md

@@ -1,11 +1,52 @@
-# @twin.org/data-processing-rest-client - Changelog
+# Changelog
 
-## [0.0.2-next.4](https://github.com/twinfoundation/data-processing/compare/data-processing-rest-client-v0.0.2-next.3...data-processing-rest-client-v0.0.2-next.4) (2025-10-22)
+## [0.0.3-next.2](https://github.com/iotaledger/twin-data-processing/compare/data-processing-rest-client-v0.0.3-next.1...data-processing-rest-client-v0.0.3-next.2) (2026-05-11)
+
+
+### Features
+
+* typescript 6 update ([b67debb](https://github.com/iotaledger/twin-data-processing/commit/b67debb8aff83c0f3b179c6db038ed733f7308b1))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/data-processing-models bumped from 0.0.3-next.1 to 0.0.3-next.2
+
+## [0.0.3-next.1](https://github.com/iotaledger/twin-data-processing/compare/data-processing-rest-client-v0.0.3-next.0...data-processing-rest-client-v0.0.3-next.1) (2025-11-11)
+
+
+### Features
+
+* add context id features ([#25](https://github.com/iotaledger/twin-data-processing/issues/25)) ([2a2a955](https://github.com/iotaledger/twin-data-processing/commit/2a2a9559d54e8c703e97e2c05996e678416ef560))
+* Add rule group query functionality ([#2](https://github.com/iotaledger/twin-data-processing/issues/2)) ([0fbbfb0](https://github.com/iotaledger/twin-data-processing/commit/0fbbfb065b6ecc293920b25f97ba011743105486))
+* add validate-locales ([9af0874](https://github.com/iotaledger/twin-data-processing/commit/9af0874cd3f44a4cfca514dde8380f002e62337e))
+* eslint migration to flat config ([a8138b0](https://github.com/iotaledger/twin-data-processing/commit/a8138b020ed58baeff162a822d4df207a6aeadc4))
+* pass the mimeTypeOverride through the component extract method ([#9](https://github.com/iotaledger/twin-data-processing/issues/9)) ([a2b36de](https://github.com/iotaledger/twin-data-processing/commit/a2b36de5c19c56e4172d3f22b176aa83e1df84c8))
+* update dependencies ([21b8e80](https://github.com/iotaledger/twin-data-processing/commit/21b8e8007c87136a09f0a8e35ffde13a07ff4711))
+* update framework core ([96f6e80](https://github.com/iotaledger/twin-data-processing/commit/96f6e8016a4ef0fb873f6775e750b4ab42e9f491))
+* use shared store mechanism ([#6](https://github.com/iotaledger/twin-data-processing/issues/6)) ([6009228](https://github.com/iotaledger/twin-data-processing/commit/600922880acef07cc2f818dee7645c342929108b))
+
+
+### Bug Fixes
+
+* supporting array usage ([#20](https://github.com/iotaledger/twin-data-processing/issues/20)) ([d2c68cd](https://github.com/iotaledger/twin-data-processing/commit/d2c68cd3983622586cc073377545d6416b87a827))
+* Update endpoint for fetching rule group list ([#3](https://github.com/iotaledger/twin-data-processing/issues/3)) ([919c1b4](https://github.com/iotaledger/twin-data-processing/commit/919c1b435e760251ca57f96ed9f701b08542f318))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/data-processing-models bumped from 0.0.3-next.0 to 0.0.3-next.1
+
+## [0.0.2-next.4](https://github.com/iotaledger/twin-data-processing/compare/data-processing-rest-client-v0.0.2-next.3...data-processing-rest-client-v0.0.2-next.4) (2025-10-22)
 
 
 ### Bug Fixes
 
-* supporting array usage ([#20](https://github.com/twinfoundation/data-processing/issues/20)) ([d2c68cd](https://github.com/twinfoundation/data-processing/commit/d2c68cd3983622586cc073377545d6416b87a827))
+* supporting array usage ([#20](https://github.com/iotaledger/twin-data-processing/issues/20)) ([d2c68cd](https://github.com/iotaledger/twin-data-processing/commit/d2c68cd3983622586cc073377545d6416b87a827))
 
 
 ### Dependencies
@@ -14,12 +55,12 @@
   * dependencies
     * @twin.org/data-processing-models bumped from 0.0.2-next.3 to 0.0.2-next.4
 
-## [0.0.2-next.3](https://github.com/twinfoundation/data-processing/compare/data-processing-rest-client-v0.0.2-next.2...data-processing-rest-client-v0.0.2-next.3) (2025-10-09)
+## [0.0.2-next.3](https://github.com/iotaledger/twin-data-processing/compare/data-processing-rest-client-v0.0.2-next.2...data-processing-rest-client-v0.0.2-next.3) (2025-10-09)
 
 
 ### Features
 
-* add validate-locales ([9af0874](https://github.com/twinfoundation/data-processing/commit/9af0874cd3f44a4cfca514dde8380f002e62337e))
+* add validate-locales ([9af0874](https://github.com/iotaledger/twin-data-processing/commit/9af0874cd3f44a4cfca514dde8380f002e62337e))
 
 
 ### Dependencies
@@ -28,12 +69,12 @@
   * dependencies
     * @twin.org/data-processing-models bumped from 0.0.2-next.2 to 0.0.2-next.3
 
-## [0.0.2-next.2](https://github.com/twinfoundation/data-processing/compare/data-processing-rest-client-v0.0.2-next.1...data-processing-rest-client-v0.0.2-next.2) (2025-08-29)
+## [0.0.2-next.2](https://github.com/iotaledger/twin-data-processing/compare/data-processing-rest-client-v0.0.2-next.1...data-processing-rest-client-v0.0.2-next.2) (2025-08-29)
 
 
 ### Features
 
-* eslint migration to flat config ([a8138b0](https://github.com/twinfoundation/data-processing/commit/a8138b020ed58baeff162a822d4df207a6aeadc4))
+* eslint migration to flat config ([a8138b0](https://github.com/iotaledger/twin-data-processing/commit/a8138b020ed58baeff162a822d4df207a6aeadc4))
 
 
 ### Dependencies
@@ -42,21 +83,21 @@
   * dependencies
     * @twin.org/data-processing-models bumped from 0.0.2-next.1 to 0.0.2-next.2
 
-## [0.0.2-next.1](https://github.com/twinfoundation/data-processing/compare/data-processing-rest-client-v0.0.2-next.0...data-processing-rest-client-v0.0.2-next.1) (2025-08-20)
+## [0.0.2-next.1](https://github.com/iotaledger/twin-data-processing/compare/data-processing-rest-client-v0.0.2-next.0...data-processing-rest-client-v0.0.2-next.1) (2025-08-20)
 
 
 ### Features
 
-* Add rule group query functionality ([#2](https://github.com/twinfoundation/data-processing/issues/2)) ([0fbbfb0](https://github.com/twinfoundation/data-processing/commit/0fbbfb065b6ecc293920b25f97ba011743105486))
-* 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))
-* update dependencies ([21b8e80](https://github.com/twinfoundation/data-processing/commit/21b8e8007c87136a09f0a8e35ffde13a07ff4711))
-* update framework core ([96f6e80](https://github.com/twinfoundation/data-processing/commit/96f6e8016a4ef0fb873f6775e750b4ab42e9f491))
-* use shared store mechanism ([#6](https://github.com/twinfoundation/data-processing/issues/6)) ([6009228](https://github.com/twinfoundation/data-processing/commit/600922880acef07cc2f818dee7645c342929108b))
+* Add rule group query functionality ([#2](https://github.com/iotaledger/twin-data-processing/issues/2)) ([0fbbfb0](https://github.com/iotaledger/twin-data-processing/commit/0fbbfb065b6ecc293920b25f97ba011743105486))
+* pass the mimeTypeOverride through the component extract method ([#9](https://github.com/iotaledger/twin-data-processing/issues/9)) ([a2b36de](https://github.com/iotaledger/twin-data-processing/commit/a2b36de5c19c56e4172d3f22b176aa83e1df84c8))
+* update dependencies ([21b8e80](https://github.com/iotaledger/twin-data-processing/commit/21b8e8007c87136a09f0a8e35ffde13a07ff4711))
+* update framework core ([96f6e80](https://github.com/iotaledger/twin-data-processing/commit/96f6e8016a4ef0fb873f6775e750b4ab42e9f491))
+* use shared store mechanism ([#6](https://github.com/iotaledger/twin-data-processing/issues/6)) ([6009228](https://github.com/iotaledger/twin-data-processing/commit/600922880acef07cc2f818dee7645c342929108b))
 
 
 ### Bug Fixes
 
-* Update endpoint for fetching rule group list ([#3](https://github.com/twinfoundation/data-processing/issues/3)) ([919c1b4](https://github.com/twinfoundation/data-processing/commit/919c1b435e760251ca57f96ed9f701b08542f318))
+* Update endpoint for fetching rule group list ([#3](https://github.com/iotaledger/twin-data-processing/issues/3)) ([919c1b4](https://github.com/iotaledger/twin-data-processing/commit/919c1b435e760251ca57f96ed9f701b08542f318))
 
 
 ### Dependencies
@@ -70,16 +111,16 @@
 
 ### Features
 
-* Add rule group query functionality ([#2](https://github.com/twinfoundation/data-processing/issues/2)) ([0fbbfb0](https://github.com/twinfoundation/data-processing/commit/0fbbfb065b6ecc293920b25f97ba011743105486))
-* 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))
-* release to production ([531ba89](https://github.com/twinfoundation/data-processing/commit/531ba89dea2deb2810870b72851dca3081f9d2ce))
-* update dependencies ([21b8e80](https://github.com/twinfoundation/data-processing/commit/21b8e8007c87136a09f0a8e35ffde13a07ff4711))
-* use shared store mechanism ([#6](https://github.com/twinfoundation/data-processing/issues/6)) ([6009228](https://github.com/twinfoundation/data-processing/commit/600922880acef07cc2f818dee7645c342929108b))
+* Add rule group query functionality ([#2](https://github.com/iotaledger/twin-data-processing/issues/2)) ([0fbbfb0](https://github.com/iotaledger/twin-data-processing/commit/0fbbfb065b6ecc293920b25f97ba011743105486))
+* pass the mimeTypeOverride through the component extract method ([#9](https://github.com/iotaledger/twin-data-processing/issues/9)) ([a2b36de](https://github.com/iotaledger/twin-data-processing/commit/a2b36de5c19c56e4172d3f22b176aa83e1df84c8))
+* release to production ([531ba89](https://github.com/iotaledger/twin-data-processing/commit/531ba89dea2deb2810870b72851dca3081f9d2ce))
+* update dependencies ([21b8e80](https://github.com/iotaledger/twin-data-processing/commit/21b8e8007c87136a09f0a8e35ffde13a07ff4711))
+* use shared store mechanism ([#6](https://github.com/iotaledger/twin-data-processing/issues/6)) ([6009228](https://github.com/iotaledger/twin-data-processing/commit/600922880acef07cc2f818dee7645c342929108b))
 
 
 ### Bug Fixes
 
-* Update endpoint for fetching rule group list ([#3](https://github.com/twinfoundation/data-processing/issues/3)) ([919c1b4](https://github.com/twinfoundation/data-processing/commit/919c1b435e760251ca57f96ed9f701b08542f318))
+* Update endpoint for fetching rule group list ([#3](https://github.com/iotaledger/twin-data-processing/issues/3)) ([919c1b4](https://github.com/iotaledger/twin-data-processing/commit/919c1b435e760251ca57f96ed9f701b08542f318))
 
 
 ### Dependencies
@@ -88,7 +129,7 @@
   * dependencies
     * @twin.org/data-processing-models bumped from ^0.0.0 to ^0.0.1
 
-## [0.0.1-next.16](https://github.com/twinfoundation/data-processing/compare/data-processing-rest-client-v0.0.1-next.15...data-processing-rest-client-v0.0.1-next.16) (2025-06-20)
+## [0.0.1-next.16](https://github.com/iotaledger/twin-data-processing/compare/data-processing-rest-client-v0.0.1-next.15...data-processing-rest-client-v0.0.1-next.16) (2025-06-20)
 
 
 ### Miscellaneous Chores
@@ -102,12 +143,12 @@
   * dependencies
     * @twin.org/data-processing-models bumped from 0.0.1-next.15 to 0.0.1-next.16
 
-## [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)
+## [0.0.1-next.15](https://github.com/iotaledger/twin-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))
+* update dependencies ([21b8e80](https://github.com/iotaledger/twin-data-processing/commit/21b8e8007c87136a09f0a8e35ffde13a07ff4711))
 
 
 ### Dependencies
@@ -116,12 +157,12 @@
   * 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)
+## [0.0.1-next.14](https://github.com/iotaledger/twin-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))
+* pass the mimeTypeOverride through the component extract method ([#9](https://github.com/iotaledger/twin-data-processing/issues/9)) ([a2b36de](https://github.com/iotaledger/twin-data-processing/commit/a2b36de5c19c56e4172d3f22b176aa83e1df84c8))
 
 
 ### Dependencies
@@ -130,7 +171,7 @@
   * 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)
+## [0.0.1-next.13](https://github.com/iotaledger/twin-data-processing/compare/data-processing-rest-client-v0.0.1-next.12...data-processing-rest-client-v0.0.1-next.13) (2025-04-24)
 
 
 ### Miscellaneous Chores
@@ -144,12 +185,12 @@
   * dependencies
     * @twin.org/data-processing-models bumped from 0.0.1-next.12 to 0.0.1-next.13
 
-## [0.0.1-next.12](https://github.com/twinfoundation/data-processing/compare/data-processing-rest-client-v0.0.1-next.11...data-processing-rest-client-v0.0.1-next.12) (2025-04-17)
+## [0.0.1-next.12](https://github.com/iotaledger/twin-data-processing/compare/data-processing-rest-client-v0.0.1-next.11...data-processing-rest-client-v0.0.1-next.12) (2025-04-17)
 
 
 ### Features
 
-* use shared store mechanism ([#6](https://github.com/twinfoundation/data-processing/issues/6)) ([6009228](https://github.com/twinfoundation/data-processing/commit/600922880acef07cc2f818dee7645c342929108b))
+* use shared store mechanism ([#6](https://github.com/iotaledger/twin-data-processing/issues/6)) ([6009228](https://github.com/iotaledger/twin-data-processing/commit/600922880acef07cc2f818dee7645c342929108b))
 
 
 ### Dependencies
@@ -158,17 +199,17 @@
   * dependencies
     * @twin.org/data-processing-models bumped from 0.0.1-next.11 to 0.0.1-next.12
 
-## [0.0.1-next.11](https://github.com/twinfoundation/data-processing/compare/data-processing-rest-client-v0.0.1-next.10...data-processing-rest-client-v0.0.1-next.11) (2025-03-28)
+## [0.0.1-next.11](https://github.com/iotaledger/twin-data-processing/compare/data-processing-rest-client-v0.0.1-next.10...data-processing-rest-client-v0.0.1-next.11) (2025-03-28)
 
 
 ### Features
 
-* Add rule group query functionality ([#2](https://github.com/twinfoundation/data-processing/issues/2)) ([0fbbfb0](https://github.com/twinfoundation/data-processing/commit/0fbbfb065b6ecc293920b25f97ba011743105486))
+* Add rule group query functionality ([#2](https://github.com/iotaledger/twin-data-processing/issues/2)) ([0fbbfb0](https://github.com/iotaledger/twin-data-processing/commit/0fbbfb065b6ecc293920b25f97ba011743105486))
 
 
 ### Bug Fixes
 
-* Update endpoint for fetching rule group list ([#3](https://github.com/twinfoundation/data-processing/issues/3)) ([919c1b4](https://github.com/twinfoundation/data-processing/commit/919c1b435e760251ca57f96ed9f701b08542f318))
+* Update endpoint for fetching rule group list ([#3](https://github.com/iotaledger/twin-data-processing/issues/3)) ([919c1b4](https://github.com/iotaledger/twin-data-processing/commit/919c1b435e760251ca57f96ed9f701b08542f318))
 
 
 ### Dependencies

package/docs/examples.md

@@ -1 +1,61 @@
-# @twin.org/data-processing-rest-client - Examples
+# Data Processing REST Client Examples
+
+These snippets show how to connect to a running service, maintain rule groups, and call extraction and conversion endpoints.
+
+## DataProcessingRestClient
+
+```typescript
+import { ObjectHelper } from '@twin.org/core';
+import type { IRuleGroup } from '@twin.org/data-processing-models';
+import { DataProcessingRestClient } from '@twin.org/data-processing-rest-client';
+
+const client = new DataProcessingRestClient({ endpoint: 'http://localhost:8080' });
+
+console.log(client.className()); // dataProcessingRestClient
+
+const ruleGroup: IRuleGroup = {
+  id: 'orders-summary',
+  label: 'Orders Summary',
+  rules: [
+    { source: '$.orders[*].id', target: 'orderIds' },
+    { source: '$.orders[*].total', target: 'totals' }
+  ]
+};
+
+await client.ruleGroupSet(ruleGroup);
+
+const saved = await client.ruleGroupGet('orders-summary');
+console.log(saved); // { id: 'orders-summary', label: 'Orders Summary', rules: [ { source: '$.orders[*].id', target: 'orderIds' }, { source: '$.orders[*].total', target: 'totals' } ] }
+```
+
+```typescript
+import { ObjectHelper } from '@twin.org/core';
+import { DataProcessingRestClient } from '@twin.org/data-processing-rest-client';
+
+const client = new DataProcessingRestClient({ endpoint: 'http://localhost:8080' });
+
+const payload = ObjectHelper.toBytes({
+  orders: [
+    { id: 'A-100', total: 19.99 },
+    { id: 'A-101', total: 24.5 }
+  ]
+});
+
+const extracted = await client.extract('orders-summary', payload);
+console.log(extracted); // { orderIds: ['A-100', 'A-101'], totals: [19.99, 24.5] }
+
+const converted = await client.convert(payload, 'application/json');
+console.log(converted); // { orders: [ { id: 'A-100', total: 19.99 }, { id: 'A-101', total: 24.5 } ] }
+```
+
+```typescript
+import { DataProcessingRestClient } from '@twin.org/data-processing-rest-client';
+
+const client = new DataProcessingRestClient({ endpoint: 'http://localhost:8080' });
+
+const listed = await client.query(undefined, 10);
+console.log(listed.entities.length); // 1
+console.log(listed.cursor); // undefined
+
+await client.ruleGroupRemove('orders-summary');
+```

package/docs/reference/classes/DataProcessingRestClient.md

@@ -36,7 +36,7 @@ The configuration for the client.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -44,7 +44,25 @@ Runtime name for the class.
 
 ## Methods
 
-### ruleGroupSet()
+### className() {#classname}
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IDataProcessingComponent.className`
+
+***
+
+### ruleGroupSet() {#rulegroupset}
 
 > **ruleGroupSet**(`ruleGroup`): `Promise`\<`void`\>
 
@@ -70,7 +88,7 @@ Nothing.
 
 ***
 
-### ruleGroupGet()
+### ruleGroupGet() {#rulegroupget}
 
 > **ruleGroupGet**(`ruleGroupId`): `Promise`\<`IRuleGroup`\>
 
@@ -96,7 +114,7 @@ The rule group.
 
 ***
 
-### ruleGroupRemove()
+### ruleGroupRemove() {#rulegroupremove}
 
 > **ruleGroupRemove**(`ruleGroupId`): `Promise`\<`void`\>
 
@@ -122,7 +140,7 @@ Nothing.
 
 ***
 
-### extract()
+### extract() {#extract}
 
 > **extract**(`ruleGroupId`, `data`, `overrideExtractorType?`, `overrideMimeType?`): `Promise`\<`unknown`\>
 
@@ -166,7 +184,7 @@ The extracted data.
 
 ***
 
-### convert()
+### convert() {#convert}
 
 > **convert**(`data`, `overrideMimeType?`): `Promise`\<`unknown`\>
 
@@ -198,7 +216,7 @@ The converted data.
 
 ***
 
-### query()
+### query() {#query}
 
 > **query**(`cursor?`, `limit?`): `Promise`\<\{ `entities`: `IRuleGroup`[]; `cursor?`: `string`; \}\>
 

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@twin.org/data-processing-rest-client",
-	"version": "0.0.2-next.4",
-	"description": "Data processing contract implementation which can connect to REST endpoints",
+	"version": "0.0.3-next.2",
+	"description": "REST client for calling data processing service endpoints from applications",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/twinfoundation/data-processing.git",
+		"url": "git+https://github.com/iotaledger/data-processing.git",
 		"directory": "packages/data-processing-rest-client"
 	},
 	"author": "martyn.janes@iota.org",
@@ -17,25 +17,23 @@
 		"@twin.org/api-core": "next",
 		"@twin.org/api-models": "next",
 		"@twin.org/core": "next",
-		"@twin.org/data-processing-models": "0.0.2-next.4",
+		"@twin.org/data-processing-models": "0.0.3-next.2",
 		"@twin.org/entity": "next",
 		"@twin.org/nameof": "next",
 		"@twin.org/web": "next"
 	},
-	"main": "./dist/cjs/index.cjs",
-	"module": "./dist/esm/index.mjs",
+	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
 			"types": "./dist/types/index.d.ts",
-			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs"
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
 		},
 		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
-		"dist/cjs",
-		"dist/esm",
+		"dist/es",
 		"dist/types",
 		"locales",
 		"docs"
@@ -53,7 +51,7 @@
 		"conversion"
 	],
 	"bugs": {
-		"url": "git+https://github.com/twinfoundation/data-processing/issues"
+		"url": "git+https://github.com/iotaledger/data-processing/issues"
 	},
 	"homepage": "https://twindev.org"
 }

package/dist/cjs/index.cjs

@@ -1,125 +0,0 @@
-'use strict';
-
-var apiCore = require('@twin.org/api-core');
-var core = require('@twin.org/core');
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Client for performing data processing through to REST endpoints.
- */
-class DataProcessingRestClient extends apiCore.BaseRestClient {
-    /**
-     * Runtime name for the class.
-     */
-    static CLASS_NAME = "DataProcessingRestClient";
-    /**
-     * Create a new instance of DataProcessingRestClient.
-     * @param config The configuration for the client.
-     */
-    constructor(config) {
-        super(DataProcessingRestClient.CLASS_NAME, config, "data-processing");
-    }
-    /**
-     * Set an extraction rule group.
-     * @param ruleGroup The rule group to store.
-     * @returns Nothing.
-     */
-    async ruleGroupSet(ruleGroup) {
-        core.Guards.object(DataProcessingRestClient.CLASS_NAME, "ruleGroup", ruleGroup);
-        core.Guards.stringValue(DataProcessingRestClient.CLASS_NAME, "ruleGroup.id", ruleGroup.id);
-        core.Guards.stringValue(DataProcessingRestClient.CLASS_NAME, "ruleGroup.label", ruleGroup.label);
-        core.Guards.array(DataProcessingRestClient.CLASS_NAME, "ruleGroup.rules", ruleGroup.rules);
-        await this.fetch("/rule-group/:id", "PUT", {
-            pathParams: {
-                id: ruleGroup.id
-            },
-            body: {
-                label: ruleGroup.label,
-                rules: ruleGroup.rules
-            }
-        });
-    }
-    /**
-     * Get a rule group for extraction.
-     * @param ruleGroupId The id of the rule group to get.
-     * @returns The rule group.
-     */
-    async ruleGroupGet(ruleGroupId) {
-        core.Guards.stringValue(DataProcessingRestClient.CLASS_NAME, "ruleGroupId", ruleGroupId);
-        const response = await this.fetch("/rule-group/:id", "GET", {
-            pathParams: {
-                id: ruleGroupId
-            }
-        });
-        return response.body;
-    }
-    /**
-     * Remove a rule group.
-     * @param ruleGroupId The id of the rule group to remove.
-     * @returns Nothing.
-     */
-    async ruleGroupRemove(ruleGroupId) {
-        core.Guards.stringValue(DataProcessingRestClient.CLASS_NAME, "ruleGroupId", ruleGroupId);
-        await this.fetch("/rule-group/:id", "DELETE", {
-            pathParams: {
-                id: ruleGroupId
-            }
-        });
-    }
-    /**
-     * Extracts data from the provided input.
-     * @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, overrideMimeType) {
-        core.Guards.stringValue(DataProcessingRestClient.CLASS_NAME, "ruleGroupId", ruleGroupId);
-        core.Guards.uint8Array(DataProcessingRestClient.CLASS_NAME, "data", data);
-        const result = await this.fetch("/extract", "POST", {
-            body: {
-                ruleGroupId,
-                data: core.Converter.bytesToBase64(data),
-                overrideExtractorType,
-                overrideMimeType
-            }
-        });
-        return core.ObjectHelper.fromExtended(result.body);
-    }
-    /**
-     * Converts data from the provided input to a structured JSON document.
-     * @param data The data to convert.
-     * @param overrideMimeType An optional override for the mime type, will auto detect if empty.
-     * @returns The converted data.
-     */
-    async convert(data, overrideMimeType) {
-        core.Guards.uint8Array(DataProcessingRestClient.CLASS_NAME, "data", data);
-        const result = await this.fetch("/convert", "POST", {
-            body: {
-                data: core.Converter.bytesToBase64(data),
-                overrideMimeType
-            }
-        });
-        return core.ObjectHelper.fromExtended(result.body);
-    }
-    /**
-     * Query the rule group entries.
-     * @param cursor The cursor to request the next chunk of entities.
-     * @param limit Limit the number of entities to return.
-     * @returns All the entities for the storage matching the conditions,
-     * and a cursor which can be used to request more entities.
-     */
-    async query(cursor, limit) {
-        const response = await this.fetch("/rule-group", "GET", {
-            query: {
-                cursor,
-                limit: core.Coerce.string(limit)
-            }
-        });
-        return response.body;
-    }
-}
-
-exports.DataProcessingRestClient = DataProcessingRestClient;