gt-react 2.0.210 → 3.0.0

package/dist/types/CreateI18NConfigProps.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CreateI18NConfigProps.js","sourceRoot":"","sources":["../../src/types/CreateI18NConfigProps.ts"],"names":[],"mappings":";;AAsBA,kBAAe,qBAAqB,CAAC"}

package/dist/types/GTInterface.d.ts

@@ -0,0 +1,29 @@
+export default interface GTInterface {
+    /** React component for internationalization */
+    I18N: React.ComponentType<any>;
+    /** Internationalization function */
+    intl: (key: string, options?: Record<string, any>) => Promise<string>;
+    /** Provider component for GlobalThis */
+    GTProvider: React.ComponentType<any>;
+    /** Translation function */
+    t: (key: string, options?: Record<string, any>) => any;
+    /** Dictionary function */
+    dict: (key: string) => any;
+    /** Component for rendering localized values */
+    Value: React.ComponentType<any>;
+    /** Component for rendering localized numeric values */
+    Numeric: React.ComponentType<any>;
+    /** Component for rendering variables */
+    Variable: React.ComponentType<any>;
+    /** Component for rendering number variables */
+    NumberVariable: React.ComponentType<any>;
+    /** Component for rendering date variables */
+    DateVariable: React.ComponentType<any>;
+    /** Component for rendering currency variables */
+    CurrencyVariable: React.ComponentType<any>;
+    /** Function to get the current locale */
+    getLocale: () => string;
+    /** Function to get the default locale */
+    getDefaultLocale: () => string;
+}
+//# sourceMappingURL=GTInterface.d.ts.map

package/dist/types/GTInterface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GTInterface.d.ts","sourceRoot":"","sources":["../../src/types/GTInterface.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,OAAO,WAAW,WAAW;IAEhC,+CAA+C;IAC/C,IAAI,EAAE,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IAE/B,oCAAoC;IACpC,IAAI,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IAEtE,wCAAwC;IACxC,UAAU,EAAE,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IAErC,2BAA2B;IAC3B,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,GAAG,CAAC;IAEvD,0BAA0B;IAC1B,IAAI,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,GAAG,CAAC;IAE3B,+CAA+C;IAC/C,KAAK,EAAE,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IAEhC,uDAAuD;IACvD,OAAO,EAAE,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IAElC,wCAAwC;IACxC,QAAQ,EAAE,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IAEnC,+CAA+C;IAC/C,cAAc,EAAE,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IAEzC,6CAA6C;IAC7C,YAAY,EAAE,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IAEvC,iDAAiD;IACjD,gBAAgB,EAAE,KAAK,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IAE3C,yCAAyC;IACzC,SAAS,EAAE,MAAM,MAAM,CAAC;IAExB,yCAAyC;IACzC,gBAAgB,EAAE,MAAM,MAAM,CAAC;CAElC"}

package/dist/types/GTInterface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=GTInterface.js.map

package/dist/types/GTInterface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GTInterface.js","sourceRoot":"","sources":["../../src/types/GTInterface.ts"],"names":[],"mappings":""}

package/dist/types/GeneralTranslationInterface.d.ts

