generaltranslation 8.2.13 → 8.2.14

package/dist/index.d.cts

@@ -1,5 +1,6 @@
-import { a as standardizeLocale, c as CutoffFormatOptions, i as resolveCanonicalLocale, n as formatMessage, o as LocaleConfig, r as isValidLocale, s as LocaleConfigConstructorParams, t as formatCutoff } from "./core-TLJoDpJP.cjs";
-import { $ as FileReference, A as BranchDataResult, B as FileUpload, C as ProcessMovesOptions, D as FileDataQuery, F as DownloadFileOptions, Ft as LocaleProperties, H as UploadFilesResponse, I as PublishFileEntry, It as CustomMapping, J as DownloadFileBatchOptions, L as PublishFilesResult, M as TranslationError, N as TranslationResult, O as FileDataResult, T as GetOrphanedFilesResult, U as CreateTagOptions, V as UploadFilesOptions, W as CreateTagResult, X as DownloadFileBatchResult, Y as DownloadFileBatchRequest, _ as AwaitJobsResult, _t as TranslateManyEntry, at as CheckFileTranslationsOptions, et as FileReferenceIds, g as AwaitJobsOptions, h as SubmitUserEditDiffsPayload, j as TranslateManyResult, jt as StringFormat, k as BranchQuery, n as FormatVariables, ot as FileQuery, rt as EnqueueFilesResult, st as FileQueryResult, vt as TranslateOptions, w as ProcessMovesResponse, x as MoveMapping, y as CheckJobStatusResult } from "./types-Bf8_Apq_.cjs";
+import { $ as TranslationResult, Ct as EnqueueFilesResult, Dt as FileQueryResult, Et as FileQuery, F as SubmitUserEditDiffsPayload, G as GetOrphanedFilesResult, I as AwaitJobsOptions, J as FileDataResult, L as AwaitJobsResult, Lt as TranslateManyEntry, Q as TranslationError, Rt as TranslateOptions, Tt as CheckFileTranslationsOptions, U as ProcessMovesOptions, V as MoveMapping, W as ProcessMovesResponse, X as BranchDataResult, Y as BranchQuery, Z as TranslateManyResult, bt as FileReferenceIds, ct as UploadFilesResponse, gt as DownloadFileBatchResult, ht as DownloadFileBatchRequest, lt as CreateTagOptions, mt as DownloadFileBatchOptions, nt as PublishFileEntry, ot as FileUpload, q as FileDataQuery, rt as PublishFilesResult, st as UploadFilesOptions, tt as DownloadFileOptions, ut as CreateTagResult, yt as FileReference, z as CheckJobStatusResult } from "./types-YrrGRHBP.cjs";
+import { LocaleConfig, LocaleConfig as LocaleConfig$1, LocaleConfigConstructorParams, 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";
+import { CustomMapping, CustomRegionMapping, CutoffFormatOptions, FormatVariables, LocaleProperties, StringFormat } from "@generaltranslation/format/types";
 
 //#region src/translate/setupProject.d.ts
 type SetupProjectResult = {
@@ -24,15 +25,6 @@ type EnqueueOptions = {
   timeout?: number;
 };
 //#endregion
-//#region src/locales/getRegionProperties.d.ts
-type CustomRegionMapping = {
-  [region: string]: {
-    name?: string;
-    emoji?: string;
-    locale?: string;
-  };
-};
-//#endregion
 //#region src/types-dir/api/project.d.ts
 type ProjectData = {
   id: string;
@@ -115,7 +107,7 @@ declare class GT {
   /** Runtime-safe locale and formatting helpers (backing field) */
   private _localeConfig;
   /** Runtime-safe locale and formatting helpers */
-  get localeConfig(): LocaleConfig;
+  get localeConfig(): LocaleConfig$1;
   /**
    * Constructs an instance of the GT class.
    *
@@ -825,236 +817,6 @@ declare class GT {
    */
   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 {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.
- */
-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.
- */
-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.
- */
-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.
- */
-declare function 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.
- */
-declare function 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 {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.
- */
-declare function 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 - Formatting options.
- * @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 (e.g., "2 hours ago", "in 3 days").
- */
-declare function formatRelativeTimeFromDate(date: Date, options: {
-  locales: string | string[];
-  baseDate?: Date;
-} & 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.
- */
-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.
- */
-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.
- */
-declare function getLocaleProperties(locale: string, defaultLocale?: string, customMapping?: CustomMapping): 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"`).
- * - 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 in the given `defaultLocale`,
- *   falling back to `libraryDefaultLocale`.
- * - Falls back to the region code as `name` if display name resolution fails.
- * - Falls back to `defaultEmoji` if no emoji mapping is found in `emojis` or `customMapping`.
- *
- * @param {string} region - The region code to look up (e.g., `"US"`, `"GB"`, `"DE"`).
- * @param {string} [defaultLocale=libraryDefaultLocale] - The locale to use when localizing the region name.
- * @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
- *
- * @example
- * getRegionProperties('US', 'en');
- * // => { code: 'US', name: 'United States', emoji: '🇺🇸' }
- *
- * @example
- * getRegionProperties('US', 'fr');
- * // => { code: 'US', name: 'États-Unis', emoji: '🇺🇸' }
- *
- * @example
- * getRegionProperties('US', 'en', { US: { name: 'USA', emoji: '🗽' } });
- * // => { code: 'US', name: 'USA', emoji: '🗽' }
- */
-declare function getRegionProperties(region: string, defaultLocale?: string, customMapping?: CustomRegionMapping): {
-  code: string;
-  name: string;
-  emoji: string;
-};
-/**
- * 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`.
- */
-declare function requiresTranslation(sourceLocale: string, targetLocale: string, approvedLocales?: string[], customMapping?: CustomMapping): 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.
- */
-declare function determineLocale(locales: string | string[], approvedLocales?: string[] | undefined, customMapping?: CustomMapping | 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'.
- */
-declare function getLocaleDirection(locale: string): 'ltr' | 'rtl';
-/**
- * Resolves the alias locale for a given locale.
- * @param {string} locale - The locale to resolve the alias locale for
- * @param {CustomMapping} [customMapping] - The custom mapping to use for resolving the alias locale
- * @returns {string} The alias locale
- */
-declare function resolveAliasLocale(locale: string, customMapping?: CustomMapping): 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.
- */
-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.
- */
-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.
- */
-declare function isSupersetLocale(superLocale: string, subLocale: string): boolean;
 declare const API_VERSION = "2026-03-06.v1";
 //#endregion
 export { API_VERSION, GT, LocaleConfig, type LocaleConfigConstructorParams, determineLocale, formatCurrency, formatCutoff, formatDateTime, formatList, formatListToParts, formatMessage, formatNum, formatRelativeTime, formatRelativeTimeFromDate, getLocaleDirection, getLocaleEmoji, getLocaleName, getLocaleProperties, getRegionProperties, isSameDialect, isSameLanguage, isSupersetLocale, isValidLocale, requiresTranslation, resolveAliasLocale, resolveCanonicalLocale, standardizeLocale };

package/dist/index.d.mts

@@ -1,5 +1,6 @@
-import { a as standardizeLocale, c as CutoffFormatOptions, i as resolveCanonicalLocale, n as formatMessage, o as LocaleConfig, r as isValidLocale, s as LocaleConfigConstructorParams, t as formatCutoff } from "./core-I9pWGafA.mjs";
-import { $ as FileReference, A as BranchDataResult, B as FileUpload, C as ProcessMovesOptions, D as FileDataQuery, F as DownloadFileOptions, Ft as LocaleProperties, H as UploadFilesResponse, I as PublishFileEntry, It as CustomMapping, J as DownloadFileBatchOptions, L as PublishFilesResult, M as TranslationError, N as TranslationResult, O as FileDataResult, T as GetOrphanedFilesResult, U as CreateTagOptions, V as UploadFilesOptions, W as CreateTagResult, X as DownloadFileBatchResult, Y as DownloadFileBatchRequest, _ as AwaitJobsResult, _t as TranslateManyEntry, at as CheckFileTranslationsOptions, et as FileReferenceIds, g as AwaitJobsOptions, h as SubmitUserEditDiffsPayload, j as TranslateManyResult, jt as StringFormat, k as BranchQuery, n as FormatVariables, ot as FileQuery, rt as EnqueueFilesResult, st as FileQueryResult, vt as TranslateOptions, w as ProcessMovesResponse, x as MoveMapping, y as CheckJobStatusResult } from "./types-AHtYZIP-.mjs";
+import { $ as TranslationResult, Ct as EnqueueFilesResult, Dt as FileQueryResult, Et as FileQuery, F as SubmitUserEditDiffsPayload, G as GetOrphanedFilesResult, I as AwaitJobsOptions, J as FileDataResult, L as AwaitJobsResult, Lt as TranslateManyEntry, Q as TranslationError, Rt as TranslateOptions, Tt as CheckFileTranslationsOptions, U as ProcessMovesOptions, V as MoveMapping, W as ProcessMovesResponse, X as BranchDataResult, Y as BranchQuery, Z as TranslateManyResult, bt as FileReferenceIds, ct as UploadFilesResponse, gt as DownloadFileBatchResult, ht as DownloadFileBatchRequest, lt as CreateTagOptions, mt as DownloadFileBatchOptions, nt as PublishFileEntry, ot as FileUpload, q as FileDataQuery, rt as PublishFilesResult, st as UploadFilesOptions, tt as DownloadFileOptions, ut as CreateTagResult, yt as FileReference, z as CheckJobStatusResult } from "./types-73XFwmhH.mjs";
+import { LocaleConfig, LocaleConfig as LocaleConfig$1, LocaleConfigConstructorParams, 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";
+import { CustomMapping, CustomRegionMapping, CutoffFormatOptions, FormatVariables, LocaleProperties, StringFormat } from "@generaltranslation/format/types";
 
 //#region src/translate/setupProject.d.ts
 type SetupProjectResult = {
@@ -24,15 +25,6 @@ type EnqueueOptions = {
   timeout?: number;
 };
 //#endregion
-//#region src/locales/getRegionProperties.d.ts
-type CustomRegionMapping = {
-  [region: string]: {
-    name?: string;
-    emoji?: string;
-    locale?: string;
-  };
-};
-//#endregion
 //#region src/types-dir/api/project.d.ts
 type ProjectData = {
   id: string;
@@ -115,7 +107,7 @@ declare class GT {
   /** Runtime-safe locale and formatting helpers (backing field) */
   private _localeConfig;
   /** Runtime-safe locale and formatting helpers */
-  get localeConfig(): LocaleConfig;
+  get localeConfig(): LocaleConfig$1;
   /**
    * Constructs an instance of the GT class.
    *
@@ -825,236 +817,6 @@ declare class GT {
    */
   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 {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.
- */
-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.
- */
-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.
- */
-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.
- */
-declare function 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.
- */
-declare function 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 {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.
- */
-declare function 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 - Formatting options.
- * @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 (e.g., "2 hours ago", "in 3 days").
- */
-declare function formatRelativeTimeFromDate(date: Date, options: {
-  locales: string | string[];
-  baseDate?: Date;
-} & 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.
- */
-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.
- */
-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.
- */
-declare function getLocaleProperties(locale: string, defaultLocale?: string, customMapping?: CustomMapping): 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"`).
- * - 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 in the given `defaultLocale`,
- *   falling back to `libraryDefaultLocale`.
- * - Falls back to the region code as `name` if display name resolution fails.
- * - Falls back to `defaultEmoji` if no emoji mapping is found in `emojis` or `customMapping`.
- *
- * @param {string} region - The region code to look up (e.g., `"US"`, `"GB"`, `"DE"`).
- * @param {string} [defaultLocale=libraryDefaultLocale] - The locale to use when localizing the region name.
- * @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
- *
- * @example
- * getRegionProperties('US', 'en');
- * // => { code: 'US', name: 'United States', emoji: '🇺🇸' }
- *
- * @example
- * getRegionProperties('US', 'fr');
- * // => { code: 'US', name: 'États-Unis', emoji: '🇺🇸' }
- *
- * @example
- * getRegionProperties('US', 'en', { US: { name: 'USA', emoji: '🗽' } });
- * // => { code: 'US', name: 'USA', emoji: '🗽' }
- */
-declare function getRegionProperties(region: string, defaultLocale?: string, customMapping?: CustomRegionMapping): {
-  code: string;
-  name: string;
-  emoji: string;
-};
-/**
- * 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`.
- */
-declare function requiresTranslation(sourceLocale: string, targetLocale: string, approvedLocales?: string[], customMapping?: CustomMapping): 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.
- */
-declare function determineLocale(locales: string | string[], approvedLocales?: string[] | undefined, customMapping?: CustomMapping | 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'.
- */
-declare function getLocaleDirection(locale: string): 'ltr' | 'rtl';
-/**
- * Resolves the alias locale for a given locale.
- * @param {string} locale - The locale to resolve the alias locale for
- * @param {CustomMapping} [customMapping] - The custom mapping to use for resolving the alias locale
- * @returns {string} The alias locale
- */
-declare function resolveAliasLocale(locale: string, customMapping?: CustomMapping): 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.
- */
-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.
- */
-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.
- */
-declare function isSupersetLocale(superLocale: string, subLocale: string): boolean;
 declare const API_VERSION = "2026-03-06.v1";
 //#endregion
 export { API_VERSION, GT, LocaleConfig, type LocaleConfigConstructorParams, determineLocale, formatCurrency, formatCutoff, formatDateTime, formatList, formatListToParts, formatMessage, formatNum, formatRelativeTime, formatRelativeTimeFromDate, getLocaleDirection, getLocaleEmoji, getLocaleName, getLocaleProperties, getRegionProperties, isSameDialect, isSameLanguage, isSupersetLocale, isValidLocale, requiresTranslation, resolveAliasLocale, resolveCanonicalLocale, standardizeLocale };