@uniformdev/canvas 18.28.0 → 18.29.2-alpha.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -3358,6 +3358,10 @@ declare class UncachedCanvasClient extends CanvasClient {
3358
3358
  constructor(options: Omit<CanvasClientOptions, 'bypassCache'>);
3359
3359
  }
3360
3360
 
3361
+ type PreviewPanelSettings = {
3362
+ isInteractive: boolean;
3363
+ };
3364
+
3361
3365
  /**
3362
3366
  * This file was auto-generated by openapi-typescript.
3363
3367
  * Do not make direct changes to the file.
@@ -5493,23 +5497,36 @@ type DismissPlaceholderMessage = {
5493
5497
  parentId: string;
5494
5498
  slotName: string;
5495
5499
  };
5496
- type ChannelMessage = SelectComponentMessage | ReadyMessage | UpdateCompositionMessage | AddComponentMessage | MoveComponentMessage | DismissPlaceholderMessage;
5500
+ type UpdatePreviewSettingsMessage = {
5501
+ type: 'update-preview-settings';
5502
+ settings: PreviewPanelSettings;
5503
+ };
5504
+ type ReportRenderedCompositionsMessage = {
5505
+ type: 'report-rendered-compositions';
5506
+ compositionIds: string[];
5507
+ url: string;
5508
+ };
5509
+ type ChannelMessage = SelectComponentMessage | ReadyMessage | UpdateCompositionMessage | AddComponentMessage | MoveComponentMessage | DismissPlaceholderMessage | UpdatePreviewSettingsMessage | ReportRenderedCompositionsMessage;
5497
5510
  declare const isSelectComponentMessage: (message: ChannelMessage) => message is SelectComponentMessage;
5498
5511
  declare const isReadyMessage: (message: ChannelMessage) => message is ReadyMessage;
5499
5512
  declare const isUpdateCompositionMessage: (message: ChannelMessage) => message is UpdateCompositionMessage;
5500
5513
  declare const isAddComponentMessage: (message: ChannelMessage) => message is AddComponentMessage;
5501
5514
  declare const isMovingComponentMessage: (message: ChannelMessage) => message is MoveComponentMessage;
5502
5515
  declare const isDismissPlaceholderMessage: (message: ChannelMessage) => message is DismissPlaceholderMessage;
5516
+ declare const isUpdatePreviewSettingsMessage: (message: ChannelMessage) => message is UpdatePreviewSettingsMessage;
5517
+ declare const isReportRenderedCompositionsMessage: (message: ChannelMessage) => message is ReportRenderedCompositionsMessage;
5503
5518
  type MessageHandler = (message: ChannelMessage, originalEvent: MessageEvent) => void;
5504
5519
  type Channel = {
5520
+ on: (types: ChannelMessage['type'][] | ChannelMessage['type'], handler: MessageHandler) => () => void;
5505
5521
  ready: () => void;
5506
5522
  destroy: () => void;
5507
5523
  selectComponent: (id: string) => void;
5508
5524
  updateComposition: (component: RootComponentInstance, secret?: string) => void;
5509
- on: (types: ChannelMessage['type'][] | ChannelMessage['type'], handler: MessageHandler) => () => void;
5510
5525
  addComponent: (options: Omit<AddComponentMessage, 'type'>) => void;
5511
5526
  moveComponent: (options: Omit<MoveComponentMessage, 'type'>) => void;
5512
5527
  dismissPlaceholder: (options: Omit<DismissPlaceholderMessage, 'type'>) => void;
5528
+ updatePreviewSettings: (options: Omit<UpdatePreviewSettingsMessage, 'type'>) => void;
5529
+ reportRenderedCompositions: (options: Omit<ReportRenderedCompositionsMessage, 'type'>) => void;
5513
5530
  };
5514
5531
  declare const createCanvasChannel: ({ listenTo, broadcastTo, }: {
5515
5532
  listenTo: Window[];
@@ -5587,6 +5604,8 @@ declare const CANVAS_ENRICHMENT_TAG_PARAM = "$enr";
5587
5604
  declare const IN_CONTEXT_EDITOR_QUERY_STRING_PARAM = "is_incontext_editing_mode";
5588
5605
  /** The value of "data-role" in the component start `<script>` tag */
5589
5606
  declare const IN_CONTEXT_EDITOR_COMPONENT_START_ROLE = "uniform-component-start";
