json-to-spec 19.1.0

package/src/v12/replace.js

@@ -0,0 +1,169 @@
+import resolvePath from "./resolvePath.js";
+
+/**
+ * Resolves a token expression path against local context first, then root data.
+ */
+const resolveTokenValue = ({ inPath, inContext, inData }) => {
+    const localPath = inPath;
+    const localContext = inContext;
+    const localData = inData;
+
+    let value = resolvePath({ inData: localContext, inPath: localPath });
+
+    if (value === undefined && localContext && typeof localContext === "object") {
+        if (localContext.item && typeof localContext.item === "object") {
+            value = resolvePath({ inData: localContext.item, inPath: localPath });
+        }
+        if (value === undefined && localContext.row && typeof localContext.row === "object") {
+            value = resolvePath({ inData: localContext.row, inPath: localPath });
+        }
+    }
+
+    if (value === undefined && localData) {
+        value = resolvePath({ inData: localData, inPath: localPath });
+    }
+
+    return value;
+};
+
+/**
+ * Replaces ${path} tokens in a string value.
+ */
+const replaceValue = ({ inValue, inContext, inData }) => {
+    const localValue = inValue;
+    const localContext = inContext;
+    const localData = inData;
+
+    if (typeof localValue !== "string" || !localValue.includes("${")) {
+        return localValue;
+    }
+
+    const hasItemContext = Boolean(localContext && (localContext.item || Object.keys(localContext).length > 0));
+
+    // Exact match: "${path}" -> preserve primitive types (boolean, number, object)
+    const exactMatch = localValue.match(/^\$\{([^}]+)\}$/);
+    if (exactMatch) {
+        const token = resolveTokenValue({
+            inPath: exactMatch[1].trim(),
+            inContext: localContext,
+            inData: localData
+        });
+        return token !== undefined && token !== null ? token : (hasItemContext ? "" : localValue);
+    }
+
+    // Substring interpolation: "Hello ${name}" -> string replacement
+    return localValue.replace(/\$\{([^}]+)\}/g, (fullMatch, expr) => {
+        const token = resolveTokenValue({
+            inPath: expr.trim(),
+            inContext: localContext,
+            inData: localData
+        });
+        return token !== undefined && token !== null ? String(token) : (hasItemContext ? "" : fullMatch);
+    });
+};
+
+/**
+ * Recursively walks a JSON tree and replaces all ${...} tokens against data.
+ */
+export const replaceNode = ({ inNode, inContext = {}, inData = {} } = {}) => {
+    const localNode = inNode;
+    const localContext = inContext;
+    const localData = inData;
+
+    if (localNode === null || localNode === undefined) return localNode;
+
+    if (Array.isArray(localNode)) {
+        return localNode.map(child => replaceNode({
+            inNode: child,
+            inContext: localContext,
+            inData: localData
+        }));
+    }
+
+    if (typeof localNode === "string") {
+        return replaceValue({
+            inValue: localNode,
+            inContext: localContext,
+            inData: localData
+        });
+    }
+
+    if (typeof localNode !== "object") {
+        return localNode;
+    }
+
+    const clone = { ...localNode };
+
+    if (clone.textContent && typeof clone.textContent === "string") {
+        clone.textContent = replaceValue({
+            inValue: clone.textContent,
+            inContext: localContext,
+            inData: localData
+        });
+    }
+
+    if (clone.attributes) {
+        clone.attributes = { ...clone.attributes };
+        for (const [name, val] of Object.entries(clone.attributes)) {
+            if (typeof val === "string") {
+                clone.attributes[name] = replaceValue({
+                    inValue: val,
+                    inContext: localContext,
+                    inData: localData
+                });
+            }
+        }
+    }
+
+    if (clone.properties) {
+        clone.properties = { ...clone.properties };
+        for (const [name, val] of Object.entries(clone.properties)) {
+            if (typeof val === "string") {
+                clone.properties[name] = replaceValue({
+                    inValue: val,
+                    inContext: localContext,
+                    inData: localData
+                });
+            }
+        }
+    }
+
+    if (Array.isArray(clone.children)) {
+        clone.children = clone.children.map(child => replaceNode({
+            inNode: child,
+            inContext: localContext,
+            inData: localData
+        }));
+    }
+
+    return clone;
+};
+
+/**
+ * Main replace function: (structure, data) -> replaced JSON structure
+ */
+export const replace = (inStructureOrOptions, inData = {}) => {
+    let localStructure = inStructureOrOptions;
+    let localData = inData;
+    let localContext = {};
+
+    if (inStructureOrOptions && typeof inStructureOrOptions === "object" && !Array.isArray(inStructureOrOptions)) {
+        if ("inStructure" in inStructureOrOptions || "inTree" in inStructureOrOptions || "inNode" in inStructureOrOptions) {
+            localStructure = inStructureOrOptions.inStructure || inStructureOrOptions.inTree || inStructureOrOptions.inNode;
+            localData = inStructureOrOptions.inData || localData;
+            localContext = inStructureOrOptions.inContext || localContext;
+        } else if ("structure" in inStructureOrOptions) {
+            localStructure = inStructureOrOptions.structure;
+            localData = inStructureOrOptions.data || localData;
+            localContext = inStructureOrOptions.context || localContext;
+        }
+    }
+
+    return replaceNode({
+        inNode: localStructure,
+        inContext: localContext,
+        inData: localData
+    });
+};
+
+export default replace;