@@ -0,0 +1,179 @@
+import { ComponentType } from 'react';
+export default interface GeneralTranslation {
+    /**
+    * The `<I18N>` component. Translates its ReactNode children into the user's locale.
+    *
+    * `children?` - (any) - Children to translate.
+    *
+    * `id?` - (string) - Specifies an ID in the target dictionary for the created translation. Used to prevent storing unnecessary translations by overwriting previous translations with the same ID. Defaults to a hash of the component's children.
+    *
+    * `...props` - ([key: string]: any) - Optional metadata which will override the global `gt-react` configuration. See https://docs.generaltranslation.com for a full list of possible props.
+    */
+    I18N: ComponentType<{
+        children?: any;
+        id?: string;
+        [key: string]: any;
+    }>;
+    /**
+    * Translates a string asynchronously, storing the result in the translation dictionary.
+    *
+    * `content` - (string) - Text content to translate into the user's language.
+    *
+    * `options?` - ({ [key: string]: any }) - Other parameters. See https://docs.generaltranslation.com for a full list.
+    *
+    * `options.targetLanguage?` - (string) - A BCP 47 language tag which represents the language to translate into. Defaults to the user's locale.
+    *
+    * `options.id?` - (string) - Specifies an ID in the target dictionary for the created translation. Used to prevent storing unnecessary translations by overwriting previous translations with the same ID. Defaults to `content`. (string)
+    */
+    intl: (content: string, options?: {
+        targetLanguage?: string;
+        id?: string;
+        [key: string]: any;
+    }) => Promise<string>;
+    /**
+    * The `<GTProvider>` component. Used on the server, but all children must be client components (or able to run on the client). Provides translations and locale data to its children using React's context API. Children are able to use the `useGT`, `useLocale`, and `useDefaultLocale` hooks.
+    *
+    * If `id` or `dictionary` components are not provided, translations of all entries in the default `createGT` dictionary are provided.
+    *
+    * These translations can be accessed on the client using the `useGT` hook.
+    *
+    * `children?` - (any) - Children to which context is provided.
+    *
+    * `id?` - (string) - If provided, only the items in the initial dictionary which fall under that ID will be provided to the client, alongside any additional items in the `dictionary` prop. Any new translations created by this component will be assigned (`id + '.'`) as a prefix.
+    *
+    * `dictionary?` - (Record<string, any>) - Object representing a dictionary, where keys are strings and the values are strings or React children, which are translated and sent to the client. Advanced: dictionary entries can also be arbitrary promises which are resolved and provided the client.
+    *
+    * `...props` - ([key: string]: any) - Optional metadata which will override the global `gt-react` configuration. See https://docs.generaltranslation.com for a full list of possible props.
+    */
+    GTProvider: ComponentType<{
+        children?: any;
+        id?: string;
+        dictionary?: Record<string, any>;
+        [key: string]: any;
+    }>;
+    /**
+    * Server-side function which gets an entry from the default dictionary and wraps it in the `<I18N>` component.
+    *
+    * `id` - (string) - ID of the item in the dictionary.
+    *
+    * `options?` - ({ [key: string]: any }) - Other parameters which override the global `gt-react` configuration. See https://docs.generaltranslation.com for a full list.
+    */
+    t: (id: string, options?: Record<string, any>) => any;
+    /**
+    * Server-side function which gets an entry from the default dictionary, in its original language.
+    *
+    * `id` - (string) - ID of the item in the dictionary.
+    */
+    dict: (id: string) => any;
+    /**
+     * Component for rendering localized values.
+     *
+     * `children?` - (any) - The default content to render if no conditions are met.
+     *
+     * `branches?` - (Record<string, any>) - An object containing conditional branches to render. Keys represent condition names, and values are the corresponding content.
+     *
+     * `values?` - (Record<string, any>) - A set of values used for conditional rendering.
+     */
+    Value: ComponentType<{
+        children?: any;
+        branches?: Record<string, any>;
+        values?: Record<string, any>;
+    }>;
+    /**
+     * Component for rendering localized numeric values.
+     *
+     * `children?` - (any) - The default content to render if no numeric conditions are met.
+     *
+     * `n` - (number) - The number to evaluate against defined ranges or conditions.
+     *
+     * `ranges?` - ({ min: number, max: number, children: any }[]) - An array of range objects for determining which branch to render based on the number `n`.
+    **/
+    Numeric: ComponentType<{
+        children?: any;
+        n: number;
+        ranges?: {
+            min: number;
+            max: number;
+            children: any;
+        }[];
+    }>;
+    /**
+     * Component for rendering variables.
+     *
+     * `children?` - (any) - The content to render if provided. Overrides `defaultValue`.
+     *
+     * `name?` - (string) - The name of the variable, used for identifying the component.
+     *
+     * `defaultValue?` - (any) - The default value to display if `children` is not provided.
+    **/
+    Variable: ComponentType<{
+        children?: any;
+        name?: string;
+        defaultValue?: any;
+    }>;
+    /**
+     * Component for rendering number variables.
+     *
+     * `children?` - (any) - The content to render if provided. Overrides `defaultValue`.
+     *
+     * `name?` - (string) - The name of the variable, used for identifying the component.
+     *
+     * `defaultValue?` - (any) - The default value to display if `children` is not provided. This can be a number or a string representation of a number.
+     *
+     * `options?` - (Record<string, any>) - Additional options for `Intl.NumberFormat` for formatting the number.
+    **/
+    NumberVariable: ComponentType<{
+        children?: any;
+        name?: string;
+        defaultValue?: any;
+        options?: Record<string, any>;
+    }>;
+    /**
+     * Component for rendering date variables.
+     *
+     * `children?` - (any) - The content to render if provided. Overrides `defaultValue`.
+     *
+     * `name?` - (string) - The name of the variable, used for identifying the component.
+     *
+     * `defaultValue?` - (any) - The default value to display if `children` is not provided. This can be a number (Unix timestamp), string, or Date object.
+     *
+     * `options?` - (Record<string, any>) - Additional options for `Intl.DateTimeFormat` for formatting the date.
+    **/
+    DateVariable: ComponentType<{
+        children?: any;
+        name?: string;
+        defaultValue?: any;
+        options?: Record<string, any>;
+    }>;
+    /**
+     * Component for rendering currency variables.
+     *
+     * `children?` - (any) - The content to render if provided. Overrides `defaultValue`.
+     *
+     * `name?` - (string) - The name of the variable, used for identifying the component.
+     *
+     * `defaultValue?` - (any) - The default value to display if `children` is not provided. This should be a number or a string representation of a number.
+     *
+     * `currency?` - (string) - The currency code to use for formatting. Defaults to "USD".
+     *
+     * `options?` - (Record<string, any>) - Additional options for `Intl.NumberFormat` for formatting the currency.
+    **/
+    CurrencyVariable: ComponentType<{
+        children?: any;
+        name?: string;
+        defaultValue?: any;
+        currency?: string;
+        options?: Record<string, any>;
+    }>;
+    /**
+    * Server-side function which gets the user's current locale.
+    * Returns a BCP 47 language code representing the user's language, e.g. `en-US`.
+    **/
+    getLocale: () => string;
+    /**
+     * Server-side function which gets the application's default locale.
+     * Returns a BCP 47 language code representing a language, e.g. `en-US`.
+    **/
+    getDefaultLocale: () => string;
+}
+//# sourceMappingURL=GeneralTranslationInterface.d.ts.map

