@uniformdev/canvas 19.159.0 → 19.159.1-alpha.27

package/dist/index.esm.js

@@ -4,6 +4,9 @@ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
 var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __typeError = (msg) => {
+  throw TypeError(msg);
+};
 var __commonJS = (cb, mod) => function __require() {
   return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
 };
@@ -23,19 +26,9 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
   isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
   mod
 ));
-var __accessCheck = (obj, member, msg) => {
-  if (!member.has(obj))
-    throw TypeError("Cannot " + msg);
-};
-var __privateGet = (obj, member, getter) => {
-  __accessCheck(obj, member, "read from private field");
-  return getter ? getter.call(obj) : member.get(obj);
-};
-var __privateAdd = (obj, member, value) => {
-  if (member.has(obj))
-    throw TypeError("Cannot add the same private member more than once");
-  member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
-};
+var __accessCheck = (obj, member, msg) => member.has(obj) || __typeError("Cannot " + msg);
+var __privateGet = (obj, member, getter) => (__accessCheck(obj, member, "read from private field"), getter ? getter.call(obj) : member.get(obj));
+var __privateAdd = (obj, member, value) => member.has(obj) ? __typeError("Cannot add the same private member more than once") : member instanceof WeakSet ? member.add(obj) : member.set(obj, value);
 
 // ../../node_modules/.pnpm/retry@0.13.1/node_modules/retry/lib/retry_operation.js
 var require_retry_operation = __commonJS({
@@ -1050,8 +1043,7 @@ function walkNodeTree(node, visitor, options) {
   const childContexts = /* @__PURE__ */ new Map();
   do {
     const currentQueueEntry = componentQueue.pop();
-    if (!currentQueueEntry)
-      continue;
+    if (!currentQueueEntry) continue;
     const currentComponent = currentQueueEntry.ancestorsAndSelf[0];
     let visitDescendants = true;
     let descendantContext = (_a = childContexts.get(currentComponent.node)) != null ? _a : currentQueueEntry.context;
@@ -1262,8 +1254,7 @@ 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;
         const blocks = (_b = propObject.value) != null ? _b : [];
         for (let blockIndex = blocks.length - 1; blockIndex >= 0; blockIndex--) {
           const enqueueingBlock = blocks[blockIndex];
@@ -1608,6 +1599,174 @@ 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/localize.ts
 function extractLocales({ component }) {
   var _a;
@@ -1626,17 +1785,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 +1815,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 +1827,7 @@ function localize(options) {
       } else {
         actions.remove();
       }
-    } else if (shouldRunPropertyLocalization) {
+    } else if (isUsingModernOptions) {
       localizeProperties(getPropertiesValue(node), locale);
     }
   });
@@ -1735,8 +1906,7 @@ function walkComponentTree(component, visitor, initialContext) {
   const childContexts = /* @__PURE__ */ new Map();
   do {
     const currentQueueEntry = componentQueue.pop();
-    if (!currentQueueEntry)
-      continue;
+    if (!currentQueueEntry) continue;
     const currentComponent = currentQueueEntry.ancestorsAndSelf[0];
     let visitDescendants = true;
     let descendantContext = (_a = childContexts.get(currentComponent.component)) != null ? _a : currentQueueEntry.context;
@@ -1841,10 +2011,25 @@ function walkComponentTree(component, visitor, initialContext) {
   } while (componentQueue.length > 0);
 }
 
-// src/LocaleClient.ts
+// src/EntityReleasesClient.ts
 import { ApiClient as ApiClient6 } from "@uniformdev/context/api";
+var releaseContentsUrl = "/api/v1/entity-releases";
+var EntityReleasesClient = class extends ApiClient6 {
+  constructor(options) {
+    super(options);
+  }
+  /** Fetches entity across all releases (and base) */
+  async get(options) {
+    const { projectId } = this.options;
+    const fetchUri = this.createUrl(releaseContentsUrl, { ...options, projectId });
+    return await this.apiClient(fetchUri);
+  }
+};
+
+// src/LocaleClient.ts
+import { ApiClient as ApiClient7 } from "@uniformdev/context/api";
 var localesUrl = "/api/v1/locales";
-var LocaleClient = class extends ApiClient6 {
+var LocaleClient = class extends ApiClient7 {
   constructor(options) {
     super(options);
   }
@@ -2262,9 +2447,9 @@ function subscribeToComposition({
 }
 
 // src/PromptClient.ts
-import { ApiClient as ApiClient7 } from "@uniformdev/context/api";
+import { ApiClient as ApiClient8 } from "@uniformdev/context/api";
 var PromptsUrl = "/api/v1/prompts";
-var PromptClient = class extends ApiClient7 {
+var PromptClient = class extends ApiClient8 {
   constructor(options) {
     super(options);
   }
@@ -2295,9 +2480,9 @@ var PromptClient = class extends ApiClient7 {
 };
 
 // src/RelationshipClient.ts
-import { ApiClient as ApiClient8 } from "@uniformdev/context/api";
+import { ApiClient as ApiClient9 } from "@uniformdev/context/api";
 var RELATIONSHIPS_URL = "/api/v1/relationships";
-var RelationshipClient = class extends ApiClient8 {
+var RelationshipClient = class extends ApiClient9 {
   constructor(options) {
     super(options);
     this.get = async (options) => {
@@ -2309,9 +2494,9 @@ var RelationshipClient = class extends ApiClient8 {
 };
 
 // src/ReleaseClient.ts
-import { ApiClient as ApiClient9 } from "@uniformdev/context/api";
+import { ApiClient as ApiClient10 } from "@uniformdev/context/api";
 var releasesUrl = "/api/v1/releases";
-var ReleaseClient = class extends ApiClient9 {
+var ReleaseClient = class extends ApiClient10 {
   constructor(options) {
     super(options);
   }
@@ -2351,21 +2536,21 @@ var ReleaseClient = class extends ApiClient9 {
 };
 
 // src/ReleaseContentsClient.ts
-import { ApiClient as ApiClient10 } from "@uniformdev/context/api";
-var releaseContentsUrl = "/api/v1/release-contents";
-var ReleaseContentsClient = class extends ApiClient10 {
+import { ApiClient as ApiClient11 } from "@uniformdev/context/api";
+var releaseContentsUrl2 = "/api/v1/release-contents";
+var ReleaseContentsClient = class extends ApiClient11 {
   constructor(options) {
     super(options);
   }
   /** Fetches all entities added to a release */
   async get(options) {
     const { projectId } = this.options;
-    const fetchUri = this.createUrl(releaseContentsUrl, { ...options, projectId });
+    const fetchUri = this.createUrl(releaseContentsUrl2, { ...options, projectId });
     return await this.apiClient(fetchUri);
   }
   /** Removes a release content from a release */
   async remove(body) {
-    const fetchUri = this.createUrl(releaseContentsUrl);
+    const fetchUri = this.createUrl(releaseContentsUrl2);
     await this.apiClient(fetchUri, {
       method: "DELETE",
       body: JSON.stringify({ ...body, projectId: this.options.projectId }),
@@ -2375,9 +2560,9 @@ var ReleaseContentsClient = class extends ApiClient10 {
 };
 
 // src/RouteClient.ts
-import { ApiClient as ApiClient11 } from "@uniformdev/context/api";
+import { ApiClient as ApiClient12 } from "@uniformdev/context/api";
 var ROUTE_URL = "/api/v1/route";
-var RouteClient = class extends ApiClient11 {
+var RouteClient = class extends ApiClient12 {
   constructor(options) {
     var _a;
     if (!options.limitPolicy) {
@@ -2488,8 +2673,7 @@ var isSystemComponentDefinition = (componentType) => {
 
 // src/utils/mapSlotToPersonalizedVariations.ts
 function mapSlotToPersonalizedVariations(slot) {
-  if (!slot)
-    return [];
+  if (!slot) return [];
   return slot.map((v, i) => {
     var _a, _b;
     const contextTag = (_b = (_a = v.parameters) == null ? void 0 : _a[CANVAS_PERSONALIZATION_PARAM]) == null ? void 0 : _b.value;
@@ -2504,8 +2688,7 @@ function mapSlotToPersonalizedVariations(slot) {
 
 // src/utils/mapSlotToTestVariations.ts
 function mapSlotToTestVariations(slot) {
-  if (!slot)
-    return [];
+  if (!slot) return [];
   return slot.map((v, i) => {
     var _a, _b, _c;
     const contextTag = (_b = (_a = v.parameters) == null ? void 0 : _a[CANVAS_TEST_VARIANT_PARAM]) == null ? void 0 : _b.value;
@@ -2747,9 +2930,9 @@ function handleRichTextNodeBinding(object, options) {
 import { ApiClientError as ApiClientError2 } from "@uniformdev/context/api";
 
 // src/WorkflowClient.ts
-import { ApiClient as ApiClient12 } from "@uniformdev/context/api";
+import { ApiClient as ApiClient13 } from "@uniformdev/context/api";
 var workflowsUrl = "/api/v1/workflows";
-var WorkflowClient = class extends ApiClient12 {
+var WorkflowClient = class extends ApiClient13 {
   constructor(options) {
     super(options);
   }
@@ -2810,6 +2993,9 @@ export {
   CANVAS_TEST_SLOT,
   CANVAS_TEST_TYPE,
   CANVAS_TEST_VARIANT_PARAM,
+  CANVAS_VIZ_CONTROL_PARAM,
+  CANVAS_VIZ_DI_RULE,
+  CANVAS_VIZ_LOCALE_RULE,
   CanvasClient,
   CanvasClientError,
   CategoryClient,
@@ -2823,6 +3009,7 @@ export {
   EDGE_MIN_CACHE_TTL,
   EMPTY_COMPOSITION,
   EnhancerBuilder,
+  EntityReleasesClient,
   IN_CONTEXT_EDITOR_COMPONENT_END_ROLE,
   IN_CONTEXT_EDITOR_COMPONENT_START_ROLE,
   IN_CONTEXT_EDITOR_CONFIG_CHECK_QUERY_STRING_PARAM,
@@ -2851,11 +3038,15 @@ export {
   convertEntryToPutEntry,
   createBatchEnhancer,
   createCanvasChannel,
+  createDynamicInputVisibilityRule,
   createEventBus,
   createLimitPolicy,
+  createLocaleVisibilityRule,
   createUniformApiEnhancer,
   createVariableReference,
   enhance,
+  evaluateVisibilityCriteriaGroup,
+  evaluateWalkTreeVisibility,
   extractLocales,
   findParameterInNodeTree,
   flattenValues,