@uniformdev/canvas 19.35.2 → 19.35.3-alpha.82

package/dist/index.js

@@ -283,7 +283,7 @@ __export(src_exports, {
   ATTRIBUTE_PARAMETER_TYPE: () => ATTRIBUTE_PARAMETER_TYPE,
   ATTRIBUTE_PARAMETER_VALUE: () => ATTRIBUTE_PARAMETER_VALUE,
   ATTRIBUTE_PLACEHOLDER: () => ATTRIBUTE_PLACEHOLDER,
-  ApiClientError: () => import_api6.ApiClientError,
+  ApiClientError: () => import_api7.ApiClientError,
   BatchEntry: () => BatchEntry,
   CANVAS_DRAFT_STATE: () => CANVAS_DRAFT_STATE,
   CANVAS_ENRICHMENT_TAG_PARAM: () => CANVAS_ENRICHMENT_TAG_PARAM,
@@ -300,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,
@@ -320,6 +321,7 @@ __export(src_exports, {
   PLACEHOLDER_ID: () => PLACEHOLDER_ID,
   RouteClient: () => RouteClient,
   UncachedCanvasClient: () => UncachedCanvasClient,
+  UncachedCategoryClient: () => UncachedCategoryClient,
   UniqueBatchEntries: () => UniqueBatchEntries,
   bindVariables: () => bindVariables,
   bindVariablesToObject: () => bindVariablesToObject,
@@ -329,6 +331,7 @@ __export(src_exports, {
   createEventBus: () => createEventBus,
   createLimitPolicy: () => createLimitPolicy,
   createUniformApiEnhancer: () => createUniformApiEnhancer,
+  createVariableReference: () => createVariableReference,
   enhance: () => enhance,
   extractLocales: () => extractLocales,
   generateHash: () => generateHash,
@@ -354,6 +357,7 @@ __export(src_exports, {
   mapSlotToPersonalizedVariations: () => mapSlotToPersonalizedVariations,
   mapSlotToTestVariations: () => mapSlotToTestVariations,
   nullLimitPolicy: () => nullLimitPolicy,
+  parseVariableExpression: () => parseVariableExpression,
   subscribeToComposition: () => subscribeToComposition,
   unstable_CompositionRelationshipClient: () => unstable_CompositionRelationshipClient,
   walkComponentTree: () => walkComponentTree
@@ -649,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 ({
@@ -713,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);
   }
@@ -753,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);
   }
@@ -1672,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) {
@@ -1691,80 +1738,6 @@ var RouteClient = class extends import_api5.ApiClient {
   }
 };
 
-// src/utils/bindVariables.ts
-function bindVariables({
-  variables,
-  value,
-  errorPrefix = "Variable",
-  handleBinding
-}) {
-  let boundCount = 0;
-  const errors = [];
-  const defaultHandleBinding = (variableName, variables2, errors2) => {
-    const variableValue = variables2[variableName];
-    if (variableValue === void 0) {
-      errors2.push(`${errorPrefix} "${variableName}" is not defined`);
-      return "";
-    }
-    return variableValue;
-  };
-  const result = value.replace(/(?<!\\)\${([^}]+)}/g, (_match, variableName) => {
-    const variableValue = (handleBinding != null ? handleBinding : defaultHandleBinding)(variableName, variables, errors);
-    boundCount++;
-    return variableValue;
-  });
-  return { result, boundCount, errors: errors.length > 0 ? errors : void 0 };
-}
-
-// src/utils/bindVariablesToObject.ts
-var import_immer = require("immer");
-function bindVariablesToObject(options) {
-  return bindVariablesToObjectRecursive(options);
-}
-function bindVariablesToObjectRecursive({
-  value,
-  recursivePath,
-  ...bindVariablesOptions
-}) {
-  let boundCount = 0;
-  const errors = [];
-  if (typeof value === "string") {
-    return bindVariables({ ...bindVariablesOptions, value });
-  }
-  if (typeof value !== "object" || value === null) {
-    return { boundCount: 0, result: value };
-  }
-  const result = (0, import_immer.produce)(value, (draft) => {
-    Object.entries(draft).forEach(([property, oldValue]) => {
-      const currentObjectPath = recursivePath ? `${recursivePath}.${property}` : property;
-      if (typeof oldValue === "string") {
-        const bindResult = bindVariables({ ...bindVariablesOptions, value: oldValue });
-        if (oldValue !== bindResult.result || bindResult.errors) {
-          boundCount += bindResult.boundCount;
-          draft[property] = bindResult.result;
-          if (bindResult.errors) {
-            errors.push(...bindResult.errors.map((e) => `${currentObjectPath}: ${e}`));
-          }
-        }
-        return;
-      }
-      const childBind = bindVariablesToObjectRecursive({
-        ...bindVariablesOptions,
-        value: oldValue,
-        recursivePath: currentObjectPath
-      });
-      if (childBind.boundCount || childBind.errors) {
-        boundCount += childBind.boundCount;
-        draft[property] = childBind.result;
-        if (childBind.errors) {
-          errors.push(...childBind.errors.map((e) => `${currentObjectPath}: ${e}`));
-        }
-      }
-    });
-  });
-  return { boundCount, result, errors: errors.length > 0 ? errors : void 0 };
-}
-
 // src/utils/createApiEnhancer.ts
 var createUniformApiEnhancer = ({ apiUrl }) => {
   return async (message) => {
@@ -1812,8 +1785,8 @@ var getParameterAttributes = ({
     [ATTRIBUTE_PARAMETER_VALUE]: String(value != null ? value : ""),
     [ATTRIBUTE_PARAMETER_TYPE]: type,
     [ATTRIBUTE_PLACEHOLDER]: placeholder,
-    [ATTRIBUTE_MULTILINE]: isMultiline,
-    contentEditable: isEditable
+    [ATTRIBUTE_MULTILINE]: type === "text" ? isMultiline : void 0,
+    contentEditable: type === "text" ? isEditable : void 0
   };
 };
 
@@ -1854,9 +1827,183 @@ function mapSlotToTestVariations(slot) {
   });
 }
 
+// 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,
+  errorPrefix = "Variable",
+  handleBinding
+}) {
+  let boundCount = 0;
+  let tokenCount = 0;
+  const errors = [];
+  const defaultHandleBinding = (variableName, variables2, errors2) => {
+    const variableValue = variables2[variableName];
+    if (variableValue === void 0) {
+      errors2.push(`${errorPrefix} "${variableName}" is not defined`);
+      return "";
+    }
+    return variableValue;
+  };
+  const result = [];
+  parseVariableExpression(value, (token, tokenType) => {
+    tokenCount++;
+    if (tokenType === "text") {
+      result.push(token);
+      return;
+    }
+    const variableValue = (handleBinding != null ? handleBinding : defaultHandleBinding)(token, variables, errors);
+    boundCount++;
+    result.push(variableValue);
+  });
+  return {
+    result: tokenCount === 1 ? result[0] : result.join(""),
+    boundCount,
+    errors: errors.length > 0 ? errors : void 0
+  };
+}
+
+// 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);
+}
+function bindVariablesToObjectRecursive({
+  value,
+  recursivePath,
+  ...bindVariablesOptions
+}) {
+  let boundCount = 0;
+  const errors = [];
+  if (typeof value === "string") {
+    return bindVariables({ ...bindVariablesOptions, value });
+  }
+  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;
+      if (typeof oldValue === "string") {
+        const bindResult = bindVariables({ ...bindVariablesOptions, value: oldValue });
+        if (oldValue !== bindResult.result || bindResult.errors) {
+          boundCount += bindResult.boundCount;
+          draft[property] = bindResult.result;
+          if (bindResult.errors) {
+            errors.push(...bindResult.errors.map((e) => `${currentObjectPath}: ${e}`));
+          }
+        }
+        return;
+      }
+      const childBind = bindVariablesToObjectRecursive({
+        ...bindVariablesOptions,
+        value: oldValue,
+        recursivePath: currentObjectPath
+      });
+      if (childBind.boundCount || childBind.errors) {
+        boundCount += childBind.boundCount;
+        draft[property] = childBind.result;
+        if (childBind.errors) {
+          errors.push(...childBind.errors);
+        }
+      }
+    });
+  });
+  return { boundCount, result, errors: errors.length > 0 ? errors : void 0 };
+}
+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,
@@ -1882,6 +2029,7 @@ var CanvasClientError = import_api6.ApiClientError;
   CANVAS_TEST_VARIANT_PARAM,
   CanvasClient,
   CanvasClientError,
+  CategoryClient,
   ChildEnhancerBuilder,
   DataSourceClient,
   DataTypeClient,
@@ -1902,6 +2050,7 @@ var CanvasClientError = import_api6.ApiClientError;
   PLACEHOLDER_ID,
   RouteClient,
   UncachedCanvasClient,
+  UncachedCategoryClient,
   UniqueBatchEntries,
   bindVariables,
   bindVariablesToObject,
@@ -1911,6 +2060,7 @@ var CanvasClientError = import_api6.ApiClientError;
   createEventBus,
   createLimitPolicy,
   createUniformApiEnhancer,
+  createVariableReference,
   enhance,
   extractLocales,
   generateHash,
@@ -1936,6 +2086,7 @@ var CanvasClientError = import_api6.ApiClientError;
   mapSlotToPersonalizedVariations,
   mapSlotToTestVariations,
   nullLimitPolicy,
+  parseVariableExpression,
   subscribeToComposition,
   unstable_CompositionRelationshipClient,
   walkComponentTree