json-renderers-build-table 1.22.3 → 1.26.2

package/src/v24/actions/insertOptions/index.js

@@ -0,0 +1,47 @@
+import applyTemplate from "json-transformer-funcs-primitive";
+import { findByRole } from "json-transformer-funcs";
+
+import spec from "../../builders/spec.json" with { type: "json" };
+import singleInstructions from "./instructions/single.json" with { type: "json" };
+import footerInstructions from "./instructions/footer.json" with { type: "json" };
+
+import runSingleInstructions from "../../singleInstruction/index.js";
+
+const functions = { applyTemplate };
+
+const insertOptions = (input = {}, config = {}, showLog = false, returnLog = []) => {
+    let localTableSpec = input;
+    let localOptions = config;
+
+    if (input && typeof input === "object" && "inTableSpec" in input) {
+        localTableSpec = input.inTableSpec;
+        localOptions = input.inOptions || config;
+    }
+
+    const localOptionsMerged = {
+        col: { width: "100px" },
+        header: { columnName: "options" },
+        body: { columnName: "show" },
+        footer: {},
+        ...localOptions
+    };
+
+    const registry = {
+        data: {
+            options: localOptionsMerged
+        },
+        base: localTableSpec,
+        spec
+    };
+
+    runSingleInstructions(singleInstructions, registry, functions, spec, showLog, returnLog);
+
+    const footerRow = findByRole(localTableSpec, "table-footer-row");
+    if (footerRow && Array.isArray(footerRow.children) && footerRow.children.length > 0) {
+        runSingleInstructions(footerInstructions, registry, functions, spec, showLog, returnLog);
+    }
+
+    return localTableSpec;
+};
+
+export default insertOptions;

package/src/v24/actions/insertOptions/instructions/footer.json

@@ -0,0 +1,22 @@
+[
+    {
+        "narration": "Append an empty cell into the table footer row if footer row is present.",
+        "destinationPath": {
+            "fileName": "base",
+            "dataRole": "table-footer-row",
+            "filePath": [
+                "children"
+            ],
+            "action": "push"
+        },
+        "sourcePath": {
+            "fileName": "data",
+            "filePath": [
+                "options",
+                "footer"
+            ]
+        },
+        "templateKey": "emptyCell",
+        "func": "applyTemplate"
+    }
+]

package/src/v24/actions/insertOptions/instructions/single.json

@@ -0,0 +1,62 @@
+[
+    {
+        "narration": "Append the options column width to the table colgroup.",
+        "destinationPath": {
+            "fileName": "base",
+            "dataRole": "table-colgroup",
+            "filePath": [
+                "children"
+            ],
+            "action": "push"
+        },
+        "sourcePath": {
+            "fileName": "data",
+            "filePath": [
+                "options",
+                "col"
+            ]
+        },
+        "templateKey": "buildColGroup",
+        "func": "applyTemplate"
+    },
+    {
+        "narration": "Append the options header cell to the table header row.",
+        "destinationPath": {
+            "fileName": "base",
+            "dataRole": "table-header-row",
+            "filePath": [
+                "children"
+            ],
+            "action": "push"
+        },
+        "sourcePath": {
+            "fileName": "data",
+            "filePath": [
+                "options",
+                "header"
+            ]
+        },
+        "templateKey": "buildHeader",
+        "func": "applyTemplate"
+    },
+    {
+        "narration": "Append the options button cell into each table body row.",
+        "destinationPath": {
+            "fileName": "base",
+            "dataRole": "table-body",
+            "filePath": [
+                "children"
+            ],
+            "action": "pushToRows"
+        },
+        "sourcePath": {
+            "fileName": "data",
+            "filePath": [
+                "options",
+                "body"
+            ]
+        },
+        "templateKey": "optionsButtonCell",
+        "func": "applyTemplate"
+    }
+]

package/src/v24/actions/insertSerial/index.js

