@generaltranslation/react-core 1.1.1 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,25 +1,3 @@
1
1
  import { InternalGTProviderProps } from '../types-dir/config';
2
- /**
3
- * Provides General Translation context to its children, which can then access `useGT`, `useLocale`, and `useDefaultLocale`.
4
- *
5
- * @param {React.ReactNode} children - The children components that will use the translation context.
6
- * @param {string} [projectId] - The project ID required for General Translation cloud services.
7
- * @param {Dictionary} [dictionary=defaultDictionary] - The translation dictionary for the project.
8
- * @param {string[]} [locales] - The list of approved locales for the project.
9
- * @param {string} [defaultLocale=libraryDefaultLocale] - The default locale to use if no other locale is found.
10
- * @param {string} [locale] - The current locale, if already set.
11
- * @param {string} [cacheUrl='https://cdn.gtx.dev'] - The URL of the cache service for fetching translations.
12
- * @param {string} [runtimeUrl='https://runtime.gtx.dev'] - The URL of the runtime service for fetching translations.
13
- * @param {RenderSettings} [renderSettings=defaultRenderSettings] - The settings for rendering translations.
14
- * @param {string} [_versionId] - The version ID for fetching translations.
15
- * @param {string} [devApiKey] - The API key for development environments.
16
- * @param {object} [metadata] - Additional metadata to pass to the context.
17
- * @param {boolean} [ssr=isSSREnabled()] - Whether to enable server-side rendering.
18
- * @param {string} [localeCookieName=defaultLocaleCookieName] - The name of the cookie to store the locale.
19
- * @param {Translations | null} [translations=null] - The translations to use for the context.
20
- * @param {React.ReactNode} [fallback = undefined] - Custom fallback to display while loading
21
- *
22
- * @returns {JSX.Element} The provider component for General Translation context.
23
- */
24
- export default function GTProvider({ children, config, environment, projectId: _projectId, devApiKey: _devApiKey, _versionId, dictionary: _dictionary, locales, defaultLocale, cacheUrl, runtimeUrl, renderSettings, ssr, localeCookieName, locale: _locale, region: _region, loadDictionary, loadTranslations, fallback, translations: _translations, customMapping, readAuthFromEnv, useDetermineLocale, useRegionState, ...metadata }: InternalGTProviderProps): import("react/jsx-runtime").JSX.Element;
2
+ export default function GTProvider({ children, config, environment, projectId: _projectId, devApiKey: _devApiKey, _versionId, dictionary: _dictionary, locales, defaultLocale, cacheUrl, runtimeUrl, renderSettings, ssr, localeCookieName, locale: _locale, region: _region, loadDictionary, loadTranslations, fallback, translations: _translations, customMapping, enableI18n: _enableI18n, enableI18nLoaded, useEnableI18n, readAuthFromEnv, useDetermineLocale, useRegionState, ...metadata }: InternalGTProviderProps): import("react/jsx-runtime").JSX.Element;
25
3
  //# sourceMappingURL=GTProvider.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"GTProvider.d.ts","sourceRoot":"","sources":["../../src/provider/GTProvider.tsx"],"names":[],"mappings":"AAeA,OAAO,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AAa9D;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,OAAO,UAAU,UAAU,CAAC,EACjC,QAAQ,EACR,MAAM,EACN,WAA0B,EAC1B,SAAS,EAAE,UAAoC,EAC/C,SAAS,EAAE,UAAoC,EAC/C,UAA+B,EAC/B,UAAU,EAAE,WAAsC,EAClD,OAA+B,EAC/B,aAA6D,EAC7D,QAA8C,EAC9C,UAAuD,EACvD,cACuC,EACvC,GAAmC,EACnC,gBAAsE,EACtE,MAAM,EAAE,OAAY,EACpB,MAAM,EAAE,OAAO,EACf,cAAc,EACd,gBAAgB,EAChB,QAAoB,EACpB,YAAY,EAAE,aAAoB,EAClC,aAAqC,EACrC,eAAkC,EAClC,kBAAwC,EACxC,cAAgC,EAChC,GAAG,QAAQ,EACZ,EAAE,uBAAuB,2CA+MzB"}
