json-renderers-build-table 1.32.2 → 1.36.2

package/src/v31/builders/simple/instructions/single.json

@@ -1,38 +0,0 @@
-[
-    {
-        "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"
-    }
-]

package/src/v31/builders/simpleSearch/base.json

@@ -1,53 +0,0 @@
-{
-    "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/v31/builders/simpleSearch/index.js

@@ -1,40 +0,0 @@
-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/v31/builders/simpleSearch/instructions/double.json

@@ -1,19 +0,0 @@
-[
-    {
-        "narration": "Build the table body rows for the table using the configured columns and data.",
-        "destinationPath": {
-            "fileName": "base",
-            "dataRole": "table-body",
-            "filePath": [
-                "children"
-            ]
-        },
-        "sourcePath": {
-            "fileName": "data",
-            "filePath": [
-                "columns"
-            ]
-        },
-        "func": "twoDimensional"
-    }
-]

package/src/v31/builders/simpleSearch/instructions/single.json

@@ -1,38 +0,0 @@
-[
-    {
-        "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"
-    }
-]

package/src/v31/builders/withFooter/base.json

@@ -1,53 +0,0 @@
-{
-    "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/v31/builders/withFooter/index.js

@@ -1,40 +0,0 @@
-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.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);
-
-    actions({ inOptions: localOptions, inBase: localBase });
-
-    return localBase;
-};
-
-export default startFunc;

package/src/v31/builders/withFooter/instructions/double.json

@@ -1,19 +0,0 @@
-[
-    {
-        "narration": "Build the table body rows for the table using the configured columns and data.",
-        "destinationPath": {
-            "fileName": "base",
-            "dataRole": "table-body",
-            "filePath": [
-                "children"
-            ]
-        },
-        "sourcePath": {
-            "fileName": "data",
-            "filePath": [
-                "columns"
-            ]
-        },
-        "func": "twoDimensional"
-    }
-]

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

@@ -1,56 +0,0 @@
-[
-    {
-        "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/v31/doubleInstruction/index.js

@@ -1,21 +0,0 @@
-import writePath from "../writePath/index.js";
-import checkInstruction from "../guards/index.js";
-
-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,
-        spec
-    );
-    writePath(registry, instruction.destinationPath, result);
-};
-
-const runDoubleInstructions = (instructions, registry, functions, spec, showLog, returnLog) => {
-    instructions.forEach(instruction => {
-        runDoubleInstruction(instruction, registry, functions, spec, showLog, returnLog);
-    });
-};
-
-export { runDoubleInstruction, runDoubleInstructions };
-export default runDoubleInstructions;

package/src/v31/guards/index.js

@@ -1,10 +0,0 @@
-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/v31/guards/references/func/index.js

@@ -1,8 +0,0 @@
-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/v31/guards/references/index.js

@@ -1,9 +0,0 @@
-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/v31/guards/references/templateKey/index.js

@@ -1,8 +0,0 @@
-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/v31/guards/structure/destinationPath/index.js

@@ -1,8 +0,0 @@
-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/v31/guards/structure/func/index.js

@@ -1,8 +0,0 @@
-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/v31/guards/structure/index.js

@@ -1,15 +0,0 @@
-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/v31/guards/structure/sourcePath/index.js

@@ -1,8 +0,0 @@
-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;

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

@@ -1,9 +0,0 @@
-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/v31/index.js

@@ -1,21 +0,0 @@
-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";
-
-export {
-    simple,
-    headerOnly,
-    bodyOnly,
-    withFooter,
-    footerOnly
-};
-
-export default {
-    simple,
-    headerOnly,
-    bodyOnly,
-    withFooter,
-    footerOnly
-};

package/src/v31/singleInstruction/index.js

@@ -1,32 +0,0 @@
-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 localShowLog = showLog;
-    const localSpec = spec;
-    const templateKey = instruction.templateKey;
-    const localSpecKey = localSpec[templateKey];
-
-    if (localShowLog) console.log("singleInstruction ; ", templateKey, 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/v31/writePath/index.js

@@ -1,62 +0,0 @@
-import { findByRole } from "json-transformer-funcs";
-
-const toArray = value => Array.isArray(value) ? value : [value];
-
-const set = (parent, key, value) => {
-    parent[key] = value;
-};
-
-const push = (parent, key, value) => {
-    parent[key].push(...toArray(value));
-};
-
-const unshift = (parent, key, value) => {
-    parent[key].unshift(...toArray(value));
-};
-
-const pushToRows = (parent, key, value) => {
-    parent[key].forEach(row => {
-        row.children.push(...structuredClone(toArray(value)));
-    });
-};
-
-const unshiftToRows = (parent, key, value) => {
-    parent[key].forEach(row => {
-        row.children.unshift(...structuredClone(toArray(value)));
-    });
-};
-
-const unshiftSerialToRows = (parent, key, value) => {
-    parent[key].forEach((row, rowIndex) => {
-        const item = structuredClone(value);
-        item.textContent = rowIndex + 1;
-        row.children.unshift(item);
-    });
-};
-
-const actions = {
-    set,
-    push,
-    unshift,
-    pushToRows,
-    unshiftToRows,
-    unshiftSerialToRows
-};
-
-const resolveParent = (registry, path) => {
-    const root = path.dataRole
-        ? findByRole(registry[path.fileName], path.dataRole)
-        : registry[path.fileName];
-    const keys = [...(path.filePath ?? [])];
-    const key = keys.pop();
-    const parent = keys.reduce((current, nextKey) => current[nextKey], root);
-    return { parent, key };
-};
-
-const writePath = (registry, path, value) => {
-    const { parent, key } = resolveParent(registry, path);
-    const action = actions[path.action] || set;
-    action(parent, key, value);
-};
-
-export default writePath;