json-to-spec 19.1.0

package/src/v8/instructionEngine/story/storyInjector.js

@@ -0,0 +1,50 @@
+import { interpolateString } from "../value/interpolate.js";
+
+export const injectStory = (cloned, originalNode, currentItem, inRootData) => {
+    if (typeof originalNode.story !== "string" || originalNode.story.trim() === "") return cloned;
+
+    const storyText = interpolateString({
+        inText: originalNode.story,
+        inItemContext: currentItem,
+        inRootData
+    });
+
+    const storyTitle = typeof originalNode.storyTitle === "string" && originalNode.storyTitle.trim() !== ""
+        ? interpolateString({
+            inText: originalNode.storyTitle,
+            inItemContext: currentItem,
+            inRootData
+        })
+        : null;
+
+    const storyTag = (typeof originalNode.storyTag === "string" && originalNode.storyTag.trim() !== "") ? originalNode.storyTag : "p";
+    const storyClass = (typeof originalNode.storyClass === "string" && originalNode.storyClass.trim() !== "") ? originalNode.storyClass : "story text-muted small";
+    const storyPosition = originalNode.storyPosition === "append" ? "append" : "prepend";
+
+    const nextChildren = Array.isArray(cloned.children) ? cloned.children : [];
+    const storyNodes = [];
+
+    if (storyTitle) {
+        storyNodes.push({
+            tagName: "strong",
+            attributes: { class: "story-title d-block" },
+            textContent: storyTitle
+        });
+    }
+
+    storyNodes.push({
+        tagName: storyTag,
+        attributes: { class: storyClass },
+        textContent: storyText
+    });
+
+    if (storyPosition === "prepend") {
+        cloned.children = [...storyNodes, ...nextChildren];
+    } else {
+        cloned.children = [...nextChildren, ...storyNodes];
+    }
+
+    return cloned;
+};
+
+export default injectStory;

package/src/v8/instructionEngine/storyInjector.js

@@ -0,0 +1 @@
+export { injectStory, default } from "./story/storyInjector.js";

package/src/v8/instructionEngine/value/interpolate.js

@@ -0,0 +1,38 @@
+import { resolveTokenValue } from "../resolve/resolveTokenValue.js";
+
+export const interpolateValue = ({ inValue, inItemContext, inRootData }) => {
+    if (typeof inValue !== "string" || !inValue.includes("${")) {
+        return inValue;
+    }
+
+    const exactMatch = inValue.match(/^\$\{([^}]+)\}$/);
+    if (exactMatch) {
+        const token = resolveTokenValue({
+            inPath: exactMatch[1].trim(),
+            inItemContext,
+            inRootData
+        });
+        return token !== undefined && token !== null ? token : "";
+    }
+
+    return inValue.replace(/\$\{([^}]+)\}/g, (_, expr) => {
+        const token = resolveTokenValue({
+            inPath: expr.trim(),
+            inItemContext,
+            inRootData
+        });
+        return token !== undefined && token !== null ? String(token) : "";
+    });
+};
+
+export const interpolateString = ({ inText, inItemContext, inRootData }) => {
+    const value = interpolateValue({
+        inValue: inText,
+        inItemContext,
+        inRootData
+    });
+
+    return value !== undefined && value !== null ? String(value) : "";
+};
+
+export default { interpolateValue, interpolateString };

package/src/v9/index.js

