gt-react 9.2.30 → 10.0.0-alpha.14

package/dist/client.d.ts

@@ -1,53 +1,54 @@
 import * as React$1 from 'react';
 import React__default from 'react';
+import { JsxChildren } from 'generaltranslation/internal';
+import { HtmlContentPropKeysRecord, Variable, VariableTransformationSuffix, JsxChildren as JsxChildren$1, CustomMapping } from 'generaltranslation/types';
 import * as generaltranslation from 'generaltranslation';
 import { GT } from 'generaltranslation';
-import * as generaltranslation_types from 'generaltranslation/types';
-import { CustomMapping } from 'generaltranslation/types';
 import * as react_jsx_runtime from 'react/jsx-runtime';
+import * as generaltranslation_dist_locales_getLocaleProperties from 'generaltranslation/dist/locales/getLocaleProperties';
 
+/**
+ * For dictionaries, we have Entry and MetaEntry
+ */
 type Entry = string;
-type Metadata = {
+type MetaEntry = {
     context?: string;
-    variablesOptions?: Record<string, any>;
-    [key: string]: any;
+    [key: string]: unknown;
 };
-type DictionaryEntry = Entry | [Entry] | [Entry, Metadata];
+type DictionaryEntry = Entry | [Entry] | [Entry, MetaEntry];
 type Dictionary = {
     [key: string]: Dictionary | DictionaryEntry;
 };
-type Variable = {
-    key: string;
-    id?: number;
-    variable?: 'variable' | 'number' | 'datetime' | 'currency';
-};
+/**
+ * Translated content types
+ */
 type TranslatedElement = {
     type: string;
     props: {
         'data-_gt': {
             id: number;
-            [key: string]: any;
-        };
+            transformation?: string;
+            branches?: Record<string, JsxChildren>;
+        } & HtmlContentPropKeysRecord;
         children?: TranslatedChildren;
     };
 };
 type TranslatedChild = TranslatedElement | string | Variable;
 type TranslatedChildren = TranslatedChild | TranslatedChild[];
