json-renderers-build-table 1.22.3 → 1.26.2

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

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

package/src/v24/index.js

@@ -0,0 +1,71 @@
+import simple from "./builders/simple/index.js";
+import headerOnly from "./builders/headerOnly/index.js";
+import bodyOnly from "./builders/bodyOnly/index.js";
+import withFooter from "./builders/withFooter/index.js";
+import footerOnly from "./builders/footerOnly/index.js";
+
+import insertSerial from "./actions/insertSerial/index.js";
+import insertOptions from "./actions/insertOptions/index.js";
+import actions from "./actions/index.js";
+
+const withSerial = (inConfig = {}, showLog = false, returnLog = []) => {
+    const localConfig = (inConfig && typeof inConfig === "object" && "inConfig" in inConfig)
+        ? inConfig.inConfig
+        : inConfig;
+
+    return simple({
+        ...localConfig,
+        options: {
+            showSerial: true,
+            serial: localConfig.serial || localConfig.inSerial,
+            ...(localConfig.options || localConfig.inOptions)
+        }
+    }, showLog, returnLog);
+};
+
+const withOptions = (inConfig = {}, showLog = false, returnLog = []) => {
+    const localConfig = (inConfig && typeof inConfig === "object" && "inConfig" in inConfig)
+        ? inConfig.inConfig
+        : inConfig;
+
+    return simple({
+        ...localConfig,
+        options: {
+            showOptions: true,
+            options: localConfig.options || localConfig.inOptions
+        }
+    }, showLog, returnLog);
+};
+
+const tableWithSerial = withSerial;
+const tableWithOptions = withOptions;
+
+export {
+    simple,
+    headerOnly,
+    bodyOnly,
+    withFooter,
+    footerOnly,
+    insertSerial,
+    insertOptions,
+    actions,
+    withSerial,
+    withOptions,
+    tableWithSerial,
+    tableWithOptions
+};
+
+export default {
+    simple,
+    headerOnly,
+    bodyOnly,
+    withFooter,
+    footerOnly,
+    insertSerial,
+    insertOptions,
+    actions,
+    withSerial,
+    withOptions,
+    tableWithSerial,
+    tableWithOptions
+};

package/src/v24/singleInstruction/index.js

@@ -0,0 +1,32 @@
+import { resolvePath } from "json-transformer-funcs";
+import writePath from "../writePath/index.js";
+import checkInstruction from "../guards/index.js";
+
+const runSingleInstruction = (instruction, registry, functions, spec, showLog, returnLog) => {
+    if (!checkInstruction(instruction, functions, spec, showLog, returnLog)) return;
+
+    const localSpec = spec;
+    const templateKey = instruction.templateKey;
+    const localSpecKey = localSpec[templateKey];
+
+    console.log("templateKey ; ", templateKey);
+    console.log("localSpecKey ; ", localSpecKey);
+
+    const source = resolvePath(registry, instruction.sourcePath);
+    const result = functions[instruction.func](source, localSpecKey);
+
+    if (templateKey === "buildFooter") {
+        console.log("result ; ", result);
+    };
+
+    writePath(registry, instruction.destinationPath, result);
+};
+
+const runSingleInstructions = (instructions, registry, functions, spec, showLog, returnLog) => {
+    instructions.forEach(instruction => {
+        runSingleInstruction(instruction, registry, functions, spec, showLog, returnLog);
+    });
+};
+
+export { runSingleInstruction, runSingleInstructions };
+export default runSingleInstructions;

package/src/v25/actions/index.js