package/dist/types/GeneralTranslationInterface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"GeneralTranslationInterface.d.ts","sourceRoot":"","sources":["../../src/types/GeneralTranslationInterface.ts"],"names":[],"mappings":"AAAA,OAAc,EAAE,aAAa,EAAE,MAAM,OAAO,CAAA;AAE5C,MAAM,CAAC,OAAO,WAAW,kBAAkB;IAEvC;;;;;;;;MAQE;IACF,IAAI,EAAE,aAAa,CAAC;QAChB,QAAQ,CAAC,EAAE,GAAG,CAAC;QACf,EAAE,CAAC,EAAE,MAAM,CAAC;QACZ,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACtB,CAAC,CAAC;IAEH;;;;;;;;;;MAUE;IACF,IAAI,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAC9B,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,EAAE,CAAC,EAAE,MAAM,CAAC;QACZ,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KACrB,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IAEtB;;;;;;;;;;;;;;MAcE;IACF,UAAU,EAAE,aAAa,CAAC;QACtB,QAAQ,CAAC,EAAE,GAAG,CAAC;QACf,EAAE,CAAC,EAAE,MAAM,CAAC;QACZ,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QACjC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KACrB,CAAC,CAAC;IAEH;;;;;;MAME;IACF,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,GAAG,CAAC;IAEtD;;;;MAIE;IACF,IAAI,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,GAAG,CAAC;IAE1B;;;;;;;;OAQG;IACH,KAAK,EAAE,aAAa,CAAC;QACjB,QAAQ,CAAC,EAAE,GAAG,CAAC;QACf,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAC/B,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;KAChC,CAAC,CAAC;IAEH;;;;;;;;OAQG;IACH,OAAO,EAAE,aAAa,CAAC;QACnB,QAAQ,CAAC,EAAE,GAAG,CAAC;QACf,CAAC,EAAE,MAAM,CAAC;QACV,MAAM,CAAC,EAAE;YAAE,GAAG,EAAE,MAAM,CAAC;YAAC,GAAG,EAAE,MAAM,CAAC;YAAC,QAAQ,EAAE,GAAG,CAAA;SAAE,EAAE,CAAC;KAC1D,CAAC,CAAC;IAEH;;;;;;;;OAQG;IACH,QAAQ,EAAE,aAAa,CAAC;QACpB,QAAQ,CAAC,EAAE,GAAG,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,YAAY,CAAC,EAAE,GAAG,CAAC;KACtB,CAAC,CAAC;IAEH;;;;;;;;;;OAUG;IACH,cAAc,EAAE,aAAa,CAAC;QAC1B,QAAQ,CAAC,EAAE,GAAG,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,YAAY,CAAC,EAAE,GAAG,CAAC;QACnB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;KACjC,CAAC,CAAC;IAEH;;;;;;;;;;OAUG;IACH,YAAY,EAAE,aAAa,CAAC;QACxB,QAAQ,CAAC,EAAE,GAAG,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,YAAY,CAAC,EAAE,GAAG,CAAC;QACnB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;KACjC,CAAC,CAAC;IAEH;;;;;;;;;;;;OAYG;IACH,gBAAgB,EAAE,aAAa,CAAC;QAC5B,QAAQ,CAAC,EAAE,GAAG,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,YAAY,CAAC,EAAE,GAAG,CAAC;QACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;KACjC,CAAC,CAAC;IAGH;;;OAGG;IACH,SAAS,EAAE,MAAM,MAAM,CAAC;IAExB;;;OAGG;IACH,gBAAgB,EAAE,MAAM,MAAM,CAAC;CAElC"}

