json-renderers-build-table 1.9.1 → 1.17.3

package/src/v15/tableWithSerial/config/instructions.json

@@ -0,0 +1,116 @@
+[
+    {
+        "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 table header row from the column metadata.",
+        "destinationPath": {
+            "fileName": "base",
+            "dataRole": "table-header-row",
+            "filePath": [
+                "children"
+            ]
+        },
+        "sourcePath": {
+            "fileName": "data",
+            "filePath": [
+                "columns"
+            ]
+        },
+        "templateKey": "buildHeader",
+        "func": "fromCollection"
+    },
+    {
+        "narration": "Create one table row for each record and place it into the table body container.",
+        "destinationPath": {
+            "fileName": "base",
+            "dataRole": "table-body",
+            "filePath": [
+                "children"
+            ]
+        },
+        "sourcePath": {
+            "fileName": "data",
+            "filePath": [
+                "data"
+            ]
+        },
+        "templateKey": "buildBodyTr",
+        "func": "fromCollection"
+    },
+    {
+        "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/v15/tableWithSerial/index.js

@@ -0,0 +1,66 @@
+import { runInstructions, buildBody, findByRole } from "../common/runner.js";
+import spec from "../spec.json" with { type: "json" };
+import base from "./config/base.json" with { type: "json" };
+import instructions from "./config/instructions.json" with { type: "json" };
+
+const buildSpec = ({ inColumns = [], inData = [], inSerial = {} } = {}) => {
+    const localColumns = inColumns;
+    const localData = inData;
+    const localSerial = {
+        col: { width: "50px" },
+        header: { columnName: "#" },
+        body: {},
+        ...inSerial
+    };
+
+    const localBase = structuredClone(base);
+    const localSpec = structuredClone(spec);
+
+    const normalizedColumns = localColumns.map(col => {
+        const colCopy = structuredClone(col);
+        colCopy.template = {
+            bodyCell: "buildBodyCell",
+            ...(colCopy.template || {})
+        };
+        return colCopy;
+    });
+
+    const buildData = {
+        columns: normalizedColumns,
+        data: localData,
+        serial: localSerial
+    };
+
+    const registry = {
+        data: buildData,
+        base: localBase,
+        spec: localSpec
+    };
+
+    runInstructions({
+        inInstructions: instructions,
+        inRegistry: registry
+    });
+
+    const tbodyElement = findByRole(localBase, "table-body");
+    if (tbodyElement && Array.isArray(tbodyElement.children)) {
+        buildBody(tbodyElement.children, buildData, localSpec);
+    }
+
+    return localBase;
+};
+
+const startFunc = (input = {}) => {
+    const localInput = (input && typeof input === "object" && "inConfig" in input)
+        ? input.inConfig
+        : input;
+
+    return buildSpec({
+        inColumns: localInput.columns || [],
+        inData: localInput.data || [],
+        inSerial: localInput.serial || {}
+    });
+};
+
+export { buildSpec };
+export default startFunc;

package/src/v15/tableWithWidths/config/base.json

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

package/src/v15/tableWithWidths/config/instructions.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 table header row from the column metadata.",
+        "destinationPath": {
+            "fileName": "base",
+            "dataRole": "table-header-row",
+            "filePath": [
+                "children"
+            ]
+        },
+        "sourcePath": {
+            "fileName": "data",
+            "filePath": [
+                "columns"
+            ]
+        },
+        "templateKey": "buildHeader",
+        "func": "fromCollection"
+    },
+    {
+        "narration": "Create one table row for each record and place it into the table body container.",
+        "destinationPath": {
+            "fileName": "base",
+            "dataRole": "table-body",
+            "filePath": [
+                "children"
+            ]
+        },
+        "sourcePath": {
+            "fileName": "data",
+            "filePath": [
+                "data"
+            ]
+        },
+        "templateKey": "buildBodyTr",
+        "func": "fromCollection"
+    }
+]

package/src/v15/tableWithWidths/index.js

