gt-react 10.5.0 → 10.6.0-alpha.0

package/dist/client.d.ts

@@ -12,12 +12,13 @@ import * as generaltranslation_dist_locales_getLocaleProperties from 'generaltra
 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
  */
@@ -56,7 +57,7 @@ type _Message = {
     $_hash?: string;
 };
 type _Messages = _Message[];
-type MFunctionType = <T extends string | null | undefined>(encodedMsg: T, options: Record<string, any>) => T extends string ? string : T;
+type MFunctionType = <T extends string | null | undefined>(encodedMsg: T, options?: Record<string, any>) => T extends string ? string : T;
 
 type TranslateIcuCallback = (params: {
     source: string;
@@ -84,6 +85,7 @@ type GTContextType = {
     _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[];
@@ -213,6 +215,7 @@ type GTProviderProps = {
 type ClientProviderProps = {
     children: any;
     dictionary: Dictionary;
+    dictionaryTranslations: Dictionary;
     translations: Translations;
     locale: string;
     locales: string[];
@@ -237,7 +240,7 @@ type ClientProviderProps = {
     customMapping?: CustomMapping;
 };
 
-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;
+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.
@@ -354,7 +357,9 @@ declare function useDefaultLocale(): string;
  * const t = useTranslations();
  * console.log(t('hello')); // Translates item 'hello'
  */
-declare function useTranslations(id?: string): (id: string, options?: Record<string, any>) => string;
+declare function useTranslations(id?: string): ((id: string, options?: Record<string, any>) => string) & {
+    obj: (id: string, options?: Record<string, any>) => Dictionary | DictionaryEntry | string | undefined;
+};
 
 /**
  * Retrieves the user's locale from the `<GTProvider>` context.