@@ -0,0 +1,47 @@
+import applyTemplate from "json-transformer-funcs-primitive";
+import { findByRole } from "json-transformer-funcs";
+
+import spec from "../../builders/spec.json" with { type: "json" };
+import singleInstructions from "./instructions/single.json" with { type: "json" };
+import footerInstructions from "./instructions/footer.json" with { type: "json" };
+
+import runSingleInstructions from "../../singleInstruction/index.js";
+
+const functions = { applyTemplate };
+
+const insertSerial = (input = {}, config = {}, showLog = false, returnLog = []) => {
+    let localTableSpec = input;
+    let localSerial = config;
+
+    if (input && typeof input === "object" && "inTableSpec" in input) {
+        localTableSpec = input.inTableSpec;
+        localSerial = input.inSerial || config;
+    }
+
+    const localSerialMerged = {
+        col: { width: "50px" },
+        header: { columnName: "#" },
+        body: {},
+        footer: {},
+        ...localSerial
+    };
+
+    const registry = {
+        data: {
+            serial: localSerialMerged
+        },
+        base: localTableSpec,
+        spec
+    };
+
+    runSingleInstructions(singleInstructions, registry, functions, spec, showLog, returnLog);
+
+    const footerRow = findByRole(localTableSpec, "table-footer-row");
+    if (footerRow && Array.isArray(footerRow.children) && footerRow.children.length > 0) {
+        runSingleInstructions(footerInstructions, registry, functions, spec, showLog, returnLog);
+    }
+
+    return localTableSpec;
+};
+
+export default insertSerial;

package/src/v24/actions/insertSerial/instructions/footer.json

@@ -0,0 +1,22 @@
+[
+    {
+        "narration": "Prepend an empty cell into the table footer row if footer row is present.",
+        "destinationPath": {
+            "fileName": "base",
+            "dataRole": "table-footer-row",
+            "filePath": [
+                "children"
+            ],
+            "action": "unshift"
+        },
+        "sourcePath": {
+            "fileName": "data",
+            "filePath": [
+                "serial",
+                "footer"
+            ]
+        },
+        "templateKey": "emptyCell",
+        "func": "applyTemplate"
+    }
+]

package/src/v24/actions/insertSerial/instructions/single.json

@@ -0,0 +1,62 @@
+[
+    {
+        "narration": "Prepend the serial column width to the table colgroup.",
+        "destinationPath": {
+            "fileName": "base",
+            "dataRole": "table-colgroup",
+            "filePath": [
+                "children"
+            ],
+            "action": "unshift"
+        },
+        "sourcePath": {
+            "fileName": "data",
+            "filePath": [
+                "serial",
+                "col"
+            ]
+        },
+        "templateKey": "buildColGroup",
+        "func": "applyTemplate"
+    },
+    {
+        "narration": "Prepend the serial header cell to the table header row.",
+        "destinationPath": {
+            "fileName": "base",
+            "dataRole": "table-header-row",
+            "filePath": [
+                "children"
+            ],
+            "action": "unshift"
+        },
+        "sourcePath": {
+            "fileName": "data",
+            "filePath": [
+                "serial",
+                "header"
+            ]
+        },
+        "templateKey": "buildHeader",
+        "func": "applyTemplate"
+    },
+    {
+        "narration": "Prepend the serial number cell into each table body row.",
+        "destinationPath": {
+            "fileName": "base",
+            "dataRole": "table-body",
+            "filePath": [
+                "children"
+            ],
+            "action": "unshiftSerialToRows"
+        },
+        "sourcePath": {
+            "fileName": "data",
+            "filePath": [
+                "serial",
+                "body"
+            ]
+        },
+        "templateKey": "buildBodyCell",
+        "func": "applyTemplate"
+    }
+]

package/src/{v20 → v24/builders}/bodyOnly/index.js

@@ -4,14 +4,14 @@ import spec from "../spec.json" with { type: "json" };
 import base from "./base.json" with { type: "json" };
 import doubleInstructions from "./instructions/double.json" with { type: "json" };
 
-import runDoubleInstructions from "../doubleInstruction/index.js";
+import runDoubleInstructions from "../../doubleInstruction/index.js";
 
 const registry = { data: {}, base, spec };
 const functions = { twoDimensional };
 
