@uniformdev/canvas 20.6.5-alpha.1 → 20.7.1-alpha.106

package/dist/index.esm.js

@@ -624,7 +624,7 @@ var CanvasClient = class extends ApiClient {
     const edgeParams = {
       ...originParams,
       projectId,
-      ...params.diagnostics ? { diagnostics: "true" } : {},
+      diagnostics: typeof params.diagnostics === "boolean" ? params.diagnostics : params.diagnostics === "no-data" ? "no-data" : void 0,
       ...rewrittenFilters
     };
     const edgeUrl = this.createUrl("/api/v1/compositions", edgeParams, this.edgeApiHost);
@@ -665,18 +665,23 @@ var CanvasClient = class extends ApiClient {
     const edgeParams = {
       ...params,
       projectId,
-      ...diagnostics ? { diagnostics: "true" } : {}
+      diagnostics: typeof diagnostics === "boolean" ? diagnostics : diagnostics === "no-data" ? "no-data" : void 0
     };
     const edgeUrl = this.createUrl("/api/v1/composition", edgeParams, this.edgeApiHost);
     return this.apiClient(edgeUrl, this.edgeApiRequestInit);
   }
   /** Updates or creates a Canvas component definition */
-  async updateComposition(body) {
+  async updateComposition(body, options) {
     const fetchUri = this.createUrl(CANVAS_URL);
+    const headers = {};
+    if (options == null ? void 0 : options.ifUnmodifiedSince) {
+      headers["x-if-unmodified-since"] = options.ifUnmodifiedSince;
+    }
     const { response } = await this.apiClientWithResponse(fetchUri, {
       method: "PUT",
       body: JSON.stringify({ ...body, projectId: this.options.projectId }),
-      expectNoContent: true
+      expectNoContent: true,
+      headers
     });
     return { modified: response.headers.get("x-modified-at") };
   }
@@ -816,12 +821,17 @@ var _ContentClient = class _ContentClient extends ApiClient3 {
       headers: opts.autogenerateDataTypes ? { "x-uniform-autogenerate-data-types": "true" } : {}
     });
   }
-  async upsertEntry(body) {
+  async upsertEntry(body, options) {
     const fetchUri = this.createUrl(__privateGet(_ContentClient, _entriesUrl));
+    const headers = {};
+    if (options == null ? void 0 : options.ifUnmodifiedSince) {
+      headers["x-if-unmodified-since"] = options.ifUnmodifiedSince;
+    }
     const { response } = await this.apiClientWithResponse(fetchUri, {
       method: "PUT",
       body: JSON.stringify({ ...body, projectId: this.options.projectId }),
-      expectNoContent: true
+      expectNoContent: true,
+      headers
     });
     return { modified: response.headers.get("x-modified-at") };
   }
@@ -847,7 +857,7 @@ var _ContentClient = class _ContentClient extends ApiClient3 {
     return {
       projectId,
       ...params,
-      diagnostics: (options == null ? void 0 : options.diagnostics) ? "true" : void 0
+      diagnostics: typeof options.diagnostics === "boolean" ? options.diagnostics : options.diagnostics === "no-data" ? "no-data" : void 0
     };
   }
 };
@@ -1075,6 +1085,10 @@ var CANVAS_DRAFT_STATE = 0;
 var CANVAS_PUBLISHED_STATE = 64;
 var CANVAS_EDITOR_STATE = 63;
 var CANVAS_PERSONALIZATION_PARAM = "$pzCrit";
+var CANVAS_PERSONALIZATION_EVENT_NAME_PARAM = "trackingEventName";
+var CANVAS_PERSONALIZATION_ALGORITHM_PARAM = "algorithm";
+var CANVAS_PERSONALIZATION_ALGORITHM_TYPE = "pzAlgorithm";
+var CANVAS_PERSONALIZATION_TAKE_PARAM = "count";
 var CANVAS_TEST_VARIANT_PARAM = "$tstVrnt";
 var CANVAS_ENRICHMENT_TAG_PARAM = "$enr";
 var CANVAS_CONTEXTUAL_EDITING_PARAM = "$contextualEditing";
