@uniformdev/canvas 18.0.1-alpha.7 → 18.1.2-alpha.4

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

@@ -1091,6 +1091,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 +1384,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 +1488,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 +1511,7 @@ export {
   createEventBus,
   getChannelName,
   subscribeToComposition,
+  createUniformApiEnhancer,
   isSystemComponentDefinition,
   mapSlotToPersonalizedVariations,
   mapSlotToTestVariations,

package/dist/cli/cli.mjs

@@ -14,7 +14,7 @@ import {
   __require,
   __toCommonJS,
   __toESM
-} from "../chunk-FIKDTGXG.mjs";
+} from "../chunk-D45SO56S.mjs";
 
 // ../../node_modules/.pnpm/ms@2.1.2/node_modules/ms/index.js
 var require_ms = __commonJS({

package/dist/index.d.ts

@@ -656,8 +656,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 +677,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 +781,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-D45SO56S.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,
@@ -1127,6 +1129,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 +1422,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 +1514,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 +1524,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-D45SO56S.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.0.1-alpha.7+919e1112a",
+  "version": "18.1.2-alpha.4+e9d268bce",
   "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.0.1-alpha.7+919e1112a",
+    "@types/yargs": "17.0.20",
+    "@uniformdev/cli": "18.1.2-alpha.4+e9d268bce",
     "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.0.1-alpha.7+919e1112a"
+    "@uniformdev/context": "18.1.2-alpha.4+e9d268bce"
   },
   "files": [
     "/dist"
@@ -65,5 +65,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "919e1112a0e44600072a7309798a55bcf70fc0ed"
+  "gitHead": "e9d268bcef28fc22632f4968ca988e3b0b92d146"
 }