-const startFunc = data => {
+const startFunc = (data, showLog = false, returnLog = []) => {
     registry.data = data;
-    runDoubleInstructions(doubleInstructions, registry, functions, spec);
+    runDoubleInstructions(doubleInstructions, registry, functions, spec, showLog, returnLog);
     return base.children;
 };
 

package/src/v24/builders/footerOnly/base.json

@@ -0,0 +1,3 @@
+{
+    "children": []
+}

package/src/v24/builders/footerOnly/index.js

@@ -0,0 +1,21 @@
+import fromCollection from "json-transformer-funcs-one-dimension";
+import twoDimensional from "json-transformer-funcs-two-dimensions";
+
+import spec from "../spec.json" with { type: "json" };
+import base from "./base.json" with { type: "json" };
+import singleInstructions from "./instructions/single.json" with { type: "json" };
+
+import runSingleInstructions from "../../singleInstruction/index.js";
+
+const registry = { data: {}, base, spec };
+const functions = { fromCollection, twoDimensional };
+
+const startFunc = (data, showLog = false, returnLog = []) => {
+    registry.data = data;
+
+    runSingleInstructions(singleInstructions, registry, functions, spec, showLog, returnLog);
+
+    return base?.children;
+};
+
+export default startFunc;

package/src/v24/builders/footerOnly/instructions/single.json

@@ -0,0 +1,19 @@
+[
+    {
+        "narration": "Build the footer row for the table using the configured columns.",
+        "destinationPath": {
+            "fileName": "base",
+            "filePath": [
+                "children"
+            ]
+        },
+        "sourcePath": {
+            "fileName": "data",
+            "filePath": [
+                "columns"
+            ]
+        },
+        "templateKey": "buildFooter",
+        "func": "fromCollection"
+    }
+]

package/src/{v20 → v24/builders}/headerOnly/index.js

@@ -4,14 +4,14 @@ import spec from "../spec.json" with { type: "json" };
 import base from "./base.json" with { type: "json" };
 import singleInstructions from "./instructions/single.json" with { type: "json" };
 
-import runSingleInstructions from "../singleInstruction/index.js";
+import runSingleInstructions from "../../singleInstruction/index.js";
 
 const registry = { data: {}, base, spec };
 const functions = { fromCollection };
 
-const startFunc = data => {
+const startFunc = (data, showLog = false, returnLog = []) => {
     registry.data = data;
-    runSingleInstructions(singleInstructions, registry, functions, spec);
+    runSingleInstructions(singleInstructions, registry, functions, spec, showLog, returnLog);
     return base;
 };
 

package/src/v24/builders/simple/index.js

@@ -0,0 +1,49 @@
+import fromCollection from "json-transformer-funcs-one-dimension";
+import twoDimensional from "json-transformer-funcs-two-dimensions";
+
+import spec from "../spec.json" with { type: "json" };
+import base from "./base.json" with { type: "json" };
+import singleInstructions from "./instructions/single.json" with { type: "json" };
+import doubleInstructions from "./instructions/double.json" with { type: "json" };
+
+import runSingleInstructions from "../../singleInstruction/index.js";
+import runDoubleInstructions from "../../doubleInstruction/index.js";
+import insertSerial from "../../actions/insertSerial/index.js";
+import insertOptions from "../../actions/insertOptions/index.js";
+
+const functions = { fromCollection, twoDimensional };
+
+const startFunc = (inConfig = {}, showLog = false, returnLog = []) => {
+    const localConfig = (inConfig && typeof inConfig === "object" && "inConfig" in inConfig)
+        ? inConfig.inConfig
+        : inConfig;
+
+    const localColumns = localConfig.inColumns || localConfig.columns || [];
+    const localData = localConfig.inData || localConfig.data || [];
+    const localOptions = localConfig.inOptions || localConfig.options || {};
+
+    const localBase = structuredClone(base);
+    const registry = {
+        data: {
+            columns: localColumns,
+            data: localData
+        },
+        base: localBase,
+        spec
+    };
+
+    runSingleInstructions(singleInstructions, registry, functions, spec, showLog, returnLog);
+    runDoubleInstructions(doubleInstructions, registry, functions, spec, showLog, returnLog);
+
+    if (localOptions.showSerial || localOptions.serial) {
+        insertSerial(localBase, localOptions.serial || {}, showLog, returnLog);
+    }
+
+    if (localOptions.showOptions || localOptions.options) {
+        insertOptions(localBase, localOptions.options || {}, showLog, returnLog);
+    }
+
+    return localBase;
+};
+
+export default startFunc;

package/src/{v18/headerOnly → v24/builders}/spec.json

@@ -28,6 +28,8 @@
                     "type": "text",
                     "placeholder": "enter ${columnName}",
                     "name": "${columnName}",
+                    "id": "${columnName}",
+                    "list": "${columnName}",
                     "class": "form-control"
                 }
             }
@@ -62,6 +64,21 @@
             }
         ]
     },
+    "optionsButtonCell": {
+        "tagName": "td",
+        "attributes": {
+            "class": "py-2 px-3 text-center"
+        },
+        "children": [
+            {
+                "tagName": "button",
+                "textContent": "${columnName}",
+                "attributes": {
+                    "class": "btn btn-primary btn-sm"
+                }
+            }
+        ]
+    },
     "buildOption": {
         "tagName": "option",
         "textContent": "${rowValue}",
@@ -82,5 +99,9 @@
             "data-name": "${columnName}"
         },
         "children": []
