@uniformdev/canvas 19.161.2-alpha.1 → 19.162.2-alpha.11

package/dist/index.mjs

@@ -1608,6 +1608,198 @@ function findParameterInNodeTree(data, predicate) {
   return results;
 }
 
+// src/enhancement/visibility/evaluateVisibilityCriteriaGroup.ts
+function evaluateVisibilityCriteriaGroup(options) {
+  const { criteriaGroup, simplifyCriteria } = options;
+  const earlyExitResult = criteriaGroup.op === "&" || !criteriaGroup.op ? false : true;
+  let hasIndeterminateClauses = false;
+  for (let index = criteriaGroup.clauses.length - 1; index >= 0; index--) {
+    const clause = criteriaGroup.clauses[index];
+    const criteriaResult = evaluateCriterion(clause, options);
+    if (criteriaResult === null) {
+      hasIndeterminateClauses = true;
+    } else if (criteriaResult === earlyExitResult) {
+      return earlyExitResult;
+    } else if (criteriaResult !== null && simplifyCriteria) {
+      criteriaGroup.clauses.splice(index, 1);
+    }
+  }
+  return hasIndeterminateClauses ? null : !earlyExitResult;
+}
+function evaluateCriterion(clause, rootOptions) {
+  if ("clauses" in clause) {
+    return evaluateVisibilityCriteriaGroup({
+      ...rootOptions,
+      criteriaGroup: clause
+    });
+  }
+  const rule = rootOptions.rules[clause.rule];
+  if (rule) {
+    return rule(clause);
+  }
+  return null;
+}
+
+// src/enhancement/visibility/types.ts
+var CANVAS_VIZ_CONTROL_PARAM = "$viz";
+
+// src/enhancement/visibility/evaluateNodeVisibility.ts
+function evaluateNodeVisibility({
+  node,
+  ...evaluateGroupOptions
+}) {
+  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({
+    ...evaluateGroupOptions,
+    criteriaGroup: vizCriteria.criteria
+  });
+  if (vizCriteria.criteria.clauses.length === 0 && evaluateGroupOptions.simplifyCriteria) {
+    properties == null ? true : delete properties[CANVAS_VIZ_CONTROL_PARAM];
+  }
+  return result;
+}
+
+// src/enhancement/visibility/evaluateWalkTreeVisibility.ts
+function evaluateWalkTreeVisibility({
+  rules,
+  showIndeterminate,
+  context
+}) {
+  const { type, node, actions } = context;
+  if (type !== "component") {
+    return;
+  }
+  const result = evaluateNodeVisibility({ node, rules, simplifyCriteria: true });
+  if (result === null && !showIndeterminate || result === false) {
+    actions.remove();
+    return false;
+  }
+  return true;
+}
+
+// src/enhancement/visibility/rules/evaluateStringMatch.ts
+var isEvaluator = (criteria, matchValue) => {
+  if (Array.isArray(criteria)) {
+    return criteria.includes(matchValue);
+  }
+  return criteria === matchValue;
+};
+var containsEvaluator = (criteria, matchValue) => {
+  if (Array.isArray(criteria)) {
+    return criteria.some((criterion) => matchValue.includes(criterion));
+  }
+  return matchValue.includes(criteria);
+};
+var startsWithEvaluator = (criteria, matchValue) => {
+  if (Array.isArray(criteria)) {
+    return criteria.some((criterion) => matchValue.startsWith(criterion));
+  }
+  return matchValue.startsWith(criteria);
+};
+var endsWithEvaluator = (criteria, matchValue) => {
+  if (Array.isArray(criteria)) {
+    return criteria.some((criterion) => matchValue.endsWith(criterion));
+  }
+  return matchValue.endsWith(criteria);
+};
+var emptyEvaluator = (_, matchValue) => {
+  return matchValue === "";
+};
+var stringOperatorEvaluators = {
+  is: isEvaluator,
+  has: containsEvaluator,
+  startswith: startsWithEvaluator,
+  endswith: endsWithEvaluator,
+  empty: emptyEvaluator
+};
+function evaluateStringMatch(criteria, matchValue, allow) {
+  const { op, value } = criteria;
+  if (allow && !allow.has(op)) {
+    return null;
+  }
+  let opMatch = op;
+  const negation = op.startsWith("!");
+  if (negation) {
+    opMatch = opMatch.slice(1);
+  }
+  const evaluator = stringOperatorEvaluators[opMatch];
+  if (!evaluator) {
+    return null;
+  }
+  const result = evaluator(value, matchValue);
+  return negation ? !result : result;
+}
+
+// src/enhancement/visibility/rules/dynamicInputVisibilityRule.ts
+var dynamicInputVisibilityOperators = /* @__PURE__ */ new Set([
+  "is",
+  "!is",
+  "has",
+  "!has",
+  "startswith",
+  "!startswith",
+  "endswith",
+  "!endswith",
+  "empty",
+  "!empty"
+]);
+var CANVAS_VIZ_DI_RULE = "$di";
+function createDynamicInputVisibilityRule(dynamicInputs) {
+  return {
+    [CANVAS_VIZ_DI_RULE]: (criterion) => {
+      const { source } = criterion;
+      const diValue = source ? dynamicInputs[source] : void 0;
+      return evaluateStringMatch(criterion, diValue != null ? diValue : "", dynamicInputVisibilityOperators);
+    }
+  };
+}
+
+// src/enhancement/visibility/rules/localeVisibilityRule.ts
+var localeVisibilityOperators = /* @__PURE__ */ new Set(["is", "!is"]);
+var CANVAS_VIZ_LOCALE_RULE = "$locale";
+function createLocaleVisibilityRule(currentLocale) {
+  return {
+    [CANVAS_VIZ_LOCALE_RULE]: (criterion) => {
+      if (!currentLocale) {
+        return false;
+      }
+      return evaluateStringMatch(criterion, currentLocale, localeVisibilityOperators);
+    }
+  };
+}
+
+// src/enhancement/visibility/rules/quirksRule.ts
+var quirksVisibilityOperators = /* @__PURE__ */ new Set([
+  "is",
+  "!is",
+  "has",
+  "!has",
+  "startswith",
+  "!startswith",
+  "endswith",
+  "!endswith",
+  "empty",
+  "!empty"
+]);
+var CANVAS_VIZ_QUIRKS_RULE = "$qk";
+function createQuirksVisibilityRule(quirks) {
+  return {
+    [CANVAS_VIZ_QUIRKS_RULE]: (criterion) => {
+      const { source } = criterion;
+      const quirkValue = source ? quirks[source] : void 0;
+      return evaluateStringMatch(criterion, quirkValue != null ? quirkValue : "", quirksVisibilityOperators);
+    }
+  };
+}
+
 // src/enhancement/localize.ts
 function extractLocales({ component }) {
   var _a;
@@ -1626,17 +1818,29 @@ function extractLocales({ component }) {
 function localize(options) {
   const nodes = "nodes" in options ? options.nodes : options.composition;
   const locale = options.locale;
-  walkNodeTree(nodes, ({ type, node, actions }) => {
+  const isUsingModernOptions = typeof locale === "string";
+  const vizControlLocaleRule = isUsingModernOptions ? createLocaleVisibilityRule(locale) : {};
+  walkNodeTree(nodes, (context) => {
+    const { type, node, actions } = context;
     if (type !== "component") {
-      if (typeof locale === "string") {
+      if (isUsingModernOptions) {
         localizeProperties(node.fields, locale);
       }
       return;
     }
-    const shouldRunPropertyLocalization = typeof locale === "string";
+    if (isUsingModernOptions) {
+      const result = evaluateWalkTreeVisibility({
+        context,
+        rules: vizControlLocaleRule,
+        showIndeterminate: true
+      });
+      if (!result) {
+        return;
+      }
+    }
     if (node.type === CANVAS_LOCALIZATION_TYPE) {
       const locales = extractLocales({ component: node });
-      const resolvedLocale = typeof locale === "string" ? locale : locale == null ? void 0 : locale({ component: node, locales });
+      const resolvedLocale = isUsingModernOptions ? locale : locale == null ? void 0 : locale({ component: node, locales });
       let replaceComponent;
       if (resolvedLocale) {
         replaceComponent = locales[resolvedLocale];
@@ -1644,7 +1848,7 @@ function localize(options) {
       if (replaceComponent == null ? void 0 : replaceComponent.length) {
         replaceComponent.forEach((component) => {
           removeLocaleProperty(component);
-          if (shouldRunPropertyLocalization) {
+          if (isUsingModernOptions) {
             localizeProperties(getPropertiesValue(component), locale);
           }
         });
@@ -1656,7 +1860,7 @@ function localize(options) {
       } else {
         actions.remove();
       }
-    } else if (shouldRunPropertyLocalization) {
+    } else if (isUsingModernOptions) {
       localizeProperties(getPropertiesValue(node), locale);
     }
   });
@@ -1950,6 +2154,9 @@ var isRequestComponentSuggestionMessage = (message) => {
 var isSuggestComponentMessage = (message) => {
   return message.type === "suggest-component";
 };
+var isContextStorageUpdatedMessage = (message) => {
+  return message.type === "context-storage-command-executed";
+};
 var createCanvasChannel = ({
   listenTo,
   broadcastTo
@@ -2130,6 +2337,13 @@ var createCanvasChannel = ({
     };
     postMessage(message);
   };
+  const contextStorageUpdated = (options) => {
+    const message = {
+      ...options,
+      type: "context-storage-command-executed"
+    };
+    postMessage(message);
+  };
   const messageEventListener = (event) => {
     if (typeof event.data !== "string") {
       return;
@@ -2179,7 +2393,8 @@ var createCanvasChannel = ({
     editorStateUpdated,
     updateComponentReferences,
     requestComponentSuggestion,
-    suggestComponent
+    suggestComponent,
+    contextStorageUpdated
   };
 };
 
@@ -2810,6 +3025,10 @@ export {
   CANVAS_TEST_SLOT,
   CANVAS_TEST_TYPE,
   CANVAS_TEST_VARIANT_PARAM,
+  CANVAS_VIZ_CONTROL_PARAM,
+  CANVAS_VIZ_DI_RULE,
+  CANVAS_VIZ_LOCALE_RULE,
+  CANVAS_VIZ_QUIRKS_RULE,
   CanvasClient,
   CanvasClientError,
   CategoryClient,
@@ -2851,11 +3070,16 @@ export {
   convertEntryToPutEntry,
   createBatchEnhancer,
   createCanvasChannel,
+  createDynamicInputVisibilityRule,
   createEventBus,
   createLimitPolicy,
+  createLocaleVisibilityRule,
+  createQuirksVisibilityRule,
   createUniformApiEnhancer,
   createVariableReference,
   enhance,
+  evaluateVisibilityCriteriaGroup,
+  evaluateWalkTreeVisibility,
   extractLocales,
   findParameterInNodeTree,
   flattenValues,
@@ -2877,6 +3101,7 @@ export {
   isAssetParamValueItem,
   isComponentActionMessage,
   isComponentPlaceholderId,
+  isContextStorageUpdatedMessage,
   isDismissPlaceholderMessage,
   isEntryData,
   isMovingComponentMessage,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/canvas",
-  "version": "19.161.2-alpha.1+d59167950a",
+  "version": "19.162.2-alpha.11+5544f3f2ca",
   "description": "Common functionality and types for Uniform Canvas",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -38,8 +38,8 @@
     "pusher-js": "8.2.0"
   },
   "dependencies": {
-    "@uniformdev/assets": "19.161.2-alpha.1+d59167950a",
-    "@uniformdev/context": "19.161.2-alpha.1+d59167950a",
+    "@uniformdev/assets": "19.162.2-alpha.11+5544f3f2ca",
+    "@uniformdev/context": "19.162.2-alpha.11+5544f3f2ca",
     "immer": "10.0.4"
   },
   "files": [
@@ -48,5 +48,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d59167950aa13607d01052f435e2e6b440e8cee6"
+  "gitHead": "5544f3f2ca31829767dbe8511c21b1192a811443"
 }