@@ -0,0 +1,96 @@
+/**
+ * json-to-spec v9
+ *
+ * Modular 3-Stage Specification Compiler:
+ * 1. operation: detects and expands iterations and structural directives
+ * 2. replace: resolves dynamic token interpolation in strings, text, attributes & properties
+ * 3. other: applies form control value bindings, story injection, and cleans up metadata
+ *
+ * All three applications can be invoked independently, chained in custom pipelines,
+ * or executed via compile().
+ */
+
+import operation from "./instructionEngine/operation/operation.js";
+import replace from "./instructionEngine/replace/replace.js";
+import other from "./instructionEngine/other/other.js";
+import { pipeline, pipe, defaultPipeline } from "./instructionEngine/pipeline/pipeline.js";
+
+export const meta = {
+    version: "9.0.0",
+    name: "json-to-spec/v9",
+    description: "Pure JSON Specification Compiler with decoupled operation, replace, and other pipeline stages"
+};
+
+/**
+ * Compiles a JSON UI structure tree containing `jsonToSpec` operations with a data payload.
+ *
+ * Outside API:
+ * - compile(structureJson, dataJson)
+ * - compile({ inStructure, inData, inSteps })
+ * - compile({ structure, data, steps })
+ *
+ * @param {Object|Array} inStructureOrOptions - The UI structure JSON tree or options object
+ * @param {Object} [inData] - Data payload containing collections and values
+ * @returns {Object|Array} - Compiled 100% pure JSON specification ready for json-to-dom
+ */
+export const compile = (inStructureOrOptions, inData = {}) => {
+    let localStructure = inStructureOrOptions;
+    let localData = inData || {};
+    let localSteps = defaultPipeline;
+
+    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;
+            localSteps = inStructureOrOptions.inSteps || localSteps;
+        } else if ("structure" in inStructureOrOptions) {
+            localStructure = inStructureOrOptions.structure;
+            localData = inStructureOrOptions.data || localData;
+            localSteps = inStructureOrOptions.steps || localSteps;
+        } else if ("context" in inStructureOrOptions) {
+            localStructure = inStructureOrOptions.context;
+            localData = inStructureOrOptions.data || localData;
+            localSteps = inStructureOrOptions.steps || localSteps;
+        }
+    }
+
+    return pipeline({
+        inStructure: localStructure,
+        inData: localData,
+        inSteps: localSteps
+    });
+};
+
+export const jsonToSpec = {
+    operation,
+    replace,
+    other,
+    pipeline,
+    pipe,
+    compile
+};
+
+export {
+    operation,
+    replace,
+    other,
+    pipeline,
+    pipe,
+    defaultPipeline
+};
+
+if (typeof globalThis !== "undefined") {
+    globalThis.ks ??= {};
+    globalThis.ks["json-to-spec"] = {
+        meta,
+        compile,
+        pipeline,
+        pipe,
+        operation,
+        replace,
+        other,
+        jsonToSpec
+    };
+}
+
+export default compile;

package/src/v9/instructionEngine/compile/compileTree.js