-type TranslatedContent = string | (string | Variable)[];
-type TranslationError = {
-    state: 'error';
-    error: string;
-    code?: number;
+type Translations = {
+    [hash: string]: TranslatedChildren;
 };
-type TranslationSuccess = {
-    state: 'success';
-    target: TranslatedChildren | TranslatedContent;
-};
-type TranslationLoading = {
-    state: 'loading';
-};
-type TranslationsObject = {
-    [hash: string]: TranslationSuccess | TranslationLoading | TranslationError;
+/**
+ * Mapping of hashes to translation result status.
+ */
+type TranslationsStatus = {
+    [hash: string]: {
+        status: 'success' | 'loading';
+    } | {
+        status: 'error';
+        code?: number;
+        error?: string;
+    };
 };
 type CustomLoader = (locale: string) => Promise<any>;
 type RenderMethod = 'skeleton' | 'replace' | 'default';
@@ -60,7 +61,7 @@ type InlineTranslationOptions = {
     id?: string;
 } & DictionaryTranslationOptions;
 type VariableProps = {
-    variableType: 'variable' | 'number' | 'datetime' | 'currency';
+    variableType: VariableTransformationSuffix;
     variableValue: any;
     variableOptions: Intl.NumberFormatOptions | Intl.DateTimeFormatOptions;
     variableName: string;
@@ -69,26 +70,28 @@ type RenderVariable = ({ variableType, variableValue, variableOptions, locales,
     locales: string[];
 }) => React__default.JSX.Element;
 
-type TranslateContentCallback = (params: {
-    source: any;
+type TranslateIcuCallback = (params: {
+    source: string;
     targetLocale: string;
     metadata: {
         hash: string;
         context?: string;
     } & Record<string, any>;
-}) => Promise<TranslationSuccess | TranslationLoading | TranslationError>;
+}) => Promise<TranslatedChildren>;
+type TranslateI18nextCallback = TranslateIcuCallback;
 type TranslateChildrenCallback = (params: {
-    source: any;
+    source: JsxChildren$1 | undefined;
     targetLocale: string;
     metadata: {
         hash: string;
         context?: string;
     } & Record<string, any>;
-}) => Promise<TranslationSuccess | TranslationLoading | TranslationError>;
+}) => Promise<TranslatedChildren>;
 
 type GTContextType = {
     gt: GT;
-    registerContentForTranslation: TranslateContentCallback;
+    registerI18nextForTranslation: TranslateI18nextCallback;
+    registerIcuForTranslation: TranslateIcuCallback;
     registerJsxForTranslation: TranslateChildrenCallback;
     _internalUseGTFunction: (string: string, options?: InlineTranslationOptions) => string;
     _internalUseTranslationsFunction: (id: string, options?: DictionaryTranslationOptions) => string;
@@ -97,7 +100,8 @@ type GTContextType = {
     locales: string[];
     setLocale: (locale: string) => void;
     defaultLocale: string;
-    translations: TranslationsObject | null;
+    translations: Translations | null;
+    translationsStatus: TranslationsStatus | null;
     translationRequired: boolean;
     dialectTranslationRequired: boolean;
     renderSettings: {
@@ -109,7 +113,7 @@ type GTContextType = {
 
 declare const GTContext: React$1.Context<GTContextType | undefined>;
 
-declare function useRuntimeTranslation({ projectId, devApiKey, locale, versionId, defaultLocale, runtimeUrl, renderSettings, setTranslations, ...globalMetadata }: {
+declare function useRuntimeTranslation({ projectId, devApiKey, locale, versionId, defaultLocale, runtimeUrl, renderSettings, setTranslations, setTranslationsStatus, ...globalMetadata }: {
     projectId?: string;
     devApiKey?: string;
     locale: string;
@@ -120,10 +124,12 @@ declare function useRuntimeTranslation({ projectId, devApiKey, locale, versionId
         method: RenderMethod;
         timeout?: number;
     };
-    setTranslations: React$1.Dispatch<React$1.SetStateAction<any>>;
+    setTranslations: React$1.Dispatch<React$1.SetStateAction<Translations | null>>;
+    setTranslationsStatus: React$1.Dispatch<React$1.SetStateAction<TranslationsStatus | null>>;
     [key: string]: any;
 }): {
-    registerContentForTranslation: TranslateContentCallback;
+    registerI18nextForTranslation: TranslateI18nextCallback;
+    registerIcuForTranslation: TranslateIcuCallback;
     registerJsxForTranslation: TranslateChildrenCallback;
     runtimeTranslationEnabled: boolean;
 };
@@ -164,7 +170,7 @@ type GTProviderProps = {
     _versionId?: string;
     ssr?: boolean;
     localeCookieName?: string;
-    translations?: TranslationsObject | null;
+    translations?: Translations | null;
     loadDictionary?: CustomLoader;
     loadTranslations?: CustomLoader;
     config?: GTConfig;
@@ -175,7 +181,7 @@ type GTProviderProps = {
 type ClientProviderProps = {
     children: any;
     dictionary: Dictionary;
-    initialTranslations: TranslationsObject;
+    initialTranslations: Translations;
     locale: string;
     locales: string[];
     _versionId?: string;
@@ -378,19 +384,19 @@ declare namespace T {
  * </Currency>
  * ```
  *
- * @param {any} [children] - Optional content to render inside the currency component.
- * @param {string} [currency] - The currency type (e.g., USD, EUR, etc.).
- * @param {string[]} [locales] - Optional locales to use for currency formatting. If not provided, the library default locale (en-US) is used. 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.
+ * @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, name, locales, options, }: {
-    children?: any;
+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;
+}): React__default.JSX.Element | null;
 declare namespace Currency {
     var gtTransformation: string;
 }
@@ -407,17 +413,16 @@ declare namespace Currency {
  * </DateTime>
  * ```
  *
- * @param {any} [children] - Optional content (typically a date) to render inside the component.
- * @param {string[]} [locales] - Optional locales to use for date formatting. If not provided, the library default locale (en-US) is used. If wrapped in a `<GTProvider>`, the user's locale is used.
+ * @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, name, options, }: {
-    children?: any;
+declare function DateTime({ children, locales, options, }: {
+    children: Date | null | undefined;
     locales?: string[];
-    name?: string;
     options?: Intl.DateTimeFormatOptions;
-}): React__default.JSX.Element;
+}): React__default.JSX.Element | null;
 declare namespace DateTime {
     var gtTransformation: string;
 }
@@ -436,16 +441,16 @@ declare namespace DateTime {
  * </Num>
  * ```
  *
- * @param {any} [children] - Optional content (typically a number) to render inside the component.
+ * @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 {JSX.Element} The formatted number component.
+ * @returns {React.JSX.Element} The formatted number component.
  */
-declare function Num({ children, name, locales, options, }: {
-    children?: any;
+declare function Num({ children, locales, options, }: {
+    children: number | string | null | undefined;
     locales?: string[];
     options?: Intl.NumberFormatOptions;
-    name?: string;
-}): React__default.JSX.Element;
+}): React__default.JSX.Element | null;
 declare namespace Num {
     var gtTransformation: string;
 }
@@ -472,10 +477,9 @@ declare namespace Num {
  * @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, name, }: {
+declare function Var({ children }: {
     children?: any;
-    name?: string;
-}): React__default.JSX.Element;
+}): React__default.JSX.Element | null;
 declare namespace Var {
     var gtTransformation: string;
 }
@@ -511,7 +515,7 @@ declare function LocaleSelector({ locales: _locales, customNames, ...props }: {
  * @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 {TranslationsObject | null} [translations=null] - The translations to use for the context.
+ * @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.
@@ -542,23 +546,14 @@ declare function useSetLocale(): (locale: string) => void;
 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.
+ * @returns {object} The locale, locales, and setLocale function.
  */
 declare function useLocaleSelector(locales?: string[]): {
     locale: string;
     locales: string[];
     setLocale: (locale: string) => void;
-    getLocaleProperties: (locale: string) => generaltranslation_types.LocaleProperties;
 };
 
 /**
@@ -581,6 +576,6 @@ declare function useGTClass(): generaltranslation.GT;
  * const localeProperties = useLocaleProperties('en-US');
  * console.log(localeProperties);
  */
-declare function useLocaleProperties(locale: string): generaltranslation_types.LocaleProperties;
+declare function useLocaleProperties(locale: string): generaltranslation_dist_locales_getLocaleProperties.LocaleProperties;
 
 export { Branch, ClientProvider, Currency, DateTime, GTContext, GTProvider, LocaleSelector, Num, Plural, T, Var, renderVariable, useDefaultLocale, useTranslations as useDict, useGT, useGTClass, useLocale, useLocaleProperties, useLocaleSelector, useLocales, useRuntimeTranslation, useSetLocale, useTranslations };