gt-react 9.0.10-alpha.2 → 9.0.10-alpha.4

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.
Files changed (33) hide show
  1. package/dist/client.cjs.min.cjs +3 -3
  2. package/dist/client.d.ts +10 -30
  3. package/dist/client.d.ts.map +1 -1
  4. package/dist/client.esm.min.mjs +3 -3
  5. package/dist/index.cjs.min.cjs +3 -3
  6. package/dist/index.d.ts +1 -2
  7. package/dist/index.d.ts.map +1 -1
  8. package/dist/index.esm.min.mjs +3 -3
  9. package/dist/inline/T.d.ts.map +1 -1
  10. package/dist/internal.cjs.min.cjs +1 -1
  11. package/dist/internal.d.ts +2 -3
  12. package/dist/internal.d.ts.map +1 -1
  13. package/dist/internal.esm.min.mjs +1 -1
  14. package/dist/provider/ClientProvider.d.ts +1 -1
  15. package/dist/provider/ClientProvider.d.ts.map +1 -1
  16. package/dist/provider/GTProvider.d.ts +1 -2
  17. package/dist/provider/GTProvider.d.ts.map +1 -1
  18. package/dist/provider/helpers/{extractEntryMetadata.d.ts → getEntryAndMetadata.d.ts} +2 -2
  19. package/dist/provider/helpers/getEntryAndMetadata.d.ts.map +1 -0
  20. package/dist/provider/rendering/defaultRenderSettings.d.ts +1 -1
  21. package/dist/provider/rendering/defaultRenderSettings.d.ts.map +1 -1
  22. package/dist/provider/runtime/useRuntimeTranslation.d.ts +3 -3
  23. package/dist/provider/runtime/useRuntimeTranslation.d.ts.map +1 -1
  24. package/dist/types/types.d.ts +4 -6
  25. package/dist/types/types.d.ts.map +1 -1
  26. package/dist/utils/fetchTranslations.d.ts +6 -1
  27. package/dist/utils/fetchTranslations.d.ts.map +1 -1
  28. package/dist/utils/utils.d.ts +1 -3
  29. package/dist/utils/utils.d.ts.map +1 -1
  30. package/package.json +2 -2
  31. package/dist/hooks/useElement.d.ts +0 -18
  32. package/dist/hooks/useElement.d.ts.map +0 -1
  33. package/dist/provider/helpers/extractEntryMetadata.d.ts.map +0 -1
package/dist/client.d.ts CHANGED
@@ -87,8 +87,9 @@ type TranslateChildrenCallback = (params: {
87
87
  }) => Promise<void>;
88
88
  type GTContextType = {
89
89
  translateDictionaryEntry: (id: string, options?: Record<string, any>) => React__default.ReactNode;
90
- translateContent: TranslateContentCallback;
91
- translateChildren: TranslateChildrenCallback;
90
+ registerContentForTranslation: TranslateContentCallback;
91
+ registerJsxForTranslation: TranslateChildrenCallback;
92
+ developmentTranslationEnabled: boolean;
92
93
  locale: string;
93
94
  locales: string[];
94
95
  setLocale: (locale: string) => void;
@@ -101,8 +102,6 @@ type GTContextType = {
101
102
  timeout?: number;
102
103
  };
103
104
  projectId?: string;
104
- translationEnabled: boolean;
105
- runtimeTranslationEnabled: boolean;
106
105
  };
