@gooddata/sdk-ui-kit 11.13.0-alpha.2 → 11.13.0-alpha.4

package/esm/sdk-ui-kit.d.ts

@@ -121,6 +121,12 @@ export declare function AddGranteeBase({ appliedGrantees, addedGrantees, current
  */
 export declare type AddMessageType = (message: MessageDescriptor, options?: MessageParameters) => IMessage;
 
+/**
+ * Advanced format template definitions (complex conditional formats).
+ * @internal
+ */
+export declare const ADVANCED_TEMPLATE_DEFINITIONS: readonly ITemplateDefinition[];
+
 /**
  * @internal
  */
@@ -468,16 +474,54 @@ export declare function ContentDivider({ className }: {
  */
 export declare type CopyCodeOriginType = "keyboard" | "button";
 
+/**
+ * Creates all localized format templates (standard + currency + advanced).
+ *
+ * @param formatMessage - Function to format localized messages (e.g., from react-intl)
+ * @param messageIdPrefix - Optional prefix for message IDs (default: "metricComponent.numberFormat.template")
+ * @returns Array of all format templates with localized names
+ * @internal
+ */
+export declare function createAllTemplates(formatMessage: (descriptor: {
+    id: string;
+}) => string, messageIdPrefix?: string): IFormatTemplate[];
+
 /**
  * Creates localized currency format presets.
  *
  * @param formatMessage - Function to format localized messages (e.g., from react-intl)
+ * @param messageIdPrefix - Optional prefix for message IDs (default: "metricComponent.numberFormat.preset")
  * @returns Array of currency format presets with localized names
  * @internal
  */
 export declare function createCurrencyPresets(formatMessage: (descriptor: {
     id: string;
-}) => string): IFormatPreset[];
+}) => string, messageIdPrefix?: string): IFormatPreset[];
+
+/**
+ * Creates localized standard format presets.
+ *
+ * @param formatMessage - Function to format localized messages (e.g., from react-intl)
+ * @param messageIdPrefix - Optional prefix for message IDs (default: "metricComponent.numberFormat.preset")
+ * @returns Array of standard format presets with localized names
+ * @internal
+ */
+export declare function createStandardPresets(formatMessage: (descriptor: {
+    id: string;
+}) => string, messageIdPrefix?: string): IFormatPreset[];
+
+/**
+ * Creates localized format templates.
+ *
+ * @param formatMessage - Function to format localized messages (e.g., from react-intl)
+ * @param definitions - Template definitions to localize
+ * @param messageIdPrefix - Optional prefix for message IDs (default: "metricComponent.numberFormat.template")
+ * @returns Array of format templates with localized names
+ * @internal
+ */
+export declare function createTemplates(formatMessage: (descriptor: {
+    id: string;
+}) => string, definitions: readonly ITemplateDefinition[], messageIdPrefix?: string): IFormatTemplate[];
 
 /**
  * Base currency preset definitions.
@@ -486,6 +530,19 @@ export declare function createCurrencyPresets(formatMessage: (descriptor: {
  */
 export declare const CURRENCY_PRESET_DEFINITIONS: readonly ICurrencyPresetDefinition[];
 
+/**
+ * Currency format template definitions.
+ * @internal
+ */
+export declare const CURRENCY_TEMPLATE_DEFINITIONS: readonly ITemplateDefinition[];
+
+/**
+ * Local identifiers of templates that are currency-specific.
+ * Used to filter templates when metric type is CURRENCY.
+ * @internal
+ */
+export declare const CURRENCY_TEMPLATE_IDS: string[];
+
 /**
  * @alpha
  */
@@ -515,6 +572,12 @@ export declare class Datepicker extends PureComponent<IDatePickerOwnProps> {
     render(): JSX.Element;
 }
 
+/**
+ * Default message ID prefix for currency preset definitions.
+ * @internal
+ */
+export declare const DEFAULT_CURRENCY_PRESET_PREFIX = "metricComponent.numberFormat.preset";
+
 /**
  * @internal
  */
@@ -525,6 +588,18 @@ export declare const DEFAULT_ITEM_HEIGHT = 28;
  */
 export declare const DEFAULT_MOBILE_ITEM_HEIGHT = 40;
 
+/**
+ * Default message ID prefix for standard preset definitions.
+ * @internal
+ */
+export declare const DEFAULT_STANDARD_PRESET_PREFIX = "metricComponent.numberFormat.preset";
+
+/**
+ * Default message ID prefix for template definitions.
+ * @internal
+ */
+export declare const DEFAULT_TEMPLATE_PREFIX = "metricComponent.numberFormat.template";
+
 /**
  * Dummy theme metadata object which represents the default colors of GD.
  *
@@ -3631,6 +3706,7 @@ export declare interface IInvertableSelectProps<T> {
     searchString?: string;
     searchPlaceholder?: string;
     onSearch?: (search: string) => void;
+    onEscKeyPress?: (e: KeyboardEvent_2) => void;
     error?: any;
     isLoading?: boolean;
     nextPageItemPlaceholdersCount?: number;
@@ -3720,6 +3796,7 @@ export declare interface IInvertableSelectRenderSearchBarProps {
     searchString?: string;
     searchPlaceholder?: string;
     onSearch: (searchString: string) => void;
+    onEscKeyPress?: (e: KeyboardEvent_2) => void;
 }
 
 /**
@@ -3741,6 +3818,7 @@ export declare interface IInvertableSelectSearchBarProps {
     searchString?: string;
     searchPlaceholder?: string;
     onSearch: (searchString: string) => void;
+    onEscKeyPress?: (e: KeyboardEvent_2) => void;
 }
 
 /**
@@ -4584,7 +4662,7 @@ export declare function InvertableSelectLimitWarning({ limit, selectedItemsCount
 /**
  * @internal
  */
-export declare function InvertableSelectSearchBar({ className, isSmall, searchString, onSearch, searchPlaceholder, }: IInvertableSelectSearchBarProps): JSX.Element;
+export declare function InvertableSelectSearchBar({ className, isSmall, searchString, onSearch, onEscKeyPress, searchPlaceholder, }: IInvertableSelectSearchBarProps): JSX.Element;
 
 /**
  * @internal
@@ -5399,6 +5477,17 @@ export declare const isSpaceKey: (event: KeyboardEvent_2) => boolean;
  */
 export declare const isTabKey: (event: KeyboardEvent_2) => boolean;
 
+/**
+ * Base standard preset definition without localized name.
+ * @internal
+ */
+export declare interface IStandardPresetDefinition {
+    localIdentifier: string;
+    format: string;
+    previewNumber: number;
+    messageId: string;
+}
+
 /**
  * @internal
  */
@@ -5540,6 +5629,16 @@ export declare interface ITabsState {
  */
 export declare function Item({ checked, subMenu, disabled, className, children, style, onClick, }: IItemProps): JSX.Element;
 
+/**
+ * Base template definition without localized name.
+ * @internal
+ */
+export declare interface ITemplateDefinition {
+    localIdentifier: string;
+    format: string;
+    messageId: string;
+}
+
 /**
  * @internal
  */
@@ -7047,6 +7146,19 @@ export declare const Spinner: NamedExoticComponent<ISpinnerProps>;
  */
 export declare type SpinnerSize = "large" | "small";
 
+/**
+ * Standard numeric preset definitions.
+ * These are the raw preset data that can be used to create localized presets.
+ * @internal
+ */
+export declare const STANDARD_PRESET_DEFINITIONS: readonly IStandardPresetDefinition[];
+
+/**
+ * Standard format template definitions (basic numeric formats).
+ * @internal
+ */
+export declare const STANDARD_TEMPLATE_DEFINITIONS: readonly ITemplateDefinition[];
+
 /**
  * Properties for BEM modifiers.
  *
@@ -8324,6 +8436,19 @@ export declare function useFocusWithinContainer(idToFocus?: string | null): {
     containerRef: RefObject<HTMLElement | null>;
 };
 
+/**
+ * Hook that creates all format templates.
+ * Use this when you need templates without metric type filtering.
+ *
+ * @param formatMessage - Function to format localized messages
+ * @param excludeCurrencyTemplates - Whether to exclude currency-specific templates
+ * @returns Array of format templates
+ * @internal
+ */
+export declare function useFormatTemplates(formatMessage: (descriptor: {
+    id: string;
+}) => string, excludeCurrencyTemplates?: boolean): IFormatTemplate[];
+
 /**
  * Internal context hook used to provide header search drop-down state to the components.
  * @internal
@@ -8399,6 +8524,98 @@ export declare function useListWithActionsKeyboardNavigation<Item, Action extend
  */
 export declare const useMediaQuery: (mediaQueryName: keyof IMediaQueries) => boolean;
 
+/**
+ * Hook that creates format presets and templates based on metric type.
+ *
+ * This hook encapsulates the logic for building format options that respect:
+ * - Metric type (CURRENCY vs standard)
+ * - Currency format override (creates "inherit" preset)
+ *
+ * @example
+ * ```tsx
+ * const { presets, templates, inheritPreset } = useMetricTypePresets({
+ *   metricType: "CURRENCY",
+ *   currencyFormatOverride: "$#,##0.00",
+ *   formatMessage: (d) => intl.formatMessage(d),
+ * });
+ * ```
+ *
+ * @example
+ * ```tsx
+ * // With custom message ID prefixes (e.g., for Analytical Designer)
+ * const { presets, templates } = useMetricTypePresets({
+ *   metricType: undefined,
+ *   formatMessage: (d) => intl.formatMessage(d),
+ *   presetMessageIdPrefix: "measure_number_format.preset",
+ *   templateMessageIdPrefix: "measure_number_format.template",
+ * });
+ * ```
+ *
+ * @internal
+ */
+export declare function useMetricTypePresets({ metricType, currencyFormatOverride, formatMessage, presetMessageIdPrefix, templateMessageIdPrefix, }: UseMetricTypePresetsConfig): UseMetricTypePresetsResult;
+
+/**
+ * Configuration for the useMetricTypePresets hook.
+ * @internal
+ */
+export declare interface UseMetricTypePresetsConfig {
+    /**
+     * The metric type. When "CURRENCY", currency-specific presets are shown.
+     * When undefined, standard numeric presets are shown.
+     */
+    metricType?: MetricType;
+    /**
+     * The currency format override from workspace settings.
+     * When set and metricType is "CURRENCY", an "inherit" preset is added.
+     */
+    currencyFormatOverride?: string | null;
+    /**
+     * Function to format localized messages (e.g., from react-intl).
+     */
+    formatMessage: (descriptor: {
+        id: string;
+    }) => string;
+    /**
+     * Optional prefix for preset message IDs.
+     * Default: "metricComponent.numberFormat.preset"
+     *
+     * Use this to customize the translation keys for presets.
+     * For example, set to "measure_number_format.preset" for Analytical Designer compatibility.
+     */
+    presetMessageIdPrefix?: string;
+    /**
+     * Optional prefix for template message IDs.
+     * Default: "metricComponent.numberFormat.template"
+     *
+     * Use this to customize the translation keys for templates.
+     * For example, set to "measure_number_format.template" for Analytical Designer compatibility.
+     */
+    templateMessageIdPrefix?: string;
+}
+
+/**
+ * Result from the useMetricTypePresets hook.
+ * @internal
+ */
+export declare interface UseMetricTypePresetsResult {
+    /**
+     * Format presets based on metric type.
+     * For CURRENCY: currency presets with optional inherit preset.
+     * For other types: standard numeric presets.
+     */
+    presets: IFormatPreset[];
+    /**
+     * Format templates. For CURRENCY metrics, currency templates are excluded
+     * from the general list (they're already in presets).
+     */
+    templates: IFormatTemplate[];
+    /**
+     * The inherit preset if available (only for CURRENCY with override).
+     */
+    inheritPreset: IFormatPreset | null;
+}
+
 /**
  * Hook to get current instance of the {@link OverlayController}
  *
@@ -8468,6 +8685,18 @@ export declare const useScrollContext: () => {
     scrollIntoView: (_element: HTMLElement, _bottomMargin?: number, _isElementInvisibleCheck?: isElementInvisibleType) => void;
 };
 
+/**
+ * Hook that creates standard numeric format presets.
+ * Use this when you don't need metric type awareness.
+ *
+ * @param formatMessage - Function to format localized messages
+ * @returns Array of standard format presets
+ * @internal
+ */
+export declare function useStandardPresets(formatMessage: (descriptor: {
+    id: string;
+}) => string): IFormatPreset[];
+
 /**
  * @internal
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gooddata/sdk-ui-kit",
-  "version": "11.13.0-alpha.2",
+  "version": "11.13.0-alpha.4",
   "description": "GoodData SDK - UI Building Components",
   "repository": {
     "type": "git",
@@ -76,11 +76,11 @@
     "tslib": "2.8.1",
     "unified": "^11.0.5",
     "uuid": "^11.1.0",
-    "@gooddata/sdk-backend-spi": "11.13.0-alpha.2",
-    "@gooddata/sdk-model": "11.13.0-alpha.2",
-    "@gooddata/util": "11.13.0-alpha.2",
-    "@gooddata/sdk-ui-theme-provider": "11.13.0-alpha.2",
-    "@gooddata/sdk-ui": "11.13.0-alpha.2"
+    "@gooddata/sdk-backend-spi": "11.13.0-alpha.4",
+    "@gooddata/sdk-model": "11.13.0-alpha.4",
+    "@gooddata/sdk-ui": "11.13.0-alpha.4",
+    "@gooddata/sdk-ui-theme-provider": "11.13.0-alpha.4",
+    "@gooddata/util": "11.13.0-alpha.4"
   },
   "devDependencies": {
     "@gooddata/stylelint-config": "^5.0.0",
@@ -130,9 +130,9 @@
     "typescript": "5.8.3",
     "vitest": "3.2.4",
     "vitest-dom": "0.1.1",
-    "@gooddata/eslint-config": "11.13.0-alpha.2",
-    "@gooddata/reference-workspace": "11.13.0-alpha.2",
-    "@gooddata/sdk-backend-mockingbird": "11.13.0-alpha.2"
+    "@gooddata/eslint-config": "11.13.0-alpha.4",
+    "@gooddata/reference-workspace": "11.13.0-alpha.4",
+    "@gooddata/sdk-backend-mockingbird": "11.13.0-alpha.4"
   },
   "peerDependencies": {
     "react": "^18.0.0 || ^19.0.0",