generaltranslation 8.0.1-alpha.2 → 8.0.1

package/dist/index.d.ts

@@ -1,3 +1,5 @@
+import { DataFormat as DataFormat$1 } from 'src/types';
+
 type CustomMapping = Record<string, string | Partial<LocaleProperties>>;
 
 type LocaleProperties = {
@@ -167,7 +169,7 @@ type FileReference = {
     branchId: string;
     fileName: string;
     fileFormat: FileFormat;
-    dataFormat?: DataFormat;
+    dataFormat?: DataFormat$1;
 };
 
 type DownloadFileBatchRequest = {
@@ -1236,6 +1238,45 @@ declare function getLocaleEmoji(locale: string, customMapping?: CustomMapping):
  * @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.
  *
@@ -1307,4 +1348,4 @@ declare function isSameLanguage(...locales: (string | string[])[]): boolean;
  */
 declare function isSupersetLocale(superLocale: string, subLocale: string): boolean;
 
-export { GT, determineLocale, formatCurrency, formatDateTime, formatList, formatListToParts, formatMessage, formatNum, formatRelativeTime, getLocaleDirection, getLocaleEmoji, getLocaleName, getLocaleProperties, isSameDialect, isSameLanguage, isSupersetLocale, isValidLocale, requiresTranslation, resolveAliasLocale, standardizeLocale };
+export { GT, determineLocale, formatCurrency, formatDateTime, formatList, formatListToParts, formatMessage, formatNum, formatRelativeTime, getLocaleDirection, getLocaleEmoji, getLocaleName, getLocaleProperties, getRegionProperties, isSameDialect, isSameLanguage, isSupersetLocale, isValidLocale, requiresTranslation, resolveAliasLocale, standardizeLocale };