@@ -0,0 +1,58 @@
+import { runInstructions, buildBody, findByRole } from "../common/runner.js";
+import spec from "../spec.json" with { type: "json" };
+import base from "./config/base.json" with { type: "json" };
+import instructions from "./config/instructions.json" with { type: "json" };
+
+const buildSpec = ({ inColumns = [], inData = [] } = {}) => {
+    const localColumns = inColumns;
+    const localData = inData;
+
+    const localBase = structuredClone(base);
+    const localSpec = structuredClone(spec);
+
+    const normalizedColumns = localColumns.map(col => {
+        const colCopy = structuredClone(col);
+        colCopy.template = {
+            bodyCell: "buildBodyCell",
+            ...(colCopy.template || {})
+        };
+        return colCopy;
+    });
+
+    const buildData = {
+        columns: normalizedColumns,
+        data: localData
+    };
+
+    const registry = {
+        data: buildData,
+        base: localBase,
+        spec: localSpec
+    };
+
+    runInstructions({
+        inInstructions: instructions,
+        inRegistry: registry
+    });
+
+    const tbodyElement = findByRole(localBase, "table-body");
+    if (tbodyElement && Array.isArray(tbodyElement.children)) {
+        buildBody(tbodyElement.children, buildData, localSpec);
+    }
+
+    return localBase;
+};
+
+const startFunc = (input = {}) => {
+    const localInput = (input && typeof input === "object" && "inConfig" in input)
+        ? input.inConfig
+        : input;
+
+    return buildSpec({
+        inColumns: localInput.columns || [],
+        inData: localInput.data || []
+    });
+};
+
+export { buildSpec };
+export default startFunc;

package/src/v16/common/runner.js

@@ -0,0 +1,33 @@
+import {
+    fromCollection, tableBody, buildBody,
+    findByRole, resolvePath, applyTemplate
+} from "json-transformer-funcs";
+import writePath from "./writePath.js";
+
+const functions = {
+    fromCollection,
+    tableBody,
+    buildBody,
+    applyTemplate: (inSource, inTemplate) => applyTemplate(inTemplate, inSource)
+};
+
+export const runInstructions = ({ inInstructions, inRegistry }) => {
+    const localInstructions = inInstructions;
+    const localRegistry = inRegistry;
+
+    localInstructions.forEach(instruction => {
+        const source = resolvePath(localRegistry, instruction.sourcePath);
+
+        if (source) {
+            const result = functions[instruction.func](source, localRegistry.spec[instruction.templateKey]);
+            writePath({
+                inRegistry: localRegistry,
+                inPath: instruction.destinationPath,
+                inValue: result
+            });
+        }
+    });
+};
+
+export { findByRole, buildBody };
+export default runInstructions;

package/src/v16/common/writePath.js

@@ -0,0 +1,55 @@
+import { findByRole } from "json-transformer-funcs";
+
+const toArray = val => (Array.isArray(val) ? val : [val]);
+
+const actions = {
+    set: (parent, key, value) => {
+        parent[key] = value;
+    },
+    push: (parent, key, value) => {
+        parent[key].push(...toArray(value));
+    },
+    unshift: (parent, key, value) => {
+        parent[key].unshift(...toArray(value));
+    },
+    pushToRows: (parent, key, value) => {
+        parent[key].forEach(row => {
+            row.children.push(...structuredClone(toArray(value)));
+        });
+    },
+    unshiftToRows: (parent, key, value) => {
+        parent[key].forEach(row => {
+            row.children.unshift(...structuredClone(toArray(value)));
+        });
+    },
+    unshiftSerialToRows: (parent, key, value) => {
+        parent[key].forEach((row, rowIndex) => {
+            const item = structuredClone(value);
+            item.textContent = rowIndex + 1;
+            row.children.unshift(item);
+        });
+    }
+};
+
+const writePath = ({ inRegistry, inPath, inValue }) => {
+    const localRegistry = inRegistry;
+    const localPath = inPath;
+    const localValue = inValue;
+
+    const root = localPath.dataRole
+        ? findByRole(localRegistry[localPath.fileName], localPath.dataRole)
+        : localRegistry[localPath.fileName];
+
+    if (!root) return;
+
+    const keys = [...(localPath.filePath ?? [])];
+    const lastKey = keys.pop();
+    const parent = keys.reduce((current, key) => current?.[key], root);
+
+    if (!parent) return;
+
+    const actionHandler = actions[localPath.action] || actions.set;
+    actionHandler(parent, lastKey, localValue);
+};
+
+export default writePath;

package/src/v16/index.js

@@ -0,0 +1,7 @@
+// V16 exposes three focused table scenarios. Each scenario owns its config and instructions.
+// Only genuinely shared execution helpers live in ./common.
+import simpleTable from "./simpleTable/index.js";
+import tableWithSerial from "./tableWithSerial/index.js";
+import tableWithOptions from "./tableWithOptions/index.js";
+
+export { simpleTable, tableWithSerial, tableWithOptions };

package/src/v16/simpleTable/config/base.json