5607
+ /** The value of "data-role" in the component end `<script>` tag */
5608
+ declare const IN_CONTEXT_EDITOR_COMPONENT_END_ROLE = "uniform-component-end";
5590
5609
  /** The ID of the Contextual Editing script that gets embedded in frontend apps */
5591
5610
  declare const IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID = "uniform-canvas-preview-script";
5592
5611
  /** The ID we give to placeholder components */
@@ -5762,4 +5781,4 @@ declare function mapSlotToTestVariations(slot: ComponentInstance[] | undefined):
5762
5781
 
5763
5782
  declare const CanvasClientError: typeof ApiClientError;
5764
5783
 
5765
- export { AddComponentMessage, BatchEnhancer, BatchEntry, BatchInvalidationPayload, 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, CanvasDefinitions, Channel, ChannelMessage, ChannelSubscription, ChildEnhancerBuilder, ComponentDefinition, ComponentDefinitionAPIDeleteRequest, ComponentDefinitionAPIPutRequest, ComponentDefinitionAPIResponse, ComponentDefinitionDeleteParameters, ComponentDefinitionGetParameters, ComponentDefinitionGetResponse, ComponentDefinitionListAPIOptions, ComponentDefinitionParameter, ComponentDefinitionPermission, ComponentDefinitionPutParameters, ComponentDefinitionSlot, ComponentDefinitionSlugSettings, ComponentDefinitionVariant, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentInstance, ComponentLocationReference, ComponentOverridability, ComponentOverride, ComponentOverrides, ComponentParameter, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, CompositionAPIDeleteRequest, CompositionAPIOptions, CompositionAPIResponse, CompositionDataDiagnostic, CompositionDeleteParameters, CompositionDiagnostics, CompositionGetByIdParameters, CompositionGetByNodeIdParameters, CompositionGetByNodePathParameters, CompositionGetBySlugParameters, CompositionGetListResponse, CompositionGetOrderBy, CompositionGetParameters, CompositionGetResponse, CompositionGetValidResponses, CompositionIssue, CompositionListAPIResponse, CompositionPatternIssue, CompositionPutParameters, CompositionResolvedGetResponse, CompositionUIStatus, CreatingComponentDefinition, DataElementBindingIssue, DataElementConnectionDefinition, DataResolutionConfigIssue, DataResolutionOption, DataResolutionOptionNegative, DataResolutionOptionPositive, DataResolutionParameters, DataResourceDefinition, DataResourceDefinitions, DataResourceIssue, DataResourceVariableIssue, DataResourceVariables, DataSource, DataSourceClient, DataSourceDeleteParameters, DataSourceGetParameters, DataSourceGetResponse, DataSourcePutParameters, DataSourcesGetParameters, DataSourcesGetResponse, DataType, DataTypeClient, DataTypeDeleteParameters, DataTypeGetParameters, DataTypeGetResponse, DataTypePutParameters, DataVariableDefinition, 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, InvalidationPayload, InvalidationResult, LimitPolicy, MessageHandler, MoveComponentMessage, OverrideIssue, OverrideOptions, PLACEHOLDER_ID, PreviewEventBus, ReadyMessage, RootComponentInstance, SelectComponentMessage, SpecificProjectMap, SubscribeToCompositionOptions, UncachedCanvasClient, UniqueBatchEntries, UnsubscribeCallback, UpdateCompositionMessage, WalkComponentTreeActions, compose, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, enhance, extractLocales, generateHash, getChannelName, getComponentJsonPointer, getComponentPath, isAddComponentMessage, isDismissPlaceholderMessage, isMovingComponentMessage, isReadyMessage, isSelectComponentMessage, isSystemComponentDefinition, isUpdateCompositionMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, subscribeToComposition, walkComponentTree };
5784
+ export { AddComponentMessage, BatchEnhancer, BatchEntry, BatchInvalidationPayload, 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, CanvasDefinitions, Channel, ChannelMessage, ChannelSubscription, ChildEnhancerBuilder, ComponentDefinition, ComponentDefinitionAPIDeleteRequest, ComponentDefinitionAPIPutRequest, ComponentDefinitionAPIResponse, ComponentDefinitionDeleteParameters, ComponentDefinitionGetParameters, ComponentDefinitionGetResponse, ComponentDefinitionListAPIOptions, ComponentDefinitionParameter, ComponentDefinitionPermission, ComponentDefinitionPutParameters, ComponentDefinitionSlot, ComponentDefinitionSlugSettings, ComponentDefinitionVariant, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentInstance, ComponentLocationReference, ComponentOverridability, ComponentOverride, ComponentOverrides, ComponentParameter, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, CompositionAPIDeleteRequest, CompositionAPIOptions, CompositionAPIResponse, CompositionDataDiagnostic, CompositionDeleteParameters, CompositionDiagnostics, CompositionGetByIdParameters, CompositionGetByNodeIdParameters, CompositionGetByNodePathParameters, CompositionGetBySlugParameters, CompositionGetListResponse, CompositionGetOrderBy, CompositionGetParameters, CompositionGetResponse, CompositionGetValidResponses, CompositionIssue, CompositionListAPIResponse, CompositionPatternIssue, CompositionPutParameters, CompositionResolvedGetResponse, CompositionUIStatus, CreatingComponentDefinition, DataElementBindingIssue, DataElementConnectionDefinition, DataResolutionConfigIssue, DataResolutionOption, DataResolutionOptionNegative, DataResolutionOptionPositive, DataResolutionParameters, DataResourceDefinition, DataResourceDefinitions, DataResourceIssue, DataResourceVariableIssue, DataResourceVariables, DataSource, DataSourceClient, DataSourceDeleteParameters, DataSourceGetParameters, DataSourceGetResponse, DataSourcePutParameters, DataSourcesGetParameters, DataSourcesGetResponse, DataType, DataTypeClient, DataTypeDeleteParameters, DataTypeGetParameters, DataTypeGetResponse, DataTypePutParameters, DataVariableDefinition, 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_END_ROLE, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, InvalidationPayload, InvalidationResult, LimitPolicy, MessageHandler, MoveComponentMessage, OverrideIssue, OverrideOptions, PLACEHOLDER_ID, PreviewEventBus, PreviewPanelSettings, ReadyMessage, ReportRenderedCompositionsMessage, RootComponentInstance, SelectComponentMessage, SpecificProjectMap, SubscribeToCompositionOptions, UncachedCanvasClient, UniqueBatchEntries, UnsubscribeCallback, UpdateCompositionMessage, UpdatePreviewSettingsMessage, WalkComponentTreeActions, compose, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, enhance, extractLocales, generateHash, getChannelName, getComponentJsonPointer, getComponentPath, isAddComponentMessage, isDismissPlaceholderMessage, isMovingComponentMessage, isReadyMessage, isReportRenderedCompositionsMessage, isSelectComponentMessage, isSystemComponentDefinition, isUpdateCompositionMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, subscribeToComposition, walkComponentTree };
package/dist/index.esm.js CHANGED
@@ -1127,6 +1127,7 @@ var CANVAS_TEST_VARIANT_PARAM = "$tstVrnt";
1127
1127
  var CANVAS_ENRICHMENT_TAG_PARAM = "$enr";
