@uniformdev/canvas 19.164.0 → 19.165.1-alpha.0

package/dist/index.d.mts

@@ -25491,6 +25491,9 @@ declare function localize(options: LocalizeDeprecatedOptions): void;
  *
  * NOTE: this function mutates its input object for maximum performance.
  * If you desire immutability wrap it in immer.
+ *
+ * NOTE: this function is only necessary when content has been fetched in more than one locale from the Uniform API.
+ * If a locale was provided to the Uniform API, the content will already be localized in the desired locale.
  */
 declare function localize(options: LocalizeModernOptions): void;
 
@@ -25511,6 +25514,106 @@ declare class UniqueBatchEntries<TArgs, TResult> {
     resolveRemaining(value: TResult): void;
 }
 
+declare const CANVAS_VIZ_CONTROL_PARAM = "$viz";
+/**
+ * @deprecated beta functionality subject to change
+ */
+type VisibilityRules = {
+    [rule: string]: VisibilityRule;
+};
+/**
+ * @deprecated beta functionality subject to change
+ */
+type VisibilityRule = (criteria: VisibilityCriteria) => VisibilityCriteriaEvaluationResult;
+/**
+ * @deprecated beta functionality subject to change
+ */
+type VisibilityParameterValue = {
+    /**
+     * Overrides any criteria value and hides the component explicitly
+     * (e.g. for unfinished content)
+     */
+    explicitlyHidden?: boolean;
+    /** Criteria for the visibility of the component. If these evaluate to false, the component is hidden. */
+    criteria?: VisibilityCriteriaGroup;
+};
+/**
+ * @deprecated beta functionality subject to change
+ */
+type VisibilityCriteriaGroup = {
+    /** The boolean operator to join the clauses with. Defaults to & if not specified. */
+    op?: '&' | '|';
+    clauses: Array<VisibilityCriteria | VisibilityCriteriaGroup>;
+};
+/**
+ * @deprecated beta functionality subject to change
+ */
+type VisibilityCriteria = {
+    /** The rule type to execute */
+    rule: string;
+    /** The source value of the rule. For rules which have multiple classes of match, for example a dynamic input matches on a named DI. The rule is dynamic input. The DI name is the source. */
+    source?: string;
+    /** The rule-definition-specific operator to test against */
+    op: string;
+    /** The value, or if an array several potential values, to test against. In most rules, multiple values are OR'd together ('any of') but this is not a hard requirement. */
+    value: string | string[];
+};
+/**
+ * @deprecated beta functionality subject to change
+ */
+type VisibilityCriteriaEvaluationResult = boolean | null;
+
+type EvaluateCriteriaGroupOptions = {
+    /** Visibility rule definitions to evaluate */
+    rules: VisibilityRules;
+    /**
+     * When true, the criteria group passed in will be simplified according to rules which pass or fail,
+     * resulting in a result that only contains indeterminate results.
+     *
+     * If false, the criteria group object will not be modified.
+     */
+    simplifyCriteria?: boolean;
+    /** The criteria group to evaluate */
+    criteriaGroup: VisibilityCriteriaGroup;
+};
+/**
+ * @deprecated beta functionality subject to change
+ */
+declare function evaluateVisibilityCriteriaGroup(options: EvaluateCriteriaGroupOptions): VisibilityCriteriaEvaluationResult;
+
+interface EvaluateNodeVisibilityOptions extends Omit<EvaluateCriteriaGroupOptions, 'criteriaGroup'> {
+    /** The node to evaluate visibility rules on */
+    node: ComponentInstance;
+}
+
+interface EvaluateNodeTreeVisibilityOptions extends Pick<EvaluateNodeVisibilityOptions, 'rules'> {
+    context: TreeNodeInfoTypes<unknown>;
+    /**
+     * Controls the overall result when indeterminate criteria are found
+     * (unknown rule types, or rule evaluators that return null)
+     * When true, indeterminate criteria will not fail the summary result
+     * When false, indeterminate criteria will fail the summary result, and the node will be hidden
+     */
+    showIndeterminate?: boolean;
+}
+/**
+ * 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.
+ *
+ * @deprecated beta functionality subject to change
+ */
+declare function evaluateWalkTreeVisibility({ rules, showIndeterminate, context, }: EvaluateNodeTreeVisibilityOptions): boolean | undefined;
+
+declare const CANVAS_VIZ_DI_RULE = "$di";
+declare function createDynamicInputVisibilityRule(dynamicInputs: Record<string, string>): VisibilityRules;
+
+type CoreStringOperators = 'is' | 'has' | 'startswith' | 'endswith' | 'empty';
+type StringOperators = CoreStringOperators | `!${CoreStringOperators}`;
+
+declare const CANVAS_VIZ_LOCALE_RULE = "$locale";
+declare function createLocaleVisibilityRule(currentLocale: string | undefined): VisibilityRules;
+
 /** API client to fetch entity across releases */
 declare class EntityReleasesClient extends ApiClient {
     constructor(options: ClientOptions);
@@ -26442,4 +26545,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, type BlockLocationReference, type BlockValue, CANVAS_BLOCK_PARAM_TYPE, 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, CanvasClient, CanvasClientError, type CanvasDefinitions, type CategoriesDeleteParameters, type CategoriesGetParameters, type CategoriesGetResponse, type CategoriesPutParameters, type Category, CategoryClient, type Channel, type ChannelMessage, type ChannelSubscription, 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 ComponentLocationReferenceV2, type ComponentOverridability, type ComponentOverride, type ComponentOverrides, type ComponentParameter, type ComponentParameterBlock, type ComponentParameterContextualEditing, type ComponentParameterEnhancer, type ComponentParameterEnhancerFunction, type ComponentParameterEnhancerOptions, type CompositionDataDiagnostic, type CompositionDeleteParameters, type CompositionDiagnostics, type CompositionFilters, type CompositionGetByComponentIdParameters, type CompositionGetByIdParameters, type CompositionGetByNodeIdParameters, type CompositionGetByNodePathParameters, type CompositionGetBySlugParameters, type CompositionGetListResponse, type CompositionGetOrderBy, type CompositionGetParameters, type CompositionGetResponse, type CompositionGetValidResponses, type CompositionIssue, type CompositionPatternIssue, type CompositionPutParameters, type CompositionResolvedGetResponse, type CompositionResolvedListResponse, type CompositionUIStatus, ContentClient, type ContentType, type ContentTypeField, type ContextualEditingComponentReference, 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 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 EventNames, type Filters, type FindInNodeTreeReference, type FlattenProperty, type FlattenValues, type FlattenValuesOptions, type GetContentTypesOptions, type GetContentTypesResponse, 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 LinkComponentParameterValue, type LinkParamConfiguration, type LinkParamValue, type LinkParameterType, type LinkTypeConfiguration, type Locale, LocaleClient, type LocaleDeleteParameters, type LocalePutParameters, type LocalesGetParameters, type LocalesGetResponse, type LocalizeDeprecatedOptions, type LocalizeModernOptions, type MessageHandler, type MoveComponentMessage, type NodeLocationReference, type NonProjectMapLinkParamValue, type OpenParameterEditorMessage, type OverrideOptions, PLACEHOLDER_ID, type PatternIssue, type PreviewEventBus, type PreviewPanelSettings, type ProjectMapLinkComponentParameterValue, type ProjectMapLinkParamValue, type Prompt, PromptClient, type PromptsDeleteParameters, type PromptsGetParameters, type PromptsGetResponse, type PromptsPutParameters, 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 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 SpecificProjectMap, type SubscribeToCompositionOptions, type SuggestComponentMessage, type TreeNodeInfoTypes, type TriggerComponentActionMessage, type TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, UncachedContentClient, UniqueBatchEntries, type UnsubscribeCallback, type UpdateComponentParameterMessage, type UpdateComponentReferencesMessage, type UpdateCompositionInternalMessage, type UpdateCompositionMessage, type UpdateContextualEditingStateInternalMessage, type UpdateFeatureFlagsMessage, type UpdatePreviewSettingsMessage, type WalkComponentTreeActions, type WalkNodeTreeActions, type WalkNodeTreeOptions, WorkflowClient, type WorkflowDefinition, type WorkflowStage, type WorkflowStagePermission, type WorkflowStageTransition, type WorkflowStageTransitionPermission, type WorkflowsDeleteParameters, type WorkflowsGetParameters, type WorkflowsGetResponse, type WorkflowsPutParameters, bindVariables, bindVariablesToObject, compose, convertEntryToPutEntry, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, createVariableReference, enhance, extractLocales, findParameterInNodeTree, flattenValues, generateComponentPlaceholderId, generateHash, getBlockValue, getChannelName, getComponentJsonPointer, getComponentPath, getLocalizedPropertyValues, getNounForLocation, getNounForNode, getParameterAttributes, getPropertiesValue, getPropertyValue, isAddComponentMessage, isAllowedReferrer, isAssetParamValue, isAssetParamValueItem, isComponentActionMessage, isComponentPlaceholderId, isDismissPlaceholderMessage, isEntryData, 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, subscribeToComposition, walkComponentTree, walkNodeTree };
+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, type BlockLocationReference, type BlockValue, CANVAS_BLOCK_PARAM_TYPE, 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_LOCALE_RULE, CanvasClient, CanvasClientError, type CanvasDefinitions, type CategoriesDeleteParameters, type CategoriesGetParameters, type CategoriesGetResponse, type CategoriesPutParameters, type Category, CategoryClient, type Channel, type ChannelMessage, type ChannelSubscription, 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 ComponentLocationReferenceV2, type ComponentOverridability, type ComponentOverride, type ComponentOverrides, type ComponentParameter, type ComponentParameterBlock, type ComponentParameterContextualEditing, type ComponentParameterEnhancer, type ComponentParameterEnhancerFunction, type ComponentParameterEnhancerOptions, type CompositionDataDiagnostic, type CompositionDeleteParameters, type CompositionDiagnostics, type CompositionFilters, type CompositionGetByComponentIdParameters, type CompositionGetByIdParameters, type CompositionGetByNodeIdParameters, type CompositionGetByNodePathParameters, type CompositionGetBySlugParameters, type CompositionGetListResponse, type CompositionGetOrderBy, type CompositionGetParameters, type CompositionGetResponse, type CompositionGetValidResponses, type CompositionIssue, type CompositionPatternIssue, type CompositionPutParameters, type CompositionResolvedGetResponse, type CompositionResolvedListResponse, type CompositionUIStatus, ContentClient, type ContentType, type ContentTypeField, type ContextualEditingComponentReference, 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 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 EventNames, type Filters, type FindInNodeTreeReference, type FlattenProperty, type FlattenValues, type FlattenValuesOptions, type GetContentTypesOptions, type GetContentTypesResponse, 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 LinkComponentParameterValue, type LinkParamConfiguration, type LinkParamValue, type LinkParameterType, type LinkTypeConfiguration, type Locale, LocaleClient, type LocaleDeleteParameters, type LocalePutParameters, type LocalesGetParameters, type LocalesGetResponse, type LocalizeDeprecatedOptions, type LocalizeModernOptions, type MessageHandler, type MoveComponentMessage, type NodeLocationReference, type NonProjectMapLinkParamValue, type OpenParameterEditorMessage, type OverrideOptions, PLACEHOLDER_ID, type PatternIssue, type PreviewEventBus, type PreviewPanelSettings, type ProjectMapLinkComponentParameterValue, type ProjectMapLinkParamValue, type Prompt, PromptClient, type PromptsDeleteParameters, type PromptsGetParameters, type PromptsGetResponse, type PromptsPutParameters, 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 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 SpecificProjectMap, type StringOperators, type SubscribeToCompositionOptions, type SuggestComponentMessage, type TreeNodeInfoTypes, type TriggerComponentActionMessage, type TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, UncachedContentClient, UniqueBatchEntries, type UnsubscribeCallback, 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 WalkComponentTreeActions, type WalkNodeTreeActions, type WalkNodeTreeOptions, WorkflowClient, type WorkflowDefinition, type WorkflowStage, type WorkflowStagePermission, type WorkflowStageTransition, type WorkflowStageTransitionPermission, type WorkflowsDeleteParameters, type WorkflowsGetParameters, type WorkflowsGetResponse, type WorkflowsPutParameters, bindVariables, bindVariablesToObject, compose, convertEntryToPutEntry, createBatchEnhancer, createCanvasChannel, createDynamicInputVisibilityRule, createEventBus, createLimitPolicy, createLocaleVisibilityRule, createUniformApiEnhancer, createVariableReference, enhance, evaluateVisibilityCriteriaGroup, evaluateWalkTreeVisibility, extractLocales, findParameterInNodeTree, flattenValues, generateComponentPlaceholderId, generateHash, getBlockValue, getChannelName, getComponentJsonPointer, getComponentPath, getLocalizedPropertyValues, getNounForLocation, getNounForNode, getParameterAttributes, getPropertiesValue, getPropertyValue, isAddComponentMessage, isAllowedReferrer, isAssetParamValue, isAssetParamValueItem, isComponentActionMessage, isComponentPlaceholderId, isDismissPlaceholderMessage, isEntryData, 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, subscribeToComposition, walkComponentTree, walkNodeTree };