package/dist/types/GeneralTranslationInterface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=GeneralTranslationInterface.js.map

package/dist/types/GeneralTranslationInterface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GeneralTranslationInterface.js","sourceRoot":"","sources":["../../src/types/GeneralTranslationInterface.ts"],"names":[],"mappings":""}

package/dist/types/VariableInterface.d.ts

@@ -0,0 +1,100 @@
+import { ComponentType } from 'react';
+export default interface Variables {
+    /**
+     * Component for rendering localized values.
+     *
+     * `children?` - (any) - The default content to render if no conditions are met.
+     *
+     * `branches?` - (Record<string, any>) - An object containing conditional branches to render. Keys represent condition names, and values are the corresponding content.
+     *
+     * `values?` - (Record<string, any>) - A set of values used for conditional rendering.
+     */
+    Value: ComponentType<{
+        children?: any;
+        branches?: Record<string, any>;
+        values?: Record<string, any>;
+    }>;
+    /**
+     * Component for rendering localized numeric values.
+     *
+     * `children?` - (any) - The default content to render if no numeric conditions are met.
+     *
+     * `n` - (number) - The number to evaluate against defined ranges or conditions.
+     *
+     * `ranges?` - (Range[]) - An array of range objects for determining which branch to render based on the number `n`.
+     */
+    Numeric: ComponentType<{
+        children?: any;
+        n: number;
+        ranges?: Range[];
+    }>;
+    /**
+     * Component for rendering variables.
+     *
+     * `children?` - (any) - The content to render if provided. Overrides `defaultValue`.
+     *
+     * `name?` - (string) - The name of the variable, used for identifying the component.
+     *
+     * `defaultValue?` - (any) - The default value to display if `children` is not provided.
+     */
+    Variable: ComponentType<{
+        children?: any;
+        name?: string;
+        defaultValue?: any;
+    }>;
+    /**
+     * Component for rendering number variables.
+     *
+     * `children?` - (any) - The content to render if provided. Overrides `defaultValue`.
+     *
+     * `name?` - (string) - The name of the variable, used for identifying the component.
+     *
+     * `defaultValue?` - (any) - The default value to display if `children` is not provided. This can be a number or a string representation of a number.
+     *
+     * `options?` - (Record<string, any>) - Additional options for `Intl.NumberFormat` for formatting the number.
+     */
+    NumberVariable: ComponentType<{
+        children?: any;
+        name?: string;
+        defaultValue?: any;
+        options?: Record<string, any>;
+    }>;
+    /**
+     * Component for rendering date variables.
+     *
+     * `children?` - (any) - The content to render if provided. Overrides `defaultValue`.
+     *
+     * `name?` - (string) - The name of the variable, used for identifying the component.
+     *
+     * `defaultValue?` - (any) - The default value to display if `children` is not provided. This can be a number (Unix timestamp), string, or Date object.
+     *
+     * `options?` - (Record<string, any>) - Additional options for `Intl.DateTimeFormat` for formatting the date.
+     */
+    DateVariable: ComponentType<{
+        children?: any;
+        name?: string;
+        defaultValue?: any;
+        options?: Record<string, any>;
+    }>;
+    /**
+     * Component for rendering currency variables.
+     *
+     * `children?` - (any) - The content to render if provided. Overrides `defaultValue`.
+     *
+     * `name?` - (string) - The name of the variable, used for identifying the component.
+     *
+     * `defaultValue?` - (any) - The default value to display if `children` is not provided. This should be a number or a string representation of a number.
+     *
+     * `currency?` - (string) - The currency code to use for formatting. Defaults to "USD".
+     *
+     * `options?` - (Record<string, any>) - Additional options for `Intl.NumberFormat` for formatting the currency.
+     */
+    CurrencyVariable: ComponentType<{
+        children?: any;
+        name?: string;
+        defaultValue?: any;
+        currency?: string;
+        options?: Record<string, any>;
+    }>;
+}
+//# sourceMappingURL=VariableInterface.d.ts.map

