@uniformdev/canvas 19.35.1 → 19.35.3-alpha.82

package/dist/index.js

@@ -277,7 +277,13 @@ var require_retry2 = __commonJS({
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
-  ApiClientError: () => import_api6.ApiClientError,
+  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_api7.ApiClientError,
   BatchEntry: () => BatchEntry,
   CANVAS_DRAFT_STATE: () => CANVAS_DRAFT_STATE,
   CANVAS_ENRICHMENT_TAG_PARAM: () => CANVAS_ENRICHMENT_TAG_PARAM,
@@ -294,6 +300,7 @@ __export(src_exports, {
   CANVAS_TEST_VARIANT_PARAM: () => CANVAS_TEST_VARIANT_PARAM,
   CanvasClient: () => CanvasClient,
   CanvasClientError: () => CanvasClientError,
+  CategoryClient: () => CategoryClient,
   ChildEnhancerBuilder: () => ChildEnhancerBuilder,
   DataSourceClient: () => DataSourceClient,
   DataTypeClient: () => DataTypeClient,
@@ -314,6 +321,7 @@ __export(src_exports, {
   PLACEHOLDER_ID: () => PLACEHOLDER_ID,
   RouteClient: () => RouteClient,
   UncachedCanvasClient: () => UncachedCanvasClient,
+  UncachedCategoryClient: () => UncachedCategoryClient,
   UniqueBatchEntries: () => UniqueBatchEntries,
   bindVariables: () => bindVariables,
   bindVariablesToObject: () => bindVariablesToObject,
@@ -323,12 +331,14 @@ __export(src_exports, {
   createEventBus: () => createEventBus,
   createLimitPolicy: () => createLimitPolicy,
   createUniformApiEnhancer: () => createUniformApiEnhancer,
+  createVariableReference: () => createVariableReference,
   enhance: () => enhance,
   extractLocales: () => extractLocales,
   generateHash: () => generateHash,
   getChannelName: () => getChannelName,
   getComponentJsonPointer: () => getComponentJsonPointer,
   getComponentPath: () => getComponentPath,
+  getParameterAttributes: () => getParameterAttributes,
   isAddComponentMessage: () => isAddComponentMessage,
   isDismissPlaceholderMessage: () => isDismissPlaceholderMessage,
   isMovingComponentMessage: () => isMovingComponentMessage,
@@ -347,6 +357,7 @@ __export(src_exports, {
   mapSlotToPersonalizedVariations: () => mapSlotToPersonalizedVariations,
   mapSlotToTestVariations: () => mapSlotToTestVariations,
   nullLimitPolicy: () => nullLimitPolicy,
+  parseVariableExpression: () => parseVariableExpression,
   subscribeToComposition: () => subscribeToComposition,
   unstable_CompositionRelationshipClient: () => unstable_CompositionRelationshipClient,
   walkComponentTree: () => walkComponentTree
@@ -642,10 +653,53 @@ var UncachedCanvasClient = class extends CanvasClient {
   }
 };
 
-// src/CompositionRelationshipClient.ts
+// src/CategoryClient.ts
 var import_api2 = require("@uniformdev/context/api");
+var CATEGORIES_URL = "/api/v1/categories";
+var CategoryClient = class extends import_api2.ApiClient {
+  constructor(options) {
+    if (!options.limitPolicy) {
+      options.limitPolicy = createLimitPolicy({});
+    }
+    super(options);
+  }
+  /** Fetches all categories created in given project */
+  async getCategories(options) {
+    const { projectId } = this.options;
+    const fetchUri = this.createUrl("/api/v1/categories", { ...options, projectId });
+    return await this.apiClient(fetchUri);
+  }
+  /** Updates or creates a category, also used to re-order them */
+  async upsertCategories(categories) {
+    const { projectId } = this.options;
+    const fetchUri = this.createUrl(CATEGORIES_URL);
+    return await this.apiClient(fetchUri, {
+      method: "PUT",
+      body: JSON.stringify({ categories, projectId }),
+      expectNoContent: true
+    });
+  }
+  /** Deletes a category */
+  async removeCategory(options) {
+    const { projectId } = this.options;
+    const fetchUri = this.createUrl(CATEGORIES_URL);
+    return await this.apiClient(fetchUri, {
+      method: "DELETE",
+      body: JSON.stringify({ projectId, categoryId: options.categoryId }),
+      expectNoContent: true
+    });
+  }
+};
+var UncachedCategoryClient = class extends CategoryClient {
+  constructor(options) {
+    super({ ...options, bypassCache: true });
+  }
+};
+
+// src/CompositionRelationshipClient.ts
+var import_api3 = require("@uniformdev/context/api");
 var COMPOSITION_RELATIONSHIP_URL = "/api/v1/composition-relationships";
-var unstable_CompositionRelationshipClient = class extends import_api2.ApiClient {
+var unstable_CompositionRelationshipClient = class extends import_api3.ApiClient {
   constructor(options) {
     super(options);
     this.getDefinitionsRelationships = async ({
@@ -706,10 +760,10 @@ var unstable_CompositionRelationshipClient = class extends import_api2.ApiClient
 };
 
 // src/DataSourceClient.ts
-var import_api3 = require("@uniformdev/context/api");
+var import_api4 = require("@uniformdev/context/api");
 var dataSourceUrl = "/api/v1/data-source";
 var dataSourcesUrl = "/api/v1/data-sources";
-var DataSourceClient = class extends import_api3.ApiClient {
+var DataSourceClient = class extends import_api4.ApiClient {
   constructor(options) {
     super(options);
   }
@@ -746,9 +800,9 @@ var DataSourceClient = class extends import_api3.ApiClient {
 };
 
 // src/DataTypeClient.ts
-var import_api4 = require("@uniformdev/context/api");
+var import_api5 = require("@uniformdev/context/api");
 var _url;
-var _DataTypeClient = class _DataTypeClient extends import_api4.ApiClient {
+var _DataTypeClient = class _DataTypeClient extends import_api5.ApiClient {
   constructor(options) {
     super(options);
   }
@@ -1665,9 +1719,9 @@ function subscribeToComposition({
 }
 
 // src/RouteClient.ts
-var import_api5 = require("@uniformdev/context/api");
+var import_api6 = require("@uniformdev/context/api");
 var ROUTE_URL = "/api/v1/route";
-var RouteClient = class extends import_api5.ApiClient {
+var RouteClient = class extends import_api6.ApiClient {
   constructor(options) {
     var _a;
     if (!options.limitPolicy) {
@@ -1684,7 +1738,157 @@ var RouteClient = class extends import_api5.ApiClient {
   }
 };
 
-// src/utils/bindVariables.ts
+// src/utils/createApiEnhancer.ts
+var createUniformApiEnhancer = ({ apiUrl }) => {
+  return async (message) => {
+    const response = await fetch(apiUrl, {
+      method: "post",
+      body: JSON.stringify({
+        composition: message.composition,
+        hash: message.hash
+      }),
+      headers: {
+        "Content-Type": "application/json"
+      }
+    });
+    const json = await response.json();
+    if (!response.ok) {
+      throw new Error("Error reading enhanced composition");
+    }
+    const body = json;
+    return body.composition;
+  };
+};
+
+// src/utils/getParameterAttributes.ts
+var ATTRIBUTE_COMPONENT_ID = "data-uniform-component-id";
+var ATTRIBUTE_PARAMETER_ID = "data-uniform-parameter-id";
+var ATTRIBUTE_PARAMETER_VALUE = "data-uniform-parameter-value";
+var ATTRIBUTE_PARAMETER_TYPE = "data-uniform-parameter-type";
+var ATTRIBUTE_PLACEHOLDER = "data-uniform-placeholder";
+var ATTRIBUTE_MULTILINE = "data-uniform-is-multiline";
+var getParameterAttributes = ({
+  id,
+  component,
+  placeholder,
+  isMultiline = false
+}) => {
+  var _a, _b, _c;
+  const componentId = component == null ? void 0 : component._id;
+  const parameter = (_a = component == null ? void 0 : component.parameters) == null ? void 0 : _a[id];
+  const value = parameter == null ? void 0 : parameter.value;
+  const type = parameter == null ? void 0 : parameter.type;
+  const isEditable = (_c = (_b = parameter == null ? void 0 : parameter._contextualEditing) == null ? void 0 : _b.isEditable) != null ? _c : false;
+  return {
+    [ATTRIBUTE_COMPONENT_ID]: componentId,
+    [ATTRIBUTE_PARAMETER_ID]: id,
+    [ATTRIBUTE_PARAMETER_VALUE]: String(value != null ? value : ""),
+    [ATTRIBUTE_PARAMETER_TYPE]: type,
+    [ATTRIBUTE_PLACEHOLDER]: placeholder,
+    [ATTRIBUTE_MULTILINE]: type === "text" ? isMultiline : void 0,
+    contentEditable: type === "text" ? isEditable : void 0
+  };
+};
+
+// src/utils/isSystemComponentDefinition.ts
+var isSystemComponentDefinition = (componentType) => {
+  return componentType.startsWith("$");
+};
+
+// src/utils/mapSlotToPersonalizedVariations.ts
+function mapSlotToPersonalizedVariations(slot) {
+  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;
+    const id = (contextTag == null ? void 0 : contextTag.name) || `pz-${i}-${v.type}`;
+    return {
+      ...v,
+      id,
+      pz: contextTag
+    };
+  });
+}
+
+// src/utils/mapSlotToTestVariations.ts
+function mapSlotToTestVariations(slot) {
+  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;
+    const id = (_c = contextTag == null ? void 0 : contextTag.id) != null ? _c : "testId" in v ? v.testId : `ab-${i}-${v.type}`;
+    return {
+      ...v,
+      id
+      //testDistribution: contextTag?.testDistribution,
+    };
+  });
+}
+
+// src/utils/variables/parseVariableExpression.ts
+var escapeCharacter = "\\";
+var variablePrefix = "${";
+var variableSuffix = "}";
+function parseVariableExpression(serialized, onToken) {
+  let bufferStartIndex = 0;
+  let bufferEndIndex = 0;
+  let tokenCount = 0;
+  const handleToken = (token, type) => {
+    tokenCount++;
+    return onToken == null ? void 0 : onToken(token, type);
+  };
+  let state = "text";
+  for (let index = 0; index < serialized.length; index++) {
+    const char = serialized[index];
+    if (bufferStartIndex > bufferEndIndex) {
+      bufferEndIndex = bufferStartIndex;
+    }
+    if (char === variablePrefix[0] && serialized[index + 1] === variablePrefix[1]) {
+      if (serialized[index - 1] === escapeCharacter) {
+        bufferEndIndex -= escapeCharacter.length;
+        if (handleToken(serialized.substring(bufferStartIndex, bufferEndIndex), "text") === false) {
+          return tokenCount;
+        }
+        bufferStartIndex = index;
+        bufferEndIndex = index + 1;
+        continue;
+      }
+      state = "variable";
+      if (bufferEndIndex > bufferStartIndex) {
+        if (handleToken(serialized.substring(bufferStartIndex, bufferEndIndex), "text") === false) {
+          return tokenCount;
+        }
+        bufferStartIndex = bufferEndIndex;
+      }
+      index += variablePrefix.length - 1;
+      bufferStartIndex += variablePrefix.length;
+      continue;
+    }
+    if (char === variableSuffix && state === "variable") {
+      state = "text";
+      if (bufferEndIndex > bufferStartIndex) {
+        if (handleToken(serialized.substring(bufferStartIndex, bufferEndIndex), "variable") === false) {
+          return tokenCount;
+        }
+        bufferStartIndex = bufferEndIndex + variableSuffix.length;
+      }
+      continue;
+    }
+    bufferEndIndex++;
+  }
+  if (bufferEndIndex > bufferStartIndex) {
+    if (state === "variable") {
+      state = "text";
+      bufferStartIndex -= variablePrefix.length;
+    }
+    handleToken(serialized.substring(bufferStartIndex), state);
+  }
+  return tokenCount;
+}
+
+// src/utils/variables/bindVariables.ts
 function bindVariables({
   variables,
   value,
@@ -1692,6 +1896,7 @@ function bindVariables({
   handleBinding
 }) {
   let boundCount = 0;
+  let tokenCount = 0;
   const errors = [];
   const defaultHandleBinding = (variableName, variables2, errors2) => {
     const variableValue = variables2[variableName];
@@ -1701,16 +1906,33 @@ function bindVariables({
     }
     return variableValue;
   };
-  const result = value.replace(/(?<!\\)\${([^}]+)}/g, (_match, variableName) => {
-    const variableValue = (handleBinding != null ? handleBinding : defaultHandleBinding)(variableName, variables, errors);
+  const result = [];
+  parseVariableExpression(value, (token, tokenType) => {
+    tokenCount++;
+    if (tokenType === "text") {
+      result.push(token);
+      return;
+    }
+    const variableValue = (handleBinding != null ? handleBinding : defaultHandleBinding)(token, variables, errors);
     boundCount++;
-    return variableValue;
+    result.push(variableValue);
   });
-  return { result, boundCount, errors: errors.length > 0 ? errors : void 0 };
+  return {
+    result: tokenCount === 1 ? result[0] : result.join(""),
+    boundCount,
+    errors: errors.length > 0 ? errors : void 0
+  };
 }
 
-// src/utils/bindVariablesToObject.ts
+// src/utils/variables/bindVariablesToObject.ts
 var import_immer = require("immer");
+
+// src/utils/variables/createVariableReference.ts
+function createVariableReference(variableName) {
+  return `\${${variableName}}`;
+}
+
+// src/utils/variables/bindVariablesToObject.ts
 function bindVariablesToObject(options) {
   return bindVariablesToObjectRecursive(options);
 }
@@ -1727,6 +1949,10 @@ function bindVariablesToObjectRecursive({
   if (typeof value !== "object" || value === null) {
     return { boundCount: 0, result: value };
   }
+  const richTextNodeResult = handleRichTextNodeBinding(value, bindVariablesOptions);
+  if (richTextNodeResult !== void 0) {
+    return richTextNodeResult;
+  }
   const result = (0, import_immer.produce)(value, (draft) => {
     Object.entries(draft).forEach(([property, oldValue]) => {
       const currentObjectPath = recursivePath ? `${recursivePath}.${property}` : property;
@@ -1750,78 +1976,42 @@ function bindVariablesToObjectRecursive({
         boundCount += childBind.boundCount;
         draft[property] = childBind.result;
         if (childBind.errors) {
-          errors.push(...childBind.errors.map((e) => `${currentObjectPath}: ${e}`));
+          errors.push(...childBind.errors);
         }
       }
     });
   });
   return { boundCount, result, errors: errors.length > 0 ? errors : void 0 };
 }
-
-// src/utils/createApiEnhancer.ts
-var createUniformApiEnhancer = ({ apiUrl }) => {
-  return async (message) => {
-    const response = await fetch(apiUrl, {
-      method: "post",
-      body: JSON.stringify({
-        composition: message.composition,
-        hash: message.hash
-      }),
-      headers: {
-        "Content-Type": "application/json"
-      }
-    });
-    const json = await response.json();
-    if (!response.ok) {
-      throw new Error("Error reading enhanced composition");
-    }
-    const body = json;
-    return body.composition;
-  };
-};
-
-// src/utils/isSystemComponentDefinition.ts
-var isSystemComponentDefinition = (componentType) => {
-  return componentType.startsWith("$");
-};
-
-// src/utils/mapSlotToPersonalizedVariations.ts
-function mapSlotToPersonalizedVariations(slot) {
-  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;
-    const id = (contextTag == null ? void 0 : contextTag.name) || `pz-${i}-${v.type}`;
-    return {
-      ...v,
-      id,
-      pz: contextTag
-    };
-  });
-}
-
-// src/utils/mapSlotToTestVariations.ts
-function mapSlotToTestVariations(slot) {
-  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;
-    const id = (_c = contextTag == null ? void 0 : contextTag.id) != null ? _c : "testId" in v ? v.testId : `ab-${i}-${v.type}`;
-    return {
-      ...v,
-      id
-      //testDistribution: contextTag?.testDistribution,
+function handleRichTextNodeBinding(object, options) {
+  if ("type" in object && object.type === "variable" && "reference" in object && typeof object.reference === "string" && "version" in object && object.version === 1) {
+    const value = createVariableReference(object.reference);
+    const bindResult = bindVariables({ ...options, value });
+    const bindResultAsTextNode = {
+      detail: 0,
+      format: 0,
+      mode: "normal",
+      style: "",
+      text: bindResult.result,
+      type: "text",
+      version: 1
     };
-  });
+    return { ...bindResult, result: bindResultAsTextNode };
+  }
+  return void 0;
 }
 
 // src/index.ts
-var import_api6 = require("@uniformdev/context/api");
-var CanvasClientError = import_api6.ApiClientError;
+var import_api7 = require("@uniformdev/context/api");
+var CanvasClientError = import_api7.ApiClientError;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  ATTRIBUTE_COMPONENT_ID,
+  ATTRIBUTE_MULTILINE,
+  ATTRIBUTE_PARAMETER_ID,
+  ATTRIBUTE_PARAMETER_TYPE,
+  ATTRIBUTE_PARAMETER_VALUE,
+  ATTRIBUTE_PLACEHOLDER,
   ApiClientError,
   BatchEntry,
   CANVAS_DRAFT_STATE,
@@ -1839,6 +2029,7 @@ var CanvasClientError = import_api6.ApiClientError;
   CANVAS_TEST_VARIANT_PARAM,
   CanvasClient,
   CanvasClientError,
+  CategoryClient,
   ChildEnhancerBuilder,
   DataSourceClient,
   DataTypeClient,
@@ -1859,6 +2050,7 @@ var CanvasClientError = import_api6.ApiClientError;
   PLACEHOLDER_ID,
   RouteClient,
   UncachedCanvasClient,
+  UncachedCategoryClient,
   UniqueBatchEntries,
   bindVariables,
   bindVariablesToObject,
@@ -1868,12 +2060,14 @@ var CanvasClientError = import_api6.ApiClientError;
   createEventBus,
   createLimitPolicy,
   createUniformApiEnhancer,
+  createVariableReference,
   enhance,
   extractLocales,
   generateHash,
   getChannelName,
   getComponentJsonPointer,
   getComponentPath,
+  getParameterAttributes,
   isAddComponentMessage,
   isDismissPlaceholderMessage,
   isMovingComponentMessage,
@@ -1892,6 +2086,7 @@ var CanvasClientError = import_api6.ApiClientError;
   mapSlotToPersonalizedVariations,
   mapSlotToTestVariations,
   nullLimitPolicy,
+  parseVariableExpression,
   subscribeToComposition,
   unstable_CompositionRelationshipClient,
   walkComponentTree