@uniformdev/canvas 19.178.2-alpha.25 → 19.179.2-alpha.22

package/dist/index.js

@@ -281,6 +281,7 @@ __export(src_exports, {
   ATTRIBUTE_PLACEHOLDER: () => ATTRIBUTE_PLACEHOLDER,
   ApiClientError: () => import_api15.ApiClientError,
   BatchEntry: () => BatchEntry,
+  BlockFormatError: () => BlockFormatError,
   CANVAS_BLOCK_PARAM_TYPE: () => CANVAS_BLOCK_PARAM_TYPE,
   CANVAS_DRAFT_STATE: () => CANVAS_DRAFT_STATE,
   CANVAS_EDITOR_STATE: () => CANVAS_EDITOR_STATE,
@@ -300,6 +301,7 @@ __export(src_exports, {
   CANVAS_TEST_VARIANT_PARAM: () => CANVAS_TEST_VARIANT_PARAM,
   CANVAS_VIZ_CONTROL_PARAM: () => CANVAS_VIZ_CONTROL_PARAM,
   CANVAS_VIZ_DI_RULE: () => CANVAS_VIZ_DI_RULE,
+  CANVAS_VIZ_DYNAMIC_TOKEN_RULE: () => CANVAS_VIZ_DYNAMIC_TOKEN_RULE,
   CANVAS_VIZ_LOCALE_RULE: () => CANVAS_VIZ_LOCALE_RULE,
   CANVAS_VIZ_QUIRKS_RULE: () => CANVAS_VIZ_QUIRKS_RULE,
   CanvasClient: () => CanvasClient,
@@ -345,6 +347,7 @@ __export(src_exports, {
   createBatchEnhancer: () => createBatchEnhancer,
   createCanvasChannel: () => createCanvasChannel,
   createDynamicInputVisibilityRule: () => createDynamicInputVisibilityRule,
+  createDynamicTokenVisibilityRule: () => createDynamicTokenVisibilityRule,
   createEventBus: () => createEventBus,
   createLimitPolicy: () => createLimitPolicy,
   createLocaleVisibilityRule: () => createLocaleVisibilityRule,
@@ -353,8 +356,10 @@ __export(src_exports, {
   createVariableReference: () => createVariableReference,
   enhance: () => enhance,
   evaluateNodeVisibilityParameter: () => evaluateNodeVisibilityParameter,
+  evaluatePropertyCriteria: () => evaluatePropertyCriteria,
   evaluateVisibilityCriteriaGroup: () => evaluateVisibilityCriteriaGroup,
-  evaluateWalkTreeVisibility: () => evaluateWalkTreeVisibility,
+  evaluateWalkTreeNodeVisibility: () => evaluateWalkTreeNodeVisibility,
+  evaluateWalkTreePropertyCriteria: () => evaluateWalkTreePropertyCriteria,
   extractLocales: () => extractLocales,
   findParameterInNodeTree: () => findParameterInNodeTree,
   flattenValues: () => flattenValues,
@@ -370,6 +375,7 @@ __export(src_exports, {
   getParameterAttributes: () => getParameterAttributes,
   getPropertiesValue: () => getPropertiesValue,
   getPropertyValue: () => getPropertyValue,
+  hasReferencedVariables: () => hasReferencedVariables,
   isAddComponentMessage: () => isAddComponentMessage,
   isAllowedReferrer: () => isAllowedReferrer,
   isAssetParamValue: () => isAssetParamValue,
@@ -611,14 +617,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
@@ -1403,7 +1412,16 @@ 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 (!Array.isArray(propObject.value)) {
+          throw new BlockFormatError(
+            `${getComponentPath(currentQueueEntry.ancestorsAndSelf)}`,
+            propKey,
+            propObject.value
+          );
+        }
         const blocks = (_b = propObject.value) != null ? _b : [];
         for (let blockIndex = blocks.length - 1; blockIndex >= 0; blockIndex--) {
           const enqueueingBlock = blocks[blockIndex];
@@ -1439,6 +1457,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 ${typeof blockValue}`
+    );
+    this.componentPath = componentPath;
+    this.propertyId = propertyId;
+    this.blockValue = blockValue;
+    Object.setPrototypeOf(this, _BlockFormatError.prototype);
+  }
+};
 
 // src/enhancement/enhance.ts
 async function enhance({
@@ -1748,6 +1777,86 @@ function findParameterInNodeTree(data, predicate) {
   return results;
 }
 
+// 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/visibility/evaluateVisibilityCriteriaGroup.ts
 function evaluateVisibilityCriteriaGroup(options) {
   const { criteriaGroup, simplifyCriteria } = options;
@@ -1767,12 +1876,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);
@@ -1798,6 +1913,59 @@ function evaluateNodeVisibilityParameter({
   return result;
 }
 
+// src/enhancement/visibility/evaluatePropertyCriteria.ts
+function evaluatePropertyCriteria({
+  baseValue,
+  conditionalValues,
+  keepIndeterminate,
+  ...evaluateGroupOptions
+}) {
+  let authoritative = true;
+  const result = {
+    currentValue: baseValue,
+    remainingConditionalValues: evaluateGroupOptions.simplifyCriteria && conditionalValues ? [...conditionalValues] : conditionalValues,
+    currentConditionIndex: -1
+  };
+  if (!conditionalValues) {
+    return result;
+  }
+  const conditionIndexesToRemove = [];
+  for (let i = 0; i < conditionalValues.length; i++) {
+    const conditionalVariant = conditionalValues[i];
+    if (result.matched) {
+      conditionIndexesToRemove.push(i);
+      continue;
+    }
+    const evaluationResult = evaluateVisibilityCriteriaGroup({
+      ...evaluateGroupOptions,
+      criteriaGroup: conditionalVariant.when
+    });
+    if (evaluationResult === null) {
+      if (keepIndeterminate) {
+        authoritative = false;
+      } else {
+        conditionIndexesToRemove.push(i);
+      }
+    } else if (evaluationResult === true) {
+      result.matched = conditionalVariant;
+      result.currentValue = conditionalVariant.value;
+      result.currentConditionIndex = i;
+      conditionIndexesToRemove.push(i);
+    } else {
+      conditionIndexesToRemove.push(i);
+    }
+  }
+  if (evaluateGroupOptions.simplifyCriteria) {
+    for (let i = conditionIndexesToRemove.length - 1; i >= 0; i--) {
+      result.remainingConditionalValues.splice(conditionIndexesToRemove[i], 1);
+    }
+  }
+  if (authoritative) {
+    result.remainingConditionalValues = void 0;
+  }
+  return result;
+}
+
 // src/enhancement/visibility/types.ts
 var CANVAS_VIZ_CONTROL_PARAM = "$viz";
 
@@ -1819,8 +1987,8 @@ function evaluateNodeVisibility({
   return result;
 }
 
-// src/enhancement/visibility/evaluateWalkTreeVisibility.ts
-function evaluateWalkTreeVisibility({
+// src/enhancement/visibility/evaluateWalkTreeNodeVisibility.ts
+function evaluateWalkTreeNodeVisibility({
   rules,
   showIndeterminate,
   context
@@ -1837,6 +2005,69 @@ function evaluateWalkTreeVisibility({
   return true;
 }
 
+// src/enhancement/visibility/evaluateWalkTreePropertyCriteria.ts
+function evaluateWalkTreePropertyCriteria({
+  rules,
+  node,
+  keepIndeterminate
+}) {
+  const properties = getPropertiesValue(node);
+  if (!properties) {
+    return;
+  }
+  Object.entries(properties).forEach(([propertyName, property]) => {
+    var _a, _b, _c;
+    if (property.locales || property.localesConditions) {
+      const localesDefined = [
+        ...Object.keys((_a = property.locales) != null ? _a : {}),
+        ...Object.keys((_b = property.localesConditions) != null ? _b : {})
+      ];
+      localesDefined.forEach((locale) => {
+        var _a2, _b2, _c2, _d, _e, _f, _g;
+        const { currentValue, remainingConditionalValues } = evaluatePropertyCriteria({
+          baseValue: (_a2 = property.locales) == null ? void 0 : _a2[locale],
+          conditionalValues: (_b2 = property.localesConditions) == null ? void 0 : _b2[locale],
+          rules,
+          simplifyCriteria: true,
+          keepIndeterminate
+        });
+        if (currentValue === null) {
+          (_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 = {};
+          property.locales[locale] = currentValue;
+        }
+        if (!(remainingConditionalValues == null ? void 0 : remainingConditionalValues.length)) {
+          (_f = property.localesConditions) == null ? true : delete _f[locale];
+        } else {
+          (_g = property.localesConditions) != null ? _g : property.localesConditions = {};
+          property.localesConditions[locale] = remainingConditionalValues;
+        }
+      });
+      if (!Object.keys((_c = property.localesConditions) != null ? _c : {}).length) {
+        delete property.localesConditions;
+      }
+    } else {
+      const { currentValue, remainingConditionalValues } = evaluatePropertyCriteria({
+        baseValue: property.value,
+        conditionalValues: property.conditions,
+        rules,
+        simplifyCriteria: true,
+        keepIndeterminate
+      });
+      if (currentValue === null) {
+        delete properties[propertyName];
+      } else {
+        property.value = currentValue;
+      }
+      property.conditions = remainingConditionalValues;
+    }
+  });
+}
+
 // src/enhancement/visibility/rules/evaluateStringMatch.ts
 var isEvaluator = (criteria, matchValue) => {
   if (Array.isArray(criteria)) {
@@ -1914,6 +2145,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";
@@ -1981,7 +2238,7 @@ function localize(options) {
       return;
     }
     if (isUsingModernOptions) {
-      const result = evaluateWalkTreeVisibility({
+      const result = evaluateWalkTreeNodeVisibility({
         context,
         rules: vizControlLocaleRule,
         showIndeterminate: true
@@ -1989,6 +2246,11 @@ 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 });
@@ -2055,13 +2317,16 @@ function localizeProperties(properties, locale) {
 // 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) {
@@ -2935,72 +3200,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,
@@ -3066,11 +3265,7 @@ function bindVariablesToObjectRecursive({
   if (richTextNodeResult !== void 0) {
     return richTextNodeResult;
   }
-  const produceToUse = !(0, import_immer.isDraft)(value) ? import_immer.produce : (produceValue, producer) => {
-    producer(produceValue);
-    return produceValue;
-  };
-  const result = produceToUse(value, (draft) => {
+  const result = (0, import_immer.produce)(value, (draft) => {
     Object.entries(draft).forEach(([property, oldValue]) => {
       const currentObjectPath = recursivePath ? `${recursivePath}.${property}` : property;
       if (typeof oldValue === "string") {
@@ -3177,6 +3372,7 @@ var CanvasClientError = import_api15.ApiClientError;
   ATTRIBUTE_PLACEHOLDER,
   ApiClientError,
   BatchEntry,
+  BlockFormatError,
   CANVAS_BLOCK_PARAM_TYPE,
   CANVAS_DRAFT_STATE,
   CANVAS_EDITOR_STATE,
@@ -3196,6 +3392,7 @@ var CanvasClientError = import_api15.ApiClientError;
   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,
@@ -3241,6 +3438,7 @@ var CanvasClientError = import_api15.ApiClientError;
   createBatchEnhancer,
   createCanvasChannel,
   createDynamicInputVisibilityRule,
+  createDynamicTokenVisibilityRule,
   createEventBus,
   createLimitPolicy,
   createLocaleVisibilityRule,
@@ -3249,8 +3447,10 @@ var CanvasClientError = import_api15.ApiClientError;
   createVariableReference,
   enhance,
   evaluateNodeVisibilityParameter,
+  evaluatePropertyCriteria,
   evaluateVisibilityCriteriaGroup,
-  evaluateWalkTreeVisibility,
+  evaluateWalkTreeNodeVisibility,
+  evaluateWalkTreePropertyCriteria,
   extractLocales,
   findParameterInNodeTree,
   flattenValues,
@@ -3266,6 +3466,7 @@ var CanvasClientError = import_api15.ApiClientError;
   getParameterAttributes,
   getPropertiesValue,
   getPropertyValue,
+  hasReferencedVariables,
   isAddComponentMessage,
   isAllowedReferrer,
   isAssetParamValue,