generaltranslation/dist/index.d.ts

A language toolkit for AI developers

import { CustomMapping, FormatVariables, I18nextMessage, IcuMessage, TranslateManyResult, TranslationError, TranslationResult, Updates, EnqueueEntriesOptions, EnqueueEntriesResult, EnqueueFilesOptions, EnqueueFilesResult, FileToTranslate, CheckFileTranslationsOptions, CheckFileTranslationsResult, DownloadFileBatchOptions, DownloadFileBatchResult, FetchTranslationsOptions, FetchTranslationsResult, DownloadFileOptions, EntryMetadata, Entry } from './types';
import { LocaleProperties } from './locales/getLocaleProperties';
import { JsxChildren } from './internal';
import { FileTranslationQuery } from './types-dir/checkFileTranslations';
import { CheckTranslationStatusOptions, TranslationStatusResult } from './types-dir/translationStatus';
import { CustomRegionMapping } from './locales/getRegionProperties';
/**
 * 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 {
    /** Base URL for the translation service API */
    baseUrl?: string;
    /** 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;
    /** Lazily derived custom mapping for regions */
    customRegionMapping?: CustomRegionMapping;
    /**
     * Constructs an instance of the GT class.
     *
     * @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(params?: GTConstructorParams);
    setConfig({ apiKey, devApiKey, sourceLocale, targetLocale, locales, projectId, customMapping, baseUrl, }: GTConstructorParams): void;
    private _getTranslationConfig;
    private _validateAuth;
    /**
     * Enqueues translation entries for processing.
     *
     * @param {Updates} updates - The translation entries to enqueue.
     * @param {EnqueueEntriesOptions} options - Options for enqueueing entries.
     * @param {string} library - The library being used (for context).
     * @returns {Promise<EnqueueTranslationEntriesResult>} The result of the enqueue operation.
     *
     * @example
     * const gt = new GT({
     *   sourceLocale: 'en-US',
     *   targetLocale: 'es-ES',
     *   locales: ['en-US', 'es-ES', 'fr-FR']
     * });
     *
     * const result = await gt.enqueueEntries([
     *   {
     *     content: 'Hello, world!',
     *     fileName: 'Button.tsx',
     *     fileFormat: 'TS',
     *     dataFormat: 'JSX',
     *   },
     * ], {
     *   sourceLocale: 'en-US',
     *   targetLocales: ['es-ES', 'fr-FR'],
     *   publish: true,
     *   description: 'Translations for the Button component',
     * });
     */
    enqueueEntries(updates: Updates, options?: EnqueueEntriesOptions): Promise<EnqueueEntriesResult>;
    /**
     * Enqueues files for translation processing.
     *
     * @param {FileToTranslate[]} files - Array of files to enqueue for translation.
     * @param {EnqueueFilesOptions} options - Options for enqueueing files.
     * @returns {Promise<EnqueueFilesResult>} The result of the enqueue operation.
     *
     * @example
     * const gt = new GT({
     *   sourceLocale: 'en-US',
     *   targetLocale: 'es-ES',
     *   locales: ['en-US', 'es-ES', 'fr-FR']
     * });
     *
     * const result = await gt.enqueueFiles([
     *   {
     *     content: 'Hello, world!',
     *     fileName: 'Button.tsx',
     *     fileFormat: 'TS',
     *     dataFormat: 'JSX',
     *   },
     * ], {
     *   sourceLocale: 'en-US',
     *   targetLocales: ['es-ES', 'fr-FR'],
     *   publish: true,
     *   description: 'Translations for the Button component',
     * });
     */
    enqueueFiles(files: FileToTranslate[], options: EnqueueFilesOptions): Promise<EnqueueFilesResult>;
    /**
     * Checks the translation status of files.
     *
     * @param {Object} data - Object mapping source paths to file information.
     * @param {CheckFileTranslationsOptions} options - Options for checking file translations.
     * @returns {Promise<CheckFileTranslationsResult>} The file translation status information.
     *
     * @example
     * const gt = new GT({
     *   sourceLocale: 'en-US',
     *   targetLocale: 'es-ES',
     *   locales: ['en-US', 'es-ES', 'fr-FR']
     * });
     *
     * const result = await gt.checkFileTranslations([
     *   { sourcePath: 'src/components/Button.tsx', locale: 'es-ES' },
     *   { sourcePath: 'src/components/Input.tsx', locale: 'fr-FR' },
     * ], {
     *   timeout: 10000,
     * });
     *
     */
    checkFileTranslations(data: FileTranslationQuery[], options?: CheckFileTranslationsOptions): Promise<CheckFileTranslationsResult>;
    /**
     * Checks the translation status of a version.
     *
     * @param {string} versionId - The ID of the version to check.
     * @param {CheckTranslationStatusOptions} options - Options for checking the translation status.
     * @returns {Promise<TranslationStatusResult>} The translation status of the version.
     *
     * @example
     * const gt = new GT({
     *   sourceLocale: 'en-US',
     *   targetLocale: 'es-ES',
     *   locales: ['en-US', 'es-ES', 'fr-FR']
     * });
     *
     * const result = await gt.checkTranslationStatus('1234567890', {
     *   timeout: 10000,
     * });
     */
    checkTranslationStatus(versionId: string, options?: CheckTranslationStatusOptions): Promise<TranslationStatusResult>;
    /**
     * Downloads a single translation file.
     *
     * @param {string} translationId - The ID of the translation to download.
     * @param {DownloadFileOptions} options - Options for downloading the file.
     * @returns {Promise<DownloadFileResult>} The downloaded file content and metadata.
     *
     * @example
     * const gt = new GT({
     *   sourceLocale: 'en-US',
     *   targetLocale: 'es-ES',
     *   locales: ['en-US', 'es-ES', 'fr-FR']
     * });
     *
     * const result = await gt.downloadFile('1234567890', {
     *   timeout: 10000,
     * });
     */
    downloadFile(translationId: string, options?: DownloadFileOptions): Promise<ArrayBuffer>;
    /**
     * Downloads multiple translation files in a batch.
     *
     * @param {string[]} fileIds - Array of file IDs to download.
     * @param {DownloadFileBatchOptions} options - Options for the batch download.
     * @returns {Promise<DownloadFileBatchResult>} The batch download results.
     *
     * @example
     * const gt = new GT({
     *   sourceLocale: 'en-US',
     *   targetLocale: 'es-ES',
     *   locales: ['en-US', 'es-ES', 'fr-FR']
     * });
     *
     * const result = await gt.downloadFileBatch(['1234567890', '1234567891'], {
     *   timeout: 10000,
     * });
     */
    downloadFileBatch(fileIds: string[], options?: DownloadFileBatchOptions): Promise<DownloadFileBatchResult>;
    /**
     * Fetches translation metadata and information.
     *
     * @param {string} versionId - The version ID to fetch translations for.
     * @param {FetchTranslationsOptions} options - Options for fetching translations.
     * @returns {Promise<FetchTranslationsResult>} The translation metadata and information.
     *
     * @example
     * const gt = new GT({
     *   sourceLocale: 'en-US',
     *   targetLocale: 'es-ES',
     *   locales: ['en-US', 'es-ES', 'fr-FR']
     * });
     *
     * const result = await gt.fetchTranslations('1234567890');
     */
    fetchTranslations(versionId: string, options?: FetchTranslationsOptions): Promise<FetchTranslationsResult>;
    /**
     * Translates the source content to the target locale.
     * @deprecated Use the {@link translate} method instead.
     */
    _translate(source: JsxChildren, targetLocale: string, metadata?: Omit<EntryMetadata, 'dataFormat'> & {
        dataFormat?: 'JSX';
    }): Promise<TranslationResult | TranslationError>;
    _translate(source: IcuMessage, targetLocale: string, metadata?: Omit<EntryMetadata, 'dataFormat'> & {
        dataFormat?: 'ICU';
    }): Promise<TranslationResult | TranslationError>;
    _translate(source: I18nextMessage, targetLocale: string, metadata?: Omit<EntryMetadata, 'dataFormat'> & {
        dataFormat?: 'I18NEXT';
    }): Promise<TranslationResult | TranslationError>;
    /**
     * Translates the source content to the target locale.
     *
     * @param {Content} source - {@link JsxChildren} | {@link IcuMessage} | {@link I18nextMessage} The source content to translate.
     * @param {string} targetLocale - string The target locale to translate to.
     * @param {EntryMetadata} metadata - {@link EntryMetadata} The metadata for the translation.
     * @returns {Promise<TranslationResult | TranslationError>} The translated content.
     *
     * @example
     * const gt = new GT({
     *   sourceLocale: 'en-US',
     *   targetLocale: 'es-ES',
     *   locales: ['en-US', 'es-ES', 'fr-FR']
     * });
     *
     * const result = await gt.translate('Hello, world!', 'es-ES');
     *
     * @example
     * const gt = new GT({
     *   sourceLocale: 'en-US',
     *   targetLocale: 'es-ES',
     *   locales: ['en-US', 'es-ES', 'fr-FR']
     * });
     *
     * const result = await gt.translate('Hello, world!', 'es-ES', { context: 'A formal greeting'});
     */
    translate(source: JsxChildren, targetLocale: string, metadata?: Omit<EntryMetadata, 'dataFormat'> & {
        dataFormat?: 'JSX';
    }): Promise<TranslationResult | TranslationError>;
    translate(source: IcuMessage, targetLocale: string, metadata?: Omit<EntryMetadata, 'dataFormat'> & {
        dataFormat?: 'ICU';
    }): Promise<TranslationResult | TranslationError>;
    translate(source: I18nextMessage, targetLocale: string, metadata?: Omit<EntryMetadata, 'dataFormat'> & {
        dataFormat?: 'I18NEXT';
    }): Promise<TranslationResult | TranslationError>;
    /**
     * Translates multiple source contents to the target locale.
     * Override global metadata by supplying a metadata object for each request.
     *
     * @param {Entry[]} sources - The source contents to translate.
     * @param {EntryMetadata} globalMetadata - {@link EntryMetadata} The metadata for the translation.
     * @returns {Promise<TranslateManyResult>} The translated contents.
     *
     * @example
     * const gt = new GT({
     *   sourceLocale: 'en-US',
     *   targetLocale: 'es-ES',
     *   locales: ['en-US', 'es-ES', 'fr-FR']
     * });
     *
     * const result = await gt.translateMany([
     *   { source: 'Hello, world!' },
     *   { source: 'Goodbye, world!' },
     * ], { targetLocale: 'es-ES' });
     */
    translateMany(sources: Entry[], globalMetadata?: {
        targetLocale: string;
    } & EntryMetadata): Promise<TranslateManyResult>;
    /**
     * 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.
     *
     * @example
     * gt.formatMessage('Hello {name}', { name: 'John' });
     * // Returns: "Hello John"
     *
     * gt.formatMessage('Hello {name}', { name: 'John' }, { locales: ['fr'] });
     * // Returns: "Bonjour John"
     */
    formatMessage(message: string, options?: {
        locales?: string | string[];
        variables?: FormatVariables;
    }): string;
    /**
     * Formats a number according to the specified locales and options.
     *
     * @param {number} number - The number to format
     * @param {Object} [options] - Additional options for number formatting
     * @param {string | string[]} [options.locales] - The locales to use for formatting
     * @param {Intl.NumberFormatOptions} [options] - Additional Intl.NumberFormat options
     * @returns {string} The formatted number
     *
     * @example
     * gt.formatNum(1234.56, { style: 'currency', currency: 'USD' });
     * // Returns: "$1,234.56"
     */
    formatNum(number: number, options?: {
        locales?: string | string[];
    } & Intl.NumberFormatOptions): string;
    /**
     * Formats a date according to the specified locales and options.
     *
     * @param {Date} date - The date to format
     * @param {Object} [options] - Additional options for date formatting
     * @param {string | string[]} [options.locales] - The locales to use for formatting
     * @param {Intl.DateTimeFormatOptions} [options] - Additional Intl.DateTimeFormat options
     * @returns {string} The formatted date
     *
     * @example
     * gt.formatDateTime(new Date(), { dateStyle: 'full', timeStyle: 'long' });
     * // Returns: "Thursday, March 14, 2024 at 2:30:45 PM GMT-7"
     */
    formatDateTime(date: Date, options?: {
        locales?: string | string[];
    } & Intl.DateTimeFormatOptions): string;
    /**
     * Formats a currency value according to the specified locales and options.
     *
     * @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 | 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 | 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 | 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 | 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 | 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"
     */
    formatRelativeTime(value: number, unit: Intl.RelativeTimeFormatUnit, options?: {
        locales?: string | string[];
    } & Omit<Intl.RelativeTimeFormatOptions, 'locales'>): string;
    /**
     * Retrieves the display name of a locale code using Intl.DisplayNames, returning an empty string if no name is found.
     *
     * @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;
    /**
     * 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;
    /**
     * Retrieves multiple properties for a given region code, including:
     * - `code`: the original region code
     * - `name`: the localized display name
     * - `emoji`: the associated flag or symbol
     *
     * Behavior:
     * - Accepts ISO 3166-1 alpha-2 or UN M.49 region codes (e.g., `"US"`, `"FR"`, `"419"`).
     * - Uses the instance's `targetLocale` to localize the region name for the user.
     * - If `customMapping` contains a `name` or `emoji` for the region, those override the default values.
     * - Otherwise, uses `Intl.DisplayNames` to get the localized region name, falling back to `libraryDefaultLocale`.
     * - Falls back to the region code as `name` if display name resolution fails.
     * - Falls back to a default emoji if no emoji mapping is found in built-in data or `customMapping`.
     *
     * @param {string} [region=this.getLocaleProperties().regionCode] - The region code to look up (e.g., `"US"`, `"GB"`, `"DE"`).
     * @param {CustomRegionMapping} [customMapping] - Optional mapping of region codes to custom names and/or emojis.
     * @returns {{ code: string, name: string, emoji: string }} An object containing:
     *  - `code`: the input region code
     *  - `name`: the localized or custom region name
     *  - `emoji`: the matching emoji flag or symbol
     *
     * @throws {Error} If no target locale is available to determine region properties.
     *
     * @example
     * const gt = new GT({ targetLocale: 'en-US' });
     * gt.getRegionProperties('US');
     * // => { code: 'US', name: 'United States', emoji: '🇺🇸' }
     *
     * @example
     * const gt = new GT({ targetLocale: 'fr-FR' });
     * gt.getRegionProperties('US');
     * // => { code: 'US', name: 'États-Unis', emoji: '🇺🇸' }
     *
     * @example
     * gt.getRegionProperties('US', { US: { name: 'USA', emoji: '🗽' } });
     * // => { code: 'US', name: 'USA', emoji: '🗽' }
     */
    getRegionProperties(region?: string, customMapping?: CustomRegionMapping): {
        code: string;
        name: string;
        emoji: string;
    };
    /**
     * 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;
}
/**
 * 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.
 *
 * @example
 * formatMessage('Hello {name}', { name: 'John' });
 * // Returns: "Hello John"
 *
 * formatMessage('Hello {name}', { name: 'John' }, { locales: ['fr'] });
 * // Returns: "Bonjour John"
 */
