@uniformdev/canvas 19.79.0 → 19.79.1-alpha.7

package/dist/index.js

@@ -277,13 +277,16 @@ var require_retry2 = __commonJS({
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
+  ASSETS_SOURCE_CUSTOM_URL: () => ASSETS_SOURCE_CUSTOM_URL,
+  ASSETS_SOURCE_UNIFORM: () => ASSETS_SOURCE_UNIFORM,
+  ASSET_PARAMETER_TYPE: () => ASSET_PARAMETER_TYPE,
   ATTRIBUTE_COMPONENT_ID: () => ATTRIBUTE_COMPONENT_ID,
   ATTRIBUTE_MULTILINE: () => ATTRIBUTE_MULTILINE,
   ATTRIBUTE_PARAMETER_ID: () => ATTRIBUTE_PARAMETER_ID,
   ATTRIBUTE_PARAMETER_TYPE: () => ATTRIBUTE_PARAMETER_TYPE,
   ATTRIBUTE_PARAMETER_VALUE: () => ATTRIBUTE_PARAMETER_VALUE,
   ATTRIBUTE_PLACEHOLDER: () => ATTRIBUTE_PLACEHOLDER,
-  ApiClientError: () => import_api10.ApiClientError,
+  ApiClientError: () => import_api11.ApiClientError,
   BatchEntry: () => BatchEntry,
   CANVAS_BLOCK_PARAM_TYPE: () => CANVAS_BLOCK_PARAM_TYPE,
   CANVAS_DRAFT_STATE: () => CANVAS_DRAFT_STATE,
@@ -320,6 +323,8 @@ __export(src_exports, {
   IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM: () => IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM,
   IN_CONTEXT_EDITOR_QUERY_STRING_PARAM: () => IN_CONTEXT_EDITOR_QUERY_STRING_PARAM,
   IS_RENDERED_BY_UNIFORM_ATTRIBUTE: () => IS_RENDERED_BY_UNIFORM_ATTRIBUTE,
+  LOCALE_DYNAMIC_INPUT_NAME: () => LOCALE_DYNAMIC_INPUT_NAME,
+  LocaleClient: () => LocaleClient,
   PLACEHOLDER_ID: () => PLACEHOLDER_ID,
   PromptClient: () => PromptClient,
   RouteClient: () => RouteClient,
@@ -340,21 +345,29 @@ __export(src_exports, {
   createVariableReference: () => createVariableReference,
   enhance: () => enhance,
   extractLocales: () => extractLocales,
+  findParameterInNodeTree: () => findParameterInNodeTree,
+  flattenValues: () => flattenValues,
   generateComponentPlaceholderId: () => generateComponentPlaceholderId,
   generateHash: () => generateHash,
   getBlockValue: () => getBlockValue,
   getChannelName: () => getChannelName,
   getComponentJsonPointer: () => getComponentJsonPointer,
   getComponentPath: () => getComponentPath,
+  getNounForLocation: () => getNounForLocation,
+  getNounForNode: () => getNounForNode,
   getParameterAttributes: () => getParameterAttributes,
   getPropertiesValue: () => getPropertiesValue,
+  getPropertyValue: () => getPropertyValue,
   isAddComponentMessage: () => isAddComponentMessage,
   isAllowedReferrer: () => isAllowedReferrer,
+  isAssetParamValue: () => isAssetParamValue,
+  isAssetParamValueItem: () => isAssetParamValueItem,
   isComponentActionMessage: () => isComponentActionMessage,
   isComponentPlaceholderId: () => isComponentPlaceholderId,
   isDismissPlaceholderMessage: () => isDismissPlaceholderMessage,
   isEntryData: () => isEntryData,
   isMovingComponentMessage: () => isMovingComponentMessage,
+  isNestedNodeType: () => isNestedNodeType,
   isOpenParameterEditorMessage: () => isOpenParameterEditorMessage,
   isReadyMessage: () => isReadyMessage,
   isReportRenderedCompositionsMessage: () => isReportRenderedCompositionsMessage,
@@ -590,6 +603,7 @@ var CanvasClient = class extends import_api2.ApiClient {
     }
     super(options);
     this.edgeApiHost = (_a = options.edgeApiHost) != null ? _a : "https://uniform.global";
+    this.edgeApiRequestInit = options.disableSWR ? { headers: { "x-disable-swr": "true" } } : void 0;
   }
   /** Fetches lists of Canvas compositions, optionally by type */
   async getCompositionList(params = {}) {
@@ -605,7 +619,7 @@ var CanvasClient = class extends import_api2.ApiClient {
       ...params.diagnostics ? { diagnostics: "true" } : {}
     };
     const edgeUrl = this.createUrl("/api/v1/compositions", edgeParams, this.edgeApiHost);
-    return this.apiClient(edgeUrl);
+    return this.apiClient(edgeUrl, this.edgeApiRequestInit);
   }
   getCompositionByNodePath(options) {
     return this.getOneComposition(options);
@@ -645,7 +659,7 @@ var CanvasClient = class extends import_api2.ApiClient {
       ...diagnostics ? { diagnostics: "true" } : {}
     };
     const edgeUrl = this.createUrl("/api/v1/composition", edgeParams, this.edgeApiHost);
-    return this.apiClient(edgeUrl);
+    return this.apiClient(edgeUrl, this.edgeApiRequestInit);
   }
   /** Updates or creates a Canvas component definition */
   async updateComposition(body) {
@@ -748,13 +762,15 @@ var unstable_CompositionRelationshipClient = class extends import_api4.ApiClient
     super(options);
     this.getDefinitionsRelationships = async ({
       definitionIds,
-      withCompositions
+      withCompositions,
+      entityType = "composition"
     }) => {
       const url = this.createUrl(COMPOSITION_RELATIONSHIP_URL, {
         type: "definition",
         projectId: this._options.projectId,
         definitionIds: definitionIds.join(","),
-        withCompositions
+        withCompositions,
+        entityType
       });
       return this.apiClient(url);
     };
@@ -820,8 +836,15 @@ var _ContentClient = class _ContentClient extends import_api5.ApiClient {
   getEntries(options) {
     const { projectId } = this.options;
     const { skipDataResolution, ...params } = options;
-    const fetchUri = skipDataResolution ? this.createUrl(__privateGet(_ContentClient, _entriesUrl), { ...params, projectId }) : this.createUrl(__privateGet(_ContentClient, _entriesUrl), this.getEdgeOptions(params), this.edgeApiHost);
-    return this.apiClient(fetchUri);
+    if (skipDataResolution) {
+      const url = this.createUrl(__privateGet(_ContentClient, _entriesUrl), { ...params, projectId });
+      return this.apiClient(url);
+    }
+    const edgeUrl = this.createUrl(__privateGet(_ContentClient, _entriesUrl), this.getEdgeOptions(params), this.edgeApiHost);
+    return this.apiClient(
+      edgeUrl,
+      this.options.disableSWR ? { headers: { "x-disable-swr": "true" } } : void 0
+    );
   }
   /** Fetches historical versions of an entry */
   async getEntryHistory(options) {
@@ -1114,25 +1137,9 @@ var EDGE_MIN_CACHE_TTL = 10;
 var EDGE_MAX_CACHE_TTL = 24 * 60 * 60;
 var EDGE_DEFAULT_CACHE_TTL = 30;
 var EDGE_CACHE_DISABLED = -1;
-
-// src/utils/entryConverter.ts
-function convertEntryToPutEntry(entry) {
-  return {
-    entry: {
-      type: entry.entry.type,
-      _dataResources: entry.entry._dataResources,
-      _id: entry.entry._id,
-      _name: entry.entry._name,
-      _slug: entry.entry._slug,
-      fields: entry.entry.fields
-    },
-    state: entry.state,
-    projectId: entry.projectId
-  };
-}
-function getPropertiesValue(entity) {
-  return "parameters" in entity && entity.parameters ? entity.parameters : "fields" in entity && entity.fields ? entity.fields : void 0;
-}
+var ASSET_PARAMETER_TYPE = "asset";
+var ASSETS_SOURCE_UNIFORM = "uniform-assets";
+var ASSETS_SOURCE_CUSTOM_URL = "custom-url";
 
 // src/utils/guards.ts
 function isRootEntryReference(root) {
@@ -1141,6 +1148,49 @@ function isRootEntryReference(root) {
 function isEntryData(entryData) {
   return Boolean(entryData && typeof entryData === "object" && "fields" in entryData);
 }
+function isAssetParamValue(value) {
+  return Array.isArray(value) && (value.length > 0 ? isAssetParamValueItem(value[0]) : true);
+}
+function isAssetParamValueItem(item) {
+  return Boolean(
+    item instanceof Object && "_source" in item && "fields" in item && item.fields instanceof Object && "url" in item.fields && item.fields.url instanceof Object
+  );
+}
+
+// src/utils/properties.ts
+function getPropertiesValue(entity) {
+  return "parameters" in entity && entity.parameters ? entity.parameters : "fields" in entity && entity.fields ? entity.fields : void 0;
+}
+function getPropertyValue(parameter) {
+  return parameter ? parameter.value : parameter;
+}
+function flattenValues(data, options = {}) {
+  if (!data) {
+    return data;
+  } else if (Array.isArray(data) && options.toSingle) {
+    return data.length > 0 ? flattenSingleNodeValues(data[0]) : void 0;
+  } else if (Array.isArray(data)) {
+    return data.map((node) => flattenSingleNodeValues(node, options));
+  } else {
+    return flattenSingleNodeValues(data, options);
+  }
+}
+function flattenSingleNodeValues(data, options = {}) {
+  const { levels = 1 } = options;
+  const properties = getPropertiesValue(data);
+  return properties ? Object.fromEntries(
+    Object.entries(properties).map(([id, parameter]) => {
+      const value = getPropertyValue(parameter);
+      if (levels > 0 && Array.isArray(value) && // In the future ASSET_PARAMETER_TYPE will be a nested data type
+      (isNestedNodeType(parameter.type) || parameter.type === ASSET_PARAMETER_TYPE)) {
+        const nestedOptions = { ...options, levels: levels - 1 };
+        return [id, value.map((item) => flattenValues(item, nestedOptions))];
+      } else {
+        return [id, value];
+      }
+    })
+  ) : properties;
+}
 
 // src/enhancement/walkNodeTree.ts
 function walkNodeTree(node, visitor, options) {
@@ -1364,7 +1414,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 (propObject.type !== CANVAS_BLOCK_PARAM_TYPE)
+        if (!isNestedNodeType(propObject.type))
           continue;
         const blocks = (_b = propObject.value) != null ? _b : [];
         for (let blockIndex = blocks.length - 1; blockIndex >= 0; blockIndex--) {
@@ -1390,6 +1440,9 @@ function walkNodeTree(node, visitor, options) {
     }
   } while (componentQueue.length > 0);
 }
+function isNestedNodeType(type) {
+  return type === CANVAS_BLOCK_PARAM_TYPE;
+}
 function getBlockValue(component, parameterName) {
   var _a;
   const parameter = (_a = getPropertiesValue(component)) == null ? void 0 : _a[parameterName];
@@ -1681,6 +1734,31 @@ function getNounForLocation(parentLocation) {
   }
   return noun;
 }
+function getNounForNode(node) {
+  let noun = "parameters";
+  if (isEntryData(node)) {
+    noun = "fields";
+  }
+  return noun;
+}
+
+// src/enhancement/findInNodeTree.ts
+function findParameterInNodeTree(data, predicate) {
+  const results = [];
+  walkNodeTree(data, ({ node, ancestorsAndSelf }) => {
+    const parameters = getPropertiesValue(node);
+    if (parameters) {
+      Object.entries(parameters).filter(([key, field]) => predicate(field, key, node)).forEach(([key, field]) => {
+        results.push({
+          key,
+          pointer: (ancestorsAndSelf.length === 1 ? "" : getComponentJsonPointer(ancestorsAndSelf)) + `/${getNounForNode(node)}/${key}`,
+          parameter: field
+        });
+      });
+    }
+  });
+  return results;
+}
 
 // src/enhancement/localize.ts
 function extractLocales({ component }) {
@@ -1697,23 +1775,31 @@ function extractLocales({ component }) {
   });
   return variations;
 }
-function localize({
-  composition,
-  locale
-}) {
-  walkNodeTree(composition, ({ type, node, actions }) => {
+function localize(options) {
+  const nodes = "nodes" in options ? options.nodes : options.composition;
+  const locale = options.locale;
+  walkNodeTree(nodes, ({ type, node, actions }) => {
     if (type !== "component") {
-      actions.stopProcessingDescendants();
+      if (typeof locale === "string") {
+        localizeProperties(node.fields, locale);
+      }
       return;
     }
+    const shouldRunPropertyLocalization = typeof locale === "string";
     if (node.type === CANVAS_LOCALIZATION_TYPE) {
       const locales = extractLocales({ component: node });
-      const resolvedLocale = typeof locale === "string" ? locale : locale({ component: node, locales });
+      const resolvedLocale = typeof locale === "string" ? locale : locale == null ? void 0 : locale({ component: node, locales });
       let replaceComponent;
       if (resolvedLocale) {
         replaceComponent = locales[resolvedLocale];
       }
       if (replaceComponent == null ? void 0 : replaceComponent.length) {
+        replaceComponent.forEach((component) => {
+          removeLocaleProperty(component);
+          if (shouldRunPropertyLocalization) {
+            localizeProperties(getPropertiesValue(component), locale);
+          }
+        });
         const [first, ...rest] = replaceComponent;
         actions.replace(first);
         if (rest.length) {
@@ -1722,6 +1808,42 @@ function localize({
       } else {
         actions.remove();
       }
+    } else if (shouldRunPropertyLocalization) {
+      localizeProperties(getPropertiesValue(node), locale);
+    }
+  });
+}
+function removeLocaleProperty(component) {
+  const properties = getPropertiesValue(component);
+  const localeTagProperty = properties == null ? void 0 : properties[CANVAS_LOCALE_TAG_PARAM];
+  if (localeTagProperty) {
+    delete properties[CANVAS_LOCALE_TAG_PARAM];
+  }
+  if (properties && Object.keys(properties).length === 0) {
+    if ("fields" in component) {
+      delete component.fields;
+    }
+    if ("parameters" in component) {
+      delete component.parameters;
+    }
+  }
+}
+function localizeProperties(properties, locale) {
+  if (!properties) {
+    return void 0;
+  }
+  Object.entries(properties).forEach(([key, property]) => {
+    var _a;
+    if (!locale) {
+      delete property.locales;
+    }
+    const currentLocaleValue = locale ? (_a = property.locales) == null ? void 0 : _a[locale] : void 0;
+    if (currentLocaleValue !== void 0) {
+      property.value = currentLocaleValue;
+    }
+    delete property.locales;
+    if (property.value === void 0) {
+      delete properties[key];
     }
   });
 }
@@ -1871,6 +1993,39 @@ function walkComponentTree(component, visitor, initialContext) {
   } while (componentQueue.length > 0);
 }
 
+// src/LocaleClient.ts
+var import_api8 = require("@uniformdev/context/api");
+var localesUrl = "/api/v1/locales";
+var LocaleClient = class extends import_api8.ApiClient {
+  constructor(options) {
+    super(options);
+  }
+  /** Fetches all locales for a project */
+  async get(options) {
+    const { projectId } = this.options;
+    const fetchUri = this.createUrl(localesUrl, { ...options, projectId });
+    return await this.apiClient(fetchUri);
+  }
+  /** Updates or creates (based on id) a locale */
+  async upsert(body) {
+    const fetchUri = this.createUrl(localesUrl);
+    await this.apiClient(fetchUri, {
+      method: "PUT",
+      body: JSON.stringify({ ...body, projectId: this.options.projectId }),
+      expectNoContent: true
+    });
+  }
+  /** Deletes a locale */
+  async remove(body) {
+    const fetchUri = this.createUrl(localesUrl);
+    await this.apiClient(fetchUri, {
+      method: "DELETE",
+      body: JSON.stringify({ ...body, projectId: this.options.projectId }),
+      expectNoContent: true
+    });
+  }
+};
+
 // src/utils/hash.ts
 var generateHash = ({
   composition,
@@ -2228,9 +2383,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);
   }
@@ -2261,9 +2416,9 @@ var PromptClient = class extends import_api8.ApiClient {
 };
 
 // src/RouteClient.ts
-var import_api9 = require("@uniformdev/context/api");
+var import_api10 = require("@uniformdev/context/api");
 var ROUTE_URL = "/api/v1/route";
-var RouteClient = class extends import_api9.ApiClient {
+var RouteClient = class extends import_api10.ApiClient {
   constructor(options) {
     var _a;
     if (!options.limitPolicy) {
@@ -2276,10 +2431,16 @@ var RouteClient = class extends import_api9.ApiClient {
   async getRoute(options) {
     const { projectId } = this.options;
     const fetchUri = this.createUrl(ROUTE_URL, { ...options, projectId }, this.edgeApiHost);
-    return await this.apiClient(fetchUri);
+    return await this.apiClient(
+      fetchUri,
+      this.options.disableSWR ? { headers: { "x-disable-swr": "true" } } : void 0
+    );
   }
 };
 
+// src/types/locales.ts
+var LOCALE_DYNAMIC_INPUT_NAME = "locale";
+
 // src/utils/createApiEnhancer.ts
 var createUniformApiEnhancer = ({ apiUrl }) => {
   return async (message) => {
@@ -2302,6 +2463,26 @@ var createUniformApiEnhancer = ({ apiUrl }) => {
   };
 };
 
+// src/utils/entryConverter.ts
+function convertEntryToPutEntry(entry) {
+  return {
+    entry: {
+      type: entry.entry.type,
+      _dataResources: entry.entry._dataResources,
+      _id: entry.entry._id,
+      _name: entry.entry._name,
+      _slug: entry.entry._slug,
+      _pattern: entry.entry._pattern,
+      _overridability: entry.entry._overridability,
+      _overrides: entry.entry._overrides,
+      fields: entry.entry.fields,
+      _locales: entry.entry._locales
+    },
+    state: entry.state,
+    projectId: entry.projectId
+  };
+}
+
 // src/utils/getParameterAttributes.ts
 var ATTRIBUTE_COMPONENT_ID = "data-uniform-component-id";
 var ATTRIBUTE_PARAMETER_ID = "data-uniform-parameter-id";
@@ -2431,9 +2612,14 @@ function parseVariableExpression(serialized, onToken) {
       continue;
     }
     if (char === variableSuffix && state === "variable") {
+      if (serialized[index - 1] === escapeCharacter) {
+        bufferEndIndex++;
+        continue;
+      }
       state = "text";
       if (bufferEndIndex > bufferStartIndex) {
-        if (handleToken(serialized.substring(bufferStartIndex, bufferEndIndex), "variable") === false) {
+        const unescapedVariableName = serialized.substring(bufferStartIndex, bufferEndIndex).replace(/\\([${}])/g, "$1");
+        if (handleToken(unescapedVariableName, "variable") === false) {
           return tokenCount;
         }
         bufferStartIndex = bufferEndIndex + variableSuffix.length;
@@ -2493,7 +2679,7 @@ var import_immer = require("immer");
 
 // src/utils/variables/createVariableReference.ts
 function createVariableReference(variableName) {
-  return `\${${variableName}}`;
+  return `\${${variableName.replace(/([${}])/g, "\\$1")}}`;
 }
 
 // src/utils/variables/bindVariablesToObject.ts
@@ -2574,10 +2760,13 @@ function handleRichTextNodeBinding(object, options) {
 }
 
 // src/index.ts
-var import_api10 = require("@uniformdev/context/api");
-var CanvasClientError = import_api10.ApiClientError;
+var import_api11 = require("@uniformdev/context/api");
+var CanvasClientError = import_api11.ApiClientError;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  ASSETS_SOURCE_CUSTOM_URL,
+  ASSETS_SOURCE_UNIFORM,
+  ASSET_PARAMETER_TYPE,
   ATTRIBUTE_COMPONENT_ID,
   ATTRIBUTE_MULTILINE,
   ATTRIBUTE_PARAMETER_ID,
@@ -2621,6 +2810,8 @@ var CanvasClientError = import_api10.ApiClientError;
   IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM,
   IN_CONTEXT_EDITOR_QUERY_STRING_PARAM,
   IS_RENDERED_BY_UNIFORM_ATTRIBUTE,
+  LOCALE_DYNAMIC_INPUT_NAME,
+  LocaleClient,
   PLACEHOLDER_ID,
   PromptClient,
   RouteClient,
@@ -2641,21 +2832,29 @@ var CanvasClientError = import_api10.ApiClientError;
   createVariableReference,
   enhance,
   extractLocales,
+  findParameterInNodeTree,
+  flattenValues,
   generateComponentPlaceholderId,
   generateHash,
   getBlockValue,
   getChannelName,
   getComponentJsonPointer,
   getComponentPath,
+  getNounForLocation,
+  getNounForNode,
   getParameterAttributes,
   getPropertiesValue,
+  getPropertyValue,
   isAddComponentMessage,
   isAllowedReferrer,
+  isAssetParamValue,
+  isAssetParamValueItem,
   isComponentActionMessage,
   isComponentPlaceholderId,
   isDismissPlaceholderMessage,
   isEntryData,
   isMovingComponentMessage,
+  isNestedNodeType,
   isOpenParameterEditorMessage,
   isReadyMessage,
   isReportRenderedCompositionsMessage,