generaltranslation 6.3.2 → 7.0.0-alpha.1

package/dist/index.d.ts

@@ -1,84 +1,420 @@
-import { Content, JsxChildren, JsxTranslationResult, ContentTranslationResult, TranslationError, IcuTranslationResult, Metadata, CustomMapping } from './types';
+import { CustomMapping, FormatVariables } from './types';
 import { LocaleProperties } from './locales/getLocaleProperties';
-import { FullCustomMapping } from './locales/customLocaleMapping';
 /**
  * Type representing the constructor parameters for the GT class.
+ * @typedef {Object} GTConstructorParams
+ * @property {string} [apiKey] - The API key for accessing the translation service
+ * @property {string} [devApiKey] - The development API key for accessing the translation service
+ * @property {string} [sourceLocale] - The default source locale for translations
+ * @property {string} [targetLocale] - The default target locale for translations
+ * @property {string[]} [locales] - Array of supported locales
+ * @property {string} [projectId] - The project ID for the translation service
+ * @property {string} [baseUrl] - The base URL for the translation service
+ * @property {CustomMapping} [customMapping] - Custom mapping of locale codes to their names
  */
 type GTConstructorParams = {
     apiKey?: string;
     devApiKey?: string;
     sourceLocale?: string;
+    targetLocale?: string;
+    locales?: string[];
     projectId?: string;
     baseUrl?: string;
     customMapping?: CustomMapping;
 };
 /**
  * GT is the core driver for the General Translation library.
+ * This class provides functionality for locale management, formatting, and translation operations.
+ *
+ * @class GT
+ * @description A comprehensive toolkit for handling internationalization and localization.
+ *
+ * @example
+ * const gt = new GT({
+ *   sourceLocale: 'en-US',
+ *   targetLocale: 'es-ES',
+ *   locales: ['en-US', 'es-ES', 'fr-FR']
+ * });
  */