+    },
+    "emptyCell": {
+        "tagName": "td",
+        "children": []
     }
 }

package/src/v24/builders/withFooter/index.js

@@ -0,0 +1,49 @@
+import fromCollection from "json-transformer-funcs-one-dimension";
+import twoDimensional from "json-transformer-funcs-two-dimensions";
+
+import spec from "../spec.json" with { type: "json" };
+import base from "./base.json" with { type: "json" };
+import singleInstructions from "./instructions/single.json" with { type: "json" };
+import doubleInstructions from "./instructions/double.json" with { type: "json" };
+
+import runSingleInstructions from "../../singleInstruction/index.js";
+import runDoubleInstructions from "../../doubleInstruction/index.js";
+import insertSerial from "../../actions/insertSerial/index.js";
+import insertOptions from "../../actions/insertOptions/index.js";
+
+const functions = { fromCollection, twoDimensional };
+
+const startFunc = (inConfig = {}, showLog = false, returnLog = []) => {
+    const localConfig = (inConfig && typeof inConfig === "object" && "inConfig" in inConfig)
+        ? inConfig.inConfig
+        : inConfig;
+
+    const localColumns = localConfig.inColumns || localConfig.columns || [];
+    const localData = localConfig.inData || localConfig.data || [];
+    const localOptions = localConfig.inOptions || localConfig.options || {};
+
+    const localBase = structuredClone(base);
+    const registry = {
+        data: {
+            columns: localColumns,
+            data: localData
+        },
+        base: localBase,
+        spec
+    };
+
+    runSingleInstructions(singleInstructions, registry, functions, spec, showLog, returnLog);
+    runDoubleInstructions(doubleInstructions, registry, functions, spec, showLog, returnLog);
+
+    if (localOptions.showSerial || localOptions.serial) {
+        insertSerial(localBase, localOptions.serial || {}, showLog, returnLog);
+    }
+
+    if (localOptions.showOptions || localOptions.options) {
+        insertOptions(localBase, localOptions.options || {}, showLog, returnLog);
+    }
+
+    return localBase;
+};
+
+export default startFunc;

package/src/v24/builders/withFooter/instructions/single.json

@@ -0,0 +1,56 @@
+[
+    {
+        "narration": "Build the column widths for the table using the configured columns.",
+        "destinationPath": {
+            "fileName": "base",
+            "dataRole": "table-colgroup",
+            "filePath": [
+                "children"
+            ]
+        },
+        "sourcePath": {
+            "fileName": "data",
+            "filePath": [
+                "columns"
+            ]
+        },
+        "templateKey": "buildColGroup",
+        "func": "fromCollection"
+    },
+    {
+        "narration": "Build the header row for the table using the configured columns.",
+        "destinationPath": {
+            "fileName": "base",
+            "dataRole": "table-header-row",
+            "filePath": [
+                "children"
+            ]
+        },
+        "sourcePath": {
+            "fileName": "data",
+            "filePath": [
+                "columns"
+            ]
+        },
+        "templateKey": "buildHeader",
+        "func": "fromCollection"
+    },
+    {
+        "narration": "Build the footer row for the table using the configured columns.",
+        "destinationPath": {
+            "fileName": "base",
+            "dataRole": "table-footer-row",
+            "filePath": [
+                "children"
+            ]
+        },
+        "sourcePath": {
+            "fileName": "data",
+            "filePath": [
+                "columns"
+            ]
+        },
+        "templateKey": "buildFooter",
+        "func": "fromCollection"
+    }
+]

package/src/{v20 → v24}/doubleInstruction/index.js

@@ -1,6 +1,8 @@
 import writePath from "../writePath/index.js";
+import checkInstruction from "../guards/index.js";
 