package/src/v12/resolvePath.js

@@ -0,0 +1,29 @@
+/**
+ * Resolves a dot-delimited path or array of keys from a data object.
+ *
+ * @param {Object} inArgs
+ * @param {Object} inArgs.inData - Target object to resolve from
+ * @param {string|Array} inArgs.inPath - Key or dot-path (e.g. "meta.formTitle", "columns")
+ * @returns {*} Resolved value or undefined
+ */
+export const resolvePath = ({ inData, inPath }) => {
+    const localData = inData;
+    const localPath = inPath;
+
+    if (localData === null || localData === undefined) return undefined;
+    if (localPath === undefined || localPath === null || localPath === "" || localPath === ".") {
+        return localData;
+    }
+
+    const segments = Array.isArray(localPath) ? localPath : String(localPath).split(".");
+    let current = localData;
+
+    for (const segment of segments) {
+        if (current === null || current === undefined) return undefined;
+        current = current[segment];
+    }
+
+    return current;
+};
+
+export default resolvePath;

package/src/v13/index.js

@@ -0,0 +1,110 @@
+/**
+ * json-to-spec v11
+ *
+ * Minimalist 2-Layer Specification Compiler:
+ * 1. replace: Pure ${...} token replacement across JSON structures.
+ * 2. iterate: Evaluates jsonToSpec operations, expanding collections into clean children.
+ */
+
+import { replace, replaceNode } from "./replace.js";
+
+// import { iterate, iterateNode, operation } from "./iterate.js";
+
+import {
+    iterate,
+    operation
+} from "./iterate/index.js";
+
+export const meta = {
+    version: "11.0.0",
+    name: "json-to-spec/v11",
+    description: "Minimalist 2-layer compiler: pure value replace + jsonToSpec iterate"
+};
+
+/**
+ * Executes a custom pipeline of transformations over the structure.
+ */
+export const pipeline = ({ inStructure, inData = {}, inSteps = [replace, iterate] } = {}) => {
+    const localData = inData;
+    const localSteps = inSteps;
+
+    let current = inStructure;
+    for (const step of localSteps) {
+        if (typeof step === "function") {
+            current = step({ inStructure: current, inData: localData });
+        };
+    }
+    return current;
+};
+
+export const pipe = (...inSteps) => {
+    const localSteps = inSteps.length > 0 ? inSteps : [replace, iterate];
+    return (inStructure, inData = {}) => {
+        return pipeline({ inStructure, inData, inSteps: localSteps });
+    };
+};
+
+/**
+ * Main compiler entry point:
+ * 1. Replace values: replace(structure, data)
+ * 2. Iterate/Operate: iterate(replacedStructure, data)
+ */
+export const compile = (inStructureOrOptions, inData = {}) => {
+    let localStructure = inStructureOrOptions;
+    let localData = inData;
+
+    if (inStructureOrOptions && typeof inStructureOrOptions === "object" && !Array.isArray(inStructureOrOptions)) {
+        if ("inStructure" in inStructureOrOptions || "inTree" in inStructureOrOptions || "inNode" in inStructureOrOptions) {
+            localStructure = inStructureOrOptions.inStructure || inStructureOrOptions.inTree || inStructureOrOptions.inNode;
+            localData = inStructureOrOptions.inData || localData;
+        } else if ("structure" in inStructureOrOptions) {
+            localStructure = inStructureOrOptions.structure;
+            localData = inStructureOrOptions.data || localData;
+        }
+    }
+
+    // Step 1: Replace tokens in the structure
+    const replaced = replace({
+        inStructure: localStructure,
+        inData: localData
+    });
+
+    // Step 2: Expand jsonToSpec operations on the replaced structure
+    const spec = iterate({
+        inStructure: replaced,
+        inData: localData
+    });
+
+    return spec;
+};
+
+export const jsonToSpec = {
+    replace,
+    iterate,
+    operation,
+    pipeline,
+    pipe,
+    compile
+};
+
+export {
+    replace,
+    replaceNode,
+    iterate,
+    operation
+};
+
+if (typeof globalThis !== "undefined") {
+    globalThis.ks ??= {};
+    globalThis.ks["json-to-spec"] = {
+        meta,
+        compile,
+        replace,
+        iterate,
+        operation,
+        pipeline,
+        jsonToSpec
+    };
+}
+
+export default compile;

