@uniformdev/canvas 19.173.1-alpha.17 → 19.173.2-alpha.210

package/dist/index.esm.js

@@ -462,14 +462,17 @@ var nullLimitPolicy = async (func) => await func();
 // src/utils/rewriteFilters.ts
 var isPlainObject = (obj) => typeof obj === "object" && obj !== null && !Array.isArray(obj);
 function rewriteFilters(filters) {
-  return Object.entries(filters != null ? filters : {}).reduce((acc, [key, value]) => {
-    const lhs = `filters.${key}` + (isPlainObject(value) ? `[${Object.keys(value)[0]}]` : "");
-    const rhs = isPlainObject(value) ? Object.values(value)[0] : value;
-    return {
-      ...acc,
-      [lhs]: Array.isArray(rhs) ? rhs.map((v) => `${v}`.trim()).join(",") : `${rhs}`.trim()
-    };
-  }, {});
+  return Object.entries(filters != null ? filters : {}).reduce(
+    (acc, [key, value]) => {
+      const lhs = `filters.${key}` + (isPlainObject(value) ? `[${Object.keys(value)[0]}]` : "");
+      const rhs = isPlainObject(value) ? Object.values(value)[0] : value;
+      return {
+        ...acc,
+        [lhs]: Array.isArray(rhs) ? rhs.map((v) => `${v}`.trim()).join(",") : `${rhs}`.trim()
+      };
+    },
+    {}
+  );
 }
 
 // src/CanvasClient.ts
@@ -980,6 +983,9 @@ function isAssetParamValueItem(item) {
     item instanceof Object && "_source" in item && "fields" in item && item.fields instanceof Object && "url" in item.fields && item.fields.url instanceof Object
   );
 }
+function isLinkParamValue(value) {
+  return typeof value === "object" && value !== null && "type" in value && "path" in value;
+}
 
 // src/utils/properties.ts
 function getPropertiesValue(entity) {
@@ -1031,6 +1037,86 @@ function flattenSingleNodeValues(data, options = {}) {
   ) : properties;
 }
 
