json-instructions 0.0.0-stage → 1.4.1

package/src/v3/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/v3/spec.json

@@ -0,0 +1,107 @@
+{
+    "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}",
+                    "id": "${columnName}",
+                    "list": "${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"
+                }
+            }
+        ]
+    },
+    "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}",
+        "attributes": {
+            "value": "${rowValue}"
+        }
+    },
+    "buildSelect": {
+        "tagName": "select",
+        "attributes": {
+            "id": "LedgerName"
+        },
+        "children": []
+    },
+    "buildDataList": {
+        "tagName": "datalist",
+        "attributes": {
+            "data-name": "${columnName}"
+        },
+        "children": []
+    },
+    "emptyCell": {
+        "tagName": "td",
+        "children": []
+    }
+}

package/src/v4/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/v4/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/v4/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/v4/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/v4/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/v4/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/v4/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/v4/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;

package/src/v4/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/v4/index.js

@@ -0,0 +1,28 @@
+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);
+
+    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/v4/spec.json

@@ -0,0 +1,107 @@
+{
+    "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}",
+                    "id": "${columnName}",
+                    "list": "${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"
+                }
+            }
+        ]
+    },
+    "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}",
+        "attributes": {
+            "value": "${rowValue}"
+        }
+    },
+    "buildSelect": {
+        "tagName": "select",
+        "attributes": {
+            "id": "LedgerName"
+        },
+        "children": []
+    },
+    "buildDataList": {
+        "tagName": "datalist",
+        "attributes": {
+            "data-name": "${columnName}"
+        },
+        "children": []
+    },
+    "emptyCell": {
+        "tagName": "td",
+        "children": []
+    }
+}

package/src/v4/writePath/index.js

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

package/src/writePath/index.js

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