@uniformdev/canvas 20.27.1 → 20.30.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 +45 -7
- package/dist/index.d.ts +45 -7
- package/dist/index.esm.js +17 -5
- package/dist/index.js +18 -5
- package/dist/index.mjs +17 -5
- package/package.json +5 -5
package/dist/index.d.mts
CHANGED
@@ -1813,6 +1813,8 @@ declare const CANVAS_PERSONALIZATION_PARAM = "$pzCrit";
|
|
1813
1813
|
declare const CANVAS_PERSONALIZATION_EVENT_NAME_PARAM = "trackingEventName";
|
1814
1814
|
/** Public ID of the Uniform Context personalization component's algorithm parameter */
|
1815
1815
|
declare const CANVAS_PERSONALIZATION_ALGORITHM_PARAM = "algorithm";
|
1816
|
+
/** Type value for the personalization algorithm parameter */
|
1817
|
+
declare const CANVAS_PERSONALIZATION_ALGORITHM_TYPE = "pzAlgorithm";
|
1816
1818
|
/** Public ID of the Uniform Context personalization component's number of variants to show parameter */
|
1817
1819
|
declare const CANVAS_PERSONALIZATION_TAKE_PARAM = "count";
|
1818
1820
|
/** Public ID of the Uniform Context test variant parameter on Canvas components */
|
@@ -3092,7 +3094,13 @@ interface paths$h {
|
|
3092
3094
|
put: {
|
3093
3095
|
parameters: {
|
3094
3096
|
query?: never;
|
3095
|
-
header?:
|
3097
|
+
header?: {
|
3098
|
+
/** @description Optional concurrency control header. If provided, the server will check that the entry
|
3099
|
+
* has not been modified since this timestamp. If the timestamp doesn't match the current
|
3100
|
+
* modified timestamp, a 409 Conflict response will be returned.
|
3101
|
+
* */
|
3102
|
+
"X-If-Unmodified-Since"?: string;
|
3103
|
+
};
|
3096
3104
|
path?: never;
|
3097
3105
|
cookie?: never;
|
3098
3106
|
};
|
@@ -3166,6 +3174,15 @@ interface paths$h {
|
|
3166
3174
|
400: components$j["responses"]["BadRequestError"];
|
3167
3175
|
401: components$j["responses"]["UnauthorizedError"];
|
3168
3176
|
403: components$j["responses"]["ForbiddenError"];
|
3177
|
+
/** @description Conflict - Entry has been changed since being loaded */
|
3178
|
+
409: {
|
3179
|
+
headers: {
|
3180
|
+
[name: string]: unknown;
|
3181
|
+
};
|
3182
|
+
content: {
|
3183
|
+
"text/plain": string;
|
3184
|
+
};
|
3185
|
+
};
|
3169
3186
|
429: components$j["responses"]["RateLimitError"];
|
3170
3187
|
500: components$j["responses"]["InternalServerError"];
|
3171
3188
|
};
|
@@ -6282,7 +6299,13 @@ interface paths$a {
|
|
6282
6299
|
put: {
|
6283
6300
|
parameters: {
|
6284
6301
|
query?: never;
|
6285
|
-
header?:
|
6302
|
+
header?: {
|
6303
|
+
/** @description Optional concurrency control header. If provided, the server will check that the composition
|
6304
|
+
* has not been modified since this timestamp. If the timestamp doesn't match the current
|
6305
|
+
* modified timestamp, a 409 Conflict response will be returned.
|
6306
|
+
* */
|
6307
|
+
"X-If-Unmodified-Since"?: string;
|
6308
|
+
};
|
6286
6309
|
path?: never;
|
6287
6310
|
cookie?: never;
|
6288
6311
|
};
|
@@ -6372,6 +6395,15 @@ interface paths$a {
|
|
6372
6395
|
400: components$b["responses"]["BadRequestError"];
|
6373
6396
|
401: components$b["responses"]["UnauthorizedError"];
|
6374
6397
|
403: components$b["responses"]["ForbiddenError"];
|
6398
|
+
/** @description Conflict - Composition has been changed since being loaded */
|
6399
|
+
409: {
|
6400
|
+
headers: {
|
6401
|
+
[name: string]: unknown;
|
6402
|
+
};
|
6403
|
+
content: {
|
6404
|
+
"text/plain": string;
|
6405
|
+
};
|
6406
|
+
};
|
6375
6407
|
429: components$b["responses"]["RateLimitError"];
|
6376
6408
|
500: components$b["responses"]["InternalServerError"];
|
6377
6409
|
};
|
@@ -11561,6 +11593,9 @@ type CanvasClientOptions = ClientOptions & {
|
|
11561
11593
|
edgeApiHost?: string;
|
11562
11594
|
disableSWR?: boolean;
|
11563
11595
|
};
|
11596
|
+
type UpdateCompositionOptions = {
|
11597
|
+
ifUnmodifiedSince?: string;
|
11598
|
+
};
|
11564
11599
|
declare class CanvasClient extends ApiClient<CanvasClientOptions> {
|
11565
11600
|
private edgeApiHost;
|
11566
11601
|
private edgeApiRequestInit?;
|
@@ -11602,7 +11637,7 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
|
|
11602
11637
|
}>;
|
11603
11638
|
private getOneComposition;
|
11604
11639
|
/** Updates or creates a Canvas component definition */
|
11605
|
-
updateComposition(body: Omit<CompositionPutParameters, 'projectId'
|
11640
|
+
updateComposition(body: Omit<CompositionPutParameters, 'projectId'>, options?: UpdateCompositionOptions): Promise<{
|
11606
11641
|
modified: string | null;
|
11607
11642
|
}>;
|
11608
11643
|
/** Deletes a Canvas component definition */
|
@@ -11635,6 +11670,9 @@ declare class UncachedCategoryClient extends CategoryClient {
|
|
11635
11670
|
constructor(options: Omit<ClientOptions, 'bypassCache'>);
|
11636
11671
|
}
|
11637
11672
|
|
11673
|
+
type UpsertEntryOptions = {
|
11674
|
+
ifUnmodifiedSince?: string;
|
11675
|
+
};
|
11638
11676
|
type ContentClientOptions = ClientOptions & {
|
11639
11677
|
edgeApiHost?: string;
|
11640
11678
|
disableSWR?: boolean;
|
@@ -11656,7 +11694,7 @@ declare class ContentClient extends ApiClient<ContentClientOptions> {
|
|
11656
11694
|
upsertContentType(body: ExceptProject<PutContentTypeBody>, opts?: {
|
11657
11695
|
autogenerateDataTypes?: boolean;
|
11658
11696
|
}): Promise<void>;
|
11659
|
-
upsertEntry(body: ExceptProject<PutEntryBody
|
11697
|
+
upsertEntry(body: ExceptProject<PutEntryBody>, options?: UpsertEntryOptions): Promise<{
|
11660
11698
|
modified: string | null;
|
11661
11699
|
}>;
|
11662
11700
|
deleteContentType(body: ExceptProject<DeleteContentTypeOptions>): Promise<void>;
|
@@ -12840,7 +12878,7 @@ interface paths {
|
|
12840
12878
|
parameters: {
|
12841
12879
|
query: {
|
12842
12880
|
projectId: string;
|
12843
|
-
type: "component" | "contentType" | "blockType" | "asset" | "componentPattern" | "entryPattern" | "compositionPattern" | "entry";
|
12881
|
+
type: "component" | "contentType" | "blockType" | "asset" | "componentPattern" | "entryPattern" | "compositionPattern" | "entry" | "dataType" | "dataSource" | "test";
|
12844
12882
|
ids: string[];
|
12845
12883
|
withInstances?: boolean | null;
|
12846
12884
|
limit?: number;
|
@@ -13292,7 +13330,7 @@ declare function hasReferencedVariables(value: string | undefined): number;
|
|
13292
13330
|
*/
|
13293
13331
|
declare function parseVariableExpression(serialized: string, onToken?: (token: string, type: 'text' | 'variable') => void | false): number;
|
13294
13332
|
|
13295
|
-
declare const version = "20.
|
13333
|
+
declare const version = "20.30.0";
|
13296
13334
|
|
13297
13335
|
/** API client to enable managing workflow definitions */
|
13298
13336
|
declare class WorkflowClient extends ApiClient {
|
@@ -13309,4 +13347,4 @@ declare class WorkflowClient extends ApiClient {
|
|
13309
13347
|
|
13310
13348
|
declare const CanvasClientError: typeof ApiClientError;
|
13311
13349
|
|
13312
|
-
export { ASSETS_SOURCE_CUSTOM_URL, ASSETS_SOURCE_UNIFORM, ASSET_PARAMETER_TYPE, ATTRIBUTE_COMPONENT_ID, ATTRIBUTE_MULTILINE, ATTRIBUTE_PARAMETER_ID, ATTRIBUTE_PARAMETER_TYPE, ATTRIBUTE_PARAMETER_VALUE, ATTRIBUTE_PLACEHOLDER, type AddComponentMessage, type BatchEnhancer, BatchEntry, type BatchInvalidationPayload, type BindVariablesOptions, type BindVariablesResult, type BindVariablesToObjectOptions, BlockFormatError, type BlockLocationReference, type BlockValue, CANVAS_BLOCK_PARAM_TYPE, CANVAS_CONTEXTUAL_EDITING_PARAM, CANVAS_DRAFT_STATE, CANVAS_EDITOR_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_ALGORITHM_PARAM, CANVAS_PERSONALIZATION_EVENT_NAME_PARAM, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZATION_TAKE_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_SLOT_SECTION_SLOT, CANVAS_SLOT_SECTION_TYPE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CANVAS_VIZ_CONTROL_PARAM, CANVAS_VIZ_DI_RULE, CANVAS_VIZ_DYNAMIC_TOKEN_RULE, CANVAS_VIZ_LOCALE_RULE, CANVAS_VIZ_QUIRKS_RULE, CanvasClient, CanvasClientError, type CanvasDefinitions, type CategoriesDeleteParameters, type CategoriesGetParameters, type CategoriesGetResponse, type CategoriesPutParameters, type Category, CategoryClient, type Channel, type ChannelMessage, ChildEnhancerBuilder, type ComponentDefinition, type ComponentDefinitionDeleteParameters, type ComponentDefinitionGetParameters, type ComponentDefinitionGetResponse, type ComponentDefinitionParameter, type ComponentDefinitionPermission, type ComponentDefinitionPutParameters, type ComponentDefinitionSlot, type ComponentDefinitionSlugSettings, type ComponentDefinitionVariant, type ComponentEnhancer, type ComponentEnhancerFunction, type ComponentEnhancerOptions, type ComponentInstance, type ComponentInstanceContextualEditing, type ComponentInstanceHistoryEntry, type ComponentInstanceHistoryGetParameters, type ComponentInstanceHistoryGetResponse, type ComponentLocationReference, type ComponentOverridability, type ComponentOverride, type ComponentOverrides, type ComponentParameter, type ComponentParameterBlock, type ComponentParameterConditionalValue, type ComponentParameterContextualEditing, type ComponentParameterEnhancer, type ComponentParameterEnhancerFunction, type ComponentParameterEnhancerOptions, type CompositionDeleteParameters, type CompositionFilters, type CompositionGetByComponentIdParameters, type CompositionGetByIdParameters, type CompositionGetByNodeIdParameters, type CompositionGetByNodePathParameters, type CompositionGetBySlugParameters, type CompositionGetListResponse, type CompositionGetParameters, type CompositionGetResponse, type CompositionGetValidResponses, type CompositionPutParameters, type CompositionResolvedGetResponse, type CompositionResolvedListResponse, type CompositionUIStatus, ContentClient, type ContentType, type ContentTypeField, type ContentTypePreviewConfiguration, type ContextStorageUpdatedMessage, type ContextualEditingComponentReference, type ContextualEditingValue, type CopiedComponentSubtree, type DataDiagnostic, type DataElementBindingIssue, type DataElementConnectionDefinition, type DataElementConnectionFailureAction, type DataElementConnectionFailureLogLevel, type DataResolutionConfigIssue, type DataResolutionIssue, type DataResolutionOption, type DataResolutionOptionNegative, type DataResolutionOptionPositive, type DataResolutionParameters, type DataResourceDefinition, type DataResourceDefinitions, type DataResourceIssue, type DataResourceVariables, type DataSource, DataSourceClient, type DataSourceDeleteParameters, type DataSourceGetParameters, type DataSourceGetResponse, type DataSourcePutParameters, type DataSourceVariantData, type DataSourceVariantsKeys, type DataSourcesGetParameters, type DataSourcesGetResponse, type DataType, DataTypeClient, type DataTypeDeleteParameters, type DataTypeGetParameters, type DataTypeGetResponse, type DataTypePutParameters, type DataVariableDefinition, type DataWithProperties, type DeleteContentTypeOptions, type DeleteEntryOptions, type DismissPlaceholderMessage, type DynamicInputIssue, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_MAX_CACHE_TTL, EDGE_MIN_CACHE_TTL, EMPTY_COMPOSITION, type EdgehancersDiagnostics, type EdgehancersWholeResponseCacheDiagnostics, type EditorStateUpdatedMessage, EnhancerBuilder, type EnhancerContext, type EnhancerError, EntityReleasesClient, type EntityReleasesGetParameters, type EntityReleasesGetResponse, type EntriesGetParameters, type EntriesGetResponse, type EntriesHistoryGetParameters, type EntriesHistoryGetResponse, type EntriesResolvedListResponse, type Entry, type EntryData, type EntryFilters, type EntryList, type EvaluateCriteriaGroupOptions, type EvaluateNodeTreeVisibilityOptions, type EvaluateNodeVisibilityParameterOptions, type EvaluatePropertyCriteriaOptions, type EvaluateWalkTreePropertyCriteriaOptions, type Filters, type FindInNodeTreeReference, type FlattenProperty, type FlattenValues, type FlattenValuesOptions, type GetContentTypesOptions, type GetContentTypesResponse, type GetEffectivePropertyValueOptions, type GetEntriesOptions, type GetEntriesResponse, type GetParameterAttributesProps, IN_CONTEXT_EDITOR_COMPONENT_END_ROLE, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_CONFIG_CHECK_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_FORCED_SETTINGS_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, IS_RENDERED_BY_UNIFORM_ATTRIBUTE, type InvalidationPayload, LOCALE_DYNAMIC_INPUT_NAME, type LimitPolicy, type LinkParamConfiguration, type LinkParamValue, type LinkParameterType, type LinkTypeConfiguration, type Locale, LocaleClient, type LocaleDeleteParameters, type LocalePutParameters, type LocalesGetParameters, type LocalesGetResponse, type LocalizeOptions, type MaxDepthExceededIssue, type MessageHandler, type MoveComponentMessage, type MultiSelectParamConfiguration, type MultiSelectParamValue, type NodeLocationReference, type NonProjectMapLinkParamValue, type NumberParamConfig, type NumberParamValue, type OpenParameterEditorMessage, type OverrideOptions, PLACEHOLDER_ID, type PatternIssue, PreviewClient, type PreviewPanelSettings, type PreviewUrl, type PreviewUrlDeleteParameters, type PreviewUrlDeleteResponse, type PreviewUrlPutParameters, type PreviewUrlPutResponse, type PreviewUrlsGetParameters, type PreviewUrlsGetResponse, type PreviewViewport, type PreviewViewportDeleteParameters, type PreviewViewportDeleteResponse, type PreviewViewportPutParameters, type PreviewViewportPutResponse, type PreviewViewportsGetParameters, type PreviewViewportsGetResponse, type Project, ProjectClient, type ProjectDeleteParameters, type ProjectGetParameters, type ProjectGetResponse, type ProjectMapLinkParamValue, type ProjectPutParameters, type ProjectPutResponse, type Prompt, PromptClient, type PromptsDeleteParameters, type PromptsGetParameters, type PromptsGetResponse, type PromptsPutParameters, type PropertyCriteriaMatch, type PropertyValue, type PutContentTypeBody, type PutEntryBody, type ReadyMessage, RelationshipClient, type RelationshipResultInstance, type Release, ReleaseClient, type ReleaseContent, ReleaseContentsClient, type ReleaseContentsDeleteBody, type ReleaseContentsGetParameters, type ReleaseContentsGetResponse, type ReleaseDeleteParameters, type ReleasePatchParameters, type ReleasePutParameters, type ReleaseState, type ReleasesGetParameters, type ReleasesGetResponse, type ReportRenderedCompositionsMessage, type RequestComponentSuggestionMessage, type RequestPageHtmlMessage, type ResolvedRouteGetResponse, type RichTextBuiltInElement, type RichTextBuiltInFormat, type RichTextParamConfiguration, type RichTextParamValue, type RootComponentInstance, type RootEntryReference, type RootLocationReference, RouteClient, type RouteDynamicInputs, type RouteGetParameters, type RouteGetResponse, type RouteGetResponseComposition, type RouteGetResponseEdgehancedComposition, type RouteGetResponseEdgehancedNotFound, type RouteGetResponseNotFound, type RouteGetResponseRedirect, SECRET_QUERY_STRING_PARAM, type SelectComponentMessage, type SelectParamConfiguration, type SelectParamOption, type SelectParamValue, type SelectParameterMessage, type SendPageHtmlMessage, type SpecificProjectMap, type StringOperators, type SuggestComponentMessage, type TreeNodeInfoTypes, type TriggerComponentActionMessage, type TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, UncachedContentClient, UniqueBatchEntries, type UpdateComponentParameterMessage, type UpdateComponentReferencesMessage, type UpdateCompositionInternalMessage, type UpdateCompositionMessage, type UpdateContextualEditingStateInternalMessage, type UpdateFeatureFlagsMessage, type UpdatePreviewSettingsMessage, type VisibilityCriteria, type VisibilityCriteriaEvaluationResult, type VisibilityCriteriaGroup, type VisibilityParameterValue, type VisibilityRule, type VisibilityRules, type WalkNodeTreeActions, type WalkNodeTreeOptions, WorkflowClient, type WorkflowDefinition, type WorkflowStage, type WorkflowStagePermission, type WorkflowStageTransition, type WorkflowStageTransitionPermission, type WorkflowsDeleteParameters, type WorkflowsGetParameters, type WorkflowsGetResponse, type WorkflowsPutParameters, bindExpressionEscapeChars, bindExpressionPrefix, bindVariables, bindVariablesToObject, compose, convertEntryToPutEntry, convertToBindExpression, createBatchEnhancer, createCanvasChannel, createDynamicInputVisibilityRule, createDynamicTokenVisibilityRule, createLimitPolicy, createLocaleVisibilityRule, createQuirksVisibilityRule, createUniformApiEnhancer, createVariableReference, enhance, escapeBindExpressionDefaultValue, evaluateNodeVisibilityParameter, evaluatePropertyCriteria, evaluateVisibilityCriteriaGroup, evaluateWalkTreeNodeVisibility, evaluateWalkTreePropertyCriteria, extractLocales, findParameterInNodeTree, flattenValues, generateComponentPlaceholderId, generateHash, getBlockValue, getComponentJsonPointer, getComponentPath, getDataSourceVariantFromRouteGetParams, getEffectivePropertyValue, getLocalizedPropertyValues, getNounForLocation, getNounForNode, getParameterAttributes, getPropertiesValue, hasReferencedVariables, isAddComponentMessage, isAllowedReferrer, isAssetParamValue, isAssetParamValueItem, isComponentActionMessage, isComponentPlaceholderId, isContextStorageUpdatedMessage, isDismissPlaceholderMessage, isEntryData, isLinkParamValue, isMovingComponentMessage, isNestedNodeType, isOpenParameterEditorMessage, isReadyMessage, isReportRenderedCompositionsMessage, isRequestComponentSuggestionMessage, isRootEntryReference, isSelectComponentMessage, isSelectParameterMessage, isSuggestComponentMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateComponentParameterMessage, isUpdateComponentReferencesMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdateFeatureFlagsMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, parseComponentPlaceholderId, parseVariableExpression, version, walkNodeTree, walkPropertyValues };
|
13350
|
+
export { ASSETS_SOURCE_CUSTOM_URL, ASSETS_SOURCE_UNIFORM, ASSET_PARAMETER_TYPE, ATTRIBUTE_COMPONENT_ID, ATTRIBUTE_MULTILINE, ATTRIBUTE_PARAMETER_ID, ATTRIBUTE_PARAMETER_TYPE, ATTRIBUTE_PARAMETER_VALUE, ATTRIBUTE_PLACEHOLDER, type AddComponentMessage, type BatchEnhancer, BatchEntry, type BatchInvalidationPayload, type BindVariablesOptions, type BindVariablesResult, type BindVariablesToObjectOptions, BlockFormatError, type BlockLocationReference, type BlockValue, CANVAS_BLOCK_PARAM_TYPE, CANVAS_CONTEXTUAL_EDITING_PARAM, CANVAS_DRAFT_STATE, CANVAS_EDITOR_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_ALGORITHM_PARAM, CANVAS_PERSONALIZATION_ALGORITHM_TYPE, CANVAS_PERSONALIZATION_EVENT_NAME_PARAM, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZATION_TAKE_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_SLOT_SECTION_SLOT, CANVAS_SLOT_SECTION_TYPE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CANVAS_VIZ_CONTROL_PARAM, CANVAS_VIZ_DI_RULE, CANVAS_VIZ_DYNAMIC_TOKEN_RULE, CANVAS_VIZ_LOCALE_RULE, CANVAS_VIZ_QUIRKS_RULE, CanvasClient, CanvasClientError, type CanvasDefinitions, type CategoriesDeleteParameters, type CategoriesGetParameters, type CategoriesGetResponse, type CategoriesPutParameters, type Category, CategoryClient, type Channel, type ChannelMessage, ChildEnhancerBuilder, type ComponentDefinition, type ComponentDefinitionDeleteParameters, type ComponentDefinitionGetParameters, type ComponentDefinitionGetResponse, type ComponentDefinitionParameter, type ComponentDefinitionPermission, type ComponentDefinitionPutParameters, type ComponentDefinitionSlot, type ComponentDefinitionSlugSettings, type ComponentDefinitionVariant, type ComponentEnhancer, type ComponentEnhancerFunction, type ComponentEnhancerOptions, type ComponentInstance, type ComponentInstanceContextualEditing, type ComponentInstanceHistoryEntry, type ComponentInstanceHistoryGetParameters, type ComponentInstanceHistoryGetResponse, type ComponentLocationReference, type ComponentOverridability, type ComponentOverride, type ComponentOverrides, type ComponentParameter, type ComponentParameterBlock, type ComponentParameterConditionalValue, type ComponentParameterContextualEditing, type ComponentParameterEnhancer, type ComponentParameterEnhancerFunction, type ComponentParameterEnhancerOptions, type CompositionDeleteParameters, type CompositionFilters, type CompositionGetByComponentIdParameters, type CompositionGetByIdParameters, type CompositionGetByNodeIdParameters, type CompositionGetByNodePathParameters, type CompositionGetBySlugParameters, type CompositionGetListResponse, type CompositionGetParameters, type CompositionGetResponse, type CompositionGetValidResponses, type CompositionPutParameters, type CompositionResolvedGetResponse, type CompositionResolvedListResponse, type CompositionUIStatus, ContentClient, type ContentType, type ContentTypeField, type ContentTypePreviewConfiguration, type ContextStorageUpdatedMessage, type ContextualEditingComponentReference, type ContextualEditingValue, type CopiedComponentSubtree, type DataDiagnostic, type DataElementBindingIssue, type DataElementConnectionDefinition, type DataElementConnectionFailureAction, type DataElementConnectionFailureLogLevel, type DataResolutionConfigIssue, type DataResolutionIssue, type DataResolutionOption, type DataResolutionOptionNegative, type DataResolutionOptionPositive, type DataResolutionParameters, type DataResourceDefinition, type DataResourceDefinitions, type DataResourceIssue, type DataResourceVariables, type DataSource, DataSourceClient, type DataSourceDeleteParameters, type DataSourceGetParameters, type DataSourceGetResponse, type DataSourcePutParameters, type DataSourceVariantData, type DataSourceVariantsKeys, type DataSourcesGetParameters, type DataSourcesGetResponse, type DataType, DataTypeClient, type DataTypeDeleteParameters, type DataTypeGetParameters, type DataTypeGetResponse, type DataTypePutParameters, type DataVariableDefinition, type DataWithProperties, type DeleteContentTypeOptions, type DeleteEntryOptions, type DismissPlaceholderMessage, type DynamicInputIssue, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_MAX_CACHE_TTL, EDGE_MIN_CACHE_TTL, EMPTY_COMPOSITION, type EdgehancersDiagnostics, type EdgehancersWholeResponseCacheDiagnostics, type EditorStateUpdatedMessage, EnhancerBuilder, type EnhancerContext, type EnhancerError, EntityReleasesClient, type EntityReleasesGetParameters, type EntityReleasesGetResponse, type EntriesGetParameters, type EntriesGetResponse, type EntriesHistoryGetParameters, type EntriesHistoryGetResponse, type EntriesResolvedListResponse, type Entry, type EntryData, type EntryFilters, type EntryList, type EvaluateCriteriaGroupOptions, type EvaluateNodeTreeVisibilityOptions, type EvaluateNodeVisibilityParameterOptions, type EvaluatePropertyCriteriaOptions, type EvaluateWalkTreePropertyCriteriaOptions, type Filters, type FindInNodeTreeReference, type FlattenProperty, type FlattenValues, type FlattenValuesOptions, type GetContentTypesOptions, type GetContentTypesResponse, type GetEffectivePropertyValueOptions, type GetEntriesOptions, type GetEntriesResponse, type GetParameterAttributesProps, IN_CONTEXT_EDITOR_COMPONENT_END_ROLE, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_CONFIG_CHECK_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_FORCED_SETTINGS_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, IS_RENDERED_BY_UNIFORM_ATTRIBUTE, type InvalidationPayload, LOCALE_DYNAMIC_INPUT_NAME, type LimitPolicy, type LinkParamConfiguration, type LinkParamValue, type LinkParameterType, type LinkTypeConfiguration, type Locale, LocaleClient, type LocaleDeleteParameters, type LocalePutParameters, type LocalesGetParameters, type LocalesGetResponse, type LocalizeOptions, type MaxDepthExceededIssue, type MessageHandler, type MoveComponentMessage, type MultiSelectParamConfiguration, type MultiSelectParamValue, type NodeLocationReference, type NonProjectMapLinkParamValue, type NumberParamConfig, type NumberParamValue, type OpenParameterEditorMessage, type OverrideOptions, PLACEHOLDER_ID, type PatternIssue, PreviewClient, type PreviewPanelSettings, type PreviewUrl, type PreviewUrlDeleteParameters, type PreviewUrlDeleteResponse, type PreviewUrlPutParameters, type PreviewUrlPutResponse, type PreviewUrlsGetParameters, type PreviewUrlsGetResponse, type PreviewViewport, type PreviewViewportDeleteParameters, type PreviewViewportDeleteResponse, type PreviewViewportPutParameters, type PreviewViewportPutResponse, type PreviewViewportsGetParameters, type PreviewViewportsGetResponse, type Project, ProjectClient, type ProjectDeleteParameters, type ProjectGetParameters, type ProjectGetResponse, type ProjectMapLinkParamValue, type ProjectPutParameters, type ProjectPutResponse, type Prompt, PromptClient, type PromptsDeleteParameters, type PromptsGetParameters, type PromptsGetResponse, type PromptsPutParameters, type PropertyCriteriaMatch, type PropertyValue, type PutContentTypeBody, type PutEntryBody, type ReadyMessage, RelationshipClient, type RelationshipResultInstance, type Release, ReleaseClient, type ReleaseContent, ReleaseContentsClient, type ReleaseContentsDeleteBody, type ReleaseContentsGetParameters, type ReleaseContentsGetResponse, type ReleaseDeleteParameters, type ReleasePatchParameters, type ReleasePutParameters, type ReleaseState, type ReleasesGetParameters, type ReleasesGetResponse, type ReportRenderedCompositionsMessage, type RequestComponentSuggestionMessage, type RequestPageHtmlMessage, type ResolvedRouteGetResponse, type RichTextBuiltInElement, type RichTextBuiltInFormat, type RichTextParamConfiguration, type RichTextParamValue, type RootComponentInstance, type RootEntryReference, type RootLocationReference, RouteClient, type RouteDynamicInputs, type RouteGetParameters, type RouteGetResponse, type RouteGetResponseComposition, type RouteGetResponseEdgehancedComposition, type RouteGetResponseEdgehancedNotFound, type RouteGetResponseNotFound, type RouteGetResponseRedirect, SECRET_QUERY_STRING_PARAM, type SelectComponentMessage, type SelectParamConfiguration, type SelectParamOption, type SelectParamValue, type SelectParameterMessage, type SendPageHtmlMessage, type SpecificProjectMap, type StringOperators, type SuggestComponentMessage, type TreeNodeInfoTypes, type TriggerComponentActionMessage, type TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, UncachedContentClient, UniqueBatchEntries, type UpdateComponentParameterMessage, type UpdateComponentReferencesMessage, type UpdateCompositionInternalMessage, type UpdateCompositionMessage, type UpdateCompositionOptions, type UpdateContextualEditingStateInternalMessage, type UpdateFeatureFlagsMessage, type UpdatePreviewSettingsMessage, type UpsertEntryOptions, type VisibilityCriteria, type VisibilityCriteriaEvaluationResult, type VisibilityCriteriaGroup, type VisibilityParameterValue, type VisibilityRule, type VisibilityRules, type WalkNodeTreeActions, type WalkNodeTreeOptions, WorkflowClient, type WorkflowDefinition, type WorkflowStage, type WorkflowStagePermission, type WorkflowStageTransition, type WorkflowStageTransitionPermission, type WorkflowsDeleteParameters, type WorkflowsGetParameters, type WorkflowsGetResponse, type WorkflowsPutParameters, bindExpressionEscapeChars, bindExpressionPrefix, bindVariables, bindVariablesToObject, compose, convertEntryToPutEntry, convertToBindExpression, createBatchEnhancer, createCanvasChannel, createDynamicInputVisibilityRule, createDynamicTokenVisibilityRule, createLimitPolicy, createLocaleVisibilityRule, createQuirksVisibilityRule, createUniformApiEnhancer, createVariableReference, enhance, escapeBindExpressionDefaultValue, evaluateNodeVisibilityParameter, evaluatePropertyCriteria, evaluateVisibilityCriteriaGroup, evaluateWalkTreeNodeVisibility, evaluateWalkTreePropertyCriteria, extractLocales, findParameterInNodeTree, flattenValues, generateComponentPlaceholderId, generateHash, getBlockValue, getComponentJsonPointer, getComponentPath, getDataSourceVariantFromRouteGetParams, getEffectivePropertyValue, getLocalizedPropertyValues, getNounForLocation, getNounForNode, getParameterAttributes, getPropertiesValue, hasReferencedVariables, isAddComponentMessage, isAllowedReferrer, isAssetParamValue, isAssetParamValueItem, isComponentActionMessage, isComponentPlaceholderId, isContextStorageUpdatedMessage, isDismissPlaceholderMessage, isEntryData, isLinkParamValue, isMovingComponentMessage, isNestedNodeType, isOpenParameterEditorMessage, isReadyMessage, isReportRenderedCompositionsMessage, isRequestComponentSuggestionMessage, isRootEntryReference, isSelectComponentMessage, isSelectParameterMessage, isSuggestComponentMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateComponentParameterMessage, isUpdateComponentReferencesMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdateFeatureFlagsMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, parseComponentPlaceholderId, parseVariableExpression, version, walkNodeTree, walkPropertyValues };
|
package/dist/index.d.ts
CHANGED
@@ -1813,6 +1813,8 @@ declare const CANVAS_PERSONALIZATION_PARAM = "$pzCrit";
|
|
1813
1813
|
declare const CANVAS_PERSONALIZATION_EVENT_NAME_PARAM = "trackingEventName";
|
1814
1814
|
/** Public ID of the Uniform Context personalization component's algorithm parameter */
|
1815
1815
|
declare const CANVAS_PERSONALIZATION_ALGORITHM_PARAM = "algorithm";
|
1816
|
+
/** Type value for the personalization algorithm parameter */
|
1817
|
+
declare const CANVAS_PERSONALIZATION_ALGORITHM_TYPE = "pzAlgorithm";
|
1816
1818
|
/** Public ID of the Uniform Context personalization component's number of variants to show parameter */
|
1817
1819
|
declare const CANVAS_PERSONALIZATION_TAKE_PARAM = "count";
|
1818
1820
|
/** Public ID of the Uniform Context test variant parameter on Canvas components */
|
@@ -3092,7 +3094,13 @@ interface paths$h {
|
|
3092
3094
|
put: {
|
3093
3095
|
parameters: {
|
3094
3096
|
query?: never;
|
3095
|
-
header?:
|
3097
|
+
header?: {
|
3098
|
+
/** @description Optional concurrency control header. If provided, the server will check that the entry
|
3099
|
+
* has not been modified since this timestamp. If the timestamp doesn't match the current
|
3100
|
+
* modified timestamp, a 409 Conflict response will be returned.
|
3101
|
+
* */
|
3102
|
+
"X-If-Unmodified-Since"?: string;
|
3103
|
+
};
|
3096
3104
|
path?: never;
|
3097
3105
|
cookie?: never;
|
3098
3106
|
};
|
@@ -3166,6 +3174,15 @@ interface paths$h {
|
|
3166
3174
|
400: components$j["responses"]["BadRequestError"];
|
3167
3175
|
401: components$j["responses"]["UnauthorizedError"];
|
3168
3176
|
403: components$j["responses"]["ForbiddenError"];
|
3177
|
+
/** @description Conflict - Entry has been changed since being loaded */
|
3178
|
+
409: {
|
3179
|
+
headers: {
|
3180
|
+
[name: string]: unknown;
|
3181
|
+
};
|
3182
|
+
content: {
|
3183
|
+
"text/plain": string;
|
3184
|
+
};
|
3185
|
+
};
|
3169
3186
|
429: components$j["responses"]["RateLimitError"];
|
3170
3187
|
500: components$j["responses"]["InternalServerError"];
|
3171
3188
|
};
|
@@ -6282,7 +6299,13 @@ interface paths$a {
|
|
6282
6299
|
put: {
|
6283
6300
|
parameters: {
|
6284
6301
|
query?: never;
|
6285
|
-
header?:
|
6302
|
+
header?: {
|
6303
|
+
/** @description Optional concurrency control header. If provided, the server will check that the composition
|
6304
|
+
* has not been modified since this timestamp. If the timestamp doesn't match the current
|
6305
|
+
* modified timestamp, a 409 Conflict response will be returned.
|
6306
|
+
* */
|
6307
|
+
"X-If-Unmodified-Since"?: string;
|
6308
|
+
};
|
6286
6309
|
path?: never;
|
6287
6310
|
cookie?: never;
|
6288
6311
|
};
|
@@ -6372,6 +6395,15 @@ interface paths$a {
|
|
6372
6395
|
400: components$b["responses"]["BadRequestError"];
|
6373
6396
|
401: components$b["responses"]["UnauthorizedError"];
|
6374
6397
|
403: components$b["responses"]["ForbiddenError"];
|
6398
|
+
/** @description Conflict - Composition has been changed since being loaded */
|
6399
|
+
409: {
|
6400
|
+
headers: {
|
6401
|
+
[name: string]: unknown;
|
6402
|
+
};
|
6403
|
+
content: {
|
6404
|
+
"text/plain": string;
|
6405
|
+
};
|
6406
|
+
};
|
6375
6407
|
429: components$b["responses"]["RateLimitError"];
|
6376
6408
|
500: components$b["responses"]["InternalServerError"];
|
6377
6409
|
};
|
@@ -11561,6 +11593,9 @@ type CanvasClientOptions = ClientOptions & {
|
|
11561
11593
|
edgeApiHost?: string;
|
11562
11594
|
disableSWR?: boolean;
|
11563
11595
|
};
|
11596
|
+
type UpdateCompositionOptions = {
|
11597
|
+
ifUnmodifiedSince?: string;
|
11598
|
+
};
|
11564
11599
|
declare class CanvasClient extends ApiClient<CanvasClientOptions> {
|
11565
11600
|
private edgeApiHost;
|
11566
11601
|
private edgeApiRequestInit?;
|
@@ -11602,7 +11637,7 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
|
|
11602
11637
|
}>;
|
11603
11638
|
private getOneComposition;
|
11604
11639
|
/** Updates or creates a Canvas component definition */
|
11605
|
-
updateComposition(body: Omit<CompositionPutParameters, 'projectId'
|
11640
|
+
updateComposition(body: Omit<CompositionPutParameters, 'projectId'>, options?: UpdateCompositionOptions): Promise<{
|
11606
11641
|
modified: string | null;
|
11607
11642
|
}>;
|
11608
11643
|
/** Deletes a Canvas component definition */
|
@@ -11635,6 +11670,9 @@ declare class UncachedCategoryClient extends CategoryClient {
|
|
11635
11670
|
constructor(options: Omit<ClientOptions, 'bypassCache'>);
|
11636
11671
|
}
|
11637
11672
|
|
11673
|
+
type UpsertEntryOptions = {
|
11674
|
+
ifUnmodifiedSince?: string;
|
11675
|
+
};
|
11638
11676
|
type ContentClientOptions = ClientOptions & {
|
11639
11677
|
edgeApiHost?: string;
|
11640
11678
|
disableSWR?: boolean;
|
@@ -11656,7 +11694,7 @@ declare class ContentClient extends ApiClient<ContentClientOptions> {
|
|
11656
11694
|
upsertContentType(body: ExceptProject<PutContentTypeBody>, opts?: {
|
11657
11695
|
autogenerateDataTypes?: boolean;
|
11658
11696
|
}): Promise<void>;
|
11659
|
-
upsertEntry(body: ExceptProject<PutEntryBody
|
11697
|
+
upsertEntry(body: ExceptProject<PutEntryBody>, options?: UpsertEntryOptions): Promise<{
|
11660
11698
|
modified: string | null;
|
11661
11699
|
}>;
|
11662
11700
|
deleteContentType(body: ExceptProject<DeleteContentTypeOptions>): Promise<void>;
|
@@ -12840,7 +12878,7 @@ interface paths {
|
|
12840
12878
|
parameters: {
|
12841
12879
|
query: {
|
12842
12880
|
projectId: string;
|
12843
|
-
type: "component" | "contentType" | "blockType" | "asset" | "componentPattern" | "entryPattern" | "compositionPattern" | "entry";
|
12881
|
+
type: "component" | "contentType" | "blockType" | "asset" | "componentPattern" | "entryPattern" | "compositionPattern" | "entry" | "dataType" | "dataSource" | "test";
|
12844
12882
|
ids: string[];
|
12845
12883
|
withInstances?: boolean | null;
|
12846
12884
|
limit?: number;
|
@@ -13292,7 +13330,7 @@ declare function hasReferencedVariables(value: string | undefined): number;
|
|
13292
13330
|
*/
|
13293
13331
|
declare function parseVariableExpression(serialized: string, onToken?: (token: string, type: 'text' | 'variable') => void | false): number;
|
13294
13332
|
|
13295
|
-
declare const version = "20.
|
13333
|
+
declare const version = "20.30.0";
|
13296
13334
|
|
13297
13335
|
/** API client to enable managing workflow definitions */
|
13298
13336
|
declare class WorkflowClient extends ApiClient {
|
@@ -13309,4 +13347,4 @@ declare class WorkflowClient extends ApiClient {
|
|
13309
13347
|
|
13310
13348
|
declare const CanvasClientError: typeof ApiClientError;
|
13311
13349
|
|
13312
|
-
export { ASSETS_SOURCE_CUSTOM_URL, ASSETS_SOURCE_UNIFORM, ASSET_PARAMETER_TYPE, ATTRIBUTE_COMPONENT_ID, ATTRIBUTE_MULTILINE, ATTRIBUTE_PARAMETER_ID, ATTRIBUTE_PARAMETER_TYPE, ATTRIBUTE_PARAMETER_VALUE, ATTRIBUTE_PLACEHOLDER, type AddComponentMessage, type BatchEnhancer, BatchEntry, type BatchInvalidationPayload, type BindVariablesOptions, type BindVariablesResult, type BindVariablesToObjectOptions, BlockFormatError, type BlockLocationReference, type BlockValue, CANVAS_BLOCK_PARAM_TYPE, CANVAS_CONTEXTUAL_EDITING_PARAM, CANVAS_DRAFT_STATE, CANVAS_EDITOR_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_ALGORITHM_PARAM, CANVAS_PERSONALIZATION_EVENT_NAME_PARAM, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZATION_TAKE_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_SLOT_SECTION_SLOT, CANVAS_SLOT_SECTION_TYPE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CANVAS_VIZ_CONTROL_PARAM, CANVAS_VIZ_DI_RULE, CANVAS_VIZ_DYNAMIC_TOKEN_RULE, CANVAS_VIZ_LOCALE_RULE, CANVAS_VIZ_QUIRKS_RULE, CanvasClient, CanvasClientError, type CanvasDefinitions, type CategoriesDeleteParameters, type CategoriesGetParameters, type CategoriesGetResponse, type CategoriesPutParameters, type Category, CategoryClient, type Channel, type ChannelMessage, ChildEnhancerBuilder, type ComponentDefinition, type ComponentDefinitionDeleteParameters, type ComponentDefinitionGetParameters, type ComponentDefinitionGetResponse, type ComponentDefinitionParameter, type ComponentDefinitionPermission, type ComponentDefinitionPutParameters, type ComponentDefinitionSlot, type ComponentDefinitionSlugSettings, type ComponentDefinitionVariant, type ComponentEnhancer, type ComponentEnhancerFunction, type ComponentEnhancerOptions, type ComponentInstance, type ComponentInstanceContextualEditing, type ComponentInstanceHistoryEntry, type ComponentInstanceHistoryGetParameters, type ComponentInstanceHistoryGetResponse, type ComponentLocationReference, type ComponentOverridability, type ComponentOverride, type ComponentOverrides, type ComponentParameter, type ComponentParameterBlock, type ComponentParameterConditionalValue, type ComponentParameterContextualEditing, type ComponentParameterEnhancer, type ComponentParameterEnhancerFunction, type ComponentParameterEnhancerOptions, type CompositionDeleteParameters, type CompositionFilters, type CompositionGetByComponentIdParameters, type CompositionGetByIdParameters, type CompositionGetByNodeIdParameters, type CompositionGetByNodePathParameters, type CompositionGetBySlugParameters, type CompositionGetListResponse, type CompositionGetParameters, type CompositionGetResponse, type CompositionGetValidResponses, type CompositionPutParameters, type CompositionResolvedGetResponse, type CompositionResolvedListResponse, type CompositionUIStatus, ContentClient, type ContentType, type ContentTypeField, type ContentTypePreviewConfiguration, type ContextStorageUpdatedMessage, type ContextualEditingComponentReference, type ContextualEditingValue, type CopiedComponentSubtree, type DataDiagnostic, type DataElementBindingIssue, type DataElementConnectionDefinition, type DataElementConnectionFailureAction, type DataElementConnectionFailureLogLevel, type DataResolutionConfigIssue, type DataResolutionIssue, type DataResolutionOption, type DataResolutionOptionNegative, type DataResolutionOptionPositive, type DataResolutionParameters, type DataResourceDefinition, type DataResourceDefinitions, type DataResourceIssue, type DataResourceVariables, type DataSource, DataSourceClient, type DataSourceDeleteParameters, type DataSourceGetParameters, type DataSourceGetResponse, type DataSourcePutParameters, type DataSourceVariantData, type DataSourceVariantsKeys, type DataSourcesGetParameters, type DataSourcesGetResponse, type DataType, DataTypeClient, type DataTypeDeleteParameters, type DataTypeGetParameters, type DataTypeGetResponse, type DataTypePutParameters, type DataVariableDefinition, type DataWithProperties, type DeleteContentTypeOptions, type DeleteEntryOptions, type DismissPlaceholderMessage, type DynamicInputIssue, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_MAX_CACHE_TTL, EDGE_MIN_CACHE_TTL, EMPTY_COMPOSITION, type EdgehancersDiagnostics, type EdgehancersWholeResponseCacheDiagnostics, type EditorStateUpdatedMessage, EnhancerBuilder, type EnhancerContext, type EnhancerError, EntityReleasesClient, type EntityReleasesGetParameters, type EntityReleasesGetResponse, type EntriesGetParameters, type EntriesGetResponse, type EntriesHistoryGetParameters, type EntriesHistoryGetResponse, type EntriesResolvedListResponse, type Entry, type EntryData, type EntryFilters, type EntryList, type EvaluateCriteriaGroupOptions, type EvaluateNodeTreeVisibilityOptions, type EvaluateNodeVisibilityParameterOptions, type EvaluatePropertyCriteriaOptions, type EvaluateWalkTreePropertyCriteriaOptions, type Filters, type FindInNodeTreeReference, type FlattenProperty, type FlattenValues, type FlattenValuesOptions, type GetContentTypesOptions, type GetContentTypesResponse, type GetEffectivePropertyValueOptions, type GetEntriesOptions, type GetEntriesResponse, type GetParameterAttributesProps, IN_CONTEXT_EDITOR_COMPONENT_END_ROLE, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_CONFIG_CHECK_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_FORCED_SETTINGS_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, IS_RENDERED_BY_UNIFORM_ATTRIBUTE, type InvalidationPayload, LOCALE_DYNAMIC_INPUT_NAME, type LimitPolicy, type LinkParamConfiguration, type LinkParamValue, type LinkParameterType, type LinkTypeConfiguration, type Locale, LocaleClient, type LocaleDeleteParameters, type LocalePutParameters, type LocalesGetParameters, type LocalesGetResponse, type LocalizeOptions, type MaxDepthExceededIssue, type MessageHandler, type MoveComponentMessage, type MultiSelectParamConfiguration, type MultiSelectParamValue, type NodeLocationReference, type NonProjectMapLinkParamValue, type NumberParamConfig, type NumberParamValue, type OpenParameterEditorMessage, type OverrideOptions, PLACEHOLDER_ID, type PatternIssue, PreviewClient, type PreviewPanelSettings, type PreviewUrl, type PreviewUrlDeleteParameters, type PreviewUrlDeleteResponse, type PreviewUrlPutParameters, type PreviewUrlPutResponse, type PreviewUrlsGetParameters, type PreviewUrlsGetResponse, type PreviewViewport, type PreviewViewportDeleteParameters, type PreviewViewportDeleteResponse, type PreviewViewportPutParameters, type PreviewViewportPutResponse, type PreviewViewportsGetParameters, type PreviewViewportsGetResponse, type Project, ProjectClient, type ProjectDeleteParameters, type ProjectGetParameters, type ProjectGetResponse, type ProjectMapLinkParamValue, type ProjectPutParameters, type ProjectPutResponse, type Prompt, PromptClient, type PromptsDeleteParameters, type PromptsGetParameters, type PromptsGetResponse, type PromptsPutParameters, type PropertyCriteriaMatch, type PropertyValue, type PutContentTypeBody, type PutEntryBody, type ReadyMessage, RelationshipClient, type RelationshipResultInstance, type Release, ReleaseClient, type ReleaseContent, ReleaseContentsClient, type ReleaseContentsDeleteBody, type ReleaseContentsGetParameters, type ReleaseContentsGetResponse, type ReleaseDeleteParameters, type ReleasePatchParameters, type ReleasePutParameters, type ReleaseState, type ReleasesGetParameters, type ReleasesGetResponse, type ReportRenderedCompositionsMessage, type RequestComponentSuggestionMessage, type RequestPageHtmlMessage, type ResolvedRouteGetResponse, type RichTextBuiltInElement, type RichTextBuiltInFormat, type RichTextParamConfiguration, type RichTextParamValue, type RootComponentInstance, type RootEntryReference, type RootLocationReference, RouteClient, type RouteDynamicInputs, type RouteGetParameters, type RouteGetResponse, type RouteGetResponseComposition, type RouteGetResponseEdgehancedComposition, type RouteGetResponseEdgehancedNotFound, type RouteGetResponseNotFound, type RouteGetResponseRedirect, SECRET_QUERY_STRING_PARAM, type SelectComponentMessage, type SelectParamConfiguration, type SelectParamOption, type SelectParamValue, type SelectParameterMessage, type SendPageHtmlMessage, type SpecificProjectMap, type StringOperators, type SuggestComponentMessage, type TreeNodeInfoTypes, type TriggerComponentActionMessage, type TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, UncachedContentClient, UniqueBatchEntries, type UpdateComponentParameterMessage, type UpdateComponentReferencesMessage, type UpdateCompositionInternalMessage, type UpdateCompositionMessage, type UpdateContextualEditingStateInternalMessage, type UpdateFeatureFlagsMessage, type UpdatePreviewSettingsMessage, type VisibilityCriteria, type VisibilityCriteriaEvaluationResult, type VisibilityCriteriaGroup, type VisibilityParameterValue, type VisibilityRule, type VisibilityRules, type WalkNodeTreeActions, type WalkNodeTreeOptions, WorkflowClient, type WorkflowDefinition, type WorkflowStage, type WorkflowStagePermission, type WorkflowStageTransition, type WorkflowStageTransitionPermission, type WorkflowsDeleteParameters, type WorkflowsGetParameters, type WorkflowsGetResponse, type WorkflowsPutParameters, bindExpressionEscapeChars, bindExpressionPrefix, bindVariables, bindVariablesToObject, compose, convertEntryToPutEntry, convertToBindExpression, createBatchEnhancer, createCanvasChannel, createDynamicInputVisibilityRule, createDynamicTokenVisibilityRule, createLimitPolicy, createLocaleVisibilityRule, createQuirksVisibilityRule, createUniformApiEnhancer, createVariableReference, enhance, escapeBindExpressionDefaultValue, evaluateNodeVisibilityParameter, evaluatePropertyCriteria, evaluateVisibilityCriteriaGroup, evaluateWalkTreeNodeVisibility, evaluateWalkTreePropertyCriteria, extractLocales, findParameterInNodeTree, flattenValues, generateComponentPlaceholderId, generateHash, getBlockValue, getComponentJsonPointer, getComponentPath, getDataSourceVariantFromRouteGetParams, getEffectivePropertyValue, getLocalizedPropertyValues, getNounForLocation, getNounForNode, getParameterAttributes, getPropertiesValue, hasReferencedVariables, isAddComponentMessage, isAllowedReferrer, isAssetParamValue, isAssetParamValueItem, isComponentActionMessage, isComponentPlaceholderId, isContextStorageUpdatedMessage, isDismissPlaceholderMessage, isEntryData, isLinkParamValue, isMovingComponentMessage, isNestedNodeType, isOpenParameterEditorMessage, isReadyMessage, isReportRenderedCompositionsMessage, isRequestComponentSuggestionMessage, isRootEntryReference, isSelectComponentMessage, isSelectParameterMessage, isSuggestComponentMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateComponentParameterMessage, isUpdateComponentReferencesMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdateFeatureFlagsMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, parseComponentPlaceholderId, parseVariableExpression, version, walkNodeTree, walkPropertyValues };
|
13350
|
+
export { ASSETS_SOURCE_CUSTOM_URL, ASSETS_SOURCE_UNIFORM, ASSET_PARAMETER_TYPE, ATTRIBUTE_COMPONENT_ID, ATTRIBUTE_MULTILINE, ATTRIBUTE_PARAMETER_ID, ATTRIBUTE_PARAMETER_TYPE, ATTRIBUTE_PARAMETER_VALUE, ATTRIBUTE_PLACEHOLDER, type AddComponentMessage, type BatchEnhancer, BatchEntry, type BatchInvalidationPayload, type BindVariablesOptions, type BindVariablesResult, type BindVariablesToObjectOptions, BlockFormatError, type BlockLocationReference, type BlockValue, CANVAS_BLOCK_PARAM_TYPE, CANVAS_CONTEXTUAL_EDITING_PARAM, CANVAS_DRAFT_STATE, CANVAS_EDITOR_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_ALGORITHM_PARAM, CANVAS_PERSONALIZATION_ALGORITHM_TYPE, CANVAS_PERSONALIZATION_EVENT_NAME_PARAM, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZATION_TAKE_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_SLOT_SECTION_SLOT, CANVAS_SLOT_SECTION_TYPE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CANVAS_VIZ_CONTROL_PARAM, CANVAS_VIZ_DI_RULE, CANVAS_VIZ_DYNAMIC_TOKEN_RULE, CANVAS_VIZ_LOCALE_RULE, CANVAS_VIZ_QUIRKS_RULE, CanvasClient, CanvasClientError, type CanvasDefinitions, type CategoriesDeleteParameters, type CategoriesGetParameters, type CategoriesGetResponse, type CategoriesPutParameters, type Category, CategoryClient, type Channel, type ChannelMessage, ChildEnhancerBuilder, type ComponentDefinition, type ComponentDefinitionDeleteParameters, type ComponentDefinitionGetParameters, type ComponentDefinitionGetResponse, type ComponentDefinitionParameter, type ComponentDefinitionPermission, type ComponentDefinitionPutParameters, type ComponentDefinitionSlot, type ComponentDefinitionSlugSettings, type ComponentDefinitionVariant, type ComponentEnhancer, type ComponentEnhancerFunction, type ComponentEnhancerOptions, type ComponentInstance, type ComponentInstanceContextualEditing, type ComponentInstanceHistoryEntry, type ComponentInstanceHistoryGetParameters, type ComponentInstanceHistoryGetResponse, type ComponentLocationReference, type ComponentOverridability, type ComponentOverride, type ComponentOverrides, type ComponentParameter, type ComponentParameterBlock, type ComponentParameterConditionalValue, type ComponentParameterContextualEditing, type ComponentParameterEnhancer, type ComponentParameterEnhancerFunction, type ComponentParameterEnhancerOptions, type CompositionDeleteParameters, type CompositionFilters, type CompositionGetByComponentIdParameters, type CompositionGetByIdParameters, type CompositionGetByNodeIdParameters, type CompositionGetByNodePathParameters, type CompositionGetBySlugParameters, type CompositionGetListResponse, type CompositionGetParameters, type CompositionGetResponse, type CompositionGetValidResponses, type CompositionPutParameters, type CompositionResolvedGetResponse, type CompositionResolvedListResponse, type CompositionUIStatus, ContentClient, type ContentType, type ContentTypeField, type ContentTypePreviewConfiguration, type ContextStorageUpdatedMessage, type ContextualEditingComponentReference, type ContextualEditingValue, type CopiedComponentSubtree, type DataDiagnostic, type DataElementBindingIssue, type DataElementConnectionDefinition, type DataElementConnectionFailureAction, type DataElementConnectionFailureLogLevel, type DataResolutionConfigIssue, type DataResolutionIssue, type DataResolutionOption, type DataResolutionOptionNegative, type DataResolutionOptionPositive, type DataResolutionParameters, type DataResourceDefinition, type DataResourceDefinitions, type DataResourceIssue, type DataResourceVariables, type DataSource, DataSourceClient, type DataSourceDeleteParameters, type DataSourceGetParameters, type DataSourceGetResponse, type DataSourcePutParameters, type DataSourceVariantData, type DataSourceVariantsKeys, type DataSourcesGetParameters, type DataSourcesGetResponse, type DataType, DataTypeClient, type DataTypeDeleteParameters, type DataTypeGetParameters, type DataTypeGetResponse, type DataTypePutParameters, type DataVariableDefinition, type DataWithProperties, type DeleteContentTypeOptions, type DeleteEntryOptions, type DismissPlaceholderMessage, type DynamicInputIssue, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_MAX_CACHE_TTL, EDGE_MIN_CACHE_TTL, EMPTY_COMPOSITION, type EdgehancersDiagnostics, type EdgehancersWholeResponseCacheDiagnostics, type EditorStateUpdatedMessage, EnhancerBuilder, type EnhancerContext, type EnhancerError, EntityReleasesClient, type EntityReleasesGetParameters, type EntityReleasesGetResponse, type EntriesGetParameters, type EntriesGetResponse, type EntriesHistoryGetParameters, type EntriesHistoryGetResponse, type EntriesResolvedListResponse, type Entry, type EntryData, type EntryFilters, type EntryList, type EvaluateCriteriaGroupOptions, type EvaluateNodeTreeVisibilityOptions, type EvaluateNodeVisibilityParameterOptions, type EvaluatePropertyCriteriaOptions, type EvaluateWalkTreePropertyCriteriaOptions, type Filters, type FindInNodeTreeReference, type FlattenProperty, type FlattenValues, type FlattenValuesOptions, type GetContentTypesOptions, type GetContentTypesResponse, type GetEffectivePropertyValueOptions, type GetEntriesOptions, type GetEntriesResponse, type GetParameterAttributesProps, IN_CONTEXT_EDITOR_COMPONENT_END_ROLE, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_CONFIG_CHECK_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_FORCED_SETTINGS_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, IS_RENDERED_BY_UNIFORM_ATTRIBUTE, type InvalidationPayload, LOCALE_DYNAMIC_INPUT_NAME, type LimitPolicy, type LinkParamConfiguration, type LinkParamValue, type LinkParameterType, type LinkTypeConfiguration, type Locale, LocaleClient, type LocaleDeleteParameters, type LocalePutParameters, type LocalesGetParameters, type LocalesGetResponse, type LocalizeOptions, type MaxDepthExceededIssue, type MessageHandler, type MoveComponentMessage, type MultiSelectParamConfiguration, type MultiSelectParamValue, type NodeLocationReference, type NonProjectMapLinkParamValue, type NumberParamConfig, type NumberParamValue, type OpenParameterEditorMessage, type OverrideOptions, PLACEHOLDER_ID, type PatternIssue, PreviewClient, type PreviewPanelSettings, type PreviewUrl, type PreviewUrlDeleteParameters, type PreviewUrlDeleteResponse, type PreviewUrlPutParameters, type PreviewUrlPutResponse, type PreviewUrlsGetParameters, type PreviewUrlsGetResponse, type PreviewViewport, type PreviewViewportDeleteParameters, type PreviewViewportDeleteResponse, type PreviewViewportPutParameters, type PreviewViewportPutResponse, type PreviewViewportsGetParameters, type PreviewViewportsGetResponse, type Project, ProjectClient, type ProjectDeleteParameters, type ProjectGetParameters, type ProjectGetResponse, type ProjectMapLinkParamValue, type ProjectPutParameters, type ProjectPutResponse, type Prompt, PromptClient, type PromptsDeleteParameters, type PromptsGetParameters, type PromptsGetResponse, type PromptsPutParameters, type PropertyCriteriaMatch, type PropertyValue, type PutContentTypeBody, type PutEntryBody, type ReadyMessage, RelationshipClient, type RelationshipResultInstance, type Release, ReleaseClient, type ReleaseContent, ReleaseContentsClient, type ReleaseContentsDeleteBody, type ReleaseContentsGetParameters, type ReleaseContentsGetResponse, type ReleaseDeleteParameters, type ReleasePatchParameters, type ReleasePutParameters, type ReleaseState, type ReleasesGetParameters, type ReleasesGetResponse, type ReportRenderedCompositionsMessage, type RequestComponentSuggestionMessage, type RequestPageHtmlMessage, type ResolvedRouteGetResponse, type RichTextBuiltInElement, type RichTextBuiltInFormat, type RichTextParamConfiguration, type RichTextParamValue, type RootComponentInstance, type RootEntryReference, type RootLocationReference, RouteClient, type RouteDynamicInputs, type RouteGetParameters, type RouteGetResponse, type RouteGetResponseComposition, type RouteGetResponseEdgehancedComposition, type RouteGetResponseEdgehancedNotFound, type RouteGetResponseNotFound, type RouteGetResponseRedirect, SECRET_QUERY_STRING_PARAM, type SelectComponentMessage, type SelectParamConfiguration, type SelectParamOption, type SelectParamValue, type SelectParameterMessage, type SendPageHtmlMessage, type SpecificProjectMap, type StringOperators, type SuggestComponentMessage, type TreeNodeInfoTypes, type TriggerComponentActionMessage, type TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, UncachedContentClient, UniqueBatchEntries, type UpdateComponentParameterMessage, type UpdateComponentReferencesMessage, type UpdateCompositionInternalMessage, type UpdateCompositionMessage, type UpdateCompositionOptions, type UpdateContextualEditingStateInternalMessage, type UpdateFeatureFlagsMessage, type UpdatePreviewSettingsMessage, type UpsertEntryOptions, type VisibilityCriteria, type VisibilityCriteriaEvaluationResult, type VisibilityCriteriaGroup, type VisibilityParameterValue, type VisibilityRule, type VisibilityRules, type WalkNodeTreeActions, type WalkNodeTreeOptions, WorkflowClient, type WorkflowDefinition, type WorkflowStage, type WorkflowStagePermission, type WorkflowStageTransition, type WorkflowStageTransitionPermission, type WorkflowsDeleteParameters, type WorkflowsGetParameters, type WorkflowsGetResponse, type WorkflowsPutParameters, bindExpressionEscapeChars, bindExpressionPrefix, bindVariables, bindVariablesToObject, compose, convertEntryToPutEntry, convertToBindExpression, createBatchEnhancer, createCanvasChannel, createDynamicInputVisibilityRule, createDynamicTokenVisibilityRule, createLimitPolicy, createLocaleVisibilityRule, createQuirksVisibilityRule, createUniformApiEnhancer, createVariableReference, enhance, escapeBindExpressionDefaultValue, evaluateNodeVisibilityParameter, evaluatePropertyCriteria, evaluateVisibilityCriteriaGroup, evaluateWalkTreeNodeVisibility, evaluateWalkTreePropertyCriteria, extractLocales, findParameterInNodeTree, flattenValues, generateComponentPlaceholderId, generateHash, getBlockValue, getComponentJsonPointer, getComponentPath, getDataSourceVariantFromRouteGetParams, getEffectivePropertyValue, getLocalizedPropertyValues, getNounForLocation, getNounForNode, getParameterAttributes, getPropertiesValue, hasReferencedVariables, isAddComponentMessage, isAllowedReferrer, isAssetParamValue, isAssetParamValueItem, isComponentActionMessage, isComponentPlaceholderId, isContextStorageUpdatedMessage, isDismissPlaceholderMessage, isEntryData, isLinkParamValue, isMovingComponentMessage, isNestedNodeType, isOpenParameterEditorMessage, isReadyMessage, isReportRenderedCompositionsMessage, isRequestComponentSuggestionMessage, isRootEntryReference, isSelectComponentMessage, isSelectParameterMessage, isSuggestComponentMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateComponentParameterMessage, isUpdateComponentReferencesMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdateFeatureFlagsMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, parseComponentPlaceholderId, parseVariableExpression, version, walkNodeTree, walkPropertyValues };
|
package/dist/index.esm.js
CHANGED
@@ -671,12 +671,17 @@ var CanvasClient = class extends ApiClient {
|
|
671
671
|
return this.apiClient(edgeUrl, this.edgeApiRequestInit);
|
672
672
|
}
|
673
673
|
/** Updates or creates a Canvas component definition */
|
674
|
-
async updateComposition(body) {
|
674
|
+
async updateComposition(body, options) {
|
675
675
|
const fetchUri = this.createUrl(CANVAS_URL);
|
676
|
+
const headers = {};
|
677
|
+
if (options == null ? void 0 : options.ifUnmodifiedSince) {
|
678
|
+
headers["x-if-unmodified-since"] = options.ifUnmodifiedSince;
|
679
|
+
}
|
676
680
|
const { response } = await this.apiClientWithResponse(fetchUri, {
|
677
681
|
method: "PUT",
|
678
682
|
body: JSON.stringify({ ...body, projectId: this.options.projectId }),
|
679
|
-
expectNoContent: true
|
683
|
+
expectNoContent: true,
|
684
|
+
headers
|
680
685
|
});
|
681
686
|
return { modified: response.headers.get("x-modified-at") };
|
682
687
|
}
|
@@ -816,12 +821,17 @@ var _ContentClient = class _ContentClient extends ApiClient3 {
|
|
816
821
|
headers: opts.autogenerateDataTypes ? { "x-uniform-autogenerate-data-types": "true" } : {}
|
817
822
|
});
|
818
823
|
}
|
819
|
-
async upsertEntry(body) {
|
824
|
+
async upsertEntry(body, options) {
|
820
825
|
const fetchUri = this.createUrl(__privateGet(_ContentClient, _entriesUrl));
|
826
|
+
const headers = {};
|
827
|
+
if (options == null ? void 0 : options.ifUnmodifiedSince) {
|
828
|
+
headers["x-if-unmodified-since"] = options.ifUnmodifiedSince;
|
829
|
+
}
|
821
830
|
const { response } = await this.apiClientWithResponse(fetchUri, {
|
822
831
|
method: "PUT",
|
823
832
|
body: JSON.stringify({ ...body, projectId: this.options.projectId }),
|
824
|
-
expectNoContent: true
|
833
|
+
expectNoContent: true,
|
834
|
+
headers
|
825
835
|
});
|
826
836
|
return { modified: response.headers.get("x-modified-at") };
|
827
837
|
}
|
@@ -1077,6 +1087,7 @@ var CANVAS_EDITOR_STATE = 63;
|
|
1077
1087
|
var CANVAS_PERSONALIZATION_PARAM = "$pzCrit";
|
1078
1088
|
var CANVAS_PERSONALIZATION_EVENT_NAME_PARAM = "trackingEventName";
|
1079
1089
|
var CANVAS_PERSONALIZATION_ALGORITHM_PARAM = "algorithm";
|
1090
|
+
var CANVAS_PERSONALIZATION_ALGORITHM_TYPE = "pzAlgorithm";
|
1080
1091
|
var CANVAS_PERSONALIZATION_TAKE_PARAM = "count";
|
1081
1092
|
var CANVAS_TEST_VARIANT_PARAM = "$tstVrnt";
|
1082
1093
|
var CANVAS_ENRICHMENT_TAG_PARAM = "$enr";
|
@@ -3406,7 +3417,7 @@ function handleRichTextNodeBinding(object, options) {
|
|
3406
3417
|
import { ApiClientError as ApiClientError2 } from "@uniformdev/context/api";
|
3407
3418
|
|
3408
3419
|
// src/.version.ts
|
3409
|
-
var version = "20.
|
3420
|
+
var version = "20.30.0";
|
3410
3421
|
|
3411
3422
|
// src/WorkflowClient.ts
|
3412
3423
|
import { ApiClient as ApiClient15 } from "@uniformdev/context/api";
|
@@ -3466,6 +3477,7 @@ export {
|
|
3466
3477
|
CANVAS_LOCALIZATION_SLOT,
|
3467
3478
|
CANVAS_LOCALIZATION_TYPE,
|
3468
3479
|
CANVAS_PERSONALIZATION_ALGORITHM_PARAM,
|
3480
|
+
CANVAS_PERSONALIZATION_ALGORITHM_TYPE,
|
3469
3481
|
CANVAS_PERSONALIZATION_EVENT_NAME_PARAM,
|
3470
3482
|
CANVAS_PERSONALIZATION_PARAM,
|
3471
3483
|
CANVAS_PERSONALIZATION_TAKE_PARAM,
|
package/dist/index.js
CHANGED
@@ -410,6 +410,7 @@ __export(src_exports, {
|
|
410
410
|
CANVAS_LOCALIZATION_SLOT: () => CANVAS_LOCALIZATION_SLOT,
|
411
411
|
CANVAS_LOCALIZATION_TYPE: () => CANVAS_LOCALIZATION_TYPE,
|
412
412
|
CANVAS_PERSONALIZATION_ALGORITHM_PARAM: () => CANVAS_PERSONALIZATION_ALGORITHM_PARAM,
|
413
|
+
CANVAS_PERSONALIZATION_ALGORITHM_TYPE: () => CANVAS_PERSONALIZATION_ALGORITHM_TYPE,
|
413
414
|
CANVAS_PERSONALIZATION_EVENT_NAME_PARAM: () => CANVAS_PERSONALIZATION_EVENT_NAME_PARAM,
|
414
415
|
CANVAS_PERSONALIZATION_PARAM: () => CANVAS_PERSONALIZATION_PARAM,
|
415
416
|
CANVAS_PERSONALIZATION_TAKE_PARAM: () => CANVAS_PERSONALIZATION_TAKE_PARAM,
|
@@ -836,12 +837,17 @@ var CanvasClient = class extends import_api2.ApiClient {
|
|
836
837
|
return this.apiClient(edgeUrl, this.edgeApiRequestInit);
|
837
838
|
}
|
838
839
|
/** Updates or creates a Canvas component definition */
|
839
|
-
async updateComposition(body) {
|
840
|
+
async updateComposition(body, options) {
|
840
841
|
const fetchUri = this.createUrl(CANVAS_URL);
|
842
|
+
const headers = {};
|
843
|
+
if (options == null ? void 0 : options.ifUnmodifiedSince) {
|
844
|
+
headers["x-if-unmodified-since"] = options.ifUnmodifiedSince;
|
845
|
+
}
|
841
846
|
const { response } = await this.apiClientWithResponse(fetchUri, {
|
842
847
|
method: "PUT",
|
843
848
|
body: JSON.stringify({ ...body, projectId: this.options.projectId }),
|
844
|
-
expectNoContent: true
|
849
|
+
expectNoContent: true,
|
850
|
+
headers
|
845
851
|
});
|
846
852
|
return { modified: response.headers.get("x-modified-at") };
|
847
853
|
}
|
@@ -981,12 +987,17 @@ var _ContentClient = class _ContentClient extends import_api4.ApiClient {
|
|
981
987
|
headers: opts.autogenerateDataTypes ? { "x-uniform-autogenerate-data-types": "true" } : {}
|
982
988
|
});
|
983
989
|
}
|
984
|
-
async upsertEntry(body) {
|
990
|
+
async upsertEntry(body, options) {
|
985
991
|
const fetchUri = this.createUrl(__privateGet(_ContentClient, _entriesUrl));
|
992
|
+
const headers = {};
|
993
|
+
if (options == null ? void 0 : options.ifUnmodifiedSince) {
|
994
|
+
headers["x-if-unmodified-since"] = options.ifUnmodifiedSince;
|
995
|
+
}
|
986
996
|
const { response } = await this.apiClientWithResponse(fetchUri, {
|
987
997
|
method: "PUT",
|
988
998
|
body: JSON.stringify({ ...body, projectId: this.options.projectId }),
|
989
|
-
expectNoContent: true
|
999
|
+
expectNoContent: true,
|
1000
|
+
headers
|
990
1001
|
});
|
991
1002
|
return { modified: response.headers.get("x-modified-at") };
|
992
1003
|
}
|
@@ -1242,6 +1253,7 @@ var CANVAS_EDITOR_STATE = 63;
|
|
1242
1253
|
var CANVAS_PERSONALIZATION_PARAM = "$pzCrit";
|
1243
1254
|
var CANVAS_PERSONALIZATION_EVENT_NAME_PARAM = "trackingEventName";
|
1244
1255
|
var CANVAS_PERSONALIZATION_ALGORITHM_PARAM = "algorithm";
|
1256
|
+
var CANVAS_PERSONALIZATION_ALGORITHM_TYPE = "pzAlgorithm";
|
1245
1257
|
var CANVAS_PERSONALIZATION_TAKE_PARAM = "count";
|
1246
1258
|
var CANVAS_TEST_VARIANT_PARAM = "$tstVrnt";
|
1247
1259
|
var CANVAS_ENRICHMENT_TAG_PARAM = "$enr";
|
@@ -3571,7 +3583,7 @@ function handleRichTextNodeBinding(object, options) {
|
|
3571
3583
|
var import_api17 = require("@uniformdev/context/api");
|
3572
3584
|
|
3573
3585
|
// src/.version.ts
|
3574
|
-
var version = "20.
|
3586
|
+
var version = "20.30.0";
|
3575
3587
|
|
3576
3588
|
// src/WorkflowClient.ts
|
3577
3589
|
var import_api16 = require("@uniformdev/context/api");
|
@@ -3632,6 +3644,7 @@ var CanvasClientError = import_api17.ApiClientError;
|
|
3632
3644
|
CANVAS_LOCALIZATION_SLOT,
|
3633
3645
|
CANVAS_LOCALIZATION_TYPE,
|
3634
3646
|
CANVAS_PERSONALIZATION_ALGORITHM_PARAM,
|
3647
|
+
CANVAS_PERSONALIZATION_ALGORITHM_TYPE,
|
3635
3648
|
CANVAS_PERSONALIZATION_EVENT_NAME_PARAM,
|
3636
3649
|
CANVAS_PERSONALIZATION_PARAM,
|
3637
3650
|
CANVAS_PERSONALIZATION_TAKE_PARAM,
|
package/dist/index.mjs
CHANGED
@@ -671,12 +671,17 @@ var CanvasClient = class extends ApiClient {
|
|
671
671
|
return this.apiClient(edgeUrl, this.edgeApiRequestInit);
|
672
672
|
}
|
673
673
|
/** Updates or creates a Canvas component definition */
|
674
|
-
async updateComposition(body) {
|
674
|
+
async updateComposition(body, options) {
|
675
675
|
const fetchUri = this.createUrl(CANVAS_URL);
|
676
|
+
const headers = {};
|
677
|
+
if (options == null ? void 0 : options.ifUnmodifiedSince) {
|
678
|
+
headers["x-if-unmodified-since"] = options.ifUnmodifiedSince;
|
679
|
+
}
|
676
680
|
const { response } = await this.apiClientWithResponse(fetchUri, {
|
677
681
|
method: "PUT",
|
678
682
|
body: JSON.stringify({ ...body, projectId: this.options.projectId }),
|
679
|
-
expectNoContent: true
|
683
|
+
expectNoContent: true,
|
684
|
+
headers
|
680
685
|
});
|
681
686
|
return { modified: response.headers.get("x-modified-at") };
|
682
687
|
}
|
@@ -816,12 +821,17 @@ var _ContentClient = class _ContentClient extends ApiClient3 {
|
|
816
821
|
headers: opts.autogenerateDataTypes ? { "x-uniform-autogenerate-data-types": "true" } : {}
|
817
822
|
});
|
818
823
|
}
|
819
|
-
async upsertEntry(body) {
|
824
|
+
async upsertEntry(body, options) {
|
820
825
|
const fetchUri = this.createUrl(__privateGet(_ContentClient, _entriesUrl));
|
826
|
+
const headers = {};
|
827
|
+
if (options == null ? void 0 : options.ifUnmodifiedSince) {
|
828
|
+
headers["x-if-unmodified-since"] = options.ifUnmodifiedSince;
|
829
|
+
}
|
821
830
|
const { response } = await this.apiClientWithResponse(fetchUri, {
|
822
831
|
method: "PUT",
|
823
832
|
body: JSON.stringify({ ...body, projectId: this.options.projectId }),
|
824
|
-
expectNoContent: true
|
833
|
+
expectNoContent: true,
|
834
|
+
headers
|
825
835
|
});
|
826
836
|
return { modified: response.headers.get("x-modified-at") };
|
827
837
|
}
|
@@ -1077,6 +1087,7 @@ var CANVAS_EDITOR_STATE = 63;
|
|
1077
1087
|
var CANVAS_PERSONALIZATION_PARAM = "$pzCrit";
|
1078
1088
|
var CANVAS_PERSONALIZATION_EVENT_NAME_PARAM = "trackingEventName";
|
1079
1089
|
var CANVAS_PERSONALIZATION_ALGORITHM_PARAM = "algorithm";
|
1090
|
+
var CANVAS_PERSONALIZATION_ALGORITHM_TYPE = "pzAlgorithm";
|
1080
1091
|
var CANVAS_PERSONALIZATION_TAKE_PARAM = "count";
|
1081
1092
|
var CANVAS_TEST_VARIANT_PARAM = "$tstVrnt";
|
1082
1093
|
var CANVAS_ENRICHMENT_TAG_PARAM = "$enr";
|
@@ -3406,7 +3417,7 @@ function handleRichTextNodeBinding(object, options) {
|
|
3406
3417
|
import { ApiClientError as ApiClientError2 } from "@uniformdev/context/api";
|
3407
3418
|
|
3408
3419
|
// src/.version.ts
|
3409
|
-
var version = "20.
|
3420
|
+
var version = "20.30.0";
|
3410
3421
|
|
3411
3422
|
// src/WorkflowClient.ts
|
3412
3423
|
import { ApiClient as ApiClient15 } from "@uniformdev/context/api";
|
@@ -3466,6 +3477,7 @@ export {
|
|
3466
3477
|
CANVAS_LOCALIZATION_SLOT,
|
3467
3478
|
CANVAS_LOCALIZATION_TYPE,
|
3468
3479
|
CANVAS_PERSONALIZATION_ALGORITHM_PARAM,
|
3480
|
+
CANVAS_PERSONALIZATION_ALGORITHM_TYPE,
|
3469
3481
|
CANVAS_PERSONALIZATION_EVENT_NAME_PARAM,
|
3470
3482
|
CANVAS_PERSONALIZATION_PARAM,
|
3471
3483
|
CANVAS_PERSONALIZATION_TAKE_PARAM,
|
package/package.json
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
{
|
2
2
|
"name": "@uniformdev/canvas",
|
3
|
-
"version": "20.
|
3
|
+
"version": "20.30.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",
|
@@ -40,9 +40,9 @@
|
|
40
40
|
"p-throttle": "5.0.0"
|
41
41
|
},
|
42
42
|
"dependencies": {
|
43
|
-
"@uniformdev/assets": "20.
|
44
|
-
"@uniformdev/context": "20.
|
45
|
-
"@uniformdev/richtext": "20.
|
43
|
+
"@uniformdev/assets": "20.30.0",
|
44
|
+
"@uniformdev/context": "20.30.0",
|
45
|
+
"@uniformdev/richtext": "20.30.0",
|
46
46
|
"immer": "10.1.1"
|
47
47
|
},
|
48
48
|
"files": [
|
@@ -51,5 +51,5 @@
|
|
51
51
|
"publishConfig": {
|
52
52
|
"access": "public"
|
53
53
|
},
|
54
|
-
"gitHead": "
|
54
|
+
"gitHead": "933c8162daf230a896cc8962f63fbb35efd03653"
|
55
55
|
}
|