@@ -0,0 +1,191 @@
+import { interpolateValue, interpolateString } from "../value/interpolate.js";
+import { injectStory } from "../story/storyInjector.js";
+import { expandIterationNode } from "../iteration/expandIteration.js";
+
+const compileArrayNode = ({ inNode, inContext, inRootData }) => {
+    const flattened = [];
+
+    for (const child of inNode) {
+        const childContext = child && child.__loopItemContext
+            ? { ...inContext, ...child.__loopItemContext }
+            : inContext;
+
+        const compiledChild = compileNode({
+            inNode: child,
+            inContext: childContext,
+            inRootData
+        });
+
+        if (Array.isArray(compiledChild)) {
+            flattened.push(...compiledChild);
+        } else if (compiledChild !== null && compiledChild !== undefined) {
+            flattened.push(compiledChild);
+        }
+    }
+
+    return flattened;
+};
+
+const compilePrimitiveNode = ({ inNode, inContext, inRootData }) => {
+    return interpolateString({
+        inText: inNode,
+        inItemContext: inContext,
+        inRootData
+    });
+};
+
+const applyValueBindings = ({ inNode, inItemContext, inRootData }) => {
+    const clone = { ...inNode };
+
+    if (clone.textContent) {
+        clone.textContent = interpolateString({
+            inText: clone.textContent,
+            inItemContext,
+            inRootData
+        });
+    }
+
+    if (clone.attributes) {
+        clone.attributes = { ...clone.attributes };
+        for (const [name, value] of Object.entries(clone.attributes)) {
+            if (typeof value === "string") {
+                clone.attributes[name] = interpolateValue({
+                    inValue: value,
+                    inItemContext,
+                    inRootData
+                });
+            }
+        }
+    }
+
+    if (clone.properties) {
+        clone.properties = { ...clone.properties };
+        for (const [name, value] of Object.entries(clone.properties)) {
+            if (typeof value === "string") {
+                clone.properties[name] = interpolateValue({
+                    inValue: value,
+                    inItemContext,
+                    inRootData
+                });
+            }
+        }
+    }
+
+    return clone;
+};
+
+const compileStandardNode = ({ inNode, inContext, inRootData }) => {
+    const currentItem = {
+        ...(typeof inContext.item === "object" ? inContext.item : {}),
+        ...inContext
+    };
+
+    const withBindings = applyValueBindings({
+        inNode: { ...inNode },
+        inItemContext: currentItem,
+        inRootData
+    });
+
+    if ("jsonToSpec" in withBindings) {
+        delete withBindings.jsonToSpec;
+    }
+
+    if (withBindings.attributes) {
+        const isFormField = ["input", "textarea", "select", "option"].includes(withBindings.tagName?.toLowerCase());
+        if (isFormField) {
+            const fieldName = currentItem.field || currentItem.columnName || currentItem.name;
+            if (currentItem.value !== undefined && currentItem.value !== null) {
+                withBindings.attributes.value = String(currentItem.value);
+                if (withBindings.tagName === "textarea" && !withBindings.textContent) {
+                    withBindings.textContent = String(currentItem.value);
+                }
+            } else if (fieldName && inRootData[fieldName] !== undefined && inRootData[fieldName] !== null) {
+                withBindings.attributes.value = String(inRootData[fieldName]);
+                if (withBindings.tagName === "textarea" && !withBindings.textContent) {
+                    withBindings.textContent = String(inRootData[fieldName]);
+                }
+            } else if (fieldName && inRootData.values && inRootData.values[fieldName] !== undefined && inRootData.values[fieldName] !== null) {
+                withBindings.attributes.value = String(inRootData.values[fieldName]);
+                if (withBindings.tagName === "textarea" && !withBindings.textContent) {
+                    withBindings.textContent = String(inRootData.values[fieldName]);
+                }
+            }
+        }
+    }
+
+    const storyNode = injectStory(withBindings, inNode, currentItem, inRootData);
+
+    if (Array.isArray(storyNode.children)) {
+        const compiledChildren = [];
+        for (const child of storyNode.children) {
+            const childContext = child && child.__loopItemContext
+                ? { ...inContext, ...child.__loopItemContext }
+                : inContext;
+
+            const compiledChild = compileNode({
+                inNode: child,
+                inContext: childContext,
+                inRootData
+            });
+
+            if (Array.isArray(compiledChild)) {
+                compiledChildren.push(...compiledChild);
+            } else if (compiledChild !== null && compiledChild !== undefined) {
+                compiledChildren.push(compiledChild);
+            }
+        }
+        storyNode.children = compiledChildren;
+    }
+
+    delete storyNode.__loopItemContext;
+    return storyNode;
+};
+
+export const compileNode = ({ inNode, inContext = {}, inRootData = {} } = {}) => {
+    if (inNode === null || inNode === undefined) return null;
+
+    if (Array.isArray(inNode)) {
+        return compileArrayNode({
+            inNode,
+            inContext,
+            inRootData
+        });
+    }
+
+    if (typeof inNode !== "object") {
+        return compilePrimitiveNode({
+            inNode,
+            inContext,
+            inRootData
+        });
+    }
+
+    const iterationResult = expandIterationNode({
+        inNode,
+        inContext,
+        inRootData
+    });
+
+    if (iterationResult !== undefined) {
+        if (Array.isArray(iterationResult)) {
+            return compileArrayNode({
+                inNode: iterationResult,
+                inContext,
+                inRootData
+            });
+        }
+        return compileStandardNode({
+            inNode: iterationResult,
+            inContext,
+            inRootData
+        });
+    }
+
+    return compileStandardNode({
+        inNode,
+        inContext,
+        inRootData
+    });
+};
+
+export default compileNode;

