@gooddata/sdk-ui-kit 11.13.0-alpha.1 → 11.13.0-alpha.3

package/esm/measureNumberFormat/presets/standardPresets.js

@@ -0,0 +1,71 @@
+// (C) 2025 GoodData Corporation
+/**
+ * Standard numeric preset definitions.
+ * These are the raw preset data that can be used to create localized presets.
+ * @internal
+ */
+export const STANDARD_PRESET_DEFINITIONS = [
+    {
+        localIdentifier: "rounded",
+        format: "#,##0",
+        previewNumber: 1000.12,
+        messageId: "metricComponent.numberFormat.preset.rounded",
+    },
+    {
+        localIdentifier: "decimal-1",
+        format: "#,##0.0",
+        previewNumber: 1000.12,
+        messageId: "metricComponent.numberFormat.preset.decimal1",
+    },
+    {
+        localIdentifier: "decimal-2",
+        format: "#,##0.00",
+        previewNumber: 1000.12,
+        messageId: "metricComponent.numberFormat.preset.decimal2",
+    },
+    {
+        localIdentifier: "percent-rounded",
+        format: "#,##0%",
+        previewNumber: 0.1,
+        messageId: "metricComponent.numberFormat.preset.percentRounded",
+    },
+    {
+        localIdentifier: "percent-1",
+        format: "#,##0.0%",
+        previewNumber: 0.101,
+        messageId: "metricComponent.numberFormat.preset.percent1",
+    },
+    {
+        localIdentifier: "percent-2",
+        format: "#,##0.00%",
+        previewNumber: 0.1012,
+        messageId: "metricComponent.numberFormat.preset.percent2",
+    },
+];
+/**
+ * Default message ID prefix for standard preset definitions.
+ * @internal
+ */
+export const DEFAULT_STANDARD_PRESET_PREFIX = "metricComponent.numberFormat.preset";
+/**
+ * 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 function createStandardPresets(formatMessage, messageIdPrefix = DEFAULT_STANDARD_PRESET_PREFIX) {
+    return STANDARD_PRESET_DEFINITIONS.map((definition) => {
+        // Extract the key part from the default message ID (e.g., "rounded" from "metricComponent.numberFormat.preset.rounded")
+        const keyPart = definition.messageId.replace(`${DEFAULT_STANDARD_PRESET_PREFIX}.`, "");
+        const messageId = `${messageIdPrefix}.${keyPart}`;
+        return {
+            name: formatMessage({ id: messageId }),
+            localIdentifier: definition.localIdentifier,
+            format: definition.format,
+            previewNumber: definition.previewNumber,
+        };
+    });
+}
+//# sourceMappingURL=standardPresets.js.map

package/esm/measureNumberFormat/presets/standardPresets.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"standardPresets.js","sourceRoot":"","sources":["../../../src/measureNumberFormat/presets/standardPresets.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAehC;;;;GAIG;AACH,MAAM,CAAC,MAAM,2BAA2B,GAAyC;IAC7E;QACI,eAAe,EAAE,SAAS;QAC1B,MAAM,EAAE,OAAO;QACf,aAAa,EAAE,OAAO;QACtB,SAAS,EAAE,6CAA6C;KAC3D;IACD;QACI,eAAe,EAAE,WAAW;QAC5B,MAAM,EAAE,SAAS;QACjB,aAAa,EAAE,OAAO;QACtB,SAAS,EAAE,8CAA8C;KAC5D;IACD;QACI,eAAe,EAAE,WAAW;QAC5B,MAAM,EAAE,UAAU;QAClB,aAAa,EAAE,OAAO;QACtB,SAAS,EAAE,8CAA8C;KAC5D;IACD;QACI,eAAe,EAAE,iBAAiB;QAClC,MAAM,EAAE,QAAQ;QAChB,aAAa,EAAE,GAAG;QAClB,SAAS,EAAE,oDAAoD;KAClE;IACD;QACI,eAAe,EAAE,WAAW;QAC5B,MAAM,EAAE,UAAU;QAClB,aAAa,EAAE,KAAK;QACpB,SAAS,EAAE,8CAA8C;KAC5D;IACD;QACI,eAAe,EAAE,WAAW;QAC5B,MAAM,EAAE,WAAW;QACnB,aAAa,EAAE,MAAM;QACrB,SAAS,EAAE,8CAA8C;KAC5D;CACK,CAAC;AAEX;;;GAGG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,qCAAqC,CAAC;AAEpF;;;;;;;GAOG;AACH,MAAM,UAAU,qBAAqB,CACjC,aAAqD,EACrD,kBAA0B,8BAA8B;IAExD,OAAO,2BAA2B,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE;QAClD,wHAAwH;QACxH,MAAM,OAAO,GAAG,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,8BAA8B,GAAG,EAAE,EAAE,CAAC,CAAC;QACvF,MAAM,SAAS,GAAG,GAAG,eAAe,IAAI,OAAO,EAAE,CAAC;QAClD,OAAO;YACH,IAAI,EAAE,aAAa,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC;YACtC,eAAe,EAAE,UAAU,CAAC,eAAe;YAC3C,MAAM,EAAE,UAAU,CAAC,MAAM;YACzB,aAAa,EAAE,UAAU,CAAC,aAAa;SAC1C,CAAC;IACN,CAAC,CAAC,CAAC;AACP,CAAC"}

package/esm/measureNumberFormat/presets/templates.d.ts

@@ -0,0 +1,60 @@
+import { type IFormatTemplate } from "../typings.js";
+/**
+ * Base template definition without localized name.
+ * @internal
+ */
+export interface ITemplateDefinition {
+    localIdentifier: string;
+    format: string;
+    messageId: string;
+}
+/**
+ * Standard format template definitions (basic numeric formats).
+ * @internal
+ */
+export declare const STANDARD_TEMPLATE_DEFINITIONS: readonly ITemplateDefinition[];
+/**
+ * Currency format template definitions.
+ * @internal
+ */
+export declare const CURRENCY_TEMPLATE_DEFINITIONS: readonly ITemplateDefinition[];
+/**
+ * Advanced format template definitions (complex conditional formats).
+ * @internal
+ */
+export declare const ADVANCED_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[];
+/**
+ * Default message ID prefix for template definitions.
+ * @internal
+ */
+export declare const DEFAULT_TEMPLATE_PREFIX = "metricComponent.numberFormat.template";
+/**
+ * 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[];
+/**
+ * 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[];
+//# sourceMappingURL=templates.d.ts.map

package/esm/measureNumberFormat/presets/templates.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"templates.d.ts","sourceRoot":"","sources":["../../../src/measureNumberFormat/presets/templates.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,eAAe,CAAC;AAErD;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAChC,eAAe,EAAE,MAAM,CAAC;IACxB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,eAAO,MAAM,6BAA6B,EAAE,SAAS,mBAAmB,EA+B9D,CAAC;AAEX;;;GAGG;AACH,eAAO,MAAM,6BAA6B,EAAE,SAAS,mBAAmB,EAqB9D,CAAC;AAEX;;;GAGG;AACH,eAAO,MAAM,6BAA6B,EAAE,SAAS,mBAAmB,EAuE9D,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,UAA8D,CAAC;AAEjG;;;GAGG;AACH,eAAO,MAAM,uBAAuB,0CAA0C,CAAC;AAE/E;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAC3B,aAAa,EAAE,CAAC,UAAU,EAAE;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,KAAK,MAAM,EACrD,WAAW,EAAE,SAAS,mBAAmB,EAAE,EAC3C,eAAe,GAAE,MAAgC,GAClD,eAAe,EAAE,CAWnB;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAC9B,aAAa,EAAE,CAAC,UAAU,EAAE;IAAE,EAAE,EAAE,MAAM,CAAA;CAAE,KAAK,MAAM,EACrD,eAAe,GAAE,MAAgC,GAClD,eAAe,EAAE,CAMnB"}

package/esm/measureNumberFormat/presets/templates.js

@@ -0,0 +1,183 @@
+// (C) 2025 GoodData Corporation
+/**
+ * Standard format template definitions (basic numeric formats).
+ * @internal
+ */
+export const STANDARD_TEMPLATE_DEFINITIONS = [
+    {
+        localIdentifier: "rounded",
+        format: "#,##0",
+        messageId: "metricComponent.numberFormat.template.rounded",
+    },
+    {
+        localIdentifier: "decimal-1",
+        format: "#,##0.0",
+        messageId: "metricComponent.numberFormat.template.decimal1",
+    },
+    {
+        localIdentifier: "decimal-2",
+        format: "#,##0.00",
+        messageId: "metricComponent.numberFormat.template.decimal2",
+    },
+    {
+        localIdentifier: "percent-rounded",
+        format: "#,##0%",
+        messageId: "metricComponent.numberFormat.template.percentRounded",
+    },
+    {
+        localIdentifier: "percent-1",
+        format: "#,##0.0%",
+        messageId: "metricComponent.numberFormat.template.percent1",
+    },
+    {
+        localIdentifier: "percent-2",
+        format: "#,##0.00%",
+        messageId: "metricComponent.numberFormat.template.percent2",
+    },
+];
+/**
+ * Currency format template definitions.
+ * @internal
+ */
+export const CURRENCY_TEMPLATE_DEFINITIONS = [
+    {
+        localIdentifier: "currency",
+        format: "$#,##0.00",
+        messageId: "metricComponent.numberFormat.template.currency",
+    },
+    {
+        localIdentifier: "currency-shortened",
+        format: "[>=1000000000000]$#,,,,.0 T;\n" +
+            "[>=1000000000]$#,,,.0 B;\n" +
+            "[>=1000000]$#,,.0 M;\n" +
+            "[>=1000]$#,.0 K;\n" +
+            "[>=0]$#,##0;\n" +
+            "[<=-1000000000000]-$#,,,,.0 T;\n" +
+            "[<=-1000000000]-$#,,,.0 B;\n" +
+            "[<=-1000000]-$#,,.0 M;\n" +
+            "[<=-1000]-$#,.0 K;\n" +
+            "[<0]-$#,##0",
+        messageId: "metricComponent.numberFormat.template.currencyShortened",
+    },
+];
+/**
+ * Advanced format template definitions (complex conditional formats).
+ * @internal
+ */
+export const ADVANCED_TEMPLATE_DEFINITIONS = [
+    {
+        localIdentifier: "large-numbers-shortened",
+        format: "[>=1000000000000]#,,,,.0 T;\n" +
+            "[>=1000000000]#,,,.0 B;\n" +
+            "[>=1000000]#,,.0 M;\n" +
+            "[>=1000]#,.0 K;\n" +
+            "[>=0]#,##0;\n" +
+            "[<=-1000000000000]-#,,,,.0 T;\n" +
+            "[<=-1000000000]-#,,,.0 B;\n" +
+            "[<=-1000000]-#,,.0 M;\n" +
+            "[<=-1000]-#,.0 K;\n" +
+            "[<0]-#,##0",
+        messageId: "metricComponent.numberFormat.template.largeNumbersShortened",
+    },
+    {
+        localIdentifier: "large-numbers-shortened-with-colors",
+        format: "[>=1000000000000][green]#,,,,.0 T;\n" +
+            "[>=1000000000][green]#,,,.0 B;\n" +
+            "[>=1000000][green]#,,.0 M;\n" +
+            "[>=1000][black]#,.0 K;\n" +
+            "[>=0][black]#,##0;\n" +
+            "[<=-1000000000000][red]-#,,,,.0 T;\n" +
+            "[<=-1000000000][red]-#,,,.0 B;\n" +
+            "[<=-1000000][red]-#,,.0 M;\n" +
+            "[<=-1000][red]-#,.0 K;\n" +
+            "[<0][black]-#,##0",
+        messageId: "metricComponent.numberFormat.template.largeNumbersShortenedWithColors",
+    },
+    {
+        localIdentifier: "negative-numbers-red",
+        format: "[<0][red]-#,##0.0;\n[black]#,##0.0",
+        messageId: "metricComponent.numberFormat.template.negativeNumbersRed",
+    },
+    {
+        localIdentifier: "financial",
+        format: "[<0](#,##0.0);\n#,##0.0",
+        messageId: "metricComponent.numberFormat.template.financial",
+    },
+    {
+        localIdentifier: "decimal-without-thousands-separator",
+        format: "0.00",
+        messageId: "metricComponent.numberFormat.template.decimalWithoutThousandsSeparator",
+    },
+    {
+        localIdentifier: "conditional-colors",
+        format: "[<0][red]#,#.##;\n[<1000][black]#,0.##;\n[>=1000][green]#,#.##",
+        messageId: "metricComponent.numberFormat.template.conditionalColors",
+    },
+    {
+        localIdentifier: "trend-symbols",
+        format: "[<0][green]▲ #,##0.0%;\n[=0][black]#,##0.0%;\n[>0][red]▼ #,##0.0%",
+        messageId: "metricComponent.numberFormat.template.trendSymbols",
+    },
+    {
+        localIdentifier: "time-from-seconds",
+        format: "[>=86400]{{{86400||0d}}} {{{3600|24|00}}}h;\n" +
+            "[>=3600]{{{3600|24|00}}}h {{{60|60|00}}}m;\n" +
+            "[>=60]{{{60|60|00}}}m {{{|60.|00}}}s;\n" +
+            "[>0]{{{|60.|00.0}}}s;\n" +
+            "[=0]{{{|60.|0}}}",
+        messageId: "metricComponent.numberFormat.template.timeFromSeconds",
+    },
+    {
+        localIdentifier: "zero-instead-of-null",
+        format: "[=null]0.00;\n[>=0]#,#0.00;\n[<0]-#,#0.00",
+        messageId: "metricComponent.numberFormat.template.zeroInsteadOfNull",
+    },
+];
+/**
+ * Local identifiers of templates that are currency-specific.
+ * Used to filter templates when metric type is CURRENCY.
+ * @internal
+ */
+export const CURRENCY_TEMPLATE_IDS = CURRENCY_TEMPLATE_DEFINITIONS.map((t) => t.localIdentifier);
+/**
+ * Default message ID prefix for template definitions.
+ * @internal
+ */
+export const DEFAULT_TEMPLATE_PREFIX = "metricComponent.numberFormat.template";
+/**
+ * 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 function createTemplates(formatMessage, definitions, messageIdPrefix = DEFAULT_TEMPLATE_PREFIX) {
+    return definitions.map((definition) => {
+        // Extract the key part from the default message ID (e.g., "rounded" from "metricComponent.numberFormat.template.rounded")
+        const keyPart = definition.messageId.replace(`${DEFAULT_TEMPLATE_PREFIX}.`, "");
+        const messageId = `${messageIdPrefix}.${keyPart}`;
+        return {
+            name: formatMessage({ id: messageId }),
+            localIdentifier: definition.localIdentifier,
+            format: definition.format,
+        };
+    });
+}
+/**
+ * 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 function createAllTemplates(formatMessage, messageIdPrefix = DEFAULT_TEMPLATE_PREFIX) {
+    return [
+        ...createTemplates(formatMessage, STANDARD_TEMPLATE_DEFINITIONS, messageIdPrefix),
+        ...createTemplates(formatMessage, CURRENCY_TEMPLATE_DEFINITIONS, messageIdPrefix),
+        ...createTemplates(formatMessage, ADVANCED_TEMPLATE_DEFINITIONS, messageIdPrefix),
+    ];
+}
+//# sourceMappingURL=templates.js.map

package/esm/measureNumberFormat/presets/templates.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"templates.js","sourceRoot":"","sources":["../../../src/measureNumberFormat/presets/templates.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAchC;;;GAGG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAmC;IACzE;QACI,eAAe,EAAE,SAAS;QAC1B,MAAM,EAAE,OAAO;QACf,SAAS,EAAE,+CAA+C;KAC7D;IACD;QACI,eAAe,EAAE,WAAW;QAC5B,MAAM,EAAE,SAAS;QACjB,SAAS,EAAE,gDAAgD;KAC9D;IACD;QACI,eAAe,EAAE,WAAW;QAC5B,MAAM,EAAE,UAAU;QAClB,SAAS,EAAE,gDAAgD;KAC9D;IACD;QACI,eAAe,EAAE,iBAAiB;QAClC,MAAM,EAAE,QAAQ;QAChB,SAAS,EAAE,sDAAsD;KACpE;IACD;QACI,eAAe,EAAE,WAAW;QAC5B,MAAM,EAAE,UAAU;QAClB,SAAS,EAAE,gDAAgD;KAC9D;IACD;QACI,eAAe,EAAE,WAAW;QAC5B,MAAM,EAAE,WAAW;QACnB,SAAS,EAAE,gDAAgD;KAC9D;CACK,CAAC;AAEX;;;GAGG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAmC;IACzE;QACI,eAAe,EAAE,UAAU;QAC3B,MAAM,EAAE,WAAW;QACnB,SAAS,EAAE,gDAAgD;KAC9D;IACD;QACI,eAAe,EAAE,oBAAoB;QACrC,MAAM,EACF,gCAAgC;YAChC,4BAA4B;YAC5B,wBAAwB;YACxB,oBAAoB;YACpB,gBAAgB;YAChB,kCAAkC;YAClC,8BAA8B;YAC9B,0BAA0B;YAC1B,sBAAsB;YACtB,aAAa;QACjB,SAAS,EAAE,yDAAyD;KACvE;CACK,CAAC;AAEX;;;GAGG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAmC;IACzE;QACI,eAAe,EAAE,yBAAyB;QAC1C,MAAM,EACF,+BAA+B;YAC/B,2BAA2B;YAC3B,uBAAuB;YACvB,mBAAmB;YACnB,eAAe;YACf,iCAAiC;YACjC,6BAA6B;YAC7B,yBAAyB;YACzB,qBAAqB;YACrB,YAAY;QAChB,SAAS,EAAE,6DAA6D;KAC3E;IACD;QACI,eAAe,EAAE,qCAAqC;QACtD,MAAM,EACF,sCAAsC;YACtC,kCAAkC;YAClC,8BAA8B;YAC9B,0BAA0B;YAC1B,sBAAsB;YACtB,sCAAsC;YACtC,kCAAkC;YAClC,8BAA8B;YAC9B,0BAA0B;YAC1B,mBAAmB;QACvB,SAAS,EAAE,uEAAuE;KACrF;IACD;QACI,eAAe,EAAE,sBAAsB;QACvC,MAAM,EAAE,oCAAoC;QAC5C,SAAS,EAAE,0DAA0D;KACxE;IACD;QACI,eAAe,EAAE,WAAW;QAC5B,MAAM,EAAE,yBAAyB;QACjC,SAAS,EAAE,iDAAiD;KAC/D;IACD;QACI,eAAe,EAAE,qCAAqC;QACtD,MAAM,EAAE,MAAM;QACd,SAAS,EAAE,wEAAwE;KACtF;IACD;QACI,eAAe,EAAE,oBAAoB;QACrC,MAAM,EAAE,gEAAgE;QACxE,SAAS,EAAE,yDAAyD;KACvE;IACD;QACI,eAAe,EAAE,eAAe;QAChC,MAAM,EAAE,mEAAmE;QAC3E,SAAS,EAAE,oDAAoD;KAClE;IACD;QACI,eAAe,EAAE,mBAAmB;QACpC,MAAM,EACF,+CAA+C;YAC/C,8CAA8C;YAC9C,yCAAyC;YACzC,yBAAyB;YACzB,kBAAkB;QACtB,SAAS,EAAE,uDAAuD;KACrE;IACD;QACI,eAAe,EAAE,sBAAsB;QACvC,MAAM,EAAE,2CAA2C;QACnD,SAAS,EAAE,yDAAyD;KACvE;CACK,CAAC;AAEX;;;;GAIG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,6BAA6B,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC;AAEjG;;;GAGG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,uCAAuC,CAAC;AAE/E;;;;;;;;GAQG;AACH,MAAM,UAAU,eAAe,CAC3B,aAAqD,EACrD,WAA2C,EAC3C,kBAA0B,uBAAuB;IAEjD,OAAO,WAAW,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE;QAClC,0HAA0H;QAC1H,MAAM,OAAO,GAAG,UAAU,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,uBAAuB,GAAG,EAAE,EAAE,CAAC,CAAC;QAChF,MAAM,SAAS,GAAG,GAAG,eAAe,IAAI,OAAO,EAAE,CAAC;QAClD,OAAO;YACH,IAAI,EAAE,aAAa,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,CAAC;YACtC,eAAe,EAAE,UAAU,CAAC,eAAe;YAC3C,MAAM,EAAE,UAAU,CAAC,MAAM;SAC5B,CAAC;IACN,CAAC,CAAC,CAAC;AACP,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,kBAAkB,CAC9B,aAAqD,EACrD,kBAA0B,uBAAuB;IAEjD,OAAO;QACH,GAAG,eAAe,CAAC,aAAa,EAAE,6BAA6B,EAAE,eAAe,CAAC;QACjF,GAAG,eAAe,CAAC,aAAa,EAAE,6BAA6B,EAAE,eAAe,CAAC;QACjF,GAAG,eAAe,CAAC,aAAa,EAAE,6BAA6B,EAAE,eAAe,CAAC;KACpF,CAAC;AACN,CAAC"}

package/esm/measureNumberFormat/validation/currencyFormatValidator.d.ts

@@ -0,0 +1,55 @@
+import { type ISeparators } from "@gooddata/number-formatter";
+/**
+ * @alpha
+ */
+export type CurrencyFormatValidationErrorCode = "empty" | "invalidFormat" | "missingCurrencySymbol" | "missingDecimalPlaces";
+/**
+ * @alpha
+ */
+export interface ICurrencyFormatValidationError {
+    code: CurrencyFormatValidationErrorCode;
+    /**
+     * Indexes of sections (0-based) that failed validation.
+     * The value is only present for section-driven validations.
+     */
+    sectionIndexes?: number[];
+    message: string;
+}
+/**
+ * @alpha
+ */
+export interface ICurrencyFormatValidationResult {
+    isValid: boolean;
+    errors: ICurrencyFormatValidationError[];
+}
+/**
+ * @alpha
+ */
+export interface ICurrencyFormatValidationOptions {
+    /**
+     * Sample value used to verify the formatter does not throw.
+     * Defaults to 12345.67 to cover both thousands and decimals.
+     */
+    sampleValue?: number;
+    /**
+     * Number of mandatory decimal places each section must contain.
+     * Set to 0 (or a negative value) to skip the decimal check.
+     * Defaults to 2.
+     */
+    requiredDecimalPlaces?: number;
+    separators?: ISeparators;
+}
+/**
+ * Validates a number format string that is expected to represent a currency amount.
+ *
+ * @alpha
+ */
+export declare function validateCurrencyFormat(format: string | undefined | null, options?: ICurrencyFormatValidationOptions): ICurrencyFormatValidationResult;
+/**
+ * Checks if a format string represents a currency format.
+ * A currency format is one where at least one numeric section contains a currency symbol.
+ *
+ * @alpha
+ */
+export declare function isCurrencyFormat(format: string | undefined | null): boolean;
+//# sourceMappingURL=currencyFormatValidator.d.ts.map

