gt-react 9.2.23 → 9.2.25-alpha.0

package/dist/client.d.ts

@@ -1,5 +1,10 @@
 import * as React$1 from 'react';
 import React__default from 'react';
+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';
 
 type Entry = string;
 type Metadata = {
@@ -82,6 +87,7 @@ type TranslateChildrenCallback = (params: {
 }) => Promise<TranslationSuccess | TranslationLoading | TranslationError>;
 
 type GTContextType = {
+    gt: GT;
     registerContentForTranslation: TranslateContentCallback;
     registerJsxForTranslation: TranslateChildrenCallback;
     _internalUseGTFunction: (string: string, options?: InlineTranslationOptions) => string;
@@ -100,6 +106,72 @@ type GTContextType = {
     };
     projectId?: string;
 };
+
+declare const GTContext: React$1.Context<GTContextType | undefined>;
+
+declare function useRuntimeTranslation({ projectId, devApiKey, locale, versionId, defaultLocale, runtimeUrl, renderSettings, setTranslations, ...globalMetadata }: {
+    projectId?: string;
+    devApiKey?: string;
+    locale: string;
+    versionId?: string;
+    defaultLocale?: string;
+    runtimeUrl?: string | null;
+    renderSettings: {
+        method: RenderMethod;
+        timeout?: number;
+    };
+    setTranslations: React$1.Dispatch<React$1.SetStateAction<any>>;
+    [key: string]: any;
+}): {
+    registerContentForTranslation: TranslateContentCallback;
+    registerJsxForTranslation: TranslateChildrenCallback;
+    runtimeTranslationEnabled: boolean;
+};
+
+declare const renderVariable: RenderVariable;
+
+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;
+};
+type GTProviderProps = {
+    children?: React.ReactNode;
+    projectId?: string;
+    devApiKey?: string;
+    dictionary?: any;
+    locales?: string[];
+    defaultLocale?: string;
+    locale?: string;
+    cacheUrl?: string;
+    runtimeUrl?: string;
+    renderSettings?: {
+        method: RenderMethod;
+        timeout?: number;
+    };
+    _versionId?: string;
+    ssr?: boolean;
+    localeCookieName?: string;
+    translations?: TranslationsObject | null;
+    loadDictionary?: CustomLoader;
+    loadTranslations?: CustomLoader;
+    config?: GTConfig;
+    fallback?: React.ReactNode;
+    customMapping?: CustomMapping;
+    [key: string]: any;
+};
 type ClientProviderProps = {
     children: any;
     dictionary: Dictionary;
@@ -122,32 +194,10 @@ type ClientProviderProps = {
     gtServicesEnabled?: boolean;
     localeCookieName?: string;
     resetLocaleCookieName: string;
+    customMapping?: CustomMapping;
 };
 
-declare const GTContext: React$1.Context<GTContextType | undefined>;
-
-declare function useRuntimeTranslation({ projectId, devApiKey, locale, versionId, defaultLocale, runtimeUrl, renderSettings, setTranslations, runtimeTranslationEnabled, ...globalMetadata }: {
-    projectId?: string;
-    devApiKey?: string;
-    locale: string;
-    versionId?: string;
-    defaultLocale?: string;
-    runtimeUrl?: string | null;
-    runtimeTranslationEnabled: boolean;
-    renderSettings: {
-        method: RenderMethod;
-        timeout?: number;
-    };
-    setTranslations: React$1.Dispatch<React$1.SetStateAction<any>>;
-    [key: string]: any;
-}): {
-    registerContentForTranslation: TranslateContentCallback;
-    registerJsxForTranslation: TranslateChildrenCallback;
-};
-
-declare const renderVariable: RenderVariable;
-
-declare function ClientProvider({ children, dictionary, initialTranslations, locale: _locale, _versionId, defaultLocale, translationRequired, dialectTranslationRequired, locales, renderSettings, projectId, devApiKey, runtimeUrl, runtimeTranslationEnabled, resetLocaleCookieName, localeCookieName, }: ClientProviderProps): React$1.JSX.Element;
+declare function ClientProvider({ children, dictionary, initialTranslations, locale: _locale, _versionId, defaultLocale, translationRequired, dialectTranslationRequired, locales, renderSettings, projectId, devApiKey, runtimeUrl, runtimeTranslationEnabled, resetLocaleCookieName, localeCookieName, customMapping, }: ClientProviderProps): React$1.JSX.Element;
 
 /**
  * The `<Branch>` component dynamically renders a specified branch of content or a fallback child component.
@@ -433,30 +483,17 @@ declare namespace Var {
 /**
  * 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 - An optional object to map locales to custom names.
  * @returns {React.ReactElement | null} The rendered locale dropdown component or null to prevent rendering.
  */
-declare function LocaleSelector({ locales: _locales, ...props }: {
+declare function LocaleSelector({ locales: _locales, customNames, ...props }: {
     locales?: string[];
+    customNames?: {
+        [key: string]: string;
+    };
     [key: string]: any;
 }): React__default.JSX.Element | 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;
-};
-
 /**
  * Provides General Translation context to its children, which can then access `useGT`, `useLocale`, and `useDefaultLocale`.
  *
@@ -479,30 +516,7 @@ type GTConfig = {
  *
  * @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, loadDictionary, loadTranslations, fallback, translations: _translations, _versionId, ...metadata }: {
-    children?: React__default.ReactNode;
-    projectId?: string;
-    devApiKey?: string;
-    dictionary?: any;
-    locales?: string[];
-    defaultLocale?: string;
-    locale?: string;
-    cacheUrl?: string;
-    runtimeUrl?: string;
-    renderSettings?: {
-        method: RenderMethod;
-        timeout?: number;
-    };
-    _versionId?: string;
-    ssr?: boolean;
-    localeCookieName?: string;
-    translations?: TranslationsObject | null;
-    loadDictionary?: CustomLoader;
-    loadTranslations?: CustomLoader;
-    config?: GTConfig;
-    fallback?: React__default.ReactNode;
-    [key: string]: any;
-}): React__default.JSX.Element;
+declare function GTProvider({ children, config, projectId: _projectId, devApiKey: _devApiKey, dictionary: _dictionary, locales, defaultLocale, cacheUrl, runtimeUrl, renderSettings, ssr, localeCookieName, locale: _locale, loadDictionary, loadTranslations, fallback, translations: _translations, _versionId, customMapping, ...metadata }: GTProviderProps): react_jsx_runtime.JSX.Element;
 
 /**
  * Sets the user's locale in the `<GTProvider>` context.
@@ -538,4 +552,7 @@ declare function useLocaleSelector(locales?: string[]): {
     setLocale: (locale: string) => void;
 };
 
-export { Branch, ClientProvider, Currency, DateTime, GTContext, GTProvider, LocaleSelector, Num, Plural, T, Var, renderVariable, useDefaultLocale, useDict, useGT, useLocale, useLocaleSelector, useLocales, useRuntimeTranslation, useSetLocale };
+declare function useGTClass(): generaltranslation.GT;
+declare function useLocaleProperties(locale: string): generaltranslation_types.LocaleProperties;
+
+export { Branch, ClientProvider, Currency, DateTime, GTContext, GTProvider, LocaleSelector, Num, Plural, T, Var, renderVariable, useDefaultLocale, useDict, useGT, useGTClass, useLocale, useLocaleProperties, useLocaleSelector, useLocales, useRuntimeTranslation, useSetLocale };

package/dist/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,qBAAqB,MAAM,wCAAwC,CAAC;AAC3E,OAAO,cAAc,MAAM,qCAAqC,CAAC;AACjE,OAAO,cAAc,MAAM,2BAA2B,CAAC;AACvD,OAAO,MAAM,MAAM,mBAAmB,CAAC;AACvC,OAAO,MAAM,MAAM,2BAA2B,CAAC;AAC/C,OAAO,KAAK,MAAM,2BAA2B,CAAC;AAC9C,OAAO,gBAAgB,MAAM,0BAA0B,CAAC;AACxD,OAAO,OAAO,MAAM,6BAA6B,CAAC;AAClD,OAAO,SAAS,MAAM,mBAAmB,CAAC;AAC1C,OAAO,CAAC,MAAM,wBAAwB,CAAC;AACvC,OAAO,QAAQ,MAAM,sBAAsB,CAAC;AAC5C,OAAO,QAAQ,MAAM,sBAAsB,CAAC;AAC5C,OAAO,GAAG,MAAM,iBAAiB,CAAC;AAClC,OAAO,GAAG,MAAM,iBAAiB,CAAC;AAClC,OAAO,cAAc,MAAM,qBAAqB,CAAC;AACjD,OAAO,UAAU,MAAM,uBAAuB,CAAC;AAC/C,OAAO,YAAY,MAAM,sBAAsB,CAAC;AAChD,OAAO,UAAU,MAAM,oBAAoB,CAAC;AAC5C,OAAO,iBAAiB,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EACL,SAAS,EACT,UAAU,EACV,qBAAqB,EACrB,cAAc,EACd,cAAc,EACd,KAAK,EACL,OAAO,EACP,gBAAgB,EAChB,SAAS,EACT,UAAU,EACV,YAAY,EACZ,iBAAiB,EACjB,CAAC,EACD,GAAG,EACH,GAAG,EACH,QAAQ,EACR,QAAQ,EACR,MAAM,EACN,MAAM,EACN,cAAc,GACf,CAAC"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,qBAAqB,MAAM,wCAAwC,CAAC;AAC3E,OAAO,cAAc,MAAM,4BAA4B,CAAC;AACxD,OAAO,cAAc,MAAM,2BAA2B,CAAC;AACvD,OAAO,MAAM,MAAM,mBAAmB,CAAC;AACvC,OAAO,MAAM,MAAM,2BAA2B,CAAC;AAC/C,OAAO,KAAK,MAAM,2BAA2B,CAAC;AAC9C,OAAO,gBAAgB,MAAM,0BAA0B,CAAC;AACxD,OAAO,OAAO,MAAM,6BAA6B,CAAC;AAClD,OAAO,SAAS,MAAM,mBAAmB,CAAC;AAC1C,OAAO,CAAC,MAAM,wBAAwB,CAAC;AACvC,OAAO,QAAQ,MAAM,sBAAsB,CAAC;AAC5C,OAAO,QAAQ,MAAM,sBAAsB,CAAC;AAC5C,OAAO,GAAG,MAAM,iBAAiB,CAAC;AAClC,OAAO,GAAG,MAAM,iBAAiB,CAAC;AAClC,OAAO,cAAc,MAAM,qBAAqB,CAAC;AACjD,OAAO,UAAU,MAAM,uBAAuB,CAAC;AAC/C,OAAO,YAAY,MAAM,sBAAsB,CAAC;AAChD,OAAO,UAAU,MAAM,oBAAoB,CAAC;AAC5C,OAAO,iBAAiB,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAErE,OAAO,EACL,SAAS,EACT,UAAU,EACV,qBAAqB,EACrB,cAAc,EACd,cAAc,EACd,KAAK,EACL,OAAO,EACP,gBAAgB,EAChB,SAAS,EACT,UAAU,EACV,YAAY,EACZ,iBAAiB,EACjB,UAAU,EACV,mBAAmB,EACnB,CAAC,EACD,GAAG,EACH,GAAG,EACH,QAAQ,EACR,QAAQ,EACR,MAAM,EACN,MAAM,EACN,cAAc,GACf,CAAC"}