package/dist/types/VariableInterface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"VariableInterface.d.ts","sourceRoot":"","sources":["../../src/types/VariableInterface.ts"],"names":[],"mappings":"AAAA,OAAc,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAE7C,MAAM,CAAC,OAAO,WAAW,SAAS;IAE9B;;;;;;;;OAQG;IACH,KAAK,EAAE,aAAa,CAAC;QACjB,QAAQ,CAAC,EAAE,GAAG,CAAC;QACf,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAC/B,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;KAChC,CAAC,CAAC;IAEH;;;;;;;;OAQG;IACH,OAAO,EAAE,aAAa,CAAC;QACnB,QAAQ,CAAC,EAAE,GAAG,CAAC;QACf,CAAC,EAAE,MAAM,CAAC;QACV,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC;KACpB,CAAC,CAAC;IAEH;;;;;;;;OAQG;IACH,QAAQ,EAAE,aAAa,CAAC;QACpB,QAAQ,CAAC,EAAE,GAAG,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,YAAY,CAAC,EAAE,GAAG,CAAC;KACtB,CAAC,CAAC;IAEH;;;;;;;;;;OAUG;IACH,cAAc,EAAE,aAAa,CAAC;QAC1B,QAAQ,CAAC,EAAE,GAAG,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,YAAY,CAAC,EAAE,GAAG,CAAC;QACnB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;KACjC,CAAC,CAAC;IAEH;;;;;;;;;;OAUG;IACH,YAAY,EAAE,aAAa,CAAC;QACxB,QAAQ,CAAC,EAAE,GAAG,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,YAAY,CAAC,EAAE,GAAG,CAAC;QACnB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;KACjC,CAAC,CAAC;IAEH;;;;;;;;;;;;OAYG;IACH,gBAAgB,EAAE,aAAa,CAAC;QAC5B,QAAQ,CAAC,EAAE,GAAG,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,YAAY,CAAC,EAAE,GAAG,CAAC;QACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;KACjC,CAAC,CAAC;CAEN"}

package/dist/types/VariableInterface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=VariableInterface.js.map

package/dist/types/VariableInterface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"VariableInterface.js","sourceRoot":"","sources":["../../src/types/VariableInterface.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gt-react",
-  "version": "2.0.210",
+  "version": "3.0.0",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -89,6 +89,6 @@
     "i18n"
   ],
   "dependencies": {
-    "generaltranslation": "^2.0.16"
+    "generaltranslation": "^2.0.17"
   }
 }

package/tsconfig.json

@@ -13,6 +13,8 @@
     "sourceMap": true,
     "declaration": true,
     "declarationMap": true,
+    "removeComments": false,
+    "allowSyntheticDefaultImports": true,
     "jsx": "react-jsx"
   },
   "include": ["src/**/*"],

package/dist/client/useDefaultLanguage.d.ts

@@ -1,2 +0,0 @@
-export default function useDefaultLanguage(): string;
-//# sourceMappingURL=useDefaultLanguage.d.ts.map