export declare function formatMessage(message: string, options?: {
    locales?: string | 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 | string[]} [params.options.locales] - The locales to use for 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 {Intl.DateTimeFormatOptions} [params.options] - Additional options for date formatting.
 * @param {string | string[]} [params.options.locales] - The languages to use for 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 {Intl.NumberFormatOptions} [params.options={}] - Additional options for currency formatting.
 * @param {string | string[]} [params.options.locales] - The locale codes to use for 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 {Intl.ListFormatOptions} [params.options={}] - Additional options for list formatting.
 * @param {string | string[]} [params.options.locales] - The locales to use for 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 {Intl.RelativeTimeFormatOptions} [params.options={}] - Additional options for relative time formatting.
 * @param {string | string[]} [params.options.locales] - The locales to use for formatting.
 * @returns {string} The formatted relative time string.
 */
export declare function formatRelativeTime(value: number, unit: Intl.RelativeTimeFormatUnit, options: {
    locales: string | 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.
 */
export declare function getLocaleName(locale: string, defaultLocale?: string, customMapping?: CustomMapping): 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.
 */
export declare function 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 - 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".
 * @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?: 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`.
 */
export declare function 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.
 */
export declare function 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'.
 */
export declare function 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.
 */
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.
 * @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.
 * @param {string[]} locales - The BCP 47 locale codes to compare.
 * @returns {boolean} True if all BCP 47 codes represent the same language, 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.
 *
 * @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;
export {};