package/esm/measureNumberFormat/validation/currencyFormatValidator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"currencyFormatValidator.d.ts","sourceRoot":"","sources":["../../../src/measureNumberFormat/validation/currencyFormatValidator.ts"],"names":[],"mappings":"AAEA,OAAO,EAAyB,KAAK,WAAW,EAAE,MAAM,4BAA4B,CAAC;AAWrF;;GAEG;AACH,MAAM,MAAM,iCAAiC,GACvC,OAAO,GACP,eAAe,GACf,uBAAuB,GACvB,sBAAsB,CAAC;AAE7B;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC3C,IAAI,EAAE,iCAAiC,CAAC;IACxC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B,OAAO,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC5C,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,8BAA8B,EAAE,CAAC;CAC5C;AAED;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAC7C;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,UAAU,CAAC,EAAE,WAAW,CAAC;CAC5B;AASD;;;;GAIG;AACH,wBAAgB,sBAAsB,CAClC,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,EACjC,OAAO,GAAE,gCAAqC,GAC/C,+BAA+B,CAsDjC;AAgED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,GAAG,OAAO,CAc3E"}

package/esm/measureNumberFormat/validation/currencyFormatValidator.js

@@ -0,0 +1,118 @@
+// (C) 2025 GoodData Corporation
+import { ClientFormatterFacade } from "@gooddata/number-formatter";
+const DEFAULT_SAMPLE_VALUE = 12345.67;
+const DEFAULT_REQUIRED_DECIMALS = 2;
+const SECTION_SEPARATOR = ";";
+const NUMBER_PLACEHOLDER_PATTERN = /[0#?]/;
+const DECIMAL_TOKEN_PATTERN = /\.(0+)/;
+const CURRENCY_SYMBOL_PATTERN = /\p{Sc}/u;
+const CURRENCY_BRACKET_PATTERN = /\[\$[^\]]+\]/;
+const QUOTED_CURRENCY_PATTERN = /(["'])[ \t]*[A-Za-z]{2,6}[ \t]*\1/;
+const DEFAULT_ERROR_MESSAGES = {
+    empty: "Format is required.",
+    invalidFormat: "Format contains invalid tokens.",
+    missingCurrencySymbol: "Currency symbol is missing.",
+    missingDecimalPlaces: "Format must include the required decimal places.",
+};
+/**
+ * Validates a number format string that is expected to represent a currency amount.
+ *
+ * @alpha
+ */
+export function validateCurrencyFormat(format, options = {}) {
+    const sanitizedFormat = format?.trim() ?? "";
+    const errors = [];
+    if (!sanitizedFormat) {
+        errors.push(buildError("empty"));
+        return { isValid: false, errors };
+    }
+    const sampleValue = options.sampleValue ?? DEFAULT_SAMPLE_VALUE;
+    const separators = options.separators;
+    if (!isParsableFormat(sanitizedFormat, sampleValue, separators)) {
+        errors.push(buildError("invalidFormat"));
+        return { isValid: false, errors };
+    }
+    const sections = getFormatSections(sanitizedFormat);
+    const sectionsWithNumbers = sections.filter(hasNumericPlaceholder);
+    if (sectionsWithNumbers.length === 0) {
+        errors.push(buildError("invalidFormat"));
+        return { isValid: false, errors };
+    }
+    if (!sectionsWithNumbers.every(hasCurrencyToken)) {
+        errors.push(buildError("missingCurrencySymbol", collectInvalidSections(sectionsWithNumbers, hasCurrencyToken)));
+    }
+    const requiredDecimals = options.requiredDecimalPlaces ?? DEFAULT_REQUIRED_DECIMALS;
+    if (requiredDecimals > 0 &&
+        !sectionsWithNumbers.every((section) => hasRequiredDecimals(section, requiredDecimals))) {
+        errors.push(buildError("missingDecimalPlaces", collectInvalidSections(sectionsWithNumbers, (section) => hasRequiredDecimals(section, requiredDecimals))));
+    }
+    return {
+        isValid: errors.length === 0,
+        errors,
+    };
+}
+function buildError(code, sectionIndexes) {
+    return {
+        code,
+        sectionIndexes,
+        message: DEFAULT_ERROR_MESSAGES[code],
+    };
+}
+function getFormatSections(format) {
+    return format
+        .split(SECTION_SEPARATOR)
+        .map((section) => section.trim())
+        .filter((section) => section.length > 0);
+}
+function hasNumericPlaceholder(section) {
+    return NUMBER_PLACEHOLDER_PATTERN.test(section);
+}
+function hasCurrencyToken(section) {
+    return (CURRENCY_BRACKET_PATTERN.test(section) ||
+        CURRENCY_SYMBOL_PATTERN.test(section) ||
+        QUOTED_CURRENCY_PATTERN.test(section));
+}
+function hasRequiredDecimals(section, requiredDecimalPlaces) {
+    const match = section.match(DECIMAL_TOKEN_PATTERN);
+    if (!match) {
+        return false;
+    }
+    return match[1].length >= requiredDecimalPlaces;
+}
+function collectInvalidSections(sections, predicate) {
+    const invalidIndexes = sections.reduce((result, section, index) => {
+        if (!predicate(section)) {
+            result.push(index);
+        }
+        return result;
+    }, []);
+    return invalidIndexes.length > 0 ? invalidIndexes : undefined;
+}
+function isParsableFormat(format, sampleValue, separators) {
+    try {
+        ClientFormatterFacade.formatValue(sampleValue, format, separators);
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+/**
+ * Checks if a format string represents a currency format.
+ * A currency format is one where at least one numeric section contains a currency symbol.
+ *
+ * @alpha
+ */
+export function isCurrencyFormat(format) {
+    const sanitizedFormat = format?.trim();
+    if (!sanitizedFormat) {
+        return false;
+    }
+    const sections = getFormatSections(sanitizedFormat);
+    const sectionsWithNumbers = sections.filter(hasNumericPlaceholder);
+    if (sectionsWithNumbers.length === 0) {
+        return false;
+    }
+    return sectionsWithNumbers.some(hasCurrencyToken);
+}
+//# sourceMappingURL=currencyFormatValidator.js.map

package/esm/measureNumberFormat/validation/currencyFormatValidator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"currencyFormatValidator.js","sourceRoot":"","sources":["../../../src/measureNumberFormat/validation/currencyFormatValidator.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAEhC,OAAO,EAAE,qBAAqB,EAAoB,MAAM,4BAA4B,CAAC;AAErF,MAAM,oBAAoB,GAAG,QAAQ,CAAC;AACtC,MAAM,yBAAyB,GAAG,CAAC,CAAC;AACpC,MAAM,iBAAiB,GAAG,GAAG,CAAC;AAC9B,MAAM,0BAA0B,GAAG,OAAO,CAAC;AAC3C,MAAM,qBAAqB,GAAG,QAAQ,CAAC;AACvC,MAAM,uBAAuB,GAAG,SAAS,CAAC;AAC1C,MAAM,wBAAwB,GAAG,cAAc,CAAC;AAChD,MAAM,uBAAuB,GAAG,mCAAmC,CAAC;AAkDpE,MAAM,sBAAsB,GAAsD;IAC9E,KAAK,EAAE,qBAAqB;IAC5B,aAAa,EAAE,iCAAiC;IAChD,qBAAqB,EAAE,6BAA6B;IACpD,oBAAoB,EAAE,kDAAkD;CAC3E,CAAC;AAEF;;;;GAIG;AACH,MAAM,UAAU,sBAAsB,CAClC,MAAiC,EACjC,UAA4C,EAAE;IAE9C,MAAM,eAAe,GAAG,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;IAC7C,MAAM,MAAM,GAAqC,EAAE,CAAC;IAEpD,IAAI,CAAC,eAAe,EAAE,CAAC;QACnB,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC;QACjC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;IACtC,CAAC;IAED,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,IAAI,oBAAoB,CAAC;IAChE,MAAM,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;IAEtC,IAAI,CAAC,gBAAgB,CAAC,eAAe,EAAE,WAAW,EAAE,UAAU,CAAC,EAAE,CAAC;QAC9D,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC,CAAC;QACzC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;IACtC,CAAC;IAED,MAAM,QAAQ,GAAG,iBAAiB,CAAC,eAAe,CAAC,CAAC;IACpD,MAAM,mBAAmB,GAAG,QAAQ,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;IAEnE,IAAI,mBAAmB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACnC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC,CAAC;QACzC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC;IACtC,CAAC;IAED,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,gBAAgB,CAAC,EAAE,CAAC;QAC/C,MAAM,CAAC,IAAI,CACP,UAAU,CACN,uBAAuB,EACvB,sBAAsB,CAAC,mBAAmB,EAAE,gBAAgB,CAAC,CAChE,CACJ,CAAC;IACN,CAAC;IAED,MAAM,gBAAgB,GAAG,OAAO,CAAC,qBAAqB,IAAI,yBAAyB,CAAC;IAEpF,IACI,gBAAgB,GAAG,CAAC;QACpB,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,mBAAmB,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC,EACzF,CAAC;QACC,MAAM,CAAC,IAAI,CACP,UAAU,CACN,sBAAsB,EACtB,sBAAsB,CAAC,mBAAmB,EAAE,CAAC,OAAO,EAAE,EAAE,CACpD,mBAAmB,CAAC,OAAO,EAAE,gBAAgB,CAAC,CACjD,CACJ,CACJ,CAAC;IACN,CAAC;IAED,OAAO;QACH,OAAO,EAAE,MAAM,CAAC,MAAM,KAAK,CAAC;QAC5B,MAAM;KACT,CAAC;AACN,CAAC;AAED,SAAS,UAAU,CACf,IAAuC,EACvC,cAAyB;IAEzB,OAAO;QACH,IAAI;QACJ,cAAc;QACd,OAAO,EAAE,sBAAsB,CAAC,IAAI,CAAC;KACxC,CAAC;AACN,CAAC;AAED,SAAS,iBAAiB,CAAC,MAAc;IACrC,OAAO,MAAM;SACR,KAAK,CAAC,iBAAiB,CAAC;SACxB,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;SAChC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;AACjD,CAAC;AAED,SAAS,qBAAqB,CAAC,OAAe;IAC1C,OAAO,0BAA0B,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;AACpD,CAAC;AAED,SAAS,gBAAgB,CAAC,OAAe;IACrC,OAAO,CACH,wBAAwB,CAAC,IAAI,CAAC,OAAO,CAAC;QACtC,uBAAuB,CAAC,IAAI,CAAC,OAAO,CAAC;QACrC,uBAAuB,CAAC,IAAI,CAAC,OAAO,CAAC,CACxC,CAAC;AACN,CAAC;AAED,SAAS,mBAAmB,CAAC,OAAe,EAAE,qBAA6B;IACvE,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;IACnD,IAAI,CAAC,KAAK,EAAE,CAAC;QACT,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,qBAAqB,CAAC;AACpD,CAAC;AAED,SAAS,sBAAsB,CAC3B,QAAkB,EAClB,SAAuC;IAEvC,MAAM,cAAc,GAAG,QAAQ,CAAC,MAAM,CAAW,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE;QACxE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,CAAC;YACtB,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC;QACD,OAAO,MAAM,CAAC;IAClB,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO,cAAc,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,SAAS,CAAC;AAClE,CAAC;AAED,SAAS,gBAAgB,CAAC,MAAc,EAAE,WAAmB,EAAE,UAAwB;IACnF,IAAI,CAAC;QACD,qBAAqB,CAAC,WAAW,CAAC,WAAW,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC;QACnE,OAAO,IAAI,CAAC;IAChB,CAAC;IAAC,MAAM,CAAC;QACL,OAAO,KAAK,CAAC;IACjB,CAAC;AACL,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAAC,MAAiC;IAC9D,MAAM,eAAe,GAAG,MAAM,EAAE,IAAI,EAAE,CAAC;IACvC,IAAI,CAAC,eAAe,EAAE,CAAC;QACnB,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,MAAM,QAAQ,GAAG,iBAAiB,CAAC,eAAe,CAAC,CAAC;IACpD,MAAM,mBAAmB,GAAG,QAAQ,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;IAEnE,IAAI,mBAAmB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACnC,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,OAAO,mBAAmB,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;AACtD,CAAC"}