package/dist/client/useDefaultLanguage.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"useDefaultLanguage.d.ts","sourceRoot":"","sources":["../../src/client/useDefaultLanguage.ts"],"names":[],"mappings":"AAKA,MAAM,CAAC,OAAO,UAAU,kBAAkB,IAAI,MAAM,CAMnD"}

package/dist/client/useDefaultLanguage.js

@@ -1,14 +0,0 @@
-"use strict";
-'use client';
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = useDefaultLanguage;
-const react_1 = require("react");
-const ClientProvider_1 = require("./ClientProvider");
-function useDefaultLanguage() {
-    const ctx = (0, react_1.useContext)(ClientProvider_1.GTContext);
-    if (ctx === null || ctx === void 0 ? void 0 : ctx.defaultLanguage) {
-        return ctx.defaultLanguage;
-    }
-    return "";
-}
-//# sourceMappingURL=useDefaultLanguage.js.map

package/dist/client/useDefaultLanguage.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"useDefaultLanguage.js","sourceRoot":"","sources":["../../src/client/useDefaultLanguage.ts"],"names":[],"mappings":";AAAA,YAAY,CAAA;;AAKZ,qCAMC;AATD,iCAAmC;AACnC,qDAA6C;AAE7C,SAAwB,kBAAkB;IACtC,MAAM,GAAG,GAAG,IAAA,kBAAU,EAAC,0BAAS,CAAC,CAAC;IAClC,IAAI,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,eAAe,EAAE,CAAC;QACvB,OAAO,GAAG,CAAC,eAAe,CAAC;IAC/B,CAAC;IACD,OAAO,EAAE,CAAC;AACd,CAAC"}

package/dist/client/useGT.d.ts

@@ -1,2 +0,0 @@
-export default function useGT(): Function;
-//# sourceMappingURL=useGT.d.ts.map

package/dist/client/useGT.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"useGT.d.ts","sourceRoot":"","sources":["../../src/client/useGT.ts"],"names":[],"mappings":"AAKA,MAAM,CAAC,OAAO,UAAU,KAAK,IAAI,QAAQ,CAMxC"}

package/dist/client/useGT.js

@@ -1,14 +0,0 @@
-"use strict";
-'use client';
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = useGT;
-const react_1 = require("react");
-const ClientProvider_1 = require("./ClientProvider");
-function useGT() {
-    const ctx = (0, react_1.useContext)(ClientProvider_1.GTContext);
-    if (ctx === null || ctx === void 0 ? void 0 : ctx.translate) {
-        return (id) => ctx.translate(id);
-    }
-    return () => { };
-}
-//# sourceMappingURL=useGT.js.map

package/dist/client/useGT.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"useGT.js","sourceRoot":"","sources":["../../src/client/useGT.ts"],"names":[],"mappings":";AAAA,YAAY,CAAA;;AAKZ,wBAMC;AATD,iCAAmC;AACnC,qDAA6C;AAE7C,SAAwB,KAAK;IACzB,MAAM,GAAG,GAAG,IAAA,kBAAU,EAAC,0BAAS,CAAC,CAAC;IAClC,IAAI,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,SAAS,EAAE,CAAC;QACjB,OAAO,CAAC,EAAU,EAAE,EAAE,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;IAC7C,CAAC;IACD,OAAO,GAAG,EAAE,GAAE,CAAC,CAAC;AACpB,CAAC"}

package/dist/client/useUserLanguage.d.ts

@@ -1,2 +0,0 @@
-export default function useUserLanguage(): string;
-//# sourceMappingURL=useUserLanguage.d.ts.map

package/dist/client/useUserLanguage.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"useUserLanguage.d.ts","sourceRoot":"","sources":["../../src/client/useUserLanguage.ts"],"names":[],"mappings":"AAKA,MAAM,CAAC,OAAO,UAAU,eAAe,IAAI,MAAM,CAMhD"}

package/dist/client/useUserLanguage.js

@@ -1,14 +0,0 @@
-"use strict";
-'use client';
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = useUserLanguage;
-const react_1 = require("react");
-const ClientProvider_1 = require("./ClientProvider");
-function useUserLanguage() {
-    const ctx = (0, react_1.useContext)(ClientProvider_1.GTContext);
-    if (ctx === null || ctx === void 0 ? void 0 : ctx.userLanguage) {
-        return ctx.userLanguage;
-    }
-    return "";
-}
-//# sourceMappingURL=useUserLanguage.js.map

