gt-react 10.2.1 → 10.2.2-alpha.1

package/dist/client.d.ts

@@ -29,19 +29,7 @@ type TranslatedElement = {
 type TranslatedChild = TranslatedElement | string | Variable;
 type TranslatedChildren = TranslatedChild | TranslatedChild[];
 type Translations = {
-    [hash: string]: TranslatedChildren;
-};
-/**
- * Mapping of hashes to translation result status.
- */
-type TranslationsStatus = {
-    [hash: string]: {
-        status: 'success' | 'loading';
-    } | {
-        status: 'error';
-        code?: number;
-        error?: string;
-    };
+    [hash: string]: TranslatedChildren | null;
 };
 type CustomLoader = (locale: string) => Promise<any>;
 type RenderMethod = 'skeleton' | 'replace' | 'default';
@@ -49,6 +37,7 @@ type DictionaryTranslationOptions = Record<string, any>;
 type InlineTranslationOptions = DictionaryTranslationOptions & {
     $context?: string;
     $id?: string;
+    $_hash?: string;
 };
 type VariableProps = {
     variableType: VariableType;
@@ -59,6 +48,13 @@ type VariableProps = {
 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 TranslateIcuCallback = (params: {
     source: string;
@@ -68,7 +64,6 @@ type TranslateIcuCallback = (params: {
         context?: string;
     } & Record<string, any>;
 }) => Promise<TranslatedChildren>;
-type TranslateI18nextCallback = TranslateIcuCallback;
 type TranslateChildrenCallback = (params: {
     source: JsxChildren | undefined;
     targetLocale: string;
@@ -80,12 +75,13 @@ type TranslateChildrenCallback = (params: {
 
 type GTContextType = {
     gt: GT;
-    registerI18nextForTranslation: TranslateI18nextCallback;
     registerIcuForTranslation: TranslateIcuCallback;
     registerJsxForTranslation: TranslateChildrenCallback;
-    _internalUseGTFunction: (string: string, options?: InlineTranslationOptions) => string;
-    _internalUseTranslationsFunction: (id: string, options?: DictionaryTranslationOptions) => string;
-    runtimeTranslationEnabled: boolean;
+    _tFunction: (message: string, options?: InlineTranslationOptions, preloadedTranslations?: Translations) => string;
+    _filterMessagesForPreload: (_messages: _Messages) => _Messages;
+    _preloadMessages: (_messages: _Messages) => Promise<Translations>;
+    _dictionaryFunction: (id: string, options?: DictionaryTranslationOptions) => string;
+    developmentApiEnabled: boolean;
     locale: string;
     locales: string[];
     setLocale: (locale: string) => void;
@@ -93,7 +89,6 @@ type GTContextType = {
     region: string | undefined;
     setRegion: (region: string | undefined) => void;
     translations: Translations | null;
-    translationsStatus: TranslationsStatus | null;
     translationRequired: boolean;
     dialectTranslationRequired: boolean;
     renderSettings: {
@@ -105,7 +100,8 @@ type GTContextType = {
 
 declare const GTContext: React$1.Context<GTContextType | undefined>;
 
-declare function useRuntimeTranslation({ gt, locale, versionId, defaultLocale, runtimeUrl, renderSettings, setTranslations, setTranslationsStatus, ...globalMetadata }: {
+declare function useRuntimeTranslation({ gt, locale, versionId, // kept for API compatibility (not used)
+defaultLocale, runtimeUrl, renderSettings, setTranslations, ...additionalMetadata }: {
     gt: GT;
     locale: string;
     versionId?: string;
@@ -116,13 +112,11 @@ declare function useRuntimeTranslation({ gt, locale, versionId, defaultLocale, r
         timeout?: number;
     };
     setTranslations: React$1.Dispatch<React$1.SetStateAction<Translations | null>>;
-    setTranslationsStatus: React$1.Dispatch<React$1.SetStateAction<TranslationsStatus | null>>;
     [key: string]: any;
 }): {
-    registerI18nextForTranslation: TranslateI18nextCallback;
     registerIcuForTranslation: TranslateIcuCallback;
     registerJsxForTranslation: TranslateChildrenCallback;
-    runtimeTranslationEnabled: boolean;
+    developmentApiEnabled: boolean;
 };
 
 declare const renderVariable: RenderVariable;
@@ -175,8 +169,7 @@ type GTProviderProps = {
 type ClientProviderProps = {
     children: any;
     dictionary: Dictionary;
-    initialTranslations: Translations;
-    initialTranslationsStatus: TranslationsStatus;
+    translations: Translations;
     locale: string;
     locales: string[];
     region?: string;
@@ -189,7 +182,7 @@ type ClientProviderProps = {
         method: RenderMethod;
         timeout?: number;
     };
-    runtimeTranslationEnabled: boolean;
+    developmentApiEnabled: boolean;
     projectId?: string;
     devApiKey?: string;
     runtimeUrl?: string | null;
@@ -200,7 +193,7 @@ type ClientProviderProps = {
     customMapping?: CustomMapping;
 };
 
-declare function ClientProvider({ children, dictionary, initialTranslations, initialTranslationsStatus, locale: _locale, region: _region, _versionId, defaultLocale, translationRequired, dialectTranslationRequired, locales, renderSettings, projectId, devApiKey, runtimeUrl, runtimeTranslationEnabled, resetLocaleCookieName, localeCookieName, regionCookieName, customMapping, }: ClientProviderProps): React$1.JSX.Element;
+declare function ClientProvider({ children, dictionary, 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.
@@ -290,9 +283,10 @@ declare namespace Plural {
  * </>);
  *
  */
-declare function useGT(): (string: string, options?: Record<string, any> & {
+declare function useGT(_messages?: _Messages): (string: string, options?: Record<string, any> & {
     $id?: string;
     $context?: string;
+    $_hash?: string;
 }) => string;
 
 /**
@@ -363,12 +357,13 @@ declare function useLocale(): string;
  *
  * @throws {Error} If a plural translation is requested but the `n` option is not provided.
  */
-declare function T({ children, id, context, ...options }: {
+declare function T({ children, id, context, _hash, ...options }: {
     children: any;
     id?: string;
     context?: string;
+    _hash?: string;
     [key: string]: any;
-}): React__default.JSX.Element | null;
+}): React__default.JSX.Element | undefined;
 declare namespace T {
     var _gtt: string;
 }