@uniformdev/canvas 20.7.1-alpha.4 → 20.7.1-alpha.42

package/dist/index.d.mts

@@ -1,7 +1,8 @@
 import { ApiClient, ExceptProject, ClientOptions, ApiClientError } from '@uniformdev/context/api';
 export { ApiClientError } from '@uniformdev/context/api';
-import { AssetGetResponseSingle, AssetDefinitionType } from '@uniformdev/assets';
-import { Quirks, StorageCommands, PersonalizedVariant, TestVariant } from '@uniformdev/context';
+import { AssetGetResponseSingle, AssetDefinitionType, AssetParamValue, AssetParamValueItem } from '@uniformdev/assets';
+export { AssetParamValue, AssetParamValueItem } from '@uniformdev/assets';
+import { Quirks, StorageCommands, PersonalizedVariant, VariationMatchMetadata, TestVariant } from '@uniformdev/context';
 import { Options as Options$1 } from 'p-retry';
 import { Options } from 'p-throttle';
 import { RichTextBuiltInFormat as RichTextBuiltInFormat$1, RichTextBuiltInElement as RichTextBuiltInElement$1, ParameterRichTextValue } from '@uniformdev/richtext';
@@ -552,7 +553,7 @@ interface components$n {
             categoryId?: string | null;
             /** @description Description of the component definition */
             description?: string;
-            /** @description Description of the component definition */
+            /** @description Preview image URL for the component definition (shown in the UI) */
             previewImageUrl?: string;
             /**
              * @description if this component uses team permissions or custom permissions
@@ -777,7 +778,7 @@ interface components$m {
             categoryId?: string | null;
             /** @description Description of the component definition */
             description?: string;
-            /** @description Description of the component definition */
+            /** @description Preview image URL for the component definition (shown in the UI) */
             previewImageUrl?: string;
             /**
              * @description if this component uses team permissions or custom permissions
@@ -850,6 +851,27 @@ interface components$m {
              * @description ID of the workflow that instances of this content type will use by default. When not set, no workflow is attached
              */
             workflowId?: string;
+            /** @description Configurations for previewing an entry on a consuming pattern or composition. */
+            previewConfigurations?: components$m["schemas"]["ContentTypePreviewConfiguration"][];
+        };
+        /** @description Defines a configuration for previewing an entry on a consuming pattern or composition. */
+        ContentTypePreviewConfiguration: {
+            /**
+             * @description The type of preview configuration
+             * @enum {string}
+             */
+            type: "pattern" | "project-map";
+            /** @description Display label for the preview configuration */
+            label: string;
+            /**
+             * Format: uuid
+             * @description Target preview entity ID (project map node ID or pattern ID)
+             */
+            id: string;
+            /** @description Optional mapping of dynamic input names to their values */
+            dynamicInputs?: {
+                [key: string]: string;
+            };
         };
         /** @description Defines an editable parameter on a component */
         ComponentParameter: {
@@ -1781,8 +1803,14 @@ declare const CANVAS_DRAFT_STATE = 0;
 declare const CANVAS_PUBLISHED_STATE = 64;
 /** Constant for editor composition state. */
 declare const CANVAS_EDITOR_STATE = 63;
-/** Public ID of the Uniform Context personalization parameter on Canvas components */
+/** Public ID of the Uniform Context personalization criteria parameter on Canvas components */
 declare const CANVAS_PERSONALIZATION_PARAM = "$pzCrit";
+/** Public ID of the Uniform Context personalization component's event name parameter */
+declare const CANVAS_PERSONALIZATION_EVENT_NAME_PARAM = "trackingEventName";
+/** Public ID of the Uniform Context personalization component's algorithm parameter */
+declare const CANVAS_PERSONALIZATION_ALGORITHM_PARAM = "algorithm";
+/** Public ID of the Uniform Context personalization component's number of variants to show parameter */
+declare const CANVAS_PERSONALIZATION_TAKE_PARAM = "count";
 /** Public ID of the Uniform Context test variant parameter on Canvas components */
 declare const CANVAS_TEST_VARIANT_PARAM = "$tstVrnt";
 /** Public ID of the Uniform Context enrichment tag parameter on Canvas components */
@@ -2763,6 +2791,25 @@ interface components$j {
             /** @description State of the component that this permission applies to */
             state: number;
         };
+        /** @description Defines a configuration for previewing an entry on a consuming pattern or composition. */
+        ContentTypePreviewConfiguration: {
+            /**
+             * @description The type of preview configuration
+             * @enum {string}
+             */
+            type: "pattern" | "project-map";
+            /** @description Display label for the preview configuration */
+            label: string;
+            /**
+             * Format: uuid
+             * @description Target preview entity ID (project map node ID or pattern ID)
+             */
+            id: string;
+            /** @description Optional mapping of dynamic input names to their values */
+            dynamicInputs?: {
+                [key: string]: string;
+            };
+        };
         /** @description Defines a content type */
         ContentType: {
             id: components$j["schemas"]["PublicIdProperty"];
@@ -2810,6 +2857,8 @@ interface components$j {
              * @description ID of the workflow that instances of this content type will use by default. When not set, no workflow is attached
              */
             workflowId?: string;
+            /** @description Configurations for previewing an entry on a consuming pattern or composition. */
+            previewConfigurations?: components$j["schemas"]["ContentTypePreviewConfiguration"][];
         };
         Error: {
             /** @description Error message(s) that occurred while processing the request */
@@ -4100,6 +4149,7 @@ interface components$h {
 
 type HistoryApi$1 = paths$f['/api/v1/entries-history'];
 type ContentType = components$m['schemas']['ContentType'];
+type ContentTypePreviewConfiguration = components$m['schemas']['ContentTypePreviewConfiguration'];
 type ContentTypeField = Exclude<ContentType['fields'], undefined>[number];
 type GetContentTypesOptions = paths$h['/api/v1/content-types']['get']['parameters']['query'];
 type DeleteContentTypeOptions = paths$h['/api/v1/content-types']['delete']['requestBody']['content']['application/json'];
@@ -7457,6 +7507,8 @@ interface components$8 {
                 retryCount: number;
                 retryDelay: number;
                 sourceCache?: string;
+                /** @description Array of status codes for corresponding retries; will be empty for cache hits, Uniform Content data resources and static JSON data resources */
+                statusCodes: number[];
             };
             data: unknown;
         };
@@ -7491,6 +7543,7 @@ interface components$8 {
             };
         };
         DataResolutionIssue: {
+            componentId?: string;
             componentPath?: string;
             componentType?: string;
             message: string;
@@ -8369,8 +8422,8 @@ interface components$8 {
         };
     };
     parameters: {
-        /** @description Enables additional diagnostics that will be attached to the response */
-        diagnostics: boolean;
+        /** @description Enables additional diagnostics that will be attached to the response; set to "no-data" to skip data resource values while keeping metrics */
+        diagnostics: "true" | "false" | "no-data";
         /** @description Controls how many levels deep content references should be resolved */
         resolutionDepth: number;
         /** @description Max number of records to return */
@@ -9682,9 +9735,10 @@ type DataResolutionOptionPositive = {
 type DataResolutionParameters = {
     /**
      * Adds additional diagnostics about edge request processing to the response (`diagnostics`).
-     * Because this adds a lot of data to the response, we do not recommend using this unless diagnosing performance issues.
+     * Only use when diagnosing performance issues, don't use for serving production traffic.
+     * Setting to `true` will include all resolved data which may be big. Use `"no-data"` to skip data.
      */
-    diagnostics?: boolean;
+    diagnostics?: boolean | 'no-data';
     /**
      * Controls how many levels deep content references should be resolved.
      */
@@ -10006,81 +10060,6 @@ type schemas = components$8['schemas'];
 type InvalidationPayload = schemas['InvalidationPayload'];
 type BatchInvalidationPayload = schemas['BatchInvalidationPayload'];
 
-type AssetParamValue = AssetParamValueItem[];
-type AssetParamValueItem = {
-    type: string;
-    _id: string;
-    /**
-     * Internal Uniform source ID or
-     * dataType ID of the global integration library
-     * which created this asset item
-     */
-    _source?: string;
-    fields: {
-        url: {
-            type: 'text';
-            value: string;
-        };
-        id?: {
-            type: 'text';
-            value: string | undefined;
-        };
-        title?: {
-            type: 'text';
-            value: string | undefined;
-        };
-        description?: {
-            type: 'text';
-            value: string | undefined;
-        };
-        mediaType?: {
-            type: 'text';
-            value: string | undefined;
-        };
-        /**
-         * The width of the original asset
-         *
-         * Should resolve to a number but might
-         * be a string with a pointer reference
-         */
-        width?: {
-            type: 'number';
-            value: number | string | undefined;
-        };
-        /**
-         * The height of the original asset
-         *
-         * Should resolve to a number but might
-         * be a string with a pointer reference
-         */
-        height?: {
-            type: 'number';
-            value: number | string | undefined;
-        };
-        /**
-         * The size in bytes of the original asset
-         *
-         * Should resolve to a number but might
-         * be a string with a pointer reference
-         */
-        size?: {
-            type: 'number';
-            value: number | string | undefined;
-        };
-        /**
-         * Any key/value properties which the source
-         * wants to attach to the asset data
-         */
-        custom?: {
-            type: string;
-            value: Record<string, unknown>;
-        };
-    };
-    _overrides?: {
-        fields: ComponentOverride['parameters'];
-    };
-};
-
 type LinkParameterType = 'projectMapNode' | 'url' | 'tel' | 'email';
 type LinkTypeConfiguration = Partial<Record<LinkParameterType, boolean>>;
 type LinkParamConfiguration = {
@@ -10126,10 +10105,7 @@ interface paths$6 {
             path?: never;
             cookie?: never;
         };
-        /**
-         * @deprecated
-         * @description Gets all preview URLs
-         */
+        /** @description Gets all preview URLs */
         get: {
             parameters: {
                 query: {
@@ -10174,10 +10150,7 @@ interface paths$6 {
                 500: components$6["responses"]["InternalServerError"];
             };
         };
-        /**
-         * @deprecated
-         * @description Upserts a preview URL
-         */
+        /** @description Upserts a preview URL */
         put: {
             parameters: {
                 query?: never;
@@ -10239,10 +10212,7 @@ interface paths$6 {
             };
         };
         post?: never;
-        /**
-         * @deprecated
-         * @description Deletes a preview URL
-         */
+        /** @description Deletes a preview URL */
         delete: {
             parameters: {
                 query?: never;
@@ -11573,7 +11543,7 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
         filters?: CompositionFilters;
     } & ({
         resolveData: true;
-        diagnostics?: boolean;
+        diagnostics: DataResolutionParameters['diagnostics'];
     } | {
         resolveData?: false;
     })): Promise<CompositionGetListResponse | CompositionResolvedListResponse>;
@@ -12127,13 +12097,19 @@ interface EvaluateNodeTreeVisibilityOptions extends Pick<EvaluateNodeVisibilityO
      * When false, indeterminate criteria will fail the summary result, and the node will be hidden
      */
     showIndeterminate?: boolean;
+    /**
+     * When evaluating visibility of a root node, this controls what happens when the node is found to be invisible.
+     * When 'throw' (default), an error is thrown.
+     * When 'ignore', the node is left intact. False is still returned.
+     */
+    rootNodeInvisibleHandling?: 'throw' | 'ignore';
 }
 /**
  * Function to call to evaluate visibility rules when traversing the node tree with walkNodeTree.
  *
  * If the function returns false, that means the current node is removed and you should stop any other code handling.
  */
-declare function evaluateWalkTreeNodeVisibility({ rules, showIndeterminate, context, }: EvaluateNodeTreeVisibilityOptions): boolean | undefined;
+declare function evaluateWalkTreeNodeVisibility({ rules, showIndeterminate, rootNodeInvisibleHandling, context, }: EvaluateNodeTreeVisibilityOptions): boolean | undefined;
 
 interface EvaluateWalkTreePropertyCriteriaOptions extends Pick<EvaluatePropertyCriteriaOptions, 'rules' | 'keepIndeterminate'> {
     node: ComponentInstance;
@@ -12423,8 +12399,6 @@ declare const createCanvasChannel: ({ listenTo, broadcastTo, }: {
 
 /**
  * API client to work with Uniform Project Preview entities
- *
- * @deprecated beta functionality subject to change
  */
 declare class PreviewClient extends ApiClient {
     constructor(options: ClientOptions);
@@ -12837,7 +12811,7 @@ declare const isSystemComponentDefinition: (componentType: string) => boolean;
  * Converts components in a slot into personalized variations (based on each component's intent tag in Canvas) suitable to pass to a personalize component
  * Useful when implementing custom personalization settings for Canvas components.
  */
-declare function mapSlotToPersonalizedVariations(slot: ComponentInstance[] | undefined): Array<ComponentInstance & PersonalizedVariant>;
+declare function mapSlotToPersonalizedVariations(slot: ComponentInstance[] | undefined): Array<ComponentInstance & PersonalizedVariant<VariationMatchMetadata>>;
 
 /**
  * Converts components in a slot into test variations (based on each component's Context tag in Canvas) suitable to pass to a personalize component
@@ -12995,4 +12969,4 @@ declare class WorkflowClient extends ApiClient {
 
 declare const CanvasClientError: typeof ApiClientError;
 
-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 AssetParamValue, type AssetParamValueItem, 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_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 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 NodeLocationReference, type NonProjectMapLinkParamValue, 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 ProjectMapLinkParamValue, 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 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, walkNodeTree, walkPropertyValues };
+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 NodeLocationReference, type NonProjectMapLinkParamValue, 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 ProjectMapLinkParamValue, 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 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, walkNodeTree, walkPropertyValues };

package/dist/index.d.ts

@@ -1,7 +1,8 @@
 import { ApiClient, ExceptProject, ClientOptions, ApiClientError } from '@uniformdev/context/api';
 export { ApiClientError } from '@uniformdev/context/api';
-import { AssetGetResponseSingle, AssetDefinitionType } from '@uniformdev/assets';
-import { Quirks, StorageCommands, PersonalizedVariant, TestVariant } from '@uniformdev/context';
+import { AssetGetResponseSingle, AssetDefinitionType, AssetParamValue, AssetParamValueItem } from '@uniformdev/assets';
+export { AssetParamValue, AssetParamValueItem } from '@uniformdev/assets';
+import { Quirks, StorageCommands, PersonalizedVariant, VariationMatchMetadata, TestVariant } from '@uniformdev/context';
 import { Options as Options$1 } from 'p-retry';
 import { Options } from 'p-throttle';
 import { RichTextBuiltInFormat as RichTextBuiltInFormat$1, RichTextBuiltInElement as RichTextBuiltInElement$1, ParameterRichTextValue } from '@uniformdev/richtext';
@@ -552,7 +553,7 @@ interface components$n {
             categoryId?: string | null;
             /** @description Description of the component definition */
             description?: string;
-            /** @description Description of the component definition */
+            /** @description Preview image URL for the component definition (shown in the UI) */
             previewImageUrl?: string;
             /**
              * @description if this component uses team permissions or custom permissions
@@ -777,7 +778,7 @@ interface components$m {
             categoryId?: string | null;
             /** @description Description of the component definition */
             description?: string;
-            /** @description Description of the component definition */
+            /** @description Preview image URL for the component definition (shown in the UI) */
             previewImageUrl?: string;
             /**
              * @description if this component uses team permissions or custom permissions
@@ -850,6 +851,27 @@ interface components$m {
              * @description ID of the workflow that instances of this content type will use by default. When not set, no workflow is attached
              */
             workflowId?: string;
+            /** @description Configurations for previewing an entry on a consuming pattern or composition. */
+            previewConfigurations?: components$m["schemas"]["ContentTypePreviewConfiguration"][];
+        };
+        /** @description Defines a configuration for previewing an entry on a consuming pattern or composition. */
+        ContentTypePreviewConfiguration: {
+            /**
+             * @description The type of preview configuration
+             * @enum {string}
+             */
+            type: "pattern" | "project-map";
+            /** @description Display label for the preview configuration */
+            label: string;
+            /**
+             * Format: uuid
+             * @description Target preview entity ID (project map node ID or pattern ID)
+             */
+            id: string;
+            /** @description Optional mapping of dynamic input names to their values */
+            dynamicInputs?: {
+                [key: string]: string;
+            };
         };
         /** @description Defines an editable parameter on a component */
         ComponentParameter: {
@@ -1781,8 +1803,14 @@ declare const CANVAS_DRAFT_STATE = 0;
 declare const CANVAS_PUBLISHED_STATE = 64;
 /** Constant for editor composition state. */
 declare const CANVAS_EDITOR_STATE = 63;
-/** Public ID of the Uniform Context personalization parameter on Canvas components */
+/** Public ID of the Uniform Context personalization criteria parameter on Canvas components */
 declare const CANVAS_PERSONALIZATION_PARAM = "$pzCrit";
+/** Public ID of the Uniform Context personalization component's event name parameter */
+declare const CANVAS_PERSONALIZATION_EVENT_NAME_PARAM = "trackingEventName";
+/** Public ID of the Uniform Context personalization component's algorithm parameter */
+declare const CANVAS_PERSONALIZATION_ALGORITHM_PARAM = "algorithm";
+/** Public ID of the Uniform Context personalization component's number of variants to show parameter */
+declare const CANVAS_PERSONALIZATION_TAKE_PARAM = "count";
 /** Public ID of the Uniform Context test variant parameter on Canvas components */
 declare const CANVAS_TEST_VARIANT_PARAM = "$tstVrnt";
 /** Public ID of the Uniform Context enrichment tag parameter on Canvas components */
@@ -2763,6 +2791,25 @@ interface components$j {
             /** @description State of the component that this permission applies to */
             state: number;
         };
+        /** @description Defines a configuration for previewing an entry on a consuming pattern or composition. */
+        ContentTypePreviewConfiguration: {
+            /**
+             * @description The type of preview configuration
+             * @enum {string}
+             */
+            type: "pattern" | "project-map";
+            /** @description Display label for the preview configuration */
+            label: string;
+            /**
+             * Format: uuid
+             * @description Target preview entity ID (project map node ID or pattern ID)
+             */
+            id: string;
+            /** @description Optional mapping of dynamic input names to their values */
+            dynamicInputs?: {
+                [key: string]: string;
+            };
+        };
         /** @description Defines a content type */
         ContentType: {
             id: components$j["schemas"]["PublicIdProperty"];
@@ -2810,6 +2857,8 @@ interface components$j {
              * @description ID of the workflow that instances of this content type will use by default. When not set, no workflow is attached
              */
             workflowId?: string;
+            /** @description Configurations for previewing an entry on a consuming pattern or composition. */
+            previewConfigurations?: components$j["schemas"]["ContentTypePreviewConfiguration"][];
         };
         Error: {
             /** @description Error message(s) that occurred while processing the request */
@@ -4100,6 +4149,7 @@ interface components$h {
 
 type HistoryApi$1 = paths$f['/api/v1/entries-history'];
 type ContentType = components$m['schemas']['ContentType'];
+type ContentTypePreviewConfiguration = components$m['schemas']['ContentTypePreviewConfiguration'];
 type ContentTypeField = Exclude<ContentType['fields'], undefined>[number];
 type GetContentTypesOptions = paths$h['/api/v1/content-types']['get']['parameters']['query'];
 type DeleteContentTypeOptions = paths$h['/api/v1/content-types']['delete']['requestBody']['content']['application/json'];
@@ -7457,6 +7507,8 @@ interface components$8 {
                 retryCount: number;
                 retryDelay: number;
                 sourceCache?: string;
+                /** @description Array of status codes for corresponding retries; will be empty for cache hits, Uniform Content data resources and static JSON data resources */
+                statusCodes: number[];
             };
             data: unknown;
         };
@@ -7491,6 +7543,7 @@ interface components$8 {
             };
         };
         DataResolutionIssue: {
+            componentId?: string;
             componentPath?: string;
             componentType?: string;
             message: string;
@@ -8369,8 +8422,8 @@ interface components$8 {
         };
     };
     parameters: {
-        /** @description Enables additional diagnostics that will be attached to the response */
-        diagnostics: boolean;
+        /** @description Enables additional diagnostics that will be attached to the response; set to "no-data" to skip data resource values while keeping metrics */
+        diagnostics: "true" | "false" | "no-data";
         /** @description Controls how many levels deep content references should be resolved */
         resolutionDepth: number;
         /** @description Max number of records to return */
@@ -9682,9 +9735,10 @@ type DataResolutionOptionPositive = {
 type DataResolutionParameters = {
     /**
      * Adds additional diagnostics about edge request processing to the response (`diagnostics`).
-     * Because this adds a lot of data to the response, we do not recommend using this unless diagnosing performance issues.
+     * Only use when diagnosing performance issues, don't use for serving production traffic.
+     * Setting to `true` will include all resolved data which may be big. Use `"no-data"` to skip data.
      */
-    diagnostics?: boolean;
+    diagnostics?: boolean | 'no-data';
     /**
      * Controls how many levels deep content references should be resolved.
      */
@@ -10006,81 +10060,6 @@ type schemas = components$8['schemas'];
 type InvalidationPayload = schemas['InvalidationPayload'];
 type BatchInvalidationPayload = schemas['BatchInvalidationPayload'];
 
-type AssetParamValue = AssetParamValueItem[];
-type AssetParamValueItem = {
-    type: string;
-    _id: string;
-    /**
-     * Internal Uniform source ID or
-     * dataType ID of the global integration library
-     * which created this asset item
-     */
-    _source?: string;
-    fields: {
-        url: {
-            type: 'text';
-            value: string;
-        };
-        id?: {
-            type: 'text';
-            value: string | undefined;
-        };
-        title?: {
-            type: 'text';
-            value: string | undefined;
-        };
-        description?: {
-            type: 'text';
-            value: string | undefined;
-        };
-        mediaType?: {
-            type: 'text';
-            value: string | undefined;
-        };
-        /**
-         * The width of the original asset
-         *
-         * Should resolve to a number but might
-         * be a string with a pointer reference
-         */
-        width?: {
-            type: 'number';
-            value: number | string | undefined;
-        };
-        /**
-         * The height of the original asset
-         *
-         * Should resolve to a number but might
-         * be a string with a pointer reference
-         */
-        height?: {
-            type: 'number';
-            value: number | string | undefined;
-        };
-        /**
-         * The size in bytes of the original asset
-         *
-         * Should resolve to a number but might
-         * be a string with a pointer reference
-         */
-        size?: {
-            type: 'number';
-            value: number | string | undefined;
-        };
-        /**
-         * Any key/value properties which the source
-         * wants to attach to the asset data
-         */
-        custom?: {
-            type: string;
-            value: Record<string, unknown>;
-        };
-    };
-    _overrides?: {
-        fields: ComponentOverride['parameters'];
-    };
-};
-
 type LinkParameterType = 'projectMapNode' | 'url' | 'tel' | 'email';
 type LinkTypeConfiguration = Partial<Record<LinkParameterType, boolean>>;
 type LinkParamConfiguration = {
@@ -10126,10 +10105,7 @@ interface paths$6 {
             path?: never;
             cookie?: never;
         };
-        /**
-         * @deprecated
-         * @description Gets all preview URLs
-         */
+        /** @description Gets all preview URLs */
         get: {
             parameters: {
                 query: {
@@ -10174,10 +10150,7 @@ interface paths$6 {
                 500: components$6["responses"]["InternalServerError"];
             };
         };
-        /**
-         * @deprecated
-         * @description Upserts a preview URL
-         */
+        /** @description Upserts a preview URL */
         put: {
             parameters: {
                 query?: never;
@@ -10239,10 +10212,7 @@ interface paths$6 {
             };
         };
         post?: never;
-        /**
-         * @deprecated
-         * @description Deletes a preview URL
-         */
+        /** @description Deletes a preview URL */
         delete: {
             parameters: {
                 query?: never;
@@ -11573,7 +11543,7 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
         filters?: CompositionFilters;
     } & ({
         resolveData: true;
-        diagnostics?: boolean;
+        diagnostics: DataResolutionParameters['diagnostics'];
     } | {
         resolveData?: false;
     })): Promise<CompositionGetListResponse | CompositionResolvedListResponse>;
@@ -12127,13 +12097,19 @@ interface EvaluateNodeTreeVisibilityOptions extends Pick<EvaluateNodeVisibilityO
      * When false, indeterminate criteria will fail the summary result, and the node will be hidden
      */
     showIndeterminate?: boolean;
+    /**
+     * When evaluating visibility of a root node, this controls what happens when the node is found to be invisible.
+     * When 'throw' (default), an error is thrown.
+     * When 'ignore', the node is left intact. False is still returned.
+     */
+    rootNodeInvisibleHandling?: 'throw' | 'ignore';
 }
 /**
  * Function to call to evaluate visibility rules when traversing the node tree with walkNodeTree.
  *
  * If the function returns false, that means the current node is removed and you should stop any other code handling.
  */
-declare function evaluateWalkTreeNodeVisibility({ rules, showIndeterminate, context, }: EvaluateNodeTreeVisibilityOptions): boolean | undefined;
+declare function evaluateWalkTreeNodeVisibility({ rules, showIndeterminate, rootNodeInvisibleHandling, context, }: EvaluateNodeTreeVisibilityOptions): boolean | undefined;
 
 interface EvaluateWalkTreePropertyCriteriaOptions extends Pick<EvaluatePropertyCriteriaOptions, 'rules' | 'keepIndeterminate'> {
     node: ComponentInstance;
@@ -12423,8 +12399,6 @@ declare const createCanvasChannel: ({ listenTo, broadcastTo, }: {
 
 /**
  * API client to work with Uniform Project Preview entities
- *
- * @deprecated beta functionality subject to change
  */
 declare class PreviewClient extends ApiClient {
     constructor(options: ClientOptions);
@@ -12837,7 +12811,7 @@ declare const isSystemComponentDefinition: (componentType: string) => boolean;
  * Converts components in a slot into personalized variations (based on each component's intent tag in Canvas) suitable to pass to a personalize component
  * Useful when implementing custom personalization settings for Canvas components.
  */
-declare function mapSlotToPersonalizedVariations(slot: ComponentInstance[] | undefined): Array<ComponentInstance & PersonalizedVariant>;
+declare function mapSlotToPersonalizedVariations(slot: ComponentInstance[] | undefined): Array<ComponentInstance & PersonalizedVariant<VariationMatchMetadata>>;
 
 /**
  * Converts components in a slot into test variations (based on each component's Context tag in Canvas) suitable to pass to a personalize component
@@ -12995,4 +12969,4 @@ declare class WorkflowClient extends ApiClient {
 
 declare const CanvasClientError: typeof ApiClientError;
 
-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 AssetParamValue, type AssetParamValueItem, 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_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 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 NodeLocationReference, type NonProjectMapLinkParamValue, 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 ProjectMapLinkParamValue, 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 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, walkNodeTree, walkPropertyValues };
+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 NodeLocationReference, type NonProjectMapLinkParamValue, 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 ProjectMapLinkParamValue, 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 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, walkNodeTree, walkPropertyValues };

package/dist/index.esm.js

@@ -624,7 +624,7 @@ var CanvasClient = class extends ApiClient {
     const edgeParams = {
       ...originParams,
       projectId,
-      ...params.diagnostics ? { diagnostics: "true" } : {},
+      diagnostics: typeof params.diagnostics === "boolean" ? params.diagnostics : params.diagnostics === "no-data" ? "no-data" : void 0,
       ...rewrittenFilters
     };
     const edgeUrl = this.createUrl("/api/v1/compositions", edgeParams, this.edgeApiHost);
@@ -665,7 +665,7 @@ var CanvasClient = class extends ApiClient {
     const edgeParams = {
       ...params,
       projectId,
-      ...diagnostics ? { diagnostics: "true" } : {}
+      diagnostics: typeof diagnostics === "boolean" ? diagnostics : diagnostics === "no-data" ? "no-data" : void 0
     };
     const edgeUrl = this.createUrl("/api/v1/composition", edgeParams, this.edgeApiHost);
     return this.apiClient(edgeUrl, this.edgeApiRequestInit);
@@ -847,7 +847,7 @@ var _ContentClient = class _ContentClient extends ApiClient3 {
     return {
       projectId,
       ...params,
-      diagnostics: (options == null ? void 0 : options.diagnostics) ? "true" : void 0
+      diagnostics: typeof options.diagnostics === "boolean" ? options.diagnostics : options.diagnostics === "no-data" ? "no-data" : void 0
     };
   }
 };
@@ -1075,6 +1075,9 @@ var CANVAS_DRAFT_STATE = 0;
 var CANVAS_PUBLISHED_STATE = 64;
 var CANVAS_EDITOR_STATE = 63;
 var CANVAS_PERSONALIZATION_PARAM = "$pzCrit";
+var CANVAS_PERSONALIZATION_EVENT_NAME_PARAM = "trackingEventName";
+var CANVAS_PERSONALIZATION_ALGORITHM_PARAM = "algorithm";
+var CANVAS_PERSONALIZATION_TAKE_PARAM = "count";
 var CANVAS_TEST_VARIANT_PARAM = "$tstVrnt";
 var CANVAS_ENRICHMENT_TAG_PARAM = "$enr";
 var CANVAS_CONTEXTUAL_EDITING_PARAM = "$contextualEditing";
@@ -2089,15 +2092,19 @@ function evaluateNodeVisibility({
 function evaluateWalkTreeNodeVisibility({
   rules,
   showIndeterminate,
+  rootNodeInvisibleHandling = "throw",
   context
 }) {
-  const { type, node, actions } = context;
+  const { type, node, actions, ancestorsAndSelf } = context;
   if (type !== "component") {
     return;
   }
   const result = evaluateNodeVisibility({ node, rules, simplifyCriteria: true });
   if (result === null && !showIndeterminate || result === false) {
-    actions.remove();
+    if (ancestorsAndSelf.length === 1 && rootNodeInvisibleHandling === "ignore") {
+    } else {
+      actions.remove();
+    }
     return false;
   }
   return true;
@@ -2333,25 +2340,24 @@ function extractLocales({ component }) {
 function localize(options) {
   const nodes = options.nodes;
   const locale = options.locale;
-  const isUsingModernOptions = typeof locale === "string";
-  const vizControlLocaleRule = isUsingModernOptions ? createLocaleVisibilityRule(locale) : {};
+  if (!locale) {
+    return;
+  }
+  const vizControlLocaleRule = createLocaleVisibilityRule(locale);
   walkNodeTree(nodes, (context) => {
     const { type, node, actions } = context;
     if (type !== "component") {
-      if (isUsingModernOptions) {
-        localizeProperties(node, locale, vizControlLocaleRule);
-      }
+      localizeProperties(node, locale, vizControlLocaleRule);
       return;
     }
-    if (isUsingModernOptions) {
-      const result = evaluateWalkTreeNodeVisibility({
-        context,
-        rules: vizControlLocaleRule,
-        showIndeterminate: true
-      });
-      if (!result) {
-        return;
-      }
+    const result = evaluateWalkTreeNodeVisibility({
+      context,
+      rules: vizControlLocaleRule,
+      showIndeterminate: true,
+      rootNodeInvisibleHandling: "ignore"
+    });
+    if (!result) {
+      return;
     }
     if (node.type === CANVAS_LOCALIZATION_TYPE) {
       const locales = extractLocales({ component: node });
@@ -2362,9 +2368,7 @@ function localize(options) {
       if (replaceComponent == null ? void 0 : replaceComponent.length) {
         replaceComponent.forEach((component) => {
           removeLocaleProperty(component);
-          if (isUsingModernOptions) {
-            localizeProperties(component, locale, vizControlLocaleRule);
-          }
+          localizeProperties(component, locale, vizControlLocaleRule);
         });
         const [first, ...rest] = replaceComponent;
         actions.replace(first);
@@ -2374,7 +2378,7 @@ function localize(options) {
       } else {
         actions.remove();
       }
-    } else if (isUsingModernOptions) {
+    } else {
       localizeProperties(node, locale, vizControlLocaleRule);
     }
   });
@@ -3422,7 +3426,10 @@ export {
   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,

package/dist/index.js

@@ -409,7 +409,10 @@ __export(src_exports, {
   CANVAS_LOCALE_TAG_PARAM: () => CANVAS_LOCALE_TAG_PARAM,
   CANVAS_LOCALIZATION_SLOT: () => CANVAS_LOCALIZATION_SLOT,
   CANVAS_LOCALIZATION_TYPE: () => CANVAS_LOCALIZATION_TYPE,
+  CANVAS_PERSONALIZATION_ALGORITHM_PARAM: () => CANVAS_PERSONALIZATION_ALGORITHM_PARAM,
+  CANVAS_PERSONALIZATION_EVENT_NAME_PARAM: () => CANVAS_PERSONALIZATION_EVENT_NAME_PARAM,
   CANVAS_PERSONALIZATION_PARAM: () => CANVAS_PERSONALIZATION_PARAM,
+  CANVAS_PERSONALIZATION_TAKE_PARAM: () => CANVAS_PERSONALIZATION_TAKE_PARAM,
   CANVAS_PERSONALIZE_SLOT: () => CANVAS_PERSONALIZE_SLOT,
   CANVAS_PERSONALIZE_TYPE: () => CANVAS_PERSONALIZE_TYPE,
   CANVAS_PUBLISHED_STATE: () => CANVAS_PUBLISHED_STATE,
@@ -784,7 +787,7 @@ var CanvasClient = class extends import_api2.ApiClient {
     const edgeParams = {
       ...originParams,
       projectId,
-      ...params.diagnostics ? { diagnostics: "true" } : {},
+      diagnostics: typeof params.diagnostics === "boolean" ? params.diagnostics : params.diagnostics === "no-data" ? "no-data" : void 0,
       ...rewrittenFilters
     };
     const edgeUrl = this.createUrl("/api/v1/compositions", edgeParams, this.edgeApiHost);
@@ -825,7 +828,7 @@ var CanvasClient = class extends import_api2.ApiClient {
     const edgeParams = {
       ...params,
       projectId,
-      ...diagnostics ? { diagnostics: "true" } : {}
+      diagnostics: typeof diagnostics === "boolean" ? diagnostics : diagnostics === "no-data" ? "no-data" : void 0
     };
     const edgeUrl = this.createUrl("/api/v1/composition", edgeParams, this.edgeApiHost);
     return this.apiClient(edgeUrl, this.edgeApiRequestInit);
@@ -1007,7 +1010,7 @@ var _ContentClient = class _ContentClient extends import_api4.ApiClient {
     return {
       projectId,
       ...params,
-      diagnostics: (options == null ? void 0 : options.diagnostics) ? "true" : void 0
+      diagnostics: typeof options.diagnostics === "boolean" ? options.diagnostics : options.diagnostics === "no-data" ? "no-data" : void 0
     };
   }
 };
@@ -1235,6 +1238,9 @@ var CANVAS_DRAFT_STATE = 0;
 var CANVAS_PUBLISHED_STATE = 64;
 var CANVAS_EDITOR_STATE = 63;
 var CANVAS_PERSONALIZATION_PARAM = "$pzCrit";
+var CANVAS_PERSONALIZATION_EVENT_NAME_PARAM = "trackingEventName";
+var CANVAS_PERSONALIZATION_ALGORITHM_PARAM = "algorithm";
+var CANVAS_PERSONALIZATION_TAKE_PARAM = "count";
 var CANVAS_TEST_VARIANT_PARAM = "$tstVrnt";
 var CANVAS_ENRICHMENT_TAG_PARAM = "$enr";
 var CANVAS_CONTEXTUAL_EDITING_PARAM = "$contextualEditing";
@@ -2249,15 +2255,19 @@ function evaluateNodeVisibility({
 function evaluateWalkTreeNodeVisibility({
   rules,
   showIndeterminate,
+  rootNodeInvisibleHandling = "throw",
   context
 }) {
-  const { type, node, actions } = context;
+  const { type, node, actions, ancestorsAndSelf } = context;
   if (type !== "component") {
     return;
   }
   const result = evaluateNodeVisibility({ node, rules, simplifyCriteria: true });
   if (result === null && !showIndeterminate || result === false) {
-    actions.remove();
+    if (ancestorsAndSelf.length === 1 && rootNodeInvisibleHandling === "ignore") {
+    } else {
+      actions.remove();
+    }
     return false;
   }
   return true;
@@ -2493,25 +2503,24 @@ function extractLocales({ component }) {
 function localize(options) {
   const nodes = options.nodes;
   const locale = options.locale;
-  const isUsingModernOptions = typeof locale === "string";
-  const vizControlLocaleRule = isUsingModernOptions ? createLocaleVisibilityRule(locale) : {};
+  if (!locale) {
+    return;
+  }
+  const vizControlLocaleRule = createLocaleVisibilityRule(locale);
   walkNodeTree(nodes, (context) => {
     const { type, node, actions } = context;
     if (type !== "component") {
-      if (isUsingModernOptions) {
-        localizeProperties(node, locale, vizControlLocaleRule);
-      }
+      localizeProperties(node, locale, vizControlLocaleRule);
       return;
     }
-    if (isUsingModernOptions) {
-      const result = evaluateWalkTreeNodeVisibility({
-        context,
-        rules: vizControlLocaleRule,
-        showIndeterminate: true
-      });
-      if (!result) {
-        return;
-      }
+    const result = evaluateWalkTreeNodeVisibility({
+      context,
+      rules: vizControlLocaleRule,
+      showIndeterminate: true,
+      rootNodeInvisibleHandling: "ignore"
+    });
+    if (!result) {
+      return;
     }
     if (node.type === CANVAS_LOCALIZATION_TYPE) {
       const locales = extractLocales({ component: node });
@@ -2522,9 +2531,7 @@ function localize(options) {
       if (replaceComponent == null ? void 0 : replaceComponent.length) {
         replaceComponent.forEach((component) => {
           removeLocaleProperty(component);
-          if (isUsingModernOptions) {
-            localizeProperties(component, locale, vizControlLocaleRule);
-          }
+          localizeProperties(component, locale, vizControlLocaleRule);
         });
         const [first, ...rest] = replaceComponent;
         actions.replace(first);
@@ -2534,7 +2541,7 @@ function localize(options) {
       } else {
         actions.remove();
       }
-    } else if (isUsingModernOptions) {
+    } else {
       localizeProperties(node, locale, vizControlLocaleRule);
     }
   });
@@ -3583,7 +3590,10 @@ var CanvasClientError = import_api16.ApiClientError;
   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,

package/dist/index.mjs

@@ -624,7 +624,7 @@ var CanvasClient = class extends ApiClient {
     const edgeParams = {
       ...originParams,
       projectId,
-      ...params.diagnostics ? { diagnostics: "true" } : {},
+      diagnostics: typeof params.diagnostics === "boolean" ? params.diagnostics : params.diagnostics === "no-data" ? "no-data" : void 0,
       ...rewrittenFilters
     };
     const edgeUrl = this.createUrl("/api/v1/compositions", edgeParams, this.edgeApiHost);
@@ -665,7 +665,7 @@ var CanvasClient = class extends ApiClient {
     const edgeParams = {
       ...params,
       projectId,
-      ...diagnostics ? { diagnostics: "true" } : {}
+      diagnostics: typeof diagnostics === "boolean" ? diagnostics : diagnostics === "no-data" ? "no-data" : void 0
     };
     const edgeUrl = this.createUrl("/api/v1/composition", edgeParams, this.edgeApiHost);
     return this.apiClient(edgeUrl, this.edgeApiRequestInit);
@@ -847,7 +847,7 @@ var _ContentClient = class _ContentClient extends ApiClient3 {
     return {
       projectId,
       ...params,
-      diagnostics: (options == null ? void 0 : options.diagnostics) ? "true" : void 0
+      diagnostics: typeof options.diagnostics === "boolean" ? options.diagnostics : options.diagnostics === "no-data" ? "no-data" : void 0
     };
   }
 };
@@ -1075,6 +1075,9 @@ var CANVAS_DRAFT_STATE = 0;
 var CANVAS_PUBLISHED_STATE = 64;
 var CANVAS_EDITOR_STATE = 63;
 var CANVAS_PERSONALIZATION_PARAM = "$pzCrit";
+var CANVAS_PERSONALIZATION_EVENT_NAME_PARAM = "trackingEventName";
+var CANVAS_PERSONALIZATION_ALGORITHM_PARAM = "algorithm";
+var CANVAS_PERSONALIZATION_TAKE_PARAM = "count";
 var CANVAS_TEST_VARIANT_PARAM = "$tstVrnt";
 var CANVAS_ENRICHMENT_TAG_PARAM = "$enr";
 var CANVAS_CONTEXTUAL_EDITING_PARAM = "$contextualEditing";
@@ -2089,15 +2092,19 @@ function evaluateNodeVisibility({
 function evaluateWalkTreeNodeVisibility({
   rules,
   showIndeterminate,
+  rootNodeInvisibleHandling = "throw",
   context
 }) {
-  const { type, node, actions } = context;
+  const { type, node, actions, ancestorsAndSelf } = context;
   if (type !== "component") {
     return;
   }
   const result = evaluateNodeVisibility({ node, rules, simplifyCriteria: true });
   if (result === null && !showIndeterminate || result === false) {
-    actions.remove();
+    if (ancestorsAndSelf.length === 1 && rootNodeInvisibleHandling === "ignore") {
+    } else {
+      actions.remove();
+    }
     return false;
   }
   return true;
@@ -2333,25 +2340,24 @@ function extractLocales({ component }) {
 function localize(options) {
   const nodes = options.nodes;
   const locale = options.locale;
-  const isUsingModernOptions = typeof locale === "string";
-  const vizControlLocaleRule = isUsingModernOptions ? createLocaleVisibilityRule(locale) : {};
+  if (!locale) {
+    return;
+  }
+  const vizControlLocaleRule = createLocaleVisibilityRule(locale);
   walkNodeTree(nodes, (context) => {
     const { type, node, actions } = context;
     if (type !== "component") {
-      if (isUsingModernOptions) {
-        localizeProperties(node, locale, vizControlLocaleRule);
-      }
+      localizeProperties(node, locale, vizControlLocaleRule);
       return;
     }
-    if (isUsingModernOptions) {
-      const result = evaluateWalkTreeNodeVisibility({
-        context,
-        rules: vizControlLocaleRule,
-        showIndeterminate: true
-      });
-      if (!result) {
-        return;
-      }
+    const result = evaluateWalkTreeNodeVisibility({
+      context,
+      rules: vizControlLocaleRule,
+      showIndeterminate: true,
+      rootNodeInvisibleHandling: "ignore"
+    });
+    if (!result) {
+      return;
     }
     if (node.type === CANVAS_LOCALIZATION_TYPE) {
       const locales = extractLocales({ component: node });
@@ -2362,9 +2368,7 @@ function localize(options) {
       if (replaceComponent == null ? void 0 : replaceComponent.length) {
         replaceComponent.forEach((component) => {
           removeLocaleProperty(component);
-          if (isUsingModernOptions) {
-            localizeProperties(component, locale, vizControlLocaleRule);
-          }
+          localizeProperties(component, locale, vizControlLocaleRule);
         });
         const [first, ...rest] = replaceComponent;
         actions.replace(first);
@@ -2374,7 +2378,7 @@ function localize(options) {
       } else {
         actions.remove();
       }
-    } else if (isUsingModernOptions) {
+    } else {
       localizeProperties(node, locale, vizControlLocaleRule);
     }
   });
@@ -3422,7 +3426,10 @@ export {
   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,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/canvas",
-  "version": "20.7.1-alpha.4+20185a97ff",
+  "version": "20.7.1-alpha.42+580f8a1849",
   "description": "Common functionality and types for Uniform Canvas",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -28,7 +28,7 @@
     "lint": "eslint \"src/**/*.{js,ts,tsx}\"",
     "format": "prettier --write \"src/**/*.{js,ts,tsx}\"",
     "update-openapi": "tsx ./scripts/update-openapi.cts",
-    "document": "api-extractor run --local"
+    "document:prebuild": "api-extractor run --local"
   },
   "devDependencies": {
     "@types/retry": "0.12.5",
@@ -38,9 +38,9 @@
     "p-throttle": "5.0.0"
   },
   "dependencies": {
-    "@uniformdev/assets": "20.7.1-alpha.4+20185a97ff",
-    "@uniformdev/context": "20.7.1-alpha.4+20185a97ff",
-    "@uniformdev/richtext": "20.7.1-alpha.4+20185a97ff",
+    "@uniformdev/assets": "20.7.1-alpha.42+580f8a1849",
+    "@uniformdev/context": "20.7.1-alpha.42+580f8a1849",
+    "@uniformdev/richtext": "20.7.1-alpha.42+580f8a1849",
     "immer": "10.1.1"
   },
   "files": [
@@ -49,5 +49,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "20185a97ff6c2de2f871223af12d73583fe300af"
+  "gitHead": "580f8a1849984760d11edb936da050eb05e28313"
 }