@uniformdev/canvas 19.69.0 → 19.71.1-alpha.103

package/dist/index.mjs

@@ -717,12 +717,13 @@ var _ContentClient = class _ContentClient extends ApiClient4 {
     });
     return this.apiClient(historyUrl);
   }
-  async upsertContentType(body) {
+  async upsertContentType(body, opts = {}) {
     const fetchUri = this.createUrl(__privateGet(_ContentClient, _contentTypesUrl));
     await this.apiClient(fetchUri, {
       method: "PUT",
       body: JSON.stringify({ ...body, projectId: this.options.projectId }),
-      expectNoContent: true
+      expectNoContent: true,
+      headers: opts.autogenerateDataTypes ? { "x-uniform-autogenerate-data-types": "true" } : {}
     });
   }
   async upsertEntry(body) {
@@ -999,25 +1000,60 @@ 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;
+var ASSET_PARAMETER_TYPE = "asset";
+var ASSETS_SOURCE_UNIFORM = "uniform-assets";
+var ASSETS_SOURCE_CUSTOM_URL = "custom-url";
 
-// 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
-  };
+// src/utils/guards.ts
+function isRootEntryReference(root) {
+  return root.type === "root" && isEntryData(root.node);
+}
+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) {
@@ -1037,7 +1073,83 @@ function walkNodeTree(node, visitor, options) {
     let visitDescendants = true;
     let descendantContext = (_a = childContexts.get(currentComponent.node)) != null ? _a : currentQueueEntry.context;
     let visitorInfo;
-    if (currentComponent.type === "root" || currentComponent.type === "slot") {
+    if (currentComponent.type === "root" && isRootEntryReference(currentComponent) || currentComponent.type === "block") {
+      visitorInfo = {
+        type: "entry",
+        node: currentComponent.node,
+        ancestorsAndSelf: currentQueueEntry.ancestorsAndSelf,
+        actions: {
+          replace: (replacementNode) => {
+            Object.assign(currentComponent.node, replacementNode);
+            const propertiesToCheck = ["fields", "_dataResources", "_author"];
+            propertiesToCheck.forEach((property) => {
+              if (!replacementNode[property]) {
+                delete currentComponent.node[property];
+              }
+            });
+          },
+          remove: () => {
+            const currentComponentLocation = currentQueueEntry.ancestorsAndSelf[0];
+            const parentComponent = currentQueueEntry.ancestorsAndSelf[1];
+            if (currentComponentLocation.type === "block") {
+              const { fieldName, blockIndex } = currentComponentLocation;
+              const blockValue = getBlockValue(parentComponent.node, fieldName);
+              blockValue.splice(blockIndex, 1);
+              if (blockValue.length === 0) {
+                const properties2 = getPropertiesValue(parentComponent.node);
+                delete properties2[fieldName];
+              }
+            } else {
+              throw new Error("Unknown node type");
+            }
+          },
+          insertAfter: (nodes) => {
+            const currentNodeInfo = currentQueueEntry.ancestorsAndSelf[0];
+            if (currentNodeInfo.type !== "block") {
+              throw new Error("Unknown type");
+            }
+            const { fieldName, blockIndex } = currentNodeInfo;
+            const parentComponent = currentQueueEntry.ancestorsAndSelf[1];
+            const nodesToInsert = Array.isArray(nodes) ? nodes : [nodes];
+            if (fieldName && typeof blockIndex !== "undefined") {
+              getPropertiesValue(parentComponent.node)[fieldName].value.splice(
+                blockIndex + 1,
+                0,
+                ...nodesToInsert
+              );
+              componentQueue.unshift(
+                ...nodesToInsert.map((enqueueingComponent) => ({
+                  ancestorsAndSelf: [
+                    {
+                      type: "block",
+                      node: enqueueingComponent,
+                      fieldName,
+                      get blockIndex() {
+                        const parentArray = getPropertiesValue(parentComponent.node)[fieldName].value;
+                        return parentArray.findIndex((x) => x === enqueueingComponent);
+                      }
+                    },
+                    // slice removes 'self' since we are inserting a peer of self
+                    ...currentQueueEntry.ancestorsAndSelf.slice(1)
+                  ],
+                  context: descendantContext
+                }))
+              );
+            }
+          },
+          stopProcessingDescendants() {
+            visitDescendants = false;
+          },
+          setDescendantsContext(context) {
+            descendantContext = context;
+          },
+          setChildContext(child, context) {
+            childContexts.set(child, context);
+          }
+        },
+        context: descendantContext
+      };
+    } else {
       visitorInfo = {
         type: "component",
         node: currentComponent.node,
@@ -1128,82 +1240,6 @@ function walkNodeTree(node, visitor, options) {
         },
         context: descendantContext
       };
-    } else {
-      visitorInfo = {
-        type: "entry",
-        node: currentComponent.node,
-        ancestorsAndSelf: currentQueueEntry.ancestorsAndSelf,
-        actions: {
-          replace: (replacementNode) => {
-            Object.assign(currentComponent.node, replacementNode);
-            const propertiesToCheck = ["fields", "_dataResources", "_author"];
-            propertiesToCheck.forEach((property) => {
-              if (!replacementNode[property]) {
-                delete currentComponent.node[property];
-              }
-            });
-          },
-          remove: () => {
-            const currentComponentLocation = currentQueueEntry.ancestorsAndSelf[0];
-            const parentComponent = currentQueueEntry.ancestorsAndSelf[1];
-            if (currentComponentLocation.type === "block") {
-              const { fieldName, blockIndex } = currentComponentLocation;
-              const blockValue = getBlockValue(parentComponent.node, fieldName);
-              blockValue.splice(blockIndex, 1);
-              if (blockValue.length === 0) {
-                const properties2 = getPropertiesValue(parentComponent.node);
-                delete properties2[fieldName];
-              }
-            } else {
-              throw new Error("Unknown node type");
-            }
-          },
-          insertAfter: (nodes) => {
-            const currentNodeInfo = currentQueueEntry.ancestorsAndSelf[0];
-            if (currentNodeInfo.type !== "block") {
-              throw new Error("Unknown type");
-            }
-            const { fieldName, blockIndex } = currentNodeInfo;
-            const parentComponent = currentQueueEntry.ancestorsAndSelf[1];
-            const nodesToInsert = Array.isArray(nodes) ? nodes : [nodes];
-            if (fieldName && typeof blockIndex !== "undefined") {
-              getPropertiesValue(parentComponent.node)[fieldName].value.splice(
-                blockIndex + 1,
-                0,
-                ...nodesToInsert
-              );
-              componentQueue.unshift(
-                ...nodesToInsert.map((enqueueingComponent) => ({
-                  ancestorsAndSelf: [
-                    {
-                      type: "block",
-                      node: enqueueingComponent,
-                      fieldName,
-                      get blockIndex() {
-                        const parentArray = getPropertiesValue(parentComponent.node)[fieldName].value;
-                        return parentArray.findIndex((x) => x === enqueueingComponent);
-                      }
-                    },
-                    // slice removes 'self' since we are inserting a peer of self
-                    ...currentQueueEntry.ancestorsAndSelf.slice(1)
-                  ],
-                  context: descendantContext
-                }))
-              );
-            }
-          },
-          stopProcessingDescendants() {
-            visitDescendants = false;
-          },
-          setDescendantsContext(context) {
-            descendantContext = context;
-          },
-          setChildContext(child, context) {
-            childContexts.set(child, context);
-          }
-        },
-        context: descendantContext
-      };
     }
     visitor(visitorInfo);
     if (!visitDescendants) {
@@ -1241,7 +1277,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--) {
@@ -1267,6 +1303,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];
@@ -1535,7 +1574,7 @@ function getComponentJsonPointer(ancestorsAndSelf) {
       if (currentLocation.type === "block") {
         const { fieldName: parameterName, blockIndex } = currentLocation;
         if (parameterName && blockIndex !== void 0) {
-          const noun = parentLocation && "type" in parentLocation && parentLocation.type === "block" ? "fields" : "parameters";
+          const noun = getNounForLocation(parentLocation);
           path.push(`${noun}/${parameterName}/value/${blockIndex}`);
         }
       } else {
@@ -1549,6 +1588,40 @@ function getComponentJsonPointer(ancestorsAndSelf) {
   }
   return `/${path.join("/")}`;
 }
+function getNounForLocation(parentLocation) {
+  let noun = "parameters";
+  if (parentLocation && "type" in parentLocation) {
+    if (parentLocation.type === "block" || isRootEntryReference(parentLocation)) {
+      noun = "fields";
+    }
+  }
+  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 }) {
@@ -1565,18 +1638,22 @@ 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;
     }
+    if (typeof locale === "string") {
+      localizeProperties(getPropertiesValue(node), locale);
+    }
     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];
@@ -1593,6 +1670,25 @@ function localize({
     }
   });
 }
