npm - jtlt - Versions diffs - 0.2.0 → 0.4.0 - Mend

jtlt 0.2.0 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (70) hide show

package/CHANGES.md +27 -0
package/README.md +61 -164
package/demo/calltemplate-params-demo.js +138 -0
package/demo/codemirror.esm.js +28242 -0
package/demo/codemirror.js +94 -0
package/demo/index.css +7 -0
package/demo/index.html +28 -0
package/demo/index.js +210 -0
package/demo/vendor/jamilih/dist/jml.mjs +2341 -0
package/demo/vendor/jhtml/src/SAJJ/SAJJ.ObjectArrayDelegator.js +356 -0
package/demo/vendor/jhtml/src/SAJJ/SAJJ.Stringifier.js +186 -0
package/demo/vendor/jhtml/src/SAJJ/SAJJ.js +746 -0
package/demo/vendor/jhtml/src/SAJJ/testing/SAJJ.html +33 -0
package/demo/vendor/jhtml/src/SAJJ/testing/SAJJ.testing.js +25 -0
package/demo/vendor/jhtml/src/jhtml-browser.js +5 -0
package/demo/vendor/jhtml/src/jhtml-node.cts +3 -0
package/demo/vendor/jhtml/src/jhtml-node.js +8 -0
package/demo/vendor/jhtml/src/jhtml-node.mts +1 -0
package/demo/vendor/jhtml/src/jhtml.cts +3 -0
package/demo/vendor/jhtml/src/jhtml.js +602 -0
package/demo/vendor/jhtml/src/jhtml.mts +1 -0
package/demo/vendor/jsonpath-plus/dist/index-browser-esm.js +2158 -0
package/demo/vendor/simple-get-json/dist/index-es.js +151 -0
package/demo/xpath2-placeholder.js +1 -0
package/dist/AbstractJoiningTransformer.d.ts +83 -9
package/dist/AbstractJoiningTransformer.d.ts.map +1 -1
package/dist/DOMJoiningTransformer.d.ts +85 -25
package/dist/DOMJoiningTransformer.d.ts.map +1 -1
package/dist/JSONJoiningTransformer.d.ts +159 -51
package/dist/JSONJoiningTransformer.d.ts.map +1 -1
package/dist/JSONPathTransformer.d.ts +37 -38
package/dist/JSONPathTransformer.d.ts.map +1 -1
package/dist/JSONPathTransformerContext.d.ts +334 -124
package/dist/JSONPathTransformerContext.d.ts.map +1 -1
package/dist/StringJoiningTransformer.d.ts +132 -41
package/dist/StringJoiningTransformer.d.ts.map +1 -1
package/dist/XPathTransformer.d.ts +35 -20
package/dist/XPathTransformer.d.ts.map +1 -1
package/dist/XPathTransformerContext.d.ts +281 -105
package/dist/XPathTransformerContext.d.ts.map +1 -1
package/dist/index-browser.d.ts +4 -0
package/dist/index-browser.d.ts.map +1 -0
package/dist/index-node.d.ts +4 -0
package/dist/index-node.d.ts.map +1 -0
package/dist/index.d.ts +330 -57
package/dist/index.d.ts.map +1 -1
package/dist/types.d.ts +204 -0
package/dist/types.d.ts.map +1 -0
package/docs/API.expanded.md +172 -5
package/docs/API.md +92 -2
package/docs/TO-DO.md +168 -0
package/docs/calltemplate-params.md +251 -0
package/eslint.config.js +11 -5
package/package.json +35 -9
package/pnpm-workspace.yaml +1 -0
package/rollup.config.js +13 -0
package/src/AbstractJoiningTransformer.js +54 -15
package/src/DOMJoiningTransformer.js +275 -28
package/src/JSONJoiningTransformer.js +351 -70
package/src/JSONPathTransformer.js +48 -30
package/src/JSONPathTransformerContext.js +729 -107
package/src/StringJoiningTransformer.js +311 -57
package/src/XPathTransformer.js +27 -12
package/src/XPathTransformerContext.js +928 -99
package/src/index-browser.js +5 -0
package/src/index-node.js +7 -0
package/src/index.js +502 -98
package/tsconfig.json +5 -2
package/typings/xpath2-js.d.ts +40 -1
package/src/types/xpath2-js.d.ts +0 -2

package/demo/codemirror.js ADDED Viewed

