gt-react 10.12.1 → 10.14.0

package/dist/browser.d.ts

@@ -1,126 +1,6 @@
-import { GTConfig, TranslationsLoader } from 'gt-i18n/internal/types';
-import { SyncResolutionFunction } from 'gt-i18n/types';
-import React from 'react';
-import { CustomMapping } from 'generaltranslation/types';
-
-/**
- * Type for custom getLocale function
- */
-type GetLocale = () => string;
-
-/**
- * Parameters for the initializing GT
- * @param {string} params.defaultLocale - The default locale to use
- * @param {string[]} params.locales - The locales to support
- * @param {GetLocale} params.getLocale - The function to get the locale
- * @param {TranslationsLoader} params.loadTranslations - The custom translation loader to use
- */
-type InitializeGTParams = GTConfig & {
-    loadTranslations?: TranslationsLoader;
-    getLocale?: GetLocale;
-};
-
-/**
- * Initialization function for react-core library invoked to enable synchronous resolution
- * @param {InitializeGTParams} params - The parameters for the initialization
- * @returns {Promise<void>} A promise that resolves when the bootstrap is complete
- *
- * @example
- * import gtConfig from '../gt.config.json';
- *
- * function getTranslations(locale: string) {
- *   return import(`./_gt/${locale}.json`);
- * }
- *
- * await bootstrap({
- *   ...gtConfig,
- *   getTranslations,
- * });
- *
- * await import('./main.tsx')
- */
-declare function bootstrap(params: InitializeGTParams): Promise<void>;
-
-/**
- * Configure GT for browser runtime. This must be called to setup GT for browser runtime.
- * @param {InitializeGTParams} config - The configuration for the GT instance
- */
-declare function initializeGT(params: InitializeGTParams): void;
-
-/**
- * Returns the user's current locale.
- * @returns {string} The user's current locale.
- *
- * @example
- * const locale = getLocale();
- * console.log(locale); // 'en-US'
- */
-declare function getLocale(): string;
-/**
- * Returns the locales that are supported by the application.
- * @returns {string[]} The locales that are supported by the application.
- *
- * @example
- * const locales = getLocales();
- * console.log(locales); // ['en-US', 'es-ES']
- */
-declare function getLocales(): string[];
-/**
- * Returns the user's current locales.
- * @returns {string[]} The user's current locales.
- *
- * @note This function causes a page reload
- *
- * @example
- * const locales = getLocales();
- * console.log(locales); // ['en-US', 'es-ES']
- */
-declare function setLocale(locale: string): void;
-/**
- * Returns the user's current default locale.
- * @returns {string} The user's current default locale.
- *
- * @example
- * const defaultLocale = getDefaultLocale();
- * console.log(defaultLocale); // 'en-US'
- */
-declare function getDefaultLocale(): string;
-
-/**
- * NOTE: t() is the only function exported from the 'gt-react' entry point.
- * All other functions in i18n-context are exported from the 'gt-react/browser' entry point.
- */
-/**
- * Translate a message
- * @param {string} message - The message to translate.
- * @param {InlineTranslationOptions} [options] - The options for the translation.
- * @returns {string} The translated message.
- *
- * This is a BROWSER ONLY function.
- *
- * @example
- * t('Hello, world!'); // Translates 'Hello, world!'
- *
- * @example
- * t('Hello, {name}!', { name: 'John' }); // Translates 'Hello, John!'
- *
- */
-declare const t: SyncResolutionFunction;
-
-/**
- * A dropdown component that allows users to select a locale.
- * @param {string[]} [locales] - An optional list of locales to use for the dropdown. If not provided, the list of locales from the `<GTProvider>` context is used.
- * @param {object} [customNames] - (deprecated) An optional object to map locales to custom names. Use `customMapping` instead.
- * @param {CustomMapping} [customMapping] - An optional object to map locales to custom display names, emojis, or other properties.
- * @returns {React.ReactElement | null} The rendered locale dropdown component or null to prevent rendering.
- */
-declare function LocaleSelector({ locales, ...props }: {
-    locales?: string[];
-    customNames?: {
-        [key: string]: string;
-    };
-    customMapping?: CustomMapping;
-    [key: string]: any;
-}): React.JSX.Element | null;
-
-export { LocaleSelector, bootstrap, getDefaultLocale, getLocale, getLocales, initializeGT, setLocale, t };
+export * from './i18n-context/setup/index';
+export * from './i18n-context/functions/locale-operations';
+export * from './i18n-context/functions/versionId';
+export { t } from './i18n-context/functions/translation/t';
+export { LocaleSelector } from './i18n-context/ui/LocaleSelector';
+//# sourceMappingURL=browser.d.ts.map

package/dist/browser.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../src/browser.ts"],"names":[],"mappings":"AAMA,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4CAA4C,CAAC;AAC3D,OAAO,EAAE,CAAC,EAAE,MAAM,wCAAwC,CAAC;AAC3D,OAAO,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC"}
+{"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../src/browser.ts"],"names":[],"mappings":"AAMA,cAAc,4BAA4B,CAAC;AAC3C,cAAc,4CAA4C,CAAC;AAC3D,cAAc,oCAAoC,CAAC;AACnD,OAAO,EAAE,CAAC,EAAE,MAAM,wCAAwC,CAAC;AAC3D,OAAO,EAAE,cAAc,EAAE,MAAM,kCAAkC,CAAC"}