@uniformdev/canvas 18.34.1-alpha.57 → 18.35.1-alpha.16

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
@@ -2908,6 +2908,13 @@ type ComponentParameter<TValue = unknown> = Omit<SharedComponents['ComponentPara
2908
2908
  /** The type of the parameter. Determines how it is displayed when editing, and tells the consumer how to process it. */
2909
2909
  value: TValue;
2910
2910
  };
2911
+ /** The type of the parameters in contextual editing mode. */
2912
+ type ComponentParameterContextualEditing<TValue = unknown> = ComponentParameter<TValue> & {
2913
+ /** Data used for visual editing. It's not supposed to be used externally. The format might change without prior notice. */
2914
+ _contextualEditing?: {
2915
+ isEditable?: boolean;
2916
+ };
2917
+ };
2911
2918
  /** Defines a connection to a data element on a data resource. */
2912
2919
  type DataElementConnectionDefinition = SharedComponents['DataElementConnectionDefinition'];
2913
2920
  /** Variable values for a data resource. */
@@ -5420,6 +5427,11 @@ type UpdateCompositionMessage = {
5420
5427
  composition: RootComponentInstance;
5421
5428
  hash: number | undefined;
5422
5429
  };
5430
+ type UpdateCompositionInternalMessage = {
5431
+ type: 'update-composition-internal';
5432
+ composition: RootComponentInstance;
5433
+ hash: number | undefined;
5434
+ };
5423
5435
  type AddComponentMessage = {
5424
5436
  type: 'add-component';
5425
5437
  parentId: string;
@@ -5433,6 +5445,12 @@ type MoveComponentMessage = {
5433
5445
  index: number;
5434
5446
  direction: 'up' | 'down';
5435
5447
  };
5448
+ type UpdateComponentParameterMessage = {
5449
+ type: 'update-component-parameter';
5450
+ componentId: string;
5451
+ parameterId: string;
5452
+ value: string | number | undefined;
5453
+ };
5436
5454
  type DismissPlaceholderMessage = {
5437
5455
  type: 'dismiss-placeholder';
5438
5456
  parentId: string;
@@ -5447,12 +5465,14 @@ type ReportRenderedCompositionsMessage = {
5447
5465
  compositionIds: string[];
5448
5466
  url: string;
5449
5467
  };
5450
- type ChannelMessage = SelectComponentMessage | ReadyMessage | UpdateCompositionMessage | AddComponentMessage | MoveComponentMessage | DismissPlaceholderMessage | UpdatePreviewSettingsMessage | ReportRenderedCompositionsMessage;
5468
+ type ChannelMessage = SelectComponentMessage | ReadyMessage | UpdateCompositionMessage | UpdateCompositionInternalMessage | AddComponentMessage | MoveComponentMessage | DismissPlaceholderMessage | UpdatePreviewSettingsMessage | ReportRenderedCompositionsMessage | UpdateComponentParameterMessage | DismissPlaceholderMessage;
5451
5469
  declare const isSelectComponentMessage: (message: ChannelMessage) => message is SelectComponentMessage;
5452
5470
  declare const isReadyMessage: (message: ChannelMessage) => message is ReadyMessage;
5453
5471
  declare const isUpdateCompositionMessage: (message: ChannelMessage) => message is UpdateCompositionMessage;
5472
+ declare const isUpdateCompositionInternalMessage: (message: ChannelMessage) => message is UpdateCompositionInternalMessage;
5454
5473
  declare const isAddComponentMessage: (message: ChannelMessage) => message is AddComponentMessage;
5455
5474
  declare const isMovingComponentMessage: (message: ChannelMessage) => message is MoveComponentMessage;
5475
+ declare const isUpdateComponentParameterMessage: (message: ChannelMessage) => message is UpdateComponentParameterMessage;
5456
5476
  declare const isDismissPlaceholderMessage: (message: ChannelMessage) => message is DismissPlaceholderMessage;
5457
5477
  declare const isUpdatePreviewSettingsMessage: (message: ChannelMessage) => message is UpdatePreviewSettingsMessage;
5458
5478
  declare const isReportRenderedCompositionsMessage: (message: ChannelMessage) => message is ReportRenderedCompositionsMessage;
@@ -5462,9 +5482,11 @@ type Channel = {
5462
5482
  ready: () => void;
5463
5483
  destroy: () => void;
5464
5484
  selectComponent: (id: string) => void;
5465
- updateComposition: (component: RootComponentInstance, secret?: string) => void;
5485
+ updateComposition: (composition: RootComponentInstance, secret?: string) => void;
5486
+ updateCompositionInternal: (composition: RootComponentInstance, hash?: number) => void;
5466
5487
  addComponent: (options: Omit<AddComponentMessage, 'type'>) => void;
5467
5488
  moveComponent: (options: Omit<MoveComponentMessage, 'type'>) => void;
5489
+ updateComponentParameter: (options: Omit<UpdateComponentParameterMessage, 'type'>) => void;
5468
5490
  dismissPlaceholder: (options: Omit<DismissPlaceholderMessage, 'type'>) => void;
5469
5491
  updatePreviewSettings: (options: Omit<UpdatePreviewSettingsMessage, 'type'>) => void;
5470
5492
  reportRenderedCompositions: (options: Omit<ReportRenderedCompositionsMessage, 'type'>) => void;
@@ -5549,6 +5571,11 @@ declare const IN_CONTEXT_EDITOR_COMPONENT_START_ROLE = "uniform-component-start"
5549
5571
  declare const IN_CONTEXT_EDITOR_COMPONENT_END_ROLE = "uniform-component-end";
5550
5572
  /** The ID of the Contextual Editing script that gets embedded in frontend apps */
5551
5573
  declare const IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID = "uniform-canvas-preview-script";
5574
+ /**
5575
+ * The name of the attribute added to the elements rendered by Uniform.
5576
+ * Use to allow interacting with them by default in the preview panel
5577
+ */
5578
+ declare const IS_RENDERED_BY_UNIFORM_ATTRIBUTE = "data-is-rendered-by-uniform";
5552
5579
  /** The ID we give to placeholder components */
5553
5580
  declare const PLACEHOLDER_ID = "placeholder";
5554
5581
  /** Contextual editing empty composition, used as a placeholder while waiting for the composition to be send by the editor. */
@@ -5724,4 +5751,4 @@ declare function mapSlotToTestVariations(slot: ComponentInstance[] | undefined):
5724
5751
 
5725
5752
  declare const CanvasClientError: typeof ApiClientError;
5726
5753
 
5727
- 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, EMPTY_COMPOSITION, 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 };
5754
+ 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, ComponentParameterContextualEditing, 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, EMPTY_COMPOSITION, 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, IS_RENDERED_BY_UNIFORM_ATTRIBUTE, InvalidationPayload, InvalidationResult, LimitPolicy, MessageHandler, MoveComponentMessage, OverrideIssue, OverrideOptions, PLACEHOLDER_ID, PreviewEventBus, PreviewPanelSettings, ReadyMessage, ReportRenderedCompositionsMessage, RootComponentInstance, SelectComponentMessage, SpecificProjectMap, SubscribeToCompositionOptions, UncachedCanvasClient, UniqueBatchEntries, UnsubscribeCallback, UpdateComponentParameterMessage, UpdateCompositionInternalMessage, UpdateCompositionMessage, UpdatePreviewSettingsMessage, WalkComponentTreeActions, compose, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, enhance, extractLocales, generateHash, getChannelName, getComponentJsonPointer, getComponentPath, isAddComponentMessage, isDismissPlaceholderMessage, isMovingComponentMessage, isReadyMessage, isReportRenderedCompositionsMessage, isSelectComponentMessage, isSystemComponentDefinition, isUpdateComponentParameterMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, subscribeToComposition, walkComponentTree };
package/dist/index.esm.js CHANGED
@@ -1129,6 +1129,7 @@ var IN_CONTEXT_EDITOR_QUERY_STRING_PARAM = "is_incontext_editing_mode";
1129
1129
  var IN_CONTEXT_EDITOR_COMPONENT_START_ROLE = "uniform-component-start";
1130
1130
  var IN_CONTEXT_EDITOR_COMPONENT_END_ROLE = "uniform-component-end";
1131
1131
  var IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID = "uniform-canvas-preview-script";
1132
+ var IS_RENDERED_BY_UNIFORM_ATTRIBUTE = "data-is-rendered-by-uniform";
1132
1133
  var PLACEHOLDER_ID = "placeholder";
1133
1134
  var EMPTY_COMPOSITION = {
1134
1135
  _id: "_empty_composition_id",
@@ -1238,12 +1239,18 @@ var isReadyMessage = (message) => {
1238
1239
  var isUpdateCompositionMessage = (message) => {
1239
1240
  return message.type === "update-composition";
1240
1241
  };
1242
+ var isUpdateCompositionInternalMessage = (message) => {
1243
+ return message.type === "update-composition-internal";
1244
+ };
1241
1245
  var isAddComponentMessage = (message) => {
1242
1246
  return message.type === "add-component";
1243
1247
  };
1244
1248
  var isMovingComponentMessage = (message) => {
1245
1249
  return message.type === "move-component";
1246
1250
  };
1251
+ var isUpdateComponentParameterMessage = (message) => {
1252
+ return message.type === "update-component-parameter";
1253
+ };
1247
1254
  var isDismissPlaceholderMessage = (message) => {
1248
1255
  return message.type === "dismiss-placeholder";
1249
1256
  };
@@ -1305,6 +1312,14 @@ var createCanvasChannel = ({
1305
1312
  };
1306
1313
  postMessage(message);
1307
1314
  };
1315
+ const updateCompositionInternal = (composition, hash) => {
1316
+ const message = {
1317
+ type: "update-composition-internal",
1318
+ composition,
1319
+ hash
1320
+ };
1321
+ postMessage(message);
1322
+ };
1308
1323
  const addComponent = (options) => {
1309
1324
  const message = {
1310
1325
  ...options,
@@ -1319,6 +1334,13 @@ var createCanvasChannel = ({
1319
1334
  };
1320
1335
  postMessage(message);
1321
1336
  };
1337
+ const updateComponentParameter = (options) => {
1338
+ const message = {
1339
+ ...options,
1340
+ type: "update-component-parameter"
1341
+ };
1342
+ postMessage(message);
1343
+ };
1322
1344
  const dismissPlaceholder = (options) => {
1323
1345
  const message = {
1324
1346
  ...options,
@@ -1341,7 +1363,7 @@ var createCanvasChannel = ({
1341
1363
  postMessage(message);
1342
1364
  };
1343
1365
  const messageEventListener = (event) => {
1344
- if (typeof event.data !== "string" || event.source === window) {
1366
+ if (typeof event.data !== "string") {
1345
1367
  return;
1346
1368
  }
1347
1369
  let message = null;
@@ -1371,9 +1393,11 @@ var createCanvasChannel = ({
1371
1393
  destroy,
1372
1394
  selectComponent,
1373
1395
  updateComposition,
1396
+ updateCompositionInternal,
1374
1397
  on,
1375
1398
  addComponent,
1376
1399
  moveComponent,
1400
+ updateComponentParameter,
1377
1401
  dismissPlaceholder,
1378
1402
  updatePreviewSettings,
1379
1403
  reportRenderedCompositions
@@ -1554,6 +1578,7 @@ export {
1554
1578
  IN_CONTEXT_EDITOR_COMPONENT_START_ROLE,
1555
1579
  IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID,
1556
1580
  IN_CONTEXT_EDITOR_QUERY_STRING_PARAM,
1581
+ IS_RENDERED_BY_UNIFORM_ATTRIBUTE,
1557
1582
  PLACEHOLDER_ID,
1558
1583
  UncachedCanvasClient,
1559
1584
  UniqueBatchEntries,
@@ -1576,6 +1601,8 @@ export {
1576
1601
  isReportRenderedCompositionsMessage,
1577
1602
  isSelectComponentMessage,
1578
1603
  isSystemComponentDefinition,
1604
+ isUpdateComponentParameterMessage,
1605
+ isUpdateCompositionInternalMessage,
1579
1606
  isUpdateCompositionMessage,
1580
1607
  isUpdatePreviewSettingsMessage,
1581
1608
  localize,
package/dist/index.js CHANGED
@@ -307,6 +307,7 @@ __export(src_exports, {
307
307
  IN_CONTEXT_EDITOR_COMPONENT_START_ROLE: () => IN_CONTEXT_EDITOR_COMPONENT_START_ROLE,
308
308
  IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID: () => IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID,
309
309
  IN_CONTEXT_EDITOR_QUERY_STRING_PARAM: () => IN_CONTEXT_EDITOR_QUERY_STRING_PARAM,
310
+ IS_RENDERED_BY_UNIFORM_ATTRIBUTE: () => IS_RENDERED_BY_UNIFORM_ATTRIBUTE,
310
311
  PLACEHOLDER_ID: () => PLACEHOLDER_ID,
311
312
  UncachedCanvasClient: () => UncachedCanvasClient,
312
313
  UniqueBatchEntries: () => UniqueBatchEntries,
@@ -329,6 +330,8 @@ __export(src_exports, {
329
330
  isReportRenderedCompositionsMessage: () => isReportRenderedCompositionsMessage,
330
331
  isSelectComponentMessage: () => isSelectComponentMessage,
331
332
  isSystemComponentDefinition: () => isSystemComponentDefinition,
333
+ isUpdateComponentParameterMessage: () => isUpdateComponentParameterMessage,
334
+ isUpdateCompositionInternalMessage: () => isUpdateCompositionInternalMessage,
332
335
  isUpdateCompositionMessage: () => isUpdateCompositionMessage,
333
336
  isUpdatePreviewSettingsMessage: () => isUpdatePreviewSettingsMessage,
334
337
  localize: () => localize,
@@ -1204,6 +1207,7 @@ var IN_CONTEXT_EDITOR_QUERY_STRING_PARAM = "is_incontext_editing_mode";
1204
1207
  var IN_CONTEXT_EDITOR_COMPONENT_START_ROLE = "uniform-component-start";
1205
1208
  var IN_CONTEXT_EDITOR_COMPONENT_END_ROLE = "uniform-component-end";
1206
1209
  var IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID = "uniform-canvas-preview-script";
1210
+ var IS_RENDERED_BY_UNIFORM_ATTRIBUTE = "data-is-rendered-by-uniform";
1207
1211
  var PLACEHOLDER_ID = "placeholder";
1208
1212
  var EMPTY_COMPOSITION = {
1209
1213
  _id: "_empty_composition_id",
@@ -1313,12 +1317,18 @@ var isReadyMessage = (message) => {
1313
1317
  var isUpdateCompositionMessage = (message) => {
1314
1318
  return message.type === "update-composition";
1315
1319
  };
1320
+ var isUpdateCompositionInternalMessage = (message) => {
1321
+ return message.type === "update-composition-internal";
1322
+ };
1316
1323
  var isAddComponentMessage = (message) => {
1317
1324
  return message.type === "add-component";
1318
1325
  };
1319
1326
  var isMovingComponentMessage = (message) => {
1320
1327
  return message.type === "move-component";
1321
1328
  };
1329
+ var isUpdateComponentParameterMessage = (message) => {
1330
+ return message.type === "update-component-parameter";
1331
+ };
1322
1332
  var isDismissPlaceholderMessage = (message) => {
1323
1333
  return message.type === "dismiss-placeholder";
1324
1334
  };
@@ -1380,6 +1390,14 @@ var createCanvasChannel = ({
1380
1390
  };
1381
1391
  postMessage(message);
1382
1392
  };
1393
+ const updateCompositionInternal = (composition, hash) => {
1394
+ const message = {
1395
+ type: "update-composition-internal",
1396
+ composition,
1397
+ hash
1398
+ };
1399
+ postMessage(message);
1400
+ };
1383
1401
  const addComponent = (options) => {
1384
1402
  const message = {
1385
1403
  ...options,
@@ -1394,6 +1412,13 @@ var createCanvasChannel = ({
1394
1412
  };
1395
1413
  postMessage(message);
1396
1414
  };
1415
+ const updateComponentParameter = (options) => {
1416
+ const message = {
1417
+ ...options,
1418
+ type: "update-component-parameter"
1419
+ };
1420
+ postMessage(message);
1421
+ };
1397
1422
  const dismissPlaceholder = (options) => {
1398
1423
  const message = {
1399
1424
  ...options,
@@ -1416,7 +1441,7 @@ var createCanvasChannel = ({
1416
1441
  postMessage(message);
1417
1442
  };
1418
1443
  const messageEventListener = (event) => {
1419
- if (typeof event.data !== "string" || event.source === window) {
1444
+ if (typeof event.data !== "string") {
1420
1445
  return;
1421
1446
  }
1422
1447
  let message = null;
@@ -1446,9 +1471,11 @@ var createCanvasChannel = ({
1446
1471
  destroy,
1447
1472
  selectComponent,
1448
1473
  updateComposition,
1474
+ updateCompositionInternal,
1449
1475
  on,
1450
1476
  addComponent,
1451
1477
  moveComponent,
1478
+ updateComponentParameter,
1452
1479
  dismissPlaceholder,
1453
1480
  updatePreviewSettings,
1454
1481
  reportRenderedCompositions
@@ -1630,6 +1657,7 @@ var CanvasClientError = import_api4.ApiClientError;
1630
1657
  IN_CONTEXT_EDITOR_COMPONENT_START_ROLE,
1631
1658
  IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID,
1632
1659
  IN_CONTEXT_EDITOR_QUERY_STRING_PARAM,
1660
+ IS_RENDERED_BY_UNIFORM_ATTRIBUTE,
1633
1661
  PLACEHOLDER_ID,
1634
1662
  UncachedCanvasClient,
1635
1663
  UniqueBatchEntries,
@@ -1652,6 +1680,8 @@ var CanvasClientError = import_api4.ApiClientError;
1652
1680
  isReportRenderedCompositionsMessage,
1653
1681
  isSelectComponentMessage,
1654
1682
  isSystemComponentDefinition,
1683
+ isUpdateComponentParameterMessage,
1684
+ isUpdateCompositionInternalMessage,
1655
1685
  isUpdateCompositionMessage,
1656
1686
  isUpdatePreviewSettingsMessage,
1657
1687
  localize,
package/dist/index.mjs CHANGED
@@ -1129,6 +1129,7 @@ var IN_CONTEXT_EDITOR_QUERY_STRING_PARAM = "is_incontext_editing_mode";
1129
1129
  var IN_CONTEXT_EDITOR_COMPONENT_START_ROLE = "uniform-component-start";
1130
1130
  var IN_CONTEXT_EDITOR_COMPONENT_END_ROLE = "uniform-component-end";
1131
1131
  var IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID = "uniform-canvas-preview-script";
1132
+ var IS_RENDERED_BY_UNIFORM_ATTRIBUTE = "data-is-rendered-by-uniform";
1132
1133
  var PLACEHOLDER_ID = "placeholder";
1133
1134
  var EMPTY_COMPOSITION = {
1134
1135
  _id: "_empty_composition_id",
@@ -1238,12 +1239,18 @@ var isReadyMessage = (message) => {
1238
1239
  var isUpdateCompositionMessage = (message) => {
1239
1240
  return message.type === "update-composition";
1240
1241
  };
1242
+ var isUpdateCompositionInternalMessage = (message) => {
1243
+ return message.type === "update-composition-internal";
1244
+ };
1241
1245
  var isAddComponentMessage = (message) => {
1242
1246
  return message.type === "add-component";
1243
1247
  };
1244
1248
  var isMovingComponentMessage = (message) => {
1245
1249
  return message.type === "move-component";
1246
1250
  };
1251
+ var isUpdateComponentParameterMessage = (message) => {
1252
+ return message.type === "update-component-parameter";
1253
+ };
1247
1254
  var isDismissPlaceholderMessage = (message) => {
1248
1255
  return message.type === "dismiss-placeholder";
1249
1256
  };
@@ -1305,6 +1312,14 @@ var createCanvasChannel = ({
1305
1312
  };
1306
1313
  postMessage(message);
1307
1314
  };
1315
+ const updateCompositionInternal = (composition, hash) => {
1316
+ const message = {
1317
+ type: "update-composition-internal",
1318
+ composition,
1319
+ hash
1320
+ };
1321
+ postMessage(message);
1322
+ };
1308
1323
  const addComponent = (options) => {
1309
1324
  const message = {
1310
1325
  ...options,
@@ -1319,6 +1334,13 @@ var createCanvasChannel = ({
1319
1334
  };
1320
1335
  postMessage(message);
1321
1336
  };
1337
+ const updateComponentParameter = (options) => {
1338
+ const message = {
1339
+ ...options,
1340
+ type: "update-component-parameter"
1341
+ };
1342
+ postMessage(message);
1343
+ };
1322
1344
  const dismissPlaceholder = (options) => {
1323
1345
  const message = {
1324
1346
  ...options,
@@ -1341,7 +1363,7 @@ var createCanvasChannel = ({
1341
1363
  postMessage(message);
1342
1364
  };
1343
1365
  const messageEventListener = (event) => {
1344
- if (typeof event.data !== "string" || event.source === window) {
1366
+ if (typeof event.data !== "string") {
1345
1367
  return;
1346
1368
  }
1347
1369
  let message = null;
@@ -1371,9 +1393,11 @@ var createCanvasChannel = ({
1371
1393
  destroy,
1372
1394
  selectComponent,
1373
1395
  updateComposition,
1396
+ updateCompositionInternal,
1374
1397
  on,
1375
1398
  addComponent,
1376
1399
  moveComponent,
1400
+ updateComponentParameter,
1377
1401
  dismissPlaceholder,
1378
1402
  updatePreviewSettings,
1379
1403
  reportRenderedCompositions
@@ -1554,6 +1578,7 @@ export {
1554
1578
  IN_CONTEXT_EDITOR_COMPONENT_START_ROLE,
1555
1579
  IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID,
1556
1580
  IN_CONTEXT_EDITOR_QUERY_STRING_PARAM,
1581
+ IS_RENDERED_BY_UNIFORM_ATTRIBUTE,
1557
1582
  PLACEHOLDER_ID,
1558
1583
  UncachedCanvasClient,
1559
1584
  UniqueBatchEntries,
@@ -1576,6 +1601,8 @@ export {
1576
1601
  isReportRenderedCompositionsMessage,
1577
1602
  isSelectComponentMessage,
1578
1603
  isSystemComponentDefinition,
1604
+ isUpdateComponentParameterMessage,
1605
+ isUpdateCompositionInternalMessage,
1579
1606
  isUpdateCompositionMessage,
1580
1607
  isUpdatePreviewSettingsMessage,
1581
1608
  localize,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uniformdev/canvas",
3
- "version": "18.34.1-alpha.57+d06712d70",
3
+ "version": "18.35.1-alpha.16+3d99d8fd6",
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.34.1-alpha.57+d06712d70"
50
+ "@uniformdev/context": "18.35.1-alpha.16+3d99d8fd6"
51
51
  },
52
52
  "files": [
53
53
  "/dist"
@@ -55,5 +55,5 @@
55
55
  "publishConfig": {
56
56
  "access": "public"
57
57
  },
58
- "gitHead": "d06712d70880e665966897d71c92444ea1dea80e"
58
+ "gitHead": "3d99d8fd68048310f8f6dc56a1d18e61c35c9765"
59
59
  }