1
+ {"version":3,"file":"GTProvider.d.ts","sourceRoot":"","sources":["../../src/provider/GTProvider.tsx"],"names":[],"mappings":"AAgBA,OAAO,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAC;AAe9D,MAAM,CAAC,OAAO,UAAU,UAAU,CAAC,EACjC,QAAQ,EACR,MAAM,EACN,WAA0B,EAC1B,SAAS,EAAE,UAAoC,EAC/C,SAAS,EAAE,UAAoC,EAC/C,UAA+B,EAC/B,UAAU,EAAE,WAAsC,EAClD,OAA+B,EAC/B,aAA6D,EAC7D,QAA8C,EAC9C,UAAuD,EACvD,cACuC,EACvC,GAAmC,EACnC,gBAAsE,EACtE,MAAM,EAAE,OAAY,EACpB,MAAM,EAAE,OAAO,EACf,cAAc,EACd,gBAAgB,EAChB,QAAoB,EACpB,YAAY,EAAE,aAAoB,EAClC,aAAqC,EACrC,UAAU,EAAE,WAEJ,EACR,gBAAgB,EAChB,aAA8B,EAC9B,eAAkC,EAClC,kBAAwC,EACxC,cAAgC,EAChC,GAAG,QAAQ,EACZ,EAAE,uBAAuB,2CAwNzB"}
@@ -2,6 +2,7 @@ import { CustomMapping } from 'generaltranslation/types';
2
2
  export type UseDetermineLocaleParams = {
3
3
  defaultLocale: string;
4
4
  locales: string[];
5
+ enableI18n: boolean;
5
6
  locale?: string;
6
7
  localeCookieName?: string;
7
8
  ssr?: boolean;
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/provider/hooks/locales/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAEzD,MAAM,MAAM,wBAAwB,GAAG;IACrC,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC,CAAC"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/provider/hooks/locales/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAEzD,MAAM,MAAM,wBAAwB,GAAG;IACrC,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,UAAU,EAAE,OAAO,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,wBAAwB,GAAG,CAAC,MAAM,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC,CAAC"}
@@ -1,12 +1,13 @@
1
1
  import { CustomMapping } from 'generaltranslation/types';
2
2
  import { UseDetermineLocaleParams, UseDetermineLocaleReturn } from './types';