+// src/utils/variables/parseVariableExpression.ts
+var escapeCharacter = "\\";
+var variablePrefix = "${";
+var variableSuffix = "}";
+function parseVariableExpression(serialized, onToken) {
+  let bufferStartIndex = 0;
+  let bufferEndIndex = 0;
+  let tokenCount = 0;
+  const handleToken = (token, type) => {
+    tokenCount++;
+    return onToken == null ? void 0 : onToken(token, type);
+  };
+  let state = "text";
+  for (let index = 0; index < serialized.length; index++) {
+    const char = serialized[index];
+    if (bufferStartIndex > bufferEndIndex) {
+      bufferEndIndex = bufferStartIndex;
+    }
+    if (char === variablePrefix[0] && serialized[index + 1] === variablePrefix[1]) {
+      if (serialized[index - 1] === escapeCharacter) {
+        bufferEndIndex -= escapeCharacter.length;
+        if (handleToken(serialized.substring(bufferStartIndex, bufferEndIndex), "text") === false) {
+          return tokenCount;
+        }
+        bufferStartIndex = index;
+        bufferEndIndex = index + 1;
+        continue;
+      }
+      state = "variable";
+      if (bufferEndIndex > bufferStartIndex) {
+        if (handleToken(serialized.substring(bufferStartIndex, bufferEndIndex), "text") === false) {
+          return tokenCount;
+        }
+        bufferStartIndex = bufferEndIndex;
+      }
+      index += variablePrefix.length - 1;
+      bufferStartIndex += variablePrefix.length;
+      continue;
+    }
+    if (char === variableSuffix && state === "variable") {
+      if (serialized[index - 1] === escapeCharacter) {
+        bufferEndIndex++;
+        continue;
+      }
+      state = "text";
+      if (bufferEndIndex > bufferStartIndex) {
+        const unescapedVariableName = serialized.substring(bufferStartIndex, bufferEndIndex).replace(/\\([${}])/g, "$1");
+        if (handleToken(unescapedVariableName, "variable") === false) {
+          return tokenCount;
+        }
+        bufferStartIndex = bufferEndIndex + variableSuffix.length;
+      }
+      continue;
+    }
+    bufferEndIndex++;
+  }
+  if (bufferEndIndex > bufferStartIndex) {
+    if (state === "variable") {
+      state = "text";
+      bufferStartIndex -= variablePrefix.length;
+    }
+    handleToken(serialized.substring(bufferStartIndex), state);
+  }
+  return tokenCount;
+}
+
+// src/utils/variables/hasReferencedVariables.ts
+function hasReferencedVariables(value) {
+  if (value === void 0) {
+    return 0;
+  }
+  let variableTokenCount = 0;
+  parseVariableExpression(value, (_, tokenType) => {
+    if (tokenType === "variable") {
+      variableTokenCount++;
+    }
+  });
+  return variableTokenCount;
+}
+
 // src/enhancement/walkNodeTree.ts
 function walkNodeTree(node, visitor, options) {
   var _a, _b;
@@ -1254,7 +1340,25 @@ function walkNodeTree(node, visitor, options) {
       const propertyEntries = Object.entries(properties);
       for (let propIndex = propertyEntries.length - 1; propIndex >= 0; propIndex--) {
         const [propKey, propObject] = propertyEntries[propIndex];
-        if (!isNestedNodeType(propObject.type)) continue;
+        if (!isNestedNodeType(propObject.type)) {
+          continue;
+        }
+        if (typeof propObject.value === "string" && hasReferencedVariables(propObject.value) > 0) {
+          continue;
+        }
+        if (!Array.isArray(propObject.value)) {
+          const error = new BlockFormatError(
+            `${getComponentPath(currentQueueEntry.ancestorsAndSelf)}`,
+            propKey,
+            propObject.value
+          );
+          if (options == null ? void 0 : options.throwForInvalidBlockValues) {
+            throw error;
+          } else {
+            console.warn(`Skipped invalid block value: ${error.message}}`);
+            continue;
+          }
+        }
         const blocks = (_b = propObject.value) != null ? _b : [];
         for (let blockIndex = blocks.length - 1; blockIndex >= 0; blockIndex--) {
           const enqueueingBlock = blocks[blockIndex];
@@ -1290,6 +1394,17 @@ function getBlockValue(component, parameterName) {
   }
   return [];
 }
+var BlockFormatError = class _BlockFormatError extends Error {
+  constructor(componentPath, propertyId, blockValue) {
+    super(
+      `${componentPath} has an invalid block property value on ${propertyId}. Block values must be arrays of blocks (BlockValue type), but received ${blockValue === null ? "null" : typeof blockValue}`
+    );
+    this.componentPath = componentPath;
+    this.propertyId = propertyId;
+    this.blockValue = blockValue;
+    Object.setPrototypeOf(this, _BlockFormatError.prototype);
+  }
+};
 
 // src/enhancement/enhance.ts
 async function enhance({
@@ -1618,12 +1733,18 @@ function evaluateVisibilityCriteriaGroup(options) {
   return hasIndeterminateClauses ? null : !earlyExitResult;
 }
 function evaluateCriterion(clause, rootOptions) {
+  var _a;
   if ("clauses" in clause) {
     return evaluateVisibilityCriteriaGroup({
       ...rootOptions,
       criteriaGroup: clause
     });
   }
+  const lhs = (_a = clause.source) != null ? _a : clause.rule;
+  const rhs = Array.isArray(clause.value) ? clause.value : clause.value !== void 0 ? [clause.value] : void 0;
+  if (hasReferencedVariables(lhs) > 0 || (rhs == null ? void 0 : rhs.some((rhv) => hasReferencedVariables(rhv) > 0))) {
+    return null;
+  }
   const rule = rootOptions.rules[clause.rule];
   if (rule) {
     return rule(clause);
@@ -1631,6 +1752,24 @@ function evaluateCriterion(clause, rootOptions) {
   return null;
 }
 
+// src/enhancement/visibility/evaluateNodeVisibilityParameter.ts
+function evaluateNodeVisibilityParameter({
+  parameter,
+  ...evaluateGroupOptions
+}) {
+  if (parameter == null ? void 0 : parameter.explicitlyHidden) {
+    return false;
+  }
+  if (!(parameter == null ? void 0 : parameter.criteria)) {
+    return true;
+  }
+  const result = evaluateVisibilityCriteriaGroup({
+    ...evaluateGroupOptions,
+    criteriaGroup: parameter.criteria
+  });
+  return result;
+}
+
 // src/enhancement/visibility/evaluatePropertyCriteria.ts
 function evaluatePropertyCriteria({
   baseValue,
@@ -1695,17 +1834,11 @@ function evaluateNodeVisibility({
   var _a;
   const properties = getPropertiesValue(node);
   const vizCriteria = (_a = properties == null ? void 0 : properties[CANVAS_VIZ_CONTROL_PARAM]) == null ? void 0 : _a.value;
-  if (vizCriteria == null ? void 0 : vizCriteria.explicitlyHidden) {
-    return false;
-  }
-  if (!(vizCriteria == null ? void 0 : vizCriteria.criteria)) {
-    return true;
-  }
-  const result = evaluateVisibilityCriteriaGroup({
+  const result = evaluateNodeVisibilityParameter({
     ...evaluateGroupOptions,
-    criteriaGroup: vizCriteria.criteria
+    parameter: vizCriteria
   });
-  if (vizCriteria.criteria.clauses.length === 0 && evaluateGroupOptions.simplifyCriteria) {
+  if ((vizCriteria == null ? void 0 : vizCriteria.criteria) && vizCriteria.criteria.clauses.length === 0 && evaluateGroupOptions.simplifyCriteria) {
     properties == null ? true : delete properties[CANVAS_VIZ_CONTROL_PARAM];
   }
   return result;
@@ -1747,7 +1880,7 @@ function evaluateWalkTreePropertyCriteria({
         ...Object.keys((_b = property.localesConditions) != null ? _b : {})
       ];
       localesDefined.forEach((locale) => {
-        var _a2, _b2, _c2, _d, _e, _f, _g;
+        var _a2, _b2, _c2, _d, _e, _f;
         const { currentValue, remainingConditionalValues } = evaluatePropertyCriteria({
           baseValue: (_a2 = property.locales) == null ? void 0 : _a2[locale],
           conditionalValues: (_b2 = property.localesConditions) == null ? void 0 : _b2[locale],
@@ -1755,25 +1888,25 @@ function evaluateWalkTreePropertyCriteria({
           simplifyCriteria: true,
           keepIndeterminate
         });
-        if (currentValue === null) {
+        if (currentValue === null || currentValue === void 0) {
           (_c2 = property.locales) == null ? true : delete _c2[locale];
-          if (!Object.keys((_d = property.locales) != null ? _d : {}).length) {
-            delete properties[propertyName];
-          }
         } else {
-          (_e = property.locales) != null ? _e : property.locales = {};
+          (_d = property.locales) != null ? _d : property.locales = {};
           property.locales[locale] = currentValue;
         }
         if (!(remainingConditionalValues == null ? void 0 : remainingConditionalValues.length)) {
-          (_f = property.localesConditions) == null ? true : delete _f[locale];
+          (_e = property.localesConditions) == null ? true : delete _e[locale];
         } else {
-          (_g = property.localesConditions) != null ? _g : property.localesConditions = {};
+          (_f = property.localesConditions) != null ? _f : property.localesConditions = {};
           property.localesConditions[locale] = remainingConditionalValues;
         }
       });
       if (!Object.keys((_c = property.localesConditions) != null ? _c : {}).length) {
         delete property.localesConditions;
       }
+      if (!property.locales && !property.localesConditions) {
+        delete properties[propertyName];
+      }
     } else {
       const { currentValue, remainingConditionalValues } = evaluatePropertyCriteria({
         baseValue: property.value,
@@ -1785,9 +1918,17 @@ function evaluateWalkTreePropertyCriteria({
       if (currentValue === null) {
         delete properties[propertyName];
       } else {
-        property.value = currentValue;
+        if (currentValue !== void 0) {
+          property.value = currentValue;
+        } else {
+          delete property.value;
+        }
+      }
+      if (remainingConditionalValues === void 0) {
+        delete property.conditions;
+      } else {
+        property.conditions = remainingConditionalValues;
       }
-      property.conditions = remainingConditionalValues;
     }
   });
 }
@@ -1869,6 +2010,32 @@ function createDynamicInputVisibilityRule(dynamicInputs) {
   };
 }
 
+// src/enhancement/visibility/rules/createDynamicTokenVisibilityRule.ts
+var dynamicTokenVisibilityOperators = /* @__PURE__ */ new Set([
+  "is",
+  "!is",
+  "has",
+  "!has",
+  "startswith",
+  "!startswith",
+  "endswith",
+  "!endswith",
+  "empty",
+  "!empty"
+]);
+var CANVAS_VIZ_DYNAMIC_TOKEN_RULE = "$dt";
+function createDynamicTokenVisibilityRule() {
+  return {
+    [CANVAS_VIZ_DYNAMIC_TOKEN_RULE]: (criterion) => {
+      var _a;
+      if (hasReferencedVariables(criterion.source)) {
+        return null;
+      }
+      return evaluateStringMatch(criterion, (_a = criterion.source) != null ? _a : "", dynamicTokenVisibilityOperators);
+    }
+  };
+}
+
 // src/enhancement/visibility/rules/createLocaleVisibilityRule.ts
 var localeVisibilityOperators = /* @__PURE__ */ new Set(["is", "!is"]);
 var CANVAS_VIZ_LOCALE_RULE = "$locale";
@@ -1931,7 +2098,7 @@ function localize(options) {
     const { type, node, actions } = context;
     if (type !== "component") {
       if (isUsingModernOptions) {
-        localizeProperties(node.fields, locale);
+        localizeProperties(node, locale, vizControlLocaleRule);
       }
       return;
     }
@@ -1944,11 +2111,6 @@ function localize(options) {
       if (!result) {
         return;
       }
-      evaluateWalkTreePropertyCriteria({
-        node: context.node,
-        rules: vizControlLocaleRule,
-        keepIndeterminate: true
-      });
     }
     if (node.type === CANVAS_LOCALIZATION_TYPE) {
       const locales = extractLocales({ component: node });
@@ -1961,7 +2123,7 @@ function localize(options) {
         replaceComponent.forEach((component) => {
           removeLocaleProperty(component);
           if (isUsingModernOptions) {
-            localizeProperties(getPropertiesValue(component), locale);
+            localizeProperties(component, locale, vizControlLocaleRule);
           }
         });
         const [first, ...rest] = replaceComponent;
@@ -1973,7 +2135,7 @@ function localize(options) {
         actions.remove();
       }
     } else if (isUsingModernOptions) {
-      localizeProperties(getPropertiesValue(node), locale);
+      localizeProperties(node, locale, vizControlLocaleRule);
     }
   });
 }
@@ -1992,36 +2154,51 @@ function removeLocaleProperty(component) {
     }
   }
 }
-function localizeProperties(properties, locale) {
+function localizeProperties(node, locale, rules) {
+  const properties = getPropertiesValue(node);
   if (!properties) {
     return void 0;
   }
-  Object.entries(properties).forEach(([key, property]) => {
-    var _a;
+  Object.entries(properties).forEach(([propertyId, propertyValue]) => {
+    var _a, _b;
     if (!locale) {
-      delete property.locales;
+      delete propertyValue.locales;
+      delete propertyValue.localesConditions;
     }
-    const currentLocaleValue = locale ? (_a = property.locales) == null ? void 0 : _a[locale] : void 0;
+    const currentLocaleValue = locale ? (_a = propertyValue.locales) == null ? void 0 : _a[locale] : void 0;
     if (currentLocaleValue !== void 0) {
-      property.value = currentLocaleValue;
+      propertyValue.value = currentLocaleValue;
+    }
+    const currentLocaleConditionalValues = locale ? (_b = propertyValue.localesConditions) == null ? void 0 : _b[locale] : void 0;
+    if (currentLocaleConditionalValues !== void 0) {
+      propertyValue.conditions = currentLocaleConditionalValues;
     }
-    delete property.locales;
-    if (property.value === void 0) {
-      delete properties[key];
+    delete propertyValue.locales;
+    delete propertyValue.localesConditions;
+    if (propertyValue.value === void 0 && propertyValue.conditions === void 0) {
+      delete properties[propertyId];
     }
   });
+  evaluateWalkTreePropertyCriteria({
+    node,
+    rules,
+    keepIndeterminate: true
+  });
 }
 
 // src/enhancement/UniqueBatchEntries.ts
 var UniqueBatchEntries = class {
   constructor(entries, uniqueKeySelector) {
-    this.groups = entries.reduce((acc, task) => {
-      var _a;
-      const key = uniqueKeySelector(task.args);
-      acc[key] = (_a = acc[key]) != null ? _a : [];
-      acc[key].push(task);
-      return acc;
-    }, {});
+    this.groups = entries.reduce(
+      (acc, task) => {
+        var _a;
+        const key = uniqueKeySelector(task.args);
+        acc[key] = (_a = acc[key]) != null ? _a : [];
+        acc[key].push(task);
+        return acc;
+      },
+      {}
+    );
   }
   /** Resolves all entries in a group key with the same result value. */
   resolveKey(key, result) {
@@ -2869,7 +3046,7 @@ var isComponentPlaceholderId = (id) => {
   return id == null ? void 0 : id.startsWith(PLACEHOLDER_ID);
 };
 var generateComponentPlaceholderId = (randomId, sdkVersion, parent) => {
-  if (typeof sdkVersion === "undefined" || sdkVersion === 1) {
+  if (sdkVersion === 1) {
     return PLACEHOLDER_ID;
   }
   let idParts = [PLACEHOLDER_ID, randomId];
@@ -2895,72 +3072,6 @@ var parseComponentPlaceholderId = (id) => {
   return result;
 };
 
-// src/utils/variables/parseVariableExpression.ts
-var escapeCharacter = "\\";
-var variablePrefix = "${";
-var variableSuffix = "}";
-function parseVariableExpression(serialized, onToken) {
-  let bufferStartIndex = 0;
-  let bufferEndIndex = 0;
-  let tokenCount = 0;
-  const handleToken = (token, type) => {
-    tokenCount++;
-    return onToken == null ? void 0 : onToken(token, type);
-  };
-  let state = "text";
-  for (let index = 0; index < serialized.length; index++) {
-    const char = serialized[index];
-    if (bufferStartIndex > bufferEndIndex) {
-      bufferEndIndex = bufferStartIndex;
-    }
-    if (char === variablePrefix[0] && serialized[index + 1] === variablePrefix[1]) {
-      if (serialized[index - 1] === escapeCharacter) {
-        bufferEndIndex -= escapeCharacter.length;
-        if (handleToken(serialized.substring(bufferStartIndex, bufferEndIndex), "text") === false) {
-          return tokenCount;
-        }
-        bufferStartIndex = index;
-        bufferEndIndex = index + 1;
-        continue;
-      }
-      state = "variable";
-      if (bufferEndIndex > bufferStartIndex) {
-        if (handleToken(serialized.substring(bufferStartIndex, bufferEndIndex), "text") === false) {
-          return tokenCount;
-        }
-        bufferStartIndex = bufferEndIndex;
-      }
-      index += variablePrefix.length - 1;
-      bufferStartIndex += variablePrefix.length;
-      continue;
-    }
-    if (char === variableSuffix && state === "variable") {
-      if (serialized[index - 1] === escapeCharacter) {
-        bufferEndIndex++;
-        continue;
-      }
-      state = "text";
-      if (bufferEndIndex > bufferStartIndex) {
-        const unescapedVariableName = serialized.substring(bufferStartIndex, bufferEndIndex).replace(/\\([${}])/g, "$1");
-        if (handleToken(unescapedVariableName, "variable") === false) {
-          return tokenCount;
-        }
-        bufferStartIndex = bufferEndIndex + variableSuffix.length;
-      }
-      continue;
-    }
-    bufferEndIndex++;
-  }
-  if (bufferEndIndex > bufferStartIndex) {
-    if (state === "variable") {
-      state = "text";
-      bufferStartIndex -= variablePrefix.length;
-    }
-    handleToken(serialized.substring(bufferStartIndex), state);
-  }
-  return tokenCount;
-}
-
 // src/utils/variables/bindVariables.ts
 function bindVariables({
   variables,
@@ -2998,7 +3109,7 @@ function bindVariables({
 }
 
 // src/utils/variables/bindVariablesToObject.ts
-import { produce } from "immer";
+import { isDraft, produce } from "immer";
 
 // src/utils/variables/createVariableReference.ts
 function createVariableReference(variableName) {
@@ -3026,7 +3137,11 @@ function bindVariablesToObjectRecursive({
   if (richTextNodeResult !== void 0) {
     return richTextNodeResult;
   }
-  const result = produce(value, (draft) => {
+  const produceToUse = !isDraft(value) ? produce : (produceValue, producer) => {
+    producer(produceValue);
+    return produceValue;
+  };
+  const result = produceToUse(value, (draft) => {
     Object.entries(draft).forEach(([property, oldValue]) => {
       const currentObjectPath = recursivePath ? `${recursivePath}.${property}` : property;
       if (typeof oldValue === "string") {
@@ -3132,6 +3247,7 @@ export {
   ATTRIBUTE_PLACEHOLDER,
   ApiClientError2 as ApiClientError,
   BatchEntry,
+  BlockFormatError,
   CANVAS_BLOCK_PARAM_TYPE,
   CANVAS_DRAFT_STATE,
   CANVAS_EDITOR_STATE,
@@ -3151,6 +3267,7 @@ export {
   CANVAS_TEST_VARIANT_PARAM,
   CANVAS_VIZ_CONTROL_PARAM,
   CANVAS_VIZ_DI_RULE,
+  CANVAS_VIZ_DYNAMIC_TOKEN_RULE,
   CANVAS_VIZ_LOCALE_RULE,
   CANVAS_VIZ_QUIRKS_RULE,
   CanvasClient,
@@ -3196,6 +3313,7 @@ export {
   createBatchEnhancer,
   createCanvasChannel,
   createDynamicInputVisibilityRule,
+  createDynamicTokenVisibilityRule,
   createEventBus,
   createLimitPolicy,
   createLocaleVisibilityRule,
@@ -3203,6 +3321,7 @@ export {
   createUniformApiEnhancer,
   createVariableReference,
   enhance,
+  evaluateNodeVisibilityParameter,
   evaluatePropertyCriteria,
   evaluateVisibilityCriteriaGroup,
   evaluateWalkTreeNodeVisibility,
@@ -3222,6 +3341,7 @@ export {
   getParameterAttributes,
   getPropertiesValue,
   getPropertyValue,
+  hasReferencedVariables,
   isAddComponentMessage,
   isAllowedReferrer,
   isAssetParamValue,
@@ -3231,6 +3351,7 @@ export {
   isContextStorageUpdatedMessage,
   isDismissPlaceholderMessage,
   isEntryData,
+  isLinkParamValue,
   isMovingComponentMessage,
   isNestedNodeType,
   isOpenParameterEditorMessage,