@@ -0,0 +1,31 @@
+{
+    "tagName": "table",
+    "attributes": {
+        "class": "table table-hover table-striped align-middle border mb-0"
+    },
+    "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": []
+        }
+    ]
+}

package/src/v16/simpleTable/config/instructions.json

@@ -0,0 +1,38 @@
+[
+    {
+        "narration": "Build the table header row from the column metadata.",
+        "destinationPath": {
+            "fileName": "base",
+            "dataRole": "table-header-row",
+            "filePath": [
+                "children"
+            ]
+        },
+        "sourcePath": {
+            "fileName": "data",
+            "filePath": [
+                "columns"
+            ]
+        },
+        "templateKey": "buildHeader",
+        "func": "fromCollection"
+    },
+    {
+        "narration": "Create one table row for each record and place it into the table body container.",
+        "destinationPath": {
+            "fileName": "base",
+            "dataRole": "table-body",
+            "filePath": [
+                "children"
+            ]
+        },
+        "sourcePath": {
+            "fileName": "data",
+            "filePath": [
+                "data"
+            ]
+        },
+        "templateKey": "buildBodyTr",
+        "func": "fromCollection"
+    }
+]

package/src/v16/simpleTable/index.js

@@ -0,0 +1,58 @@
+import { runInstructions, buildBody, findByRole } from "../common/runner.js";
+import spec from "../spec.json" with { type: "json" };
+import base from "./config/base.json" with { type: "json" };
+import instructions from "./config/instructions.json" with { type: "json" };
+
+const buildSpec = ({ inColumns = [], inData = [] } = {}) => {
+    const localColumns = inColumns;
+    const localData = inData;
+
+    const localBase = structuredClone(base);
+    const localSpec = structuredClone(spec);
+
+    const normalizedColumns = localColumns.map(col => {
+        const colCopy = structuredClone(col);
+        colCopy.template = {
+            bodyCell: "buildBodyCell",
+            ...(colCopy.template || {})
+        };
+        return colCopy;
+    });
+
+    const buildData = {
+        columns: normalizedColumns,
+        data: localData
+    };
+
+    const registry = {
+        data: buildData,
+        base: localBase,
+        spec: localSpec
+    };
+
+    runInstructions({
+        inInstructions: instructions,
+        inRegistry: registry
+    });
+
+    const tbodyElement = findByRole(localBase, "table-body");
+    if (tbodyElement && Array.isArray(tbodyElement.children)) {
+        buildBody(tbodyElement.children, buildData, localSpec);
+    }
+
+    return localBase;
+};
+
+const startFunc = (input = {}) => {
+    const localInput = (input && typeof input === "object" && "inConfig" in input)
+        ? input.inConfig
+        : input;
+
+    return buildSpec({
+        inColumns: localInput.columns || [],
+        inData: localInput.data || []
+    });
+};
+
+export { buildSpec };
+export default startFunc;

package/src/v16/spec.json

@@ -0,0 +1,65 @@
+{
+    "buildBodyTr": {
+        "tagName": "tr",
+        "attributes": {
+            "class": "align-middle"
+        },
+        "children": []
+    },
+    "buildColGroup": {
+        "tagName": "col",
+        "attributes": {
+            "width": "${width}"
+        }
+    },
+    "buildHeader": {
+        "tagName": "th",
+        "textContent": "${columnName}",
+        "attributes": {
+            "class": "py-3 px-3 fw-semibold text-uppercase small"
+        }
+    },
+    "buildFooter": {
+        "tagName": "td",
+        "children": [
+            {
+                "tagName": "input",
+                "attributes": {
+                    "type": "text",
+                    "placeholder": "enter ${columnName}",
+                    "name": "${columnName}",
+                    "class": "form-control"
+                }
+            }
+        ]
+    },
+    "buildBodyCell": {
+        "tagName": "td",
+        "textContent": "${rowValue}",
+        "attributes": {
+            "class": "py-3 px-3 text-secondary"
+        }
+    },
+    "button": {
+        "tagName": "button",
+        "textContent": "${columnName}",
+        "attributes": {
+            "class": "btn btn-primary btn-sm"
+        }
+    },
+    "buttonCell": {
+        "tagName": "td",
+        "attributes": {
+            "class": "py-2 px-3 text-center"
+        },
+        "children": [
+            {
+                "tagName": "button",
+                "textContent": "${agg:count}",
+                "attributes": {
+                    "class": "btn btn-primary btn-sm"
+                }
+            }
+        ]
+    }
+}

package/src/v16/tableWithOptions/config/base.json

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