-const runDoubleInstruction = (instruction, registry, functions, spec) => {
+const runDoubleInstruction = (instruction, registry, functions, spec, showLog, returnLog) => {
+    if (!checkInstruction(instruction, functions, spec, showLog, returnLog)) return;
     const result = functions[instruction.func](
         registry.data.columns,
         registry.data.data,
@@ -9,9 +11,9 @@ const runDoubleInstruction = (instruction, registry, functions, spec) => {
     writePath(registry, instruction.destinationPath, result);
 };
 
-const runDoubleInstructions = (instructions, registry, functions, spec) => {
+const runDoubleInstructions = (instructions, registry, functions, spec, showLog, returnLog) => {
     instructions.forEach(instruction => {
-        runDoubleInstruction(instruction, registry, functions, spec);
+        runDoubleInstruction(instruction, registry, functions, spec, showLog, returnLog);
     });
 };
 

package/src/v24/guards/index.js

@@ -0,0 +1,10 @@
+import checkStructure from "./structure/index.js";
+import checkReferences from "./references/index.js";
+
+const checkInstruction = (instruction, functions, spec, showLog, returnLog) => {
+    const structurePassed = checkStructure(instruction, showLog, returnLog);
+    if (!structurePassed) return false;
+    return checkReferences(instruction, functions, spec, showLog, returnLog);
+};
+export { checkStructure, checkReferences, checkInstruction };
+export default checkInstruction;

package/src/v24/guards/references/func/index.js

@@ -0,0 +1,8 @@
+const checkFunctionReference = (instruction, functions, showLog, returnLog) => {
+    const passed = typeof functions[instruction.func] === "function";
+    const message = `references/func (${instruction.func}): ${passed ? "passed" : "failed"}`;
+    returnLog.push(message);
+    if (showLog) console.log(message);
+    return passed;
+};
+export default checkFunctionReference;

package/src/v24/guards/references/index.js

@@ -0,0 +1,9 @@
+import checkFunctionReference from "./func/index.js";
+import checkSpecReference from "./templateKey/index.js";
+
+const checkReferences = (instruction, functions, spec, showLog, returnLog) => {
+    const functionPassed = checkFunctionReference(instruction, functions, showLog, returnLog);
+    const specPassed = checkSpecReference(instruction, spec, showLog, returnLog);
+    return functionPassed && specPassed;
+};
+export default checkReferences;

package/src/v24/guards/references/templateKey/index.js

@@ -0,0 +1,8 @@
+const checkSpecReference = (instruction, spec, showLog, returnLog) => {
+    const passed = instruction.templateKey === undefined || Object.hasOwn(spec, instruction.templateKey);
+    const message = `references/templateKey${instruction.templateKey === undefined ? " (not used)" : ` (${instruction.templateKey})`}: ${passed ? "passed" : "failed"}`;
+    returnLog.push(message);
+    if (showLog) console.log(message);
+    return passed;
+};
+export default checkSpecReference;

package/src/v24/guards/structure/destinationPath/index.js

@@ -0,0 +1,8 @@
+const checkDestinationPath = (instruction, showLog, returnLog) => {
+    const passed = Boolean(instruction.destinationPath?.fileName && Array.isArray(instruction.destinationPath?.filePath));
+    const message = `structure/destinationPath: ${passed ? "passed" : "failed"}`;
+    returnLog.push(message);
+    if (showLog) console.log(message);
+    return passed;
+};
+export default checkDestinationPath;

package/src/v24/guards/structure/func/index.js

@@ -0,0 +1,8 @@
+const checkFunc = (instruction, showLog, returnLog) => {
+    const passed = typeof instruction.func === "string" && instruction.func.length > 0;
+    const message = `structure/func: ${passed ? "passed" : "failed"}`;
+    returnLog.push(message);
+    if (showLog) console.log(message);
+    return passed;
+};
+export default checkFunc;

package/src/v24/guards/structure/index.js

@@ -0,0 +1,15 @@
+import checkSourcePath from "./sourcePath/index.js";
+import checkDestinationPath from "./destinationPath/index.js";
+import checkTemplateKey from "./templateKey/index.js";
+import checkFunc from "./func/index.js";
+
+const checkStructure = (instruction, showLog, returnLog) => {
+    const results = [
+        checkSourcePath(instruction, showLog, returnLog),
+        checkDestinationPath(instruction, showLog, returnLog),
+        checkTemplateKey(instruction, showLog, returnLog),
+        checkFunc(instruction, showLog, returnLog)
+    ];
+    return results.every(Boolean);
+};
+export default checkStructure;

package/src/v24/guards/structure/sourcePath/index.js

@@ -0,0 +1,8 @@
+const checkSourcePath = (instruction, showLog, returnLog) => {
+    const passed = Boolean(instruction.sourcePath?.fileName && Array.isArray(instruction.sourcePath?.filePath));
+    const message = `structure/sourcePath: ${passed ? "passed" : "failed"}`;
+    returnLog.push(message);
+    if (showLog) console.log(message);
+    return passed;
+};
+export default checkSourcePath;