@uniformdev/canvas 19.80.0 → 19.80.1-alpha.149

package/dist/index.js

@@ -277,6 +277,9 @@ 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,
@@ -340,21 +343,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,
@@ -1114,25 +1125,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 +1136,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 +1402,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 +1428,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 +1722,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 }) {
@@ -2302,6 +2368,22 @@ 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
+    },
+    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 +2513,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 +2580,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
@@ -2578,6 +2665,9 @@ var import_api10 = require("@uniformdev/context/api");
 var CanvasClientError = import_api10.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,
@@ -2641,21 +2731,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,

package/dist/index.mjs

@@ -1000,25 +1000,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) {
@@ -1027,6 +1011,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) {
@@ -1250,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--) {
@@ -1276,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];
@@ -1567,6 +1597,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 }) {
@@ -2188,6 +2243,22 @@ 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
+    },
+    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";
@@ -2317,9 +2388,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;
@@ -2379,7 +2455,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
@@ -2463,6 +2539,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,
@@ -2526,21 +2605,29 @@ 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,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/canvas",
-  "version": "19.80.0",
+  "version": "19.80.1-alpha.149+7f4e45fecc",
   "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.80.0",
-    "@uniformdev/context": "19.80.0",
-    "immer": "9.0.21"
+    "@uniformdev/assets": "19.80.1-alpha.149+7f4e45fecc",
+    "@uniformdev/context": "19.80.1-alpha.149+7f4e45fecc",
+    "immer": "10.0.3"
   },
   "files": [
     "/dist"
@@ -48,5 +48,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "8c61dce79f176cb5aa3cb163657326407f17dee6"
+  "gitHead": "7f4e45fecc013dc224fbd0a2975f6d208382b05e"
 }