@lytical/jxf 1.0.0

package/README.md

@@ -0,0 +1,274 @@
+# @lytical/jxf
+
+JXF (short for JavaScript Tranformation) library provides a similar solution that XSLT provides, for plain old data (POD) JavaScript objects.\
+Using JSPath for XPATH like DSL, declare transformation templates with declarative conditional statements, to transform your objects into a text formatted document. 
+
+This lightweight implementation is extendable to support simple to complex transformation. 
+
+Among other use cases... 
+
+- Use it to automate document-driven business processes.
+- Dynamically render content for emails; web pages; code generation.
+- Utilize it for EDI processing. 
+
+Built for TypeScript, you can utilize the library with plain old JavaScript. 
+
+Supports ES6 environments in both DOM and NodeJS. 
+
+## Getting Started 
+
+After installing JXF, import and invoke the `jxf()` function. DSL usage documentation can be found in [JSPath]('https://www.npmjs.com/package/jspath'). 
+
+## Usage
+
+```javascript
+jxf(data, transforms, [variables]) 
+```
+### Where
+
+| argument | description |
+| --- | --- |
+| data | an object or array |
+| transforms | an array of one or more transformers and strings |
+| variables | an optional object with keys are variable names and respective values. |
+| **returns** | **an array for strings you can concatenate to compose any text document.** |
+
+## Example
+
+Let's say you want to create the following markdown...
+
+### Markdown 
+Thank you for your interest in our products. As discussed, the following are the top (2) products you are interested in.
+
+| Product | Description | Cost |
+| --- | --- | ---: |
+| CRM | Our state-of-the-art Customer Relationship Management | $39 / mo |
+| CMS | Build web applications and sites with No Coding required | $2500 / yr |
+
+Let me know when you want to move forward...
+
+Regards,
+
+Sally Salesperson\
+sally.salesperson@lytical.com
+
+### Source Code
+
+Import jxf:
+
+```typescript
+import jxf from '@lytical/jxf';
+```
+
+Using the following data:
+
+```typescript
+const data = {
+  customer: {
+    first_name: 'Barry',
+    last_name: 'Hayles',
+    email: 'barry.hayles@lytical.com',
+  },
+  product: [
+    {
+      name: 'CRM',
+      description: 'Our state-of-the-art Customer Relationship Management',
+      price: 39.0,
+      term: 'monthly',
+    },
+    {
+      name: 'CMS',
+      description:
+        'Build web applications and sites with No Coding required',
+      price: 2500.0,
+      term: 'yearly',
+    },
+  ],
+  sales_rep: {
+    name: 'Sally Salesperson',
+    email: 'sally.salesperson@lytical.com',
+  },
+};
+```
+
+...and with the following transformation:
+
+```typescript
+const transform = [
+  `Hi `,
+  jxf_value_of('.customer.first_name'),
+  `, 
+
+Thank you for your interest in our products. As discussed, the following are the top (`,
+  jxf_length('.product'),
+  `) products you are interested in.
+
+| Name | Description | Cost |
+| --- | --- | ---: |
+`,
+  jxf_for_each('.product', [
+  `| `,
+  jxf_value_of('.name'),
+  ` | `,
+  jxf_value_of('.description'),
+  ` | $`,
+  jxf_value_of('.price'),
+  ` / `,
+  jxf_switch('.term', [
+    jxf_case('.{. === "monthly"}', ['mo']),
+    jxf_case('.{. === "yearly"}', ['yr']),
+  ]),
+  ` |
+`,
+  ]),
+  `
+
+Let me know when you want to move forward... 
+
+Regards, 
+
+`,
+  jxf_value_of('.sales_rep.name'),
+  `\\
+`,
+  jxf_value_of('.sales_rep.email'),
+];
+```
+
+...perform the transformation:
+
+```typescript
+const rs = jxf(data, transform);
+const message = rs.join('');
+console.log(message);
+```
+
+## Documentation
+
+A transformers takes as an argument (at the minimum), a selector string (to match the target data). (e.g. `'.property{. > 1.25}'`)
+
+Creating a custom transformer involves returning function with the following signature: `(data, ctx) => string[]`
+
+```typescript
+import apply from 'jspath';
+
+import type { jxf_transformer_t } from '@lytical/jxf/types';
+
+export function my_custom_xformer(match: string): jxf_transformer_t {
+  return (data, ctx): string[] => {
+    const [val] = apply(match, data, ctx);
+    return [val?.toString() ?? ''];
+  };
+}
+```
+
+`data` is the javascript type to select (match) and transform to an array of `string`.
+`ctx` stores variables. Variable should be considered immutable within the context.
+
+This library has standard transformers;
+
+```typescript
+import { ... } from '@lytical/jxf/transformer';
+```
+
+### Transformers
+
+#### *jxf_value_of(match, [formatter])
+---
+Transforms a single scalar value to a string.
+
+| Argument | Description |
+| --- | --- |
+| match | The selector to match the scalar value. |
+| formatter | An optional callback function to specialize the formatting of the scalar value; `(val: any) => string`
+
+#### * jxf_variable(name, match)
+---
+Set a variable name with selected (matched) data. This is useful in capturing values in outer `for` loops, to be used in inner `for` loops.
+
+| Argument | Description |
+| --- | --- |
+| name | The variable name.
+| match | The selector to match the variable value. |
+
+Note: variable names starting with `$` are reserved.
+
+Access the variables in your select (match) statement by prefixing the name with `$`. (e.g. `'.user{.age < $max_age}'`)
+
+#### * jxf_with(match, transformers)
+---
+Select (match) data used in nested transformations.
+
+| Argument | Description |
+| --- | --- |
+| match | The selector to match the scalar value. |
+| transformers | An array of transformers to process the selected data.
+
+#### * jxf_length(match)
+---
+Transforms a selected array's length. The following will not select the `product` array length `.product.length`.\
+This statement will try to select the `length` property of the element(s) of the `product` array.
+
+| Argument | Description |
+| --- | --- |
+| match | The selector to match the array. |
+
+#### * jxf_if(match, transformers)
+---
+Execute the nested transformations if the selected (matched) value is truthy.
+
+| Argument | Description |
+| --- | --- |
+| match | The selector to match the value, and test for truthyness. |
+| transformers | An array of transformers to process the data in context if the match is truthy.
+
+#### * jxf_switch(match, transformers)
+---
+Transforms a single scalar value to a string.
+
+| Argument | Description |
+| --- | --- |
+| match | The selector to match the value to switch. |
+| transformers | An array of `jxf_case()` transformers to test the matched value. (Note: any type of transformer can be added here, but this should be last in the array to handle a default case.)
+
+#### * jxf_case(match, transformers)
+---
+Used as nested transformers to `jxf_switch()`, that are executed if the `match` case is truthy.
+
+| Argument | Description |
+| --- | --- |
+| match | The selector to test the switched value. |
+| transformers | An array of transformers to process the data in context if the match is truthy.
+
+#### * jxf_for_each(match, transformers, [sort])
+---
+Execute the nested transformers for each item in a selected array.
+
+| Argument | Description |
+| --- | --- |
+| match | The selector to match the array value. |
+| transformers | An array of transformers to process each item in the matched array.
+
+For each array item, the following variables are available.
+
+| Name | Description |
+| --- | --- |
+| $even | true if the array item is in an even position |
+| $first | true if the array item is first |
+| $last | true if the array item is last |
+| $length | the length of the array |
+| $odd | true if the array item is in an odd position |
+| $parent | the outer data |
+
+#### * jxf_for_keys(match, transformers, [sort])
+---
+Execute the nested transformers for each key in a selected object.
+
+| Argument | Description |
+| --- | --- |
+| match | The selector to match the first object value. |
+| transformers | An array of transformers to process each key in the matched object.
+
+Stay tuned! I have more packages to come.` 
+
+*lytical(r) is a registered trademark of lytical, inc. all rights are reserved.*

package/index.d.ts

@@ -0,0 +1,31 @@
+import type { jxf_ctx_t, jxf_transformer_t } from './types';
+/**
+ * jxf(data, transform, ctx?)
+ *
+ * @description
+ * Transforms a pod or array using an array of transformers, and or text to add to the transformation.
+ *
+ * @example
+ *
+ * import { jxf_value_of } from '@lytical/jxf/transformers/index.js';
+ *
+ * const data = { name: 'john', age: 42 };
+ * const transform = [
+ *   'User Information:',
+ *   jxf_value_of('.name'),
+ *   ' is ',
+ *   jxf_value_of('.age'),
+ *   ' years old.'
+ * ];
+ * const result = jxf(data, transform);
+ * console.log(result.join('')); // "User Information: john is 42 years old."
+ *
+ * @module \@lytical/jxf/index
+ *
+ * @param {object} data a pod or array to transform
+ * @param {(jxf_transformer_t | string)[]} transform an array of transformers, and or text to add to the transformation
+ * @param {jxf_ctx_t} ctx (optional) context object to pass to the transformers that may contain preset variables
+ * @returns {string[]} an array of strings that represent the transformed data
+ */
+export default function jxf(data: object, transform: (jxf_transformer_t | string)[], ctx?: jxf_ctx_t): string[];
+//# sourceMappingURL=index.d.ts.map

package/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,SAAS,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAE5D;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,CAAC,OAAO,UAAU,GAAG,CACzB,IAAI,EAAE,MAAM,EACZ,SAAS,EAAE,CAAC,iBAAiB,GAAG,MAAM,CAAC,EAAE,EACzC,GAAG,GAAE,SAAc,GAClB,MAAM,EAAE,CAaV"}

package/index.js

@@ -0,0 +1,6 @@
+/* @preserve
+  (c) 2025 lytical, inc. all rights are reserved.
+  lytical(r) is a registered trademark of lytical, inc.
+  please refer to your license agreement on the use of this file.
+*/
+export default function jxf(o,t,f={}){const n=[];void 0===f.$&&(f.$=o);for(const r of t)"string"==typeof r?n.push(r):n.push(...r(o,f));return n}

package/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;EAIE;AAIF;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,CAAC,OAAO,UAAU,GAAG,CACzB,IAAY,EACZ,SAAyC,EACzC,MAAiB,EAAE;IAEnB,MAAM,EAAE,GAAa,EAAE,CAAC;IACxB,IAAI,GAAG,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE,CAAC;QAC3B,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;IAClB,CAAC;IACD,KAAK,MAAM,EAAE,IAAI,SAAS,EAAE,CAAC;QAC3B,IAAI,OAAO,EAAE,KAAK,QAAQ,EAAE,CAAC;YAC3B,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACd,CAAC;aAAM,CAAC;YACN,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC;QAC5B,CAAC;IACH,CAAC;IACD,OAAO,EAAE,CAAC;AACZ,CAAC"}

package/jxf.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=jxf.test.d.ts.map

package/jxf.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"jxf.test.d.ts","sourceRoot":"","sources":["../src/jxf.test.ts"],"names":[],"mappings":""}

package/jxf.test.js

@@ -0,0 +1,6 @@
+/* @preserve
+  (c) 2025 lytical, inc. all rights are reserved.
+  lytical(r) is a registered trademark of lytical, inc.
+  please refer to your license agreement on the use of this file.
+*/
+var __awaiter=this&&this.__awaiter||function(e,a,t,n){return new(t||(t=Promise))(function(r,s){function fulfilled(e){try{step(n.next(e))}catch(e){s(e)}}function rejected(e){try{step(n.throw(e))}catch(e){s(e)}}function step(e){var a;e.done?r(e.value):(a=e.value,a instanceof t?a:new t(function(e){e(a)})).then(fulfilled,rejected)}step((n=n.apply(e,a||[])).next())})};import{expect}from"chai";import{describe}from"mocha";import jxf from"./index.js";import{jxf_case,jxf_for_each,jxf_if,jxf_length,jxf_switch,jxf_value_of,jxf_variable,jxf_with}from"./transformers/index.js";describe("a jsxform instance",()=>{it("can transform plain text",()=>__awaiter(void 0,void 0,void 0,function*(){const e=jxf({},["Hello, World!"]);expect(e).exist.and.is.an("array").that.includes("Hello, World!")})),it("can transform an object property using jxf_value(), into a formatted string",()=>__awaiter(void 0,void 0,void 0,function*(){const e=jxf({name:"Barry"},["Hello, ",jxf_value_of(".name"),"!"]);expect(e).exist.and.is.an("array"),expect(e.join("")).equals("Hello, Barry!")})),it("can transform an object property using jxf_value() and jxf_variable(), into a formatted string",()=>__awaiter(void 0,void 0,void 0,function*(){const e=jxf({first_name:"Barry",last_name:"Hayles"},[jxf_variable("lname",".last_name"),"Hello, ",jxf_value_of(".first_name")," ",jxf_value_of("$lname"),"!"]);expect(e).exist.and.is.an("array"),expect(e.join("")).equals("Hello, Barry Hayles!")})),it("can transform objects using jxf_for_each()",()=>{const e=jxf({name:["Barry","Hayles"]},["Names:",jxf_for_each(".name",[jxf_value_of(".")])]);expect(e).exist.and.is.an("array"),expect(e.join(" ")).equals("Names: Barry Hayles")}),it("can transform objects using jxf_with()",()=>{const e=jxf({first_name:"Barry",last_name:"Hayles"},["Full Name:",jxf_with(".",[jxf_value_of(".first_name"),jxf_value_of(".last_name")])]);expect(e).exist.and.is.an("array"),expect(e.join(" ")).equals("Full Name: Barry Hayles")}),it("can transform objects using jxf_switch() and jfx_case()",()=>{const e=jxf([{first_name:"Barry",last_name:"Hayles",age:42},{first_name:"Roger",last_name:"Rabbit",age:25}],["Ages:",jxf_for_each(".",[jxf_value_of(".first_name"),jxf_value_of(".last_name"),jxf_switch(".age",[jxf_case(".{. <= 30}",["Is Young"]),jxf_case(".{. > 30}",["Is Old"])]),jxf_if(".{$$last === false}",["and"])])]);expect(e).exist.and.is.an("array"),expect(e.join(" ")).equals("Ages: Barry Hayles Is Old and Roger Rabbit Is Young")}),it("can transform an object to email message.",()=>{const e=["Hi ",jxf_value_of(".customer.first_name"),", \n\nThank you for your interest in our products. As discussed, the following are the top (",jxf_length(".product"),") products you are interested in.\n\n| Name | Description | Cost |\n| --- | --- | ---: |\n",jxf_for_each(".product",["| ",jxf_value_of(".name")," | ",jxf_value_of(".description")," | $",jxf_value_of(".price")," / ",jxf_switch(".term",[jxf_case('.{. === "monthly"}',["mo"]),jxf_case('.{. === "yearly"}',["yr"])])," |\n"]),"\n\nLet me know when you want to move forward... \n\nRegards, \n\n",jxf_value_of(".sales_rep.name"),"\\\n",jxf_value_of(".sales_rep.email")],a=jxf({customer:{first_name:"Barry",last_name:"Hayles",email:"barry.hayles@lytical.com"},product:[{name:"CRM",description:"Our state-of-the-art Customer Relationship Management",price:39,term:"monthly"},{name:"CMS",description:"Build web applications and sites with No Coding required",price:2500,term:"yearly"}],sales_rep:{name:"Sally Salesperson",email:"sally.salesperson@lytical.com"}},e);expect(a).exist.and.is.an("array");const t=a.join("");console.log(t)}),it("can transform objects using jxf_for_each and jxf_if()",()=>{const e=jxf([{first_name:"Barry",last_name:"Hayles",age:42},{first_name:"Roger",last_name:"Rabbit",age:25}],["Full Name:",jxf_for_each(".",[jxf_if(".{.age < 30}",[jxf_value_of(".first_name"),jxf_value_of(".last_name")])])]);expect(e).exist.and.is.an("array"),expect(e.join(" ")).equals("Full Name: Roger Rabbit")})});

package/jxf.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"jxf.test.js","sourceRoot":"","sources":["../src/jxf.test.ts"],"names":[],"mappings":"AAAA;;;;EAIE;;;;;;;;;;AAEF,OAAO,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AAC9B,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAEjC,OAAO,GAAG,MAAM,YAAY,CAAC;AAE7B,OAAO,EACL,QAAQ,EACR,YAAY,EACZ,MAAM,EACN,UAAU,EACV,UAAU,EACV,YAAY,EACZ,YAAY,EACZ,QAAQ,GACT,MAAM,yBAAyB,CAAC;AAEjC,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;IAClC,EAAE,CAAC,0BAA0B,EAAE,GAAS,EAAE;QACxC,MAAM,EAAE,GAAG,GAAG,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,CAAC,CAAC;QACtC,MAAM,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;IACrE,CAAC,CAAA,CAAC,CAAC;IAEH,EAAE,CAAC,6EAA6E,EAAE,GAAS,EAAE;QAC3F,MAAM,EAAE,GAAG,GAAG,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,CAAC,SAAS,EAAE,YAAY,CAAC,OAAO,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC;QAC3E,MAAM,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC;QACpC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;IAC9C,CAAC,CAAA,CAAC,CAAC;IAEH,EAAE,CAAC,gGAAgG,EAAE,GAAS,EAAE;QAC9G,MAAM,EAAE,GAAG,GAAG,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,EAAE;YAC3D,YAAY,CAAC,OAAO,EAAE,YAAY,CAAC;YACnC,SAAS;YACT,YAAY,CAAC,aAAa,CAAC;YAC3B,GAAG;YACH,YAAY,CAAC,QAAQ,CAAC;YACtB,GAAG;SACJ,CAAC,CAAC;QACH,MAAM,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC;QACpC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,sBAAsB,CAAC,CAAC;IACrD,CAAC,CAAA,CAAC,CAAC;IAEH,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;QACpD,MAAM,EAAE,GAAG,GAAG,CAAC,EAAE,IAAI,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE,EAAE;YAC5C,QAAQ;YACR,YAAY,CAAC,OAAO,EAAE,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC;SAC3C,CAAC,CAAC;QACH,MAAM,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC;QACpC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;QAChD,MAAM,EAAE,GAAG,GAAG,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,EAAE;YAC3D,YAAY;YACZ,QAAQ,CAAC,GAAG,EAAE,CAAC,YAAY,CAAC,aAAa,CAAC,EAAE,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC;SACzE,CAAC,CAAC;QACH,MAAM,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC;QACpC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,yBAAyB,CAAC,CAAC;IACzD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,yDAAyD,EAAE,GAAG,EAAE;QACjE,MAAM,EAAE,GAAG,GAAG,CACZ;YACE,EAAE,UAAU,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,EAAE,EAAE,EAAE;YACrD,EAAE,UAAU,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,EAAE,EAAE,EAAE;SACtD,EACD;YACE,OAAO;YACP,YAAY,CAAC,GAAG,EAAE;gBAChB,YAAY,CAAC,aAAa,CAAC;gBAC3B,YAAY,CAAC,YAAY,CAAC;gBAC1B,UAAU,CAAC,MAAM,EAAE;oBACjB,QAAQ,CAAC,YAAY,EAAE,CAAC,UAAU,CAAC,CAAC;oBACpC,QAAQ,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,CAAC;iBAClC,CAAC;gBACF,MAAM,CAAC,qBAAqB,EAAE,CAAC,KAAK,CAAC,CAAC;aACvC,CAAC;SACH,CACF,CAAC;QACF,MAAM,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC;QACpC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CACzB,qDAAqD,CACtD,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;QACnD,MAAM,IAAI,GAAG;YACX,QAAQ,EAAE;gBACR,UAAU,EAAE,OAAO;gBACnB,SAAS,EAAE,QAAQ;gBACnB,KAAK,EAAE,0BAA0B;aAClC;YACD,OAAO,EAAE;gBACP;oBACE,IAAI,EAAE,KAAK;oBACX,WAAW,EAAE,uDAAuD;oBACpE,KAAK,EAAE,IAAI;oBACX,IAAI,EAAE,SAAS;iBAChB;gBACD;oBACE,IAAI,EAAE,KAAK;oBACX,WAAW,EACT,0DAA0D;oBAC5D,KAAK,EAAE,MAAM;oBACb,IAAI,EAAE,QAAQ;iBACf;aACF;YACD,SAAS,EAAE;gBACT,IAAI,EAAE,mBAAmB;gBACzB,KAAK,EAAE,+BAA+B;aACvC;SACF,CAAC;QAEF,MAAM,SAAS,GAAG;YAChB,KAAK;YACL,YAAY,CAAC,sBAAsB,CAAC;YACpC;;uFAEiF;YACjF,UAAU,CAAC,UAAU,CAAC;YACtB;;;;CAIL;YACK,YAAY,CAAC,UAAU,EAAE;gBACvB,IAAI;gBACJ,YAAY,CAAC,OAAO,CAAC;gBACrB,KAAK;gBACL,YAAY,CAAC,cAAc,CAAC;gBAC5B,MAAM;gBACN,YAAY,CAAC,QAAQ,CAAC;gBACtB,KAAK;gBACL,UAAU,CAAC,OAAO,EAAE;oBAClB,QAAQ,CAAC,oBAAoB,EAAE,CAAC,IAAI,CAAC,CAAC;oBACtC,QAAQ,CAAC,mBAAmB,EAAE,CAAC,IAAI,CAAC,CAAC;iBACtC,CAAC;gBACF;CACP;aACM,CAAC;YACF;;;;;;CAML;YACK,YAAY,CAAC,iBAAiB,CAAC;YAC/B;CACL;YACK,YAAY,CAAC,kBAAkB,CAAC;SACjC,CAAC;QACF,MAAM,EAAE,GAAG,GAAG,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;QAChC,MAAM,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC;QACpC,MAAM,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAC5B,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IACvB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uDAAuD,EAAE,GAAG,EAAE;QAC/D,MAAM,EAAE,GAAG,GAAG,CACZ;YACE,EAAE,UAAU,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,EAAE,EAAE,EAAE;YACrD,EAAE,UAAU,EAAE,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,EAAE,EAAE,EAAE;SACtD,EACD;YACE,YAAY;YACZ,YAAY,CAAC,GAAG,EAAE;gBAChB,MAAM,CAAC,cAAc,EAAE;oBACrB,YAAY,CAAC,aAAa,CAAC;oBAC3B,YAAY,CAAC,YAAY,CAAC;iBAC3B,CAAC;aACH,CAAC;SACH,CACF,CAAC;QACF,MAAM,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC;QACpC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,yBAAyB,CAAC,CAAC;IACzD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@lytical/jxf",
+  "version": "1.0.0",
+  "description": "A TypeScript library for transforming template declarations into formatted strings based on provided data.",
+  "main": "index.js",
+  "private": false,
+  "scripts": {
+    "build": "tsc --build&&gulp post_build",
+    "clean": "rimraf ./dist",
+    "rebuild": "npm run clean&&npm run build",
+    "test": "mocha --recursive ./dist/**/*.test.js"
+  },
+  "keywords": [
+    "dom",
+    "dsl",
+    "lytical",
+    "node",
+    "template",
+    "template-engine",
+    "transformation",
+    "typescript",
+    "xpath",
+    "xslt"
+  ],
+  "author": {
+    "email": "barry.hayles@lytical.com",
+    "name": "Barry Hayles",
+    "url": "https://www.lytical.com"
+  },
+  "repository": {
+    "type": "github",
+    "url": "git+https://github.com/lytical/jxf.git"
+  },
+  "license": "ISC",
+  "type": "module",
+  "dependencies": {
+    "chai": "^6.2.2",
+    "jspath": "^0.4.0",
+    "mocha": "^11.7.5",
+    "typescript": "^5.9.3"
+  },
+  "devDependencies": {
+    "@types/chai": "^5.2.3",
+    "@types/jspath": "^0.4.2",
+    "@types/mocha": "^10.0.10",
+    "@types/node": "^25.0.9",
+    "gulp": "^5.0.1",
+    "gulp-uglify-es": "^3.0.0",
+    "pump": "^3.0.3",
+    "rimraf": "^6.1.2"
+  }
+}

package/transformers/case.d.ts

@@ -0,0 +1,22 @@
+import type { jxf_transformer_t } from '../types';
+/**
+ * jxf_case(match, transform)
+ * @description
+ * A transformer that applies the given transform if the match expression evaluates to true.
+ * @param {string} match a jspath expression that evaluates to a truthy or falsy value
+ * @param {(jxf_transformer_t | string)[]} transform transformers and/or strings to apply if the match is true
+ * @returns {jxf_transformer_t} A jxf transformer function.
+ * @module \@lytical/jxf/transformers/case
+ * @example
+ * import { jxf_case } from '@lytical/jxf/transformers/case.js';
+ * import jxf from '@lytical/jxf/index.js';
+ *
+ * const data = { age: 25 };
+ * const transform = [
+ *   jxf_case('{.age < 30}', ['Is Young']),
+ *   jxf_case('{.age >= 30}', ['Is Old']),
+ * ];
+ *
+ */
+export declare function jxf_case(match: string, transform: (jxf_transformer_t | string)[]): jxf_transformer_t;
+//# sourceMappingURL=case.d.ts.map

package/transformers/case.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"case.d.ts","sourceRoot":"","sources":["../../src/transformers/case.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAGlD;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,QAAQ,CACtB,KAAK,EAAE,MAAM,EACb,SAAS,EAAE,CAAC,iBAAiB,GAAG,MAAM,CAAC,EAAE,GACxC,iBAAiB,CAKnB"}

package/transformers/case.js

@@ -0,0 +1,6 @@
+/* @preserve
+  (c) 2025 lytical, inc. all rights are reserved.
+  lytical(r) is a registered trademark of lytical, inc.
+  please refer to your license agreement on the use of this file.
+*/
+import apply from"jspath";import jxf from"../index.js";export function jxf_case(t,r){return(s,e)=>{const[n]=apply(t,e.$switch,e);return n?jxf(s,r,Object.assign(Object.assign({},e),{$eval:n})):[]}}

package/transformers/case.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"case.js","sourceRoot":"","sources":["../../src/transformers/case.ts"],"names":[],"mappings":"AAAA;;;;EAIE;AAEF,OAAO,KAAK,MAAM,QAAQ,CAAC;AAG3B,OAAO,GAAG,MAAM,aAAa,CAAC;AAE9B;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,UAAU,QAAQ,CACtB,KAAa,EACb,SAAyC;IAEzC,OAAO,CAAC,IAAI,EAAE,GAAG,EAAY,EAAE;QAC7B,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,SAAS,CAAC,EAAE,GAAG,CAAC,CAAC;QAChD,OAAO,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,SAAS,kCAAO,GAAG,KAAE,KAAK,EAAE,GAAG,IAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IACjE,CAAC,CAAC;AACJ,CAAC"}

package/transformers/for-each.d.ts

@@ -0,0 +1,23 @@
+import type { jxf_transformer_t } from '../types';
+/**
+ * jxf_for_each(match, transform, sort?)
+ * @description
+ * A transformer that iterates over each item in the array resolved by the match expression,
+ * applying the given transform to each item.
+ * @example
+ * import { jxf_for_each, jxf_value_of } from '@lytical/jxf/transformers/index.js';
+ * const data = { names: ['Alice', 'Bob', 'Charlie'] };
+ * const transform = [
+ *   'Names:',
+ *   jxf_for_each('.names', [jxf_value_of('.')]),
+ * ];
+ * const result = jxf(data, transform);
+ * console.log(result.join(' ')); // "Names: Alice Bob Charlie"
+ * @module \@lytical/jxf/transformers/for-each
+ * @param {string} match a jspath expression that resolves to an array
+ * @param {(jxf_transformer_t | string)[]} transform transformers and/or strings to apply to each item in the array
+ * @param {(a: string, b: string) => number} [sort] (optional) a sort function to order the items before transformation
+ * @returns {jxf_transformer_t} A jxf transformer function.
+ */
+export declare function jxf_for_each(match: string, transform: (jxf_transformer_t | string)[], sort?: (a: string, b: string) => number): jxf_transformer_t;
+//# sourceMappingURL=for-each.d.ts.map

package/transformers/for-each.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"for-each.d.ts","sourceRoot":"","sources":["../../src/transformers/for-each.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAIlD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,YAAY,CAC1B,KAAK,EAAE,MAAM,EACb,SAAS,EAAE,CAAC,iBAAiB,GAAG,MAAM,CAAC,EAAE,EACzC,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,KAAK,MAAM,GACtC,iBAAiB,CA+BnB"}

package/transformers/for-each.js

@@ -0,0 +1,6 @@
+/* @preserve
+  (c) 2025 lytical, inc. all rights are reserved.
+  lytical(r) is a registered trademark of lytical, inc.
+  please refer to your license agreement on the use of this file.
+*/
+import apply from"jspath";import jxf from"../index.js";export function jxf_for_each(t,r,e){return(o,n)=>{const s=[];let a=apply(t,o,n);const f="object"==typeof a&&null!==a&&Array.isArray(a);if(console.assert(f,`jxf_for_key: match '${t}' did not resolve to an array.`),f){e&&(a=[...a].sort(e));for(let t=0,e=a.length;t<e;++t)s.push(...jxf(a[t],r,Object.assign(Object.assign({},n),{$even:t%2==0,$first:0===t,$index:t,$last:t===e-1,$length:e,$odd:t%2!=0,$parent:o})))}return s}}

package/transformers/for-each.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"for-each.js","sourceRoot":"","sources":["../../src/transformers/for-each.ts"],"names":[],"mappings":"AAAA;;;;EAIE;AAEF,OAAO,KAAK,MAAM,QAAQ,CAAC;AAI3B,OAAO,GAAG,MAAM,aAAa,CAAC;AAE9B;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,YAAY,CAC1B,KAAa,EACb,SAAyC,EACzC,IAAuC;IAEvC,OAAO,CAAC,IAAI,EAAE,GAAG,EAAY,EAAE;QAC7B,MAAM,EAAE,GAAa,EAAE,CAAC;QACxB,IAAI,GAAG,GAAG,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;QAClC,MAAM,QAAQ,GACZ,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAChE,OAAO,CAAC,MAAM,CACZ,QAAQ,EACR,uBAAuB,KAAK,gCAAgC,CAC7D,CAAC;QACF,IAAI,QAAQ,EAAE,CAAC;YACb,IAAI,IAAI,EAAE,CAAC;gBACT,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC5B,CAAC;YACD,KAAK,IAAI,GAAG,GAAG,CAAC,EAAE,GAAG,GAAG,GAAG,CAAC,MAAM,EAAE,GAAG,GAAG,GAAG,EAAE,EAAE,GAAG,EAAE,CAAC;gBACrD,EAAE,CAAC,IAAI,CACL,GAAG,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,SAAS,kCACrB,GAAG,KACN,KAAK,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC,EACpB,MAAM,EAAE,GAAG,KAAK,CAAC,EACjB,MAAM,EAAE,GAAG,EACX,KAAK,EAAE,GAAG,KAAK,GAAG,GAAG,CAAC,EACtB,OAAO,EAAE,GAAG,EACZ,IAAI,EAAE,GAAG,GAAG,CAAC,KAAK,CAAC,EACnB,OAAO,EAAE,IAAI,IACb,CACH,CAAC;YACJ,CAAC;QACH,CAAC;QACD,OAAO,EAAE,CAAC;IACZ,CAAC,CAAC;AACJ,CAAC"}

package/transformers/for-keys.d.ts

@@ -0,0 +1,23 @@
+import type { jxf_transformer_t } from '../types';
+/**
+ * jxf_for_key(match, transform, sort?)
+ * @description
+ * A transformer that iterates over each key in the object resolved by the match expression,
+ * applying the given transform to each key.
+ * @example
+ * import { jxf_for_key } from '@lytical/jxf/transformers/index.js';
+ * const data = { age: 25, name: 'Alice' };
+ * const transform = [
+ *   'Keys:',
+ *   jxf_for_key('.*', [jxf_value_of('$key')]),
+ * ];
+ * const result = jxf(data, transform);
+ * console.log(result.join(' ')); // "Keys: age name"
+ * @module \@lytical/jxf/transformers/for-keys
+ * @param {string} match a jspath expression that resolves to an object
+ * @param {(jxf_transformer_t | string)[]} transform transformers and/or strings to apply to each key in the object
+ * @param {(a: string, b: string) => number} [sort] (optional) a sort function to order the keys before transformation
+ * @returns {jxf_transformer_t} A jxf transformer function.
+ */
+export declare function jxf_for_key(match: string, transform: (jxf_transformer_t | string)[], sort?: (a: string, b: string) => number): jxf_transformer_t;
+//# sourceMappingURL=for-keys.d.ts.map

package/transformers/for-keys.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"for-keys.d.ts","sourceRoot":"","sources":["../../src/transformers/for-keys.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAIlD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,WAAW,CACzB,KAAK,EAAE,MAAM,EACb,SAAS,EAAE,CAAC,iBAAiB,GAAG,MAAM,CAAC,EAAE,EACzC,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,KAAK,MAAM,GACtC,iBAAiB,CAiBnB"}

package/transformers/for-keys.js

@@ -0,0 +1,6 @@
+/* @preserve
+  (c) 2025 lytical, inc. all rights are reserved.
+  lytical(r) is a registered trademark of lytical, inc.
+  please refer to your license agreement on the use of this file.
+*/
+import apply from"jspath";import jxf from"../index.js";export function jxf_for_key(t,e,o){return(r,s)=>{const n=[],[f]=apply(t,r,s);if(console.assert("object"==typeof f&&null!==f,`jxf_for_key: match '${t}' did not resolve to an object.`),f)for(const t of o?Object.keys(f).sort(o):Object.keys(f))n.push(...jxf(f[t],e,Object.assign(Object.assign({},s),{$key:t,$parent:r})));return n}}

package/transformers/for-keys.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"for-keys.js","sourceRoot":"","sources":["../../src/transformers/for-keys.ts"],"names":[],"mappings":"AAAA;;;;EAIE;AAEF,OAAO,KAAK,MAAM,QAAQ,CAAC;AAI3B,OAAO,GAAG,MAAM,aAAa,CAAC;AAE9B;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,WAAW,CACzB,KAAa,EACb,SAAyC,EACzC,IAAuC;IAEvC,OAAO,CAAC,IAAI,EAAE,GAAG,EAAY,EAAE;QAC7B,MAAM,EAAE,GAAa,EAAE,CAAC;QACxB,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;QACtC,OAAO,CAAC,MAAM,CACZ,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,EACvC,uBAAuB,KAAK,iCAAiC,CAC9D,CAAC;QACF,IAAI,GAAG,EAAE,CAAC;YACR,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;gBACxE,EAAE,CAAC,IAAI,CACL,GAAG,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,SAAS,kCAAO,GAAG,KAAE,IAAI,EAAE,GAAG,EAAE,OAAO,EAAE,IAAI,IAAG,CAClE,CAAC;YACJ,CAAC;QACH,CAAC;QACD,OAAO,EAAE,CAAC;IACZ,CAAC,CAAC;AACJ,CAAC"}

package/transformers/if.d.ts

@@ -0,0 +1,20 @@
+import type { jxf_transformer_t } from '../types';
+/**
+ * jxf_if(match, transform)
+ * @description
+ * A transformer that conditionally applies the given transform to the data if the match expression evaluates to a truthy value.
+ * @example
+ * import { jxf_if, jxf_value_of } from '@lytical/jxf/transformers/index.js';
+ * const data = { age: 25 };
+ * const transform = [
+ *   jxf_if('.age > 18', ['You are an adult.']),
+ * ];
+ * const result = jxf(data, transform);
+ * console.log(result.join(' ')); // "You are an adult."
+ * @module \@lytical/jxf/transformers/if
+ * @param {string} match a jspath expression that resolves to a boolean value
+ * @param {(jxf_transformer_t | string)[]} transform transformers and/or strings to apply if the match expression evaluates to a truthy value
+ * @returns {jxf_transformer_t} A jxf transformer function.
+ */
+export declare function jxf_if(match: string, transform: (jxf_transformer_t | string)[]): jxf_transformer_t;
+//# sourceMappingURL=if.d.ts.map

package/transformers/if.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"if.d.ts","sourceRoot":"","sources":["../../src/transformers/if.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAGlD;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,MAAM,CACpB,KAAK,EAAE,MAAM,EACb,SAAS,EAAE,CAAC,iBAAiB,GAAG,MAAM,CAAC,EAAE,GACxC,iBAAiB,CAKnB"}

package/transformers/if.js

@@ -0,0 +1,6 @@
+/* @preserve
+  (c) 2025 lytical, inc. all rights are reserved.
+  lytical(r) is a registered trademark of lytical, inc.
+  please refer to your license agreement on the use of this file.
+*/
+import apply from"jspath";import jxf from"../index.js";export function jxf_if(t,r){return(n,p)=>{const[e]=apply(t,n,p);return e?jxf(n,r,Object.assign(Object.assign({},p),{$eval:e})):[]}}

package/transformers/if.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"if.js","sourceRoot":"","sources":["../../src/transformers/if.ts"],"names":[],"mappings":"AAAA;;;;EAIE;AAEF,OAAO,KAAK,MAAM,QAAQ,CAAC;AAG3B,OAAO,GAAG,MAAM,aAAa,CAAC;AAE9B;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,MAAM,CACpB,KAAa,EACb,SAAyC;IAEzC,OAAO,CAAC,IAAI,EAAE,GAAG,EAAY,EAAE;QAC7B,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;QACtC,OAAO,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,EAAE,SAAS,kCAAO,GAAG,KAAE,KAAK,EAAE,GAAG,IAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IACjE,CAAC,CAAC;AACJ,CAAC"}

package/transformers/index.d.ts

@@ -0,0 +1,10 @@
+export * from './case.js';
+export * from './for-keys.js';
+export * from './for-each.js';
+export * from './if.js';
+export * from './length.js';
+export * from './switch.js';
+export * from './value-of.js';
+export * from './variable.js';
+export * from './with.js';
+//# sourceMappingURL=index.d.ts.map

package/transformers/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/transformers/index.ts"],"names":[],"mappings":"AAMA,cAAc,WAAW,CAAA;AACzB,cAAc,eAAe,CAAA;AAC7B,cAAc,eAAe,CAAA;AAC7B,cAAc,SAAS,CAAA;AACvB,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,eAAe,CAAA;AAC7B,cAAc,eAAe,CAAA;AAC7B,cAAc,WAAW,CAAA"}

package/transformers/index.js

@@ -0,0 +1,6 @@
+/* @preserve
+  (c) 2025 lytical, inc. all rights are reserved.
+  lytical(r) is a registered trademark of lytical, inc.
+  please refer to your license agreement on the use of this file.
+*/
+export*from"./case.js";export*from"./for-keys.js";export*from"./for-each.js";export*from"./if.js";export*from"./length.js";export*from"./switch.js";export*from"./value-of.js";export*from"./variable.js";export*from"./with.js";

package/transformers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/transformers/index.ts"],"names":[],"mappings":"AAAA;;;;EAIE;AAEF,cAAc,WAAW,CAAA;AACzB,cAAc,eAAe,CAAA;AAC7B,cAAc,eAAe,CAAA;AAC7B,cAAc,SAAS,CAAA;AACvB,cAAc,aAAa,CAAA;AAC3B,cAAc,aAAa,CAAA;AAC3B,cAAc,eAAe,CAAA;AAC7B,cAAc,eAAe,CAAA;AAC7B,cAAc,WAAW,CAAA"}

package/transformers/length.d.ts

@@ -0,0 +1,12 @@
+import type { jxf_transformer_t } from '../types';
+/**
+ * jxf_length(match)
+ * @description
+ * A transformer that computes the length of the array or string resolved by the match expression.
+ * @example
+ * import { jxf_length } from '@lytical/jxf/transformers/index.js';
+ * @param match a jspath expression that resolves to an array or string
+ * @returns {jxf_transformer_t} A jxf transformer function.
+ */
+export declare function jxf_length(match: string): jxf_transformer_t;
+//# sourceMappingURL=length.d.ts.map

package/transformers/length.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"length.d.ts","sourceRoot":"","sources":["../../src/transformers/length.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAElD;;;;;;;;GAQG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,iBAAiB,CAK3D"}

package/transformers/length.js

@@ -0,0 +1,6 @@
+/* @preserve
+  (c) 2025 lytical, inc. all rights are reserved.
+  lytical(r) is a registered trademark of lytical, inc.
+  please refer to your license agreement on the use of this file.
+*/
+import apply from"jspath";export function jxf_length(t){return(p,n)=>[apply(t,p,n).length.toString()]}

package/transformers/length.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"length.js","sourceRoot":"","sources":["../../src/transformers/length.ts"],"names":[],"mappings":"AAAA;;;;EAIE;AAEF,OAAO,KAAK,MAAM,QAAQ,CAAC;AAI3B;;;;;;;;GAQG;AACH,MAAM,UAAU,UAAU,CAAC,KAAa;IACtC,OAAO,CAAC,IAAI,EAAE,GAAG,EAAY,EAAE;QAC7B,MAAM,GAAG,GAAG,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;QACpC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC;IACjC,CAAC,CAAC;AACJ,CAAC"}

package/transformers/switch.d.ts

@@ -0,0 +1,23 @@
+import type { jxf_transformer_t } from '../types';
+/**
+ * jxf_switch(match, transform)
+ * @description
+ * A transformer that evaluates the match expression and applies the first case transform that matches.
+ * @example
+ * import { jxf_switch, jxf_case } from '@lytical/jxf/transformers/index.js';
+ * const data = { age: 25 };
+ * const transform = [
+ *   jxf_switch('.age', [
+ *     jxf_case('.age < 18', ['You are a minor.']),
+ *     jxf_case('.age >= 18', ['You are an adult.']),
+ *   ]),
+ * ];
+ * const result = jxf(data, transform);
+ * console.log(result.join(' ')); // "You are an adult."
+ * @module \@lytical/jxf/transformers/switch
+ * @param {string} match a jspath expression that resolves to a value to be matched
+ * @param {(jxf_transformer_t | string)[]} transform transformers and/or strings to apply if the match expression evaluates to a truthy value
+ * @returns {jxf_transformer_t} A jxf transformer function.
+ */
+export declare function jxf_switch(match: string, transform: (jxf_transformer_t | string)[]): jxf_transformer_t;
+//# sourceMappingURL=switch.d.ts.map

package/transformers/switch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"switch.d.ts","sourceRoot":"","sources":["../../src/transformers/switch.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAGlD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,UAAU,CACxB,KAAK,EAAE,MAAM,EACb,SAAS,EAAE,CAAC,iBAAiB,GAAG,MAAM,CAAC,EAAE,GACxC,iBAAiB,CAWnB"}

package/transformers/switch.js

@@ -0,0 +1,6 @@
+/* @preserve
+  (c) 2025 lytical, inc. all rights are reserved.
+  lytical(r) is a registered trademark of lytical, inc.
+  please refer to your license agreement on the use of this file.
+*/
+import apply from"jspath";import jxf from"../index.js";export function jxf_switch(t,n){return(r,o)=>{const[s]=apply(t,r,o);for(const t of n){const n=jxf(r,[t],Object.assign(Object.assign({},o),{$switch:s}));if(0!==n.length)return n}return[]}}

package/transformers/switch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"switch.js","sourceRoot":"","sources":["../../src/transformers/switch.ts"],"names":[],"mappings":"AAAA;;;;EAIE;AAEF,OAAO,KAAK,MAAM,QAAQ,CAAC;AAG3B,OAAO,GAAG,MAAM,aAAa,CAAC;AAE9B;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,UAAU,UAAU,CACxB,KAAa,EACb,SAAyC;IAEzC,OAAO,CAAC,IAAI,EAAE,GAAG,EAAY,EAAE;QAC7B,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;QACtC,KAAK,MAAM,CAAC,IAAI,SAAS,EAAE,CAAC;YAC1B,MAAM,EAAE,GAAG,GAAG,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,kCAAO,GAAG,KAAE,OAAO,EAAE,GAAG,IAAG,CAAC;YACpD,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACpB,OAAO,EAAE,CAAC;YACZ,CAAC;QACH,CAAC;QACD,OAAO,EAAE,CAAC;IACZ,CAAC,CAAC;AACJ,CAAC"}

package/transformers/value-of.d.ts

@@ -0,0 +1,20 @@
+import type { jxf_transformer_t } from '../types';
+/**
+ * jxf_value_of(match, format)
+ * @description
+ * A transformer that extracts the value resolved by the match expression and formats it as a string.
+ * @example
+ * import { jxf_value_of } from '@lytical/jxf/transformers/index.js';
+ * const data = { name: 'John Doe' };
+ * const transform = [
+ *   jxf_value_of('.name', (val) => `Name: ${val}`),
+ * ];
+ * const result = jxf(data, transform);
+ * console.log(result.join(' ')); // "Name: John Doe"
+ * @module \@lytical/jxf/transformers/value-of
+ * @param match a jspath expression that resolves to a value
+ * @param format a function that formats the value as a string
+ * @returns {jxf_transformer_t} A jxf transformer function.
+ */
+export declare function jxf_value_of(match: string, format?: (val: any) => string): jxf_transformer_t;
+//# sourceMappingURL=value-of.d.ts.map

package/transformers/value-of.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"value-of.d.ts","sourceRoot":"","sources":["../../src/transformers/value-of.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAElD;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,YAAY,CAC1B,KAAK,EAAE,MAAM,EACb,MAAM,GAAE,CAAC,GAAG,EAAE,GAAG,KAAK,MAAiC,GACtD,iBAAiB,CAKnB"}

package/transformers/value-of.js

@@ -0,0 +1,6 @@
+/* @preserve
+  (c) 2025 lytical, inc. all rights are reserved.
+  lytical(r) is a registered trademark of lytical, inc.
+  please refer to your license agreement on the use of this file.
+*/
+import apply from"jspath";export function jxf_value_of(t,o=t=>null==t?void 0:t.toString()){return(r,n)=>{const[p]=apply(t,r,n);return[o(p)]}}

package/transformers/value-of.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"value-of.js","sourceRoot":"","sources":["../../src/transformers/value-of.ts"],"names":[],"mappings":"AAAA;;;;EAIE;AAEF,OAAO,KAAK,MAAM,QAAQ,CAAC;AAI3B;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,YAAY,CAC1B,KAAa,EACb,SAA+B,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,QAAQ,EAAE;IAEvD,OAAO,CAAC,IAAI,EAAE,GAAG,EAAY,EAAE;QAC7B,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;QACtC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;IACvB,CAAC,CAAC;AACJ,CAAC"}

package/transformers/variable.d.ts

@@ -0,0 +1,21 @@
+import type { jxf_transformer_t } from '../types';
+/**
+ * jxf_variable(name, match)
+ * @description
+ * A transformer that defines a variable in the transformation context by evaluating the match expression.
+ * @example
+ * import { jxf_variable, jxf_value_of } from '@lytical/jxf/transformers/index.js';
+ * const data = { first_name: 'John', last_name: 'Doe' };
+ * const transform = [
+ *   jxf_variable('fullName', '.first_name + " " + .last_name'),
+ *  jxf_value_of('.fullName', (val) => `Full Name: ${val}`),
+ * ];
+ * const result = jxf(data, transform);
+ * console.log(result.join(' ')); // "Full Name: John Doe"
+ * @module \@lytical/jxf/transformers/variable
+ * @param name the name of the variable to define
+ * @param match a jspath expression that resolves to a value
+ * @returns {jxf_transformer_t} A jxf transformer function.
+ */
+export declare function jxf_variable(name: string, match: string): jxf_transformer_t;
+//# sourceMappingURL=variable.d.ts.map

package/transformers/variable.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"variable.d.ts","sourceRoot":"","sources":["../../src/transformers/variable.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAElD;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,iBAAiB,CAY3E"}

package/transformers/variable.js

@@ -0,0 +1,6 @@
+/* @preserve
+  (c) 2025 lytical, inc. all rights are reserved.
+  lytical(r) is a registered trademark of lytical, inc.
+  please refer to your license agreement on the use of this file.
+*/
+import apply from"jspath";export function jxf_variable(a,e){return(r,t)=>{const i=t[a];return console.assert(void 0===i,`jxf_variable: variable '${a}' is already defined in the context. variables are immutable.`),i||(t[a]=apply(e,r,t)),[]}}

package/transformers/variable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"variable.js","sourceRoot":"","sources":["../../src/transformers/variable.ts"],"names":[],"mappings":"AAAA;;;;EAIE;AAEF,OAAO,KAAK,MAAM,QAAQ,CAAC;AAI3B;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,YAAY,CAAC,IAAY,EAAE,KAAa;IACtD,OAAO,CAAC,IAAI,EAAE,GAAG,EAAY,EAAE;QAC7B,MAAM,GAAG,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC;QACtB,OAAO,CAAC,MAAM,CACZ,GAAG,KAAK,SAAS,EACjB,2BAA2B,IAAI,+DAA+D,CAC/F,CAAC;QACF,IAAI,CAAC,GAAG,EAAE,CAAC;YACT,GAAG,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;QACtC,CAAC;QACD,OAAO,EAAE,CAAC;IACZ,CAAC,CAAC;AACJ,CAAC"}

package/transformers/with.d.ts

@@ -0,0 +1,22 @@
+import type { jxf_transformer_t } from '../types';
+/**
+ * jxf_with(match, transform)
+ * @description
+ * A transformer that changes the context to the value resolved by the match expression and applies the given transform.
+ * @example
+ * import { jxf_with, jxf_value_of } from '@lytical/jxf/transformers/index.js';
+ * const data = { user: { name: 'John Doe', age: 30 } };
+ * const transform = [
+ *   jxf_with('.user', [
+ *     jxf_value_of('.name', (val) => `Name: ${val}`),
+ *     jxf_value_of('.age', (val) => `Age: ${val}`),
+ *   ]),
+ * ];
+ * const result = jxf(data, transform);
+ * console.log(result.join(' ')); // "Name: John Doe Age: 30"
+ * @param match a jspath expression that resolves to a value
+ * @param transform transformers and/or strings to apply with the new context
+ * @returns {jxf_transformer_t} A jxf transformer function.
+ */
+export declare function jxf_with(match: string, transform: (jxf_transformer_t | string)[]): jxf_transformer_t;
+//# sourceMappingURL=with.d.ts.map

package/transformers/with.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"with.d.ts","sourceRoot":"","sources":["../../src/transformers/with.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAGlD;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,QAAQ,CACtB,KAAK,EAAE,MAAM,EACb,SAAS,EAAE,CAAC,iBAAiB,GAAG,MAAM,CAAC,EAAE,GACxC,iBAAiB,CAKnB"}

package/transformers/with.js

@@ -0,0 +1,6 @@
+/* @preserve
+  (c) 2025 lytical, inc. all rights are reserved.
+  lytical(r) is a registered trademark of lytical, inc.
+  please refer to your license agreement on the use of this file.
+*/
+import apply from"jspath";import jxf from"../index.js";export function jxf_with(t,r){return(n,p)=>{const e=apply(t,n,p);return e?jxf(e,r,Object.assign(Object.assign({},p),{$parent:n})):[]}}

package/transformers/with.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"with.js","sourceRoot":"","sources":["../../src/transformers/with.ts"],"names":[],"mappings":"AAAA;;;;EAIE;AAEF,OAAO,KAAK,MAAM,QAAQ,CAAC;AAG3B,OAAO,GAAG,MAAM,aAAa,CAAC;AAE9B;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,UAAU,QAAQ,CACtB,KAAa,EACb,SAAyC;IAEzC,OAAO,CAAC,IAAI,EAAE,GAAG,EAAY,EAAE;QAC7B,MAAM,GAAG,GAAG,KAAK,CAAC,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;QACpC,OAAO,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,SAAS,kCAAO,GAAG,KAAE,OAAO,EAAE,IAAI,IAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IACnE,CAAC,CAAC;AACJ,CAAC"}

package/types.d.ts

@@ -0,0 +1,48 @@
+/* @preserve
+  (c) 2025 lytical, inc. all rights are reserved.
+  lytical(r) is a registered trademark of lytical, inc.
+  please refer to your license agreement on the use of this file.
+*/
+
+/**
+ * jxf_ctx_t
+ * Stores context variables for jxf transformers.
+ * @description
+ * Context object type used in jxf transformers.
+ * @typedef {Record<string, any>} jxf_ctx_t
+ * @property {Record<string, any>} [key: string] - dynamic properties to hold context variables
+ * @module \@lytical/jxf/types
+ */
+export type jxf_ctx_t = Record<string, any>;
+
+/**
+ * jxf_transformer_t
+ * A function type for jxf transformers.
+ * @description
+ * Function type that defines the signature for jxf transformers.
+ * @example
+ * import type { jxf_ctx_t, jxf_transformer_t } from '@lytical/jxf/types';
+ * 
+ * const myTransformer: jxf_transformer_t = (data: any, ctx: jxf_ctx_t): string[] => {
+ *   // Transformer logic here
+ *   return [`Transformed data: ${JSON.stringify(data)}`];
+ * };
+ * 
+ * export default myTransformer;
+ * 
+ * @typedef {(data: any, ctx: jxf_ctx_t) => string[]} jxf_transformer_t
+ * @module \@lytical/jxf/types
+ * @param {any} data - The input data to be transformed.
+ * @param {jxf_ctx_t} ctx - The context object containing variables for transformation.
+ * @returns {string[]} An array of strings resulting from the transformation.
+ */
+export type jxf_transformer_t = (data: any, ctx: jxf_ctx_t) => string[];
+
+// the current version of (@types/jspath@0.4.2) is outdated and does not properly exports the default apply() function.
+declare module 'jspath' {
+  export default function apply<_t_ = any>(
+    path: string,
+    data: any,
+    replacement?: any,
+  ): _t_[];
+}