@uniformdev/canvas 18.1.1-alpha.11 → 18.1.2-alpha.7

package/dist/{chunk-FIKDTGXG.mjs → chunk-RFV573P3.mjs}

@@ -475,17 +475,19 @@ function createLimitPolicy({
 var nullLimitPolicy = async (func) => await func();
 
 // src/CanvasClient.ts
+var CANVAS_URL = "/api/v1/canvas";
 var CanvasClient = class extends ApiClient {
   constructor(options) {
+    var _a;
     if (!options.limitPolicy) {
       options.limitPolicy = createLimitPolicy({});
     }
     super(options);
-    this.canvasUrl = "/api/v1/canvas";
+    this.edgeApiHost = (_a = options.edgeApiHost) != null ? _a : "https://uniform.global";
   }
   async getCompositionList(options) {
     const { projectId } = this.options;
-    const fetchUri = this.createUrl(this.canvasUrl, { ...options, projectId });
+    const fetchUri = this.createUrl(CANVAS_URL, { ...options, projectId });
     return await this.apiClient(fetchUri);
   }
   unstable_getCompositionByNodePath(options) {
@@ -507,20 +509,20 @@ var CanvasClient = class extends ApiClient {
     ...params
   }) {
     const { projectId } = this.options;
-    const url = resolveData ? "/api/edge/v1/composition" : this.canvasUrl;
-    const dataResolutionParams = {};
-    if (resolveData) {
-      if (dynamicVariables) {
-        dataResolutionParams.dynamicVariables = JSON.stringify(dynamicVariables);
-      }
-      if (dataDiagnostics) {
-        dataResolutionParams.dataDiagnostics = "true";
-      }
+    if (!resolveData) {
+      return this.apiClient(this.createUrl(CANVAS_URL, { ...params, projectId }));
     }
-    return this.apiClient(this.createUrl(url, { ...params, ...dataResolutionParams, projectId }));
+    const edgeParams = {
+      ...params,
+      projectId,
+      ...dynamicVariables ? { dynamicVariables: JSON.stringify(dynamicVariables) } : {},
+      ...dataDiagnostics ? { dataDiagnostics: "true" } : {}
+    };
+    const edgeUrl = this.createUrl("/api/v1/composition", edgeParams, this.edgeApiHost);
+    return this.apiClient(edgeUrl);
   }
   async updateComposition(body) {
-    const fetchUri = this.createUrl("/api/v1/canvas");
+    const fetchUri = this.createUrl(CANVAS_URL);
     await this.apiClient(fetchUri, {
       method: "PUT",
       body: JSON.stringify({ ...body, projectId: this.options.projectId }),
@@ -528,7 +530,7 @@ var CanvasClient = class extends ApiClient {
     });
   }
   async removeComposition(body) {
-    const fetchUri = this.createUrl("/api/v1/canvas");
+    const fetchUri = this.createUrl(CANVAS_URL);
     const { projectId } = this.options;
     await this.apiClient(fetchUri, {
       method: "DELETE",
@@ -1091,6 +1093,7 @@ 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_COMPONENT_START_ROLE = "uniform-component-start";
+var IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID = "uniform-canvas-preview-script";
 var PLACEHOLDER_ID = "placeholder";
 var EDGE_MIN_CACHE_TTL = 15;
 var EDGE_MAX_CACHE_TTL = 600;
@@ -1383,6 +1386,28 @@ function subscribeToComposition({
   };
 }
 
+// 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("$");
@@ -1465,6 +1490,7 @@ export {
   CANVAS_ENRICHMENT_TAG_PARAM,
   IN_CONTEXT_EDITOR_QUERY_STRING_PARAM,
   IN_CONTEXT_EDITOR_COMPONENT_START_ROLE,
+  IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID,
   PLACEHOLDER_ID,
   EDGE_MIN_CACHE_TTL,
   EDGE_MAX_CACHE_TTL,
@@ -1487,6 +1513,7 @@ export {
   createEventBus,
   getChannelName,
   subscribeToComposition,
+  createUniformApiEnhancer,
   isSystemComponentDefinition,
   mapSlotToPersonalizedVariations,
   mapSlotToTestVariations,

package/dist/cli/cli.d.ts

@@ -1,6 +1,6 @@
 import { UniformCLIPlugin } from '@uniformdev/cli';
 import { UniformPackage } from '@uniformdev/cli/sync';
-import { a1 as CanvasDefinitions } from '../createEventBus-fc82f596.js';
+import { a1 as CanvasDefinitions } from '../createEventBus-bd2e0a92.js';
 import 'pusher-js';
 
 type CanvasPackage = UniformPackage & CanvasDefinitions;

package/dist/cli/cli.js

@@ -18087,17 +18087,22 @@ async function createArraySyncEngineDataSource({
 }
 var import_chalk = __toESM2(require_source());
 function withApiOptions(yargs) {
-  var _a2, _b2, _c2;
+  var _a2, _b2;
   return yargs.option("apiKey", {
-    describe: "Uniform API key. Defaults to UNIFORM_CLI_API_KEY or UNIFORM_API_KEY env. Supports dotenv.",
-    default: (_c2 = (_b2 = (_a2 = process.env.UNIFORM_CLI_API_KEY) != null ? _a2 : process.env.CANVAS_CLI_API_KEY) != null ? _b2 : process.env.UPM_CLI_API_KEY) != null ? _c2 : process.env.UNIFORM_API_KEY,
+    describe: "Uniform API key. Defaults to CANVAS_CLI_API_KEY or UNIFORM_API_KEY env. Supports dotenv.",
+    default: (_b2 = (_a2 = process.env.CANVAS_CLI_API_KEY) != null ? _a2 : process.env.UPM_CLI_API_KEY) != null ? _b2 : process.env.UNIFORM_API_KEY,
     demandOption: true,
     type: "string"
   }).option("apiHost", {
-    describe: "Uniform host. Defaults to UNIFORM_CLI_BASE_URL env or https://uniform.app. Supports dotenv.",
+    describe: "Uniform host. Defaults to UNIFORM_CLI_BASE_URL env var or https://uniform.app. Supports dotenv.",
     default: process.env.UNIFORM_CLI_BASE_URL || "https://uniform.app",
     demandOption: true,
     type: "string"
+  }).option("edgeApiHost", {
+    describe: "Uniform edge host. Defaults to UNIFORM_CLI_BASE_EDGE_URL env var or https://uniform.global. Supports dotenv.",
+    default: process.env.UNIFORM_CLI_BASE_EDGE_URL || "https://uniform.global",
+    demandOption: true,
+    type: "string"
   }).option("proxy", {
     describe: "HTTPS proxy to use for Uniform API calls. Defaults to HTTPS_PROXY, https_proxy, ALL_PROXY, or all_proxy env vars (in that order). Supports dotenv.",
     default: process.env.HTTPS_PROXY || process.env.https_proxy || process.env.ALL_PROXY || process.env.all_proxy,
@@ -18598,17 +18603,19 @@ function createLimitPolicy({
 }
 
 // src/CanvasClient.ts
+var CANVAS_URL = "/api/v1/canvas";
 var CanvasClient = class extends import_api.ApiClient {
   constructor(options) {
+    var _a2;
     if (!options.limitPolicy) {
       options.limitPolicy = createLimitPolicy({});
     }
     super(options);
-    this.canvasUrl = "/api/v1/canvas";
+    this.edgeApiHost = (_a2 = options.edgeApiHost) != null ? _a2 : "https://uniform.global";
   }
   async getCompositionList(options) {
     const { projectId } = this.options;
-    const fetchUri = this.createUrl(this.canvasUrl, { ...options, projectId });
+    const fetchUri = this.createUrl(CANVAS_URL, { ...options, projectId });
     return await this.apiClient(fetchUri);
   }
   unstable_getCompositionByNodePath(options) {
@@ -18630,20 +18637,20 @@ var CanvasClient = class extends import_api.ApiClient {
     ...params
   }) {
     const { projectId } = this.options;
-    const url = resolveData ? "/api/edge/v1/composition" : this.canvasUrl;
-    const dataResolutionParams = {};
-    if (resolveData) {
-      if (dynamicVariables) {
-        dataResolutionParams.dynamicVariables = JSON.stringify(dynamicVariables);
-      }
-      if (dataDiagnostics) {
-        dataResolutionParams.dataDiagnostics = "true";
-      }
+    if (!resolveData) {
+      return this.apiClient(this.createUrl(CANVAS_URL, { ...params, projectId }));
     }
-    return this.apiClient(this.createUrl(url, { ...params, ...dataResolutionParams, projectId }));
+    const edgeParams = {
+      ...params,
+      projectId,
+      ...dynamicVariables ? { dynamicVariables: JSON.stringify(dynamicVariables) } : {},
+      ...dataDiagnostics ? { dataDiagnostics: "true" } : {}
+    };
+    const edgeUrl = this.createUrl("/api/v1/composition", edgeParams, this.edgeApiHost);
+    return this.apiClient(edgeUrl);
   }
   async updateComposition(body) {
-    const fetchUri = this.createUrl("/api/v1/canvas");
+    const fetchUri = this.createUrl(CANVAS_URL);
     await this.apiClient(fetchUri, {
       method: "PUT",
       body: JSON.stringify({ ...body, projectId: this.options.projectId }),
@@ -18651,7 +18658,7 @@ var CanvasClient = class extends import_api.ApiClient {
     });
   }
   async removeComposition(body) {
-    const fetchUri = this.createUrl("/api/v1/canvas");
+    const fetchUri = this.createUrl(CANVAS_URL);
     const { projectId } = this.options;
     await this.apiClient(fetchUri, {
       method: "DELETE",
@@ -19146,6 +19153,7 @@ var CompositionGetModule = {
   ),
   handler: async ({
     apiHost,
+    edgeApiHost,
     apiKey,
     proxy,
     id,
@@ -19159,7 +19167,7 @@ var CompositionGetModule = {
     unstableDataDiagnostics
   }) => {
     const fetch2 = nodeFetchProxy(proxy);
-    const client = new UncachedCanvasClient({ apiKey, apiHost, fetch: fetch2, projectId });
+    const client = new UncachedCanvasClient({ apiKey, edgeApiHost, apiHost, fetch: fetch2, projectId });
     const res = prepCompositionForDisk(
       await client.getCompositionById({
         compositionId: id,

package/dist/cli/cli.mjs

@@ -14,7 +14,7 @@ import {
   __require,
   __toCommonJS,
   __toESM
-} from "../chunk-FIKDTGXG.mjs";
+} from "../chunk-RFV573P3.mjs";
 
 // ../../node_modules/.pnpm/ms@2.1.2/node_modules/ms/index.js
 var require_ms = __commonJS({
@@ -17806,17 +17806,22 @@ async function createArraySyncEngineDataSource({
 }
 var import_chalk = __toESM2(require_source());
 function withApiOptions(yargs) {
-  var _a2, _b2, _c2;
+  var _a2, _b2;
   return yargs.option("apiKey", {
-    describe: "Uniform API key. Defaults to UNIFORM_CLI_API_KEY or UNIFORM_API_KEY env. Supports dotenv.",
-    default: (_c2 = (_b2 = (_a2 = process.env.UNIFORM_CLI_API_KEY) != null ? _a2 : process.env.CANVAS_CLI_API_KEY) != null ? _b2 : process.env.UPM_CLI_API_KEY) != null ? _c2 : process.env.UNIFORM_API_KEY,
+    describe: "Uniform API key. Defaults to CANVAS_CLI_API_KEY or UNIFORM_API_KEY env. Supports dotenv.",
+    default: (_b2 = (_a2 = process.env.CANVAS_CLI_API_KEY) != null ? _a2 : process.env.UPM_CLI_API_KEY) != null ? _b2 : process.env.UNIFORM_API_KEY,
     demandOption: true,
     type: "string"
   }).option("apiHost", {
-    describe: "Uniform host. Defaults to UNIFORM_CLI_BASE_URL env or https://uniform.app. Supports dotenv.",
+    describe: "Uniform host. Defaults to UNIFORM_CLI_BASE_URL env var or https://uniform.app. Supports dotenv.",
     default: process.env.UNIFORM_CLI_BASE_URL || "https://uniform.app",
     demandOption: true,
     type: "string"
+  }).option("edgeApiHost", {
+    describe: "Uniform edge host. Defaults to UNIFORM_CLI_BASE_EDGE_URL env var or https://uniform.global. Supports dotenv.",
+    default: process.env.UNIFORM_CLI_BASE_EDGE_URL || "https://uniform.global",
+    demandOption: true,
+    type: "string"
   }).option("proxy", {
     describe: "HTTPS proxy to use for Uniform API calls. Defaults to HTTPS_PROXY, https_proxy, ALL_PROXY, or all_proxy env vars (in that order). Supports dotenv.",
     default: process.env.HTTPS_PROXY || process.env.https_proxy || process.env.ALL_PROXY || process.env.all_proxy,
@@ -18591,6 +18596,7 @@ var CompositionGetModule = {
   ),
   handler: async ({
     apiHost,
+    edgeApiHost,
     apiKey,
     proxy,
     id,
@@ -18604,7 +18610,7 @@ var CompositionGetModule = {
     unstableDataDiagnostics
   }) => {
     const fetch2 = nodeFetchProxy(proxy);
-    const client = new UncachedCanvasClient({ apiKey, apiHost, fetch: fetch2, projectId });
+    const client = new UncachedCanvasClient({ apiKey, edgeApiHost, apiHost, fetch: fetch2, projectId });
     const res = prepCompositionForDisk(
       await client.getCompositionById({
         compositionId: id,

package/dist/{createEventBus-fc82f596.d.ts → createEventBus-bd2e0a92.d.ts}

@@ -2568,14 +2568,8 @@ interface paths$2 {
                         data: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataSource"];
                         /** Format: uuid */
                         projectId: string;
-                        /**
-                         * Format: uuid
-                         * @deprecated
-                         * @description Do not use. Will be removed in future.
-                         */
-                        integrationId?: string;
-                        /** @description The integration type that the data source is attached to. Must be installed in the project. */
-                        integrationType?: string;
+                        /** Format: uuid */
+                        integrationId: string;
                     };
                 };
             };

package/dist/index.d.ts

@@ -1,15 +1,18 @@
 import { ApiClient, ClientOptions, ExceptProject, ApiClientError } from '@uniformdev/context/api';
 export { ApiClientError } from '@uniformdev/context/api';
-import { C as CompositionGetParameters, a as CompositionGetByNodePathParameters, D as DataResolutionOptionNegative, b as CompositionGetResponse, c as DataResolutionOptionPositive, d as DataResolutionParameters, e as CompositionResolvedGetResponse, f as CompositionGetValidResponses, g as DataResolutionOption, h as CompositionGetByNodeIdParameters, i as CompositionGetBySlugParameters, j as CompositionGetByIdParameters, k as CompositionPutParameters, l as CompositionDeleteParameters, m as ComponentDefinitionGetParameters, n as ComponentDefinitionPutParameters, o as ComponentDefinitionDeleteParameters, p as ComponentInstance, q as ComponentParameter, r as components, s as DataSourceGetParameters, t as DataSourcesGetParameters, u as DataSourcePutParameters, v as DataSourceDeleteParameters, w as DataTypeGetParameters, x as DataTypeGetResponse, y as DataTypePutParameters, z as DataTypeDeleteParameters, R as RootComponentInstance, P as PreviewEventBus } from './createEventBus-fc82f596.js';
-export { a1 as CanvasDefinitions, A as ChannelSubscription, O as ComponentDefinition, H as ComponentDefinitionAPIDeleteRequest, G as ComponentDefinitionAPIPutRequest, F as ComponentDefinitionAPIResponse, o as ComponentDefinitionDeleteParameters, m as ComponentDefinitionGetParameters, E as ComponentDefinitionGetResponse, I as ComponentDefinitionListAPIOptions, J as ComponentDefinitionParameter, N as ComponentDefinitionPermission, n as ComponentDefinitionPutParameters, M as ComponentDefinitionSlot, L as ComponentDefinitionSlugSettings, K as ComponentDefinitionVariant, p as ComponentInstance, q as ComponentParameter, W as CompositionAPIDeleteRequest, Y as CompositionAPIOptions, V as CompositionAPIResponse, a8 as CompositionDataDiagnostic, l as CompositionDeleteParameters, j as CompositionGetByIdParameters, h as CompositionGetByNodeIdParameters, a as CompositionGetByNodePathParameters, i as CompositionGetBySlugParameters, U as CompositionGetListResponse, S as CompositionGetOrderBy, C as CompositionGetParameters, b as CompositionGetResponse, f as CompositionGetValidResponses, a2 as CompositionIssue, X as CompositionListAPIResponse, a3 as CompositionPatternIssue, k as CompositionPutParameters, e as CompositionResolvedGetResponse, T as CompositionUIStatus, Q as CreatingComponentDefinition, a4 as DataElementBindingIssue, Z as DataElementConnectionDefinition, a7 as DataResolutionConfigIssue, g as DataResolutionOption, D as DataResolutionOptionNegative, c as DataResolutionOptionPositive, d as DataResolutionParameters, a0 as DataResourceDefinition, $ as DataResourceDefinitions, a5 as DataResourceIssue, a6 as DataResourceVariableIssue, _ as DataResourceVariables, ac as DataSource, v as DataSourceDeleteParameters, s as DataSourceGetParameters, a9 as DataSourceGetResponse, u as DataSourcePutParameters, t as DataSourcesGetParameters, aa as DataSourcesGetResponse, ab as DataType, z as DataTypeDeleteParameters, w as DataTypeGetParameters, x as DataTypeGetResponse, y as DataTypePutParameters, ad as DataVariableDefinition, P as PreviewEventBus, R as RootComponentInstance, B as createEventBus } from './createEventBus-fc82f596.js';
+import { C as CompositionGetParameters, a as CompositionGetByNodePathParameters, D as DataResolutionOptionNegative, b as CompositionGetResponse, c as DataResolutionOptionPositive, d as DataResolutionParameters, e as CompositionResolvedGetResponse, f as CompositionGetValidResponses, g as DataResolutionOption, h as CompositionGetByNodeIdParameters, i as CompositionGetBySlugParameters, j as CompositionGetByIdParameters, k as CompositionPutParameters, l as CompositionDeleteParameters, m as ComponentDefinitionGetParameters, n as ComponentDefinitionPutParameters, o as ComponentDefinitionDeleteParameters, p as ComponentInstance, q as ComponentParameter, r as components, s as DataSourceGetParameters, t as DataSourcesGetParameters, u as DataSourcePutParameters, v as DataSourceDeleteParameters, w as DataTypeGetParameters, x as DataTypeGetResponse, y as DataTypePutParameters, z as DataTypeDeleteParameters, R as RootComponentInstance, P as PreviewEventBus } from './createEventBus-bd2e0a92.js';
+export { a1 as CanvasDefinitions, A as ChannelSubscription, O as ComponentDefinition, H as ComponentDefinitionAPIDeleteRequest, G as ComponentDefinitionAPIPutRequest, F as ComponentDefinitionAPIResponse, o as ComponentDefinitionDeleteParameters, m as ComponentDefinitionGetParameters, E as ComponentDefinitionGetResponse, I as ComponentDefinitionListAPIOptions, J as ComponentDefinitionParameter, N as ComponentDefinitionPermission, n as ComponentDefinitionPutParameters, M as ComponentDefinitionSlot, L as ComponentDefinitionSlugSettings, K as ComponentDefinitionVariant, p as ComponentInstance, q as ComponentParameter, W as CompositionAPIDeleteRequest, Y as CompositionAPIOptions, V as CompositionAPIResponse, a8 as CompositionDataDiagnostic, l as CompositionDeleteParameters, j as CompositionGetByIdParameters, h as CompositionGetByNodeIdParameters, a as CompositionGetByNodePathParameters, i as CompositionGetBySlugParameters, U as CompositionGetListResponse, S as CompositionGetOrderBy, C as CompositionGetParameters, b as CompositionGetResponse, f as CompositionGetValidResponses, a2 as CompositionIssue, X as CompositionListAPIResponse, a3 as CompositionPatternIssue, k as CompositionPutParameters, e as CompositionResolvedGetResponse, T as CompositionUIStatus, Q as CreatingComponentDefinition, a4 as DataElementBindingIssue, Z as DataElementConnectionDefinition, a7 as DataResolutionConfigIssue, g as DataResolutionOption, D as DataResolutionOptionNegative, c as DataResolutionOptionPositive, d as DataResolutionParameters, a0 as DataResourceDefinition, $ as DataResourceDefinitions, a5 as DataResourceIssue, a6 as DataResourceVariableIssue, _ as DataResourceVariables, ac as DataSource, v as DataSourceDeleteParameters, s as DataSourceGetParameters, a9 as DataSourceGetResponse, u as DataSourcePutParameters, t as DataSourcesGetParameters, aa as DataSourcesGetResponse, ab as DataType, z as DataTypeDeleteParameters, w as DataTypeGetParameters, x as DataTypeGetResponse, y as DataTypePutParameters, ad as DataVariableDefinition, P as PreviewEventBus, R as RootComponentInstance, B as createEventBus } from './createEventBus-bd2e0a92.js';
 import { Options as Options$1 } from 'p-retry';
 import { Options } from 'p-throttle';
 import { PersonalizedVariant, TestVariant } from '@uniformdev/context';
 import 'pusher-js';
 
-declare class CanvasClient extends ApiClient<ClientOptions> {
-    constructor(options: ClientOptions);
-    private canvasUrl;
+type CanvasClientOptions = ClientOptions & {
+    edgeApiHost?: string;
+};
+declare class CanvasClient extends ApiClient<CanvasClientOptions> {
+    private edgeApiHost;
+    constructor(options: CanvasClientOptions);
     /** Fetches lists of Canvas compositions, optionally by type */
     getCompositionList(options?: Omit<CompositionGetParameters, 'projectId' | 'compositionId' | 'slug'>): Promise<{
         compositions: {
@@ -199,7 +202,7 @@ declare class CanvasClient extends ApiClient<ClientOptions> {
     removeComponentDefinition(body: Omit<ComponentDefinitionDeleteParameters, 'projectId'>): Promise<void>;
 }
 declare class UncachedCanvasClient extends CanvasClient {
-    constructor(options: Omit<ClientOptions, 'bypassCache'>);
+    constructor(options: Omit<CanvasClientOptions, 'bypassCache'>);
 }
 
 type EnhancerContext = {
@@ -656,8 +659,10 @@ declare const CANVAS_TEST_VARIANT_PARAM = "$tstVrnt";
 declare const CANVAS_ENRICHMENT_TAG_PARAM = "$enr";
 /** The name of the query string used to detect if we are in in-context editing mode */
 declare const IN_CONTEXT_EDITOR_QUERY_STRING_PARAM = "is_incontext_editing_mode";
-/** The value of "data-role" in the component start <script> tag */
+/** The value of "data-role" in the component start `<script>` tag */
 declare const IN_CONTEXT_EDITOR_COMPONENT_START_ROLE = "uniform-component-start";
+/** The ID of the Contextual Editing script that gets embedded in frontend apps */
+declare const IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID = "uniform-canvas-preview-script";
 /** The ID we give to placeholder components */
 declare const PLACEHOLDER_ID = "placeholder";
 /** Minimal value for Edgehancers Cache TTL (in seconds) */
@@ -675,6 +680,88 @@ declare const EDGE_MAX_L2_CACHE_TTL_IN_HOURS: number;
 /** Default value for Edgehancers Long Term Cache TTL (in hours) */
 declare const EDGE_DEFAULT_L2_CACHE_TTL_IN_HOURS = 24;
 
+/**
+ * Creates an enhancer based on an API route.
+ * This is mainly used to create an enhancer for Contextual Editing, which can be passed to the `contextualEditingEnhancer` prop of `<UniformComposition />`.
+ *
+ * @example
+ * ```ts
+ * const enhance = createUniformApiEnhancer({
+ *   apiUrl: '/api/preview',
+ * });
+ * ```
+ */
+declare const createUniformApiEnhancer: ({ apiUrl }: {
+    apiUrl: string;
+}) => (message: UpdateCompositionMessage) => Promise<{
+    type: string;
+    parameters?: {
+        [key: string]: {
+            value: unknown;
+            type: string;
+            connectedData?: {
+                pointer: string;
+                syntax: "jptr";
+                required?: boolean | undefined;
+            } | undefined;
+        };
+    } | undefined;
+    variant?: string | undefined;
+    slots?: {
+        [key: string]: {
+            type: string;
+            parameters?: {
+                [key: string]: {
+                    value: unknown;
+                    type: string;
+                    connectedData?: {
+                        pointer: string;
+                        syntax: "jptr";
+                        required?: boolean | undefined;
+                    } | undefined;
+                };
+            } | undefined;
+            variant?: string | undefined;
+            slots?: {
+                [key: string]: any[];
+            } | undefined;
+            _id?: string | undefined;
+            _pattern?: string | undefined;
+            _dataResources?: {
+                [key: string]: {
+                    type: string;
+                    isPatternParameter?: boolean | undefined;
+                    variables?: {
+                        [key: string]: string;
+                    } | undefined;
+                };
+            } | undefined;
+            _patternDataResources?: {
+                [key: string]: {
+                    type: string;
+                    isPatternParameter?: boolean | undefined;
+                    variables?: {
+                        [key: string]: string;
+                    } | undefined;
+                };
+            } | undefined;
+            _patternError?: "NOTFOUND" | "CYCLIC" | undefined;
+        }[];
+    } | undefined;
+    _id: string;
+    _slug?: string | null | undefined;
+    _name: string;
+    _dataResources?: {
+        [key: string]: {
+            type: string;
+            isPatternParameter?: boolean | undefined;
+            variables?: {
+                [key: string]: string;
+            } | undefined;
+        };
+    } | undefined;
+}>;
+
 declare const generateHash: ({ composition, secret, }: {
     composition: RootComponentInstance;
     secret: string | undefined;
@@ -697,4 +784,4 @@ declare function mapSlotToTestVariations(slot: ComponentInstance[] | undefined):
 
 declare const CanvasClientError: typeof ApiClientError;
 
-export { AddComponentMessage, BatchEnhancer, BatchEntry, CANVAS_DRAFT_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CanvasClient, CanvasClientError, Channel, ChannelMessage, ChildEnhancerBuilder, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentLocationReference, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, DataSourceClient, DataTypeClient, DismissPlaceholderMessage, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_DEFAULT_L2_CACHE_TTL_IN_HOURS, EDGE_MAX_CACHE_TTL, EDGE_MAX_L2_CACHE_TTL_IN_HOURS, EDGE_MIN_CACHE_TTL, EDGE_MIN_L2_CACHE_TTL_IN_HOURS, EnhancerBuilder, EnhancerContext, EnhancerError, EventNames, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, InvalidationInput, InvalidationPayload, InvalidationResult, LimitPolicy, MessageHandler, MoveComponentMessage, PLACEHOLDER_ID, ReadyMessage, SelectComponentMessage, SubscribeToCompositionOptions, UncachedCanvasClient, UniqueBatchEntries, UnsubscribeCallback, UpdateCompositionMessage, WalkComponentTreeActions, compose, createBatchEnhancer, createCanvasChannel, createLimitPolicy, enhance, extractLocales, generateHash, getChannelName, getComponentJsonPointer, getComponentPath, isAddComponentMessage, isDismissPlaceholderMessage, isMovingComponentMessage, isReadyMessage, isSelectComponentMessage, isSystemComponentDefinition, isUpdateCompositionMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, subscribeToComposition, walkComponentTree };
+export { AddComponentMessage, BatchEnhancer, BatchEntry, CANVAS_DRAFT_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CanvasClient, CanvasClientError, Channel, ChannelMessage, ChildEnhancerBuilder, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentLocationReference, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, DataSourceClient, DataTypeClient, DismissPlaceholderMessage, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_DEFAULT_L2_CACHE_TTL_IN_HOURS, EDGE_MAX_CACHE_TTL, EDGE_MAX_L2_CACHE_TTL_IN_HOURS, EDGE_MIN_CACHE_TTL, EDGE_MIN_L2_CACHE_TTL_IN_HOURS, EnhancerBuilder, EnhancerContext, EnhancerError, EventNames, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, InvalidationInput, InvalidationPayload, InvalidationResult, LimitPolicy, MessageHandler, MoveComponentMessage, PLACEHOLDER_ID, ReadyMessage, SelectComponentMessage, SubscribeToCompositionOptions, UncachedCanvasClient, UniqueBatchEntries, UnsubscribeCallback, UpdateCompositionMessage, WalkComponentTreeActions, compose, createBatchEnhancer, createCanvasChannel, createLimitPolicy, createUniformApiEnhancer, enhance, extractLocales, generateHash, getChannelName, getComponentJsonPointer, getComponentPath, isAddComponentMessage, isDismissPlaceholderMessage, isMovingComponentMessage, isReadyMessage, isSelectComponentMessage, isSystemComponentDefinition, isUpdateCompositionMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, subscribeToComposition, walkComponentTree };

package/dist/index.esm.js

@@ -28,6 +28,7 @@ import {
   EDGE_MIN_L2_CACHE_TTL_IN_HOURS,
   EnhancerBuilder,
   IN_CONTEXT_EDITOR_COMPONENT_START_ROLE,
+  IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID,
   IN_CONTEXT_EDITOR_QUERY_STRING_PARAM,
   PLACEHOLDER_ID,
   UncachedCanvasClient,
@@ -37,6 +38,7 @@ import {
   createCanvasChannel,
   createEventBus,
   createLimitPolicy,
+  createUniformApiEnhancer,
   enhance,
   extractLocales,
   generateHash,
@@ -56,7 +58,7 @@ import {
   nullLimitPolicy,
   subscribeToComposition,
   walkComponentTree
-} from "./chunk-FIKDTGXG.mjs";
+} from "./chunk-RFV573P3.mjs";
 export {
   ApiClientError,
   BatchEntry,
@@ -87,6 +89,7 @@ export {
   EDGE_MIN_L2_CACHE_TTL_IN_HOURS,
   EnhancerBuilder,
   IN_CONTEXT_EDITOR_COMPONENT_START_ROLE,
+  IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID,
   IN_CONTEXT_EDITOR_QUERY_STRING_PARAM,
   PLACEHOLDER_ID,
   UncachedCanvasClient,
@@ -96,6 +99,7 @@ export {
   createCanvasChannel,
   createEventBus,
   createLimitPolicy,
+  createUniformApiEnhancer,
   enhance,
   extractLocales,
   generateHash,

package/dist/index.js

@@ -299,6 +299,7 @@ __export(src_exports, {
   EDGE_MIN_L2_CACHE_TTL_IN_HOURS: () => EDGE_MIN_L2_CACHE_TTL_IN_HOURS,
   EnhancerBuilder: () => EnhancerBuilder,
   IN_CONTEXT_EDITOR_COMPONENT_START_ROLE: () => IN_CONTEXT_EDITOR_COMPONENT_START_ROLE,
+  IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID: () => IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID,
   IN_CONTEXT_EDITOR_QUERY_STRING_PARAM: () => IN_CONTEXT_EDITOR_QUERY_STRING_PARAM,
   PLACEHOLDER_ID: () => PLACEHOLDER_ID,
   UncachedCanvasClient: () => UncachedCanvasClient,
@@ -308,6 +309,7 @@ __export(src_exports, {
   createCanvasChannel: () => createCanvasChannel,
   createEventBus: () => createEventBus,
   createLimitPolicy: () => createLimitPolicy,
+  createUniformApiEnhancer: () => createUniformApiEnhancer,
   enhance: () => enhance,
   extractLocales: () => extractLocales,
   generateHash: () => generateHash,
@@ -511,17 +513,19 @@ function createLimitPolicy({
 var nullLimitPolicy = async (func) => await func();
 
 // src/CanvasClient.ts
+var CANVAS_URL = "/api/v1/canvas";
 var CanvasClient = class extends import_api.ApiClient {
   constructor(options) {
+    var _a;
     if (!options.limitPolicy) {
       options.limitPolicy = createLimitPolicy({});
     }
     super(options);
-    this.canvasUrl = "/api/v1/canvas";
+    this.edgeApiHost = (_a = options.edgeApiHost) != null ? _a : "https://uniform.global";
   }
   async getCompositionList(options) {
     const { projectId } = this.options;
-    const fetchUri = this.createUrl(this.canvasUrl, { ...options, projectId });
+    const fetchUri = this.createUrl(CANVAS_URL, { ...options, projectId });
     return await this.apiClient(fetchUri);
   }
   unstable_getCompositionByNodePath(options) {
@@ -543,20 +547,20 @@ var CanvasClient = class extends import_api.ApiClient {
     ...params
   }) {
     const { projectId } = this.options;
-    const url = resolveData ? "/api/edge/v1/composition" : this.canvasUrl;
-    const dataResolutionParams = {};
-    if (resolveData) {
-      if (dynamicVariables) {
-        dataResolutionParams.dynamicVariables = JSON.stringify(dynamicVariables);
-      }
-      if (dataDiagnostics) {
-        dataResolutionParams.dataDiagnostics = "true";
-      }
+    if (!resolveData) {
+      return this.apiClient(this.createUrl(CANVAS_URL, { ...params, projectId }));
     }
-    return this.apiClient(this.createUrl(url, { ...params, ...dataResolutionParams, projectId }));
+    const edgeParams = {
+      ...params,
+      projectId,
+      ...dynamicVariables ? { dynamicVariables: JSON.stringify(dynamicVariables) } : {},
+      ...dataDiagnostics ? { dataDiagnostics: "true" } : {}
+    };
+    const edgeUrl = this.createUrl("/api/v1/composition", edgeParams, this.edgeApiHost);
+    return this.apiClient(edgeUrl);
   }
   async updateComposition(body) {
-    const fetchUri = this.createUrl("/api/v1/canvas");
+    const fetchUri = this.createUrl(CANVAS_URL);
     await this.apiClient(fetchUri, {
       method: "PUT",
       body: JSON.stringify({ ...body, projectId: this.options.projectId }),
@@ -564,7 +568,7 @@ var CanvasClient = class extends import_api.ApiClient {
     });
   }
   async removeComposition(body) {
-    const fetchUri = this.createUrl("/api/v1/canvas");
+    const fetchUri = this.createUrl(CANVAS_URL);
     const { projectId } = this.options;
     await this.apiClient(fetchUri, {
       method: "DELETE",
@@ -1127,6 +1131,7 @@ 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_COMPONENT_START_ROLE = "uniform-component-start";
+var IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID = "uniform-canvas-preview-script";
 var PLACEHOLDER_ID = "placeholder";
 var EDGE_MIN_CACHE_TTL = 15;
 var EDGE_MAX_CACHE_TTL = 600;
@@ -1419,6 +1424,28 @@ function subscribeToComposition({
   };
 }
 
+// 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("$");
@@ -1489,6 +1516,7 @@ var CanvasClientError = import_api4.ApiClientError;
   EDGE_MIN_L2_CACHE_TTL_IN_HOURS,
   EnhancerBuilder,
   IN_CONTEXT_EDITOR_COMPONENT_START_ROLE,
+  IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID,
   IN_CONTEXT_EDITOR_QUERY_STRING_PARAM,
   PLACEHOLDER_ID,
   UncachedCanvasClient,
@@ -1498,6 +1526,7 @@ var CanvasClientError = import_api4.ApiClientError;
   createCanvasChannel,
   createEventBus,
   createLimitPolicy,
+  createUniformApiEnhancer,
   enhance,
   extractLocales,
   generateHash,

package/dist/index.mjs

@@ -28,6 +28,7 @@ import {
   EDGE_MIN_L2_CACHE_TTL_IN_HOURS,
   EnhancerBuilder,
   IN_CONTEXT_EDITOR_COMPONENT_START_ROLE,
+  IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID,
   IN_CONTEXT_EDITOR_QUERY_STRING_PARAM,
   PLACEHOLDER_ID,
   UncachedCanvasClient,
@@ -37,6 +38,7 @@ import {
   createCanvasChannel,
   createEventBus,
   createLimitPolicy,
+  createUniformApiEnhancer,
   enhance,
   extractLocales,
   generateHash,
@@ -56,7 +58,7 @@ import {
   nullLimitPolicy,
   subscribeToComposition,
   walkComponentTree
-} from "./chunk-FIKDTGXG.mjs";
+} from "./chunk-RFV573P3.mjs";
 export {
   ApiClientError,
   BatchEntry,
@@ -87,6 +89,7 @@ export {
   EDGE_MIN_L2_CACHE_TTL_IN_HOURS,
   EnhancerBuilder,
   IN_CONTEXT_EDITOR_COMPONENT_START_ROLE,
+  IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID,
   IN_CONTEXT_EDITOR_QUERY_STRING_PARAM,
   PLACEHOLDER_ID,
   UncachedCanvasClient,
@@ -96,6 +99,7 @@ export {
   createCanvasChannel,
   createEventBus,
   createLimitPolicy,
+  createUniformApiEnhancer,
   enhance,
   extractLocales,
   generateHash,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/canvas",
-  "version": "18.1.1-alpha.11+c81a052e2",
+  "version": "18.1.2-alpha.7+682b9aac6",
   "description": "Common functionality and types for Uniform Canvas",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -48,16 +48,16 @@
   },
   "devDependencies": {
     "@types/retry": "0.12.1",
-    "@types/yargs": "17.0.19",
-    "@uniformdev/cli": "18.1.1-alpha.11+c81a052e2",
+    "@types/yargs": "17.0.20",
+    "@uniformdev/cli": "18.1.2-alpha.7+682b9aac6",
     "p-limit": "4.0.0",
     "p-retry": "5.1.2",
     "p-throttle": "5.0.0",
-    "pusher-js": "8.0.0",
+    "pusher-js": "8.0.1",
     "yargs": "17.6.2"
   },
   "dependencies": {
-    "@uniformdev/context": "18.1.1-alpha.11+c81a052e2"
+    "@uniformdev/context": "18.1.2-alpha.7+682b9aac6"
   },
   "files": [
     "/dist"
@@ -65,5 +65,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "c81a052e2c13c6d3d786d7030f11a7724a52b2da"
+  "gitHead": "682b9aac6143d5f462a7126f4ceab55a7c7d0c09"
 }