@@ -2089,15 +2103,19 @@ function evaluateNodeVisibility({
 function evaluateWalkTreeNodeVisibility({
   rules,
   showIndeterminate,
+  rootNodeInvisibleHandling = "throw",
   context
 }) {
-  const { type, node, actions } = context;
+  const { type, node, actions, ancestorsAndSelf } = context;
   if (type !== "component") {
     return;
   }
   const result = evaluateNodeVisibility({ node, rules, simplifyCriteria: true });
   if (result === null && !showIndeterminate || result === false) {
-    actions.remove();
+    if (ancestorsAndSelf.length === 1 && rootNodeInvisibleHandling === "ignore") {
+    } else {
+      actions.remove();
+    }
     return false;
   }
   return true;
@@ -2333,25 +2351,24 @@ function extractLocales({ component }) {
 function localize(options) {
   const nodes = options.nodes;
   const locale = options.locale;
-  const isUsingModernOptions = typeof locale === "string";
-  const vizControlLocaleRule = isUsingModernOptions ? createLocaleVisibilityRule(locale) : {};
+  if (!locale) {
+    return;
+  }
+  const vizControlLocaleRule = createLocaleVisibilityRule(locale);
   walkNodeTree(nodes, (context) => {
     const { type, node, actions } = context;
     if (type !== "component") {
-      if (isUsingModernOptions) {
-        localizeProperties(node, locale, vizControlLocaleRule);
-      }
+      localizeProperties(node, locale, vizControlLocaleRule);
       return;
     }
-    if (isUsingModernOptions) {
-      const result = evaluateWalkTreeNodeVisibility({
-        context,
-        rules: vizControlLocaleRule,
-        showIndeterminate: true
-      });
-      if (!result) {
-        return;
-      }
+    const result = evaluateWalkTreeNodeVisibility({
+      context,
+      rules: vizControlLocaleRule,
+      showIndeterminate: true,
+      rootNodeInvisibleHandling: "ignore"
+    });
+    if (!result) {
+      return;
     }
     if (node.type === CANVAS_LOCALIZATION_TYPE) {
       const locales = extractLocales({ component: node });
@@ -2362,9 +2379,7 @@ function localize(options) {
       if (replaceComponent == null ? void 0 : replaceComponent.length) {
         replaceComponent.forEach((component) => {
           removeLocaleProperty(component);
-          if (isUsingModernOptions) {
-            localizeProperties(component, locale, vizControlLocaleRule);
-          }
+          localizeProperties(component, locale, vizControlLocaleRule);
         });
         const [first, ...rest] = replaceComponent;
         actions.replace(first);
@@ -2374,7 +2389,7 @@ function localize(options) {
       } else {
         actions.remove();
       }
-    } else if (isUsingModernOptions) {
+    } else {
       localizeProperties(node, locale, vizControlLocaleRule);
     }
   });
@@ -2498,10 +2513,55 @@ var EntityReleasesClient = class extends ApiClient6 {
   }
 };
 
-// src/LocaleClient.ts
+// src/IntegrationPropertyEditorsClient.ts
 import { ApiClient as ApiClient7 } from "@uniformdev/context/api";
+var _baseUrl;
+var _IntegrationPropertyEditorsClient = class _IntegrationPropertyEditorsClient extends ApiClient7 {
+  constructor(options) {
+    super(options);
+    this.teamId = options.teamId;
+  }
+  /**
+   * Gets a list of property type and hook names for the current team, including public integrations' hooks.
+   */
+  get(options) {
+    const fetchUri = this.createUrl(__privateGet(_IntegrationPropertyEditorsClient, _baseUrl), {
+      ...options,
+      teamId: this.teamId
+    });
+    return this.apiClient(fetchUri);
+  }
+  /**
+   * Creates or updates a custom AI property editor on a Mesh app.
+   */
+  async deploy(body) {
+    const fetchUri = this.createUrl(__privateGet(_IntegrationPropertyEditorsClient, _baseUrl));
+    await this.apiClient(fetchUri, {
+      method: "PUT",
+      body: JSON.stringify({ ...body, teamId: this.teamId }),
+      expectNoContent: true
+    });
+  }
+  /**
+   * Removes a custom AI property editor from a Mesh app.
+   */
+  async delete(body) {
+    const fetchUri = this.createUrl(__privateGet(_IntegrationPropertyEditorsClient, _baseUrl));
+    await this.apiClient(fetchUri, {
+      method: "DELETE",
+      body: JSON.stringify({ ...body, teamId: this.teamId }),
+      expectNoContent: true
+    });
+  }
+};
+_baseUrl = new WeakMap();
+__privateAdd(_IntegrationPropertyEditorsClient, _baseUrl, "/api/v1/integration-property-editors");
+var IntegrationPropertyEditorsClient = _IntegrationPropertyEditorsClient;
+
+// src/LocaleClient.ts
+import { ApiClient as ApiClient8 } from "@uniformdev/context/api";
 var localesUrl = "/api/v1/locales";
-var LocaleClient = class extends ApiClient7 {
+var LocaleClient = class extends ApiClient8 {
   constructor(options) {
     super(options);
   }
@@ -2586,6 +2646,9 @@ var isUpdatePreviewSettingsMessage = (message) => {
 var isUpdateFeatureFlagsMessage = (message) => {
   return message.type === "update-feature-flags";
 };
+var isUpdateAiActionsMessage = (message) => {
+  return message.type === "update-ai-actions";
+};
 var isUpdateContextualEditingStateInternalMessage = (message) => {
   return message.type === "update-contextual-editing-state-internal";
 };
@@ -2634,17 +2697,19 @@ var createCanvasChannel = ({
     postMessage(message);
   };
   const ready = (options) => {
-    var _a, _b;
+    var _a, _b, _c;
     if (typeof window === "undefined") {
       return;
     }
     const framework = (_a = window.__UNIFORM_CONTEXTUAL_EDITING__) == null ? void 0 : _a.framework;
-    const version = (_b = window.__UNIFORM_CONTEXTUAL_EDITING__) == null ? void 0 : _b.version;
+    const version2 = (_b = window.__UNIFORM_CONTEXTUAL_EDITING__) == null ? void 0 : _b.version;
+    const canvasPackageVersion = (_c = window.__UNIFORM_CONTEXTUAL_EDITING__) == null ? void 0 : _c.canvasPackageVersion;
     const message = {
       type: "ready",
       framework,
-      version,
-      rsc: options == null ? void 0 : options.rsc
+      version: version2,
+      rsc: options == null ? void 0 : options.rsc,
+      canvasPackageVersion
     };
     postMessage(message);
   };
@@ -2804,6 +2869,13 @@ var createCanvasChannel = ({
     };
     postMessage(message);
   };
+  const updateAiActions = (options) => {
+    const message = {
+      ...options,
+      type: "update-ai-actions"
+    };
+    postMessage(message);
+  };
   const contextStorageUpdated = (options) => {
     const message = {
       ...options,
@@ -2853,6 +2925,7 @@ var createCanvasChannel = ({
     triggerCompositionAction,
     updatePreviewSettings,
     updateFeatureFlags,
+    updateAiActions,
     updateContextualEditingStateInternal,
     selectParameter,
     openParameterEditor,
@@ -2868,10 +2941,10 @@ var createCanvasChannel = ({
 };
 
 // src/PreviewClient.ts
-import { ApiClient as ApiClient8 } from "@uniformdev/context/api";
+import { ApiClient as ApiClient9 } from "@uniformdev/context/api";
 var previewUrlsUrl = "/api/v1/preview-urls";
 var previewViewportsUrl = "/api/v1/preview-viewports";
-var PreviewClient = class extends ApiClient8 {
+var PreviewClient = class extends ApiClient9 {
   constructor(options) {
     super(options);
   }
@@ -2933,10 +3006,44 @@ var PreviewClient = class extends ApiClient8 {
   }
 };
 
+// src/ProjectClient.ts
+import { ApiClient as ApiClient10 } from "@uniformdev/context/api";
+var _url2;
+var _ProjectClient = class _ProjectClient extends ApiClient10 {
+  constructor(options) {
+    super({ ...options, bypassCache: true });
+  }
+  /** Fetches single Project */
+  async get(options) {
+    const fetchUri = this.createUrl(__privateGet(_ProjectClient, _url2), { ...options });
+    return await this.apiClient(fetchUri);
+  }
+  /** Updates or creates (based on id) a Project */
+  async upsert(body) {
+    const fetchUri = this.createUrl(__privateGet(_ProjectClient, _url2));
+    return await this.apiClient(fetchUri, {
+      method: "PUT",
+      body: JSON.stringify({ ...body })
+    });
+  }
+  /** Deletes a Project */
+  async delete(body) {
+    const fetchUri = this.createUrl(__privateGet(_ProjectClient, _url2));
+    await this.apiClient(fetchUri, {
+      method: "DELETE",
+      body: JSON.stringify({ ...body }),
+      expectNoContent: true
+    });
+  }
+};
+_url2 = new WeakMap();
+__privateAdd(_ProjectClient, _url2, "/api/v1/project");
+var ProjectClient = _ProjectClient;
+
 // src/PromptClient.ts
-import { ApiClient as ApiClient9 } from "@uniformdev/context/api";
+import { ApiClient as ApiClient11 } from "@uniformdev/context/api";
 var PromptsUrl = "/api/v1/prompts";
-var PromptClient = class extends ApiClient9 {
+var PromptClient = class extends ApiClient11 {
   constructor(options) {
     super(options);
   }
@@ -2967,9 +3074,9 @@ var PromptClient = class extends ApiClient9 {
 };
 
 // src/RelationshipClient.ts
-import { ApiClient as ApiClient10 } from "@uniformdev/context/api";
+import { ApiClient as ApiClient12 } from "@uniformdev/context/api";
 var RELATIONSHIPS_URL = "/api/v1/relationships";
-var RelationshipClient = class extends ApiClient10 {
+var RelationshipClient = class extends ApiClient12 {
   constructor(options) {
     super(options);
     this.get = async (options) => {
@@ -2981,9 +3088,9 @@ var RelationshipClient = class extends ApiClient10 {
 };
 
 // src/ReleaseClient.ts
-import { ApiClient as ApiClient11 } from "@uniformdev/context/api";
+import { ApiClient as ApiClient13 } from "@uniformdev/context/api";
 var releasesUrl = "/api/v1/releases";
-var ReleaseClient = class extends ApiClient11 {
+var ReleaseClient = class extends ApiClient13 {
   constructor(options) {
     super(options);
   }
@@ -3023,9 +3130,9 @@ var ReleaseClient = class extends ApiClient11 {
 };
 
 // src/ReleaseContentsClient.ts
-import { ApiClient as ApiClient12 } from "@uniformdev/context/api";
+import { ApiClient as ApiClient14 } from "@uniformdev/context/api";
 var releaseContentsUrl2 = "/api/v1/release-contents";
-var ReleaseContentsClient = class extends ApiClient12 {
+var ReleaseContentsClient = class extends ApiClient14 {
   constructor(options) {
     super(options);
   }
@@ -3047,9 +3154,9 @@ var ReleaseContentsClient = class extends ApiClient12 {
 };
 
 // src/RouteClient.ts
-import { ApiClient as ApiClient13 } from "@uniformdev/context/api";
+import { ApiClient as ApiClient15 } from "@uniformdev/context/api";
 var ROUTE_URL = "/api/v1/route";
-var RouteClient = class extends ApiClient13 {
+var RouteClient = class extends ApiClient15 {
   constructor(options) {
     var _a;
     if (!options.limitPolicy) {
@@ -3072,6 +3179,63 @@ var RouteClient = class extends ApiClient13 {
 // src/types/locales.ts
 var LOCALE_DYNAMIC_INPUT_NAME = "locale";
 
+// src/utils/assetConfig.ts
+var mergeAssetConfigWithDefaults = (config) => {
+  var _a;
+  return {
+    ...config,
+    // For backwards compatibility reasons undefined represents restriction to
+    // image types
+    allowedTypes: (_a = config.allowedTypes) != null ? _a : ["image"]
+  };
+};
+
+// src/utils/autoFixParameterGroups.ts
+function autoFixParameterGroups(properties) {
+  var _a;
+  const remainingGroups = (_a = properties.filter((param) => param.type === "group")) != null ? _a : [];
+  if (remainingGroups.length === 0) {
+    return false;
+  }
+  let result = false;
+  while (remainingGroups.length > 0) {
+    const group = remainingGroups.shift();
+    const groupParamsConfig = group.typeConfig && typeof group.typeConfig === "object" && "childrenParams" in group.typeConfig && Array.isArray(group.typeConfig.childrenParams) ? group.typeConfig.childrenParams : [];
+    const expectedParamsToFindFollowingGroup = new Set(groupParamsConfig);
+    const groupStartIndex = properties.findIndex((param) => param.id === group.id);
+    const groupItemsCount = expectedParamsToFindFollowingGroup.size;
+    for (let i = groupStartIndex + 1; i <= groupStartIndex + groupItemsCount; i++) {
+      const param = properties[i];
+      if (!param) {
+        continue;
+      }
+      if (expectedParamsToFindFollowingGroup.has(param.id)) {
+        expectedParamsToFindFollowingGroup.delete(param.id);
+      } else {
+        break;
+      }
+    }
+    if (expectedParamsToFindFollowingGroup.size > 0) {
+      const paramsToMove = Array.from(expectedParamsToFindFollowingGroup);
+      let leadingGroupIndex = groupStartIndex + groupItemsCount - expectedParamsToFindFollowingGroup.size;
+      for (const paramId of paramsToMove) {
+        const paramIndex = properties.findIndex((param) => param.id === paramId);
+        if (paramIndex !== -1) {
+          const [param] = properties.splice(paramIndex, 1);
+          if (paramIndex > leadingGroupIndex) {
+            leadingGroupIndex++;
+          }
+          properties.splice(leadingGroupIndex, 0, param);
+        } else {
+          groupParamsConfig.splice(groupParamsConfig.indexOf(paramId), 1);
+        }
+      }
+      result = true;
+    }
+  }
+  return result;
+}
+
 // src/utils/createApiEnhancer.ts
 var createUniformApiEnhancer = ({ apiUrl }) => {
   return async (message) => {
@@ -3201,7 +3365,8 @@ function mapSlotToTestVariations(slot) {
     return {
       ...v,
       id,
-      testDistribution: contextTag == null ? void 0 : contextTag.testDistribution
+      testDistribution: contextTag == null ? void 0 : contextTag.testDistribution,
+      control: contextTag == null ? void 0 : contextTag.control
     };
   });
 }
@@ -3365,10 +3530,13 @@ function handleRichTextNodeBinding(object, options) {
 // src/index.ts
 import { ApiClientError as ApiClientError2 } from "@uniformdev/context/api";
 
+// src/.version.ts
+var version = "20.43.0";
+
 // src/WorkflowClient.ts
-import { ApiClient as ApiClient14 } from "@uniformdev/context/api";
+import { ApiClient as ApiClient16 } from "@uniformdev/context/api";
 var workflowsUrl = "/api/v1/workflows";
-var WorkflowClient = class extends ApiClient14 {
+var WorkflowClient = class extends ApiClient16 {
   constructor(options) {
     super(options);
   }
@@ -3422,7 +3590,11 @@ export {
   CANVAS_LOCALE_TAG_PARAM,
   CANVAS_LOCALIZATION_SLOT,
   CANVAS_LOCALIZATION_TYPE,
+  CANVAS_PERSONALIZATION_ALGORITHM_PARAM,
+  CANVAS_PERSONALIZATION_ALGORITHM_TYPE,
+  CANVAS_PERSONALIZATION_EVENT_NAME_PARAM,
   CANVAS_PERSONALIZATION_PARAM,
+  CANVAS_PERSONALIZATION_TAKE_PARAM,
   CANVAS_PERSONALIZE_SLOT,
   CANVAS_PERSONALIZE_TYPE,
   CANVAS_PUBLISHED_STATE,
@@ -3458,10 +3630,12 @@ export {
   IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM,
   IN_CONTEXT_EDITOR_QUERY_STRING_PARAM,
   IS_RENDERED_BY_UNIFORM_ATTRIBUTE,
+  IntegrationPropertyEditorsClient,
   LOCALE_DYNAMIC_INPUT_NAME,
   LocaleClient,
   PLACEHOLDER_ID,
   PreviewClient,
+  ProjectClient,
   PromptClient,
   RelationshipClient,
   ReleaseClient,
@@ -3473,6 +3647,7 @@ export {
   UncachedContentClient,
   UniqueBatchEntries,
   WorkflowClient,
+  autoFixParameterGroups,
   bindExpressionEscapeChars,
   bindExpressionPrefix,
   bindVariables,
@@ -3534,6 +3709,7 @@ export {
   isSuggestComponentMessage,
   isSystemComponentDefinition,
   isTriggerCompositionActionMessage,
+  isUpdateAiActionsMessage,
   isUpdateComponentParameterMessage,
   isUpdateComponentReferencesMessage,
   isUpdateCompositionInternalMessage,
@@ -3544,9 +3720,11 @@ export {
   localize,
   mapSlotToPersonalizedVariations,
   mapSlotToTestVariations,
+  mergeAssetConfigWithDefaults,
   nullLimitPolicy,
   parseComponentPlaceholderId,
   parseVariableExpression,
+  version,
   walkNodeTree,
   walkPropertyValues
 };