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

package/README.md

@@ -1,6 +1,6 @@
 # TWIN Data Processing Extractors
 
-Data extractor connector implementations.
+Connector implementations that extract data from external systems for processing.
 
 ## Installation
 

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

@@ -1,12 +1,11 @@
-import { Guards, Coerce, Is, ObjectHelper, GeneralError, BaseError } from '@twin.org/core';
-import { query } from 'json-p3';
-
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
+import { BaseError, Coerce, GeneralError, Guards, Is, ObjectHelper } from "@twin.org/core";
+import { JsonPathHelper } from "@twin.org/data-json-path";
 /**
  * Class for extracting data from a JSON source.
  */
-class JsonPathExtractorConnector {
+export class JsonPathExtractorConnector {
     /**
      * The namespace supported by the data extractor connector.
      */
@@ -15,6 +14,13 @@ class JsonPathExtractorConnector {
      * Runtime name for the class.
      */
     static CLASS_NAME = "JsonPathExtractorConnector";
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return JsonPathExtractorConnector.CLASS_NAME;
+    }
     /**
      * Extracts data from the provided input.
      * @param data The object to extract from.
@@ -39,7 +45,7 @@ class JsonPathExtractorConnector {
      */
     extractValue(jsonObject, rule, outputObject) {
         try {
-            const jsonNodes = query(rule.source, jsonObject);
+            const jsonNodes = JsonPathHelper.query(rule.source, jsonObject);
             const ruleParts = rule.source.split(".");
             // Group values by their target path to handle multiple results correctly
             const pathToValues = {};
@@ -78,11 +84,9 @@ class JsonPathExtractorConnector {
         }
         catch (err) {
             throw new GeneralError(JsonPathExtractorConnector.CLASS_NAME, "invalidRule", {
-                rule: rule.source,
-                reason: BaseError.fromError(err).message
-            });
+                rule: rule.source
+            }, BaseError.fromError(err));
         }
     }
 }
-
-export { JsonPathExtractorConnector };
+//# sourceMappingURL=jsonPathExtractorConnector.js.map