package/dist/index.d.ts

@@ -25491,6 +25491,9 @@ declare function localize(options: LocalizeDeprecatedOptions): void;
  *
  * NOTE: this function mutates its input object for maximum performance.
  * If you desire immutability wrap it in immer.
+ *
+ * NOTE: this function is only necessary when content has been fetched in more than one locale from the Uniform API.
+ * If a locale was provided to the Uniform API, the content will already be localized in the desired locale.
  */
 declare function localize(options: LocalizeModernOptions): void;
 
@@ -25511,6 +25514,106 @@ declare class UniqueBatchEntries<TArgs, TResult> {
     resolveRemaining(value: TResult): void;
 }
 
+declare const CANVAS_VIZ_CONTROL_PARAM = "$viz";
+/**
+ * @deprecated beta functionality subject to change
+ */
+type VisibilityRules = {
+    [rule: string]: VisibilityRule;
+};
+/**
+ * @deprecated beta functionality subject to change
+ */
+type VisibilityRule = (criteria: VisibilityCriteria) => VisibilityCriteriaEvaluationResult;
+/**
+ * @deprecated beta functionality subject to change
+ */
+type VisibilityParameterValue = {
+    /**
+     * Overrides any criteria value and hides the component explicitly
+     * (e.g. for unfinished content)
+     */
+    explicitlyHidden?: boolean;
+    /** Criteria for the visibility of the component. If these evaluate to false, the component is hidden. */
+    criteria?: VisibilityCriteriaGroup;
+};
+/**
+ * @deprecated beta functionality subject to change
+ */
+type VisibilityCriteriaGroup = {
+    /** The boolean operator to join the clauses with. Defaults to & if not specified. */
+    op?: '&' | '|';
+    clauses: Array<VisibilityCriteria | VisibilityCriteriaGroup>;
+};
+/**
+ * @deprecated beta functionality subject to change
+ */
+type VisibilityCriteria = {
+    /** The rule type to execute */
+    rule: string;
+    /** The source value of the rule. For rules which have multiple classes of match, for example a dynamic input matches on a named DI. The rule is dynamic input. The DI name is the source. */
+    source?: string;
+    /** The rule-definition-specific operator to test against */
+    op: string;
+    /** The value, or if an array several potential values, to test against. In most rules, multiple values are OR'd together ('any of') but this is not a hard requirement. */
+    value: string | string[];
+};
+/**
+ * @deprecated beta functionality subject to change
+ */
+type VisibilityCriteriaEvaluationResult = boolean | null;
+
+type EvaluateCriteriaGroupOptions = {
+    /** Visibility rule definitions to evaluate */
+    rules: VisibilityRules;
+    /**
+     * When true, the criteria group passed in will be simplified according to rules which pass or fail,
+     * resulting in a result that only contains indeterminate results.
+     *
+     * If false, the criteria group object will not be modified.
+     */
+    simplifyCriteria?: boolean;
+    /** The criteria group to evaluate */
+    criteriaGroup: VisibilityCriteriaGroup;
+};
+/**
+ * @deprecated beta functionality subject to change
+ */
+declare function evaluateVisibilityCriteriaGroup(options: EvaluateCriteriaGroupOptions): VisibilityCriteriaEvaluationResult;
+
+interface EvaluateNodeVisibilityOptions extends Omit<EvaluateCriteriaGroupOptions, 'criteriaGroup'> {
+    /** The node to evaluate visibility rules on */
+    node: ComponentInstance;
+}
+
+interface EvaluateNodeTreeVisibilityOptions extends Pick<EvaluateNodeVisibilityOptions, 'rules'> {
+    context: TreeNodeInfoTypes<unknown>;
+    /**
+     * Controls the overall result when indeterminate criteria are found
+     * (unknown rule types, or rule evaluators that return null)
+     * When true, indeterminate criteria will not fail the summary result
+     * When false, indeterminate criteria will fail the summary result, and the node will be hidden
+     */
+    showIndeterminate?: boolean;
+}
+/**
+ * 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.
+ *
+ * @deprecated beta functionality subject to change
+ */
+declare function evaluateWalkTreeVisibility({ rules, showIndeterminate, context, }: EvaluateNodeTreeVisibilityOptions): boolean | undefined;
+
+declare const CANVAS_VIZ_DI_RULE = "$di";
+declare function createDynamicInputVisibilityRule(dynamicInputs: Record<string, string>): VisibilityRules;
+
+type CoreStringOperators = 'is' | 'has' | 'startswith' | 'endswith' | 'empty';
+type StringOperators = CoreStringOperators | `!${CoreStringOperators}`;
+
+declare const CANVAS_VIZ_LOCALE_RULE = "$locale";
+declare function createLocaleVisibilityRule(currentLocale: string | undefined): VisibilityRules;
+
 /** API client to fetch entity across releases */
 declare class EntityReleasesClient extends ApiClient {
     constructor(options: ClientOptions);
@@ -26442,4 +26545,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, type BlockLocationReference, type BlockValue, CANVAS_BLOCK_PARAM_TYPE, 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, CanvasClient, CanvasClientError, type CanvasDefinitions, type CategoriesDeleteParameters, type CategoriesGetParameters, type CategoriesGetResponse, type CategoriesPutParameters, type Category, CategoryClient, type Channel, type ChannelMessage, type ChannelSubscription, 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 ComponentLocationReferenceV2, type ComponentOverridability, type ComponentOverride, type ComponentOverrides, type ComponentParameter, type ComponentParameterBlock, type ComponentParameterContextualEditing, type ComponentParameterEnhancer, type ComponentParameterEnhancerFunction, type ComponentParameterEnhancerOptions, type CompositionDataDiagnostic, type CompositionDeleteParameters, type CompositionDiagnostics, type CompositionFilters, type CompositionGetByComponentIdParameters, type CompositionGetByIdParameters, type CompositionGetByNodeIdParameters, type CompositionGetByNodePathParameters, type CompositionGetBySlugParameters, type CompositionGetListResponse, type CompositionGetOrderBy, type CompositionGetParameters, type CompositionGetResponse, type CompositionGetValidResponses, type CompositionIssue, type CompositionPatternIssue, type CompositionPutParameters, type CompositionResolvedGetResponse, type CompositionResolvedListResponse, type CompositionUIStatus, ContentClient, type ContentType, type ContentTypeField, type ContextualEditingComponentReference, 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 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 EventNames, type Filters, type FindInNodeTreeReference, type FlattenProperty, type FlattenValues, type FlattenValuesOptions, type GetContentTypesOptions, type GetContentTypesResponse, 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 LinkComponentParameterValue, type LinkParamConfiguration, type LinkParamValue, type LinkParameterType, type LinkTypeConfiguration, type Locale, LocaleClient, type LocaleDeleteParameters, type LocalePutParameters, type LocalesGetParameters, type LocalesGetResponse, type LocalizeDeprecatedOptions, type LocalizeModernOptions, type MessageHandler, type MoveComponentMessage, type NodeLocationReference, type NonProjectMapLinkParamValue, type OpenParameterEditorMessage, type OverrideOptions, PLACEHOLDER_ID, type PatternIssue, type PreviewEventBus, type PreviewPanelSettings, type ProjectMapLinkComponentParameterValue, type ProjectMapLinkParamValue, type Prompt, PromptClient, type PromptsDeleteParameters, type PromptsGetParameters, type PromptsGetResponse, type PromptsPutParameters, 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 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 SpecificProjectMap, type SubscribeToCompositionOptions, type SuggestComponentMessage, type TreeNodeInfoTypes, type TriggerComponentActionMessage, type TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, UncachedContentClient, UniqueBatchEntries, type UnsubscribeCallback, type UpdateComponentParameterMessage, type UpdateComponentReferencesMessage, type UpdateCompositionInternalMessage, type UpdateCompositionMessage, type UpdateContextualEditingStateInternalMessage, type UpdateFeatureFlagsMessage, type UpdatePreviewSettingsMessage, type WalkComponentTreeActions, type WalkNodeTreeActions, type WalkNodeTreeOptions, WorkflowClient, type WorkflowDefinition, type WorkflowStage, type WorkflowStagePermission, type WorkflowStageTransition, type WorkflowStageTransitionPermission, type WorkflowsDeleteParameters, type WorkflowsGetParameters, type WorkflowsGetResponse, type WorkflowsPutParameters, bindVariables, bindVariablesToObject, compose, convertEntryToPutEntry, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, createVariableReference, enhance, extractLocales, findParameterInNodeTree, flattenValues, generateComponentPlaceholderId, generateHash, getBlockValue, getChannelName, getComponentJsonPointer, getComponentPath, getLocalizedPropertyValues, getNounForLocation, getNounForNode, getParameterAttributes, getPropertiesValue, getPropertyValue, isAddComponentMessage, isAllowedReferrer, isAssetParamValue, isAssetParamValueItem, isComponentActionMessage, isComponentPlaceholderId, isDismissPlaceholderMessage, isEntryData, 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, subscribeToComposition, walkComponentTree, walkNodeTree };
+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, type BlockLocationReference, type BlockValue, CANVAS_BLOCK_PARAM_TYPE, 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_LOCALE_RULE, CanvasClient, CanvasClientError, type CanvasDefinitions, type CategoriesDeleteParameters, type CategoriesGetParameters, type CategoriesGetResponse, type CategoriesPutParameters, type Category, CategoryClient, type Channel, type ChannelMessage, type ChannelSubscription, 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 ComponentLocationReferenceV2, type ComponentOverridability, type ComponentOverride, type ComponentOverrides, type ComponentParameter, type ComponentParameterBlock, type ComponentParameterContextualEditing, type ComponentParameterEnhancer, type ComponentParameterEnhancerFunction, type ComponentParameterEnhancerOptions, type CompositionDataDiagnostic, type CompositionDeleteParameters, type CompositionDiagnostics, type CompositionFilters, type CompositionGetByComponentIdParameters, type CompositionGetByIdParameters, type CompositionGetByNodeIdParameters, type CompositionGetByNodePathParameters, type CompositionGetBySlugParameters, type CompositionGetListResponse, type CompositionGetOrderBy, type CompositionGetParameters, type CompositionGetResponse, type CompositionGetValidResponses, type CompositionIssue, type CompositionPatternIssue, type CompositionPutParameters, type CompositionResolvedGetResponse, type CompositionResolvedListResponse, type CompositionUIStatus, ContentClient, type ContentType, type ContentTypeField, type ContextualEditingComponentReference, 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 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 EventNames, type Filters, type FindInNodeTreeReference, type FlattenProperty, type FlattenValues, type FlattenValuesOptions, type GetContentTypesOptions, type GetContentTypesResponse, 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 LinkComponentParameterValue, type LinkParamConfiguration, type LinkParamValue, type LinkParameterType, type LinkTypeConfiguration, type Locale, LocaleClient, type LocaleDeleteParameters, type LocalePutParameters, type LocalesGetParameters, type LocalesGetResponse, type LocalizeDeprecatedOptions, type LocalizeModernOptions, type MessageHandler, type MoveComponentMessage, type NodeLocationReference, type NonProjectMapLinkParamValue, type OpenParameterEditorMessage, type OverrideOptions, PLACEHOLDER_ID, type PatternIssue, type PreviewEventBus, type PreviewPanelSettings, type ProjectMapLinkComponentParameterValue, type ProjectMapLinkParamValue, type Prompt, PromptClient, type PromptsDeleteParameters, type PromptsGetParameters, type PromptsGetResponse, type PromptsPutParameters, 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 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 SpecificProjectMap, type StringOperators, type SubscribeToCompositionOptions, type SuggestComponentMessage, type TreeNodeInfoTypes, type TriggerComponentActionMessage, type TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, UncachedContentClient, UniqueBatchEntries, type UnsubscribeCallback, 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 WalkComponentTreeActions, type WalkNodeTreeActions, type WalkNodeTreeOptions, WorkflowClient, type WorkflowDefinition, type WorkflowStage, type WorkflowStagePermission, type WorkflowStageTransition, type WorkflowStageTransitionPermission, type WorkflowsDeleteParameters, type WorkflowsGetParameters, type WorkflowsGetResponse, type WorkflowsPutParameters, bindVariables, bindVariablesToObject, compose, convertEntryToPutEntry, createBatchEnhancer, createCanvasChannel, createDynamicInputVisibilityRule, createEventBus, createLimitPolicy, createLocaleVisibilityRule, createUniformApiEnhancer, createVariableReference, enhance, evaluateVisibilityCriteriaGroup, evaluateWalkTreeVisibility, extractLocales, findParameterInNodeTree, flattenValues, generateComponentPlaceholderId, generateHash, getBlockValue, getChannelName, getComponentJsonPointer, getComponentPath, getLocalizedPropertyValues, getNounForLocation, getNounForNode, getParameterAttributes, getPropertiesValue, getPropertyValue, isAddComponentMessage, isAllowedReferrer, isAssetParamValue, isAssetParamValueItem, isComponentActionMessage, isComponentPlaceholderId, isDismissPlaceholderMessage, isEntryData, 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, subscribeToComposition, walkComponentTree, walkNodeTree };

