json-renderers-build-table 1.17.3 → 1.22.2

package/src/v15/buildSpec/index.js

@@ -1,147 +0,0 @@
-import {
-    fromCollection, tableBody, buildBody,
-    findByRole, resolvePath, applyTemplate
-} from "json-transformer-funcs";
-
-import spec from "../spec.json" with { type: "json" };
-import base from "./config/base.json" with { type: "json" };
-
-import columnInstructions from "./config/columnInstructions.json" with { type: "json" };
-import rowInstructions from "./config/rowInstructions.json" with { type: "json" };
-import serialInstructions from "./config/serialInstructions.json" with { type: "json" };
-import optionsInstructions from "./config/optionsInstructions.json" with { type: "json" };
-
-import writePath from "./writePath/index.js";
-
-const functions = {
-    fromCollection,
-    tableBody,
-    buildBody,
-    applyTemplate: (inSource, inTemplate) => applyTemplate(inTemplate, inSource)
-};
-
-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
-            });
-        }
-    });
-};
-
-const buildSpec = ({ inConfig }) => {
-    const localConfig = inConfig;
-
-    const localBase = structuredClone(base);
-    const localSpec = structuredClone(spec);
-
-    // Determine whether to render the footer
-    const hasFooterDisabled = localConfig?.options?.showFooter === false
-        || localConfig?.options?.footer === false
-        || localConfig?.showFooter === false
-        || localConfig?.footer === false;
-    const showFooter = !hasFooterDisabled;
-
-    if (!showFooter) {
-        localBase.children = localBase.children.filter(child => child.tagName !== "tfoot");
-    }
-
-    // Default template.bodyCell to buildBodyCell if omitted
-    const normalizedColumns = (localConfig?.columns || []).map(col => {
-        const colCopy = structuredClone(col);
-        colCopy.template = {
-            bodyCell: "buildBodyCell",
-            ...(colCopy.template || {})
-        };
-        return colCopy;
-    });
-
-    // Support explicit serial object or options.showSerial boolean
-    const hasSerial = Boolean(localConfig?.serial || localConfig?.options?.showSerial);
-    const serialConfig = localConfig?.serial || (hasSerial ? {
-        col: { width: "50px" },
-        header: { columnName: "#" },
-        body: {},
-        footer: {}
-    } : null);
-
-    const buildData = {
-        ...localConfig,
-        columns: normalizedColumns,
-        ...(serialConfig ? { serial: serialConfig } : {})
-    };
-
-    const registry = {
-        data: buildData,
-        base: localBase,
-        spec: localSpec
-    };
-
-    // 1. Build row containers in tbody
-    runInstructions({
-        inInstructions: rowInstructions,
-        inRegistry: registry
-    });
-
-    // 2. Build column group, header, and optional footer
-    const activeColumnInstructions = showFooter
-        ? columnInstructions
-        : columnInstructions.filter(inst => inst.templateKey !== "buildFooter");
-
-    runInstructions({
-        inInstructions: activeColumnInstructions,
-        inRegistry: registry
-    });
-
-    // 3. Build body cells for each row
-    const tbodyElement = findByRole(localBase, "table-body");
-    if (tbodyElement && Array.isArray(tbodyElement.children)) {
-        buildBody(tbodyElement.children, buildData, localSpec);
-    }
-
-    // 4. Optional serial column
-    if (serialConfig) {
-        const activeSerialInstructions = showFooter
-            ? serialInstructions
-            : serialInstructions.filter(inst => inst.destinationPath?.dataRole !== "table-footer-row");
-
-        runInstructions({
-            inInstructions: activeSerialInstructions,
-            inRegistry: registry
-        });
-    }
-
-    // 5. Optional action/options column
-    if (localConfig?.options && typeof localConfig.options === "object" && localConfig.options.header) {
-        const activeOptionsInstructions = showFooter
-            ? optionsInstructions
-            : optionsInstructions.filter(inst => inst.destinationPath?.dataRole !== "table-footer-row");
-
-        runInstructions({
-            inInstructions: activeOptionsInstructions,
-            inRegistry: registry
-        });
-    }
-
-    return localBase;
-};
-
-// Wrapper supporting both { inConfig } and direct object argument
-const startFunc = (input) => {
-    const localInput = (input && typeof input === "object" && "inConfig" in input)
-        ? input.inConfig
-        : input;
-
-    return buildSpec({ inConfig: localInput });
-};
-
-export default startFunc;

package/src/v15/common/runner.js

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

