gt-react 9.2.27 → 9.2.29-alpha.0

package/dist/client.d.ts

@@ -1,7 +1,7 @@
 import * as React$1 from 'react';
 import React__default from 'react';
-import * as generaltranslation from 'generaltranslation';
-import { GT } from 'generaltranslation';
+import * as GT from 'generaltranslation';
+import GT__default from 'generaltranslation';
 import * as generaltranslation_types from 'generaltranslation/types';
 import { CustomMapping } from 'generaltranslation/types';
 import * as react_jsx_runtime from 'react/jsx-runtime';
@@ -87,7 +87,7 @@ type TranslateChildrenCallback = (params: {
 }) => Promise<TranslationSuccess | TranslationLoading | TranslationError>;
 
 type GTContextType = {
-    gt: GT;
+    gt: GT__default;
     registerContentForTranslation: TranslateContentCallback;
     registerJsxForTranslation: TranslateChildrenCallback;
     _internalUseGTFunction: (string: string, options?: InlineTranslationOptions) => string;
@@ -252,7 +252,7 @@ declare namespace Branch {
  *
  * @param {any} [children] - Fallback content to render if no matching plural branch is found.
  * @param {number} [n] - The number used to determine the plural form. This is required for pluralization to work.
- * @param {string} [locale] - Optional parameter, the locale to use for pluralization format. If not provided and wrapped
+ * @param {string} [locales] - Optional parameter, the locale to use for pluralization format. If not provided and wrapped
  *  in <GTProvider> will automatically populate this value as user's current locale. If not provided and not wrapped in
  *  <GTProvider>, will use the library default locale (en-US).
  * @param {...{[key: string]: any}} [branches] - A spread object containing possible plural branches, typically including `one` for singular
@@ -260,10 +260,10 @@ declare namespace Branch {
  * @returns {React.JSX.Element} The rendered content corresponding to the plural form of `n`, or the fallback content.
  * @throws {Error} If `n` is not provided or not a valid number.
  */
-declare function Plural({ children, n, locale, ...branches }: {
-    children?: any;
+declare function Plural({ children, n, locales, ...branches }: {
+    children?: React.ReactNode;
     n?: number;
-    locale?: string;
+    locales?: string;
     [key: string]: any;
 }): React.JSX.Element;
 declare namespace Plural {
@@ -378,14 +378,14 @@ declare namespace T {
  * </Currency>
  * ```
  *
- * @param {any} [children] - Optional content to render inside the currency component.
- * @param {string} [currency] - The currency type (e.g., USD, EUR, etc.).
- * @param {string[]} [locales] - Optional locales to use for currency formatting. If not provided, the library default locale (en-US) is used. If wrapped in a `<GTProvider>`, the user's locale is used.
- * @param {Intl.NumberFormatOptions} [options] - Optional formatting options to customize how the currency is displayed.
+ * @param {number | string} children - Content to render inside the currency component.
+ * @param {string} [currency="USD"] - The currency type (e.g., USD, EUR, etc.).
+ * @param {string[]} [locales] - Optional locales to use for currency formatting. If wrapped in a `<GTProvider>`, the user's locale is used.
+ * @param {Intl.NumberFormatOptions} [options={}] - Optional formatting options to customize how the currency is displayed.
  * @returns {JSX.Element} The formatted currency component.
  */
-declare function Currency({ children, currency, name, locales, options, }: {
-    children?: any;
+declare function Currency({ children, currency, locales, options, }: {
+    children: number | string;
     currency?: string;
     name?: string;
     locales?: string[];
@@ -407,13 +407,13 @@ declare namespace Currency {
  * </DateTime>
  * ```
  *
- * @param {any} [children] - Optional content (typically a date) to render inside the component.
- * @param {string[]} [locales] - Optional locales to use for date formatting. If not provided, the library default locale (en-US) is used. If wrapped in a `<GTProvider>`, the user's locale is used.
+ * @param {Date} children - Content to render inside the date component.
+ * @param {string[]} [locales] - Optional locales to use for date formatting. If wrapped in a `<GTProvider>`, the user's locale is used.
  * @param {Intl.DateTimeFormatOptions} [options={}] - Optional formatting options for the date, following `Intl.DateTimeFormatOptions` specifications.
  * @returns {JSX.Element} The formatted date or time component.
  */
-declare function DateTime({ children, locales, name, options, }: {
-    children?: any;
+declare function DateTime({ children, locales, options, }: {
+    children: Date;
     locales?: string[];
     name?: string;
     options?: Intl.DateTimeFormatOptions;
@@ -436,12 +436,13 @@ declare namespace DateTime {
  * </Num>
  * ```
  *
- * @param {any} [children] - Optional content (typically a number) to render inside the component.
+ * @param {number | string} children - Content to render inside the number component.
+ * @param {string[]} [locales] - Optional locales to use for number formatting. If wrapped in a `<GTProvider>`, the user's locale is used.
  * @param {Intl.NumberFormatOptions} [options={}] - Optional formatting options for the number, following `Intl.NumberFormatOptions` specifications.
  * @returns {JSX.Element} The formatted number component.
  */
-declare function Num({ children, name, locales, options, }: {
-    children?: any;
+declare function Num({ children, locales, options, }: {
+    children: number | string;
     locales?: string[];
     options?: Intl.NumberFormatOptions;
     name?: string;
@@ -561,7 +562,7 @@ declare function useLocaleSelector(locales?: string[]): {
  * const gt = useGTClass();
  * console.log(gt.getLocaleProperties('en-US'));
  */
-declare function useGTClass(): generaltranslation.GT;
+declare function useGTClass(): GT.default;
 /**
  * Returns the locale properties for the given locale.
  *