generaltranslation 8.2.7 → 8.2.9

package/dist/index.d.cts

@@ -1,4 +1,5 @@
-import { $ as FileReference, A as BranchDataResult, B as FileUpload, C as ProcessMovesOptions, D as FileDataQuery, Dt as StringFormat, F as DownloadFileOptions, H as UploadFilesResponse, I as PublishFileEntry, J as DownloadFileBatchOptions, L as PublishFilesResult, M as TranslationError, Mt as CustomMapping, 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, at as CheckFileTranslationsOptions, et as FileReferenceIds, g as AwaitJobsOptions, h as SubmitUserEditDiffsPayload, j as TranslateManyResult, jt as LocaleProperties, k as BranchQuery, mt as TranslateOptions, n as FormatVariables, ot as FileQuery, pt as TranslateManyEntry, rt as EnqueueFilesResult, st as FileQueryResult, w as ProcessMovesResponse, x as MoveMapping, y as CheckJobStatusResult } from "./types-D2fTTTvZ.cjs";
+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-CJMv4fMa.cjs";
+import { $ as FileReference, A as BranchDataResult, B as FileUpload, C as ProcessMovesOptions, D as FileDataQuery, Dt as StringFormat, F as DownloadFileOptions, H as UploadFilesResponse, I as PublishFileEntry, J as DownloadFileBatchOptions, L as PublishFilesResult, M as TranslationError, Mt as CustomMapping, 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, at as CheckFileTranslationsOptions, et as FileReferenceIds, g as AwaitJobsOptions, h as SubmitUserEditDiffsPayload, j as TranslateManyResult, jt as LocaleProperties, k as BranchQuery, mt as TranslateOptions, n as FormatVariables, ot as FileQuery, pt as TranslateManyEntry, rt as EnqueueFilesResult, st as FileQueryResult, w as ProcessMovesResponse, x as MoveMapping, y as CheckJobStatusResult } from "./types-mZeu4HS3.cjs";
 
 //#region src/translate/setupProject.d.ts
 type SetupProjectResult = {
@@ -53,24 +54,6 @@ type CreateBranchResult = {
   };
 };
 //#endregion
-//#region src/formatting/custom-formats/CutoffFormat/types.d.ts
-/** Type of terminator */
-type CutoffFormatStyle = 'none' | 'ellipsis';
-/** Terminator options */
-interface TerminatorOptions {
-  /** The terminator to use */
-  terminator?: string;
-  /** An optional separator between the terminator and the value */
-  separator?: string;
-}
-/** Input formatting options (for constructor) */
-interface CutoffFormatOptions extends TerminatorOptions {
-  /** Cutoff length */
-  maxChars?: number;
-  /** Type of terminator */
-  style?: CutoffFormatStyle;
-}
-//#endregion
 //#region src/index.d.ts
 /**
  * Type representing the constructor parameters for the GT class.
@@ -123,14 +106,16 @@ declare class GT {
   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 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.
    *
@@ -840,67 +825,6 @@ declare class GT {
    */
   isSupersetLocale(superLocale: string, subLocale: string): boolean;
 }
-/**
- * Formats a string with cutoff behavior, applying a terminator when the string exceeds the maximum character limit.
- *
- * This standalone function provides cutoff formatting functionality without requiring a GT instance.
- * The locales parameter is required for proper terminator selection based on the target language.
- *
- * @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.
- * @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
- * formatCutoff('Hello, world!', { locales: 'en-US', maxChars: 8 });
- * // Returns: 'Hello, w...'
- *
- * @example
- * formatCutoff('Hello, world!', { locales: 'en-US', maxChars: -3 });
- * // Returns: '...ld!'
- *
- * @example
- * formatCutoff('Very long text that needs cutting', {
- *   locales: 'en-US',
- *   maxChars: 15,
- *   style: 'ellipsis',
- *   separator: ' '
- * });
- * // Returns: 'Very long text ...'
- */
-declare function 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. (When STRING, the message is returned as is)
- * @returns {string} The formatted message.
- *
- * @example
- * formatMessage('Hello {name}', { name: 'John' });
- * // Returns: "Hello John"
- *
- * formatMessage('Hello {name}', { name: 'John' }, { locales: ['fr'] });
- * // Returns: "Bonjour John"
- */
-declare function formatMessage(message: string, options?: {
-  locales?: string | string[];
-  variables?: FormatVariables;
-  dataFormat?: StringFormat;
-}): string;
 /**
  * Formats a number according to the specified locales and options.
  * @param {Object} params - The parameters for the number formatting.
@@ -1103,13 +1027,6 @@ declare function determineLocale(locales: string | string[], approvedLocales?: s
  * @returns {string} - 'rtl' if the locale is right-to-left, otherwise 'ltr'.
  */
 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.
