generaltranslation 7.4.2 → 7.5.0-alpha.0

package/dist/index.d.ts

@@ -4,6 +4,7 @@ import { JsxChildren } from './internal';
 import { FileTranslationQuery } from './types-dir/checkFileTranslations';
 import { CheckTranslationStatusOptions, TranslationStatusResult } from './types-dir/translationStatus';
 import { CustomRegionMapping } from './locales/getRegionProperties';
+import { FileUpload, UploadFilesOptions } from './types-dir/uploadFiles';
 /**
  * Type representing the constructor parameters for the GT class.
  * @typedef {Object} GTConstructorParams
@@ -59,6 +60,8 @@ export declare class GT {
     _renderingLocales: 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;
     /**
@@ -316,6 +319,10 @@ export declare class GT {
     translateMany(sources: Entry[], globalMetadata?: {
         targetLocale: string;
     } & EntryMetadata): Promise<TranslateManyResult>;
+    uploadFiles(files: {
+        source: FileUpload;
+        translations: FileUpload[];
+    }[], options: UploadFilesOptions): Promise<any>;
     /**
      * Formats a message according to the specified locales and options.
      *
@@ -531,7 +538,7 @@ export declare class GT {
      * gt.requiresTranslation('en-US', 'es-ES');
      * // Returns: true
      */
-    requiresTranslation(sourceLocale?: string | undefined, targetLocale?: string | undefined, approvedLocales?: string[] | undefined): boolean;
+    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.
      *
@@ -543,7 +550,7 @@ export declare class GT {
      * gt.determineLocale(['fr-CA', 'fr-FR'], ['en-US', 'fr-FR', 'es-ES']);
      * // Returns: "fr-FR"
      */
-    determineLocale(locales: string | string[], approvedLocales?: string[] | undefined): string | undefined;
+    determineLocale(locales: string | string[], approvedLocales?: string[] | undefined, customMapping?: CustomMapping | undefined): string | undefined;
     /**
      * Gets the text direction for a given locale code.
      *
@@ -560,6 +567,7 @@ export declare class GT {
      * 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
      *
@@ -567,7 +575,21 @@ export declare class GT {
      * gt.isValidLocale('en-US');
      * // Returns: true
      */
-    isValidLocale(locale?: string | undefined): boolean;
+    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
+     */
+    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 alias locale
+     */
+    resolveAliasLocale(locale: string, customMapping?: CustomMapping | undefined): string;
     /**
      * Standardizes a BCP 47 locale code to ensure correct formatting.
      *
@@ -765,14 +787,14 @@ export declare function getLocaleProperties(locale: string, defaultLocale?: stri
  *
  * @returns {boolean} - Returns `true` if translation is required, otherwise `false`.
  */
-export declare function requiresTranslation(sourceLocale: string, targetLocale: string, approvedLocales?: string[]): boolean;
+export 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.
  */
-export declare function determineLocale(locales: string | string[], approvedLocales?: string[] | undefined): string | undefined;
+export 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.
  *
@@ -783,9 +805,17 @@ 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.
+ * @param {CustomMapping} [customMapping] - The custom mapping to use for validation.
  * @returns {boolean} True if the BCP 47 code is valid, false otherwise.
  */
-export declare function isValidLocale(locale: string): boolean;
+export declare function isValidLocale(locale: string, customMapping?: CustomMapping): boolean;
+/**
+ * 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
+ */
+export declare function resolveAliasLocale(locale: string, customMapping?: CustomMapping): string;
 /**
  * Standardizes a BCP 47 locale code to ensure correct formatting.
  * @param {string} locale - The BCP 47 locale code to standardize.