@@ -1,85 +0,0 @@
-import buildSpec from "./buildSpec/index.js";
-import registerGlobal from "./register/index.js";
-import spec from "./spec.json" with { type: "json" };
-
-import simpleTable from "./simpleTable/index.js";
-import tableWithWidths from "./tableWithWidths/index.js";
-import tableWithFooter from "./tableWithFooter/index.js";
-import tableWithSerial from "./tableWithSerial/index.js";
-import tableWithOptions from "./tableWithOptions/index.js";
-import tableWithButtonCell from "./tableWithButtonCell/index.js";
-import tableFullGrid from "./tableFullGrid/index.js";
-import tableHeadless from "./tableHeadless/index.js";
-
-const render = (input = {}) => {
-    const localInput = (input && typeof input === "object" && "inConfig" in input)
-        ? input.inConfig
-        : input;
-
-    const localColumns = localInput.columns || [];
-    const localData = localInput.data || [];
-    const localOptions = localInput.options || {};
-    const localSerial = localInput.serial;
-    const localTargetHtmlId = localInput.targetHtmlId;
-
-    const tableSpec = buildSpec({
-        inConfig: {
-            columns: localColumns,
-            data: localData,
-            options: localOptions,
-            serial: localSerial
-        }
-    });
-
-    if (localTargetHtmlId && typeof document !== "undefined") {
-        const container = document.getElementById(localTargetHtmlId);
-        if (container) {
-            const toTag = globalThis?.ks?.jsonToTag?.buildSpecElement;
-            if (typeof toTag === "function") {
-                const element = toTag(tableSpec);
-                container.innerHTML = "";
-                container.append(element);
-            }
-        }
-    }
-
-    return tableSpec;
-};
-
-const scenarios = {
-    simpleTable,
-    tableWithWidths,
-    tableWithFooter,
-    tableWithSerial,
-    tableWithOptions,
-    tableWithButtonCell,
-    tableFullGrid,
-    tableHeadless
-};
-
-registerGlobal({
-    inDefinition: {
-        render,
-        renderToDom: render,
-        buildSpec,
-        spec,
-        ...scenarios
-    }
-});
-
-export {
-    render,
-    render as renderToDom,
-    buildSpec,
-    spec,
-    simpleTable,
-    tableWithWidths,
-    tableWithFooter,
-    tableWithSerial,
-    tableWithOptions,
-    tableWithButtonCell,
-    tableFullGrid,
-    tableHeadless
-};
-
-export default render;

package/src/v15/register/index.js

@@ -1,30 +0,0 @@
-import meta from "./meta.js";
-
-export const registerGlobal = ({ inDefinition } = {}) => {
-    const localDefinition = inDefinition;
-
-    if (typeof globalThis === "undefined" || !localDefinition) return;
-
-    globalThis.ks ??= {};
-
-    const renderFunc = typeof localDefinition === "function"
-        ? localDefinition
-        : localDefinition.render;
-
-    const buildSpecFunc = typeof localDefinition === "object"
-        ? localDefinition.buildSpec
-        : undefined;
-
-    const tablePackage = {
-        meta,
-        renderToDom: renderFunc,
-        render: renderFunc,
-        ...(buildSpecFunc ? { buildSpec: buildSpecFunc } : {}),
-        ...(typeof localDefinition === "object" ? localDefinition : {})
-    };
-
-    globalThis.ks.jsonRenderersBuildTable = tablePackage;
-    globalThis.ks.jsonRenderersBuild ??= tablePackage;
-};
-
-export default registerGlobal;

package/src/v15/register/meta.js

@@ -1,6 +0,0 @@
-export const meta = {
-    version: "1.15.0",
-    name: "json-renderers-build-table"
-};
-
-export default meta;

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

@@ -1,31 +0,0 @@
-{
-    "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/v15/simpleTable/index.js

@@ -1,58 +0,0 @@
-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/v15/tableFullGrid/config/instructions.json

@@ -1,234 +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 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": "Build the table footer row from the column metadata.",
-        "destinationPath": {
-            "fileName": "base",
-            "dataRole": "table-footer-row",
-            "filePath": [
-                "children"
-            ]
-        },
-        "sourcePath": {
-            "fileName": "data",
-            "filePath": [
-                "columns"
-            ]
-        },
-        "templateKey": "buildFooter",
-        "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"
-    },
-    {
-        "narration": "Prepend an empty cell into the table footer row.",
-        "destinationPath": {
-            "fileName": "base",
-            "dataRole": "table-footer-row",
-            "filePath": [
-                "children"
-            ],
-            "action": "unshift"
-        },
-        "sourcePath": {
-            "fileName": "data",
-            "filePath": [
-                "serial",
-                "footer"
-            ]
-        },
-        "templateKey": "buildBodyCell",
-        "func": "applyTemplate"
-    },
-    {
-        "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": "buttonCell",
-        "func": "applyTemplate"
-    },
-    {
-        "narration": "Append the save button cell into the table footer row.",
-        "destinationPath": {
-            "fileName": "base",
-            "dataRole": "table-footer-row",
-            "filePath": [
-                "children"
-            ],
-            "action": "push"
-        },
-        "sourcePath": {
-            "fileName": "data",
-            "filePath": [
-                "options",
-                "footer"
-            ]
-        },
-        "templateKey": "buttonCell",
-        "func": "applyTemplate"
-    }
-]