+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];
+    }
+  });
+}
 
 // src/enhancement/UniqueBatchEntries.ts
 var UniqueBatchEntries = class {
@@ -1739,6 +1835,39 @@ function walkComponentTree(component, visitor, initialContext) {
   } while (componentQueue.length > 0);
 }
 
+// src/LocaleClient.ts
+import { ApiClient as ApiClient7 } from "@uniformdev/context/api";
+var localesUrl = "/api/v1/locales";
+var LocaleClient = class extends ApiClient7 {
+  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,
@@ -1826,7 +1955,7 @@ var createCanvasChannel = ({
     };
     postMessage(message);
   };
-  const ready = () => {
+  const ready = (options) => {
     var _a, _b;
     if (typeof window === "undefined") {
       return;
@@ -1836,7 +1965,8 @@ var createCanvasChannel = ({
     const message = {
       type: "ready",
       framework,
-      version
+      version,
+      rsc: options == null ? void 0 : options.rsc
     };
     postMessage(message);
   };
@@ -2095,28 +2225,21 @@ function subscribeToComposition({
 }
 
 // src/PromptClient.ts
-import { ApiClient as ApiClient7 } from "@uniformdev/context/api";
-var PromptUrl = "/api/v1/prompt";
+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);
   }
-  /** Fetches all Prompts for a project */
+  /** Fetches Prompts for a project */
   async get(options) {
-    const { projectId } = this.options;
-    const fetchUri = this.createUrl(PromptUrl, { ...options, projectId });
-    return await this.apiClient(fetchUri);
-  }
-  /** Fetches all Prompts for a project */
-  async getList(options) {
     const { projectId } = this.options;
     const fetchUri = this.createUrl(PromptsUrl, { ...options, projectId });
     return await this.apiClient(fetchUri);
   }
   /** Updates or creates (based on id) a Prompt */
   async upsert(body) {
-    const fetchUri = this.createUrl(PromptUrl);
+    const fetchUri = this.createUrl(PromptsUrl);
     await this.apiClient(fetchUri, {
       method: "PUT",
       body: JSON.stringify({ ...body, projectId: this.options.projectId }),
@@ -2125,7 +2248,7 @@ var PromptClient = class extends ApiClient7 {
   }
   /** Deletes a Prompt */
   async remove(body) {
-    const fetchUri = this.createUrl(PromptUrl);
+    const fetchUri = this.createUrl(PromptsUrl);
     await this.apiClient(fetchUri, {
       method: "DELETE",
       body: JSON.stringify({ ...body, projectId: this.options.projectId }),
@@ -2135,9 +2258,9 @@ var PromptClient = class extends ApiClient7 {
 };
 
 // src/RouteClient.ts
-import { ApiClient as ApiClient8 } from "@uniformdev/context/api";
+import { ApiClient as ApiClient9 } from "@uniformdev/context/api";
 var ROUTE_URL = "/api/v1/route";
-var RouteClient = class extends ApiClient8 {
+var RouteClient = class extends ApiClient9 {
   constructor(options) {
     var _a;
     if (!options.limitPolicy) {
@@ -2154,6 +2277,9 @@ var RouteClient = class extends ApiClient8 {
   }
 };
 
+// src/types/locales.ts
+var LOCALE_DYNAMIC_INPUT_NAME = "locale";
+
 // src/utils/createApiEnhancer.ts
 var createUniformApiEnhancer = ({ apiUrl }) => {
   return async (message) => {
@@ -2176,6 +2302,23 @@ 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,
+      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";
@@ -2253,6 +2396,9 @@ var isComponentPlaceholderId = (id) => {
   if (id === PLACEHOLDER_ID) {
     return true;
   }
+  if (typeof id !== "string") {
+    return false;
+  }
   return id == null ? void 0 : id.startsWith(PLACEHOLDER_ID);
 };
 var generateComponentPlaceholderId = (randomId, sdkVersion) => {
@@ -2302,9 +2448,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;
@@ -2364,7 +2515,7 @@ import { produce } from "immer";
 
 // src/utils/variables/createVariableReference.ts
 function createVariableReference(variableName) {
-  return `\${${variableName}}`;
+  return `\${${variableName.replace(/([${}])/g, "\\$1")}}`;
 }
 
 // src/utils/variables/bindVariablesToObject.ts
@@ -2448,6 +2599,9 @@ function handleRichTextNodeBinding(object, options) {
 import { ApiClientError as ApiClientError2 } from "@uniformdev/context/api";
 var CanvasClientError = ApiClientError2;
 export {
+  ASSETS_SOURCE_CUSTOM_URL,
+  ASSETS_SOURCE_UNIFORM,
+  ASSET_PARAMETER_TYPE,
   ATTRIBUTE_COMPONENT_ID,
   ATTRIBUTE_MULTILINE,
   ATTRIBUTE_PARAMETER_ID,
@@ -2491,6 +2645,8 @@ export {
   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,
@@ -2511,23 +2667,33 @@ export {
   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,
+  isRootEntryReference,
   isSelectComponentMessage,
   isSelectParameterMessage,
   isSystemComponentDefinition,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/canvas",
-  "version": "19.69.0",
+  "version": "19.71.1-alpha.103+2e172bb17",
   "description": "Common functionality and types for Uniform Canvas",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -31,16 +31,16 @@
     "document": "api-extractor run --local"
   },
   "devDependencies": {
-    "@types/retry": "0.12.1",
+    "@types/retry": "0.12.5",
     "lexical": "^0.12.0",
     "p-retry": "5.1.2",
     "p-throttle": "5.0.0",
     "pusher-js": "8.2.0"
   },
   "dependencies": {
-    "@uniformdev/assets": "19.69.0",
-    "@uniformdev/context": "19.69.0",
-    "immer": "9.0.21"
+    "@uniformdev/assets": "19.71.1-alpha.103+2e172bb17",
+    "@uniformdev/context": "19.71.1-alpha.103+2e172bb17",
+    "immer": "10.0.3"
   },
   "files": [
     "/dist"
@@ -48,5 +48,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "327658d8c6e5735499845ebb29d74906f2a43dad"
+  "gitHead": "2e172bb17f644b34be818605979a1436b8621c90"
 }