107
106
  type ClientProviderProps = {
108
107
  children: any;
@@ -121,8 +120,7 @@ type ClientProviderProps = {
121
120
  method: RenderMethod;
122
121
  timeout?: number;
123
122
  };
124
- translationEnabled: boolean;
125
- runtimeTranslationEnabled: boolean;
123
+ developmentTranslationEnabled: boolean;
126
124
  projectId?: string;
127
125
  devApiKey?: string;
128
126
  runtimeUrl?: string | null;
@@ -132,7 +130,7 @@ type ClientProviderProps = {
132
130
 
133
131
  declare const GTContext: React$1.Context<GTContextType | undefined>;
134
132
 
135
- declare function useRuntimeTranslation({ projectId, devApiKey, locale, versionId, defaultLocale, runtimeUrl, renderSettings, setTranslations, runtimeTranslationEnabled, ...metadata }: {
133
+ declare function useRuntimeTranslation({ projectId, devApiKey, locale, versionId, defaultLocale, runtimeUrl, renderSettings, setTranslations, runtimeTranslationEnabled, ...globalMetadata }: {
136
134
  projectId?: string;
137
135
  devApiKey?: string;
138
136
  locale: string;
@@ -147,8 +145,8 @@ declare function useRuntimeTranslation({ projectId, devApiKey, locale, versionId
147
145
  setTranslations: React.Dispatch<React.SetStateAction<any>>;
148
146
  [key: string]: any;
149
147
  }): {
150
- translateContent: TranslateContentCallback;
151
- translateChildren: TranslateChildrenCallback;
148
+ registerContentForTranslation: TranslateContentCallback;
149
+ registerJsxForTranslation: TranslateChildrenCallback;
152
150
  };
153
151
 
154
152
  declare function renderVariable({ variableType, variableName, variableValue, variableOptions, locales, }: {
@@ -159,7 +157,7 @@ declare function renderVariable({ variableType, variableName, variableValue, var
159
157
  locales: string[];
160
158
  }): React.JSX.Element;
161
159
 
162
- declare function ClientProvider({ children, dictionary, initialTranslations, translationPromises, locale: _locale, _versionId, dictionaryEnabled, defaultLocale, translationRequired, dialectTranslationRequired, locales, requiredPrefix, renderSettings, projectId, devApiKey, runtimeUrl, translationEnabled, runtimeTranslationEnabled, onLocaleChange, cookieName, }: ClientProviderProps): React__default.JSX.Element;
160
+ declare function ClientProvider({ children, dictionary, initialTranslations, translationPromises, locale: _locale, _versionId, defaultLocale, translationRequired, dialectTranslationRequired, locales, requiredPrefix, renderSettings, projectId, devApiKey, runtimeUrl, developmentTranslationEnabled, onLocaleChange, cookieName, }: ClientProviderProps): React__default.JSX.Element;
163
161
 
164
162
  /**
165
163
  * The `<Branch>` component dynamically renders a specified branch of content or a fallback child component.
@@ -237,23 +235,6 @@ declare namespace Plural {
237
235
  */
238
236
  declare function useDefaultLocale(): string;
239
237
 
240
- /**
241
- * `useElement()` hook which gets the translation function `t()` provided by `<GTProvider>`.
242
- *
243
- * **`t()` returns only JSX elements.** For returning strings as well, see `useGT()`.
244
- *
245
- * @param {string} [id] - Optional prefix to prepend to the translation keys.
246
- * @returns {Function} A translation function that accepts a key string and returns the translated value.
247
- *
248
- * @example
249
- * const t = useElement('user');
250
- * console.log(t('name')); // Translates item 'user.name', returns it as a JSX element
251
- *
252
- * const t = useElement();
253
- * console.log(t('hello')); // Translates item 'hello', returns it as a JSX element
254
- */
255
- declare function useElement(id?: string): (id: string, options?: Record<string, any>) => React__default.JSX.Element;
256
-
257
238
  /**
258
239
  * Gets the translation function `t` provided by `<GTProvider>`.
259
240
  *
@@ -491,7 +472,7 @@ declare function LocaleSelector({ locales, }: {
491
472
  * @param {string[]} [locales] - The list of approved locales for the project.
492
473
  * @param {string} [defaultLocale=libraryDefaultLocale] - The default locale to use if no other locale is found.
493
474
  * @param {string} [locale] - The current locale, if already set.
494
- * @param {string} [cacheUrl='https://cache.gtx.dev'] - The URL of the cache service for fetching translations.
475
+ * @param {string} [cacheUrl='https://cdn.gtx.dev'] - The URL of the cache service for fetching translations.
495
476
  * @param {string} [runtimeUrl='https://runtime.gtx.dev'] - The URL of the runtime service for fetching translations.
496
477
  * @param {RenderSettings} [renderSettings=defaultRenderSettings] - The settings for rendering translations.
497
478
  * @param {string} [_versionId] - The version ID for fetching translations.
@@ -514,10 +495,9 @@ declare function GTProvider({ children, projectId: _projectId, devApiKey: _devAp
514
495
  method: RenderMethod;
515
496
  timeout?: number;
516
497
  };
517
- enableCache?: boolean;
518
498
  loadTranslation?: (locale: string) => Promise<any>;
519
499
  _versionId?: string;
520
500
  [key: string]: any;
521
501
  }): React__default.JSX.Element;
522
502
 
523
- export { Branch, ClientProvider, Currency, DateTime, GTContext, GTProvider, LocaleSelector, Num, Plural, T, Var, renderVariable, useDefaultLocale, useElement, useGT, useLocale, useRuntimeTranslation };
503
+ export { Branch, ClientProvider, Currency, DateTime, GTContext, GTProvider, LocaleSelector, Num, Plural, T, Var, renderVariable, useDefaultLocale, useGT, useLocale, useRuntimeTranslation };
@@ -1 +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,0CAA0C,CAAC;AAC7E,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,gBAAgB,MAAM,0BAA0B,CAAC;AACxD,OAAO,UAAU,MAAM,oBAAoB,CAAC;AAC5C,OAAO,KAAK,MAAM,eAAe,CAAC;AAClC,OAAO,SAAS,MAAM,mBAAmB,CAAC;AAC1C,OAAO,CAAC,MAAM,YAAY,CAAC;AAC3B,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,EACL,SAAS,EACT,UAAU,EACV,qBAAqB,EACrB,cAAc,EACd,cAAc,EACd,KAAK,EACL,UAAU,EACV,gBAAgB,EAChB,SAAS,EACT,CAAC,EACD,GAAG,EACH,GAAG,EACH,QAAQ,EACR,QAAQ,EACR,MAAM,EACN,MAAM,EACN,cAAc,GACf,CAAC"}
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,0CAA0C,CAAC;AAC7E,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,gBAAgB,MAAM,0BAA0B,CAAC;AACxD,OAAO,KAAK,MAAM,eAAe,CAAC;AAClC,OAAO,SAAS,MAAM,mBAAmB,CAAC;AAC1C,OAAO,CAAC,MAAM,YAAY,CAAC;AAC3B,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,EACL,SAAS,EACT,UAAU,EACV,qBAAqB,EACrB,cAAc,EACd,cAAc,EACd,KAAK,EACL,gBAAgB,EAChB,SAAS,EACT,CAAC,EACD,GAAG,EACH,GAAG,EACH,QAAQ,EACR,QAAQ,EACR,MAAM,EACN,MAAM,EACN,cAAc,GACf,CAAC"}