package/dist/es/extractors/jsonPathExtractorConnector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jsonPathExtractorConnector.js","sourceRoot":"","sources":["../../../src/extractors/jsonPathExtractorConnector.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,EAAE,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC3F,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAI1D;;GAEG;AACH,MAAM,OAAO,0BAA0B;IACtC;;OAEG;IACI,MAAM,CAAU,SAAS,GAAW,WAAW,CAAC;IAEvD;;OAEG;IACI,MAAM,CAAU,UAAU,gCAAgD;IAEjF;;;OAGG;IACI,SAAS;QACf,OAAO,0BAA0B,CAAC,UAAU,CAAC;IAC9C,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,OAAO,CAAC,IAAa,EAAE,KAAc;QACjD,MAAM,CAAC,MAAM,CAAC,0BAA0B,CAAC,UAAU,UAAgB,IAAI,CAAC,CAAC;QACzE,MAAM,CAAC,KAAK,CAAC,0BAA0B,CAAC,UAAU,WAAiB,KAAK,CAAC,CAAC;QAE1E,MAAM,YAAY,GAAY,EAAE,CAAC;QAEjC,KAAK,MAAM,WAAW,IAAI,KAAK,EAAE,CAAC;YACjC,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,WAAW,EAAE,YAAY,CAAC,CAAC;QACpD,CAAC;QAED,OAAO,YAAY,CAAC;IACrB,CAAC;IAED;;;;;;OAMG;IACK,YAAY,CAAC,UAAmB,EAAE,IAAW,EAAE,YAAqB;QAC3E,IAAI,CAAC;YACJ,MAAM,SAAS,GAAG,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;YAEhE,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAEzC,yEAAyE;YACzE,MAAM,YAAY,GAA8B,EAAE,CAAC;YAEnD,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;gBAClC,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,IAAI,CAAC,CAAC;gBAClD,MAAM,cAAc,GAAG,GAAG,IAAI,CAAC,MAAM,GAAG,eAAe,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;gBAC/H,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;gBAEhE,MAAM,YAAY,GAAG,QAAQ,CAAC,QAAQ,CAAC;gBAEvC,4EAA4E;gBAC5E,8EAA8E;gBAC9E,MAAM,OAAO,GACZ,YAAY,CAAC,MAAM,GAAG,CAAC;oBACvB,SAAS,CAAC,MAAM,GAAG,CAAC;oBACpB,EAAE,CAAC,OAAO,CAAC,YAAY,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;oBACjD,SAAS,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;gBAEpD,IAAI,OAAO,EAAE,CAAC;oBACb,oEAAoE;oBACpE,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC;wBACxF,YAAY,CAAC,cAAc,CAAC,GAAG,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC,CAAC;oBAC/D,CAAC;oBAED,6BAA6B;oBAC7B,YAAY,CAAC,cAAc,CAAC,KAAK,EAAE,CAAC;oBACpC,wBAAwB;oBACxB,IAAI,EAAE,CAAC,KAAK,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC,EAAE,CAAC;wBAC5C,YAAY,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;oBACjD,CAAC;gBACF,CAAC;qBAAM,CAAC;oBACP,iDAAiD;oBACjD,YAAY,CAAC,cAAc,CAAC,GAAG,YAAY,CAAC;gBAC7C,CAAC;YACF,CAAC;YAED,sCAAsC;YACtC,KAAK,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE,CAAC;gBAC3D,YAAY,CAAC,WAAW,CAAC,YAAY,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC;YACtD,CAAC;QACF,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACd,MAAM,IAAI,YAAY,CACrB,0BAA0B,CAAC,UAAU,EACrC,aAAa,EACb;gBACC,IAAI,EAAE,IAAI,CAAC,MAAM;aACjB,EACD,SAAS,CAAC,SAAS,CAAC,GAAG,CAAC,CACxB,CAAC;QACH,CAAC;IACF,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { BaseError, Coerce, GeneralError, Guards, Is, ObjectHelper } from \"@twin.org/core\";\nimport { JsonPathHelper } from \"@twin.org/data-json-path\";\nimport type { IDataExtractorConnector, IRule } from \"@twin.org/data-processing-models\";\nimport { nameof } from \"@twin.org/nameof\";\n\n/**\n * Class for extracting data from a JSON source.\n */\nexport class JsonPathExtractorConnector implements IDataExtractorConnector {\n\t/**\n\t * The namespace supported by the data extractor connector.\n\t */\n\tpublic static readonly NAMESPACE: string = \"json-path\";\n\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<JsonPathExtractorConnector>();\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 JsonPathExtractorConnector.CLASS_NAME;\n\t}\n\n\t/**\n\t * Extracts data from the provided input.\n\t * @param data The object to extract from.\n\t * @param rules The rules to use to extract the data.\n\t * @returns The extracted data.\n\t */\n\tpublic async extract(data: unknown, rules: IRule[]): Promise<unknown> {\n\t\tGuards.object(JsonPathExtractorConnector.CLASS_NAME, nameof(data), data);\n\t\tGuards.array(JsonPathExtractorConnector.CLASS_NAME, nameof(rules), rules);\n\n\t\tconst outputObject: unknown = {};\n\n\t\tfor (const extractRule of rules) {\n\t\t\tthis.extractValue(data, extractRule, outputObject);\n\t\t}\n\n\t\treturn outputObject;\n\t}\n\n\t/**\n\t * Extracts the value from the JSON object.\n\t * @param jsonObject The JSON object to extract from.\n\t * @param rule The rule to use to extract the data.\n\t * @param outputObject The object to output the extracted data to.\n\t * @internal\n\t */\n\tprivate extractValue(jsonObject: unknown, rule: IRule, outputObject: unknown): void {\n\t\ttry {\n\t\t\tconst jsonNodes = JsonPathHelper.query(rule.source, jsonObject);\n\n\t\t\tconst ruleParts = rule.source.split(\".\");\n\n\t\t\t// Group values by their target path to handle multiple results correctly\n\t\t\tconst pathToValues: { [id: string]: unknown } = {};\n\n\t\t\tfor (const jsonNode of jsonNodes) {\n\t\t\t\tconst retainPathDepth = rule.retainPathDepth ?? 0;\n\t\t\t\tconst fullTargetPath = `${rule.target}${retainPathDepth > 0 ? `.${jsonNode.location.slice(-retainPathDepth).join(\".\")}` : \"\"}`;\n\t\t\t\tconst coercedValue = Coerce.byType(jsonNode.value, rule.coerce);\n\n\t\t\t\tconst nodeLocation = jsonNode.location;\n\n\t\t\t\t// If the last part of the location before the target property is an integer\n\t\t\t\t// and the corresponding rule part ends with [*], we are dealing with an array\n\t\t\t\tconst isArray =\n\t\t\t\t\tnodeLocation.length > 1 &&\n\t\t\t\t\truleParts.length > 1 &&\n\t\t\t\t\tIs.integer(nodeLocation[nodeLocation.length - 2]) &&\n\t\t\t\t\truleParts[nodeLocation.length - 2].endsWith(\"[*]\");\n\n\t\t\t\tif (isArray) {\n\t\t\t\t\t// If the value is set and not currently an array, convert it to one\n\t\t\t\t\tif (!Is.empty(pathToValues[fullTargetPath]) && !Is.array(pathToValues[fullTargetPath])) {\n\t\t\t\t\t\tpathToValues[fullTargetPath] = [pathToValues[fullTargetPath]];\n\t\t\t\t\t}\n\n\t\t\t\t\t// Make sure the array exists\n\t\t\t\t\tpathToValues[fullTargetPath] ??= [];\n\t\t\t\t\t// And add the new value\n\t\t\t\t\tif (Is.array(pathToValues[fullTargetPath])) {\n\t\t\t\t\t\tpathToValues[fullTargetPath].push(coercedValue);\n\t\t\t\t\t}\n\t\t\t\t} else {\n\t\t\t\t\t// For single values, just set the value directly\n\t\t\t\t\tpathToValues[fullTargetPath] = coercedValue;\n\t\t\t\t}\n\t\t\t}\n\n\t\t\t// Set the values in the output object\n\t\t\tfor (const [path, values] of Object.entries(pathToValues)) {\n\t\t\t\tObjectHelper.propertySet(outputObject, path, values);\n\t\t\t}\n\t\t} catch (err) {\n\t\t\tthrow new GeneralError(\n\t\t\t\tJsonPathExtractorConnector.CLASS_NAME,\n\t\t\t\t\"invalidRule\",\n\t\t\t\t{\n\t\t\t\t\trule: rule.source\n\t\t\t\t},\n\t\t\t\tBaseError.fromError(err)\n\t\t\t);\n\t\t}\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 "./extractors/jsonPathExtractorConnector.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,4CAA4C,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./extractors/jsonPathExtractorConnector.js\";\n"]}