package/src/v9/instructionEngine/compileTree.js

@@ -0,0 +1 @@
+export { compileNode, default } from "./compile/compileTree.js";

package/src/v9/instructionEngine/expandIteration.js

@@ -0,0 +1 @@
+export { expandIterationNode, default } from "./iteration/expandIteration.js";

package/src/v9/instructionEngine/index.js

@@ -0,0 +1,29 @@
+import compileNode from "./compile/compileTree.js";
+import resolvePath from "./resolve/resolvePath.js";
+import { expandIterationNode } from "./iteration/expandIteration.js";
+import { interpolateValue, interpolateString } from "./value/interpolate.js";
+import { injectStory } from "./story/storyInjector.js";
+import { operation, operationNode } from "./operation/operation.js";
+import { replace, replaceNode } from "./replace/replace.js";
+import { other, otherNode } from "./other/other.js";
+import { pipeline, pipe, defaultPipeline } from "./pipeline/pipeline.js";
+
+export {
+    compileNode,
+    expandIterationNode,
+    interpolateValue,
+    interpolateString,
+    injectStory,
+    resolvePath,
+    operation,
+    operationNode,
+    replace,
+    replaceNode,
+    other,
+    otherNode,
+    pipeline,
+    pipe,
+    defaultPipeline
+};
+
+export default compileNode;

package/src/v9/instructionEngine/interpolate.js

@@ -0,0 +1,2 @@
+export { interpolateValue, interpolateString } from "./value/interpolate.js";
+export { default } from "./value/interpolate.js";

package/src/v9/instructionEngine/iteration/expandIteration.js

@@ -0,0 +1,95 @@
+import resolvePath from "../resolve/resolvePath.js";
+
+const resolveCollection = ({ inNode, inContext, inRootData }) => {
+    const instruction = inNode && inNode.jsonToSpec;
+    if (!instruction) return undefined;
+
+    const sourceKey = instruction.source || instruction.iterateOn || instruction.$iterate;
+    if (!sourceKey) return undefined;
+
+    return resolvePath({ inData: inRootData, inPath: sourceKey })
+        || (inRootData && inRootData[sourceKey])
+        || resolvePath({ inData: inContext, inPath: sourceKey })
+        || (inContext && inContext[sourceKey]);
+};
+
+export const expandIterationNode = ({ inNode, inContext = {}, inRootData = {} }) => {
+    const instruction = inNode && inNode.jsonToSpec;
+    if (!instruction) return undefined;
+
+    const operation = instruction.operation;
+    if (operation !== "iterate" && !instruction.source && !instruction.$iterate) {
+        return undefined;
+    }
+
+    const sourceKey = instruction.source || instruction.iterateOn || instruction.$iterate;
+    const collection = resolveCollection({ inNode, inContext, inRootData }) || [];
+
+    if (!Array.isArray(collection)) {
+        if (inNode && inNode.tagName) {
+            const cloned = { ...inNode };
+            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 = {
+            ...inContext,
+            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 (inContext.row && (item.field || item.columnName || item.name)) {
+            const fieldKey = item.field || item.columnName || item.name;
+            const cellValue = inContext.row[fieldKey];
+            if (cellValue !== undefined) {
+                itemContext.cellValue = cellValue;
+                itemContext.value = cellValue;
+                if (typeof item === "object" && item !== null && item.value === undefined) {
+                    item.value = cellValue;
+                }
+            }
+        }
+
+        const templateNode = typeof template === "object" && template !== null
+            ? { ...template, __loopItemContext: itemContext }
+            : { tagName: "span", textContent: template, __loopItemContext: itemContext };
+
+        expandedChildren.push(templateNode);
+    });
+
+    if (inNode && inNode.tagName) {
+        const cloned = { ...inNode };
+        delete cloned.jsonToSpec;
+        cloned.children = expandedChildren;
+        return cloned;
+    }
+
+    return expandedChildren;
+};
+
+export default expandIterationNode;