gt-react 9.1.0 → 9.2.0-alpha.0

package/dist/client.d.ts

@@ -69,6 +69,13 @@ type TranslationsObject = {
     [key: string]: TranslationSuccess | TranslationLoading | TranslationError;
 };
 type RenderMethod = 'skeleton' | 'replace' | 'default';
+type TranslationOptions = {
+    context?: string;
+    variables?: Record<string, any>;
+    variableOptions?: Record<string, Intl.NumberFormatOptions | Intl.DateTimeFormatOptions>;
+    [key: string]: any;
+};
+
 type TranslateContentCallback = (params: {
     source: any;
     targetLocale: string;
@@ -76,7 +83,7 @@ type TranslateContentCallback = (params: {
         hash: string;
         context?: string;
     } & Record<string, any>;
-}) => Promise<void>;
+}) => Promise<TranslationSuccess | TranslationLoading | TranslationError>;
 type TranslateChildrenCallback = (params: {
     source: any;
     targetLocale: string;
@@ -84,12 +91,14 @@ type TranslateChildrenCallback = (params: {
         hash: string;
         context?: string;
     } & Record<string, any>;
-}) => Promise<void>;
+}) => Promise<TranslationSuccess | TranslationLoading | TranslationError>;
+
 type GTContextType = {
-    translateDictionaryEntry: (id: string, options?: Record<string, any>) => React__default.ReactNode;
     registerContentForTranslation: TranslateContentCallback;
     registerJsxForTranslation: TranslateChildrenCallback;
-    developmentTranslationEnabled: boolean;
+    translateContent: (content: string, options: TranslationOptions) => string;
+    getDictionaryEntryTranslation: (id: string, options?: TranslationOptions) => React.ReactNode;
+    runtimeTranslationEnabled: boolean;
     locale: string;
     locales: string[];
     setLocale: (locale: string) => void;
@@ -120,7 +129,7 @@ type ClientProviderProps = {
         method: RenderMethod;
         timeout?: number;
     };
-    developmentTranslationEnabled: boolean;
+    runtimeTranslationEnabled: boolean;
     projectId?: string;
     devApiKey?: string;
     runtimeUrl?: string | null;
@@ -157,7 +166,7 @@ declare function renderVariable({ variableType, variableName, variableValue, var
     locales: string[];
 }): React.JSX.Element;
 
-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;
+declare function ClientProvider({ children, dictionary, initialTranslations, translationPromises, locale: _locale, _versionId, defaultLocale, translationRequired, dialectTranslationRequired, locales, requiredPrefix, renderSettings, projectId, devApiKey, runtimeUrl, runtimeTranslationEnabled, onLocaleChange, cookieName, }: ClientProviderProps): React__default.JSX.Element;
 
 /**
  * The `<Branch>` component dynamically renders a specified branch of content or a fallback child component.
@@ -222,6 +231,25 @@ declare namespace Plural {
     var gtTransformation: string;
 }
 
+/**
+ * Gets the translation function `t` provided by `<GTProvider>`.
+ *
+ * @returns {Function} A translation function that accepts a key string and returns the translated value.
+ *
+ * @example
+ * const t = useGT();
+ * console.log(t('To be or not to be...'));
+ *
+ * const t = useGT();
+ * return (<>
+ *  {
+ *     t('My name is {customName}', { variables: { customName: "Brian" } } )
+ *  }
+ * </>);
+ *
+ */
+declare function useGT(): (content?: string, options?: TranslationOptions) => string;
+
 /**
  * Retrieves the application's default locale from the `<GTProvider>` context.
  *
@@ -236,19 +264,19 @@ declare namespace Plural {
 declare function useDefaultLocale(): string;
 
 /**
- * Gets the translation function `t` provided by `<GTProvider>`.
+ * Gets the dictionary access function `d` provided by `<GTProvider>`.
  *
  * @param {string} [id] - Optional prefix to prepend to the translation keys.
  * @returns {Function} A translation function that accepts a key string and returns the translated value.
  *
  * @example
- * const t = useGT('user');
- * console.log(t('name')); // Translates item 'user.name'
+ * const d = useDict('user');
+ * console.log(d('name')); // Translates item 'user.name'
  *
- * const t = useGT();
- * console.log(t('hello')); // Translates item 'hello'
+ * const d = useDict();
+ * console.log(d('hello')); // Translates item 'hello'
  */
-declare function useGT(id?: string): (id: string, options?: Record<string, any>) => React__default.ReactNode;
+declare function useDict(id?: string): (id: string, options?: TranslationOptions) => React__default.ReactNode;
 
 /**
  * Retrieves the user's locale from the `<GTProvider>` context.
@@ -500,4 +528,4 @@ declare function GTProvider({ children, projectId: _projectId, devApiKey: _devAp
     [key: string]: any;
 }): React__default.JSX.Element;
 
-export { Branch, ClientProvider, Currency, DateTime, GTContext, GTProvider, LocaleSelector, Num, Plural, T, Var, renderVariable, useDefaultLocale, useGT, useLocale, useRuntimeTranslation };
+export { Branch, ClientProvider, Currency, DateTime, GTContext, GTProvider, LocaleSelector, Num, Plural, T, Var, renderVariable, useDefaultLocale, useDict, useGT, useLocale, useRuntimeTranslation };

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,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"}
+{"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,EACL,SAAS,EACT,UAAU,EACV,qBAAqB,EACrB,cAAc,EACd,cAAc,EACd,KAAK,EACL,OAAO,EACP,gBAAgB,EAChB,SAAS,EACT,CAAC,EACD,GAAG,EACH,GAAG,EACH,QAAQ,EACR,QAAQ,EACR,MAAM,EACN,MAAM,EACN,cAAc,GACf,CAAC"}