package/dist/index.esm.js

@@ -1608,6 +1608,174 @@ function findParameterInNodeTree(data, predicate) {
   return results;
 }
 
+// src/enhancement/visibility/evaluateVisibilityCriteriaGroup.ts
+function evaluateVisibilityCriteriaGroup(options) {
+  const { criteriaGroup, simplifyCriteria } = options;
+  const earlyExitResult = criteriaGroup.op === "&" || !criteriaGroup.op ? false : true;
+  let hasIndeterminateClauses = false;
+  for (let index = criteriaGroup.clauses.length - 1; index >= 0; index--) {
+    const clause = criteriaGroup.clauses[index];
+    const criteriaResult = evaluateCriterion(clause, options);
+    if (criteriaResult === null) {
+      hasIndeterminateClauses = true;
+    } else if (criteriaResult === earlyExitResult) {
+      return earlyExitResult;
+    } else if (criteriaResult !== null && simplifyCriteria) {
+      criteriaGroup.clauses.splice(index, 1);
+    }
+  }
+  return hasIndeterminateClauses ? null : !earlyExitResult;
+}
+function evaluateCriterion(clause, rootOptions) {
+  if ("clauses" in clause) {
+    return evaluateVisibilityCriteriaGroup({
+      ...rootOptions,
+      criteriaGroup: clause
+    });
+  }
+  const rule = rootOptions.rules[clause.rule];
+  if (rule) {
+    return rule(clause);
+  }
+  return null;
+}
+
+// src/enhancement/visibility/types.ts
+var CANVAS_VIZ_CONTROL_PARAM = "$viz";
+
+// src/enhancement/visibility/evaluateNodeVisibility.ts
+function evaluateNodeVisibility({
+  node,
+  ...evaluateGroupOptions
+}) {
+  var _a;
+  const properties = getPropertiesValue(node);
+  const vizCriteria = (_a = properties == null ? void 0 : properties[CANVAS_VIZ_CONTROL_PARAM]) == null ? void 0 : _a.value;
+  if (vizCriteria == null ? void 0 : vizCriteria.explicitlyHidden) {
+    return false;
+  }
+  if (!(vizCriteria == null ? void 0 : vizCriteria.criteria)) {
+    return true;
+  }
+  const result = evaluateVisibilityCriteriaGroup({
+    ...evaluateGroupOptions,
+    criteriaGroup: vizCriteria.criteria
+  });
+  if (vizCriteria.criteria.clauses.length === 0 && evaluateGroupOptions.simplifyCriteria) {
+    properties == null ? true : delete properties[CANVAS_VIZ_CONTROL_PARAM];
+  }
+  return result;
+}
+
+// src/enhancement/visibility/evaluateWalkTreeVisibility.ts
+function evaluateWalkTreeVisibility({
+  rules,
+  showIndeterminate,
+  context
+}) {
+  const { type, node, actions } = context;
+  if (type !== "component") {
+    return;
+  }
+  const result = evaluateNodeVisibility({ node, rules, simplifyCriteria: true });
+  if (result === null && !showIndeterminate || result === false) {
+    actions.remove();
+    return false;
+  }
+  return true;
+}
+
+// src/enhancement/visibility/rules/evaluateStringMatch.ts
+var isEvaluator = (criteria, matchValue) => {
+  if (Array.isArray(criteria)) {
+    return criteria.includes(matchValue);
+  }
+  return criteria === matchValue;
+};
+var containsEvaluator = (criteria, matchValue) => {
+  if (Array.isArray(criteria)) {
+    return criteria.some((criterion) => matchValue.includes(criterion));
+  }
+  return matchValue.includes(criteria);
+};
+var startsWithEvaluator = (criteria, matchValue) => {
+  if (Array.isArray(criteria)) {
+    return criteria.some((criterion) => matchValue.startsWith(criterion));
+  }
+  return matchValue.startsWith(criteria);
+};
+var endsWithEvaluator = (criteria, matchValue) => {
+  if (Array.isArray(criteria)) {
+    return criteria.some((criterion) => matchValue.endsWith(criterion));
+  }
+  return matchValue.endsWith(criteria);
+};
+var emptyEvaluator = (_, matchValue) => {
+  return matchValue === "";
+};
+var stringOperatorEvaluators = {
+  is: isEvaluator,
+  has: containsEvaluator,
+  startswith: startsWithEvaluator,
+  endswith: endsWithEvaluator,
+  empty: emptyEvaluator
+};
+function evaluateStringMatch(criteria, matchValue, allow) {
+  const { op, value } = criteria;
+  if (allow && !allow.has(op)) {
+    return null;
+  }
+  let opMatch = op;
+  const negation = op.startsWith("!");
+  if (negation) {
+    opMatch = opMatch.slice(1);
+  }
+  const evaluator = stringOperatorEvaluators[opMatch];
+  if (!evaluator) {
+    return null;
+  }
+  const result = evaluator(value, matchValue);
+  return negation ? !result : result;
+}
+
+// src/enhancement/visibility/rules/dynamicInputVisibilityRule.ts
+var dynamicInputVisibilityOperators = /* @__PURE__ */ new Set([
+  "is",
+  "!is",
+  "has",
+  "!has",
+  "startswith",
+  "!startswith",
+  "endswith",
+  "!endswith",
+  "empty",
+  "!empty"
+]);
+var CANVAS_VIZ_DI_RULE = "$di";
+function createDynamicInputVisibilityRule(dynamicInputs) {
+  return {
+    [CANVAS_VIZ_DI_RULE]: (criterion) => {
+      const { source } = criterion;
+      const diValue = source ? dynamicInputs[source] : void 0;
+      return evaluateStringMatch(criterion, diValue != null ? diValue : "", dynamicInputVisibilityOperators);
+    }
+  };
+}
+
+// src/enhancement/visibility/rules/localeVisibilityRule.ts
+var localeVisibilityOperators = /* @__PURE__ */ new Set(["is", "!is"]);
+var CANVAS_VIZ_LOCALE_RULE = "$locale";
+function createLocaleVisibilityRule(currentLocale) {
+  return {
+    [CANVAS_VIZ_LOCALE_RULE]: (criterion) => {
+      if (!currentLocale) {
+        return false;
+      }
+      return evaluateStringMatch(criterion, currentLocale, localeVisibilityOperators);
+    }
+  };
+}
+
 // src/enhancement/localize.ts
 function extractLocales({ component }) {
   var _a;
@@ -1626,17 +1794,29 @@ function extractLocales({ component }) {
 function localize(options) {
   const nodes = "nodes" in options ? options.nodes : options.composition;
   const locale = options.locale;
-  walkNodeTree(nodes, ({ type, node, actions }) => {
+  const isUsingModernOptions = typeof locale === "string";
+  const vizControlLocaleRule = isUsingModernOptions ? createLocaleVisibilityRule(locale) : {};
+  walkNodeTree(nodes, (context) => {
+    const { type, node, actions } = context;
     if (type !== "component") {
-      if (typeof locale === "string") {
+      if (isUsingModernOptions) {
         localizeProperties(node.fields, locale);
       }
       return;
     }
-    const shouldRunPropertyLocalization = typeof locale === "string";
+    if (isUsingModernOptions) {
+      const result = evaluateWalkTreeVisibility({
+        context,
+        rules: vizControlLocaleRule,
+        showIndeterminate: true
+      });
+      if (!result) {
+        return;
+      }
+    }
     if (node.type === CANVAS_LOCALIZATION_TYPE) {
       const locales = extractLocales({ component: node });
-      const resolvedLocale = typeof locale === "string" ? locale : locale == null ? void 0 : locale({ component: node, locales });
+      const resolvedLocale = isUsingModernOptions ? locale : locale == null ? void 0 : locale({ component: node, locales });
       let replaceComponent;
       if (resolvedLocale) {
         replaceComponent = locales[resolvedLocale];
@@ -1644,7 +1824,7 @@ function localize(options) {
       if (replaceComponent == null ? void 0 : replaceComponent.length) {
         replaceComponent.forEach((component) => {
           removeLocaleProperty(component);
-          if (shouldRunPropertyLocalization) {
+          if (isUsingModernOptions) {
             localizeProperties(getPropertiesValue(component), locale);
           }
         });
@@ -1656,7 +1836,7 @@ function localize(options) {
       } else {
         actions.remove();
       }
-    } else if (shouldRunPropertyLocalization) {
+    } else if (isUsingModernOptions) {
       localizeProperties(getPropertiesValue(node), locale);
     }
   });
@@ -2825,6 +3005,9 @@ export {
   CANVAS_TEST_SLOT,
   CANVAS_TEST_TYPE,
   CANVAS_TEST_VARIANT_PARAM,
+  CANVAS_VIZ_CONTROL_PARAM,
+  CANVAS_VIZ_DI_RULE,
+  CANVAS_VIZ_LOCALE_RULE,
   CanvasClient,
   CanvasClientError,
   CategoryClient,
@@ -2867,11 +3050,15 @@ export {
   convertEntryToPutEntry,
   createBatchEnhancer,
   createCanvasChannel,
+  createDynamicInputVisibilityRule,
   createEventBus,
   createLimitPolicy,
+  createLocaleVisibilityRule,
   createUniformApiEnhancer,
   createVariableReference,
   enhance,
+  evaluateVisibilityCriteriaGroup,
+  evaluateWalkTreeVisibility,
   extractLocales,
   findParameterInNodeTree,
   flattenValues,

package/dist/index.js

@@ -305,6 +305,9 @@ __export(src_exports, {
   CANVAS_TEST_SLOT: () => CANVAS_TEST_SLOT,
   CANVAS_TEST_TYPE: () => CANVAS_TEST_TYPE,
   CANVAS_TEST_VARIANT_PARAM: () => CANVAS_TEST_VARIANT_PARAM,
+  CANVAS_VIZ_CONTROL_PARAM: () => CANVAS_VIZ_CONTROL_PARAM,
+  CANVAS_VIZ_DI_RULE: () => CANVAS_VIZ_DI_RULE,
+  CANVAS_VIZ_LOCALE_RULE: () => CANVAS_VIZ_LOCALE_RULE,
   CanvasClient: () => CanvasClient,
   CanvasClientError: () => CanvasClientError,
   CategoryClient: () => CategoryClient,
@@ -347,11 +350,15 @@ __export(src_exports, {
   convertEntryToPutEntry: () => convertEntryToPutEntry,
   createBatchEnhancer: () => createBatchEnhancer,
   createCanvasChannel: () => createCanvasChannel,
+  createDynamicInputVisibilityRule: () => createDynamicInputVisibilityRule,
   createEventBus: () => createEventBus,
   createLimitPolicy: () => createLimitPolicy,
+  createLocaleVisibilityRule: () => createLocaleVisibilityRule,
   createUniformApiEnhancer: () => createUniformApiEnhancer,
   createVariableReference: () => createVariableReference,
   enhance: () => enhance,
+  evaluateVisibilityCriteriaGroup: () => evaluateVisibilityCriteriaGroup,
+  evaluateWalkTreeVisibility: () => evaluateWalkTreeVisibility,
   extractLocales: () => extractLocales,
   findParameterInNodeTree: () => findParameterInNodeTree,
   flattenValues: () => flattenValues,
@@ -1746,6 +1753,174 @@ function findParameterInNodeTree(data, predicate) {
   return results;
 }
 
+// src/enhancement/visibility/evaluateVisibilityCriteriaGroup.ts
+function evaluateVisibilityCriteriaGroup(options) {
+  const { criteriaGroup, simplifyCriteria } = options;
+  const earlyExitResult = criteriaGroup.op === "&" || !criteriaGroup.op ? false : true;
+  let hasIndeterminateClauses = false;
+  for (let index = criteriaGroup.clauses.length - 1; index >= 0; index--) {
+    const clause = criteriaGroup.clauses[index];
+    const criteriaResult = evaluateCriterion(clause, options);
+    if (criteriaResult === null) {
+      hasIndeterminateClauses = true;
+    } else if (criteriaResult === earlyExitResult) {
+      return earlyExitResult;
+    } else if (criteriaResult !== null && simplifyCriteria) {
+      criteriaGroup.clauses.splice(index, 1);
+    }
+  }
+  return hasIndeterminateClauses ? null : !earlyExitResult;
+}
+function evaluateCriterion(clause, rootOptions) {
+  if ("clauses" in clause) {
+    return evaluateVisibilityCriteriaGroup({
+      ...rootOptions,
+      criteriaGroup: clause
+    });
+  }
+  const rule = rootOptions.rules[clause.rule];
+  if (rule) {
+    return rule(clause);
+  }
+  return null;
+}
+
+// src/enhancement/visibility/types.ts
+var CANVAS_VIZ_CONTROL_PARAM = "$viz";
+
+// src/enhancement/visibility/evaluateNodeVisibility.ts
+function evaluateNodeVisibility({
+  node,
+  ...evaluateGroupOptions
+}) {
+  var _a;
+  const properties = getPropertiesValue(node);
+  const vizCriteria = (_a = properties == null ? void 0 : properties[CANVAS_VIZ_CONTROL_PARAM]) == null ? void 0 : _a.value;
+  if (vizCriteria == null ? void 0 : vizCriteria.explicitlyHidden) {
+    return false;
+  }
+  if (!(vizCriteria == null ? void 0 : vizCriteria.criteria)) {
+    return true;
+  }
+  const result = evaluateVisibilityCriteriaGroup({
+    ...evaluateGroupOptions,
+    criteriaGroup: vizCriteria.criteria
+  });
+  if (vizCriteria.criteria.clauses.length === 0 && evaluateGroupOptions.simplifyCriteria) {
+    properties == null ? true : delete properties[CANVAS_VIZ_CONTROL_PARAM];
+  }
+  return result;
+}
+
+// src/enhancement/visibility/evaluateWalkTreeVisibility.ts
+function evaluateWalkTreeVisibility({
+  rules,
+  showIndeterminate,
+  context
+}) {
+  const { type, node, actions } = context;
+  if (type !== "component") {
+    return;
+  }
+  const result = evaluateNodeVisibility({ node, rules, simplifyCriteria: true });
+  if (result === null && !showIndeterminate || result === false) {
+    actions.remove();
+    return false;
+  }
+  return true;
+}
+
+// src/enhancement/visibility/rules/evaluateStringMatch.ts
+var isEvaluator = (criteria, matchValue) => {
+  if (Array.isArray(criteria)) {
+    return criteria.includes(matchValue);
+  }
+  return criteria === matchValue;
+};
+var containsEvaluator = (criteria, matchValue) => {
+  if (Array.isArray(criteria)) {
+    return criteria.some((criterion) => matchValue.includes(criterion));
+  }
+  return matchValue.includes(criteria);
+};
+var startsWithEvaluator = (criteria, matchValue) => {
+  if (Array.isArray(criteria)) {
+    return criteria.some((criterion) => matchValue.startsWith(criterion));
+  }
+  return matchValue.startsWith(criteria);
+};
+var endsWithEvaluator = (criteria, matchValue) => {
+  if (Array.isArray(criteria)) {
+    return criteria.some((criterion) => matchValue.endsWith(criterion));
+  }
+  return matchValue.endsWith(criteria);
+};
+var emptyEvaluator = (_, matchValue) => {
+  return matchValue === "";
+};
+var stringOperatorEvaluators = {
+  is: isEvaluator,
+  has: containsEvaluator,
+  startswith: startsWithEvaluator,
+  endswith: endsWithEvaluator,
+  empty: emptyEvaluator
+};
+function evaluateStringMatch(criteria, matchValue, allow) {
+  const { op, value } = criteria;
+  if (allow && !allow.has(op)) {
+    return null;
+  }
+  let opMatch = op;
+  const negation = op.startsWith("!");
+  if (negation) {
+    opMatch = opMatch.slice(1);
+  }
+  const evaluator = stringOperatorEvaluators[opMatch];
+  if (!evaluator) {
+    return null;
+  }
+  const result = evaluator(value, matchValue);
+  return negation ? !result : result;
+}
+
+// src/enhancement/visibility/rules/dynamicInputVisibilityRule.ts
+var dynamicInputVisibilityOperators = /* @__PURE__ */ new Set([
+  "is",
+  "!is",
+  "has",
+  "!has",
+  "startswith",
+  "!startswith",
+  "endswith",
+  "!endswith",
+  "empty",
+  "!empty"
+]);
+var CANVAS_VIZ_DI_RULE = "$di";
+function createDynamicInputVisibilityRule(dynamicInputs) {
+  return {
+    [CANVAS_VIZ_DI_RULE]: (criterion) => {
+      const { source } = criterion;
+      const diValue = source ? dynamicInputs[source] : void 0;
+      return evaluateStringMatch(criterion, diValue != null ? diValue : "", dynamicInputVisibilityOperators);
+    }
+  };
+}
+
+// src/enhancement/visibility/rules/localeVisibilityRule.ts
+var localeVisibilityOperators = /* @__PURE__ */ new Set(["is", "!is"]);
+var CANVAS_VIZ_LOCALE_RULE = "$locale";
+function createLocaleVisibilityRule(currentLocale) {
+  return {
+    [CANVAS_VIZ_LOCALE_RULE]: (criterion) => {
+      if (!currentLocale) {
+        return false;
+      }
+      return evaluateStringMatch(criterion, currentLocale, localeVisibilityOperators);
+    }
+  };
+}
+
 // src/enhancement/localize.ts
 function extractLocales({ component }) {
   var _a;
@@ -1764,17 +1939,29 @@ function extractLocales({ component }) {
 function localize(options) {
   const nodes = "nodes" in options ? options.nodes : options.composition;
   const locale = options.locale;
-  walkNodeTree(nodes, ({ type, node, actions }) => {
+  const isUsingModernOptions = typeof locale === "string";
+  const vizControlLocaleRule = isUsingModernOptions ? createLocaleVisibilityRule(locale) : {};
+  walkNodeTree(nodes, (context) => {
+    const { type, node, actions } = context;
     if (type !== "component") {
-      if (typeof locale === "string") {
+      if (isUsingModernOptions) {
         localizeProperties(node.fields, locale);
       }
       return;
     }
-    const shouldRunPropertyLocalization = typeof locale === "string";
+    if (isUsingModernOptions) {
+      const result = evaluateWalkTreeVisibility({
+        context,
+        rules: vizControlLocaleRule,
+        showIndeterminate: true
+      });
+      if (!result) {
+        return;
+      }
+    }
     if (node.type === CANVAS_LOCALIZATION_TYPE) {
       const locales = extractLocales({ component: node });
-      const resolvedLocale = typeof locale === "string" ? locale : locale == null ? void 0 : locale({ component: node, locales });
+      const resolvedLocale = isUsingModernOptions ? locale : locale == null ? void 0 : locale({ component: node, locales });
       let replaceComponent;
       if (resolvedLocale) {
         replaceComponent = locales[resolvedLocale];
@@ -1782,7 +1969,7 @@ function localize(options) {
       if (replaceComponent == null ? void 0 : replaceComponent.length) {
         replaceComponent.forEach((component) => {
           removeLocaleProperty(component);
-          if (shouldRunPropertyLocalization) {
+          if (isUsingModernOptions) {
             localizeProperties(getPropertiesValue(component), locale);
           }
         });
@@ -1794,7 +1981,7 @@ function localize(options) {
       } else {
         actions.remove();
       }
-    } else if (shouldRunPropertyLocalization) {
+    } else if (isUsingModernOptions) {
       localizeProperties(getPropertiesValue(node), locale);
     }
   });
@@ -2964,6 +3151,9 @@ var CanvasClientError = import_api15.ApiClientError;
   CANVAS_TEST_SLOT,
   CANVAS_TEST_TYPE,
   CANVAS_TEST_VARIANT_PARAM,
+  CANVAS_VIZ_CONTROL_PARAM,
+  CANVAS_VIZ_DI_RULE,
+  CANVAS_VIZ_LOCALE_RULE,
   CanvasClient,
   CanvasClientError,
   CategoryClient,
@@ -3006,11 +3196,15 @@ var CanvasClientError = import_api15.ApiClientError;
   convertEntryToPutEntry,
   createBatchEnhancer,
   createCanvasChannel,
+  createDynamicInputVisibilityRule,
   createEventBus,
   createLimitPolicy,
+  createLocaleVisibilityRule,
   createUniformApiEnhancer,
   createVariableReference,
   enhance,
+  evaluateVisibilityCriteriaGroup,
+  evaluateWalkTreeVisibility,
   extractLocales,
   findParameterInNodeTree,
   flattenValues,

package/dist/index.mjs

@@ -1608,6 +1608,174 @@ function findParameterInNodeTree(data, predicate) {
   return results;
 }
 
+// src/enhancement/visibility/evaluateVisibilityCriteriaGroup.ts
+function evaluateVisibilityCriteriaGroup(options) {
+  const { criteriaGroup, simplifyCriteria } = options;
+  const earlyExitResult = criteriaGroup.op === "&" || !criteriaGroup.op ? false : true;
+  let hasIndeterminateClauses = false;
+  for (let index = criteriaGroup.clauses.length - 1; index >= 0; index--) {
+    const clause = criteriaGroup.clauses[index];
+    const criteriaResult = evaluateCriterion(clause, options);
+    if (criteriaResult === null) {
+      hasIndeterminateClauses = true;
+    } else if (criteriaResult === earlyExitResult) {
+      return earlyExitResult;
+    } else if (criteriaResult !== null && simplifyCriteria) {
+      criteriaGroup.clauses.splice(index, 1);
+    }
+  }
+  return hasIndeterminateClauses ? null : !earlyExitResult;
+}
+function evaluateCriterion(clause, rootOptions) {
+  if ("clauses" in clause) {
+    return evaluateVisibilityCriteriaGroup({
+      ...rootOptions,
+      criteriaGroup: clause
+    });
+  }
+  const rule = rootOptions.rules[clause.rule];
+  if (rule) {
+    return rule(clause);
+  }
+  return null;
+}
+
+// src/enhancement/visibility/types.ts
+var CANVAS_VIZ_CONTROL_PARAM = "$viz";
+
+// src/enhancement/visibility/evaluateNodeVisibility.ts
+function evaluateNodeVisibility({
+  node,
+  ...evaluateGroupOptions
+}) {
+  var _a;
+  const properties = getPropertiesValue(node);
+  const vizCriteria = (_a = properties == null ? void 0 : properties[CANVAS_VIZ_CONTROL_PARAM]) == null ? void 0 : _a.value;
+  if (vizCriteria == null ? void 0 : vizCriteria.explicitlyHidden) {
+    return false;
+  }
+  if (!(vizCriteria == null ? void 0 : vizCriteria.criteria)) {
+    return true;
+  }
+  const result = evaluateVisibilityCriteriaGroup({
+    ...evaluateGroupOptions,
+    criteriaGroup: vizCriteria.criteria
+  });
+  if (vizCriteria.criteria.clauses.length === 0 && evaluateGroupOptions.simplifyCriteria) {
+    properties == null ? true : delete properties[CANVAS_VIZ_CONTROL_PARAM];
+  }
+  return result;
+}
+
+// src/enhancement/visibility/evaluateWalkTreeVisibility.ts
+function evaluateWalkTreeVisibility({
+  rules,
+  showIndeterminate,
+  context
+}) {
+  const { type, node, actions } = context;
+  if (type !== "component") {
+    return;
+  }
+  const result = evaluateNodeVisibility({ node, rules, simplifyCriteria: true });
+  if (result === null && !showIndeterminate || result === false) {
+    actions.remove();
+    return false;
+  }
+  return true;
+}
+
+// src/enhancement/visibility/rules/evaluateStringMatch.ts
+var isEvaluator = (criteria, matchValue) => {
+  if (Array.isArray(criteria)) {
+    return criteria.includes(matchValue);
+  }
+  return criteria === matchValue;
+};
+var containsEvaluator = (criteria, matchValue) => {
+  if (Array.isArray(criteria)) {
+    return criteria.some((criterion) => matchValue.includes(criterion));
+  }
+  return matchValue.includes(criteria);
+};
+var startsWithEvaluator = (criteria, matchValue) => {
+  if (Array.isArray(criteria)) {
+    return criteria.some((criterion) => matchValue.startsWith(criterion));
+  }
+  return matchValue.startsWith(criteria);
+};
+var endsWithEvaluator = (criteria, matchValue) => {
+  if (Array.isArray(criteria)) {
+    return criteria.some((criterion) => matchValue.endsWith(criterion));
+  }
+  return matchValue.endsWith(criteria);
+};
+var emptyEvaluator = (_, matchValue) => {
+  return matchValue === "";
+};
+var stringOperatorEvaluators = {
+  is: isEvaluator,
+  has: containsEvaluator,
+  startswith: startsWithEvaluator,
+  endswith: endsWithEvaluator,
+  empty: emptyEvaluator
+};
+function evaluateStringMatch(criteria, matchValue, allow) {
+  const { op, value } = criteria;
+  if (allow && !allow.has(op)) {
+    return null;
+  }
+  let opMatch = op;
+  const negation = op.startsWith("!");
+  if (negation) {
+    opMatch = opMatch.slice(1);
+  }
+  const evaluator = stringOperatorEvaluators[opMatch];
+  if (!evaluator) {
+    return null;
+  }
+  const result = evaluator(value, matchValue);
+  return negation ? !result : result;
+}
+
+// src/enhancement/visibility/rules/dynamicInputVisibilityRule.ts
+var dynamicInputVisibilityOperators = /* @__PURE__ */ new Set([
+  "is",
+  "!is",
+  "has",
+  "!has",
+  "startswith",
+  "!startswith",
+  "endswith",
+  "!endswith",
+  "empty",
+  "!empty"
+]);
+var CANVAS_VIZ_DI_RULE = "$di";
+function createDynamicInputVisibilityRule(dynamicInputs) {
+  return {
+    [CANVAS_VIZ_DI_RULE]: (criterion) => {
+      const { source } = criterion;
+      const diValue = source ? dynamicInputs[source] : void 0;
+      return evaluateStringMatch(criterion, diValue != null ? diValue : "", dynamicInputVisibilityOperators);
+    }
+  };
+}
+
+// src/enhancement/visibility/rules/localeVisibilityRule.ts
+var localeVisibilityOperators = /* @__PURE__ */ new Set(["is", "!is"]);
+var CANVAS_VIZ_LOCALE_RULE = "$locale";
+function createLocaleVisibilityRule(currentLocale) {
+  return {
+    [CANVAS_VIZ_LOCALE_RULE]: (criterion) => {
+      if (!currentLocale) {
+        return false;
+      }
+      return evaluateStringMatch(criterion, currentLocale, localeVisibilityOperators);
+    }
+  };
+}
+
 // src/enhancement/localize.ts
 function extractLocales({ component }) {
   var _a;
@@ -1626,17 +1794,29 @@ function extractLocales({ component }) {
 function localize(options) {
   const nodes = "nodes" in options ? options.nodes : options.composition;
   const locale = options.locale;
-  walkNodeTree(nodes, ({ type, node, actions }) => {
+  const isUsingModernOptions = typeof locale === "string";
+  const vizControlLocaleRule = isUsingModernOptions ? createLocaleVisibilityRule(locale) : {};
+  walkNodeTree(nodes, (context) => {
+    const { type, node, actions } = context;
     if (type !== "component") {
-      if (typeof locale === "string") {
+      if (isUsingModernOptions) {
         localizeProperties(node.fields, locale);
       }
       return;
     }
-    const shouldRunPropertyLocalization = typeof locale === "string";
+    if (isUsingModernOptions) {
+      const result = evaluateWalkTreeVisibility({
+        context,
+        rules: vizControlLocaleRule,
+        showIndeterminate: true
+      });
+      if (!result) {
+        return;
+      }
+    }
     if (node.type === CANVAS_LOCALIZATION_TYPE) {
       const locales = extractLocales({ component: node });
-      const resolvedLocale = typeof locale === "string" ? locale : locale == null ? void 0 : locale({ component: node, locales });
+      const resolvedLocale = isUsingModernOptions ? locale : locale == null ? void 0 : locale({ component: node, locales });
       let replaceComponent;
       if (resolvedLocale) {
         replaceComponent = locales[resolvedLocale];
@@ -1644,7 +1824,7 @@ function localize(options) {
       if (replaceComponent == null ? void 0 : replaceComponent.length) {
         replaceComponent.forEach((component) => {
           removeLocaleProperty(component);
-          if (shouldRunPropertyLocalization) {
+          if (isUsingModernOptions) {
             localizeProperties(getPropertiesValue(component), locale);
           }
         });
@@ -1656,7 +1836,7 @@ function localize(options) {
       } else {
         actions.remove();
       }
-    } else if (shouldRunPropertyLocalization) {
+    } else if (isUsingModernOptions) {
       localizeProperties(getPropertiesValue(node), locale);
     }
   });
@@ -2825,6 +3005,9 @@ export {
   CANVAS_TEST_SLOT,
   CANVAS_TEST_TYPE,
   CANVAS_TEST_VARIANT_PARAM,
+  CANVAS_VIZ_CONTROL_PARAM,
+  CANVAS_VIZ_DI_RULE,
+  CANVAS_VIZ_LOCALE_RULE,
   CanvasClient,
   CanvasClientError,
   CategoryClient,
@@ -2867,11 +3050,15 @@ export {
   convertEntryToPutEntry,
   createBatchEnhancer,
   createCanvasChannel,
+  createDynamicInputVisibilityRule,
   createEventBus,
   createLimitPolicy,
+  createLocaleVisibilityRule,
   createUniformApiEnhancer,
   createVariableReference,
   enhance,
+  evaluateVisibilityCriteriaGroup,
+  evaluateWalkTreeVisibility,
   extractLocales,
   findParameterInNodeTree,
   flattenValues,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uniformdev/canvas",
-  "version": "19.164.0",
+  "version": "19.165.1-alpha.0+f8f7ef22e4",
   "description": "Common functionality and types for Uniform Canvas",
   "license": "SEE LICENSE IN LICENSE.txt",
   "main": "./dist/index.js",
@@ -38,8 +38,8 @@
     "pusher-js": "8.2.0"
   },
   "dependencies": {
-    "@uniformdev/assets": "19.164.0",
-    "@uniformdev/context": "19.164.0",
+    "@uniformdev/assets": "19.165.1-alpha.0+f8f7ef22e4",
+    "@uniformdev/context": "19.165.1-alpha.0+f8f7ef22e4",
     "immer": "10.0.4"
   },
   "files": [
@@ -48,5 +48,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "016e3b85373592ca9beb19593aa120247b638c06"
+  "gitHead": "f8f7ef22e4180653122a8f30f8c184acc8e5b25b"
 }