package/dist/types/extractors/jsonPathExtractorConnector.d.ts

@@ -11,6 +11,11 @@ export declare class JsonPathExtractorConnector implements IDataExtractorConnect
      * Runtime name for the class.
      */
     static readonly CLASS_NAME: string;
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
     /**
      * Extracts data from the provided input.
      * @param data The object to extract from.

package/dist/types/index.d.ts

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

package/docs/changelog.md

@@ -1,11 +1,50 @@
-# @twin.org/data-processing-extractors - Changelog
+# Changelog
 
-## [0.0.2-next.4](https://github.com/twinfoundation/data-processing/compare/data-processing-extractors-v0.0.2-next.3...data-processing-extractors-v0.0.2-next.4) (2025-10-22)
+## [0.0.3-next.2](https://github.com/iotaledger/twin-data-processing/compare/data-processing-extractors-v0.0.3-next.1...data-processing-extractors-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-extractors-v0.0.3-next.0...data-processing-extractors-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))
+* 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))
+
+
+### 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-extractors-v0.0.2-next.3...data-processing-extractors-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 +53,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-extractors-v0.0.2-next.2...data-processing-extractors-v0.0.2-next.3) (2025-10-09)
+## [0.0.2-next.3](https://github.com/iotaledger/twin-data-processing/compare/data-processing-extractors-v0.0.2-next.2...data-processing-extractors-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 +67,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-extractors-v0.0.2-next.1...data-processing-extractors-v0.0.2-next.2) (2025-08-29)
+## [0.0.2-next.2](https://github.com/iotaledger/twin-data-processing/compare/data-processing-extractors-v0.0.2-next.1...data-processing-extractors-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,15 +81,15 @@
   * 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-extractors-v0.0.2-next.0...data-processing-extractors-v0.0.2-next.1) (2025-08-20)
+## [0.0.2-next.1](https://github.com/iotaledger/twin-data-processing/compare/data-processing-extractors-v0.0.2-next.0...data-processing-extractors-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))
-* 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))
+* 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))
 
 
 ### Dependencies
@@ -64,10 +103,10 @@
 
 ### Features
 
-* Add rule group query functionality ([#2](https://github.com/twinfoundation/data-processing/issues/2)) ([0fbbfb0](https://github.com/twinfoundation/data-processing/commit/0fbbfb065b6ecc293920b25f97ba011743105486))
-* 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))
+* 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))
 
 
 ### Dependencies
@@ -76,7 +115,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-extractors-v0.0.1-next.15...data-processing-extractors-v0.0.1-next.16) (2025-06-20)
+## [0.0.1-next.16](https://github.com/iotaledger/twin-data-processing/compare/data-processing-extractors-v0.0.1-next.15...data-processing-extractors-v0.0.1-next.16) (2025-06-20)
 
 
 ### Miscellaneous Chores
@@ -90,12 +129,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-extractors-v0.0.1-next.14...data-processing-extractors-v0.0.1-next.15) (2025-06-12)
+## [0.0.1-next.15](https://github.com/iotaledger/twin-data-processing/compare/data-processing-extractors-v0.0.1-next.14...data-processing-extractors-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
@@ -104,7 +143,7 @@
   * 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-extractors-v0.0.1-next.13...data-processing-extractors-v0.0.1-next.14) (2025-04-28)
+## [0.0.1-next.14](https://github.com/iotaledger/twin-data-processing/compare/data-processing-extractors-v0.0.1-next.13...data-processing-extractors-v0.0.1-next.14) (2025-04-28)
 
 
 ### Miscellaneous Chores
@@ -118,7 +157,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-extractors-v0.0.1-next.12...data-processing-extractors-v0.0.1-next.13) (2025-04-24)
+## [0.0.1-next.13](https://github.com/iotaledger/twin-data-processing/compare/data-processing-extractors-v0.0.1-next.12...data-processing-extractors-v0.0.1-next.13) (2025-04-24)
 
 
 ### Miscellaneous Chores
@@ -132,12 +171,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-extractors-v0.0.1-next.11...data-processing-extractors-v0.0.1-next.12) (2025-04-17)
+## [0.0.1-next.12](https://github.com/iotaledger/twin-data-processing/compare/data-processing-extractors-v0.0.1-next.11...data-processing-extractors-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
@@ -146,12 +185,12 @@
   * 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-extractors-v0.0.1-next.10...data-processing-extractors-v0.0.1-next.11) (2025-03-28)
+## [0.0.1-next.11](https://github.com/iotaledger/twin-data-processing/compare/data-processing-extractors-v0.0.1-next.10...data-processing-extractors-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))
 
 
 ### Dependencies

package/docs/examples.md

@@ -1 +1,69 @@
-# @twin.org/data-processing-extractors - Examples
+# Data Processing Extractors Examples
+
+Use these snippets to map nested JSON data into flatter, application-focused shapes with JSONPath rules.
+
+## JsonPathExtractorConnector
+
+```typescript
+import { JsonPathExtractorConnector } from '@twin.org/data-processing-extractors';
+
+const extractor = new JsonPathExtractorConnector();
+
+console.log(extractor.className()); // jsonPathExtractorConnector
+
+const sourceData = {
+  users: [
+    { firstName: 'John', lastName: 'Doe', age: 30 },
+    { firstName: 'Jane', lastName: 'Doe', age: 25 }
+  ]
+};
+
+const extracted = await extractor.extract(sourceData, [
+  { source: '$.users[0].firstName', target: 'profile.givenName' },
+  { source: '$.users[1].lastName', target: 'profile.familyName' }
+]);
+
+console.log(extracted); // { profile: { givenName: 'John', familyName: 'Doe' } }
+```
+
+```typescript
+import { JsonPathExtractorConnector } from '@twin.org/data-processing-extractors';
+
+const extractor = new JsonPathExtractorConnector();
+
+const extracted = await extractor.extract(
+  {
+    store: {
+      books: [
+        { title: 'The Hobbit', author: 'J.R.R. Tolkien' },
+        { title: '1984', author: 'George Orwell' },
+        { title: 'Dune', author: 'Frank Herbert' }
+      ]
+    }
+  },
+  [{ source: '$.store.books[*].title', target: 'bookTitles' }]
+);
+
+console.log(extracted); // { bookTitles: ['The Hobbit', '1984', 'Dune'] }
+```
+
+```typescript
+import { JsonPathExtractorConnector } from '@twin.org/data-processing-extractors';
+
+const extractor = new JsonPathExtractorConnector();
+
+const extracted = await extractor.extract(
+  {
+    users: {
+      user1: { firstName: 'John', lastName: 'Doe', age: 30 },
+      user2: { firstName: 'Jane', lastName: 'Doe', age: 25 }
+    }
+  },
+  [
+    { source: '$.users.*.firstName', target: 'selected', retainPathDepth: 2 },
+    { source: '$.users.*.lastName', target: 'selected', retainPathDepth: 2 }
+  ]
+);
+
+console.log(extracted); // { selected: { user1: { firstName: 'John', lastName: 'Doe' }, user2: { firstName: 'Jane', lastName: 'Doe' } } }
+```

package/docs/reference/classes/JsonPathExtractorConnector.md

@@ -18,7 +18,7 @@ Class for extracting data from a JSON source.
 
 ## Properties
 
-### NAMESPACE
+### NAMESPACE {#namespace}
 
 > `readonly` `static` **NAMESPACE**: `string` = `"json-path"`
 
@@ -26,7 +26,7 @@ The namespace supported by the data extractor connector.
 
 ***
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -34,7 +34,25 @@ Runtime name for the class.
 
 ## Methods
 
-### extract()
+### className() {#classname}
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IDataExtractorConnector.className`
+
+***
+
+### extract() {#extract}
 
 > **extract**(`data`, `rules`): `Promise`\<`unknown`\>
 

package/locales/en.json

@@ -1,7 +1,7 @@
 {
 	"error": {
 		"jsonPathExtractorConnector": {
-			"invalidRule": "The JSONPath rule \"{rule}\" failed with reason: \"{reason}\""
+			"invalidRule": "The JSONPath rule \"{rule}\" failed"
 		}
 	}
 }

package/package.json

@@ -1,10 +1,10 @@
 {
 	"name": "@twin.org/data-processing-extractors",
-	"version": "0.0.2-next.4",
-	"description": "Data extractor connector implementations",
+	"version": "0.0.3-next.2",
+	"description": "Connector implementations that extract data from external systems for processing",
 	"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-extractors"
 	},
 	"author": "martyn.janes@iota.org",
@@ -15,25 +15,23 @@
 	},
 	"dependencies": {
 		"@twin.org/core": "next",
-		"@twin.org/data-processing-models": "0.0.2-next.4",
+		"@twin.org/data-json-path": "next",
+		"@twin.org/data-processing-models": "0.0.3-next.2",
 		"@twin.org/nameof": "next",
-		"@twin.org/web": "next",
-		"json-p3": "2.2.2"
+		"@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"
@@ -51,7 +49,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,90 +0,0 @@
-'use strict';
-
-var core = require('@twin.org/core');
-var jsonP3 = require('json-p3');
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Class for extracting data from a JSON source.
- */
-class JsonPathExtractorConnector {
-    /**
-     * The namespace supported by the data extractor connector.
-     */
-    static NAMESPACE = "json-path";
-    /**
-     * Runtime name for the class.
-     */
-    static CLASS_NAME = "JsonPathExtractorConnector";
-    /**
-     * Extracts data from the provided input.
-     * @param data The object to extract from.
-     * @param rules The rules to use to extract the data.
-     * @returns The extracted data.
-     */
-    async extract(data, rules) {
-        core.Guards.object(JsonPathExtractorConnector.CLASS_NAME, "data", data);
-        core.Guards.array(JsonPathExtractorConnector.CLASS_NAME, "rules", rules);
-        const outputObject = {};
-        for (const extractRule of rules) {
-            this.extractValue(data, extractRule, outputObject);
-        }
-        return outputObject;
-    }
-    /**
-     * Extracts the value from the JSON object.
-     * @param jsonObject The JSON object to extract from.
-     * @param rule The rule to use to extract the data.
-     * @param outputObject The object to output the extracted data to.
-     * @internal
-     */
-    extractValue(jsonObject, rule, outputObject) {
-        try {
-            const jsonNodes = jsonP3.query(rule.source, jsonObject);
-            const ruleParts = rule.source.split(".");
-            // Group values by their target path to handle multiple results correctly
-            const pathToValues = {};
-            for (const jsonNode of jsonNodes) {
-                const retainPathDepth = rule.retainPathDepth ?? 0;
-                const fullTargetPath = `${rule.target}${retainPathDepth > 0 ? `.${jsonNode.location.slice(-retainPathDepth).join(".")}` : ""}`;
-                const coercedValue = core.Coerce.byType(jsonNode.value, rule.coerce);
-                const nodeLocation = jsonNode.location;
-                // If the last part of the location before the target property is an integer
-                // and the corresponding rule part ends with [*], we are dealing with an array
-                const isArray = nodeLocation.length > 1 &&
-                    ruleParts.length > 1 &&
-                    core.Is.integer(nodeLocation[nodeLocation.length - 2]) &&
-                    ruleParts[nodeLocation.length - 2].endsWith("[*]");
-                if (isArray) {
-                    // If the value is set and not currently an array, convert it to one
-                    if (!core.Is.empty(pathToValues[fullTargetPath]) && !core.Is.array(pathToValues[fullTargetPath])) {
-                        pathToValues[fullTargetPath] = [pathToValues[fullTargetPath]];
-                    }
-                    // Make sure the array exists
-                    pathToValues[fullTargetPath] ??= [];
-                    // And add the new value
-                    if (core.Is.array(pathToValues[fullTargetPath])) {
-                        pathToValues[fullTargetPath].push(coercedValue);
-                    }
-                }
-                else {
-                    // For single values, just set the value directly
-                    pathToValues[fullTargetPath] = coercedValue;
-                }
-            }
-            // Set the values in the output object
-            for (const [path, values] of Object.entries(pathToValues)) {
-                core.ObjectHelper.propertySet(outputObject, path, values);
-            }
-        }
-        catch (err) {
-            throw new core.GeneralError(JsonPathExtractorConnector.CLASS_NAME, "invalidRule", {
-                rule: rule.source,
-                reason: core.BaseError.fromError(err).message
-            });
-        }
-    }
-}
-
-exports.JsonPathExtractorConnector = JsonPathExtractorConnector;