package/src/v13/iterate/bindFormValues.js

@@ -0,0 +1,74 @@
+/**
+ * Recursively binds form field values into
+ * input, textarea, select and option nodes.
+ */
+const bindFormValues = ({ inNode, inItem, inData }) => {
+    const localNode = inNode;
+    const localItem = inItem;
+    const localData = inData;
+
+    if (!localNode || typeof localNode !== "object") {
+        return localNode;
+    }
+
+    if (localNode.attributes) {
+        const isFormField = [
+            "input",
+            "textarea",
+            "select",
+            "option"
+        ].includes(localNode.tagName?.toLowerCase());
+
+        if (isFormField) {
+            const fieldName =
+                localItem.field ||
+                localItem.columnName ||
+                localItem.name;
+
+            if (
+                localItem.value !== undefined &&
+                localItem.value !== null
+            ) {
+                localNode.attributes.value = String(localItem.value);
+
+                if (
+                    localNode.tagName === "textarea" &&
+                    !localNode.textContent
+                ) {
+                    localNode.textContent = String(localItem.value);
+                }
+            } else if (
+                fieldName &&
+                localData[fieldName] !== undefined &&
+                localData[fieldName] !== null
+            ) {
+                localNode.attributes.value = String(
+                    localData[fieldName]
+                );
+
+                if (
+                    localNode.tagName === "textarea" &&
+                    !localNode.textContent
+                ) {
+                    localNode.textContent = String(
+                        localData[fieldName]
+                    );
+                }
+            }
+        }
+    }
+
+    if (Array.isArray(localNode.children)) {
+        localNode.children.forEach(child => {
+            bindFormValues({
+                inNode: child,
+                inItem: localItem,
+                inData: localData
+            });
+        });
+    }
+
+    return localNode;
+};
+
+export default bindFormValues;

package/src/v13/iterate/expandIteration.js

@@ -0,0 +1,188 @@
+import resolveCollection from "./resolveCollection.js";
+import bindFormValues from "./bindFormValues.js";
+import { replaceNode } from "../replace.js";
+
+/**
+ * Expands a single iteration directive into an array of
+ * specification nodes.
+ */
+const expandIteration = ({
+    inNode,
+    inContext,
+    inData,
+    walk
+}) => {
+    const localNode = inNode;
+    const localContext = inContext;
+    const localData = inData;
+
+    const instruction = localNode && (
+        localNode.jsonToSpec ||
+        (localNode.operation ? localNode : null)
+    );
+
+    if (!instruction) return undefined;
+
+    const operationType = instruction.operation;
+
+    if (
+        operationType !== "iterate" &&
+        !instruction.source &&
+        !instruction.$iterate
+    ) {
+        return undefined;
+    }
+
+    const sourceKey =
+        instruction.source ||
+        instruction.iterateOn ||
+        instruction.$iterate;
+
+    const collection = resolveCollection({
+        inNode: localNode,
+        inContext: localContext,
+        inData: localData
+    }) || [];
+
+    if (!Array.isArray(collection)) {
+        if (localNode && localNode.tagName) {
+            const cloned = { ...localNode };
+            delete cloned.jsonToSpec;
+            cloned.children = [];
+            return cloned;
+        }
+
+        return [];
+    }
+
+    const template =
+        instruction.template ||
+        instruction.item ||
+        {};
+
+    const filter = instruction.filter;
+
+    const filtered = collection.filter(item => {
+        if (!item || typeof item !== "object") {
+            return true;
+        }
+
+        if (filter && typeof filter === "object") {
+            for (const [key, value] of Object.entries(filter)) {
+                if (item[key] !== value) {
+                    return false;
+                }
+            }
+        }
+
+        if (item.isVisible === false) {
+            return false;
+        }
+
+        return true;
+    });
+
+    const expandedChildren = [];
+
+    filtered.forEach((item, index) => {
+        const itemContext = {
+            ...localContext,
+            item,
+            ...(typeof item === "object" && item !== null ? item : {}),
+            $index: index,
+            $number: index + 1
+        };
+
+        if (
+            sourceKey === "rows" ||
+            sourceKey.endsWith(".rows") ||
+            sourceKey === "items" ||
+            sourceKey.endsWith("Rows")
+        ) {
+            itemContext.row = item;
+        }
+
+        if (
+            localContext.row &&
+            (item.field || item.columnName || item.name)
+        ) {
+            const fieldKey =
+                item.field ||
+                item.columnName ||
+                item.name;
+
+            const cellValue = localContext.row[fieldKey];
+
+            if (cellValue !== undefined) {
+                itemContext.cellValue = cellValue;
+                itemContext.value = cellValue;
+
+                if (
+                    typeof item === "object" &&
+                    item !== null &&
+                    item.value === undefined
+                ) {
+                    item.value = cellValue;
+                }
+            }
+        }
+
+        const rawTemplate =
+            typeof template === "object" &&
+                template !== null
+                ? JSON.parse(JSON.stringify(template))
+                : {
+                    tagName: "span",
+                    textContent: template
+                };
+
+        const iteratedTemplate = walk({
+            inNode: rawTemplate,
+            inContext: itemContext,
+            inData: localData,
+            inOperation: ({ inNode, inContext, inData }) => {
+                return expandIteration({
+                    inNode,
+                    inContext,
+                    inData,
+                    walk
+                });
+            }
+        });
+
+        const replacedTemplate = replaceNode({
+            inNode: iteratedTemplate,
+            inContext: itemContext,
+            inData: localData
+        });
+
+        bindFormValues({
+            inNode: replacedTemplate,
+            inItem: item,
+            inData: localData
+        });
+
+        if (Array.isArray(replacedTemplate)) {
+            expandedChildren.push(...replacedTemplate);
+        } else if (
+            replacedTemplate !== null &&
+            replacedTemplate !== undefined
+        ) {
+            expandedChildren.push(replacedTemplate);
+        }
+    });
+
+    if (localNode && localNode.tagName) {
+        const cloned = { ...localNode };
+
+        delete cloned.jsonToSpec;
+
+        cloned.children = expandedChildren;
+
+        return cloned;
+    }
+
+    return expandedChildren;
+};
+
+export default expandIteration;

