gt-react 10.7.0-alpha.1 → 10.7.0-alpha.3

package/dist/client.d.ts

@@ -1,216 +1,9 @@
-import * as React$1 from 'react';
+import * as React from 'react';
 import React__default, { ReactNode } from 'react';
-import { GTProp, Variable, VariableType, JsxChildren, CustomMapping, LocaleProperties } from 'generaltranslation/types';
-import * as generaltranslation from 'generaltranslation';
-import { GT } from 'generaltranslation';
-import * as react_jsx_runtime from 'react/jsx-runtime';
+import { Dictionary, Translations, RenderMethod } from '@generaltranslation/react-core/types';
+import { CustomMapping } from 'generaltranslation/types';
+export { Branch, Currency, DateTime, GTProvider, Num, Plural, Static, T, Var, decodeMsg, decodeOptions, msg, useDefaultLocale, useGT, useGTClass, useLocale, useLocaleDirection, useLocaleProperties, useLocaleSelector, useLocales, useMessages, useRegion, useRegionSelector, useSetLocale, useTranslations } from '@generaltranslation/react-core';
 
-/**
- * For dictionaries, we have Entry and MetaEntry
- */
-type Entry = string;
-type MetaEntry = {
-    $context?: string;
-    $_hash?: string;
-    [key: string]: unknown;
-};
-type DictionaryEntry = Entry | [Entry] | [Entry, MetaEntry];
-type Dictionary = {
-    [key: string]: Dictionary | DictionaryEntry;
-} | (Dictionary | DictionaryEntry)[];
-/**
- * Translated content types
- */
-type TranslatedElement = {
-    i?: number;
-    d?: GTProp;
-    c?: TranslatedChildren;
-};
-type TranslatedChild = TranslatedElement | string | Variable;
-type TranslatedChildren = TranslatedChild | TranslatedChild[];
-type Translations = {
-    [hash: string]: TranslatedChildren | null;
-};
-type CustomLoader = (locale: string) => Promise<any>;
-type RenderMethod = 'skeleton' | 'replace' | 'default';
-type DictionaryTranslationOptions = Record<string, any>;
-type InlineTranslationOptions = DictionaryTranslationOptions & {
-    $context?: string;
-    $id?: string;
-    $_hash?: string;
-    $_source?: string;
-};
-type VariableProps = {
-    variableType: VariableType;
-    variableValue: any;
-    variableOptions: Intl.NumberFormatOptions | Intl.DateTimeFormatOptions;
-    variableName: string;
-};
-type RenderVariable = ({ variableType, variableValue, variableOptions, locales, }: Omit<VariableProps, 'variableName'> & {
-    locales: string[];
-}) => React__default.JSX.Element;
-type _Message = {
-    message: string;
-    $id?: string;
-    $context?: string;
-    $_hash?: string;
-};
-type _Messages = _Message[];
-type MFunctionType = <T extends string | null | undefined>(encodedMsg: T, options?: Record<string, any>) => T extends string ? string : T;
-
-type TranslateIcuCallback = (params: {
-    source: string;
-    targetLocale: string;
-    metadata: {
-        hash: string;
-        context?: string;
-    } & Record<string, any>;
-}) => Promise<TranslatedChildren>;
-type TranslateChildrenCallback = (params: {
-    source: JsxChildren | undefined;
-    targetLocale: string;
-    metadata: {
-        hash: string;
-        context?: string;
-    } & Record<string, any>;
-}) => Promise<TranslatedChildren>;
-
-type GTContextType = {
-    gt: GT;
-    registerIcuForTranslation: TranslateIcuCallback;
-    registerJsxForTranslation: TranslateChildrenCallback;
-    _tFunction: (message: string, options?: InlineTranslationOptions, preloadedTranslations?: Translations) => string;
-    _mFunction: <T extends string | null | undefined>(encodedMsg: T, options?: Record<string, any>, preloadedTranslations?: Translations) => T extends string ? string : T;
-    _filterMessagesForPreload: (_messages: _Messages) => _Messages;
-    _preloadMessages: (_messages: _Messages) => Promise<Translations>;
-    _dictionaryFunction: (id: string, options?: DictionaryTranslationOptions) => string;
-    _dictionaryObjFunction: (id: string, idWithParent: string, options?: DictionaryTranslationOptions) => Dictionary | DictionaryEntry | string | undefined;
-    developmentApiEnabled: boolean;
-    locale: string;
-    locales: string[];
-    setLocale: (locale: string) => void;
-    defaultLocale: string;
-    region: string | undefined;
-    setRegion: (region: string | undefined) => void;
-    translations: Translations | null;
-    translationRequired: boolean;
-    dialectTranslationRequired: boolean;
-    renderSettings: {
-        method: RenderMethod;
-        timeout?: number;
-    };
-    projectId?: string;
-};
-
-declare const GTContext: React$1.Context<GTContextType | undefined>;
-
-declare function useRuntimeTranslation({ gt, locale, versionId, // kept for API compatibility (not used)
-defaultLocale, runtimeUrl, renderSettings, setTranslations, ...additionalMetadata }: {
-    gt: GT;
-    locale: string;
-    versionId?: string;
-    defaultLocale?: string;
-    runtimeUrl?: string | null;
-    renderSettings: {
-        method: RenderMethod;
-        timeout?: number;
-    };
-    setTranslations: React$1.Dispatch<React$1.SetStateAction<Translations | null>>;
-    [key: string]: any;
-}): {
-    registerIcuForTranslation: TranslateIcuCallback;
-    registerJsxForTranslation: TranslateChildrenCallback;
-    developmentApiEnabled: boolean;
-};
-
-declare const renderVariable: RenderVariable;
-
-/**
- * Encodes content into a message that contains important translation metadata
- * @param message The message to encode.
- * @param options The options to encode.
- * @returns The encoded message.
- *
- * @note - Message format
- * A message is broken into two parts separated by colons:
- * - interpolated content - the content with interpolated variables
- * - hash + options - a unique identifier for the source content and options for the translation
- *
- * @example - Basic usage
- *
- * ```jsx
- * import { msg } from 'gt-react';
- * const message = msg('Hello, {name}!', { name: 'Brian' });
- * console.log(message); // "Hello, Brian:eyIkX2hhc2giOiAiMHgxMjMiLCAiJF9zb3VyY2UiOiAiSGVsbG8sIHtuYW1lfSEiLCAibmFtZSI6ICJCcmlhbiJ9"
- * ```
- * eyIkX2hhc2giOiAiMHgxMjMiLCAiJF9zb3VyY2UiOiAiSGVsbG8sIHtuYW1lfSEiLCAibmFtZSI6ICJCcmlhbiJ9
- * encodes to {"$_hash": "0x123", "$_source": "Hello, {name}!", "name": "Brian"}
- *
- */
-declare function msg(message: string, options?: InlineTranslationOptions): string;
-/**
- * Extracts the original interpolated message string.
- * If the message cannot be decoded (i.e., it does not contain a colon separator),
- * the input is returned as-is.
- * @param encodedMsg The message to decode.
- * @returns The decoded message, or the input if it cannot be decoded.
- */
-declare function decodeMsg<T extends string | null | undefined>(encodedMsg: T): T;
-/**
- * Decodes the options from an encoded message.
- * @param encodedMsg The message to decode.
- * @returns The decoded options.
- */
-declare function decodeOptions(encodedMsg: string): ({
-    $_source: string;
-    $_hash: string;
-} & InlineTranslationOptions) | null;
-
-type GTConfig = {
-    projectId?: string;
-    devApiKey?: string;
-    locales?: string[];
-    defaultLocale?: string;
-    dictionary?: string;
-    runtimeUrl?: string;
-    cacheUrl?: string;
-    renderSettings?: {
-        method: RenderMethod;
-        timeout?: number;
-    };
-    _versionId?: string;
-    ssr?: boolean;
-    localeCookieName?: string;
-    customMapping?: CustomMapping;
-    modelProvider?: string;
-};
-type GTProviderProps = {
-    children?: React.ReactNode;
-    projectId?: string;
-    devApiKey?: string;
-    dictionary?: any;
-    locales?: string[];
-    defaultLocale?: string;
-    locale?: string;
-    region?: string;
-    cacheUrl?: string;
-    runtimeUrl?: string;
-    renderSettings?: {
-        method: RenderMethod;
-        timeout?: number;
-    };
-    _versionId?: string;
-    ssr?: boolean;
-    localeCookieName?: string;
-    translations?: Translations | null;
-    loadDictionary?: CustomLoader;
-    loadTranslations?: CustomLoader;
-    config?: GTConfig;
-    fallback?: React.ReactNode;
-    customMapping?: CustomMapping;
-    modelProvider?: string;
-    [key: string]: any;
-};
 type ClientProviderProps = {
     children: any;
     dictionary: Dictionary;
@@ -237,293 +30,10 @@ type ClientProviderProps = {
     resetLocaleCookieName: string;
     regionCookieName?: string;
     customMapping?: CustomMapping;
+    environment: 'development' | 'production' | 'test';
 };
 
-declare function ClientProvider({ children, dictionary: _dictionary, dictionaryTranslations: _dictionaryTranslations, translations: _translations, locale: _locale, region: _region, _versionId, defaultLocale, translationRequired, dialectTranslationRequired, locales, renderSettings, projectId, devApiKey, runtimeUrl, developmentApiEnabled, resetLocaleCookieName, localeCookieName, regionCookieName, customMapping, }: ClientProviderProps): React$1.JSX.Element;
-
-/**
- * The `<Branch>` component dynamically renders a specified branch of content or a fallback child component.
- * It allows for flexible content switching based on the `branch` prop and an object of possible branches (`...branches`).
- * If the specified `branch` is present in the `branches` object, it renders the content of that branch.
- * If the `branch` is not found, it renders the provided `children` as fallback content.
- *
- * @example
- * ```jsx
- * <Branch
- *  branch="summary"
- * summary={<p>This is a summary</p>}
- * details={<p>Details here</p>}
- * >
- *   <p>Fallback content</p>
- * </Branch>
- * ```
- * If the `branch` prop is set to `"summary"`, it will render `<p>This is a summary</p>`. If the `branch` is not set or does not match any keys in the branches object, it renders the fallback content `<p>Fallback content</p>`.
- *
- * @param {any} [children] - Fallback content to render if no matching branch is found.
- * @param {any} [name="branch"] - Optional name for the component, used for metadata or tracking purposes.
- * @param {string} [branch] - The name of the branch to render. The component looks for this key in the `...branches` object.
- * @param {...{[key: string]: any}} [branches] - A spread object containing possible branches as keys and their corresponding content as values.
- * @returns {React.JSX.Element} The rendered branch or fallback content.
- */
-declare function Branch({ children, branch, ...branches }: {
-    children?: any;
-    branch?: string | number | boolean;
-    [key: string]: any;
-}): React.JSX.Element;
-declare namespace Branch {
-    var _gtt: string;
-}
-
-/**
- * The `<Plural>` component dynamically renders content based on the plural form of the given number (`n`).
- * It determines which content to display by matching the value of `n` to the appropriate pluralization branch,
- * based on the current locale or a default locale. If no matching plural branch is found, the component renders
- * the fallback `children` content.
- *
- * @example
- * ```jsx
- * <Plural
- *  n={1}
- *  one="There is 1 item"
- *  other="There are {n} items"
- * />
- * ```
- * In this example, if `n` is 1, it renders `"There is 1 item"`. If `n` is a different number, it renders
- * `"There are {n} items"`.
- *
- * @param {any} [children] - Fallback content to render if no matching plural branch is found.
- * @param {number} [n] - The number used to determine the plural form. This is required for pluralization to work.
- * @param {string} [locales] - Optional parameter, the locale to use for pluralization format. If not provided and wrapped
- *  in <GTProvider> will automatically populate this value as user's current locale. If not provided and not wrapped in
- *  <GTProvider>, will use the library default locale (en-US).
- * @param {...{[key: string]: any}} [branches] - A spread object containing possible plural branches, typically including `one` for singular
- * and `other` for plural forms, but it may vary depending on the locale.
- * @returns {React.JSX.Element} The rendered content corresponding to the plural form of `n`, or the fallback content.
- * @throws {Error} If `n` is not provided or not a valid number.
- */
-declare function Plural({ children, n, locales, ...branches }: {
-    children?: React.ReactNode;
-    n?: number;
-    locales?: string;
-    [key: string]: any;
-}): React.JSX.Element;
-declare namespace Plural {
-    var _gtt: string;
-}
-
-/**
- * Gets the translation function `gt` provided by `<GTProvider>`.
- *
- * @returns {Function} A translation function that accepts an ICU message format string and returns the translation of that string.
- *
- * @example
- * const gt = useGT();
- * console.log(gt('To be or not to be...'));
- *
- * @example
- * const gt = useGT();
- * gt('My name is {customName}', { customName: "Brian", id: 'my-name', context: 'a proper noun' } )
- */
-declare function useGT(_messages?: _Messages): (string: string, options?: Record<string, any> & {
-    $id?: string;
-    $context?: string;
-    $_hash?: string;
-}) => string;
-
-/**
- * Retrieves the application's default locale from the `<GTProvider>` context.
- *
- * If no default locale is passed to the `<GTProvider>`, it defaults to providing 'en'.
- *
- * @returns {string} The application's default locale, e.g., 'en-US'.
- *
- * @example
- * const locale = useDefaultLocale();
- * console.log(locale); // 'en-US'
- */
-declare function useDefaultLocale(): string;
-
-/**
- * Gets the dictionary access function `t` provided by `<GTProvider>`.
- *
- * @param {string} [id] - Optional prefix to prepend to the translation keys.
- * @returns {Function} A translation function that accepts a key string and returns the translated value.
- *
- * @example
- * const t = useTranslations('user');
- * console.log(t('name')); // Translates item 'user.name'
- *
- * const t = useTranslations();
- * console.log(t('hello')); // Translates item 'hello'
- */
-declare function useTranslations(id?: string): ((id: string, options?: Record<string, any>) => string) & {
-    obj: (id: string, options?: Record<string, any>) => any | undefined;
-};
-
-/**
- * Retrieves the user's locale from the `<GTProvider>` context.
- *
- * @returns {string} The user's locale, e.g., 'en-US'.
- *
- * @example
- * const locale = useLocale();
- * console.log(locale); // 'en-US'
- */
-declare function useLocale(): string;
-
-/**
- * Build-time translation component that renders its children in the user's given locale.
- *
- * @example
- * ```jsx
- * // Basic usage:
- * <T id="welcome_message">
- *  Hello, <Var>{name}</Var>!
- * </T>
- * ```
- *
- * @example
- * ```jsx
- * // Translating a plural
- * <T id="item_count">
- *  <Plural n={3} singular={<>You have <Num children={n}/> item.</>}>
- *      You have <Num children={n}/> items.
- *  </Plural>
- * </T>
- * ```
- *
- * @param {React.ReactNode} children - The content to be translated or displayed.
- * @param {string} [id] - Optional identifier for the translation string. If not provided, a hash will be generated from the content.
- * @param {any} [context] - Additional context for translation key generation.
- *
- * @returns {JSX.Element} The rendered translation or fallback content based on the provided configuration.
- *
- * @throws {Error} If a plural translation is requested but the `n` option is not provided.
- */
-declare function T({ children, id, context, _hash, ...options }: {
-    children: any;
-    id?: string;
-    context?: string;
-    _hash?: string;
-    [key: string]: any;
-}): React__default.JSX.Element | undefined;
-declare namespace T {
-    var _gtt: string;
-}
-
-/**
- * The `<Currency>` component renders a formatted currency string, allowing customization of name, default value, currency type, and formatting options.
- * Must be used inside a `<GTProvider>`.
- *
- * @example
- * ```jsx
- * <Currency currency="USD">
- *    1000
- * </Currency>
- * ```
- *
- * @param {number | string | null | undefined} children - Content to render inside the currency component.
- * @param {string} [currency="USD"] - The currency type (e.g., USD, EUR, etc.).
- * @param {string[]} [locales] - Optional locales to use for currency formatting. If wrapped in a `<GTProvider>`, the user's locale is used.
- * @param {Intl.NumberFormatOptions} [options={}] - Optional formatting options to customize how the currency is displayed.
- * @returns {JSX.Element} The formatted currency component.
- */
-declare function Currency({ children, currency, locales, options, }: {
-    children: number | string | null | undefined;
-    currency?: string;
-    name?: string;
-    locales?: string[];
-    options?: Intl.NumberFormatOptions;
-}): React__default.JSX.Element | null;
-declare namespace Currency {
-    var _gtt: string;
-}
-
-/**
- * The `<DateTime>` component renders a formatted date or time string, allowing customization of the name, default value, and formatting options.
- * It utilizes the current locale and optional format settings to display the date.
- * Must be used inside a `<GTProvider>`.
- *
- * @example
- * ```jsx
- * <DateTime>
- *    {new Date()}
- * </DateTime>
- * ```
- *
- * @param {Date} children - Content to render inside the date component.
- * @param {string[]} [locales] - Optional locales to use for date formatting. If wrapped in a `<GTProvider>`, the user's locale is used.
- * @param {Intl.DateTimeFormatOptions} [options={}] - Optional formatting options for the date, following `Intl.DateTimeFormatOptions` specifications.
- * @returns {JSX.Element} The formatted date or time component.
- */
-declare function DateTime({ children, locales, options, }: {
-    children: Date | null | undefined;
-    name?: string;
-    locales?: string[];
-    options?: Intl.DateTimeFormatOptions;
-}): React__default.JSX.Element | null;
-declare namespace DateTime {
-    var _gtt: string;
-}
-
-/**
- * The `<Num>` component renders a formatted number string, allowing customization of the name, default value, and formatting options.
- * It formats the number according to the current locale and optionally passed formatting options.
- * Must be used inside a `<GTProvider>`.
- *
- * @example
- * ```jsx
- * <Num
- *    options={{ style: "decimal", maximumFractionDigits: 2 }}
- * >
- *    1000
- * </Num>
- * ```
- *
- * @param {number | string | null | undefined} children - Content to render inside the number component.
- * @param {string[]} [locales] - Optional locales to use for number formatting. If wrapped in a `<GTProvider>`, the user's locale is used.
- * @param {Intl.NumberFormatOptions} [options={}] - Optional formatting options for the number, following `Intl.NumberFormatOptions` specifications.
- * @returns {React.JSX.Element} The formatted number component.
- */
-declare function Num({ children, locales, options, }: {
-    children: number | string | null | undefined;
-    name?: string;
-    locales?: string[];
-    options?: Intl.NumberFormatOptions;
-}): React__default.JSX.Element | null;
-declare namespace Num {
-    var _gtt: string;
-}
-
-/**
- * The `<Var>` component renders a variable value, which can either be passed as `children` or a `value`.
- * If `children` is provided, it will be used; otherwise, the `value` is rendered.
- *
- * @example Inline usage:
- * ```jsx
- *  function MyComponent() {
- *     const name = 'Archie';
- *     return (
- *          <T>
- *              <p>
- *                  Hello, <Var> {name} </Var>!
- *              </p>
- *          </T>
- *      );
- *  }
- * ```
- *
- *
- * @param {any} [children] - The content to render inside the component. If provided, it will take precedence over `value`.
- * @returns {JSX.Element} The rendered variable component with either `children` or `value`.
- */
-declare function Var({ children, }: {
-    children?: any;
-    name?: string;
-}): React__default.JSX.Element | null;
-declare namespace Var {
-    var _gtt: string;
-}
+declare function ClientProvider({ children, dictionary: _dictionary, dictionaryTranslations: _dictionaryTranslations, translations: _translations, locale: _locale, region: _region, _versionId, defaultLocale, translationRequired, dialectTranslationRequired, locales, renderSettings, projectId, devApiKey, runtimeUrl, developmentApiEnabled, resetLocaleCookieName, localeCookieName, regionCookieName, customMapping, environment, }: ClientProviderProps): React.JSX.Element;
 
 /**
  * A dropdown component that allows users to select a locale.
@@ -578,247 +88,4 @@ declare function RegionSelector<Regions extends string[]>({ regions: _regions, p
     [key: string]: any;
 }): React__default.JSX.Element | null;
 
-/**
- * Provides General Translation context to its children, which can then access `useGT`, `useLocale`, and `useDefaultLocale`.
- *
- * @param {React.ReactNode} children - The children components that will use the translation context.
- * @param {string} [projectId] - The project ID required for General Translation cloud services.
- * @param {Dictionary} [dictionary=defaultDictionary] - The translation dictionary for the project.
- * @param {string[]} [locales] - The list of approved locales for the project.
- * @param {string} [defaultLocale=libraryDefaultLocale] - The default locale to use if no other locale is found.
- * @param {string} [locale] - The current locale, if already set.
- * @param {string} [cacheUrl='https://cdn.gtx.dev'] - The URL of the cache service for fetching translations.
- * @param {string} [runtimeUrl='https://runtime.gtx.dev'] - The URL of the runtime service for fetching translations.
- * @param {RenderSettings} [renderSettings=defaultRenderSettings] - The settings for rendering translations.
- * @param {string} [_versionId] - The version ID for fetching translations.
- * @param {string} [devApiKey] - The API key for development environments.
- * @param {object} [metadata] - Additional metadata to pass to the context.
- * @param {boolean} [ssr=isSSREnabled()] - Whether to enable server-side rendering.
- * @param {string} [localeCookieName=defaultLocaleCookieName] - The name of the cookie to store the locale.
- * @param {Translations | null} [translations=null] - The translations to use for the context.
- * @param {React.ReactNode} [fallback = undefined] - Custom fallback to display while loading
- *
- * @returns {JSX.Element} The provider component for General Translation context.
- */
-declare function GTProvider({ children, config, projectId: _projectId, devApiKey: _devApiKey, dictionary: _dictionary, locales, defaultLocale, cacheUrl, runtimeUrl, renderSettings, ssr, localeCookieName, locale: _locale, region: _region, loadDictionary, loadTranslations, fallback, translations: _translations, _versionId, customMapping, ...metadata }: GTProviderProps): react_jsx_runtime.JSX.Element;
-
-/**
- * Sets the user's locale in the `<GTProvider>` context.
- * If the locale passed is not supported, will fallback on current locale and then defaultLocale if necessary.
- * @note Unless a locale has explicitly been passed to the `<GTProvider>`, this will override the user's browser preferences. The locale passed to `<GTProvider>` will always take priority.
- *
- * @returns {(locale: string) => void} A function that sets the user's locale.
- *
- * @example
- * setLocale('en-US');
- */
-declare function useSetLocale(): (locale: string) => void;
-
-/**
- * Retrieves the user's list of supported locales from the `<GTProvider>` context.
- *
- * @returns {string[]} The user's locales, e.g., ['en-US', 'fr', 'jp'].
- *
- * @example
- * const locales = useLocales();
- * console.log(locale); // ['en-US', 'fr', 'jp]
- */
-declare function useLocales(): string[];
-
-/**
- *
- * Gets the list of properties for using a locale selector.
- * Provides locale management utilities for the application.
- * @param locales an optional list of locales to use for the drop down. These locales must be a subset of the locales provided by the `<GTProvider>` context. When not provided, the list of locales from the `<GTProvider>` context is used.
- * Provides locale management utilities for the application.
- *
- * @returns {Object} An object containing locale-related utilities:
- * @returns {string} return.locale - The currently selected locale.
- * @returns {string[]} return.locales - The list of all available locales.
- * @returns {(locale: string) => void} return.setLocale - Function to update the current locale.
- * @returns {(locale: string) => LocaleProperties} return.getLocaleProperties - Function to retrieve properties for a given locale.
- */
-declare function useLocaleSelector(locales?: string[]): {
-    locale: string;
-    locales: string[];
-    setLocale: (locale: string) => void;
-    getLocaleProperties: (locale: string) => {
-        code: string;
-        name: string;
-        nativeName: string;
-        languageCode: string;
-        languageName: string;
-        nativeLanguageName: string;
-        nameWithRegionCode: string;
-        nativeNameWithRegionCode: string;
-        regionCode: string;
-        regionName: string;
-        nativeRegionName: string;
-        scriptCode: string;
-        scriptName: string;
-        nativeScriptName: string;
-        maximizedCode: string;
-        maximizedName: string;
-        nativeMaximizedName: string;
-        minimizedCode: string;
-        minimizedName: string;
-        nativeMinimizedName: string;
-        emoji: string;
-    };
-};
-
-/**
- * Returns the configured GT class instance.
- *
- * @returns {GT} The configured GT class instance.
- *
- * @example
- * const gt = useGTClass();
- * console.log(gt.getLocaleProperties('en-US'));
- */
-declare function useGTClass(): generaltranslation.GT;
-/**
- * Returns the locale properties for the given locale.
- *
- * @param {string} locale - The locale to get the properties for.
- * @returns {LocaleProperties} The locale properties for the given locale.
- *
- * @example
- * const localeProperties = useLocaleProperties('en-US');
- * console.log(localeProperties);
- */
-declare function useLocaleProperties(locale: string): LocaleProperties;
-
-/**
- * A React hook that retrieves the user's currently selected region from the `<GTProvider>` context.
- *
- * Returns the `region` value as a string (e.g., `"US"`, `"CA"`) or `undefined` if no region has been set.
- *
- * @returns {string | undefined} The currently active region code, or `undefined` if not set.
- *
- * @example
- * ```tsx
- * const region = useRegion();
- *
- * if (!region) {
- *   console.log("No region set yet");
- * } else {
- *   console.log(`Current region: ${region}`);
- * }
- * ```
- */
-declare function useRegion(): string | undefined;
-
-type RegionData = {
-    code: string;
-    name: string;
-    emoji: string;
-    locale: string;
-};
-/**
- * React hook for managing region selection logic in applications supporting multiple regions.
- *
- * This hook provides the necessary data and handlers to implement a region selector UI component.
- * It returns the current region, a list of available regions, region metadata, and functions to update the region or associated locale.
- *
- * ### Parameters
- * @param {Object} [options] - Optional configuration object.
- * @param {string[]} [options.regions] - An optional array of ISO 3166 region codes to display. If not provided, regions are inferred from supported locales.
- * @param {Object.<string, string|{name?: string, emoji?: string, locale?: string}>} [options.customMapping] - Optional mapping to override region display names, emojis, or associated locales.
- * @param {boolean} [options.prioritizeCurrentLocaleRegion=true] - If true, the region corresponding to the current locale is prioritized in the list.
- * @param {boolean} [options.sortRegionsAlphabetically=true] - If true, regions are sorted alphabetically by display name.
- *
- * ### Returns
- * @returns {{
- *   region: string | undefined,
- *   setRegion: (region: string) => void,
- *   regions: string[],
- *   regionData: Map<string, { code: string, name: string, emoji: string, locale: string }>,
- *   locale: string,
- *   setLocale: (locale: string) => void
- * }} An object containing:
- *   - `region`: The currently selected region code.
- *   - `setRegion`: Function to update the selected region.
- *   - `regions`: Array of available region codes.
- *   - `regionData`: Map of region codes to their display data (name, emoji, locale).
- *   - `locale`: The current locale.
- *   - `setLocale`: Function to update the locale.
- *
- * ### Example
- * ```tsx
- * const {
- *   region,
- *   setRegion,
- *   regions,
- *   regionData,
- *   locale,
- *   setLocale
- * } = useRegionSelector({
- *   customMapping: { US: { name: "United States", emoji: "🇺🇸" } }
- * });
- *
- * return (
- *   <select value={region} onChange={e => setRegion(e.target.value)}>
- *     {regions.map(r => (
- *       <option key={r} value={r}>
- *         {regionData.get(r)?.name}
- *       </option>
- *     ))}
- *   </select>
- * );
- * ```
- */
-declare function useRegionSelector({ regions: _regions, customMapping, prioritizeCurrentLocaleRegion, sortRegionsAlphabetically, }?: {
-    regions?: string[];
-    customMapping?: {
-        [region: string]: string | {
-            name?: string;
-            emoji?: string;
-            locale?: string;
-        };
-    };
-    prioritizeCurrentLocaleRegion?: boolean;
-    sortRegionsAlphabetically?: boolean;
-}): {
-    region: string | undefined;
-    setRegion: (region: string | undefined) => void;
-    regions: string[];
-    regionData: Map<string, RegionData>;
-    locales: string[];
-    locale: string;
-    localeRegion: string;
-    setLocale: (locale: string) => void;
-};
-
-/**
- * Retrieves the text direction ('ltr' or 'rtl') for the current or specified locale from the `<GTProvider>` context.
- *
- * If no locale is provided, the direction for the current user's locale is returned.
- *
- * @param {string} [locale] - Optional locale code (e.g., 'ar', 'en-US'). If omitted, uses the current locale from context.
- * @returns {'ltr' | 'rtl'} The text direction for the locale: 'rtl' for right-to-left languages, otherwise 'ltr'.
- *
- * @example
- * const dir = useLocaleDirection(); // e.g., 'ltr'
- * const arabicDir = useLocaleDirection('ar'); // 'rtl'
- */
-declare function useLocaleDirection(locale?: string): 'ltr' | 'rtl';
-
-/**
- * Gets the message decoding and translation function `m` provided by `<GTProvider>`.
- *
- * @returns {Function} A translation function that accepts an encoded message, decodes it, and returns the translated value.
- *
- * @example
- * const encodedMessage = msg("Hello, world")
- * const m = useMessages();
- * m(encodedMessage) // returns "Hello, world" translated
- *
- * @example
- * const encodedMessage = msg("My name is {name}", { name: "Brian" });
- * const m = useMessages();
- * m(encodedMessage) // returns "My name is Brian" translated
- */
-declare function useMessages(_messages?: _Messages): MFunctionType;
-
-export { Branch, ClientProvider, Currency, DateTime, GTContext, GTProvider, LocaleSelector, Num, Plural, RegionSelector, T, Var, decodeMsg, decodeOptions, msg, renderVariable, useDefaultLocale, useGT, useGTClass, useLocale, useLocaleDirection, useLocaleProperties, useLocaleSelector, useLocales, useMessages, useRegion, useRegionSelector, useRuntimeTranslation, useSetLocale, useTranslations };
+export { ClientProvider, LocaleSelector, RegionSelector };