1128
1128
  var IN_CONTEXT_EDITOR_QUERY_STRING_PARAM = "is_incontext_editing_mode";
1129
1129
  var IN_CONTEXT_EDITOR_COMPONENT_START_ROLE = "uniform-component-start";
1130
+ var IN_CONTEXT_EDITOR_COMPONENT_END_ROLE = "uniform-component-end";
1130
1131
  var IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID = "uniform-canvas-preview-script";
1131
1132
  var PLACEHOLDER_ID = "placeholder";
1132
1133
  var EDGE_MIN_CACHE_TTL = 15;
@@ -1241,6 +1242,12 @@ var isMovingComponentMessage = (message) => {
1241
1242
  var isDismissPlaceholderMessage = (message) => {
1242
1243
  return message.type === "dismiss-placeholder";
1243
1244
  };
1245
+ var isUpdatePreviewSettingsMessage = (message) => {
1246
+ return message.type === "update-preview-settings";
1247
+ };
1248
+ var isReportRenderedCompositionsMessage = (message) => {
1249
+ return message.type === "report-rendered-compositions";
1250
+ };
1244
1251
  var createCanvasChannel = ({
1245
1252
  listenTo,
1246
1253
  broadcastTo
@@ -1312,6 +1319,20 @@ var createCanvasChannel = ({
1312
1319
  };
1313
1320
  postMessage(message);
1314
1321
  };
1322
+ const updatePreviewSettings = (options) => {
1323
+ const message = {
1324
+ ...options,
1325
+ type: "update-preview-settings"
1326
+ };
1327
+ postMessage(message);
1328
+ };
1329
+ const reportRenderedCompositions = (options) => {
1330
+ const message = {
1331
+ ...options,
1332
+ type: "report-rendered-compositions"
1333
+ };
1334
+ postMessage(message);
1335
+ };
1315
1336
  const messageEventListener = (event) => {
1316
1337
  if (typeof event.data !== "string" || event.source === window) {
1317
1338
  return;
@@ -1346,7 +1367,9 @@ var createCanvasChannel = ({
1346
1367
  on,
1347
1368
  addComponent,
1348
1369
  moveComponent,
1349
- dismissPlaceholder
1370
+ dismissPlaceholder,
1371
+ updatePreviewSettings,
1372
+ reportRenderedCompositions
1350
1373
  };
1351
1374
  };
1352
1375
 
@@ -1519,6 +1542,7 @@ export {
1519
1542
  EDGE_MIN_CACHE_TTL,
1520
1543
  EDGE_MIN_L2_CACHE_TTL_IN_HOURS,
1521
1544
  EnhancerBuilder,
1545
+ IN_CONTEXT_EDITOR_COMPONENT_END_ROLE,
1522
1546
  IN_CONTEXT_EDITOR_COMPONENT_START_ROLE,
1523
1547
  IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID,
1524
1548
  IN_CONTEXT_EDITOR_QUERY_STRING_PARAM,
@@ -1541,9 +1565,11 @@ export {
1541
1565
  isDismissPlaceholderMessage,
1542
1566
  isMovingComponentMessage,
1543
1567
  isReadyMessage,
1568
+ isReportRenderedCompositionsMessage,
1544
1569
  isSelectComponentMessage,
1545
1570
  isSystemComponentDefinition,
1546
1571
  isUpdateCompositionMessage,
1572
+ isUpdatePreviewSettingsMessage,
1547
1573
  localize,
1548
1574
  mapSlotToPersonalizedVariations,
1549
1575
  mapSlotToTestVariations,
package/dist/index.js CHANGED
@@ -302,6 +302,7 @@ __export(src_exports, {
302
302
  EDGE_MIN_CACHE_TTL: () => EDGE_MIN_CACHE_TTL,
303
303
  EDGE_MIN_L2_CACHE_TTL_IN_HOURS: () => EDGE_MIN_L2_CACHE_TTL_IN_HOURS,
304
304
  EnhancerBuilder: () => EnhancerBuilder,
305
+ IN_CONTEXT_EDITOR_COMPONENT_END_ROLE: () => IN_CONTEXT_EDITOR_COMPONENT_END_ROLE,
305
306
  IN_CONTEXT_EDITOR_COMPONENT_START_ROLE: () => IN_CONTEXT_EDITOR_COMPONENT_START_ROLE,
306
307
  IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID: () => IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID,
307
308
  IN_CONTEXT_EDITOR_QUERY_STRING_PARAM: () => IN_CONTEXT_EDITOR_QUERY_STRING_PARAM,
@@ -324,9 +325,11 @@ __export(src_exports, {
324
325
  isDismissPlaceholderMessage: () => isDismissPlaceholderMessage,
325
326
  isMovingComponentMessage: () => isMovingComponentMessage,
326
327
  isReadyMessage: () => isReadyMessage,
328
+ isReportRenderedCompositionsMessage: () => isReportRenderedCompositionsMessage,
327
329
  isSelectComponentMessage: () => isSelectComponentMessage,
328
330
  isSystemComponentDefinition: () => isSystemComponentDefinition,
329
331
  isUpdateCompositionMessage: () => isUpdateCompositionMessage,
332
+ isUpdatePreviewSettingsMessage: () => isUpdatePreviewSettingsMessage,
330
333
  localize: () => localize,
331
334
  mapSlotToPersonalizedVariations: () => mapSlotToPersonalizedVariations,
332
335
  mapSlotToTestVariations: () => mapSlotToTestVariations,
@@ -1198,6 +1201,7 @@ var CANVAS_TEST_VARIANT_PARAM = "$tstVrnt";
1198
1201
  var CANVAS_ENRICHMENT_TAG_PARAM = "$enr";
1199
1202
  var IN_CONTEXT_EDITOR_QUERY_STRING_PARAM = "is_incontext_editing_mode";
1200
1203
  var IN_CONTEXT_EDITOR_COMPONENT_START_ROLE = "uniform-component-start";
1204
+ var IN_CONTEXT_EDITOR_COMPONENT_END_ROLE = "uniform-component-end";
1201
1205
  var IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID = "uniform-canvas-preview-script";
1202
1206
  var PLACEHOLDER_ID = "placeholder";
1203
1207
  var EDGE_MIN_CACHE_TTL = 15;
@@ -1312,6 +1316,12 @@ var isMovingComponentMessage = (message) => {
1312
1316
  var isDismissPlaceholderMessage = (message) => {
1313
1317
  return message.type === "dismiss-placeholder";
1314
1318
  };
1319
+ var isUpdatePreviewSettingsMessage = (message) => {
1320
+ return message.type === "update-preview-settings";
1321
+ };
1322
+ var isReportRenderedCompositionsMessage = (message) => {
1323
+ return message.type === "report-rendered-compositions";
1324
+ };
1315
1325
  var createCanvasChannel = ({
1316
1326
  listenTo,
1317
1327
  broadcastTo
@@ -1383,6 +1393,20 @@ var createCanvasChannel = ({
1383
1393
  };
1384
1394
  postMessage(message);
1385
1395
  };
1396
+ const updatePreviewSettings = (options) => {
1397
+ const message = {
1398
+ ...options,
1399
+ type: "update-preview-settings"
1400
+ };
1401
+ postMessage(message);
1402
+ };
1403
+ const reportRenderedCompositions = (options) => {
1404
+ const message = {
1405
+ ...options,
1406
+ type: "report-rendered-compositions"
1407
+ };
1408
+ postMessage(message);
1409
+ };
1386
1410
  const messageEventListener = (event) => {
1387
1411
  if (typeof event.data !== "string" || event.source === window) {
1388
1412
  return;
@@ -1417,7 +1441,9 @@ var createCanvasChannel = ({
1417
1441
  on,
1418
1442
  addComponent,
1419
1443
  moveComponent,
1420
- dismissPlaceholder
1444
+ dismissPlaceholder,
1445
+ updatePreviewSettings,
1446
+ reportRenderedCompositions
1421
1447
  };
1422
1448
  };
1423
1449
 
@@ -1591,6 +1617,7 @@ var CanvasClientError = import_api4.ApiClientError;
1591
1617
  EDGE_MIN_CACHE_TTL,
1592
1618
  EDGE_MIN_L2_CACHE_TTL_IN_HOURS,
1593
1619
  EnhancerBuilder,
1620
+ IN_CONTEXT_EDITOR_COMPONENT_END_ROLE,
1594
1621
  IN_CONTEXT_EDITOR_COMPONENT_START_ROLE,
1595
1622
  IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID,
1596
1623
  IN_CONTEXT_EDITOR_QUERY_STRING_PARAM,
@@ -1613,9 +1640,11 @@ var CanvasClientError = import_api4.ApiClientError;
1613
1640
  isDismissPlaceholderMessage,
1614
1641
  isMovingComponentMessage,
1615
1642
  isReadyMessage,
1643
+ isReportRenderedCompositionsMessage,
1616
1644
  isSelectComponentMessage,
1617
1645
  isSystemComponentDefinition,
1618
1646
  isUpdateCompositionMessage,
1647
+ isUpdatePreviewSettingsMessage,
1619
1648
  localize,
1620
1649
  mapSlotToPersonalizedVariations,
1621
1650
  mapSlotToTestVariations,
package/dist/index.mjs CHANGED
@@ -1127,6 +1127,7 @@ var CANVAS_TEST_VARIANT_PARAM = "$tstVrnt";
1127
1127
  var CANVAS_ENRICHMENT_TAG_PARAM = "$enr";
1128
1128
  var IN_CONTEXT_EDITOR_QUERY_STRING_PARAM = "is_incontext_editing_mode";
1129
1129
  var IN_CONTEXT_EDITOR_COMPONENT_START_ROLE = "uniform-component-start";
1130
+ var IN_CONTEXT_EDITOR_COMPONENT_END_ROLE = "uniform-component-end";
1130
1131
  var IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID = "uniform-canvas-preview-script";
1131
1132
  var PLACEHOLDER_ID = "placeholder";
1132
1133
  var EDGE_MIN_CACHE_TTL = 15;
@@ -1241,6 +1242,12 @@ var isMovingComponentMessage = (message) => {
1241
1242
  var isDismissPlaceholderMessage = (message) => {
1242
1243
  return message.type === "dismiss-placeholder";
1243
1244
  };
1245
+ var isUpdatePreviewSettingsMessage = (message) => {
1246
+ return message.type === "update-preview-settings";
1247
+ };
1248
+ var isReportRenderedCompositionsMessage = (message) => {
1249
+ return message.type === "report-rendered-compositions";
1250
+ };
1244
1251
  var createCanvasChannel = ({
1245
1252
  listenTo,
1246
1253
  broadcastTo
@@ -1312,6 +1319,20 @@ var createCanvasChannel = ({
1312
1319
  };
1313
1320
  postMessage(message);
1314
1321
  };
1322
+ const updatePreviewSettings = (options) => {
1323
+ const message = {
1324
+ ...options,
1325
+ type: "update-preview-settings"
1326
+ };
1327
+ postMessage(message);
1328
+ };
1329
+ const reportRenderedCompositions = (options) => {
1330
+ const message = {
1331
+ ...options,
1332
+ type: "report-rendered-compositions"
1333
+ };
1334
+ postMessage(message);
1335
+ };
1315
1336
  const messageEventListener = (event) => {
1316
1337
  if (typeof event.data !== "string" || event.source === window) {
1317
1338
  return;
@@ -1346,7 +1367,9 @@ var createCanvasChannel = ({
1346
1367
  on,
1347
1368
  addComponent,
1348
1369
  moveComponent,
1349
- dismissPlaceholder
1370
+ dismissPlaceholder,
1371
+ updatePreviewSettings,
1372
+ reportRenderedCompositions
1350
1373
  };
1351
1374
  };
1352
1375
 
@@ -1519,6 +1542,7 @@ export {
1519
1542
  EDGE_MIN_CACHE_TTL,
1520
1543
  EDGE_MIN_L2_CACHE_TTL_IN_HOURS,
1521
1544
  EnhancerBuilder,
1545
+ IN_CONTEXT_EDITOR_COMPONENT_END_ROLE,
1522
1546
  IN_CONTEXT_EDITOR_COMPONENT_START_ROLE,
1523
1547
  IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID,
1524
1548
  IN_CONTEXT_EDITOR_QUERY_STRING_PARAM,
@@ -1541,9 +1565,11 @@ export {
1541
1565
  isDismissPlaceholderMessage,
1542
1566
  isMovingComponentMessage,
1543
1567
  isReadyMessage,
1568
+ isReportRenderedCompositionsMessage,
1544
1569
  isSelectComponentMessage,
1545
1570
  isSystemComponentDefinition,
1546
1571
  isUpdateCompositionMessage,
1572
+ isUpdatePreviewSettingsMessage,
1547
1573
  localize,
1548
1574
  mapSlotToPersonalizedVariations,
1549
1575
  mapSlotToTestVariations,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uniformdev/canvas",
3
- "version": "18.28.0",
3
+ "version": "18.29.2-alpha.11+299df8405",
4
4
  "description": "Common functionality and types for Uniform Canvas",
5
5
  "license": "SEE LICENSE IN LICENSE.txt",
6
6
  "main": "./dist/index.js",
@@ -47,7 +47,7 @@
47
47
  "pusher-js": "8.0.1"
48
48
  },
49
49
  "dependencies": {
50
- "@uniformdev/context": "18.28.0"
50
+ "@uniformdev/context": "18.29.2-alpha.11+299df8405"
51
51
  },
52
52
  "files": [
53
53
  "/dist"
@@ -55,5 +55,5 @@
55
55
  "publishConfig": {
56
56
  "access": "public"
57
57
  },
58
- "gitHead": "97d916ca20965e8a86d2454847114068895ccddd"
58
+ "gitHead": "299df840521b9a41a3e683a9095b7b5f45a8cf12"
59
59
  }