package/src/v13/iterate/index.js

@@ -0,0 +1,9 @@
+import iterate from "./iterate.js";
+
+export {
+    iterate
+};
+
+export const operation = iterate;
+
+export default iterate;

package/src/v13/iterate/iterate.js

@@ -0,0 +1,32 @@
+import walk from "./walk.js";
+import expandIteration from "./expandIteration.js";
+
+/**
+ * Iterates a structure by walking the tree
+ * and applying the iteration operation to each node.
+ */
+const iterate = ({
+    inStructure,
+    inData = {},
+    inContext = {}
+} = {}) => {
+    return walk({
+        inNode: inStructure,
+        inData,
+        inContext,
+        inOperation: ({ inNode, inContext, inData }) => {
+            return expandIteration({
+                inNode,
+                inContext,
+                inData,
+                walk
+            });
+        }
+    });
+};
+
+export {
+    iterate
+};
+
+export default iterate;

package/src/v13/iterate/iterateNode.js

@@ -0,0 +1,86 @@
+import expandIteration from "./expandIteration.js";
+
+/**
+ * Recursively walks a JSON structure and resolves
+ * jsonToSpec iteration directives.
+ */
+const iterateNode = ({
+    inNode,
+    inContext = {},
+    inData = {}
+} = {}) => {
+    const localNode = inNode;
+    const localContext = inContext;
+    const localData = inData;
+
+    if (localNode === null || localNode === undefined) {
+        return localNode;
+    }
+
+    if (Array.isArray(localNode)) {
+        const flattened = [];
+
+        for (const child of localNode) {
+            const processed = iterateNode({
+                inNode: child,
+                inContext: localContext,
+                inData: localData
+            });
+
+            if (Array.isArray(processed)) {
+                flattened.push(...processed);
+            } else if (
+                processed !== null &&
+                processed !== undefined
+            ) {
+                flattened.push(processed);
+            }
+        }
+
+        return flattened;
+    }
+
+    if (typeof localNode !== "object") {
+        return localNode;
+    }
+
+    const iterationResult = expandIteration({
+        inNode: localNode,
+        inContext: localContext,
+        inData: localData,
+        iterateNode
+    });
+
+    if (iterationResult !== undefined) {
+        return iterationResult;
+    }
+
+    const clone = { ...localNode };
+
+    if (Array.isArray(clone.children)) {
+        const processedChildren = [];
+
+        for (const child of clone.children) {
+            const processed = iterateNode({
+                inNode: child,
+                inContext: localContext,
+                inData: localData
+            });
+
+            if (Array.isArray(processed)) {
+                processedChildren.push(...processed);
+            } else if (
+                processed !== null &&
+                processed !== undefined
+            ) {
+                processedChildren.push(processed);
+            }
+        }
+
+        clone.children = processedChildren;
+    }
+
+    return clone;
+};
+
+export default iterateNode;