@@ -0,0 +1,20 @@
+import insertSerial from "./insertSerial/index.js";
+import insertOptions from "./insertOptions/index.js";
+
+const startFunc = ({ inOptions = {}, inBase, showLog = false, returnLog = [] }) => {
+    const localOptions = inOptions;
+
+    const localBase = inBase;
+
+    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/v25/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/v25/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/v25/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/v25/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/v25/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/v25/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/v25/builders/bodyOnly/index.js

@@ -0,0 +1,18 @@
+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 doubleInstructions from "./instructions/double.json" with { type: "json" };
+
+import runDoubleInstructions from "../../doubleInstruction/index.js";
+
+const registry = { data: {}, base, spec };
+const functions = { twoDimensional };
+
+const startFunc = (data, showLog = false, returnLog = []) => {
+    registry.data = data;
+    runDoubleInstructions(doubleInstructions, registry, functions, spec, showLog, returnLog);
+    return base.children;
+};
+
+export default startFunc;

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

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

package/src/v25/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/v25/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/v25/builders/headerOnly/index.js

@@ -0,0 +1,18 @@
+import fromCollection from "json-transformer-funcs-one-dimension";
+
+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 };
+
+const startFunc = (data, showLog = false, returnLog = []) => {
+    registry.data = data;
+    runSingleInstructions(singleInstructions, registry, functions, spec, showLog, returnLog);
+    return base;
+};
+
+export default startFunc;

package/src/v25/builders/simple/base.json

@@ -0,0 +1,53 @@
+{
+    "tagName": "table",
+    "attributes": {
+        "class": "table table-hover table-striped align-middle border mb-0"
+    },
+    "children": [
+        {
+            "tagName": "colgroup",
+            "attributes": {
+                "data-role": "table-colgroup"
+            },
+            "children": []
+        },
+        {
+            "tagName": "thead",
+            "attributes": {
+                "class": "table-dark",
+                "data-role": "table-header"
+            },
+            "children": [
+                {
+                    "tagName": "tr",
+                    "attributes": {
+                        "data-role": "table-header-row"
+                    },
+                    "children": []
+                }
+            ]
+        },
+        {
+            "tagName": "tbody",
+            "attributes": {
+                "data-role": "table-body"
+            },
+            "children": []
+        },
+        {
+            "tagName": "tfoot",
+            "attributes": {
+                "data-role": "table-footer"
+            },
+            "children": [
+                {
+                    "tagName": "tr",
+                    "attributes": {
+                        "data-role": "table-footer-row"
+                    },
+                    "children": []
+                }
+            ]
+        }
+    ]
+}

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

@@ -0,0 +1,40 @@
+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 actions from "../../actions/index.js";
+
+const functions = { fromCollection, twoDimensional };
+
+const startFunc = (inConfig = {}, showLog = false, returnLog = []) => {
+    const localConfig = inConfig;
+
+    const localColumns = localConfig.columns || [];
+    const localData = localConfig.data || [];
+    const localOptions = 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);
+
+    actions({ inOptions: localOptions, inBase: localBase });
+
+    return localBase;
+};
+
+export default startFunc;

package/src/{v18/bodyOnly → v25/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/v25/builders/withFooter/base.json

@@ -0,0 +1,53 @@
+{
+    "tagName": "table",
+    "attributes": {
+        "class": "table table-hover table-striped align-middle border mb-0"
+    },
+    "children": [
+        {
+            "tagName": "colgroup",
+            "attributes": {
+                "data-role": "table-colgroup"
+            },
+            "children": []
+        },
+        {
+            "tagName": "thead",
+            "attributes": {
+                "class": "table-dark",
+                "data-role": "table-header"
+            },
+            "children": [
+                {
+                    "tagName": "tr",
+                    "attributes": {
+                        "data-role": "table-header-row"
+                    },
+                    "children": []
+                }
+            ]
+        },
+        {
+            "tagName": "tbody",
+            "attributes": {
+                "data-role": "table-body"
+            },
+            "children": []
+        },
+        {
+            "tagName": "tfoot",
+            "attributes": {
+                "data-role": "table-footer"
+            },
+            "children": [
+                {
+                    "tagName": "tr",
+                    "attributes": {
+                        "data-role": "table-footer-row"
+                    },
+                    "children": []
+                }
+            ]
+        }
+    ]
+}