@uniformdev/canvas 19.159.0 → 19.159.1-alpha.27

package/dist/index.js

@@ -5,6 +5,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;
 };
@@ -29,19 +32,9 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
   mod
 ));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), 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({
@@ -286,7 +279,7 @@ __export(src_exports, {
   ATTRIBUTE_PARAMETER_TYPE: () => ATTRIBUTE_PARAMETER_TYPE,
   ATTRIBUTE_PARAMETER_VALUE: () => ATTRIBUTE_PARAMETER_VALUE,
   ATTRIBUTE_PLACEHOLDER: () => ATTRIBUTE_PLACEHOLDER,
-  ApiClientError: () => import_api14.ApiClientError,
+  ApiClientError: () => import_api15.ApiClientError,
   BatchEntry: () => BatchEntry,
   CANVAS_BLOCK_PARAM_TYPE: () => CANVAS_BLOCK_PARAM_TYPE,
   CANVAS_DRAFT_STATE: () => CANVAS_DRAFT_STATE,
@@ -305,6 +298,9 @@ __export(src_exports, {
   CANVAS_TEST_SLOT: () => CANVAS_TEST_SLOT,
   CANVAS_TEST_TYPE: () => CANVAS_TEST_TYPE,
   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_LOCALE_RULE: () => CANVAS_VIZ_LOCALE_RULE,
   CanvasClient: () => CanvasClient,
   CanvasClientError: () => CanvasClientError,
   CategoryClient: () => CategoryClient,
@@ -318,6 +314,7 @@ __export(src_exports, {
   EDGE_MIN_CACHE_TTL: () => EDGE_MIN_CACHE_TTL,
   EMPTY_COMPOSITION: () => EMPTY_COMPOSITION,
   EnhancerBuilder: () => EnhancerBuilder,
+  EntityReleasesClient: () => EntityReleasesClient,
   IN_CONTEXT_EDITOR_COMPONENT_END_ROLE: () => IN_CONTEXT_EDITOR_COMPONENT_END_ROLE,
   IN_CONTEXT_EDITOR_COMPONENT_START_ROLE: () => IN_CONTEXT_EDITOR_COMPONENT_START_ROLE,
   IN_CONTEXT_EDITOR_CONFIG_CHECK_QUERY_STRING_PARAM: () => IN_CONTEXT_EDITOR_CONFIG_CHECK_QUERY_STRING_PARAM,
@@ -346,11 +343,15 @@ __export(src_exports, {
   convertEntryToPutEntry: () => convertEntryToPutEntry,
   createBatchEnhancer: () => createBatchEnhancer,
   createCanvasChannel: () => createCanvasChannel,
+  createDynamicInputVisibilityRule: () => createDynamicInputVisibilityRule,
   createEventBus: () => createEventBus,
   createLimitPolicy: () => createLimitPolicy,
+  createLocaleVisibilityRule: () => createLocaleVisibilityRule,
   createUniformApiEnhancer: () => createUniformApiEnhancer,
   createVariableReference: () => createVariableReference,
   enhance: () => enhance,
+  evaluateVisibilityCriteriaGroup: () => evaluateVisibilityCriteriaGroup,
+  evaluateWalkTreeVisibility: () => evaluateWalkTreeVisibility,
   extractLocales: () => extractLocales,
   findParameterInNodeTree: () => findParameterInNodeTree,
   flattenValues: () => flattenValues,
@@ -1187,8 +1188,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;
@@ -1399,8 +1399,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];
@@ -1745,6 +1744,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;
@@ -1763,17 +1930,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];
@@ -1781,7 +1960,7 @@ function localize(options) {
       if (replaceComponent == null ? void 0 : replaceComponent.length) {
         replaceComponent.forEach((component) => {
           removeLocaleProperty(component);
-          if (shouldRunPropertyLocalization) {
+          if (isUsingModernOptions) {
             localizeProperties(getPropertiesValue(component), locale);
           }
         });
@@ -1793,7 +1972,7 @@ function localize(options) {
       } else {
         actions.remove();
       }
-    } else if (shouldRunPropertyLocalization) {
+    } else if (isUsingModernOptions) {
       localizeProperties(getPropertiesValue(node), locale);
     }
   });
@@ -1872,8 +2051,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;
@@ -1978,10 +2156,25 @@ function walkComponentTree(component, visitor, initialContext) {
   } while (componentQueue.length > 0);
 }
 
-// src/LocaleClient.ts
+// src/EntityReleasesClient.ts
 var import_api7 = require("@uniformdev/context/api");
+var releaseContentsUrl = "/api/v1/entity-releases";
+var EntityReleasesClient = class extends import_api7.ApiClient {
+  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
+var import_api8 = require("@uniformdev/context/api");
 var localesUrl = "/api/v1/locales";
-var LocaleClient = class extends import_api7.ApiClient {
+var LocaleClient = class extends import_api8.ApiClient {
   constructor(options) {
     super(options);
   }
@@ -2399,9 +2592,9 @@ function subscribeToComposition({
 }
 
 // src/PromptClient.ts
-var import_api8 = require("@uniformdev/context/api");
+var import_api9 = require("@uniformdev/context/api");
 var PromptsUrl = "/api/v1/prompts";
-var PromptClient = class extends import_api8.ApiClient {
+var PromptClient = class extends import_api9.ApiClient {
   constructor(options) {
     super(options);
   }
@@ -2432,9 +2625,9 @@ var PromptClient = class extends import_api8.ApiClient {
 };
 
 // src/RelationshipClient.ts
-var import_api9 = require("@uniformdev/context/api");
+var import_api10 = require("@uniformdev/context/api");
 var RELATIONSHIPS_URL = "/api/v1/relationships";
-var RelationshipClient = class extends import_api9.ApiClient {
+var RelationshipClient = class extends import_api10.ApiClient {
   constructor(options) {
     super(options);
     this.get = async (options) => {
@@ -2446,9 +2639,9 @@ var RelationshipClient = class extends import_api9.ApiClient {
 };
 
 // src/ReleaseClient.ts
-var import_api10 = require("@uniformdev/context/api");
+var import_api11 = require("@uniformdev/context/api");
 var releasesUrl = "/api/v1/releases";
-var ReleaseClient = class extends import_api10.ApiClient {
+var ReleaseClient = class extends import_api11.ApiClient {
   constructor(options) {
     super(options);
   }
@@ -2488,21 +2681,21 @@ var ReleaseClient = class extends import_api10.ApiClient {
 };
 
 // src/ReleaseContentsClient.ts
-var import_api11 = require("@uniformdev/context/api");
-var releaseContentsUrl = "/api/v1/release-contents";
-var ReleaseContentsClient = class extends import_api11.ApiClient {
+var import_api12 = require("@uniformdev/context/api");
+var releaseContentsUrl2 = "/api/v1/release-contents";
+var ReleaseContentsClient = class extends import_api12.ApiClient {
   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 }),
@@ -2512,9 +2705,9 @@ var ReleaseContentsClient = class extends import_api11.ApiClient {
 };
 
 // src/RouteClient.ts
-var import_api12 = require("@uniformdev/context/api");
+var import_api13 = require("@uniformdev/context/api");
 var ROUTE_URL = "/api/v1/route";
-var RouteClient = class extends import_api12.ApiClient {
+var RouteClient = class extends import_api13.ApiClient {
   constructor(options) {
     var _a;
     if (!options.limitPolicy) {
@@ -2625,8 +2818,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;
@@ -2641,8 +2833,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;
@@ -2881,12 +3072,12 @@ function handleRichTextNodeBinding(object, options) {
 }
 
 // src/index.ts
-var import_api14 = require("@uniformdev/context/api");
+var import_api15 = require("@uniformdev/context/api");
 
 // src/WorkflowClient.ts
-var import_api13 = require("@uniformdev/context/api");
+var import_api14 = require("@uniformdev/context/api");
 var workflowsUrl = "/api/v1/workflows";
-var WorkflowClient = class extends import_api13.ApiClient {
+var WorkflowClient = class extends import_api14.ApiClient {
   constructor(options) {
     super(options);
   }
@@ -2917,7 +3108,7 @@ var WorkflowClient = class extends import_api13.ApiClient {
 };
 
 // src/index.ts
-var CanvasClientError = import_api14.ApiClientError;
+var CanvasClientError = import_api15.ApiClientError;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   ASSETS_SOURCE_CUSTOM_URL,
@@ -2948,6 +3139,9 @@ var CanvasClientError = import_api14.ApiClientError;
   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,
@@ -2961,6 +3155,7 @@ var CanvasClientError = import_api14.ApiClientError;
   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,
@@ -2989,11 +3184,15 @@ var CanvasClientError = import_api14.ApiClientError;
   convertEntryToPutEntry,
   createBatchEnhancer,
   createCanvasChannel,
+  createDynamicInputVisibilityRule,
   createEventBus,
   createLimitPolicy,
+  createLocaleVisibilityRule,
   createUniformApiEnhancer,
   createVariableReference,
   enhance,
+  evaluateVisibilityCriteriaGroup,
+  evaluateWalkTreeVisibility,
   extractLocales,
   findParameterInNodeTree,
   flattenValues,