@ikas/component-cli 1.4.0-beta.114 → 1.4.0-beta.115

package/dist/commands/config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/commands/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AA46DpC,wBAAgB,mBAAmB,IAAI,OAAO,CAuU7C"}
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/commands/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAwyEpC,wBAAgB,mBAAmB,IAAI,OAAO,CA+U7C"}

package/dist/commands/config.js

@@ -162,7 +162,54 @@ const ALLOWED_PROP_FIELDS = new Set([
     "enumTypeId",
     "filteredComponentIds",
     "privateVarMap",
+    "numberRangeData",
 ]);
+/**
+ * Validate/sanitize a numberRangeData object for a NUMBER_RANGE prop. Accepts an object
+ * or a JSON string. min/max/interval are truncated to integers; only a positive interval
+ * is kept (0/negative would yield an invalid slider step). Exits with a structured error
+ * on malformed input.
+ */
+function parseNumberRangeData(raw, propName) {
+    const fail = (error) => {
+        console.log(JSON.stringify({ success: false, error }));
+        process.exit(1);
+    };
+    let obj = raw;
+    if (typeof raw === "string") {
+        try {
+            obj = JSON.parse(raw);
+        }
+        catch {
+            fail(`Invalid --numberRangeData JSON for prop "${propName}": ${raw}`);
+        }
+    }
+    if (typeof obj !== "object" || obj === null || Array.isArray(obj)) {
+        fail(`numberRangeData for prop "${propName}" must be an object { min, max, interval?, unit? }.`);
+    }
+    const o = obj;
+    const asInt = (v, field) => {
+        if (v === undefined || v === null)
+            return undefined;
+        if (typeof v !== "number" || !Number.isFinite(v)) {
+            fail(`numberRangeData.${field} for prop "${propName}" must be a finite number.`);
+        }
+        return Math.trunc(v);
+    };
+    const min = asInt(o.min, "min");
+    const max = asInt(o.max, "max");
+    const interval = asInt(o.interval, "interval");
+    const unit = typeof o.unit === "string" && o.unit.trim() ? o.unit.trim() : undefined;
+    if (min !== undefined && max !== undefined && min >= max) {
+        fail(`numberRangeData for prop "${propName}": min (${min}) must be less than max (${max}).`);
+    }
+    return {
+        ...(min !== undefined ? { min } : {}),
+        ...(max !== undefined ? { max } : {}),
+        ...(interval !== undefined && interval > 0 ? { interval } : {}),
+        ...(unit ? { unit } : {}),
+    };
+}
 /**
  * Parse and validate the --props JSON flag for add-component.
  * Returns validated ComponentProp[] or exits with error.
@@ -240,6 +287,8 @@ async function parsePropsFlag(propsJson, config, configPath) {
             }));
             process.exit(1);
         }
+        // Dynamic (merchant-data reference) props can't carry a static default.
+        rejectDynamicDefault(r.name, propType, r.defaultValue);
         // Validate LINK / LIST_OF_LINK defaultValue shape (reject JSON strings and legacy { href })
         if ((propType === "LINK" || propType === "LIST_OF_LINK") &&
             r.defaultValue !== undefined) {
@@ -258,6 +307,15 @@ async function parsePropsFlag(propsJson, config, configPath) {
                 process.exit(1);
             }
         }
+        // Validate TYPE (structured/style) defaultValue shape — must be an object (or an array for an
+        // _array typeId), never a bare string that would be emitted as a wrong-shaped default.
+        if (propType === "TYPE" && r.defaultValue !== undefined) {
+            const typeError = validateTypeDefaultValue(r.defaultValue, r.name, r.typeId);
+            if (typeError) {
+                console.log(JSON.stringify({ success: false, error: typeError }));
+                process.exit(1);
+            }
+        }
         // Auto-generate displayName if omitted
         const displayName = typeof r.displayName === "string" && r.displayName
             ? r.displayName
@@ -328,6 +386,9 @@ async function parsePropsFlag(propsJson, config, configPath) {
                     privateVarMap: r.privateVarMap,
                 }
                 : {}),
+            ...(propType === "NUMBER_RANGE" && r.numberRangeData !== undefined
+                ? { numberRangeData: parseNumberRangeData(r.numberRangeData, r.name) }
+                : {}),
         };
         props.push(prop);
     }
@@ -557,6 +618,7 @@ async function addProp(ref, options) {
             process.exit(1);
         }
     }
+    rejectDynamicDefault(options.name, propType, options.defaultValue);
     const parsedDefaultValue = options.defaultValue !== undefined
         ? parseDefaultValue(options.defaultValue, propType)
         : undefined;
@@ -576,6 +638,23 @@ async function addProp(ref, options) {
             process.exit(1);
         }
     }
+    if (propType === "TYPE" && parsedDefaultValue !== undefined) {
+        const typeError = validateTypeDefaultValue(parsedDefaultValue, options.name, options.typeId);
+        if (typeError) {
+            console.log(JSON.stringify({ success: false, error: typeError }));
+            process.exit(1);
+        }
+    }
+    const parsedNumberRangeData = propType === "NUMBER_RANGE" && options.numberRangeData !== undefined
+        ? parseNumberRangeData(options.numberRangeData, options.name)
+        : undefined;
+    if (propType === "NUMBER_RANGE" && parsedDefaultValue !== undefined) {
+        const nrError = validateNumberRangeDefaultValue(parsedDefaultValue, parsedNumberRangeData, options.name);
+        if (nrError) {
+            console.log(JSON.stringify({ success: false, error: nrError }));
+            process.exit(1);
+        }
+    }
     const newProp = {
         name: options.name,
         displayName: options.displayName,
@@ -590,6 +669,9 @@ async function addProp(ref, options) {
         ...(options.enumTypeId ? { enumTypeId: options.enumTypeId } : {}),
         ...(parsedFilteredIds ? { filteredComponentIds: parsedFilteredIds } : {}),
         ...(parsedPrivateVarMap ? { privateVarMap: parsedPrivateVarMap } : {}),
+        ...(parsedNumberRangeData
+            ? { numberRangeData: parsedNumberRangeData }
+            : {}),
     };
     component.props.push(newProp);
     saveConfig(configPath, config);
@@ -612,6 +694,9 @@ async function addProp(ref, options) {
             ...(newProp.privateVarMap
                 ? { privateVarMap: newProp.privateVarMap }
                 : {}),
+            ...(newProp.numberRangeData
+                ? { numberRangeData: newProp.numberRangeData }
+                : {}),
         },
     }));
 }
@@ -642,10 +727,66 @@ function parseDefaultValue(value, propType) {
             catch {
                 return value;
             }
+        case "NUMBER_RANGE":
+            // The default arrives as a string; a NUMBER_RANGE value is a typed object
+            // { value, unit }. Parse it here; if it is not valid JSON, return the raw string
+            // so validateNumberRangeDefaultValue can report a precise error.
+            try {
+                return JSON.parse(value);
+            }
+            catch {
+                return value;
+            }
+        case "TYPE":
+            // A TYPE (structured/style) default is a typed object — e.g. { value, unit } for a size
+            // style type — or an array of them for an _array typeId. Parse it here; if it is not valid
+            // JSON, return the raw string so validateTypeDefaultValue can report a precise error.
+            // (Without this the --defaultValue flag would store the raw string, a wrong-shaped default.)
+            try {
+                return JSON.parse(value);
+            }
+            catch {
+                return value;
+            }
         default:
             return value;
     }
 }
+// Prop types whose value is a dynamic reference to merchant storefront data (products, media,
+// categories, brands, blogs, raffles). They resolve at storefront render time, so a static config
+// default is invalid and is rejected on add/update-prop. Keep in sync with @ikas/editor-models
+// DYNAMIC_PROP_TYPES (the CLI must not depend on that private package).
+const DYNAMIC_PROP_TYPES = [
+    "IMAGE",
+    "IMAGE_LIST",
+    "VIDEO",
+    "PRODUCT",
+    "PRODUCT_LIST",
+    "PRODUCT_ATTRIBUTE",
+    "PRODUCT_ATTRIBUTE_LIST",
+    "BRAND",
+    "BRAND_LIST",
+    "CATEGORY",
+    "CATEGORY_LIST",
+    "BLOG",
+    "BLOG_LIST",
+    "BLOG_CATEGORY",
+    "BLOG_CATEGORY_LIST",
+    "RAFFLE",
+    "RAFFLE_LIST",
+];
+const dynamicPropDefaultError = (propName, propType) => `defaultValue is not allowed for prop "${propName}" of type ${propType}. ${propType} resolves to merchant storefront data at render time, so it can't carry a static default — omit defaultValue.`;
+// Reject a static default on a dynamic (merchant-data reference) prop type: print the standard
+// error and exit. No-op when the type isn't dynamic or no default was supplied.
+const rejectDynamicDefault = (propName, propType, defaultValue) => {
+    if (DYNAMIC_PROP_TYPES.includes(propType) && defaultValue !== undefined) {
+        console.log(JSON.stringify({
+            success: false,
+            error: dynamicPropDefaultError(propName, propType),
+        }));
+        process.exit(1);
+    }
+};
 const VALID_LINK_TYPES = ["PAGE", "EXTERNAL", "FILE"];
 const LINK_SHAPE_HELP = 'A link must be an object: { "linkType": "EXTERNAL", "label": "Text", "externalLink": "https://...", "subLinks": [] } ' +
     'for external links, or { "linkType": "PAGE", "label": "Text", "pageType": "INDEX", "subLinks": [] } for store pages. ' +
@@ -762,6 +903,141 @@ function validateSvgDefaultValue(propType, value, propName) {
             : null;
     });
 }
+const NUMBER_RANGE_DEFAULT_HELP = 'A NUMBER_RANGE default must be an object { "value": <number>, "unit": "px" | null }. ' +
+    "When the prop defines numberRangeData, value must be within [min, max] and on the interval grid (min + k·interval).";
+// Validates a NUMBER_RANGE defaultValue. Returns an error message, or null if valid.
+// Checks the { value, unit } shape and — when the prop carries numberRangeData — that the
+// value is within [min, max] and lands on the interval grid, mirroring the editor's slider
+// so an agent can't author an out-of-range or off-step default.
+function validateNumberRangeDefaultValue(value, numberRangeData, propName) {
+    if (value === undefined || value === null)
+        return null;
+    const where = `defaultValue for prop "${propName}"`;
+    if (typeof value === "string") {
+        return `${where} is a JSON string but must be an object. ${NUMBER_RANGE_DEFAULT_HELP}`;
+    }
+    if (typeof value !== "object" || Array.isArray(value)) {
+        return `${where} must be an object. ${NUMBER_RANGE_DEFAULT_HELP}`;
+    }
+    const v = value;
+    if (typeof v.value !== "number" || !Number.isFinite(v.value)) {
+        return `${where}: "value" must be a finite number. ${NUMBER_RANGE_DEFAULT_HELP}`;
+    }
+    if (v.unit !== undefined && v.unit !== null && typeof v.unit !== "string") {
+        return `${where}: "unit" must be a string or null. ${NUMBER_RANGE_DEFAULT_HELP}`;
+    }
+    if (numberRangeData) {
+        const { min, max, interval } = numberRangeData;
+        if (min !== undefined && v.value < min) {
+            return `${where}: value ${v.value} is below the configured min (${min}).`;
+        }
+        if (max !== undefined && v.value > max) {
+            return `${where}: value ${v.value} is above the configured max (${max}).`;
+        }
+        if (interval !== undefined &&
+            interval > 0 &&
+            min !== undefined &&
+            (v.value - min) % interval !== 0) {
+            return `${where}: value ${v.value} is not on the interval grid (min ${min} + k·${interval}).`;
+        }
+    }
+    return null;
+}
+const STYLE_TYPE_DEFAULT_HELP = "A size/style TYPE default must be an object matching the type's shape: " +
+    '{ "value": <number>, "unit": "px" | "rem" | "%" | "vh" | "vw" } (or { "css": "<raw css>" }). ' +
+    "Author it via add-component --props '[…]' or --defaultValue '<json>'.";
+const BP_STOREFRONT_PREFIX = "@ikas/bp-storefront-models-";
+// The size/style types that share the { css?, value?, unit? } shape. This is EXACTLY the set of
+// TYPE typeIds whose default the generator emits (mirror of DYNAMIC_STYLE_TYPE_IDS in
+// @ikas/blueprint-modules design-generator/generate-helpers/styles.ts — the standalone CLI must not
+// depend on that package, so it is hand-maintained here and kept in sync by a parity test). Every
+// OTHER TYPE typeId (BorderStyleType, BoxShadowStyleType, GridTemplateColumnsStyleType, string-union
+// styles like TextAlignStyleType, IkasProduct, custom types) has a DIFFERENT value shape, so their
+// defaults are not shape-checked (and are dead code in the generator anyway).
+const SIZE_STYLE_TYPE_NAMES = [
+    "SizeStyleType",
+    "PaddingStyleType",
+    "PaddingTopStyleType",
+    "PaddingRightStyleType",
+    "PaddingBottomStyleType",
+    "PaddingLeftStyleType",
+    "MarginStyleType",
+    "MarginTopStyleType",
+    "MarginRightStyleType",
+    "MarginBottomStyleType",
+    "MarginLeftStyleType",
+    "BorderRadiusStyleType",
+    "BorderRadiusTopLeftStyleType",
+    "BorderRadiusTopRightStyleType",
+    "BorderRadiusBottomRightStyleType",
+    "BorderRadiusBottomLeftStyleType",
+    "FontSizeStyleType",
+    "LineHeightStyleType",
+    "LetterSpacingStyleType",
+    "HeightStyleType",
+    "MinHeightStyleType",
+    "MaxHeightStyleType",
+    "WidthStyleType",
+    "MinWidthStyleType",
+    "MaxWidthStyleType",
+    "GapStyleType",
+    "BorderWidthStyleType",
+    "TopStyleType",
+    "RightStyleType",
+    "BottomStyleType",
+    "LeftStyleType",
+];
+// Validates a single style-type default object. Every size style type shares the optional
+// { css?, value?, unit? } shape, so inner fields are checked loosely — the key rejection is a
+// non-object (e.g. a bare JSON string, the common failure when a --defaultValue flag is not parsed).
+function styleDefaultObjectError(value, where) {
+    if (typeof value === "string") {
+        return `${where} is a JSON string but must be an object. ${STYLE_TYPE_DEFAULT_HELP}`;
+    }
+    if (!value || typeof value !== "object" || Array.isArray(value)) {
+        return `${where} must be an object. ${STYLE_TYPE_DEFAULT_HELP}`;
+    }
+    const v = value;
+    if (v.value !== undefined &&
+        (typeof v.value !== "number" || !Number.isFinite(v.value))) {
+        return `${where}: "value" must be a finite number. ${STYLE_TYPE_DEFAULT_HELP}`;
+    }
+    if (v.unit !== undefined && v.unit !== null && typeof v.unit !== "string") {
+        return `${where}: "unit" must be a string. ${STYLE_TYPE_DEFAULT_HELP}`;
+    }
+    if (v.css !== undefined && typeof v.css !== "string") {
+        return `${where}: "css" must be a string. ${STYLE_TYPE_DEFAULT_HELP}`;
+    }
+    return null;
+}
+// Validates a TYPE prop defaultValue — but ONLY for the size/style types whose shape we know
+// ({ css?, value?, unit? }). Any other TYPE typeId (color/border/box-shadow/grid/string-union
+// styles, IkasProduct, custom types) has a different value shape we can't verify offline, so its
+// default is passed through unchecked. The generator only emits a default for these size/style
+// types anyway. Returns an error message, or null if valid / not a size-style type.
+function validateTypeDefaultValue(value, propName, typeId) {
+    if (value === undefined || value === null)
+        return null;
+    if (typeof typeId !== "string" || !typeId.startsWith(BP_STOREFRONT_PREFIX)) {
+        return null;
+    }
+    // Strip the prefix and an optional _array suffix to get the base type name.
+    const withoutPrefix = typeId.slice(BP_STOREFRONT_PREFIX.length);
+    const isArray = withoutPrefix.endsWith("_array");
+    const baseName = isArray
+        ? withoutPrefix.slice(0, -"_array".length)
+        : withoutPrefix;
+    if (!SIZE_STYLE_TYPE_NAMES.includes(baseName))
+        return null;
+    const where = `defaultValue for prop "${propName}"`;
+    if (isArray) {
+        if (!Array.isArray(value)) {
+            return `${where} must be an array for an _array TYPE prop: [ { "value": …, "unit": … }, … ]. ${STYLE_TYPE_DEFAULT_HELP}`;
+        }
+        return firstError(value, (el, i) => styleDefaultObjectError(el, `${where}[${i}]`));
+    }
+    return styleDefaultObjectError(value, where);
+}
 async function updateProp(ref, options) {
     const { config, configPath } = loadConfig();
     const component = resolveComponent(config, ref);
@@ -794,7 +1070,18 @@ async function updateProp(ref, options) {
     if (options.description !== undefined) {
         prop.description = options.description || undefined;
     }
+    // Resolve numberRangeData before defaultValue so a NUMBER_RANGE default can be validated
+    // against the (possibly just-updated) slider config in the same call.
+    if (options.numberRangeData !== undefined) {
+        if (options.numberRangeData === "" || options.numberRangeData === "none") {
+            delete prop.numberRangeData;
+        }
+        else {
+            prop.numberRangeData = parseNumberRangeData(options.numberRangeData, prop.name);
+        }
+    }
     if (options.defaultValue !== undefined) {
+        rejectDynamicDefault(prop.name, prop.type, options.defaultValue);
         const parsed = parseDefaultValue(options.defaultValue, prop.type);
         if (prop.type === "LINK" || prop.type === "LIST_OF_LINK") {
             const linkError = validateLinkDefaultValue(prop.type, parsed, prop.name);
@@ -803,6 +1090,21 @@ async function updateProp(ref, options) {
                 process.exit(1);
             }
         }
+        if (prop.type === "NUMBER_RANGE") {
+            const nrError = validateNumberRangeDefaultValue(parsed, prop.numberRangeData, prop.name);
+            if (nrError) {
+                console.log(JSON.stringify({ success: false, error: nrError }));
+                process.exit(1);
+            }
+        }
+        if (prop.type === "TYPE") {
+            // Prefer a typeId supplied in this same update over the stored one.
+            const typeError = validateTypeDefaultValue(parsed, prop.name, options.typeId ?? prop.typeId);
+            if (typeError) {
+                console.log(JSON.stringify({ success: false, error: typeError }));
+                process.exit(1);
+            }
+        }
         prop.defaultValue = parsed;
     }
     if (options.group !== undefined) {
@@ -925,6 +1227,9 @@ async function updateProp(ref, options) {
                 ? { filteredComponentIds: prop.filteredComponentIds }
                 : {}),
             ...(prop.privateVarMap ? { privateVarMap: prop.privateVarMap } : {}),
+            ...(prop.numberRangeData
+                ? { numberRangeData: prop.numberRangeData }
+                : {}),
         },
     }));
 }
@@ -1423,6 +1728,7 @@ export function createConfigCommand() {
         .option("--enumTypeId <enumTypeId>", "Enum type ID for ENUM props (required when type is ENUM)")
         .option("--filteredComponentIds <json>", "JSON array of component IDs to restrict selection (for COMPONENT/COMPONENT_LIST)")
         .option("--privateVarMap <json>", "JSON object mapping variable keys to {id, typeId} (for COMPONENT/COMPONENT_LIST)")
+        .option("--numberRangeData <json>", 'JSON slider config for NUMBER_RANGE props, e.g. \'{"min":0,"max":100,"interval":5,"unit":"px"}\'')
         .action((options) => {
         addProp({ id: options.componentId, name: options.component }, options);
     });
@@ -1442,6 +1748,7 @@ export function createConfigCommand() {
         .option("--enumTypeId <enumTypeId>", "Enum type ID for ENUM props (use 'none' to clear)")
         .option("--filteredComponentIds <json>", "JSON array of component IDs (use 'none' to clear)")
         .option("--privateVarMap <json>", "JSON object mapping variable keys to {id, typeId} (use 'none' to clear)")
+        .option("--numberRangeData <json>", "JSON slider config for NUMBER_RANGE props (use 'none' to clear)")
         .action((options) => {
         updateProp({ id: options.componentId, name: options.component }, options);
     });