3
- export declare function useLocaleState({ _locale, defaultLocale, locales: _locales, ssr, localeCookieName, customMapping, useDetermineLocale, }: {
3
+ export declare function useLocaleState({ _locale, defaultLocale, locales: _locales, ssr, localeCookieName, customMapping, useDetermineLocale, enableI18n, }: {
4
4
  _locale: string;
5
5
  defaultLocale: string;
6
6
  locales: string[];
7
7
  ssr: boolean;
8
8
  localeCookieName: string;
9
9
  customMapping?: CustomMapping;
10
+ enableI18n: boolean;
10
11
  useDetermineLocale: (params: UseDetermineLocaleParams) => UseDetermineLocaleReturn;
11
12
  }): {
12
13
  locale: string;
@@ -1 +1 @@
1
- {"version":3,"file":"useLocaleState.d.ts","sourceRoot":"","sources":["../../../../src/provider/hooks/locales/useLocaleState.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAKzD,OAAO,EAAE,wBAAwB,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAC;AAE7E,wBAAgB,cAAc,CAAC,EAC7B,OAAO,EACP,aAAa,EACb,OAAO,EAAE,QAAQ,EACjB,GAAG,EACH,gBAAgB,EAChB,aAAa,EACb,kBAAkB,GACnB,EAAE;IACD,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,GAAG,EAAE,OAAO,CAAC;IACb,gBAAgB,EAAE,MAAM,CAAC;IACzB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,kBAAkB,EAAE,CAClB,MAAM,EAAE,wBAAwB,KAC7B,wBAAwB,CAAC;CAC/B;;;;;;EAgEA"}
1
+ {"version":3,"file":"useLocaleState.d.ts","sourceRoot":"","sources":["../../../../src/provider/hooks/locales/useLocaleState.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAKzD,OAAO,EAAE,wBAAwB,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAC;AAE7E,wBAAgB,cAAc,CAAC,EAC7B,OAAO,EACP,aAAa,EACb,OAAO,EAAE,QAAQ,EACjB,GAAG,EACH,gBAAgB,EAChB,aAAa,EACb,kBAAkB,EAClB,UAAU,GACX,EAAE;IACD,OAAO,EAAE,MAAM,CAAC;IAChB,aAAa,EAAE,MAAM,CAAC;IACtB,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,GAAG,EAAE,OAAO,CAAC;IACb,gBAAgB,EAAE,MAAM,CAAC;IACzB,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,UAAU,EAAE,OAAO,CAAC;IACpB,kBAAkB,EAAE,CAClB,MAAM,EAAE,wBAAwB,KAC7B,wBAAwB,CAAC;CAC/B;;;;;;EAmEA"}
@@ -7,4 +7,13 @@ export type UseRegionStateReturn = {
7
7
  region: string | undefined;
8
8
  setRegion: (region: string | undefined) => void;
9
9
  };
10
+ export type UseEnableI18nParams = {
11
+ enableI18n: boolean;
12
+ enableI18nCookieName: string;
13
+ enableI18nLoaded?: boolean;
14
+ ssr: boolean;
15
+ };
16
+ export type UseEnableI18nReturn = {
17
+ enableI18n: boolean;
18
+ };
10
19
  //# sourceMappingURL=types.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/provider/hooks/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,oBAAoB,GAAG;IACjC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,GAAG,EAAE,OAAO,CAAC;IACb,gBAAgB,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,SAAS,EAAE,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,KAAK,IAAI,CAAC;CACjD,CAAC"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/provider/hooks/types.ts"],"names":[],"mappings":"AACA,MAAM,MAAM,oBAAoB,GAAG;IACjC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,GAAG,EAAE,OAAO,CAAC;IACb,gBAAgB,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG;IACjC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,SAAS,EAAE,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,KAAK,IAAI,CAAC;CACjD,CAAC;AAGF,MAAM,MAAM,mBAAmB,GAAG;IAChC,UAAU,EAAE,OAAO,CAAC;IACpB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,GAAG,EAAE,OAAO,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,UAAU,EAAE,OAAO,CAAC;CACrB,CAAC"}
@@ -0,0 +1,3 @@
1
+ import { UseEnableI18nParams, UseEnableI18nReturn } from './types';
2
+ export declare function useEnableI18n({ enableI18n: _enableI18n, }: UseEnableI18nParams): UseEnableI18nReturn;
3
+ //# sourceMappingURL=useEnableI18n.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"useEnableI18n.d.ts","sourceRoot":"","sources":["../../../src/provider/hooks/useEnableI18n.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,SAAS,CAAC;AAGnE,wBAAgB,aAAa,CAAC,EAC5B,UAAU,EAAE,WAAW,GACxB,EAAE,mBAAmB,GAAG,mBAAmB,CAG3C"}
@@ -4,7 +4,13 @@ import { Translations, CustomLoader } from './types';
4
4
  import { CustomMapping } from 'generaltranslation/types';
5
5
  import { AuthFromEnvParams, AuthFromEnvReturn } from '../utils/types';
6
6
  import { UseDetermineLocaleParams, UseDetermineLocaleReturn } from '../provider/hooks/locales/types';
7
- import { UseRegionStateParams, UseRegionStateReturn } from '../provider/hooks/types';
7
+ import { UseRegionStateParams, UseRegionStateReturn, UseEnableI18nParams, UseEnableI18nReturn } from '../provider/hooks/types';
8
+ export type EnableI18nConfig = {
9
+ /** Persist the feature flag as a cookie @default false (use when loading flag asynchronously) */
10
+ persist?: boolean;
11
+ /** Name of cookie @default defaultEnableI18nCookieName */
12
+ cookieName?: string;
13
+ };
8
14
  export type GTConfig = {
9
15
  projectId?: string;
10
16
  devApiKey?: string;
@@ -22,6 +28,7 @@ export type GTConfig = {
22
28
  localeCookieName?: string;
23
29
  customMapping?: CustomMapping;
24
30
  modelProvider?: string;
31
+ enableI18n?: boolean;
25
32
  };
26
33
  export type InternalGTProviderProps = {
27
34
  children?: React.ReactNode;
@@ -49,9 +56,13 @@ export type InternalGTProviderProps = {
49
56
  customMapping?: CustomMapping;
50
57
  modelProvider?: string;
51
58
  environment: 'development' | 'production' | 'test';
59
+ enableI18n?: boolean;
60
+ /** Flag to indicate if the enableI18n flag is finished loading asynchronously */
61
+ enableI18nLoaded?: boolean;
52
62
  readAuthFromEnv: (params: AuthFromEnvParams) => AuthFromEnvReturn;
53
63
  useDetermineLocale: (params: UseDetermineLocaleParams) => UseDetermineLocaleReturn;
54
64
  useRegionState: (params: UseRegionStateParams) => UseRegionStateReturn;
65
+ useEnableI18n?: (params: UseEnableI18nParams) => UseEnableI18nReturn;
55
66
  [key: string]: any;
56
67
  };
57
68
  //# sourceMappingURL=config.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/types-dir/config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAGzD,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACtE,OAAO,EACL,wBAAwB,EACxB,wBAAwB,EACzB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACL,oBAAoB,EACpB,oBAAoB,EACrB,MAAM,yBAAyB,CAAC;AAGjC,MAAM,MAAM,QAAQ,GAAG;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,cAAc,CAAC,EAAE;QACf,MAAM,EAAE,YAAY,CAAC;QACrB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,GAAG,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE;QACf,MAAM,EAAE,YAAY,CAAC;QACrB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,YAAY,CAAC,EAAE,YAAY,GAAG,IAAI,CAAC;IACnC,cAAc,CAAC,EAAE,YAAY,CAAC;IAC9B,gBAAgB,CAAC,EAAE,YAAY,CAAC;IAChC,MAAM,CAAC,EAAE,QAAQ,CAAC;IAClB,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,WAAW,EAAE,aAAa,GAAG,YAAY,GAAG,MAAM,CAAC;IACnD,eAAe,EAAE,CAAC,MAAM,EAAE,iBAAiB,KAAK,iBAAiB,CAAC;IAClE,kBAAkB,EAAE,CAClB,MAAM,EAAE,wBAAwB,KAC7B,wBAAwB,CAAC;IAC9B,cAAc,EAAE,CAAC,MAAM,EAAE,oBAAoB,KAAK,oBAAoB,CAAC;IACvE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB,CAAC"}
1
+ {"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/types-dir/config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACrD,OAAO,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAGzD,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACtE,OAAO,EACL,wBAAwB,EACxB,wBAAwB,EACzB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EACL,oBAAoB,EACpB,oBAAoB,EACpB,mBAAmB,EACnB,mBAAmB,EACpB,MAAM,yBAAyB,CAAC;AAGjC,MAAM,MAAM,gBAAgB,GAAG;IAC7B,iGAAiG;IACjG,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,0DAA0D;IAC1D,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAGF,MAAM,MAAM,QAAQ,GAAG;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,cAAc,CAAC,EAAE;QACf,MAAM,EAAE,YAAY,CAAC;QACrB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAAG;IACpC,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,GAAG,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE;QACf,MAAM,EAAE,YAAY,CAAC;QACrB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,YAAY,CAAC,EAAE,YAAY,GAAG,IAAI,CAAC;IACnC,cAAc,CAAC,EAAE,YAAY,CAAC;IAC9B,gBAAgB,CAAC,EAAE,YAAY,CAAC;IAChC,MAAM,CAAC,EAAE,QAAQ,CAAC;IAClB,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,WAAW,EAAE,aAAa,GAAG,YAAY,GAAG,MAAM,CAAC;IAEnD,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,iFAAiF;IACjF,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,eAAe,EAAE,CAAC,MAAM,EAAE,iBAAiB,KAAK,iBAAiB,CAAC;IAClE,kBAAkB,EAAE,CAClB,MAAM,EAAE,wBAAwB,KAC7B,wBAAwB,CAAC;IAC9B,cAAc,EAAE,CAAC,MAAM,EAAE,oBAAoB,KAAK,oBAAoB,CAAC;IACvE,aAAa,CAAC,EAAE,CAAC,MAAM,EAAE,mBAAmB,KAAK,mBAAmB,CAAC;IACrE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB,CAAC"}
package/dist/types.d.ts CHANGED
@@ -132,6 +132,7 @@ type AuthFromEnvReturn = {
132
132
  type UseDetermineLocaleParams = {
133
133
  defaultLocale: string;
134
134
  locales: string[];
135
+ enableI18n: boolean;
135
136
  locale?: string;
136
137
  localeCookieName?: string;
137
138
  ssr?: boolean;
@@ -148,6 +149,15 @@ type UseRegionStateReturn = {
148
149
  region: string | undefined;
149
150
  setRegion: (region: string | undefined) => void;
150
151
  };
152
+ type UseEnableI18nParams = {
153
+ enableI18n: boolean;
154
+ enableI18nCookieName: string;
155
+ enableI18nLoaded?: boolean;
156
+ ssr: boolean;
157
+ };
158
+ type UseEnableI18nReturn = {
159
+ enableI18n: boolean;
160
+ };
151
161
 
152
162
  type LocaleSelectorProps = {
153
163
  locales?: string[];
@@ -182,6 +192,7 @@ type GTConfig = {
182
192
  localeCookieName?: string;
183
193
  customMapping?: CustomMapping;
184
194
  modelProvider?: string;
195
+ enableI18n?: boolean;
185
196
  };
186
197
  type InternalGTProviderProps = {
187
198
  children?: React.ReactNode;
@@ -209,10 +220,14 @@ type InternalGTProviderProps = {
209
220
  customMapping?: CustomMapping;
210
221
  modelProvider?: string;
211
222
  environment: 'development' | 'production' | 'test';
223
+ enableI18n?: boolean;
224
+ /** Flag to indicate if the enableI18n flag is finished loading asynchronously */
225
+ enableI18nLoaded?: boolean;
212
226
  readAuthFromEnv: (params: AuthFromEnvParams) => AuthFromEnvReturn;
213
227
  useDetermineLocale: (params: UseDetermineLocaleParams) => UseDetermineLocaleReturn;
214
228
  useRegionState: (params: UseRegionStateParams) => UseRegionStateReturn;
229
+ useEnableI18n?: (params: UseEnableI18nParams) => UseEnableI18nReturn;
215
230
  [key: string]: any;
216
231
  };
217
232
 
218
- export type { AuthFromEnvParams, AuthFromEnvReturn, CustomLoader, Dictionary, DictionaryContent, DictionaryEntry, DictionaryObject, DictionaryTranslationOptions, Entry, FlattenedDictionary, GTConfig, GTContextType, InlineTranslationOptions, InternalGTProviderProps, LocaleSelectorProps, LocalesDictionary, MFunctionType, MetaEntry as Metadata, RegionSelectorProps, RenderMethod, RenderVariable, RuntimeTranslationOptions, TFunctionType, TranslatedChildren, Translations, UseDetermineLocaleParams, UseDetermineLocaleReturn, UseRegionStateParams, UseRegionStateReturn, VariableProps, _Message, _Messages };
233
+ export type { AuthFromEnvParams, AuthFromEnvReturn, CustomLoader, Dictionary, DictionaryContent, DictionaryEntry, DictionaryObject, DictionaryTranslationOptions, Entry, FlattenedDictionary, GTConfig, GTContextType, InlineTranslationOptions, InternalGTProviderProps, LocaleSelectorProps, LocalesDictionary, MFunctionType, MetaEntry as Metadata, RegionSelectorProps, RenderMethod, RenderVariable, RuntimeTranslationOptions, TFunctionType, TranslatedChildren, Translations, UseDetermineLocaleParams, UseDetermineLocaleReturn, UseEnableI18nParams, UseEnableI18nReturn, UseRegionStateParams, UseRegionStateReturn, VariableProps, _Message, _Messages };
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AACjE,OAAO,EACL,UAAU,EACV,YAAY,EACZ,kBAAkB,EAClB,YAAY,EACZ,cAAc,EACd,aAAa,EACb,eAAe,EACf,mBAAmB,EACnB,SAAS,EACT,KAAK,EACL,4BAA4B,EAC5B,wBAAwB,EACxB,yBAAyB,EACzB,iBAAiB,EACjB,iBAAiB,EACjB,gBAAgB,EAChB,YAAY,EACZ,QAAQ,EACR,SAAS,EACV,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEpD,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AACrE,OAAO,EACL,wBAAwB,EACxB,wBAAwB,EACzB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EACL,oBAAoB,EACpB,oBAAoB,EACrB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAEtE,OAAO,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAC;AAElD,OAAO,EAAE,uBAAuB,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAEvE,OAAO,EACL,UAAU,EACV,eAAe,EACf,mBAAmB,EACnB,YAAY,EACZ,MAAM,EACN,KAAK,EACL,kBAAkB,EAClB,YAAY,EACZ,aAAa,EACb,4BAA4B,EAC5B,wBAAwB,EACxB,yBAAyB,EACzB,iBAAiB,EACjB,gBAAgB,EAChB,iBAAiB,EACjB,YAAY,EACZ,cAAc,EACd,aAAa,EACb,SAAS,IAAI,QAAQ,EACrB,QAAQ,EACR,SAAS,EACT,aAAa,EACb,aAAa,EACb,mBAAmB,EACnB,mBAAmB,EACnB,uBAAuB,EACvB,iBAAiB,EACjB,iBAAiB,EACjB,wBAAwB,EACxB,wBAAwB,EACxB,oBAAoB,EACpB,oBAAoB,EACpB,QAAQ,GACT,CAAC"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AACjE,OAAO,EACL,UAAU,EACV,YAAY,EACZ,kBAAkB,EAClB,YAAY,EACZ,cAAc,EACd,aAAa,EACb,eAAe,EACf,mBAAmB,EACnB,SAAS,EACT,KAAK,EACL,4BAA4B,EAC5B,wBAAwB,EACxB,yBAAyB,EACzB,iBAAiB,EACjB,iBAAiB,EACjB,gBAAgB,EAChB,YAAY,EACZ,QAAQ,EACR,SAAS,EACV,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEpD,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AACrE,OAAO,EACL,wBAAwB,EACxB,wBAAwB,EACzB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EACL,oBAAoB,EACpB,oBAAoB,EACpB,mBAAmB,EACnB,mBAAmB,EACpB,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAEtE,OAAO,EAAE,MAAM,EAAE,MAAM,0BAA0B,CAAC;AAElD,OAAO,EAAE,uBAAuB,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAEvE,OAAO,EACL,UAAU,EACV,eAAe,EACf,mBAAmB,EACnB,YAAY,EACZ,MAAM,EACN,KAAK,EACL,kBAAkB,EAClB,YAAY,EACZ,aAAa,EACb,4BAA4B,EAC5B,wBAAwB,EACxB,yBAAyB,EACzB,iBAAiB,EACjB,gBAAgB,EAChB,iBAAiB,EACjB,YAAY,EACZ,cAAc,EACd,aAAa,EACb,SAAS,IAAI,QAAQ,EACrB,QAAQ,EACR,SAAS,EACT,aAAa,EACb,aAAa,EACb,mBAAmB,EACnB,mBAAmB,EACnB,uBAAuB,EACvB,iBAAiB,EACjB,iBAAiB,EACjB,wBAAwB,EACxB,wBAAwB,EACxB,oBAAoB,EACpB,oBAAoB,EACpB,mBAAmB,EACnB,mBAAmB,EACnB,QAAQ,GACT,CAAC"}
@@ -6,4 +6,9 @@ export declare const defaultLocaleCookieName = "generaltranslation.locale";
6
6
  * Cookie name for tracking the user's selected region
7
7
  */
8
8
  export declare const defaultRegionCookieName = "generaltranslation.region";
9
+ /**
10
+ * Cookie name for persisting the enableI18n feature flag
11
+ * "true" or "false"
12
+ */
13
+ export declare const defaultEnableI18nCookieName = "generaltranslation.enable-i18n";
9
14
  //# sourceMappingURL=cookies.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"cookies.d.ts","sourceRoot":"","sources":["../../src/utils/cookies.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,uBAAuB,8BAA8B,CAAC;AACnE;;GAEG;AACH,eAAO,MAAM,uBAAuB,8BAA8B,CAAC"}
1
+ {"version":3,"file":"cookies.d.ts","sourceRoot":"","sources":["../../src/utils/cookies.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,uBAAuB,8BAA8B,CAAC;AACnE;;GAEG;AACH,eAAO,MAAM,uBAAuB,8BAA8B,CAAC;AACnE;;;GAGG;AACH,eAAO,MAAM,2BAA2B,mCAAmC,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@generaltranslation/react-core",
3
- "version": "1.1.1",
3
+ "version": "1.2.0",
4
4
  "description": "A pure React library for internationalization",
5
5
  "main": "./dist/index.cjs.min.cjs",
6
6
  "module": "./dist/index.esm.min.mjs",