package/dist/client/useUserLanguage.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"useUserLanguage.js","sourceRoot":"","sources":["../../src/client/useUserLanguage.ts"],"names":[],"mappings":";AAAA,YAAY,CAAA;;AAKZ,kCAMC;AATD,iCAAmC;AACnC,qDAA6C;AAE7C,SAAwB,eAAe;IACnC,MAAM,GAAG,GAAG,IAAA,kBAAU,EAAC,0BAAS,CAAC,CAAC;IAClC,IAAI,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,YAAY,EAAE,CAAC;QACpB,OAAO,GAAG,CAAC,YAAY,CAAC;IAC5B,CAAC;IACD,OAAO,EAAE,CAAC;AACd,CAAC"}

package/dist/config/I18NConfig.d.ts

@@ -1,122 +0,0 @@
-import 'server-only';
-import GT from 'generaltranslation';
-import SheetManager from './SheetManager';
-type I18NConfigurationParams = {
-    apiKey?: string;
-    projectID?: string;
-    defaultLanguage?: string;
-    cachedLanguage?: string;
-    approvedLanguages?: string[];
-    maxConcurrentRequests?: number;
-    batchInterval?: number;
-    baseURL?: string;
-    cacheURL?: string;
-    remoteSource?: boolean;
-    defaultPage?: string;
-    sheetFilepaths?: Record<string, string>;
-    displayNotification?: boolean;
-    [key: string]: any;
-};
-declare class I18NConfiguration {
-    apiKey: string;
-    projectID: string;
-    defaultLanguage: string;
-    cachedLanguage: string;
-    approvedLanguages: string[] | undefined;
-    cacheURL: string;
-    baseURL: string;
-    renderMethod: string;
-    remoteSource: boolean;
-    defaultPage: string;
-    sheetFilepaths: Record<string, string>;
-    displayNotification: boolean;
-    gt: GT;
-    metadata: Record<string, any>;
-    sheetManager: SheetManager;
-    maxConcurrentRequests: number;
-    batchInterval: number;
-    _queue: Array<any>;
-    _activeRequests: number;
-    constructor({ apiKey, projectID, defaultLanguage, cachedLanguage, approvedLanguages, maxConcurrentRequests, batchInterval, cacheURL, baseURL, renderMethod, // "hang", "subtle"
-    remoteSource, defaultPage, sheetFilepaths, displayNotification, ...metadata }?: I18NConfigurationParams);
-    /**
-     * Returns true if notification should be displayed, false otherwise
-     * @returns {boolean}
-     */
-    getDisplayNotification(): boolean;
-    /**
-     * Get the default language
-     * @returns {string} A language code
-     */
-    getDefaultLanguage(): string;
-    /**
-     * Set the most recently used language, for use in variables
-     * @returns A language code
-    */
-    setCachedLanguage(language: string): void;
-    /**
-     * Get the most recently used language
-     * @returns A language code
-    */
-    getUserLanguage(): string;
-    /**
-     * Given a list of languages (usually part of the user request), find the most appropriate approved language
-     * @returns the user's most appropriate language.
-     */
-    determineUserLanguage(languageList: string[] | string | undefined): string;
-    /**
-     * Check if translation is required based on the user language
-     * @param userLanguage - The language set by the user
-     * @returns True if translation is required, otherwise false
-     */
-    translationRequired(userLanguage: string): boolean;
-    /**
-     * Get the entry in the I18N page for the user language, if it exists
-     * @param userLanguage - The language set by the user
-     * @param key - Key in the dictionary. For strings, the original language version of that string. For React children, a hash.
-     * @param page - User-defined page for better I18N page structure.
-     * @returns A promise that resolves to the value in the I18N page.
-    */
-    getI18NSheet(userLanguage: string, page?: string): Promise<Record<string, any> | null>;
-    /**
-     * Get the entry in the I18N page for the user language, if it exists
-     * @param userLanguage - The language set by the user
-     * @param key - Key in the dictionary. For strings, the original language version of that string. For React children, a hash.
-     * @param page - User-defined page for better I18N page structure.
-     * @returns A promise that resolves to the value in the I18N page.
-    */
-    getI18NEntry(userLanguage: string, key: string, id?: string, page?: string): Promise<any | null>;
-    /**
-     * Translate content into language
-     * @param params - Parameters for translation
-     * @returns Translated string
-     */
-    intl(params: any): Promise<string>;
-    /**
-     * Translate the children components
-     * @param params - Parameters for translation
-     * @returns A promise that resolves when translation is complete
-    */
-    translateChildren(params: any): Promise<any>;
-    /**
-     * Send a batch request for React translation
-     * @param batch - The batch of requests to be sent
-     */
-    private _sendBatchRequest;
-    /**
-     * Start the batching process with a set interval
-    */
-    private _startBatching;
-    /**
-     * Get the render method
-     * @returns The current render method
-    */
-    getRenderMethod(): string;
-    /**
-     * @returns True if the library is using a remote dictionary (e.g. from www.generaltranslation.com), false otherwise.
-    */
-    hasRemoteSource(): boolean;
-}
-declare const I18NConfig: I18NConfiguration;
-export default I18NConfig;
-//# sourceMappingURL=I18NConfig.d.ts.map

