@uniformdev/canvas 19.38.2 → 19.38.3-alpha.78

package/dist/index.js

@@ -283,9 +283,10 @@ __export(src_exports, {
   ATTRIBUTE_PARAMETER_TYPE: () => ATTRIBUTE_PARAMETER_TYPE,
   ATTRIBUTE_PARAMETER_VALUE: () => ATTRIBUTE_PARAMETER_VALUE,
   ATTRIBUTE_PLACEHOLDER: () => ATTRIBUTE_PLACEHOLDER,
-  ApiClientError: () => import_api8.ApiClientError,
+  ApiClientError: () => import_api9.ApiClientError,
   BatchEntry: () => BatchEntry,
   CANVAS_DRAFT_STATE: () => CANVAS_DRAFT_STATE,
+  CANVAS_EDITOR_STATE: () => CANVAS_EDITOR_STATE,
   CANVAS_ENRICHMENT_TAG_PARAM: () => CANVAS_ENRICHMENT_TAG_PARAM,
   CANVAS_INTENT_TAG_PARAM: () => CANVAS_INTENT_TAG_PARAM,
   CANVAS_LOCALE_TAG_PARAM: () => CANVAS_LOCALE_TAG_PARAM,
@@ -302,6 +303,7 @@ __export(src_exports, {
   CanvasClientError: () => CanvasClientError,
   CategoryClient: () => CategoryClient,
   ChildEnhancerBuilder: () => ChildEnhancerBuilder,
+  ContentClient: () => ContentClient,
   DataSourceClient: () => DataSourceClient,
   DataTypeClient: () => DataTypeClient,
   EDGE_CACHE_DISABLED: () => EDGE_CACHE_DISABLED,
@@ -315,13 +317,16 @@ __export(src_exports, {
   EnhancerBuilder: () => EnhancerBuilder,
   IN_CONTEXT_EDITOR_COMPONENT_END_ROLE: () => IN_CONTEXT_EDITOR_COMPONENT_END_ROLE,
   IN_CONTEXT_EDITOR_COMPONENT_START_ROLE: () => IN_CONTEXT_EDITOR_COMPONENT_START_ROLE,
+  IN_CONTEXT_EDITOR_CONFIG_CHECK_QUERY_STRING_PARAM: () => IN_CONTEXT_EDITOR_CONFIG_CHECK_QUERY_STRING_PARAM,
   IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID: () => IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID,
+  IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM: () => IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM,
   IN_CONTEXT_EDITOR_QUERY_STRING_PARAM: () => IN_CONTEXT_EDITOR_QUERY_STRING_PARAM,
   IS_RENDERED_BY_UNIFORM_ATTRIBUTE: () => IS_RENDERED_BY_UNIFORM_ATTRIBUTE,
   PLACEHOLDER_ID: () => PLACEHOLDER_ID,
   RouteClient: () => RouteClient,
   UncachedCanvasClient: () => UncachedCanvasClient,
   UncachedCategoryClient: () => UncachedCategoryClient,
+  UncachedContentClient: () => UncachedContentClient,
   UniqueBatchEntries: () => UniqueBatchEntries,
   bindVariables: () => bindVariables,
   bindVariablesToObject: () => bindVariablesToObject,
@@ -331,6 +336,7 @@ __export(src_exports, {
   createEventBus: () => createEventBus,
   createLimitPolicy: () => createLimitPolicy,
   createUniformApiEnhancer: () => createUniformApiEnhancer,
+  createVariableReference: () => createVariableReference,
   enhance: () => enhance,
   extractLocales: () => extractLocales,
   generateHash: () => generateHash,
@@ -356,6 +362,7 @@ __export(src_exports, {
   mapSlotToPersonalizedVariations: () => mapSlotToPersonalizedVariations,
   mapSlotToTestVariations: () => mapSlotToTestVariations,
   nullLimitPolicy: () => nullLimitPolicy,
+  parseVariableExpression: () => parseVariableExpression,
   subscribeToComposition: () => subscribeToComposition,
   unstable_CompositionRelationshipClient: () => unstable_CompositionRelationshipClient,
   walkComponentTree: () => walkComponentTree
@@ -773,11 +780,84 @@ var unstable_CompositionRelationshipClient = class extends import_api4.ApiClient
   }
 };
 
-// src/DataSourceClient.ts
+// src/ContentClient.ts
 var import_api5 = require("@uniformdev/context/api");
+var _contentTypesUrl, _entriesUrl;
+var _ContentClient = class _ContentClient extends import_api5.ApiClient {
+  constructor(options) {
+    var _a;
+    super(options);
+    this.edgeApiHost = (_a = options.edgeApiHost) != null ? _a : "https://uniform.global";
+  }
+  getContentTypes(options) {
+    const { projectId } = this.options;
+    const fetchUri = this.createUrl(__privateGet(_ContentClient, _contentTypesUrl), { ...options, projectId });
+    return this.apiClient(fetchUri);
+  }
+  getEntries(options) {
+    const { projectId } = this.options;
+    const { skipDataResolution, ...params } = options;
+    const fetchUri = skipDataResolution ? this.createUrl(__privateGet(_ContentClient, _entriesUrl), { ...params, projectId }) : this.createUrl(__privateGet(_ContentClient, _entriesUrl), this.getEdgeOptions(params), this.edgeApiHost);
+    return this.apiClient(fetchUri);
+  }
+  async upsertContentType(body) {
+    const fetchUri = this.createUrl(__privateGet(_ContentClient, _contentTypesUrl));
+    await this.apiClient(fetchUri, {
+      method: "PUT",
+      body: JSON.stringify({ ...body, projectId: this.options.projectId }),
+      expectNoContent: true
+    });
+  }
+  async upsertEntry(body) {
+    const fetchUri = this.createUrl(__privateGet(_ContentClient, _entriesUrl));
+    await this.apiClient(fetchUri, {
+      method: "PUT",
+      body: JSON.stringify({ ...body, projectId: this.options.projectId }),
+      expectNoContent: true
+    });
+  }
+  async deleteContentType(body) {
+    const fetchUri = this.createUrl(__privateGet(_ContentClient, _contentTypesUrl));
+    await this.apiClient(fetchUri, {
+      method: "DELETE",
+      body: JSON.stringify({ ...body, projectId: this.options.projectId }),
+      expectNoContent: true
+    });
+  }
+  async deleteEntry(body) {
+    const fetchUri = this.createUrl(__privateGet(_ContentClient, _entriesUrl));
+    await this.apiClient(fetchUri, {
+      method: "DELETE",
+      body: JSON.stringify({ ...body, projectId: this.options.projectId }),
+      expectNoContent: true
+    });
+  }
+  getEdgeOptions(options) {
+    const { projectId } = this.options;
+    const { skipDataResolution, ...params } = options;
+    return {
+      projectId,
+      ...params,
+      diagnostics: (options == null ? void 0 : options.diagnostics) ? "true" : void 0
+    };
+  }
+};
+_contentTypesUrl = new WeakMap();
+_entriesUrl = new WeakMap();
+__privateAdd(_ContentClient, _contentTypesUrl, "/api/v1/content-types");
+__privateAdd(_ContentClient, _entriesUrl, "/api/v1/entries");
+var ContentClient = _ContentClient;
+var UncachedContentClient = class extends ContentClient {
+  constructor(options) {
+    super({ ...options, bypassCache: true });
+  }
+};
+
+// src/DataSourceClient.ts
+var import_api6 = require("@uniformdev/context/api");
 var dataSourceUrl = "/api/v1/data-source";
 var dataSourcesUrl = "/api/v1/data-sources";
-var DataSourceClient = class extends import_api5.ApiClient {
+var DataSourceClient = class extends import_api6.ApiClient {
   constructor(options) {
     super(options);
   }
@@ -814,9 +894,9 @@ var DataSourceClient = class extends import_api5.ApiClient {
 };
 
 // src/DataTypeClient.ts
-var import_api6 = require("@uniformdev/context/api");
+var import_api7 = require("@uniformdev/context/api");
 var _url;
-var _DataTypeClient = class _DataTypeClient extends import_api6.ApiClient {
+var _DataTypeClient = class _DataTypeClient extends import_api7.ApiClient {
   constructor(options) {
     super(options);
   }
@@ -1339,10 +1419,13 @@ var CANVAS_TEST_SLOT = "test";
 var CANVAS_LOCALIZATION_SLOT = "localized";
 var CANVAS_DRAFT_STATE = 0;
 var CANVAS_PUBLISHED_STATE = 64;
+var CANVAS_EDITOR_STATE = 63;
 var CANVAS_PERSONALIZATION_PARAM = "$pzCrit";
 var CANVAS_TEST_VARIANT_PARAM = "$tstVrnt";
 var CANVAS_ENRICHMENT_TAG_PARAM = "$enr";
 var IN_CONTEXT_EDITOR_QUERY_STRING_PARAM = "is_incontext_editing_mode";
+var IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM = "is_incontext_editing_playground";
+var IN_CONTEXT_EDITOR_CONFIG_CHECK_QUERY_STRING_PARAM = "is_config_check";
 var IN_CONTEXT_EDITOR_COMPONENT_START_ROLE = "uniform-component-start";
 var IN_CONTEXT_EDITOR_COMPONENT_END_ROLE = "uniform-component-end";
 var IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID = "uniform-canvas-preview-script";
@@ -1609,6 +1692,12 @@ var createCanvasChannel = ({
     };
     postMessage(message);
   };
+  const editorStateUpdated = () => {
+    const message = {
+      type: "editor-state-updated"
+    };
+    postMessage(message);
+  };
   const messageEventListener = (event) => {
     if (typeof event.data !== "string") {
       return;
@@ -1650,7 +1739,8 @@ var createCanvasChannel = ({
     updatePreviewSettings,
     updateContextualEditingStateInternal,
     selectParameter,
-    reportRenderedCompositions
+    reportRenderedCompositions,
+    editorStateUpdated
   };
 };
 
@@ -1733,9 +1823,9 @@ function subscribeToComposition({
 }
 
 // src/RouteClient.ts
-var import_api7 = require("@uniformdev/context/api");
+var import_api8 = require("@uniformdev/context/api");
 var ROUTE_URL = "/api/v1/route";
-var RouteClient = class extends import_api7.ApiClient {
+var RouteClient = class extends import_api8.ApiClient {
   constructor(options) {
     var _a;
     if (!options.limitPolicy) {
@@ -1752,80 +1842,6 @@ var RouteClient = class extends import_api7.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) => {
@@ -1915,9 +1931,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_api8 = require("@uniformdev/context/api");
-var CanvasClientError = import_api8.ApiClientError;
+var import_api9 = require("@uniformdev/context/api");
+var CanvasClientError = import_api9.ApiClientError;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   ATTRIBUTE_COMPONENT_ID,
@@ -1929,6 +2119,7 @@ var CanvasClientError = import_api8.ApiClientError;
   ApiClientError,
   BatchEntry,
   CANVAS_DRAFT_STATE,
+  CANVAS_EDITOR_STATE,
   CANVAS_ENRICHMENT_TAG_PARAM,
   CANVAS_INTENT_TAG_PARAM,
   CANVAS_LOCALE_TAG_PARAM,
@@ -1945,6 +2136,7 @@ var CanvasClientError = import_api8.ApiClientError;
   CanvasClientError,
   CategoryClient,
   ChildEnhancerBuilder,
+  ContentClient,
   DataSourceClient,
   DataTypeClient,
   EDGE_CACHE_DISABLED,
@@ -1958,13 +2150,16 @@ var CanvasClientError = import_api8.ApiClientError;
   EnhancerBuilder,
   IN_CONTEXT_EDITOR_COMPONENT_END_ROLE,
   IN_CONTEXT_EDITOR_COMPONENT_START_ROLE,
+  IN_CONTEXT_EDITOR_CONFIG_CHECK_QUERY_STRING_PARAM,
   IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID,
+  IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM,
   IN_CONTEXT_EDITOR_QUERY_STRING_PARAM,
   IS_RENDERED_BY_UNIFORM_ATTRIBUTE,
   PLACEHOLDER_ID,
   RouteClient,
   UncachedCanvasClient,
   UncachedCategoryClient,
+  UncachedContentClient,
   UniqueBatchEntries,
   bindVariables,
   bindVariablesToObject,
@@ -1974,6 +2169,7 @@ var CanvasClientError = import_api8.ApiClientError;
   createEventBus,
   createLimitPolicy,
   createUniformApiEnhancer,
+  createVariableReference,
   enhance,
   extractLocales,
   generateHash,
@@ -1999,6 +2195,7 @@ var CanvasClientError = import_api8.ApiClientError;
   mapSlotToPersonalizedVariations,
   mapSlotToTestVariations,
   nullLimitPolicy,
+  parseVariableExpression,
   subscribeToComposition,
   unstable_CompositionRelationshipClient,
   walkComponentTree