- */
-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
@@ -1117,19 +1034,6 @@ declare function isValidLocale(locale: string, customMapping?: CustomMapping): b
  * @returns {string} The alias locale
  */
 declare function resolveAliasLocale(locale: string, customMapping?: CustomMapping): string;
-/**
- * Resolves the canonical locale for a given locale.
- * @param {string} locale - The locale to resolve the canonical locale for
- * @param {CustomMapping} [customMapping] - The custom mapping to use for resolving the canonical locale
- * @returns {string} The canonical locale
- */
-declare function resolveCanonicalLocale(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.
- * @returns {string} The standardized BCP 47 locale code or an empty string if it is an invalid code.
- */
-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.
@@ -1153,5 +1057,5 @@ declare function isSameLanguage(...locales: (string | string[])[]): boolean;
 declare function isSupersetLocale(superLocale: string, subLocale: string): boolean;
 declare const API_VERSION = "2026-03-06.v1";
 //#endregion
-export { API_VERSION, GT, determineLocale, formatCurrency, formatCutoff, formatDateTime, formatList, formatListToParts, formatMessage, formatNum, formatRelativeTime, formatRelativeTimeFromDate, getLocaleDirection, getLocaleEmoji, getLocaleName, getLocaleProperties, getRegionProperties, isSameDialect, isSameLanguage, isSupersetLocale, isValidLocale, requiresTranslation, resolveAliasLocale, resolveCanonicalLocale, standardizeLocale };
+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 };
 //# sourceMappingURL=index.d.cts.map

package/dist/index.d.mts

@@ -1,4 +1,5 @@
-import { $ as FileReference, A as BranchDataResult, B as FileUpload, C as ProcessMovesOptions, D as FileDataQuery, Dt as StringFormat, F as DownloadFileOptions, H as UploadFilesResponse, I as PublishFileEntry, J as DownloadFileBatchOptions, L as PublishFilesResult, M as TranslationError, Mt as CustomMapping, 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, at as CheckFileTranslationsOptions, et as FileReferenceIds, g as AwaitJobsOptions, h as SubmitUserEditDiffsPayload, j as TranslateManyResult, jt as LocaleProperties, k as BranchQuery, mt as TranslateOptions, n as FormatVariables, ot as FileQuery, pt as TranslateManyEntry, rt as EnqueueFilesResult, st as FileQueryResult, w as ProcessMovesResponse, x as MoveMapping, y as CheckJobStatusResult } from "./types-fUW4_Ole.mjs";
+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-DtPj_ruw.mjs";
+import { $ as FileReference, A as BranchDataResult, B as FileUpload, C as ProcessMovesOptions, D as FileDataQuery, Dt as StringFormat, F as DownloadFileOptions, H as UploadFilesResponse, I as PublishFileEntry, J as DownloadFileBatchOptions, L as PublishFilesResult, M as TranslationError, Mt as CustomMapping, 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, at as CheckFileTranslationsOptions, et as FileReferenceIds, g as AwaitJobsOptions, h as SubmitUserEditDiffsPayload, j as TranslateManyResult, jt as LocaleProperties, k as BranchQuery, mt as TranslateOptions, n as FormatVariables, ot as FileQuery, pt as TranslateManyEntry, rt as EnqueueFilesResult, st as FileQueryResult, w as ProcessMovesResponse, x as MoveMapping, y as CheckJobStatusResult } from "./types-Dfy_sRLD.mjs";
 
 //#region src/translate/setupProject.d.ts
 type SetupProjectResult = {
@@ -53,24 +54,6 @@ type CreateBranchResult = {
   };
 };
 //#endregion