package/dist/config/I18NConfig.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"I18NConfig.d.ts","sourceRoot":"","sources":["../../src/config/I18NConfig.ts"],"names":[],"mappings":"AAGA,OAAO,aAAa,CAAA;AAEpB,OAAO,EAAuC,MAAM,oBAAoB,CAAC;AAOzE,OAAO,YAAY,MAAM,gBAAgB,CAAC;AAc1C,KAAK,uBAAuB,GAAG;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC7B,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAC/B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACxC,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACtB,CAAA;AAED,cAAM,iBAAiB;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,EAAE,MAAM,CAAC;IACxB,cAAc,EAAE,MAAM,CAAC;IACvB,iBAAiB,EAAE,MAAM,EAAE,GAAG,SAAS,CAAC;IACxC,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,EAAE,OAAO,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACvC,mBAAmB,EAAE,OAAO,CAAC;IAC7B,EAAE,EAAE,EAAE,CAAC;IACP,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAC9B,YAAY,EAAE,YAAY,CAAC;IAC3B,qBAAqB,EAAE,MAAM,CAAC;IAC9B,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC;IACnB,eAAe,EAAE,MAAM,CAAC;gBAEZ,EACR,MAAwC,EACxC,SAA8C,EAC9C,eAAsB,EACtB,cAAgC,EAChC,iBAAiB,EACjB,qBAAyB,EACzB,aAAoB,EACpB,QAAkC,EAClC,OAAgC,EAChC,YAAwB,EAAE,mBAAmB;IAC7C,YAAmB,EACnB,WAAgB,EAChB,cAAmB,EACnB,mBAA0B,EAC1B,GAAG,QAAQ,EACd,GAAE,uBAA4B;IA8B/B;;;OAGG;IACH,sBAAsB,IAAI,OAAO;IAKjC;;;OAGG;IACH,kBAAkB,IAAI,MAAM;IAI5B;;;MAGE;IACF,iBAAiB,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAIzC;;;MAGE;IACF,eAAe,IAAI,MAAM;IAIzB;;;OAGG;IACH,qBAAqB,CAAC,YAAY,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,SAAS,GAAG,MAAM;IAc1E;;;;OAIG;IACH,mBAAmB,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO;IAOlD;;;;;;MAME;IACI,YAAY,CAAC,YAAY,EAAE,MAAM,EAAE,IAAI,GAAE,MAAsC,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC;IAW3H;;;;;;MAME;IACI,YAAY,CAAC,YAAY,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,GAAE,MAAY,EAAE,IAAI,GAAE,MAAsC,GAAG,OAAO,CAAC,GAAG,GAAG,IAAI,CAAC;IAM1I;;;;OAIG;IACG,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC;IAMxC;;;;MAIE;IACI,iBAAiB,CAAC,MAAM,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAMlD;;;OAGG;YACW,iBAAiB;IA4B/B;;MAEE;IACF,OAAO,CAAC,cAAc;IAStB;;;MAGE;IACF,eAAe,IAAI,MAAM;IAIzB;;MAEE;IACF,eAAe,IAAI,OAAO;CAG7B;AAID,QAAA,MAAM,UAAU,mBAAyC,CAAC;AAE1D,eAAe,UAAU,CAAC"}