@uniformdev/canvas 19.36.0 → 19.37.0

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.mts CHANGED
@@ -3732,6 +3732,11 @@ interface paths$4 {
3732
3732
  * This is a primary query parameter, and cannot be used with any other primary query parameters.
3733
3733
  */
3734
3734
  compositionId?: components$3["parameters"]["compositionId"];
3735
+ /**
3736
+ * Specify a single component ID to fetch the component's composition defaults. Response will be a single composition.
3737
+ * This is a primary query parameter, and cannot be used with any other primary query parameters.
3738
+ */
3739
+ componentId?: components$3["parameters"]["componentId"];
3735
3740
  /**
3736
3741
  * Specify a historical composition version ID to fetch (retrieved from the canvas-history API).
3737
3742
  * Must be used with the `compositionId` parameter.
@@ -4032,6 +4037,11 @@ interface components$3 {
4032
4037
  * This is a primary query parameter, and cannot be used with any other primary query parameters.
4033
4038
  */
4034
4039
  compositionId: string;
4040
+ /**
4041
+ * @description Specify a single component ID to fetch the component's composition defaults. Response will be a single composition.
4042
+ * This is a primary query parameter, and cannot be used with any other primary query parameters.
4043
+ */
4044
+ componentId: string;
4035
4045
  /**
4036
4046
  * @description Specify multiple composition IDs to fetch. Response type will be a list.
4037
4047
  * This is a primary query parameter, and cannot be used with any other primary query parameters.
@@ -5585,6 +5595,11 @@ interface external$3 {
5585
5595
  * This is a primary query parameter, and cannot be used with any other primary query parameters.
5586
5596
  */
5587
5597
  compositionId?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["compositionId"];
5598
+ /**
5599
+ * Specify a single component ID to fetch the component's composition defaults. Response will be a single composition.
5600
+ * This is a primary query parameter, and cannot be used with any other primary query parameters.
5601
+ */
5602
+ componentId?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["componentId"];
5588
5603
  /**
5589
5604
  * Specify a historical composition version ID to fetch (retrieved from the canvas-history API).
5590
5605
  * Must be used with the `compositionId` parameter.
@@ -5885,6 +5900,11 @@ interface external$3 {
5885
5900
  * This is a primary query parameter, and cannot be used with any other primary query parameters.
5886
5901
  */
5887
5902
  compositionId: string;
5903
+ /**
5904
+ * @description Specify a single component ID to fetch the component's composition defaults. Response will be a single composition.
5905
+ * This is a primary query parameter, and cannot be used with any other primary query parameters.
5906
+ */
5907
+ componentId: string;
5888
5908
  /**
5889
5909
  * @description Specify multiple composition IDs to fetch. Response type will be a list.
5890
5910
  * This is a primary query parameter, and cannot be used with any other primary query parameters.
@@ -7084,6 +7104,11 @@ interface external$2 {
7084
7104
  * This is a primary query parameter, and cannot be used with any other primary query parameters.
7085
7105
  */
7086
7106
  compositionId?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["compositionId"];
7107
+ /**
7108
+ * Specify a single component ID to fetch the component's composition defaults. Response will be a single composition.
7109
+ * This is a primary query parameter, and cannot be used with any other primary query parameters.
7110
+ */
7111
+ componentId?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["componentId"];
7087
7112
  /**
7088
7113
  * Specify a historical composition version ID to fetch (retrieved from the canvas-history API).
7089
7114
  * Must be used with the `compositionId` parameter.
@@ -7384,6 +7409,11 @@ interface external$2 {
7384
7409
  * This is a primary query parameter, and cannot be used with any other primary query parameters.
7385
7410
  */
7386
7411
  compositionId: string;
7412
+ /**
7413
+ * @description Specify a single component ID to fetch the component's composition defaults. Response will be a single composition.
7414
+ * This is a primary query parameter, and cannot be used with any other primary query parameters.
7415
+ */
7416
+ componentId: string;
7387
7417
  /**
7388
7418
  * @description Specify multiple composition IDs to fetch. Response type will be a list.
7389
7419
  * This is a primary query parameter, and cannot be used with any other primary query parameters.
@@ -7820,6 +7850,7 @@ type CompositionGetByNodePathParameters = CompositionGetBy<'projectMapNodePath'>
7820
7850
  type CompositionGetByNodeIdParameters = CompositionGetBy<'projectMapNodeId'> & SpecificProjectMap;
7821
7851
  type CompositionGetBySlugParameters = CompositionGetBy<'slug'>;
7822
7852
  type CompositionGetByIdParameters = CompositionGetBy<'compositionId'>;
7853
+ type CompositionGetByComponentIdParameters = CompositionGetBy<'componentId'>;
7823
7854
  /** Switches for data resolution */
7824
7855
  type DataResolutionOption = {
7825
7856
  skipDataResolution?: boolean;
@@ -7896,7 +7927,7 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
7896
7927
  private edgeApiHost;
7897
7928
  constructor(options: CanvasClientOptions);
7898
7929
  /** Fetches lists of Canvas compositions, optionally by type */
7899
- getCompositionList(options?: Omit<CompositionGetParameters, 'projectId' | 'compositionId' | 'slug'>): Promise<{
7930
+ getCompositionList(options?: Omit<CompositionGetParameters, 'projectId' | 'componentId' | 'compositionId' | 'slug'>): Promise<{
7900
7931
  compositions: {
7901
7932
  state: number;
7902
7933
  uiStatus?: "Draft" | "Modified" | "Published" | "Orphan" | "Previous" | undefined;
@@ -8042,6 +8073,10 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
8042
8073
  getCompositionById(options: CompositionGetByIdParameters & DataResolutionOptionNegative): Promise<CompositionGetResponse>;
8043
8074
  getCompositionById(options: CompositionGetByIdParameters & DataResolutionOptionPositive & DataResolutionParameters): Promise<CompositionResolvedGetResponse>;
8044
8075
  getCompositionById<T extends CompositionGetResponse = CompositionGetValidResponses>(options: CompositionGetByIdParameters & DataResolutionOption & DataResolutionParameters): Promise<T>;
8076
+ /** Fetches a component definition's composition defaults */
8077
+ getCompositionDefaults(options: CompositionGetByComponentIdParameters & DataResolutionOptionNegative): Promise<CompositionGetResponse>;
8078
+ getCompositionDefaults(options: CompositionGetByComponentIdParameters & DataResolutionOptionPositive & DataResolutionParameters): Promise<CompositionResolvedGetResponse>;
8079
+ getCompositionDefaults<T extends CompositionGetResponse = CompositionGetValidResponses>(options: CompositionGetByComponentIdParameters & DataResolutionOption & DataResolutionParameters): Promise<T>;
8045
8080
  /** Fetches historical versions of a composition or pattern */
8046
8081
  unstable_getCompositionHistory(options: ExceptProject<ComponentInstanceHistoryGetParameters>): Promise<{
8047
8082
  cursor?: string | undefined;
@@ -9317,4 +9352,4 @@ declare function mapSlotToTestVariations(slot: ComponentInstance[] | undefined):
9317
9352
 
9318
9353
  declare const CanvasClientError: typeof ApiClientError;
9319
9354
 
9320
- export { ATTRIBUTE_COMPONENT_ID, ATTRIBUTE_MULTILINE, ATTRIBUTE_PARAMETER_ID, ATTRIBUTE_PARAMETER_TYPE, ATTRIBUTE_PARAMETER_VALUE, ATTRIBUTE_PLACEHOLDER, 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, CategoriesDeleteParameters, CategoriesGetParameters, CategoriesGetResponse, CategoriesPutParameters, Category, CategoryClient, 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, GetParameterAttributesProps, 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, SelectParameterMessage, SpecificProjectMap, SubscribeToCompositionOptions, TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, 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, getParameterAttributes, isAddComponentMessage, isDismissPlaceholderMessage, isMovingComponentMessage, isReadyMessage, isReportRenderedCompositionsMessage, isSelectComponentMessage, isSelectParameterMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateComponentParameterMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, subscribeToComposition, unstable_CompositionRelationshipClient, walkComponentTree };
9355
+ export { ATTRIBUTE_COMPONENT_ID, ATTRIBUTE_MULTILINE, ATTRIBUTE_PARAMETER_ID, ATTRIBUTE_PARAMETER_TYPE, ATTRIBUTE_PARAMETER_VALUE, ATTRIBUTE_PLACEHOLDER, 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, CategoriesDeleteParameters, CategoriesGetParameters, CategoriesGetResponse, CategoriesPutParameters, Category, CategoryClient, 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, CompositionGetByComponentIdParameters, 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, GetParameterAttributesProps, 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, SelectParameterMessage, SpecificProjectMap, SubscribeToCompositionOptions, TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, 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, getParameterAttributes, isAddComponentMessage, isDismissPlaceholderMessage, isMovingComponentMessage, isReadyMessage, isReportRenderedCompositionsMessage, isSelectComponentMessage, isSelectParameterMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateComponentParameterMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, subscribeToComposition, unstable_CompositionRelationshipClient, walkComponentTree };
package/dist/index.d.ts CHANGED
@@ -3732,6 +3732,11 @@ interface paths$4 {
3732
3732
  * This is a primary query parameter, and cannot be used with any other primary query parameters.
3733
3733
  */
3734
3734
  compositionId?: components$3["parameters"]["compositionId"];
3735
+ /**
3736
+ * Specify a single component ID to fetch the component's composition defaults. Response will be a single composition.
3737
+ * This is a primary query parameter, and cannot be used with any other primary query parameters.
3738
+ */
3739
+ componentId?: components$3["parameters"]["componentId"];
3735
3740
  /**
3736
3741
  * Specify a historical composition version ID to fetch (retrieved from the canvas-history API).
3737
3742
  * Must be used with the `compositionId` parameter.
@@ -4032,6 +4037,11 @@ interface components$3 {
4032
4037
  * This is a primary query parameter, and cannot be used with any other primary query parameters.
4033
4038
  */
4034
4039
  compositionId: string;
4040
+ /**
4041
+ * @description Specify a single component ID to fetch the component's composition defaults. Response will be a single composition.
4042
+ * This is a primary query parameter, and cannot be used with any other primary query parameters.
4043
+ */
4044
+ componentId: string;
4035
4045
  /**
4036
4046
  * @description Specify multiple composition IDs to fetch. Response type will be a list.
4037
4047
  * This is a primary query parameter, and cannot be used with any other primary query parameters.
@@ -5585,6 +5595,11 @@ interface external$3 {
5585
5595
  * This is a primary query parameter, and cannot be used with any other primary query parameters.
5586
5596
  */
5587
5597
  compositionId?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["compositionId"];
5598
+ /**
5599
+ * Specify a single component ID to fetch the component's composition defaults. Response will be a single composition.
5600
+ * This is a primary query parameter, and cannot be used with any other primary query parameters.
5601
+ */
5602
+ componentId?: external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["parameters"]["componentId"];
5588
5603
  /**
5589
5604
  * Specify a historical composition version ID to fetch (retrieved from the canvas-history API).
5590
5605
  * Must be used with the `compositionId` parameter.
@@ -5885,6 +5900,11 @@ interface external$3 {
5885
5900
  * This is a primary query parameter, and cannot be used with any other primary query parameters.
5886
5901
  */
5887
5902
  compositionId: string;
5903
+ /**
5904
+ * @description Specify a single component ID to fetch the component's composition defaults. Response will be a single composition.
5905
+ * This is a primary query parameter, and cannot be used with any other primary query parameters.
5906
+ */
5907
+ componentId: string;
5888
5908
  /**
5889
5909
  * @description Specify multiple composition IDs to fetch. Response type will be a list.
5890
5910
  * This is a primary query parameter, and cannot be used with any other primary query parameters.
@@ -7084,6 +7104,11 @@ interface external$2 {
7084
7104
  * This is a primary query parameter, and cannot be used with any other primary query parameters.
7085
7105
  */
7086
7106
  compositionId?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["compositionId"];
7107
+ /**
7108
+ * Specify a single component ID to fetch the component's composition defaults. Response will be a single composition.
7109
+ * This is a primary query parameter, and cannot be used with any other primary query parameters.
7110
+ */
7111
+ componentId?: external$2["v1-canvas.swagger.yml"]["components"]["parameters"]["componentId"];
7087
7112
  /**
7088
7113
  * Specify a historical composition version ID to fetch (retrieved from the canvas-history API).
7089
7114
  * Must be used with the `compositionId` parameter.
@@ -7384,6 +7409,11 @@ interface external$2 {
7384
7409
  * This is a primary query parameter, and cannot be used with any other primary query parameters.
7385
7410
  */
7386
7411
  compositionId: string;
7412
+ /**
7413
+ * @description Specify a single component ID to fetch the component's composition defaults. Response will be a single composition.
7414
+ * This is a primary query parameter, and cannot be used with any other primary query parameters.
7415
+ */
7416
+ componentId: string;
7387
7417
  /**
7388
7418
  * @description Specify multiple composition IDs to fetch. Response type will be a list.
7389
7419
  * This is a primary query parameter, and cannot be used with any other primary query parameters.
@@ -7820,6 +7850,7 @@ type CompositionGetByNodePathParameters = CompositionGetBy<'projectMapNodePath'>
7820
7850
  type CompositionGetByNodeIdParameters = CompositionGetBy<'projectMapNodeId'> & SpecificProjectMap;
7821
7851
  type CompositionGetBySlugParameters = CompositionGetBy<'slug'>;
7822
7852
  type CompositionGetByIdParameters = CompositionGetBy<'compositionId'>;
7853
+ type CompositionGetByComponentIdParameters = CompositionGetBy<'componentId'>;
7823
7854
  /** Switches for data resolution */
7824
7855
  type DataResolutionOption = {
7825
7856
  skipDataResolution?: boolean;
@@ -7896,7 +7927,7 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
7896
7927
  private edgeApiHost;
7897
7928
  constructor(options: CanvasClientOptions);
7898
7929
  /** Fetches lists of Canvas compositions, optionally by type */
7899
- getCompositionList(options?: Omit<CompositionGetParameters, 'projectId' | 'compositionId' | 'slug'>): Promise<{
7930
+ getCompositionList(options?: Omit<CompositionGetParameters, 'projectId' | 'componentId' | 'compositionId' | 'slug'>): Promise<{
7900
7931
  compositions: {
7901
7932
  state: number;
7902
7933
  uiStatus?: "Draft" | "Modified" | "Published" | "Orphan" | "Previous" | undefined;
@@ -8042,6 +8073,10 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
8042
8073
  getCompositionById(options: CompositionGetByIdParameters & DataResolutionOptionNegative): Promise<CompositionGetResponse>;
8043
8074
  getCompositionById(options: CompositionGetByIdParameters & DataResolutionOptionPositive & DataResolutionParameters): Promise<CompositionResolvedGetResponse>;
8044
8075
  getCompositionById<T extends CompositionGetResponse = CompositionGetValidResponses>(options: CompositionGetByIdParameters & DataResolutionOption & DataResolutionParameters): Promise<T>;
8076
+ /** Fetches a component definition's composition defaults */
8077
+ getCompositionDefaults(options: CompositionGetByComponentIdParameters & DataResolutionOptionNegative): Promise<CompositionGetResponse>;
8078
+ getCompositionDefaults(options: CompositionGetByComponentIdParameters & DataResolutionOptionPositive & DataResolutionParameters): Promise<CompositionResolvedGetResponse>;
8079
+ getCompositionDefaults<T extends CompositionGetResponse = CompositionGetValidResponses>(options: CompositionGetByComponentIdParameters & DataResolutionOption & DataResolutionParameters): Promise<T>;
8045
8080
  /** Fetches historical versions of a composition or pattern */
8046
8081
  unstable_getCompositionHistory(options: ExceptProject<ComponentInstanceHistoryGetParameters>): Promise<{
8047
8082
  cursor?: string | undefined;
@@ -9317,4 +9352,4 @@ declare function mapSlotToTestVariations(slot: ComponentInstance[] | undefined):
9317
9352
 
9318
9353
  declare const CanvasClientError: typeof ApiClientError;
9319
9354
 
9320
- export { ATTRIBUTE_COMPONENT_ID, ATTRIBUTE_MULTILINE, ATTRIBUTE_PARAMETER_ID, ATTRIBUTE_PARAMETER_TYPE, ATTRIBUTE_PARAMETER_VALUE, ATTRIBUTE_PLACEHOLDER, 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, CategoriesDeleteParameters, CategoriesGetParameters, CategoriesGetResponse, CategoriesPutParameters, Category, CategoryClient, 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, GetParameterAttributesProps, 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, SelectParameterMessage, SpecificProjectMap, SubscribeToCompositionOptions, TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, 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, getParameterAttributes, isAddComponentMessage, isDismissPlaceholderMessage, isMovingComponentMessage, isReadyMessage, isReportRenderedCompositionsMessage, isSelectComponentMessage, isSelectParameterMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateComponentParameterMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, subscribeToComposition, unstable_CompositionRelationshipClient, walkComponentTree };
9355
+ export { ATTRIBUTE_COMPONENT_ID, ATTRIBUTE_MULTILINE, ATTRIBUTE_PARAMETER_ID, ATTRIBUTE_PARAMETER_TYPE, ATTRIBUTE_PARAMETER_VALUE, ATTRIBUTE_PLACEHOLDER, 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, CategoriesDeleteParameters, CategoriesGetParameters, CategoriesGetResponse, CategoriesPutParameters, Category, CategoryClient, 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, CompositionGetByComponentIdParameters, 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, GetParameterAttributesProps, 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, SelectParameterMessage, SpecificProjectMap, SubscribeToCompositionOptions, TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, 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, getParameterAttributes, isAddComponentMessage, isDismissPlaceholderMessage, isMovingComponentMessage, isReadyMessage, isReportRenderedCompositionsMessage, isSelectComponentMessage, isSelectParameterMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateComponentParameterMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, subscribeToComposition, unstable_CompositionRelationshipClient, walkComponentTree };
package/dist/index.esm.js CHANGED
@@ -271,6 +271,9 @@ var require_retry2 = __commonJS({
271
271
  // src/CanvasClient.ts
272
272
  import { ApiClient } from "@uniformdev/context/api";
273
273
 
274
+ // src/enhancement/createLimitPolicy.ts
275
+ import { ApiClientError } from "@uniformdev/context/api";
276
+
274
277
  // ../../node_modules/.pnpm/p-retry@5.1.2/node_modules/p-retry/index.js
275
278
  var import_retry = __toESM(require_retry2(), 1);
276
279
  var networkErrorMsgs = /* @__PURE__ */ new Set([
@@ -446,7 +449,17 @@ function createLimitPolicy({
446
449
  }
447
450
  if (retry2) {
448
451
  const retryFunc = currentFunc;
449
- currentFunc = () => pRetry(retryFunc, retry2);
452
+ currentFunc = () => pRetry(retryFunc, {
453
+ ...retry2,
454
+ onFailedAttempt: async (error) => {
455
+ if (retry2.onFailedAttempt) {
456
+ await retry2.onFailedAttempt(error);
457
+ }
458
+ if (error instanceof ApiClientError && typeof error.statusCode === "number" && error.statusCode.toString().startsWith("4")) {
459
+ throw error;
460
+ }
461
+ }
462
+ });
450
463
  }
451
464
  return currentFunc();
452
465
  };
@@ -482,6 +495,9 @@ var CanvasClient = class extends ApiClient {
482
495
  getCompositionById(options) {
483
496
  return this.getOneComposition(options);
484
497
  }
498
+ getCompositionDefaults(options) {
499
+ return this.getOneComposition(options);
500
+ }
485
501
  /** Fetches historical versions of a composition or pattern */
486
502
  async unstable_getCompositionHistory(options) {
487
503
  const edgeUrl = this.createUrl("/api/v1/canvas-history", {
@@ -1806,8 +1822,8 @@ function mapSlotToTestVariations(slot) {
1806
1822
  }
1807
1823
 
1808
1824
  // src/index.ts
1809
- import { ApiClientError } from "@uniformdev/context/api";
1810
- var CanvasClientError = ApiClientError;
1825
+ import { ApiClientError as ApiClientError2 } from "@uniformdev/context/api";
1826
+ var CanvasClientError = ApiClientError2;
1811
1827
  export {
1812
1828
  ATTRIBUTE_COMPONENT_ID,
1813
1829
  ATTRIBUTE_MULTILINE,
@@ -1815,7 +1831,7 @@ export {
1815
1831
  ATTRIBUTE_PARAMETER_TYPE,
1816
1832
  ATTRIBUTE_PARAMETER_VALUE,
1817
1833
  ATTRIBUTE_PLACEHOLDER,
1818
- ApiClientError,
1834
+ ApiClientError2 as ApiClientError,
1819
1835
  BatchEntry,
1820
1836
  CANVAS_DRAFT_STATE,
1821
1837
  CANVAS_ENRICHMENT_TAG_PARAM,
package/dist/index.js CHANGED
@@ -283,7 +283,7 @@ __export(src_exports, {
283
283
  ATTRIBUTE_PARAMETER_TYPE: () => ATTRIBUTE_PARAMETER_TYPE,
284
284
  ATTRIBUTE_PARAMETER_VALUE: () => ATTRIBUTE_PARAMETER_VALUE,
285
285
  ATTRIBUTE_PLACEHOLDER: () => ATTRIBUTE_PLACEHOLDER,
286
- ApiClientError: () => import_api7.ApiClientError,
286
+ ApiClientError: () => import_api8.ApiClientError,
287
287
  BatchEntry: () => BatchEntry,
288
288
  CANVAS_DRAFT_STATE: () => CANVAS_DRAFT_STATE,
289
289
  CANVAS_ENRICHMENT_TAG_PARAM: () => CANVAS_ENRICHMENT_TAG_PARAM,
@@ -363,6 +363,9 @@ __export(src_exports, {
363
363
  module.exports = __toCommonJS(src_exports);
364
364
 
365
365
  // src/CanvasClient.ts
366
+ var import_api2 = require("@uniformdev/context/api");
367
+
368
+ // src/enhancement/createLimitPolicy.ts
366
369
  var import_api = require("@uniformdev/context/api");
367
370
 
368
371
  // ../../node_modules/.pnpm/p-retry@5.1.2/node_modules/p-retry/index.js
@@ -540,7 +543,17 @@ function createLimitPolicy({
540
543
  }
541
544
  if (retry2) {
542
545
  const retryFunc = currentFunc;
543
- currentFunc = () => pRetry(retryFunc, retry2);
546
+ currentFunc = () => pRetry(retryFunc, {
547
+ ...retry2,
548
+ onFailedAttempt: async (error) => {
549
+ if (retry2.onFailedAttempt) {
550
+ await retry2.onFailedAttempt(error);
551
+ }
552
+ if (error instanceof import_api.ApiClientError && typeof error.statusCode === "number" && error.statusCode.toString().startsWith("4")) {
553
+ throw error;
554
+ }
555
+ }
556
+ });
544
557
  }
545
558
  return currentFunc();
546
559
  };
@@ -549,7 +562,7 @@ var nullLimitPolicy = async (func) => await func();
549
562
 
550
563
  // src/CanvasClient.ts
551
564
  var CANVAS_URL = "/api/v1/canvas";
552
- var CanvasClient = class extends import_api.ApiClient {
565
+ var CanvasClient = class extends import_api2.ApiClient {
553
566
  constructor(options) {
554
567
  var _a;
555
568
  if (!options.limitPolicy) {
@@ -576,6 +589,9 @@ var CanvasClient = class extends import_api.ApiClient {
576
589
  getCompositionById(options) {
577
590
  return this.getOneComposition(options);
578
591
  }
592
+ getCompositionDefaults(options) {
593
+ return this.getOneComposition(options);
594
+ }
579
595
  /** Fetches historical versions of a composition or pattern */
580
596
  async unstable_getCompositionHistory(options) {
581
597
  const edgeUrl = this.createUrl("/api/v1/canvas-history", {
@@ -652,9 +668,9 @@ var UncachedCanvasClient = class extends CanvasClient {
652
668
  };
653
669
 
654
670
  // src/CategoryClient.ts
655
- var import_api2 = require("@uniformdev/context/api");
671
+ var import_api3 = require("@uniformdev/context/api");
656
672
  var CATEGORIES_URL = "/api/v1/categories";
657
- var CategoryClient = class extends import_api2.ApiClient {
673
+ var CategoryClient = class extends import_api3.ApiClient {
658
674
  constructor(options) {
659
675
  if (!options.limitPolicy) {
660
676
  options.limitPolicy = createLimitPolicy({});
@@ -695,9 +711,9 @@ var UncachedCategoryClient = class extends CategoryClient {
695
711
  };
696
712
 
697
713
  // src/CompositionRelationshipClient.ts
698
- var import_api3 = require("@uniformdev/context/api");
714
+ var import_api4 = require("@uniformdev/context/api");
699
715
  var COMPOSITION_RELATIONSHIP_URL = "/api/v1/composition-relationships";
700
- var unstable_CompositionRelationshipClient = class extends import_api3.ApiClient {
716
+ var unstable_CompositionRelationshipClient = class extends import_api4.ApiClient {
701
717
  constructor(options) {
702
718
  super(options);
703
719
  this.getDefinitionsRelationships = async ({
@@ -758,10 +774,10 @@ var unstable_CompositionRelationshipClient = class extends import_api3.ApiClient
758
774
  };
759
775
 
760
776
  // src/DataSourceClient.ts
761
- var import_api4 = require("@uniformdev/context/api");
777
+ var import_api5 = require("@uniformdev/context/api");
762
778
  var dataSourceUrl = "/api/v1/data-source";
763
779
  var dataSourcesUrl = "/api/v1/data-sources";
764
- var DataSourceClient = class extends import_api4.ApiClient {
780
+ var DataSourceClient = class extends import_api5.ApiClient {
765
781
  constructor(options) {
766
782
  super(options);
767
783
  }
@@ -798,9 +814,9 @@ var DataSourceClient = class extends import_api4.ApiClient {
798
814
  };
799
815
 
800
816
  // src/DataTypeClient.ts
801
- var import_api5 = require("@uniformdev/context/api");
817
+ var import_api6 = require("@uniformdev/context/api");
802
818
  var _url;
803
- var _DataTypeClient = class _DataTypeClient extends import_api5.ApiClient {
819
+ var _DataTypeClient = class _DataTypeClient extends import_api6.ApiClient {
804
820
  constructor(options) {
805
821
  super(options);
806
822
  }
@@ -1717,9 +1733,9 @@ function subscribeToComposition({
1717
1733
  }
1718
1734
 
1719
1735
  // src/RouteClient.ts
1720
- var import_api6 = require("@uniformdev/context/api");
1736
+ var import_api7 = require("@uniformdev/context/api");
1721
1737
  var ROUTE_URL = "/api/v1/route";
1722
- var RouteClient = class extends import_api6.ApiClient {
1738
+ var RouteClient = class extends import_api7.ApiClient {
1723
1739
  constructor(options) {
1724
1740
  var _a;
1725
1741
  if (!options.limitPolicy) {
@@ -1900,8 +1916,8 @@ function mapSlotToTestVariations(slot) {
1900
1916
  }
1901
1917
 
1902
1918
  // src/index.ts
1903
- var import_api7 = require("@uniformdev/context/api");
1904
- var CanvasClientError = import_api7.ApiClientError;
1919
+ var import_api8 = require("@uniformdev/context/api");
1920
+ var CanvasClientError = import_api8.ApiClientError;
1905
1921
  // Annotate the CommonJS export names for ESM import in node:
1906
1922
  0 && (module.exports = {
1907
1923
  ATTRIBUTE_COMPONENT_ID,
package/dist/index.mjs CHANGED
@@ -271,6 +271,9 @@ var require_retry2 = __commonJS({
271
271
  // src/CanvasClient.ts
272
272
  import { ApiClient } from "@uniformdev/context/api";
273
273
 
274
+ // src/enhancement/createLimitPolicy.ts
275
+ import { ApiClientError } from "@uniformdev/context/api";
276
+
274
277
  // ../../node_modules/.pnpm/p-retry@5.1.2/node_modules/p-retry/index.js
275
278
  var import_retry = __toESM(require_retry2(), 1);
276
279
  var networkErrorMsgs = /* @__PURE__ */ new Set([
@@ -446,7 +449,17 @@ function createLimitPolicy({
446
449
  }
447
450
  if (retry2) {
448
451
  const retryFunc = currentFunc;
449
- currentFunc = () => pRetry(retryFunc, retry2);
452
+ currentFunc = () => pRetry(retryFunc, {
453
+ ...retry2,
454
+ onFailedAttempt: async (error) => {
455
+ if (retry2.onFailedAttempt) {
456
+ await retry2.onFailedAttempt(error);
457
+ }
458
+ if (error instanceof ApiClientError && typeof error.statusCode === "number" && error.statusCode.toString().startsWith("4")) {
459
+ throw error;
460
+ }
461
+ }
462
+ });
450
463
  }
451
464
  return currentFunc();
452
465
  };
@@ -482,6 +495,9 @@ var CanvasClient = class extends ApiClient {
482
495
  getCompositionById(options) {
483
496
  return this.getOneComposition(options);
484
497
  }
498
+ getCompositionDefaults(options) {
499
+ return this.getOneComposition(options);
500
+ }
485
501
  /** Fetches historical versions of a composition or pattern */
486
502
  async unstable_getCompositionHistory(options) {
487
503
  const edgeUrl = this.createUrl("/api/v1/canvas-history", {
@@ -1806,8 +1822,8 @@ function mapSlotToTestVariations(slot) {
1806
1822
  }
1807
1823
 
1808
1824
  // src/index.ts
1809
- import { ApiClientError } from "@uniformdev/context/api";
1810
- var CanvasClientError = ApiClientError;
1825
+ import { ApiClientError as ApiClientError2 } from "@uniformdev/context/api";
1826
+ var CanvasClientError = ApiClientError2;
1811
1827
  export {
1812
1828
  ATTRIBUTE_COMPONENT_ID,
1813
1829
  ATTRIBUTE_MULTILINE,
@@ -1815,7 +1831,7 @@ export {
1815
1831
  ATTRIBUTE_PARAMETER_TYPE,
1816
1832
  ATTRIBUTE_PARAMETER_VALUE,
1817
1833
  ATTRIBUTE_PLACEHOLDER,
1818
- ApiClientError,
1834
+ ApiClientError2 as ApiClientError,
1819
1835
  BatchEntry,
1820
1836
  CANVAS_DRAFT_STATE,
1821
1837
  CANVAS_ENRICHMENT_TAG_PARAM,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uniformdev/canvas",
3
- "version": "19.36.0",
3
+ "version": "19.37.0",
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.2.0"
39
39
  },
40
40
  "dependencies": {
41
- "@uniformdev/context": "19.36.0",
41
+ "@uniformdev/context": "19.37.0",
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": "3ae246a7f0f39adeaf04ecba4c7e48c478c019ad"
50
+ "gitHead": "2f595c3eb8113fc602b6abb0bfa7a4c5fcfc2659"
51
51
  }