-//#region src/formatting/custom-formats/CutoffFormat/types.d.ts
-/** Type of terminator */
-type CutoffFormatStyle = 'none' | 'ellipsis';
-/** Terminator options */
-interface TerminatorOptions {
-  /** The terminator to use */
-  terminator?: string;
-  /** An optional separator between the terminator and the value */
-  separator?: string;
-}
-/** Input formatting options (for constructor) */
-interface CutoffFormatOptions extends TerminatorOptions {
-  /** Cutoff length */
-  maxChars?: number;
-  /** Type of terminator */
-  style?: CutoffFormatStyle;
-}
-//#endregion
 //#region src/index.d.ts
 /**
  * Type representing the constructor parameters for the GT class.
@@ -123,14 +106,16 @@ declare class GT {
   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 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.
    *
@@ -840,67 +825,6 @@ declare class GT {
    */
   isSupersetLocale(superLocale: string, subLocale: string): boolean;
 }
-/**
- * Formats a string with cutoff behavior, applying a terminator when the string exceeds the maximum character limit.
- *
- * This standalone function provides cutoff formatting functionality without requiring a GT instance.
- * The locales parameter is required for proper terminator selection based on the target language.
- *
- * @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.
- * @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
- * formatCutoff('Hello, world!', { locales: 'en-US', maxChars: 8 });
- * // Returns: 'Hello, w...'
- *
- * @example
- * formatCutoff('Hello, world!', { locales: 'en-US', maxChars: -3 });
- * // Returns: '...ld!'
- *
- * @example
- * formatCutoff('Very long text that needs cutting', {
- *   locales: 'en-US',
- *   maxChars: 15,
- *   style: 'ellipsis',
- *   separator: ' '
- * });
- * // Returns: 'Very long text ...'
- */
-declare function 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. (When STRING, the message is returned as is)
- * @returns {string} The formatted message.
- *
- * @example
- * formatMessage('Hello {name}', { name: 'John' });
- * // Returns: "Hello John"
- *
- * formatMessage('Hello {name}', { name: 'John' }, { locales: ['fr'] });
- * // Returns: "Bonjour John"
- */
-declare function formatMessage(message: string, options?: {
-  locales?: string | string[];
-  variables?: FormatVariables;
-  dataFormat?: StringFormat;
-}): string;
 /**
  * Formats a number according to the specified locales and options.
  * @param {Object} params - The parameters for the number formatting.
@@ -1103,13 +1027,6 @@ declare function determineLocale(locales: string | string[], approvedLocales?: s
  * @returns {string} - 'rtl' if the locale is right-to-left, otherwise 'ltr'.
  */
 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.
- */
-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
@@ -1117,19 +1034,6 @@ declare function isValidLocale(locale: string, customMapping?: CustomMapping): b
  * @returns {string} The alias locale
  */
 declare function resolveAliasLocale(locale: string, customMapping?: CustomMapping): string;
-/**
- * Resolves the canonical locale for a given locale.
- * @param {string} locale - The locale to resolve the canonical locale for
- * @param {CustomMapping} [customMapping] - The custom mapping to use for resolving the canonical locale
- * @returns {string} The canonical locale
- */
-declare function resolveCanonicalLocale(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.
- * @returns {string} The standardized BCP 47 locale code or an empty string if it is an invalid code.
- */
-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.
@@ -1153,5 +1057,5 @@ declare function isSameLanguage(...locales: (string | string[])[]): boolean;
 declare function isSupersetLocale(superLocale: string, subLocale: string): boolean;
 declare const API_VERSION = "2026-03-06.v1";
 //#endregion
-export { API_VERSION, GT, determineLocale, formatCurrency, formatCutoff, formatDateTime, formatList, formatListToParts, formatMessage, formatNum, formatRelativeTime, formatRelativeTimeFromDate, getLocaleDirection, getLocaleEmoji, getLocaleName, getLocaleProperties, getRegionProperties, isSameDialect, isSameLanguage, isSupersetLocale, isValidLocale, requiresTranslation, resolveAliasLocale, resolveCanonicalLocale, standardizeLocale };
+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 };
 //# sourceMappingURL=index.d.mts.map