@@ -0,0 +1,94 @@
+import {javascript} from '@codemirror/lang-javascript';
+import {EditorView, basicSetup} from 'codemirror';
+import {xml} from '@codemirror/lang-xml';
+import {json} from '@codemirror/lang-json';
+/**
+ * @typedef {HTMLTextAreaElement & {
+ *   $setValue: (insert: string) => void,
+ *   $getValue: () => string
+ * }} EnhancedTextArea
+ */
+/** @type {Map<HTMLTextAreaElement, EditorView>} */
+const textareaToViewMap = new Map();
+/**
+ * @param {HTMLTextAreaElement} textarea
+ * @param {any} extensions
+ * @param {(content: string) => void} inputHandler
+ * @returns {EditorView}
+ */
+export function editorFromTextArea (textarea, extensions, inputHandler) {
+  /** @type {EditorView} */
+  let view = /** @type {EditorView} */ (textareaToViewMap.get(textarea));
+  /**
+   * @param {string} [val]
+   */
+  const createView = (val) => {
+    view = new EditorView({
+      doc: val ?? textarea.value,
+      extensions: [
+        basicSetup,
+        EditorView.updateListener.of((viewUpdate) => {
+          // Check if the document content has changed
+          if (viewUpdate.docChanged) {
+            const newContent = viewUpdate.state.doc.toString();
+            inputHandler(newContent);
+            // You can perform actions here based on the new content
+          }
+        }),
+        ...(extensions.javascript ? [javascript(extensions.javascript)] : []),
+        ...(extensions.xml ? [xml(extensions.xml)] : []),
+        ...(extensions.json ? [json()] : [])
+      ]
+    });
+    textareaToViewMap.set(textarea, view);
+    textarea.parentNode?.insertBefore(view.dom, textarea);
+    textarea.style.display = 'none';
+  };
+  if (textarea.previousElementSibling?.matches('.cm-editor')) {
+    const prevLang = /** @type {HTMLElement} */ (
+      textarea.previousElementSibling.querySelector('.cm-content')
+    ).dataset.language;
+    if (prevLang && prevLang in extensions) {
+      // console.log('same language');
+      return view;
+    }
+    const val = /** @type {EnhancedTextArea} */ (textarea).$getValue();
+    textarea.previousElementSibling.remove();
+    view.destroy();
+    createView(val);
+    // console.log('different language');
+  } else {
+    createView();
+    // console.log('new setup');
+  }
+  /** @type {EnhancedTextArea} */
+  (textarea).$setValue = (insert) => {
+    view.dispatch({
+      changes: {
+        from: 0,
+        to: view.state.doc.length,
+        insert
+      }
+    });
+  };
+  /** @type {EnhancedTextArea} */
+  (textarea).$getValue = () => {
+    return view.state.doc.toString();
+  };
+  if (textarea.form) {
+    textarea.form.addEventListener('submit', () => {
+      textarea.value = view.state.doc.toString();
+    });
+  }
+  return view;
+}

package/demo/index.css ADDED Viewed

@@ -0,0 +1,7 @@
+.cm-editor {
+  margin-top: 20px;
+  margin-bottom: 20px;
+}
+select {
+  min-width: 300px;
+}

package/demo/index.html ADDED Viewed

@@ -0,0 +1,28 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <title>JTLT Demo</title>
+    <link rel="icon" href="data:image/png;base64,iVBORw0KGgo=" />
+    <link rel="stylesheet" href="index.css" />
+    <script type="importmap">
+      {
+        "imports": {
+          "simple-get-json": "./vendor/simple-get-json/dist/index-es.js",
+          "jhtml": "./vendor/jhtml/src/jhtml-browser.js",
+          "jamilih": "./vendor/jamilih/dist/jml.mjs",
+          "jsonpath-plus" :"./vendor/jsonpath-plus/dist/index-browser-esm.js",
+          "xpath2.js": "./xpath2-placeholder.js",
+          "fontoxpath": "../../node_modules/fontoxpath/dist/fontoxpath.esm.js",
+          "xspattern": "../../node_modules/xspattern/dist/xspattern.esm.js",
+          "prsc": "../../node_modules/prsc/dist/prsc.esm.js",
+          "whynot": "../../node_modules/whynot/dist/whynot.esm.js",
+          "./codemirror.js": "./codemirror.esm.js"
+        }
+      }
+    </script>
+    <script type="module" src="index.js"></script>
+  </head>
+  <body>
+  </body>
+</html>

package/demo/index.js ADDED Viewed