-export declare class GT {
-    apiKey: string;
-    devApiKey: string;
-    sourceLocale: string;
-    projectId: string;
+export default class GT {
+    /** Base URL for the translation service API */
     baseUrl: string;
-    customMapping: CustomMapping;
+    /** Project ID for the translation service */
+    projectId?: string;
+    /** API key for accessing the translation service */
+    apiKey?: string;
+    /** Development API key for accessing the translation service */
+    devApiKey?: string;
+    /** Source locale for translations */
+    sourceLocale?: string;
+    /** Target locale for translations */
+    targetLocale?: string;
+    /** Array of supported locales */
+    locales?: string[];
+    /** Array of locales used for rendering variables */
+    _renderingLocales: string[];
+    /** Custom mapping for locale codes to their names */
+    customMapping?: CustomMapping;
     /**
      * Constructs an instance of the GT class.
      *
-     * @param {GTConstructorParams} [params] - The parameters for initializing the GT instance.
-     * @param {string} [params.apiKey=''] - The API key for accessing the translation service.
-     * @param {string} [params.sourceLocale=''] - The default locale for translations.
-     * @param {string} [params.projectId=''] - The project ID for the translation service.
-     * @param {string} [params.baseUrl='https://api.gtx.dev'] - The base URL for the translation service.
+     * @param {GTConstructorParams} [params] - The parameters for initializing the GT instance
+     * @throws {Error} If an invalid locale is provided
+     * @throws {Error} If any of the provided locales are invalid
+     *
+     * @example
+     * const gt = new GT({
+     *   apiKey: 'your-api-key',
+     *   sourceLocale: 'en-US',
+     *   targetLocale: 'es-ES',
+     *   locales: ['en-US', 'es-ES', 'fr-FR']
+     * });
      */
-    constructor({ apiKey, devApiKey, sourceLocale, projectId, baseUrl, customMapping, }?: GTConstructorParams);
+    constructor({ apiKey, devApiKey, sourceLocale, targetLocale, locales, projectId, customMapping, baseUrl, }?: GTConstructorParams);
+    translatef(): void;
+    mtranslatef(): void;
     /**
-     * Translates a string or an array of strings/variables into a target locale.
+     * Formats a message according to the specified locales and options.
+     *
+     * @param {string} message - The message to format.
+     * @param {string | string[]} [locales='en'] - The locales to use for formatting.
+     * @param {FormatVariables} [variables={}] - The variables to use for formatting.
+     * @returns {string} The formatted message.
      *
-     * @param {Content} source - The string or array of strings/variables to be translated.
-     * @param {string} locale - The target locale code (e.g., 'en-US', 'fr') for the translation.
-     * @param {{ context?: string, [key: string]: any }} [metadata] - Additional metadata for the translation request.
+     * @example
+     * gt.formatMessage('Hello {name}', { name: 'John' });
+     * // Returns: "Hello John"
      *
-     * @returns {Promise<ContentTranslationResult | TranslationError>} A promise that resolves to the translated content, or an error if the translation fails.
+     * gt.formatMessage('Hello {name}', { name: 'John' }, { locales: ['fr'] });
+     * // Returns: "Bonjour John"
      */
-    translate(source: Content, locale: string, metadata?: Metadata): Promise<ContentTranslationResult | TranslationError>;
+    formatMessage(message: string, options?: {
+        locales?: string[];
+        variables?: FormatVariables;
+    }): string;
     /**
-     * Translates JSX elements into a given locale.
+     * Formats a number according to the specified locales and options.
      *
-     * @param {Object} params - The parameters for the translation.
-     * @param {JsxChildren} params.source - The JSX children content to be translated.
-     * @param {string} params.locale - The target locale for the translation.
-     * @param {Object} params.metadata - Additional metadata for the translation process.
+     * @param {number} number - The number to format
+     * @param {Object} [options] - Additional options for number formatting
+     * @param {string[]} [options.locales] - The locales to use for formatting
+     * @param {Intl.NumberFormatOptions} [options] - Additional Intl.NumberFormat options
+     * @returns {string} The formatted number
      *
-     * @returns {Promise<JsxTranslationResult | TranslationError>} - A promise that resolves to the translated content.
+     * @example
+     * gt.formatNum(1234.56, { style: 'currency', currency: 'USD' });
+     * // Returns: "$1,234.56"
      */
-    translateJsx(source: JsxChildren, locale: string, metadata?: Metadata): Promise<JsxTranslationResult | TranslationError>;
+    formatNum(number: number, options?: {
+        locales?: string[];
+    } & Intl.NumberFormatOptions): string;
     /**
-     * Translates an ICU message into a given locale.
+     * Formats a date according to the specified locales and options.
      *
-     * @param {string} source - The ICU message to be translated.
-     * @param {string} locale - The target locale code (e.g., 'en-US', 'fr') for the translation.
-     * @param {{ context?: string, [key: string]: any }} [metadata] - Additional metadata for the translation request.
-     * @param {string} [metadata.context] - Contextual information to assist with the translation.
+     * @param {Date} date - The date to format
+     * @param {Object} [options] - Additional options for date formatting
+     * @param {string[]} [options.locales] - The locales to use for formatting
+     * @param {Intl.DateTimeFormatOptions} [options] - Additional Intl.DateTimeFormat options
+     * @returns {string} The formatted date
      *
-     * @returns {Promise<ContentTranslationResult | TranslationError>} A promise that resolves to the translated content, or an error if the translation fails.
+     * @example
+     * gt.formatDateTime(new Date(), { dateStyle: 'full', timeStyle: 'long' });
+     * // Returns: "Thursday, March 14, 2024 at 2:30:45 PM GMT-7"
      */
-    translateIcu(source: string, locale: string, metadata?: Metadata): Promise<IcuTranslationResult | TranslationError>;
+    formatDateTime(date: Date, options?: {
+        locales?: string[];
+    } & Intl.DateTimeFormatOptions): string;
     /**
-     * Retrieves the display name of locale code using Intl.DisplayNames.
+     * Formats a currency value according to the specified locales and options.
      *
-     * @param {string} locale - A BCP-47 locale code.
-     * @returns {string} The display name corresponding to the code.
+     * @param {number} value - The currency value to format
+     * @param {string} currency - The currency code (e.g., 'USD', 'EUR')
+     * @param {Object} [options] - Additional options for currency formatting
+     * @param {string[]} [options.locales] - The locales to use for formatting
+     * @param {Intl.NumberFormatOptions} [options] - Additional Intl.NumberFormat options
+     * @returns {string} The formatted currency value
+     *
+     * @example
+     * gt.formatCurrency(1234.56, 'USD', { style: 'currency' });
+     * // Returns: "$1,234.56"
+     */
+    formatCurrency(value: number, currency: string, options?: {
+        locales?: string[];
+    } & Intl.NumberFormatOptions): string;
+    /**
+     * Formats a list of items according to the specified locales and options.
+     *
+     * @param {Array<string | number>} array - The list of items to format
+     * @param {Object} [options] - Additional options for list formatting
+     * @param {string[]} [options.locales] - The locales to use for formatting
+     * @param {Intl.ListFormatOptions} [options] - Additional Intl.ListFormat options
+     * @returns {string} The formatted list
+     *
+     * @example
+     * gt.formatList(['apple', 'banana', 'orange'], { type: 'conjunction' });
+     * // Returns: "apple, banana, and orange"
+     */
+    formatList(array: Array<string | number>, options?: {
+        locales?: string[];
+    } & Intl.ListFormatOptions): string;
+    /**
+     * Formats a relative time value according to the specified locales and options.
+     *
+     * @param {number} value - The relative time value to format
+     * @param {Intl.RelativeTimeFormatUnit} unit - The unit of time (e.g., 'second', 'minute', 'hour', 'day', 'week', 'month', 'year')
+     * @param {Object} options - Additional options for relative time formatting
+     * @param {string[]} [options.locales] - The locales to use for formatting
+     * @param {Intl.RelativeTimeFormatOptions} [options] - Additional Intl.RelativeTimeFormat options
+     * @returns {string} The formatted relative time string
+     *
+     * @example
+     * gt.formatRelativeTime(-1, 'day', { locales: ['en-US'], numeric: 'auto' });
+     * // Returns: "yesterday"
      */
-    getLocaleName(locale: string): string;
+    formatRelativeTime(value: number, unit: Intl.RelativeTimeFormatUnit, options?: {
+        locales?: string[];
+    } & Omit<Intl.RelativeTimeFormatOptions, 'locales'>): string;
+    /**
+     * Retrieves the display name of a locale code using Intl.DisplayNames.
+     *
+     * @param {string} [locale=this.targetLocale] - A BCP-47 locale code
+     * @returns {string} The display name corresponding to the code
+     * @throws {Error} If no target locale is provided
+     *
+     * @example
+     * gt.getLocaleName('es-ES');
+     * // Returns: "Spanish (Spain)"
+     */
+    getLocaleName(locale?: string | undefined): string;
+    /**
+     * Retrieves an emoji based on a given locale code.
+     * Uses the locale's region (if present) to select an emoji or falls back on default emojis.
+     *
+     * @param {string} [locale=this.targetLocale] - A BCP-47 locale code (e.g., 'en-US', 'fr-CA')
+     * @returns {string} The emoji representing the locale or its region
+     * @throws {Error} If no target locale is provided
+     *
+     * @example
+     * gt.getLocaleEmoji('es-ES');
+     * // Returns: "🇪🇸"
+     */
+    getLocaleEmoji(locale?: string | undefined): string;
     /**
      * Retrieves an emoji based on a given locale code, taking into account region, language, and specific exceptions.
+     *
      * This function uses the locale's region (if present) to select an emoji or falls back on default emojis for certain languages.
      *
      * @param locale - A string representing the locale code (e.g., 'en-US', 'fr-CA').
+     * @param {CustomMapping} [customMapping] - A custom mapping of locale codes to their names.
      * @returns The emoji representing the locale or its region, or a default emoji if no specific match is found.
      */
-    getLocaleEmoji(locale: string): string;
+    static getLocaleEmoji(locale: string, customMapping?: CustomMapping): string;
+    /**
+     * Generates linguistic details for a given locale code.
+     *
+     * This function returns information about the locale,
+     * script, and region of a given language code both in a standard form and in a maximized form (with likely script and region).
+     * The function provides these names in both your default language and native forms, and an associated emoji.
+     *
+     * @param {string} [locale=this.targetLocale] - The locale code to get properties for (e.g., "de-AT").
+     * @returns {LocaleProperties} - An object containing detailed information about the locale.
+     *
+     * @property {string} code - The full locale code, e.g., "de-AT".
+     * @property {string} name - Language name in the default display language, e.g., "Austrian German".
+     * @property {string} nativeName - Language name in the locale's native language, e.g., "Österreichisches Deutsch".
+     * @property {string} languageCode - The base language code, e.g., "de".
+     * @property {string} languageName - The language name in the default display language, e.g., "German".
+     * @property {string} nativeLanguageName - The language name in the native language, e.g., "Deutsch".
+     * @property {string} nameWithRegionCode - Language name with region in the default language, e.g., "German (AT)".
+     * @property {string} nativeNameWithRegionCode - Language name with region in the native language, e.g., "Deutsch (AT)".
+     * @property {string} regionCode - The region code from maximization, e.g., "AT".
+     * @property {string} regionName - The region name in the default display language, e.g., "Austria".
+     * @property {string} nativeRegionName - The region name in the native language, e.g., "Österreich".
+     * @property {string} scriptCode - The script code from maximization, e.g., "Latn".
+     * @property {string} scriptName - The script name in the default display language, e.g., "Latin".
+     * @property {string} nativeScriptName - The script name in the native language, e.g., "Lateinisch".
+     * @property {string} maximizedCode - The maximized locale code, e.g., "de-Latn-AT".
+     * @property {string} maximizedName - Maximized locale name with likely script in the default language, e.g., "Austrian German (Latin)".
+     * @property {string} nativeMaximizedName - Maximized locale name in the native language, e.g., "Österreichisches Deutsch (Lateinisch)".
+     * @property {string} minimizedCode - Minimized locale code, e.g., "de-AT" (or "de" for "de-DE").
+     * @property {string} minimizedName - Minimized language name in the default language, e.g., "Austrian German".
+     * @property {string} nativeMinimizedName - Minimized language name in the native language, e.g., "Österreichisches Deutsch".
+     * @property {string} emoji - The emoji associated with the locale's region, if applicable.
+     */
+    getLocaleProperties(locale?: string | undefined): LocaleProperties;
+    /**
+     * Determines whether a translation is required based on the source and target locales.
+     *
+     * @param {string} [sourceLocale=this.sourceLocale] - The locale code for the original content
+     * @param {string} [targetLocale=this.targetLocale] - The locale code to translate into
+     * @param {string[]} [approvedLocales=this.locales] - Optional array of approved target locales
+     * @returns {boolean} True if translation is required, false otherwise
+     * @throws {Error} If no source locale is provided
+     * @throws {Error} If no target locale is provided
+     *
+     * @example
+     * gt.requiresTranslation('en-US', 'es-ES');
+     * // Returns: true
+     */
+    requiresTranslation(sourceLocale?: string | undefined, targetLocale?: string | undefined, approvedLocales?: string[] | undefined): boolean;
+    /**
+     * Determines the best matching locale from the provided approved locales list.
+     *
+     * @param {string | string[]} locales - A single locale or array of locales in preference order
+     * @param {string[]} [approvedLocales=this.locales] - Array of approved locales in preference order
+     * @returns {string | undefined} The best matching locale or undefined if no match is found
+     *
+     * @example
+     * gt.determineLocale(['fr-CA', 'fr-FR'], ['en-US', 'fr-FR', 'es-ES']);
+     * // Returns: "fr-FR"
+     */
+    determineLocale(locales: string | string[], approvedLocales?: string[] | undefined): string | undefined;
+    /**
+     * Gets the text direction for a given locale code.
+     *
+     * @param {string} [locale=this.targetLocale] - A BCP-47 locale code
+     * @returns {'ltr' | 'rtl'} 'rtl' if the locale is right-to-left, otherwise 'ltr'
+     * @throws {Error} If no target locale is provided
+     *
+     * @example
+     * gt.getLocaleDirection('ar-SA');
+     * // Returns: "rtl"
+     */
+    getLocaleDirection(locale?: string | undefined): 'ltr' | 'rtl';
+    /**
+     * Checks if a given BCP 47 locale code is valid.
+     *
+     * @param {string} [locale=this.targetLocale] - The BCP 47 locale code to validate
+     * @returns {boolean} True if the locale code is valid, false otherwise
+     * @throws {Error} If no target locale is provided
+     *
+     * @example
+     * gt.isValidLocale('en-US');
+     * // Returns: true
+     */
+    isValidLocale(locale?: string | undefined): boolean;
+    /**
+     * Standardizes a BCP 47 locale code to ensure correct formatting.
+     *
+     * @param {string} [locale=this.targetLocale] - The BCP 47 locale code to standardize
+     * @returns {string} The standardized locale code or empty string if invalid
+     * @throws {Error} If no target locale is provided
+     *
+     * @example
+     * gt.standardizeLocale('en_us');
+     * // Returns: "en-US"
+     */
+    standardizeLocale(locale?: string | undefined): string;
+    /**
+     * Checks if multiple BCP 47 locale codes represent the same dialect.
+     *
+     * @param {...(string | string[])} locales - The BCP 47 locale codes to compare
+     * @returns {boolean} True if all codes represent the same dialect, false otherwise
+     *
+     * @example
+     * gt.isSameDialect('en-US', 'en-GB');
+     * // Returns: false
+     *
+     * gt.isSameDialect('en', 'en-US');
+     * // Returns: true
+     */
+    isSameDialect(...locales: (string | string[])[]): boolean;
+    /**
+     * Checks if multiple BCP 47 locale codes represent the same language.
+     *
+     * @param {...(string | string[])} locales - The BCP 47 locale codes to compare
+     * @returns {boolean} True if all codes represent the same language, false otherwise
+     *
+     * @example
+     * gt.isSameLanguage('en-US', 'en-GB');
+     * // Returns: true
+     */
+    isSameLanguage(...locales: (string | string[])[]): boolean;
+    /**
+     * Checks if a locale is a superset of another locale.
+     *
+     * @param {string} superLocale - The locale to check if it is a superset
+     * @param {string} subLocale - The locale to check if it is a subset
+     * @returns {boolean} True if superLocale is a superset of subLocale, false otherwise
+     *
+     * @example
+     * gt.isSupersetLocale('en', 'en-US');
+     * // Returns: true
+     *
+     * gt.isSupersetLocale('en-US', 'en');
+     * // Returns: false
+     */
+    isSupersetLocale(superLocale: string, subLocale: string): boolean;
+    static formatMessage(message: string, options?: {
+        locales?: string[];
+        variables?: FormatVariables;
+    }): string;
+    /**
+     * Formats a number according to the specified locales and options.
+     * @param {Object} params - The parameters for the number formatting.
+     * @param {number} params.value - The number to format.
+     * @param {Intl.NumberFormatOptions} [params.options] - Additional options for number formatting.
+     * @param {string[]} [params.options.locales] - The locales to use for formatting.
+     * @returns {string} The formatted number.
+     */
+    static formatNum(number: number, options: {
+        locales: string[];
+    } & Intl.NumberFormatOptions): string;
+    /**
+     * Formats a date according to the specified languages and options.
+     * @param {Object} params - The parameters for the date formatting.
+     * @param {Date} params.value - The date to format.
+     * @param {Intl.DateTimeFormatOptions} [params.options] - Additional options for date formatting.
+     * @param {string[]} [params.options.locales] - The languages to use for formatting.
+     * @returns {string} The formatted date.
+     */
+    static formatDateTime(date: Date, options?: {
+        locales?: string[];
+    } & Intl.DateTimeFormatOptions): string;
+    /**
+     * Formats a currency value according to the specified languages, currency, and options.
+     * @param {Object} params - The parameters for the currency formatting.
+     * @param {number} params.value - The currency value to format.
+     * @param {string} params.currency - The currency code (e.g., 'USD').
+     * @param {Intl.NumberFormatOptions} [params.options={}] - Additional options for currency formatting.
+     * @param {string[]} [params.options.locales] - The locale codes to use for formatting.
+     * @returns {string} The formatted currency value.
+     */
+    static formatCurrency(value: number, currency: string, options: {
+        locales: string[];
+    } & Intl.NumberFormatOptions): string;
+    /**
+     * Formats a list of items according to the specified locales and options.
+     * @param {Object} params - The parameters for the list formatting.
+     * @param {Array<string | number>} params.value - The list of items to format.
+     * @param {Intl.ListFormatOptions} [params.options={}] - Additional options for list formatting.
+     * @param {string[]} [params.options.locales] - The locales to use for formatting.
+     * @returns {string} The formatted list.
+     */
+    static formatList(array: Array<string | number>, options: {
+        locales: string[];
+    } & Intl.ListFormatOptions): string;
+    /**
+     * Formats a relative time value according to the specified locales and options.
+     * @param {Object} params - The parameters for the relative time formatting.
+     * @param {number} params.value - The relative time value to format.
+     * @param {Intl.RelativeTimeFormatUnit} params.unit - The unit of time (e.g., 'second', 'minute', 'hour', 'day', 'week', 'month', 'year').
+     * @param {Intl.RelativeTimeFormatOptions} [params.options={}] - Additional options for relative time formatting.
+     * @param {string[]} [params.options.locales] - The locales to use for formatting.
+     * @returns {string} The formatted relative time string.
+     */
+    static formatRelativeTime(value: number, unit: Intl.RelativeTimeFormatUnit, options: {
+        locales: string[];
+    } & Omit<Intl.RelativeTimeFormatOptions, 'locales'>): string;
+    /**
+     * Retrieves the display name of locale code using Intl.DisplayNames.
+     *
+     * @param {string} locale - A BCP-47 locale code.
+     * @param {string} [defaultLocale] - The default locale to use for formatting.
+     * @param {CustomMapping} [customMapping] - A custom mapping of locale codes to their names.
+     * @returns {string} The display name corresponding to the code.
+     */
+    static getLocaleName(locale: string, defaultLocale?: string, customMapping?: CustomMapping): string;
     /**
      * Generates linguistic details for a given locale code.
      *
@@ -87,6 +423,8 @@ export declare class GT {
      * The function provides these names in both your default language and native forms, and an associated emoji.
      *
      * @param {string} locale - The locale code to get properties for (e.g., "de-AT").
+     * @param {string} [defaultLocale] - The default locale to use for formatting.
+     * @param {CustomMapping} [customMapping] - A custom mapping of locale codes to their names.
      * @returns {LocaleProperties} - An object containing detailed information about the locale.
      *
      * @property {string} code - The full locale code, e.g., "de-AT".
@@ -111,232 +449,68 @@ export declare class GT {
      * @property {string} nativeMinimizedName - Minimized language name in the native language, e.g., "Österreichisches Deutsch".
      * @property {string} emoji - The emoji associated with the locale's region, if applicable.
      */
-    getLocaleProperties(locale: string): LocaleProperties;
+    static getLocaleProperties(locale: string, defaultLocale?: string, customMapping?: CustomMapping): LocaleProperties;
+    /**
+     * Determines whether a translation is required based on the source and target locales.
+     *
+     * - If the target locale is not specified, the function returns `false`, as translation is not needed.
+     * - If the source and target locale are the same, returns `false`, indicating that no translation is necessary.
+     * - If the `approvedLocales` array is provided, and the target locale is not within that array, the function also returns `false`.
+     * - Otherwise, it returns `true`, meaning that a translation is required.
+     *
+     * @param {string} sourceLocale - The locale code for the original content (BCP 47 locale code).
+     * @param {string} targetLocale - The locale code of the language to translate the content into (BCP 47 locale code).
+     * @param {string[]} [approvedLocale] - An optional array of approved target locales.
+     *
+     * @returns {boolean} - Returns `true` if translation is required, otherwise `false`.
+     */
+    static requiresTranslation(sourceLocale: string, targetLocale: string, approvedLocales?: string[]): boolean;
+    /**
+     * Determines the best matching locale from the provided approved locales list.
+     * @param {string | string[]} locales - A single locale or an array of locales sorted in preference order.
+     * @param {string[]} [approvedLocales=this.locales] - An array of approved locales, also sorted by preference.
+     * @returns {string | undefined} - The best matching locale from the approvedLocales list, or undefined if no match is found.
+     */
+    static determineLocale(locales: string | string[], approvedLocales?: string[] | undefined): string | undefined;
+    /**
+     * Get the text direction for a given locale code using the Intl.Locale API.
+     *
+     * @param {string} locale - A BCP-47 locale code.
+     * @returns {string} - 'rtl' if the locale is right-to-left, otherwise 'ltr'.
+     */
+    static getLocaleDirection(locale: string): 'ltr' | 'rtl';
+    /**
+     * Checks if a given BCP 47 locale code is valid.
+     * @param {string} locale - The BCP 47 locale code to validate.
+     * @returns {boolean} True if the BCP 47 code is valid, false otherwise.
+     */
+    static isValidLocale(locale: string): boolean;
+    /**
+     * Standardizes a BCP 47 locale code to ensure correct formatting.
+     * @param {string} locale - The BCP 47 locale code to standardize.
+     * @returns {string} The standardized BCP 47 locale code or an empty string if it is an invalid code.
+     */
+    static standardizeLocale(locale: string): string;
+    /**
+     * Checks if multiple BCP 47 locale codes represent the same dialect.
+     * @param {string[]} locales - The BCP 47 locale codes to compare.
+     * @returns {boolean} True if all BCP 47 codes represent the same dialect, false otherwise.
+     */
+    static isSameDialect(...locales: (string | string[])[]): boolean;
+    /**
+     * Checks if multiple BCP 47 locale codes represent the same language.
+     * @param {string[]} locales - The BCP 47 locale codes to compare.
+     * @returns {boolean} True if all BCP 47 codes represent the same language, false otherwise.
+     */
+    static isSameLanguage(...locales: (string | string[])[]): boolean;
+    /**
+     * Checks if a locale is a superset of another locale.
+     * A subLocale is a subset of superLocale if it is an extension of superLocale or are otherwise identical.
+     *
+     * @param {string} superLocale - The locale to check if it is a superset of the other locale.
+     * @param {string} subLocale - The locale to check if it is a subset of the other locale.
+     * @returns {boolean} True if the first locale is a superset of the second locale, false otherwise.
+     */
+    static isSupersetLocale(superLocale: string, subLocale: string): boolean;
 }
-/**
- * Get the text direction for a given locale code using the Intl.Locale API.
- *
- * @param locale - A BCP-47 locale code.
- * @returns {string} - 'rtl' if the locale is right-to-left, otherwise 'ltr'.
- */
-export declare function getLocaleDirection(locale: string): 'ltr' | 'rtl';
-/**
- * Retrieves the display name of locale code using Intl.DisplayNames.
- *
- * @param {string} locale - A BCP-47 locale code.
- * @param {string} [defaultLocale = 'en'] - The locale for display names.
- * @param {FullCustomMapping} [customMapping] - Optional custom mapping of locale codes to names.
- * @returns {string} The display name corresponding to the code.
- */
-export declare function getLocaleName(locale: string, defaultLocale?: string, customMapping?: FullCustomMapping): string;
-/**
- * Generates linguistic details for a given locale code.
- *
- * This function returns information about the locale,
- * script, and region of a given language code both in a standard form and in a maximized form (with likely script and region).
- * The function provides these names in both your default language and native forms, and an associated emoji.
- *
- * @param {string} locale - The locale code to get properties for (e.g., "de-AT").
- * @param {string} [defaultLocale=libraryDefaultLocale] - The default locale code for display names.
- * @param {FullCustomMapping} [customMapping] - Optional custom mapping of locale codes to properties.
- * @returns {LocaleProperties} - An object containing detailed information about the locale.
- *
- * @property {string} code - The full locale code, e.g., "de-AT".
- * @property {string} name - Language name in the default display language, e.g., "Austrian German".
- * @property {string} nativeName - Language name in the locale's native language, e.g., "Österreichisches Deutsch".
- * @property {string} languageCode - The base language code, e.g., "de".
- * @property {string} languageName - The language name in the default display language, e.g., "German".
- * @property {string} nativeLanguageName - The language name in the native language, e.g., "Deutsch".
- * @property {string} nameWithRegionCode - Language name with region in the default language, e.g., "German (AT)".
- * @property {string} nativeNameWithRegionCode - Language name with region in the native language, e.g., "Deutsch (AT)".
- * @property {string} regionCode - The region code from maximization, e.g., "AT".
- * @property {string} regionName - The region name in the default display language, e.g., "Austria".
- * @property {string} nativeRegionName - The region name in the native language, e.g., "Österreich".
- * @property {string} scriptCode - The script code from maximization, e.g., "Latn".
- * @property {string} scriptName - The script name in the default display language, e.g., "Latin".
- * @property {string} nativeScriptName - The script name in the native language, e.g., "Lateinisch".
- * @property {string} maximizedCode - The maximized locale code, e.g., "de-Latn-AT".
- * @property {string} maximizedName - Maximized locale name with likely script in the default language, e.g., "Austrian German (Latin)".
- * @property {string} nativeMaximizedName - Maximized locale name in the native language, e.g., "Österreichisches Deutsch (Lateinisch)".
- * @property {string} minimizedCode - Minimized locale code, e.g., "de-AT" (or "de" for "de-DE").
- * @property {string} minimizedName - Minimized language name in the default language, e.g., "Austrian German".
- * @property {string} nativeMinimizedName - Minimized language name in the native language, e.g., "Österreichisches Deutsch".
- * @property {string} emoji - The emoji associated with the locale's region, if applicable.
- */
-export declare function getLocaleProperties(locale: string, defaultLocale?: string, customMapping?: FullCustomMapping): {
-    code: string;
-    name: string;
-    nativeName: string;
-    languageCode: string;
-    languageName: string;
-    nativeLanguageName: string;
-    nameWithRegionCode: string;
-    nativeNameWithRegionCode: string;
-    regionCode: string;
-    regionName: string;
-    nativeRegionName: string;
-    scriptCode: string;
-    scriptName: string;
-    nativeScriptName: string;
-    maximizedCode: string;
-    maximizedName: string;
-    nativeMaximizedName: string;
-    minimizedCode: string;
-    minimizedName: string;
-    nativeMinimizedName: string;
-    emoji: string;
-};
-/**
- * Retrieves an emoji based on a given locale code, taking into account region, language, and specific exceptions.
- * This function uses the locale's region (if present) to select an emoji or falls back on default emojis for certain languages.
- *
- * @param locale - A string representing the locale code (e.g., 'en-US', 'fr-CA').
- * @param customMapping - An optional custom mapping of locale codes to emojis.
- * @returns The emoji representing the locale or its region, or a default emoji if no specific match is found.
- */
-export declare function getLocaleEmoji(locale: string, customMapping?: FullCustomMapping): string;
-/**
- * Checks if a given BCP 47 locale code is valid.
- * @param {string} locale - The BCP 47 locale code to validate.
- * @returns {boolean} True if the BCP 47 code is valid, false otherwise.
- */
-export declare function isValidLocale(locale: string): boolean;
-/**
- * Standardizes a BCP 47 locale code to ensure correct formatting.
- * @param {string} locale - The BCP 47 locale code to standardize.
- * @returns {string} The standardized BCP 47 locale code or an empty string if it is an invalid code.
- */
-export declare function standardizeLocale(locale: string): string;
-/**
- * Checks if multiple BCP 47 locale codes represent the same dialect.
- *
- * For example, `"en-US"` and `"en-GB"` are the same language, but different dialects.
- * `isSameDialect("en-US", "en-GB")` would return `false`.
- *
- * For checking if two locale codes represent the same language, see `isSameLanguage()`.
- *
- * Note that `isSameDialect("en", "en-US")` and `isSameDialect("en", "en-GB")` would both return true.
- *
- * @param {string[]} locales - The BCP 47 locale codes to compare.
- * @returns {boolean} True if all BCP 47 codes represent the same dialect, false otherwise.
- */
-export declare function isSameDialect(...locales: (string | string[])[]): boolean;
-/**
- * Checks if multiple BCP 47 locale codes represent the same language.
- *
- * For example, `"en-US"` and `"en-GB"` are the same language, English.
- * `isSameDialect("en-US", "en-GB")` would return `true`.
- *
- * For checking if two codes represent the exact same dialect, see `isSameDialect()`.
- *
- * @param {string[]} locales - The BCP 47 locale codes to compare.
- * @returns {boolean} True if all BCP 47 codes represent the same locale, false otherwise.
- */
-export declare function isSameLanguage(...locales: (string | string[])[]): boolean;
-/**
- * Checks if a locale is a superset of another locale.
- * A subLocale is a subset of superLocale if it is an extension of superLocale or are otherwise identical.
- *
- * `isSupersetLocale("en", "en-US")` would return `true`.
- * `isSupersetLocale("en-US", "en")` would return `false`.
- *
- * @param {string} superLocale - The locale to check if it is a superset of the other locale.
- * @param {string} subLocale - The locale to check if it is a subset of the other locale.
- * @returns {boolean} True if the first locale is a superset of the second locale, false otherwise.
- */
-export declare function isSupersetLocale(superLocale: string, subLocale: string): boolean;
-/**
- * Formats a number according to the specified locales and options.
- * @param {Object} params - The parameters for the number formatting.
- * @param {number} params.value - The number to format.
- * @param {string | string[]} [params.locales=['en']] - The locales to use for formatting.
- * @param {Intl.NumberFormatOptions} [params.options={}] - Additional options for number formatting.
- * @returns {string} The formatted number.
- */
-export declare function formatNum(number: number, options?: {
-    locales?: string | string[];
-} & Intl.NumberFormatOptions): string;
-/**
- * Formats a date according to the specified languages and options.
- * @param {Object} params - The parameters for the date formatting.
- * @param {Date} params.value - The date to format.
- * @param {string | string[]} [params.locales=['en']] - The languages to use for formatting.
- * @param {Intl.DateTimeFormatOptions} [params.options={}] - Additional options for date formatting.
- * @returns {string} The formatted date.
- */
-export declare function formatDateTime(date: Date, options?: {
-    locales?: string | string[];
-} & Intl.DateTimeFormatOptions): string;
-/**
- * Formats a currency value according to the specified languages, currency, and options.
- * @param {Object} params - The parameters for the currency formatting.
- * @param {number} params.value - The currency value to format.
- * @param {string} params.currency - The currency code (e.g., 'USD').
- * @param {string | string[]} [params.locales=['en']] - The locale codes to use for formatting.
- * @param {Intl.NumberFormatOptions} [params.options={}] - Additional options for currency formatting.
- * @returns {string} The formatted currency value.
- */
-export declare function formatCurrency(value: number, currency: string, options?: {
-    locales?: string | string[];
-} & Intl.NumberFormatOptions): string;
-/**
- * Formats a list of items according to the specified locales and options.
- * @param {Object} params - The parameters for the list formatting.
- * @param {Array<string | number>} params.value - The list of items to format.
- * @param {string | string[]} [params.locales=['en']] - The locales to use for formatting.
- * @param {Intl.ListFormatOptions} [params.options={}] - Additional options for list formatting.
- * @returns {string} The formatted list.
- */
-export declare function formatList(array: Array<string | number>, options: {
-    locales?: string | string[];
-} & Intl.ListFormatOptions): string;
-/**
- * Formats a relative time value according to the specified locales and options.
- * @param {Object} params - The parameters for the relative time formatting.
- * @param {number} params.value - The relative time value to format.
- * @param {Intl.RelativeTimeFormatUnit} params.unit - The unit of time (e.g., 'second', 'minute', 'hour', 'day', 'week', 'month', 'year').
- * @param {string | string[]} [params.locales=['en']] - The locales to use for formatting.
- * @param {Intl.RelativeTimeFormatOptions} [params.options={}] - Additional options for relative time formatting.
- * @returns {string} The formatted relative time string.
- */
-export declare function formatRelativeTime(value: number, unit: Intl.RelativeTimeFormatUnit, options: {
-    locales?: string | string[];
-} & Intl.RelativeTimeFormatOptions): string;
-/**
- * Splits a string into an array of text and variable objects.
- * @param {string} string - The input string to split.
- * @returns {Content} - An array containing strings and variables.
- */
-export declare function splitStringToContent(string: string): Content;
-/**
- * Renders content to a string by replacing variables with their formatted values.
- * @param {Content} content - The content to render.
- * @param {string | string[]} [locales='en'] - The locale(s) to use for formatting.
- * @param {Record<string, any>} [variables={}] - An object containing variable values.
- * @param {Record<string, any>} [variableOptions={}] - An object containing options for formatting variables.
- * @returns {string} - The rendered string with variables replaced by their formatted values.
- */
-export declare function renderContentToString(content: Content, locales?: string | string[], variables?: Record<string, any>, variableOptions?: Record<string, any>): string;
-/**
- * Determines the best matching locale from the provided approved locales list.
- * @param {string | string[]} locales - A single locale or an array of locales sorted in preference order.
- * @param {string[]} approvedLocales - An array of approved locales, also sorted by preference.
- * @returns {string | undefined} - The best matching locale from the approvedLocales list, or undefined if no match is found.
- */
-export declare function determineLocale(locales: string | string[], approvedLocales: string[]): string | undefined;
-/**
- * Determines whether a translation is required based on the source and target locales.
- *
- * - If the target locale is not specified, the function returns `false`, as translation is not needed.
- * - If the source and target locale are the same, returns `false`, indicating that no translation is necessary.
- * - If the `approvedLocales` array is provided, and the target locale is not within that array, the function also returns `false`.
- * - Otherwise, it returns `true`, meaning that a translation is required.
- *
- * @param {string} sourceLocale - The locale code for the original content (BCP 47 locale code).
- * @param {string} targetLocale - The locale code of the language to translate the content into (BCP 47 locale code).
- * @param {string[]} [approvedLocale] - An optional array of approved target locales.
- *
- * @returns {boolean} - Returns `true` if translation is required, otherwise `false`.
- */
-export declare function requiresTranslation(sourceLocale: string, targetLocale: string, approvedLocales?: string[]): boolean;
 export {};