generaltranslation 8.2.12 → 8.2.14

package/dist/index.d.ts

@@ -0,0 +1,786 @@
+import { LocaleConfig } from '@generaltranslation/format';
+import type { CustomMapping, CustomRegionMapping, CutoffFormatOptions, FormatVariables, LocaleProperties, StringFormat } from '@generaltranslation/format/types';
+import { TranslateManyResult, TranslationError, TranslationResult, EnqueueFilesResult, CheckFileTranslationsOptions, DownloadFileBatchOptions, DownloadFileBatchResult, DownloadFileOptions, TranslateManyEntry } from './types';
+import { SetupProjectResult, SetupProjectOptions } from './translate/setupProject';
+import { EnqueueOptions } from './translate/enqueueFiles';
+import { CreateTagOptions, CreateTagResult } from './translate/createTag';
+import { FileQuery, FileQueryResult } from './types-dir/api/checkFileTranslations';
+import { SubmitUserEditDiffsPayload } from './translate/submitUserEditDiffs';
+import { FileUpload, UploadFilesOptions, UploadFilesResponse } from './types-dir/api/uploadFiles';
+import { ProjectData } from './types-dir/api/project';
+import { DownloadFileBatchRequest } from './types-dir/api/downloadFileBatch';
+import { CheckJobStatusResult } from './translate/checkJobStatus';
+import { AwaitJobsOptions, AwaitJobsResult } from './translate/awaitJobs';
+import type { FileDataQuery, FileDataResult } from './translate/queryFileData';
+import type { BranchQuery } from './translate/queryBranchData';
+import type { BranchDataResult } from './types-dir/api/branch';
+import type { CreateBranchQuery, CreateBranchResult } from './translate/createBranch';
+import type { FileReference, FileReferenceIds } from './types-dir/api/file';
+import { type MoveMapping, type ProcessMovesResponse, type ProcessMovesOptions } from './translate/processFileMoves';
+import { type GetOrphanedFilesResult } from './translate/getOrphanedFiles';
+import { type PublishFileEntry, type PublishFilesResult } from './translate/publishFiles';
+import { TranslateOptions } from './types-dir/api/entry';
+export { LocaleConfig, type LocaleConfigConstructorParams, } from '@generaltranslation/format';
+export { determineLocale, formatCurrency, formatCutoff, formatDateTime, formatList, formatListToParts, formatMessage, formatNum, formatRelativeTime, formatRelativeTimeFromDate, getLocaleDirection, getLocaleEmoji, getLocaleName, getLocaleProperties, getRegionProperties, isSameDialect, isSameLanguage, isSupersetLocale, isValidLocale, requiresTranslation, resolveAliasLocale, resolveCanonicalLocale, standardizeLocale, } from '@generaltranslation/format';
+/**
+ * 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[];
+    /** Custom mapping for locale codes to their names */
+    customMapping?: CustomMapping;
+    /** Lazily derived reverse custom mapping for alias locales */
+    reverseCustomMapping?: Record<string, string>;
+    /** Lazily derived custom mapping for regions */
+    customRegionMapping?: CustomRegionMapping;
+    /** Runtime-safe locale and formatting helpers (backing field) */
+    private _localeConfig;
+    /** Runtime-safe locale and formatting helpers */
+    get localeConfig(): LocaleConfig;
+    /**
+     * 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;
+    /**
+     * Queries branch information from the API.
+     *
+     * @param {BranchQuery} query - Object mapping the current branch and incoming branches
+     * @returns {Promise<BranchDataResult>} The branch information.
+     */
+    queryBranchData(query: BranchQuery): Promise<BranchDataResult>;
+    /**
+     * Creates a new branch in the API. If the branch already exists, it will be returned.
+     *
+     * @param {CreateBranchQuery} query - Object mapping the branch name and default branch flag
+     * @returns {Promise<CreateBranchResult>} The created branch information.
+     */
+    createBranch(query: CreateBranchQuery): Promise<CreateBranchResult>;
+    /**
+     * Processes file moves by cloning source files and translations with new fileIds.
+     * This is called when files have been moved/renamed and we want to preserve translations.
+     *
+     * @param {MoveMapping[]} moves - Array of move mappings (old fileId to new fileId)
+     * @param {ProcessMovesOptions} options - Options including branchId and timeout
+     * @returns {Promise<ProcessMovesResponse>} The move processing results.
+     *
+     * @example
+     * const result = await gt.processFileMoves([
+     *   { oldFileId: 'abc123', newFileId: 'def456', newFileName: 'locales/en.json' }
+     * ], { branchId: 'main' });
+     */
+    processFileMoves(moves: MoveMapping[], options?: ProcessMovesOptions): Promise<ProcessMovesResponse>;
+    /**
+     * Gets orphaned files for a branch - files that exist on the branch
+     * but whose fileIds are not in the provided list.
+     * Used for move detection.
+     *
+     * @param {string} branchId - The branch to check for orphaned files.
+     * @param {string[]} fileIds - List of current file IDs (files that are NOT orphaned)
+     * @param {Object} options - Options including timeout.
+     * @returns {Promise<GetOrphanedFilesResult>} The orphaned files.
+     *
+     * @example
+     * const result = await gt.getOrphanedFiles('branch-id', ['file-1', 'file-2']);
+     */
+    getOrphanedFiles(branchId: string, fileIds: string[], options?: {
+        timeout?: number;
+    }): Promise<GetOrphanedFilesResult>;
+    /**
+     * Enqueues project setup job using the specified file references
+     *
+     * This method creates setup jobs that will process source file references
+     * and generate a project setup. The files parameter contains references (IDs) to source
+     * files that have already been uploaded via uploadSourceFiles. The setup jobs are queued
+     * for processing and will generate a project setup based on the source files.
+     *
+     * @param {FileReference[]} files - Array of file references containing IDs of previously uploaded source files
+     * @param {SetupProjectOptions} [options] - Optional settings for target locales and timeout.
+     * @returns {Promise<SetupProjectResult>} Object containing the jobId and status
+     */
+    setupProject(files: FileReference[], options?: SetupProjectOptions): Promise<SetupProjectResult>;
+    /**
+     * Checks the current status of one or more project jobs by their unique identifiers.
+     *
+     * This method polls the API to determine whether one or more jobs are still running,
+     * have completed successfully, or have failed. Jobs are created after calling either enqueueFiles or setupProject.
+     *
+     * @param {string[]} jobIds - The unique identifiers of the jobs to check.
+     * @param {number} [timeoutMs] - Optional timeout in milliseconds for the API request.
+     * @returns {Promise<CheckJobStatusResult>} Object containing the job status.
+     *
+     * @example
+     * const result = await gt.checkJobStatus([
+     *   'job-123',
+     *   'job-456',
+     * ], {
+     *   timeout: 10000,
+     * });
+     */
+    checkJobStatus(jobIds: string[], timeoutMs?: number): Promise<CheckJobStatusResult>;
+    /**
+     * Polls job statuses until all jobs from enqueueFiles are finished or the timeout is reached.
+     *
+     * @param {EnqueueFilesResult} enqueueResult - The result returned from enqueueFiles.
+     * @param {AwaitJobsOptions} [options] - Polling configuration (interval, timeout).
+     * @returns {Promise<AwaitJobsResult>} The final status of all jobs and whether they all completed.
+     */
+    awaitJobs(enqueueResult: EnqueueFilesResult, options?: AwaitJobsOptions): Promise<AwaitJobsResult>;
+    /**
+     * Enqueues translation jobs for previously uploaded source files.
+     *
+     * This method creates translation jobs that will process existing source files
+     * and generate translations in the specified target languages. The files parameter
+     * contains references (IDs) to source files that have already been uploaded via
+     * uploadSourceFiles. The translation jobs are queued for processing and will
+     * generate translated content based on the source files and target locales provided.
+     *
+     * @param {FileReferenceIds[]} files - Array of file references containing IDs of previously uploaded source files
+     * @param {EnqueueOptions} options - Configuration options including source locale, target locales, and job settings.
+     * @returns {Promise<EnqueueFilesResult>} Result containing job IDs, queue status, and processing information.
+     */
+    enqueueFiles(files: FileReferenceIds[], options: EnqueueOptions): Promise<EnqueueFilesResult>;
+    /**
+     * Creates or upserts a file tag, associating a set of source files
+     * with a user-defined tag ID and optional message.
+     *
+     * @param {CreateTagOptions} options - Tag creation options including tagId, sourceFileIds, and optional message
+     * @returns {Promise<CreateTagResult>} The created or updated tag.
+     */
+    createTag(options: CreateTagOptions): Promise<CreateTagResult>;
+    /**
+     * Publishes or unpublishes files on the CDN.
+     *
+     * @param {PublishFileEntry[]} files - Array of file entries with publish flags
+     * @returns {Promise<PublishFilesResult>} Result containing per-file success/failure
+     */
+    publishFiles(files: PublishFileEntry[]): Promise<PublishFilesResult>;
+    /**
+     * Submits user edit diffs for existing translations so future generations preserve user intent.
+     *
+     * @param {SubmitUserEditDiffsPayload} payload - Project-scoped diff payload.
+     * @returns {Promise<void>} Resolves when submission succeeds.
+     */
+    submitUserEditDiffs(payload: SubmitUserEditDiffsPayload): Promise<void>;
+    /**
+     * Queries data about one or more source or translation files.
+     *
+     * @param {FileDataQuery} data - Object mapping source and translation file information.
+     * @param {CheckFileTranslationsOptions} options - Options for the API call.
+     * @returns {Promise<FileDataResult>} The source and translation file data information.
+     *
+     * @example
+     * const result = await gt.queryFileData({
+     *   sourceFiles: [
+     *     { fileId: '1234567890', versionId: '1234567890', branchId: '1234567890' },
+     *   ],
+     *   translatedFiles: [
+     *     { fileId: '1234567890', versionId: '1234567890', branchId: '1234567890', locale: 'es-ES' },
+     *   ],
+     * }, {
+     *   timeout: 10000,
+     * });
+     *
+     */
+    queryFileData(data: FileDataQuery, options?: CheckFileTranslationsOptions): Promise<FileDataResult>;
+    /**
+     * Gets source and translation information for a given file ID and version ID.
+     *
+     * @param {FileQuery} data - File query containing file ID and version ID.
+     * @param {CheckFileTranslationsOptions} options - Options for getting source and translation information.
+     * @returns {Promise<FileQueryResult>} The source file and translation information.
+     *
+     * @example
+     * const result = await gt.querySourceFile(
+     *   { fileId: '1234567890', versionId: '1234567890' },
+     *   { timeout: 10000 }
+     * );
+     *
+     */
+    querySourceFile(data: FileQuery, options?: CheckFileTranslationsOptions): Promise<FileQueryResult>;
+    /**
+     * Get project data for a given project ID.
+     *
+     * @param {string} projectId - The ID of the project to get the data for.
+     * @returns {Promise<ProjectData>} The project data.
+     *
+     * @example
+     * const result = await gt.getProjectData(
+     *   '1234567890'
+     * );
+     *
+     */
+    getProjectData(projectId: string, options?: {
+        timeout?: number;
+    }): Promise<ProjectData>;
+    /**
+     * Downloads a single file.
+     *
+     * @param file - The file query object.
+     * @param {string} file.fileId - The ID of the file to download.
+     * @param {string} [file.branchId] - The ID of the branch to download the file from. If not provided, the default branch will be used.
+     * @param {string} [file.locale] - The locale to download the file for. If not provided, the source file will be downloaded.
+     * @param {string} [file.versionId] - The version ID to download the file from. If not provided, the latest version will be used.
+     * @param {DownloadFileOptions} options - Options for downloading the file.
+     * @returns {Promise<string>} The downloaded file content.
+     *
+     * @example
+     * const result = await gt.downloadFile({
+     *   fileId: '1234567890',
+     *   branchId: '1234567890',
+     *   locale: 'es-ES',
+     *   versionId: '1234567890',
+     * }, {
+     *   timeout: 10000,
+     * });
+     */
+    downloadFile(file: {
+        fileId: string;
+        branchId?: string;
+        locale?: string;
+        versionId?: string;
+        useLatestAvailableVersion?: boolean;
+    }, options?: DownloadFileOptions): Promise<string>;
+    /**
+     * Downloads multiple files in a batch.
+     *
+     * @param {DownloadFileBatchRequest} requests - Array of file query objects to download.
+     * @param {DownloadFileBatchOptions} options - Options for the batch download.
+     * @returns {Promise<DownloadFileBatchResult>} The batch download results.
+     *
+     * @example
+     * const result = await gt.downloadFileBatch([{
+     *   fileId: '1234567890',
+     *   locale: 'es-ES',
+     *   versionId: '1234567890',
+     * }], {
+     *   timeout: 10000,
+     * });
+     */
+    downloadFileBatch(requests: DownloadFileBatchRequest, options?: DownloadFileBatchOptions): Promise<DownloadFileBatchResult>;
+    /**
+     * Translates a single source string to the target locale.
+     * Routes through {@link translateMany} under the hood.
+     *
+     * @param {string} source - The source string to translate.
+     * @param {object} options - Translation options including targetLocale and optional entry metadata.
+     * @returns {Promise<TranslationResult | TranslationError>} The translated content.
+     *
+     * @example
+     * const result = await gt.translate('Hello, world!', { targetLocale: 'es' });
+     *
+     * @example
+     * const result = await gt.translate('Hello, world!', {
+     *   targetLocale: 'es',
+     *   dataFormat: 'ICU',
+     *   context: 'A formal greeting',
+     * });
+     */
+    translate(source: TranslateManyEntry, options: string | TranslateOptions, timeout?: number): Promise<TranslationResult | TranslationError>;
+    /**
+     * Translates multiple source strings to the target locale.
+     * Each entry can be a plain string or an object with source and metadata fields.
+     *
+     * @param {TranslateManyEntry[] | Record<string, TranslateManyEntry>} sources - The source entries to translate. Can be an array or a record keyed by hash.
+     * @param {object} options - Translation options including targetLocale.
+     * @returns {Promise<TranslateManyResult | Record<string, TranslationResult>>} The translated contents. An array if sources was an array, a record if sources was a record.
+     *
+     * @example
+     * const result = await gt.translateMany(
+     *   ['Hello, world!', 'Goodbye, world!'],
+     *   { targetLocale: 'es' }
+     * );
+     *
+     * @example
+     * const result = await gt.translateMany(
+     *   [{ source: 'Hello, world!', dataFormat: 'ICU' }],
+     *   { targetLocale: 'es' }
+     * );
+     *
+     * @example
+     * const result = await gt.translateMany(
+     *   { 'my-hash': 'Hello, world!' },
+     *   { targetLocale: 'es' }
+     * );
+     */
+    translateMany(sources: TranslateManyEntry[], options: string | TranslateOptions, timeout?: number): Promise<TranslateManyResult>;
+    translateMany(sources: Record<string, TranslateManyEntry>, options: string | TranslateOptions, timeout?: number): Promise<Record<string, TranslationResult>>;
+    /**
+     * Uploads source files to the translation service without any translation content.
+     *
+     * This method creates or replaces source file entries in your project. Each uploaded
+     * file becomes a source that can later be translated into target languages. The files
+     * are processed and stored as base entries that serve as the foundation for generating
+     * translations through the translation workflow.
+     *
+     * @param {Array<{source: FileUpload}>} files - Array of objects containing source file data to upload
+     * @param {UploadFilesOptions} options - Configuration options including source locale and other upload settings.
+     * @returns {Promise<UploadFilesResponse>} Upload result containing file IDs, version information, and upload status.
+     */
+    uploadSourceFiles(files: {
+        source: FileUpload;
+    }[], options: UploadFilesOptions): Promise<UploadFilesResponse>;
+    /**
+     * Uploads translation files that correspond to previously uploaded source files.
+     *
+     * This method allows you to provide translated content for existing source files in your project.
+     * Each translation must reference an existing source file and include the translated content
+     * along with the target locale information. This is used when you have pre-existing translations
+     * that you want to upload directly rather than generating them through the translation service.
+     *
+     * @param {Array<{source: FileUpload, translations: FileUpload[]}>} files - Array of file objects where:
+     *   - `source`: Reference to the existing source file (contains IDs but no content).
+     *   - `translations`: Array of translated files, each containing content, locale, and reference IDs
+     * @param {UploadFilesOptions} options - Configuration options including source locale and upload settings.
+     * @returns {Promise<UploadFilesResponse>} Upload result containing translation IDs, status, and processing information.
+     */
+    uploadTranslations(files: {
+        source: FileUpload;
+        translations: FileUpload[];
+    }[], options: UploadFilesOptions): Promise<UploadFilesResponse>;
+    /**
+     * Formats a string with cutoff behavior, applying a terminator when the string exceeds the maximum character limit.
+     *
+     * This method uses the GT instance's rendering locales by default for locale-specific terminator selection,
+     * but can be overridden with custom locales in the options.
+     *
+     * @param {string} value - The string value to format with cutoff behavior.
+     * @param {Object} [options] - Configuration options for cutoff formatting.
+     * @param {string | string[]} [options.locales] - The locales to use for terminator selection. Defaults to instance's rendering locales.
+     * @param {number} [options.maxChars] - The maximum number of characters to display.
+     * - Undefined values are treated as no cutoff.
+     * - Negative values follow .slice() behavior and terminator will be added before the value.
+     * - 0 will result in an empty string.
+     * - If cutoff results in an empty string, no terminator is added.
+     * @param {CutoffFormatStyle} [options.style='ellipsis'] - The style of the terminator.
+     * @param {string} [options.terminator] - Optional override the terminator to use.
+     * @param {string} [options.separator] - Optional override the separator to use between the terminator and the value.
+     * - If no terminator is provided, then separator is ignored.
+     * @returns {string} The formatted string with terminator applied if cutoff occurs.
+     *
+     * @example
+     * const gt = new GT({ targetLocale: 'en-US' });
+     * gt.formatCutoff('Hello, world!', { maxChars: 8 });
+     * // Returns: 'Hello, w...'
+     *
+     * @example
+     * gt.formatCutoff('Hello, world!', { maxChars: -3 });
+     * // Returns: '...ld!'
+     */
+    formatCutoff(value: string, options?: {
+        locales?: string | string[];
+    } & CutoffFormatOptions): string;
+    /**
+     * 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.
+     * @param {StringFormat} [dataFormat='ICU'] - The format of the message.
+     * @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;
+        dataFormat?: StringFormat;
+    }): 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 list of items according to the specified locales and options.
+     * @param {Array<T>} 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 {Array<T | string>} The formatted list parts.
+     *
+     * @example
+     * gt.formatListToParts(['apple', 42, { foo: 'bar' }], { type: 'conjunction', style: 'short', locales: ['en'] });
+     * // Returns: ['apple', ', ', 42, ' and ', '{ foo: "bar" }']
+     */
+    formatListToParts<T>(array: Array<T>, options?: {
+        locales?: string | string[];
+    } & Intl.ListFormatOptions): Array<T | 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;
+    /**
+     * Formats a relative time string from a Date, automatically selecting the best unit.
+     *
+     * @param {Date} date - The date to format relative to now.
+     * @param {Object} [options] - Additional options for relative time formatting.
+     * @param {string | string[]} [options.locales] - The locales to use for formatting.
+     * @returns {string} The formatted relative time string (e.g., "2 hours ago", "in 3 days")
+     *
+     * @example
+     * gt.formatRelativeTimeFromDate(new Date(Date.now() - 3600000));
+     * // Returns: "1 hour ago"
+     */
+    formatRelativeTimeFromDate(date: Date, options?: {
+        locales?: string | string[];
+        baseDate?: Date;
+    } & 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, customMapping?: CustomMapping | 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, customMapping?: CustomMapping | 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.
+     * @param {CustomMapping} [customMapping=this.customMapping] - The custom mapping to use for validation.
+     * @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, customMapping?: CustomMapping | undefined): boolean;
+    /**
+     * Resolves the canonical locale for a given locale.
+     * @param locale - The locale to resolve the canonical locale for
+     * @param customMapping - The custom mapping to use for resolving the canonical locale
+     * @returns The canonical locale, or the input locale when no canonical mapping exists.
+     */
+    resolveCanonicalLocale(locale?: string | undefined, customMapping?: CustomMapping | undefined): string;
+    /**
+     * Resolves the alias locale for a given locale.
+     * @param locale - The locale to resolve the alias locale for
+     * @param customMapping - The custom mapping to use for resolving the alias locale
+     * @returns The configured alias for a canonical locale, or the input locale when already an alias or no alias mapping exists.
+     */
+    resolveAliasLocale(locale: string, customMapping?: CustomMapping | undefined): string;
+    /**
+     * 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 the input string if it cannot be standardized.
+     * @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;
+}
+export declare const API_VERSION = "2026-03-06.v1";