@@ -0,0 +1,210 @@
+import {nbsp, jml, body} from 'jamilih';
+import {jtlt} from '../src/index-browser.js';
+import {editorFromTextArea} from './codemirror.js';
+/**
+ * @returns {Promise<void>}
+ */
+async function templateProcessor () {
+  await processTemplates();
+}
+/**
+ * @param {string} sel
+ * @returns {HTMLInputElement}
+ */
+const $i = (sel) => {
+  return /** @type {HTMLInputElement} */ (document.querySelector(sel));
+};
+/**
+ * @param {string} sel
+ * @returns {import('./codemirror.js').EnhancedTextArea}
+ */
+const $t = (sel) => {
+  return /** @type {import('./codemirror.js').EnhancedTextArea} */ (
+    document.querySelector(sel)
+  );
+};
+/**
+ * @returns {Promise<void>}
+ */
+async function processTemplates () {
+  $t('#output').value = '';
+  const source = $t('#source').$getValue();
+  let data;
+  let isJson = false;
+  data = new DOMParser().parseFromString(source, 'text/xml');
+  if (data.documentElement.localName === 'parsererror' &&
+    data.documentElement.namespaceURI ===
+      // eslint-disable-next-line sonarjs/no-clear-text-protocols -- Namespace
+      'http://www.mozilla.org/newlayout/xml/parsererror.xml'
+  ) {
+    try {
+      data = JSON.parse(source);
+      editorFromTextArea($t('#source'), {
+        json: {}
+      }, templateProcessor);
+    } catch (err) {
+      $t('#output').value = 'Error parsing source as either XML or JSON\n\n' +
+        new XMLSerializer().serializeToString(data) + '\n\n' +
+      /** @type {Error} */ (err).message;
+      return;
+    }
+    isJson = true;
+  } else {
+    editorFromTextArea($t('#source'), {
+      xml: {}
+    }, templateProcessor);
+  }
+  let templates;
+  try {
+    // eslint-disable-next-line no-eval -- Todo: input to jsep?
+    templates = eval($t('#jtltTemplates').$getValue());
+    if (!templates || !templates.length) {
+      throw new Error('Bad templates');
+    }
+  } catch {
+    $t('#output').value =
+      'Error parsing jtlt templates; must be an array of templates.';
+    return;
+  }
+  let result;
+  if ($i('#forQuery').checked) {
+    try {
+      result = isJson
+        ? await jtlt({
+          data,
+          engineType: 'jsonpath',
+          outputType: 'string',
+          forQuery: templates
+        })
+        : await jtlt({
+          data,
+          engineType: 'xpath',
+          xpathVersion: 3.1,
+          outputType: 'string',
+          forQuery: templates
+        });
+    } catch (err) {
+      $t('#output').value = 'Error executing jtlt()\n\n' +
+      /** @type {Error} */ (err).message;
+      return;
+    }
+  } else {
+    try {
+      result = isJson
+        ? await jtlt({
+          data,
+          engineType: 'jsonpath',
+          outputType: 'string',
+          templates
+        })
+        : await jtlt({
+          data,
+          engineType: 'xpath',
+          xpathVersion: 3.1,
+          outputType: 'string',
+          templates
+        });
+    } catch (err) {
+      $t('#output').value = 'Error executing jtlt()\n\n' +
+      /** @type {Error} */ (err).message;
+      return;
+    }
+  }
+  $t('#output').value = result;
+}
+jml('section', [
+  ['select', {$on: {
+    click () {
+      if (/** @type {HTMLSelectElement} */ (this).value === 'xml') {
+        $t('#source').$setValue(`<root></root>`);
+        $t('#jtltTemplates').$setValue($i('#forQuery').checked
+          ? `['//*', function () {
+  this.string('test123');
+}]`
+          : `[
+  ['//*', function () {
+    this.string('test123');
+  }]
+]`);
+      } else if (/** @type {HTMLSelectElement} */ (this).value === 'json') {
+        $t('#source').$setValue(`{
+  "a": 5,
+  "b": {
+    "c": 7
+  }
+}`);
+        $t('#jtltTemplates').$setValue($i('#forQuery').checked
+          ? `['$.b', function (o) {
+  this.string(o.c);
+}]`
+          : `[
+  {
+    path: '$',
+    template () {
+      this.applyTemplates('$.b');
+    }
+  },
+  ['$.b', function (o) {
+    this.string(o.c);
+  }]
+]`);
+      }
+    }
+  }}, [
+    ['option', [
+      '(Populate...)'
+    ]],
+    ['option', {value: 'xml'}, [
+      'XML/XPath example 1'
+    ]],
+    ['option', {value: 'json'}, [
+      'JSON/JSONPath example 1'
+    ]]
+  ]],
+  nbsp.repeat(2),
+  ['label', [
+    ['input', {
+      id: 'forQuery', type: 'checkbox',
+      checked: Boolean(localStorage.getItem('forQuery')),
+      $on: {
+        async click (e) {
+          if (/** @type {HTMLInputElement} */ (e.target).checked) {
+            localStorage.setItem('forQuery', 'true');
+          } else {
+            localStorage.removeItem('forQuery');
+          }
+          await processTemplates();
+        }
+      }
+    }],
+    'Use `forQuery` instead of templates'
+  ]],
+  ['br'], ['br'],
+  ['textarea', {
+    id: 'source',
+    placeholder: 'Put XML or JSON source here...'
+  }],
+  ['textarea', {
+    id: 'jtltTemplates',
+    placeholder: 'Put jtlt templates array here...'
+  }],
+  ['textarea', {id: 'output', placeholder: 'Loading...'}]
+], body);
+editorFromTextArea($t('#jtltTemplates'), {
+  javascript: {typescript: true}
+}, templateProcessor);
+editorFromTextArea($t('#source'), {
+  xml: {}
+}, templateProcessor);