@uniformdev/canvas 19.36.1-alpha.4 → 19.36.1-alpha.61

package/dist/index.esm.js

@@ -482,6 +482,9 @@ var CanvasClient = class extends ApiClient {
   getCompositionById(options) {
     return this.getOneComposition(options);
   }
+  getCompositionDefaults(options) {
+    return this.getOneComposition(options);
+  }
   /** Fetches historical versions of a composition or pattern */
   async unstable_getCompositionHistory(options) {
     const edgeUrl = this.createUrl("/api/v1/canvas-history", {
@@ -1642,80 +1645,6 @@ var RouteClient = class extends ApiClient6 {
   }
 };
 
-// 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
-import { produce } from "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 = 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) => {
@@ -1805,6 +1734,180 @@ 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
+import { produce } from "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 = 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
 import { ApiClientError } from "@uniformdev/context/api";
 var CanvasClientError = ApiClientError;
@@ -1863,6 +1966,7 @@ export {
   createEventBus,
   createLimitPolicy,
   createUniformApiEnhancer,
+  createVariableReference,
   enhance,
   extractLocales,
   generateHash,
@@ -1888,6 +1992,7 @@ export {
   mapSlotToPersonalizedVariations,
   mapSlotToTestVariations,
   nullLimitPolicy,
+  parseVariableExpression,
   subscribeToComposition,
   unstable_CompositionRelationshipClient,
   walkComponentTree

package/dist/index.js

@@ -331,6 +331,7 @@ __export(src_exports, {
   createEventBus: () => createEventBus,
   createLimitPolicy: () => createLimitPolicy,
   createUniformApiEnhancer: () => createUniformApiEnhancer,
+  createVariableReference: () => createVariableReference,
   enhance: () => enhance,
   extractLocales: () => extractLocales,
   generateHash: () => generateHash,
@@ -356,6 +357,7 @@ __export(src_exports, {
   mapSlotToPersonalizedVariations: () => mapSlotToPersonalizedVariations,
   mapSlotToTestVariations: () => mapSlotToTestVariations,
   nullLimitPolicy: () => nullLimitPolicy,
+  parseVariableExpression: () => parseVariableExpression,
   subscribeToComposition: () => subscribeToComposition,
   unstable_CompositionRelationshipClient: () => unstable_CompositionRelationshipClient,
   walkComponentTree: () => walkComponentTree
@@ -576,6 +578,9 @@ var CanvasClient = class extends import_api.ApiClient {
   getCompositionById(options) {
     return this.getOneComposition(options);
   }
+  getCompositionDefaults(options) {
+    return this.getOneComposition(options);
+  }
   /** Fetches historical versions of a composition or pattern */
   async unstable_getCompositionHistory(options) {
     const edgeUrl = this.createUrl("/api/v1/canvas-history", {
@@ -1736,80 +1741,6 @@ var RouteClient = class extends import_api6.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) => {
@@ -1899,6 +1830,180 @@ 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_api7 = require("@uniformdev/context/api");
 var CanvasClientError = import_api7.ApiClientError;
@@ -1958,6 +2063,7 @@ var CanvasClientError = import_api7.ApiClientError;
   createEventBus,
   createLimitPolicy,
   createUniformApiEnhancer,
+  createVariableReference,
   enhance,
   extractLocales,
   generateHash,
@@ -1983,6 +2089,7 @@ var CanvasClientError = import_api7.ApiClientError;
   mapSlotToPersonalizedVariations,
   mapSlotToTestVariations,
   nullLimitPolicy,
+  parseVariableExpression,
   subscribeToComposition,
   unstable_CompositionRelationshipClient,
   walkComponentTree