@uniformdev/canvas 19.20.0 → 19.20.1-alpha.32

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
@@ -199,7 +199,8 @@ interface components$4 {
199
199
  /**
200
200
  * @description Unique identifier of the component within the composition.
201
201
  * No assumptions should be made about the format of this value other than "it will be unique."
202
- * This is not set unless specifically requested via `withComponentIDs` API parameter.
202
+ * This is not returned in GET replies unless specifically requested via `withComponentIDs` API parameter.
203
+ * When updating or creating a composition, if you do not specify an _id for each component, one will be created and stored for you.
203
204
  */
204
205
  _id?: string;
205
206
  /** @description Indicates this component instance should be sourced from a pattern library pattern. */
@@ -812,7 +813,8 @@ interface external$9 {
812
813
  /**
813
814
  * @description Unique identifier of the component within the composition.
814
815
  * No assumptions should be made about the format of this value other than "it will be unique."
815
- * This is not set unless specifically requested via `withComponentIDs` API parameter.
816
+ * This is not returned in GET replies unless specifically requested via `withComponentIDs` API parameter.
817
+ * When updating or creating a composition, if you do not specify an _id for each component, one will be created and stored for you.
816
818
  */
817
819
  _id?: string;
818
820
  /** @description Indicates this component instance should be sourced from a pattern library pattern. */
@@ -1436,7 +1438,8 @@ interface external$8 {
1436
1438
  /**
1437
1439
  * @description Unique identifier of the component within the composition.
1438
1440
  * No assumptions should be made about the format of this value other than "it will be unique."
1439
- * This is not set unless specifically requested via `withComponentIDs` API parameter.
1441
+ * This is not returned in GET replies unless specifically requested via `withComponentIDs` API parameter.
1442
+ * When updating or creating a composition, if you do not specify an _id for each component, one will be created and stored for you.
1440
1443
  */
1441
1444
  _id?: string;
1442
1445
  /** @description Indicates this component instance should be sourced from a pattern library pattern. */
@@ -1991,7 +1994,8 @@ interface external$7 {
1991
1994
  /**
1992
1995
  * @description Unique identifier of the component within the composition.
1993
1996
  * No assumptions should be made about the format of this value other than "it will be unique."
1994
- * This is not set unless specifically requested via `withComponentIDs` API parameter.
1997
+ * This is not returned in GET replies unless specifically requested via `withComponentIDs` API parameter.
1998
+ * When updating or creating a composition, if you do not specify an _id for each component, one will be created and stored for you.
1995
1999
  */
1996
2000
  _id?: string;
1997
2001
  /** @description Indicates this component instance should be sourced from a pattern library pattern. */
@@ -2581,7 +2585,8 @@ interface external$6 {
2581
2585
  /**
2582
2586
  * @description Unique identifier of the component within the composition.
2583
2587
  * No assumptions should be made about the format of this value other than "it will be unique."
2584
- * This is not set unless specifically requested via `withComponentIDs` API parameter.
2588
+ * This is not returned in GET replies unless specifically requested via `withComponentIDs` API parameter.
2589
+ * When updating or creating a composition, if you do not specify an _id for each component, one will be created and stored for you.
2585
2590
  */
2586
2591
  _id?: string;
2587
2592
  /** @description Indicates this component instance should be sourced from a pattern library pattern. */
@@ -3557,7 +3562,8 @@ interface external$5 {
3557
3562
  /**
3558
3563
  * @description Unique identifier of the component within the composition.
3559
3564
  * No assumptions should be made about the format of this value other than "it will be unique."
3560
- * This is not set unless specifically requested via `withComponentIDs` API parameter.
3565
+ * This is not returned in GET replies unless specifically requested via `withComponentIDs` API parameter.
3566
+ * When updating or creating a composition, if you do not specify an _id for each component, one will be created and stored for you.
3561
3567
  */
3562
3568
  _id?: string;
3563
3569
  /** @description Indicates this component instance should be sourced from a pattern library pattern. */
@@ -4358,7 +4364,8 @@ interface external$3 {
4358
4364
  /**
4359
4365
  * @description Unique identifier of the component within the composition.
4360
4366
  * No assumptions should be made about the format of this value other than "it will be unique."
4361
- * This is not set unless specifically requested via `withComponentIDs` API parameter.
4367
+ * This is not returned in GET replies unless specifically requested via `withComponentIDs` API parameter.
4368
+ * When updating or creating a composition, if you do not specify an _id for each component, one will be created and stored for you.
4362
4369
  */
4363
4370
  _id?: string;
4364
4371
  /** @description Indicates this component instance should be sourced from a pattern library pattern. */
@@ -5775,7 +5782,8 @@ interface external$2 {
5775
5782
  /**
5776
5783
  * @description Unique identifier of the component within the composition.
5777
5784
  * No assumptions should be made about the format of this value other than "it will be unique."
5778
- * This is not set unless specifically requested via `withComponentIDs` API parameter.
5785
+ * This is not returned in GET replies unless specifically requested via `withComponentIDs` API parameter.
5786
+ * When updating or creating a composition, if you do not specify an _id for each component, one will be created and stored for you.
5779
5787
  */
5780
5788
  _id?: string;
5781
5789
  /** @description Indicates this component instance should be sourced from a pattern library pattern. */
@@ -6788,7 +6796,7 @@ type DataResolutionParameters = {
6788
6796
  diagnostics?: boolean;
6789
6797
  };
6790
6798
  /** Types of issue that can occur when fetching composition data */
6791
- type CompositionIssue = CompositionPatternIssue | DataResourceIssue | DataElementBindingIssue | DataResourceInputIssue | DataResolutionConfigIssue | OverrideIssue;
6799
+ type CompositionIssue = CompositionPatternIssue | DataResourceIssue | DataElementBindingIssue | DynamicInputIssue | DataResolutionConfigIssue;
6792
6800
  type CompositionIssueCore = components$1['schemas']['CompositionIssue'];
6793
6801
  /** An error that occured resolving a pattern that is referenced on the composition */
6794
6802
  type CompositionPatternIssue = CompositionIssueCore & {
@@ -6811,20 +6819,14 @@ type DataResourceIssue = CompositionIssueCore & {
6811
6819
  * An issue that occurred while binding dynamic inputs to composition data resources,
6812
6820
  * specifically when an expected dynamic input did not have a value.
6813
6821
  */
6814
- type DataResourceInputIssue = CompositionIssueCore & {
6822
+ type DynamicInputIssue = CompositionIssueCore & {
6815
6823
  type: 'input';
6816
- inputName: string;
6817
6824
  };
6818
6825
  /** Error in data resolution configuration (internal error) */
6819
6826
  type DataResolutionConfigIssue = {
6820
6827
  message: string;
6821
6828
  type: 'config';
6822
6829
  };
6823
- /** Error in applying component overrides */
6824
- type OverrideIssue = CompositionIssueCore & {
6825
- message: string;
6826
- type: 'override';
6827
- };
6828
6830
  /** Diagnostics about edge request processing */
6829
6831
  type CompositionDiagnostics = components$1['schemas']['CompositionDiagnostics'];
6830
6832
  /** Diagnostic data about the load performance of attached composition datas */
@@ -7382,6 +7384,18 @@ declare class unstable_CompositionRelationshipClient extends ApiClient<Compositi
7382
7384
  type PreviewPanelSettings = {
7383
7385
  isInteractive: boolean;
7384
7386
  };
7387
+ type ContextualEditingComponentReference = {
7388
+ elements: HTMLElement[];
7389
+ id: string;
7390
+ slotName?: string;
7391
+ componentIndex?: number;
7392
+ totalComponents?: number;
7393
+ componentName?: string;
7394
+ componentTitle?: string;
7395
+ parentId?: string;
7396
+ parentType?: string;
7397
+ isLocalized?: boolean;
7398
+ };
7385
7399
 
7386
7400
  type EnhancerContext = {
7387
7401
  preview?: boolean;
@@ -7838,12 +7852,18 @@ type UpdatePreviewSettingsMessage = {
7838
7852
  type: 'update-preview-settings';
7839
7853
  settings: PreviewPanelSettings;
7840
7854
  };
7855
+ type UpdateContextualEditingStateInternalMessage = {
7856
+ type: 'update-contextual-editing-state-internal';
7857
+ state: {
7858
+ selectedComponentReference?: Omit<ContextualEditingComponentReference, 'elements'>;
7859
+ };
7860
+ };
7841
7861
  type ReportRenderedCompositionsMessage = {
7842
7862
  type: 'report-rendered-compositions';
7843
7863
  compositionIds: string[];
7844
7864
  url: string;
7845
7865
  };
7846
- type ChannelMessage = SelectComponentMessage | ReadyMessage | UpdateCompositionMessage | UpdateCompositionInternalMessage | AddComponentMessage | MoveComponentMessage | DismissPlaceholderMessage | TriggerCompositionActionMessage | UpdatePreviewSettingsMessage | ReportRenderedCompositionsMessage | UpdateComponentParameterMessage | DismissPlaceholderMessage;
7866
+ type ChannelMessage = SelectComponentMessage | ReadyMessage | UpdateCompositionMessage | UpdateCompositionInternalMessage | AddComponentMessage | MoveComponentMessage | DismissPlaceholderMessage | TriggerCompositionActionMessage | UpdatePreviewSettingsMessage | ReportRenderedCompositionsMessage | UpdateComponentParameterMessage | UpdateContextualEditingStateInternalMessage | DismissPlaceholderMessage;
7847
7867
  declare const isSelectComponentMessage: (message: ChannelMessage) => message is SelectComponentMessage;
7848
7868
  declare const isReadyMessage: (message: ChannelMessage) => message is ReadyMessage;
7849
7869
  declare const isUpdateCompositionMessage: (message: ChannelMessage) => message is UpdateCompositionMessage;
@@ -7854,6 +7874,7 @@ declare const isUpdateComponentParameterMessage: (message: ChannelMessage) => me
7854
7874
  declare const isDismissPlaceholderMessage: (message: ChannelMessage) => message is DismissPlaceholderMessage;
7855
7875
  declare const isTriggerCompositionActionMessage: (message: ChannelMessage) => message is TriggerCompositionActionMessage;
7856
7876
  declare const isUpdatePreviewSettingsMessage: (message: ChannelMessage) => message is UpdatePreviewSettingsMessage;
7877
+ declare const isUpdateContextualEditingStateInternalMessage: (message: ChannelMessage) => message is UpdateContextualEditingStateInternalMessage;
7857
7878
  declare const isReportRenderedCompositionsMessage: (message: ChannelMessage) => message is ReportRenderedCompositionsMessage;
7858
7879
  type MessageHandler = (message: ChannelMessage, originalEvent: MessageEvent) => void;
7859
7880
  type Channel = {
@@ -7869,6 +7890,7 @@ type Channel = {
7869
7890
  dismissPlaceholder: (options: Omit<DismissPlaceholderMessage, 'type'>) => void;
7870
7891
  triggerCompositionAction: (options: Omit<TriggerCompositionActionMessage, 'type'>) => void;
7871
7892
  updatePreviewSettings: (options: Omit<UpdatePreviewSettingsMessage, 'type'>) => void;
7893
+ updateContextualEditingStateInternal: (options: Omit<UpdateContextualEditingStateInternalMessage, 'type'>) => void;
7872
7894
  reportRenderedCompositions: (options: Omit<ReportRenderedCompositionsMessage, 'type'>) => void;
7873
7895
  };
7874
7896
  declare const createCanvasChannel: ({ listenTo, broadcastTo, }: {
@@ -7926,7 +7948,7 @@ type ResolvedRouteGetResponse = RouteGetResponseNotFound | RouteGetResponseRedir
7926
7948
  * Resolves a route using Uniform Project Map and Uniform Redirects,
7927
7949
  * returning a composition, redirection, or not found result.
7928
7950
  */
7929
- declare class unstable_RouteClient extends ApiClient<RouteClientOptions> {
7951
+ declare class RouteClient extends ApiClient<RouteClientOptions> {
7930
7952
  private edgeApiHost;
7931
7953
  constructor(options: RouteClientOptions);
7932
7954
  /** Fetches lists of Canvas compositions, optionally by type */
@@ -7941,7 +7963,6 @@ type BindVariablesResult<TValue> = {
7941
7963
  type BindVariablesToObjectOptions<T> = {
7942
7964
  /** The object to bind variables to. Only strings or objects are bound. */
7943
7965
  value: T;
7944
- recursivePath?: string;
7945
7966
  } & Omit<BindVariablesOptions, 'value'>;
7946
7967
  /**
7947
7968
  * Binds composition variables to an object whose string keys may have variable expressions in them.
@@ -8192,4 +8213,4 @@ declare function mapSlotToTestVariations(slot: ComponentInstance[] | undefined):
8192
8213
 
8193
8214
  declare const CanvasClientError: typeof ApiClientError;
8194
8215
 
8195
- export { AddComponentMessage, BatchEnhancer, BatchEntry, BatchInvalidationPayload, BindVariablesOptions, BindVariablesResult, BindVariablesToObjectOptions, 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, ComponentDefinitionDeleteParameters, ComponentDefinitionGetParameters, ComponentDefinitionGetResponse, ComponentDefinitionParameter, ComponentDefinitionPermission, ComponentDefinitionPutParameters, ComponentDefinitionSlot, ComponentDefinitionSlugSettings, ComponentDefinitionVariant, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentInstance, ComponentInstanceHistoryEntry, ComponentInstanceHistoryGetParameters, ComponentInstanceHistoryGetResponse, ComponentLocationReference, ComponentOverridability, ComponentOverride, ComponentOverrides, ComponentParameter, ComponentParameterContextualEditing, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, CompositionDataDiagnostic, CompositionDeleteParameters, CompositionDiagnostics, CompositionGetByIdParameters, CompositionGetByNodeIdParameters, CompositionGetByNodePathParameters, CompositionGetBySlugParameters, CompositionGetListResponse, CompositionGetOrderBy, CompositionGetParameters, CompositionGetResponse, CompositionGetValidResponses, CompositionIssue, CompositionPatternIssue, CompositionPutParameters, CompositionRelationshipsClientOptions, CompositionRelationshipsDDefinitionGetResponse, CompositionRelationshipsDefinitionApi, CompositionRelationshipsDefinitionGetParameters, CompositionResolvedGetResponse, CompositionUIStatus, DataElementBindingIssue, DataElementConnectionDefinition, DataResolutionConfigIssue, DataResolutionOption, DataResolutionOptionNegative, DataResolutionOptionPositive, DataResolutionParameters, DataResourceDefinition, DataResourceDefinitions, DataResourceInputIssue, DataResourceIssue, 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, LinkComponentParameterValue, LinkParamConfiguration, LinkParamValue, LinkParameterType, LinkTypeConfiguration, MessageHandler, MoveComponentMessage, NonProjectMapLinkParamValue, OverrideIssue, OverrideOptions, PLACEHOLDER_ID, PreviewEventBus, PreviewPanelSettings, ProjectMapLinkComponentParameterValue, ProjectMapLinkParamValue, ReadyMessage, ReportRenderedCompositionsMessage, ResolvedRouteGetResponse, RichTextBuiltInElement, RichTextBuiltInFormat, RichTextParamConfiguration, RichTextParamValue, RootComponentInstance, RouteDynamicInputs, RouteGetParameters, RouteGetResponse, RouteGetResponseComposition, RouteGetResponseEdgehancedComposition, RouteGetResponseNotFound, RouteGetResponseRedirect, SelectComponentMessage, SpecificProjectMap, SubscribeToCompositionOptions, TriggerCompositionActionMessage, UncachedCanvasClient, UniqueBatchEntries, UnsubscribeCallback, UpdateComponentParameterMessage, UpdateCompositionInternalMessage, UpdateCompositionMessage, UpdatePreviewSettingsMessage, UsageTrackingApi, UsageTrackingGetParameters, UsageTrackingGetResponse, UsageTrackingPostParameters, UsageTrackingPostResponse, WalkComponentTreeActions, bindVariables, bindVariablesToObject, compose, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, enhance, extractLocales, generateHash, getChannelName, getComponentJsonPointer, getComponentPath, isAddComponentMessage, isDismissPlaceholderMessage, isMovingComponentMessage, isReadyMessage, isReportRenderedCompositionsMessage, isSelectComponentMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateComponentParameterMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, subscribeToComposition, unstable_CompositionRelationshipClient, unstable_RouteClient, walkComponentTree };
8216
+ export { AddComponentMessage, BatchEnhancer, BatchEntry, BatchInvalidationPayload, BindVariablesOptions, BindVariablesResult, BindVariablesToObjectOptions, 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, ComponentDefinitionDeleteParameters, ComponentDefinitionGetParameters, ComponentDefinitionGetResponse, ComponentDefinitionParameter, ComponentDefinitionPermission, ComponentDefinitionPutParameters, ComponentDefinitionSlot, ComponentDefinitionSlugSettings, ComponentDefinitionVariant, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentInstance, ComponentInstanceHistoryEntry, ComponentInstanceHistoryGetParameters, ComponentInstanceHistoryGetResponse, ComponentLocationReference, ComponentOverridability, ComponentOverride, ComponentOverrides, ComponentParameter, ComponentParameterContextualEditing, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, CompositionDataDiagnostic, CompositionDeleteParameters, CompositionDiagnostics, CompositionGetByIdParameters, CompositionGetByNodeIdParameters, CompositionGetByNodePathParameters, CompositionGetBySlugParameters, CompositionGetListResponse, CompositionGetOrderBy, CompositionGetParameters, CompositionGetResponse, CompositionGetValidResponses, CompositionIssue, CompositionPatternIssue, CompositionPutParameters, CompositionRelationshipsClientOptions, CompositionRelationshipsDDefinitionGetResponse, CompositionRelationshipsDefinitionApi, CompositionRelationshipsDefinitionGetParameters, CompositionResolvedGetResponse, CompositionUIStatus, ContextualEditingComponentReference, DataElementBindingIssue, DataElementConnectionDefinition, DataResolutionConfigIssue, DataResolutionOption, DataResolutionOptionNegative, DataResolutionOptionPositive, DataResolutionParameters, DataResourceDefinition, DataResourceDefinitions, DataResourceIssue, DataResourceVariables, DataSource, DataSourceClient, DataSourceDeleteParameters, DataSourceGetParameters, DataSourceGetResponse, DataSourcePutParameters, DataSourcesGetParameters, DataSourcesGetResponse, DataType, DataTypeClient, DataTypeDeleteParameters, DataTypeGetParameters, DataTypeGetResponse, DataTypePutParameters, DataVariableDefinition, DismissPlaceholderMessage, DynamicInputIssue, 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, LinkComponentParameterValue, LinkParamConfiguration, LinkParamValue, LinkParameterType, LinkTypeConfiguration, MessageHandler, MoveComponentMessage, NonProjectMapLinkParamValue, OverrideOptions, PLACEHOLDER_ID, PreviewEventBus, PreviewPanelSettings, ProjectMapLinkComponentParameterValue, ProjectMapLinkParamValue, ReadyMessage, ReportRenderedCompositionsMessage, ResolvedRouteGetResponse, RichTextBuiltInElement, RichTextBuiltInFormat, RichTextParamConfiguration, RichTextParamValue, RootComponentInstance, RouteClient, RouteDynamicInputs, RouteGetParameters, RouteGetResponse, RouteGetResponseComposition, RouteGetResponseEdgehancedComposition, RouteGetResponseNotFound, RouteGetResponseRedirect, SelectComponentMessage, SpecificProjectMap, SubscribeToCompositionOptions, TriggerCompositionActionMessage, UncachedCanvasClient, UniqueBatchEntries, UnsubscribeCallback, UpdateComponentParameterMessage, UpdateCompositionInternalMessage, UpdateCompositionMessage, UpdateContextualEditingStateInternalMessage, UpdatePreviewSettingsMessage, UsageTrackingApi, UsageTrackingGetParameters, UsageTrackingGetResponse, UsageTrackingPostParameters, UsageTrackingPostResponse, WalkComponentTreeActions, bindVariables, bindVariablesToObject, compose, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, enhance, extractLocales, generateHash, getChannelName, getComponentJsonPointer, getComponentPath, isAddComponentMessage, isDismissPlaceholderMessage, isMovingComponentMessage, isReadyMessage, isReportRenderedCompositionsMessage, isSelectComponentMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateComponentParameterMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, subscribeToComposition, unstable_CompositionRelationshipClient, walkComponentTree };
package/dist/index.esm.js CHANGED
@@ -1321,6 +1321,9 @@ var isTriggerCompositionActionMessage = (message) => {
1321
1321
  var isUpdatePreviewSettingsMessage = (message) => {
1322
1322
  return message.type === "update-preview-settings";
1323
1323
  };
1324
+ var isUpdateContextualEditingStateInternalMessage = (message) => {
1325
+ return message.type === "update-contextual-editing-state-internal";
1326
+ };
1324
1327
  var isReportRenderedCompositionsMessage = (message) => {
1325
1328
  return message.type === "report-rendered-compositions";
1326
1329
  };
@@ -1426,6 +1429,13 @@ var createCanvasChannel = ({
1426
1429
  };
1427
1430
  postMessage(message);
1428
1431
  };
1432
+ const updateContextualEditingStateInternal = (options) => {
1433
+ const message = {
1434
+ ...options,
1435
+ type: "update-contextual-editing-state-internal"
1436
+ };
1437
+ postMessage(message);
1438
+ };
1429
1439
  const reportRenderedCompositions = (options) => {
1430
1440
  const message = {
1431
1441
  ...options,
@@ -1472,6 +1482,7 @@ var createCanvasChannel = ({
1472
1482
  dismissPlaceholder,
1473
1483
  triggerCompositionAction,
1474
1484
  updatePreviewSettings,
1485
+ updateContextualEditingStateInternal,
1475
1486
  reportRenderedCompositions
1476
1487
  };
1477
1488
  };
@@ -1557,7 +1568,7 @@ function subscribeToComposition({
1557
1568
  // src/RouteClient.ts
1558
1569
  import { ApiClient as ApiClient5 } from "@uniformdev/context/api";
1559
1570
  var ROUTE_URL = "/api/v1/route";
1560
- var unstable_RouteClient = class extends ApiClient5 {
1571
+ var RouteClient = class extends ApiClient5 {
1561
1572
  constructor(options) {
1562
1573
  var _a;
1563
1574
  if (!options.limitPolicy) {
@@ -1631,7 +1642,7 @@ function bindVariablesToObjectRecursive({
1631
1642
  }
1632
1643
  return;
1633
1644
  }
1634
- const childBind = bindVariablesToObject({
1645
+ const childBind = bindVariablesToObjectRecursive({
1635
1646
  ...bindVariablesOptions,
1636
1647
  value: oldValue,
1637
1648
  recursivePath: currentObjectPath
@@ -1746,6 +1757,7 @@ export {
1746
1757
  IN_CONTEXT_EDITOR_QUERY_STRING_PARAM,
1747
1758
  IS_RENDERED_BY_UNIFORM_ATTRIBUTE,
1748
1759
  PLACEHOLDER_ID,
1760
+ RouteClient,
1749
1761
  UncachedCanvasClient,
1750
1762
  UniqueBatchEntries,
1751
1763
  bindVariables,
@@ -1773,6 +1785,7 @@ export {
1773
1785
  isUpdateComponentParameterMessage,
1774
1786
  isUpdateCompositionInternalMessage,
1775
1787
  isUpdateCompositionMessage,
1788
+ isUpdateContextualEditingStateInternalMessage,
1776
1789
  isUpdatePreviewSettingsMessage,
1777
1790
  localize,
1778
1791
  mapSlotToPersonalizedVariations,
@@ -1780,6 +1793,5 @@ export {
1780
1793
  nullLimitPolicy,
1781
1794
  subscribeToComposition,
1782
1795
  unstable_CompositionRelationshipClient,
1783
- unstable_RouteClient,
1784
1796
  walkComponentTree
1785
1797
  };
package/dist/index.js CHANGED
@@ -309,6 +309,7 @@ __export(src_exports, {
309
309
  IN_CONTEXT_EDITOR_QUERY_STRING_PARAM: () => IN_CONTEXT_EDITOR_QUERY_STRING_PARAM,
310
310
  IS_RENDERED_BY_UNIFORM_ATTRIBUTE: () => IS_RENDERED_BY_UNIFORM_ATTRIBUTE,
311
311
  PLACEHOLDER_ID: () => PLACEHOLDER_ID,
312
+ RouteClient: () => RouteClient,
312
313
  UncachedCanvasClient: () => UncachedCanvasClient,
313
314
  UniqueBatchEntries: () => UniqueBatchEntries,
314
315
  bindVariables: () => bindVariables,
@@ -336,6 +337,7 @@ __export(src_exports, {
336
337
  isUpdateComponentParameterMessage: () => isUpdateComponentParameterMessage,
337
338
  isUpdateCompositionInternalMessage: () => isUpdateCompositionInternalMessage,
338
339
  isUpdateCompositionMessage: () => isUpdateCompositionMessage,
340
+ isUpdateContextualEditingStateInternalMessage: () => isUpdateContextualEditingStateInternalMessage,
339
341
  isUpdatePreviewSettingsMessage: () => isUpdatePreviewSettingsMessage,
340
342
  localize: () => localize,
341
343
  mapSlotToPersonalizedVariations: () => mapSlotToPersonalizedVariations,
@@ -343,7 +345,6 @@ __export(src_exports, {
343
345
  nullLimitPolicy: () => nullLimitPolicy,
344
346
  subscribeToComposition: () => subscribeToComposition,
345
347
  unstable_CompositionRelationshipClient: () => unstable_CompositionRelationshipClient,
346
- unstable_RouteClient: () => unstable_RouteClient,
347
348
  walkComponentTree: () => walkComponentTree
348
349
  });
349
350
  module.exports = __toCommonJS(src_exports);
@@ -1404,6 +1405,9 @@ var isTriggerCompositionActionMessage = (message) => {
1404
1405
  var isUpdatePreviewSettingsMessage = (message) => {
1405
1406
  return message.type === "update-preview-settings";
1406
1407
  };
1408
+ var isUpdateContextualEditingStateInternalMessage = (message) => {
1409
+ return message.type === "update-contextual-editing-state-internal";
1410
+ };
1407
1411
  var isReportRenderedCompositionsMessage = (message) => {
1408
1412
  return message.type === "report-rendered-compositions";
1409
1413
  };
@@ -1509,6 +1513,13 @@ var createCanvasChannel = ({
1509
1513
  };
1510
1514
  postMessage(message);
1511
1515
  };
1516
+ const updateContextualEditingStateInternal = (options) => {
1517
+ const message = {
1518
+ ...options,
1519
+ type: "update-contextual-editing-state-internal"
1520
+ };
1521
+ postMessage(message);
1522
+ };
1512
1523
  const reportRenderedCompositions = (options) => {
1513
1524
  const message = {
1514
1525
  ...options,
@@ -1555,6 +1566,7 @@ var createCanvasChannel = ({
1555
1566
  dismissPlaceholder,
1556
1567
  triggerCompositionAction,
1557
1568
  updatePreviewSettings,
1569
+ updateContextualEditingStateInternal,
1558
1570
  reportRenderedCompositions
1559
1571
  };
1560
1572
  };
@@ -1640,7 +1652,7 @@ function subscribeToComposition({
1640
1652
  // src/RouteClient.ts
1641
1653
  var import_api5 = require("@uniformdev/context/api");
1642
1654
  var ROUTE_URL = "/api/v1/route";
1643
- var unstable_RouteClient = class extends import_api5.ApiClient {
1655
+ var RouteClient = class extends import_api5.ApiClient {
1644
1656
  constructor(options) {
1645
1657
  var _a;
1646
1658
  if (!options.limitPolicy) {
@@ -1714,7 +1726,7 @@ function bindVariablesToObjectRecursive({
1714
1726
  }
1715
1727
  return;
1716
1728
  }
1717
- const childBind = bindVariablesToObject({
1729
+ const childBind = bindVariablesToObjectRecursive({
1718
1730
  ...bindVariablesOptions,
1719
1731
  value: oldValue,
1720
1732
  recursivePath: currentObjectPath
@@ -1830,6 +1842,7 @@ var CanvasClientError = import_api6.ApiClientError;
1830
1842
  IN_CONTEXT_EDITOR_QUERY_STRING_PARAM,
1831
1843
  IS_RENDERED_BY_UNIFORM_ATTRIBUTE,
1832
1844
  PLACEHOLDER_ID,
1845
+ RouteClient,
1833
1846
  UncachedCanvasClient,
1834
1847
  UniqueBatchEntries,
1835
1848
  bindVariables,
@@ -1857,6 +1870,7 @@ var CanvasClientError = import_api6.ApiClientError;
1857
1870
  isUpdateComponentParameterMessage,
1858
1871
  isUpdateCompositionInternalMessage,
1859
1872
  isUpdateCompositionMessage,
1873
+ isUpdateContextualEditingStateInternalMessage,
1860
1874
  isUpdatePreviewSettingsMessage,
1861
1875
  localize,
1862
1876
  mapSlotToPersonalizedVariations,
@@ -1864,6 +1878,5 @@ var CanvasClientError = import_api6.ApiClientError;
1864
1878
  nullLimitPolicy,
1865
1879
  subscribeToComposition,
1866
1880
  unstable_CompositionRelationshipClient,
1867
- unstable_RouteClient,
1868
1881
  walkComponentTree
1869
1882
  });
package/dist/index.mjs CHANGED
@@ -1321,6 +1321,9 @@ var isTriggerCompositionActionMessage = (message) => {
1321
1321
  var isUpdatePreviewSettingsMessage = (message) => {
1322
1322
  return message.type === "update-preview-settings";
1323
1323
  };
1324
+ var isUpdateContextualEditingStateInternalMessage = (message) => {
1325
+ return message.type === "update-contextual-editing-state-internal";
1326
+ };
1324
1327
  var isReportRenderedCompositionsMessage = (message) => {
1325
1328
  return message.type === "report-rendered-compositions";
1326
1329
  };
@@ -1426,6 +1429,13 @@ var createCanvasChannel = ({
1426
1429
  };
1427
1430
  postMessage(message);
1428
1431
  };
1432
+ const updateContextualEditingStateInternal = (options) => {
1433
+ const message = {
1434
+ ...options,
1435
+ type: "update-contextual-editing-state-internal"
1436
+ };
1437
+ postMessage(message);
1438
+ };
1429
1439
  const reportRenderedCompositions = (options) => {
1430
1440
  const message = {
1431
1441
  ...options,
@@ -1472,6 +1482,7 @@ var createCanvasChannel = ({
1472
1482
  dismissPlaceholder,
1473
1483
  triggerCompositionAction,
1474
1484
  updatePreviewSettings,
1485
+ updateContextualEditingStateInternal,
1475
1486
  reportRenderedCompositions
1476
1487
  };
1477
1488
  };
@@ -1557,7 +1568,7 @@ function subscribeToComposition({
1557
1568
  // src/RouteClient.ts
1558
1569
  import { ApiClient as ApiClient5 } from "@uniformdev/context/api";
1559
1570
  var ROUTE_URL = "/api/v1/route";
1560
- var unstable_RouteClient = class extends ApiClient5 {
1571
+ var RouteClient = class extends ApiClient5 {
1561
1572
  constructor(options) {
1562
1573
  var _a;
1563
1574
  if (!options.limitPolicy) {
@@ -1631,7 +1642,7 @@ function bindVariablesToObjectRecursive({
1631
1642
  }
1632
1643
  return;
1633
1644
  }
1634
- const childBind = bindVariablesToObject({
1645
+ const childBind = bindVariablesToObjectRecursive({
1635
1646
  ...bindVariablesOptions,
1636
1647
  value: oldValue,
1637
1648
  recursivePath: currentObjectPath
@@ -1746,6 +1757,7 @@ export {
1746
1757
  IN_CONTEXT_EDITOR_QUERY_STRING_PARAM,
1747
1758
  IS_RENDERED_BY_UNIFORM_ATTRIBUTE,
1748
1759
  PLACEHOLDER_ID,
1760
+ RouteClient,
1749
1761
  UncachedCanvasClient,
1750
1762
  UniqueBatchEntries,
1751
1763
  bindVariables,
@@ -1773,6 +1785,7 @@ export {
1773
1785
  isUpdateComponentParameterMessage,
1774
1786
  isUpdateCompositionInternalMessage,
1775
1787
  isUpdateCompositionMessage,
1788
+ isUpdateContextualEditingStateInternalMessage,
1776
1789
  isUpdatePreviewSettingsMessage,
1777
1790
  localize,
1778
1791
  mapSlotToPersonalizedVariations,
@@ -1780,6 +1793,5 @@ export {
1780
1793
  nullLimitPolicy,
1781
1794
  subscribeToComposition,
1782
1795
  unstable_CompositionRelationshipClient,
1783
- unstable_RouteClient,
1784
1796
  walkComponentTree
1785
1797
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uniformdev/canvas",
3
- "version": "19.20.0",
3
+ "version": "19.20.1-alpha.32+9ad53dedb",
4
4
  "description": "Common functionality and types for Uniform Canvas",
5
5
  "license": "SEE LICENSE IN LICENSE.txt",
6
6
  "main": "./dist/index.js",
@@ -38,7 +38,7 @@
38
38
  "pusher-js": "8.0.1"
39
39
  },
40
40
  "dependencies": {
41
- "@uniformdev/context": "19.20.0",
41
+ "@uniformdev/context": "19.20.1-alpha.32+9ad53dedb",
42
42
  "immer": "9.0.21"
43
43
  },
44
44
  "files": [
@@ -47,5 +47,5 @@
47
47
  "publishConfig": {
48
48
  "access": "public"
49
49
  },
50
- "gitHead": "eb731fec3a9f35b9cc6d218e2a77861ccf00441a"
50
+ "gitHead": "9ad53dedb0a0c580abc314fe1422f48a09efd0aa"
51
51
  }