gt-react 3.1.39 → 3.1.40

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

@@ -0,0 +1,118 @@
+import { ComponentType, ReactNode } from 'react';
+import Variables from './Variables';
+type GeneralTranslation = Variables & {
+    /**
+    * The `<T>` 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.
+    */
+    T: 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 `<T>` 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?: {
+        n?: number;
+        values?: Record<string, any>;
+        [key: string]: any;
+    }) => any;
+    /**
+    * Server-side function which prepares a `t()` function by prepending an ID. Useful with large nested dictionaries. You can also import `t()` directly.
+    * Equivalent to `useGT()` on the client-side.
+    *
+    * `id` - (string) - ID to be prepended.
+    *
+    */
+    getGT: (id?: string) => 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;
+    /**
+     *  Type of <T> translation component which renders content around variables.
+     *
+     * `children?` - (any) - The default content to render if no conditions are met.
+     *
+     * `values?` - (Record<string, any>) - A set of values used for conditional rendering.
+     */
+    Value: ComponentType<{
+        children?: any;
+        values: Record<string, any>;
+    }>;
+    /**
+     *  Type of <T> translation component which renders content around numbers.
+     *
+     * `children?` - (any) - The default content to render if no plural 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`.
+    **/
+    Plural: ComponentType<{
+        children?: any;
+        n: number;
+        zero?: ReactNode;
+        one?: ReactNode;
+        two?: ReactNode;
+        few?: ReactNode;
+        many?: ReactNode;
+        other?: ReactNode;
+        ranges?: {
+            min: number;
+            max: number;
+            children: any;
+        }[];
+    }>;
+};
+export default GeneralTranslation;
+//# sourceMappingURL=GeneralTranslationInterface.d.ts.map

package/dist/cjs/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,SAAS,EAAE,MAAM,OAAO,CAAC;AACxD,OAAO,SAAS,MAAM,aAAa,CAAC;AAEpC,KAAK,kBAAkB,GAAG,SAAS,GAAG;IAElC;;;;;;;;MAQE;IACF,CAAC,EAAE,aAAa,CAAC;QACb,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;QACtB,CAAC,CAAC,EAAE,MAAM,CAAC;QACX,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAC7B,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KACrB,KAAK,GAAG,CAAC;IAEV;;;;;;MAME;IACF,KAAK,EAAE,CAAC,EAAE,CAAC,EAAE,MAAM,KAAK,GAAG,CAAC;IAE5B;;;;MAIE;IACF,IAAI,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,GAAG,CAAC;IAE1B;;;;;;OAMG;IACH,KAAK,EAAE,aAAa,CAAC;QACjB,QAAQ,CAAC,EAAE,GAAG,CAAC;QACf,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;KAC/B,CAAC,CAAC;IAEH;;;;;;;;OAQG;IACH,MAAM,EAAE,aAAa,CAAC;QAClB,QAAQ,CAAC,EAAE,GAAG,CAAC;QACf,CAAC,EAAE,MAAM,CAAC;QACV,IAAI,CAAC,EAAE,SAAS,CAAC;QACjB,GAAG,CAAC,EAAE,SAAS,CAAC;QAChB,GAAG,CAAC,EAAE,SAAS,CAAC;QAChB,GAAG,CAAC,EAAE,SAAS,CAAC;QAChB,IAAI,CAAC,EAAE,SAAS,CAAC;QACjB,KAAK,CAAC,EAAE,SAAS,CAAC;QAClB,MAAM,CAAC,EAAE;YAAE,GAAG,EAAE,MAAM,CAAC;YAAC,GAAG,EAAE,MAAM,CAAC;YAAC,QAAQ,EAAE,GAAG,CAAA;SAAE,EAAE,CAAC;KAC1D,CAAC,CAAC;CAEN,CAAA;AAED,eAAe,kBAAkB,CAAC"}

package/dist/cjs/types/GeneralTranslationInterface.js

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

package/dist/cjs/types/GeneralTranslationInterface.js.map

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

package/dist/cjs/types/Variables.d.ts

@@ -0,0 +1,83 @@
+import { ComponentType } from 'react';
+type Variables = {
+    /**
+     * 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.
+    **/
+    Var: 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?` - (Intl.NumberFormatOptions) - Additional options for `Intl.NumberFormat` for formatting the number.
+    **/
+    Num: ComponentType<{
+        children?: any;
+        name?: string;
+        defaultValue?: any;
+        options?: Intl.NumberFormatOptions;
+    }>;
+    /**
+     * 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?` - (Intl.DateTimeFormatOptions) - Additional options for `Intl.DateTimeFormat` for formatting the date.
+    **/
+    DateTime: ComponentType<{
+        children?: any;
+        name?: string;
+        defaultValue?: any;
+        options?: Intl.DateTimeFormatOptions;
+    }>;
+    /**
+     * 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?` - (Intl.NumberFormatOptions) - Additional options for `Intl.NumberFormat` for formatting the currency.
+    **/
+    Currency: ComponentType<{
+        children?: any;
+        name?: string;
+        defaultValue?: any;
+        currency?: string;
+        options?: Intl.NumberFormatOptions;
+    }>;
+    /**
+    * 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;
+};
+export default Variables;
+//# sourceMappingURL=Variables.d.ts.map

package/dist/cjs/types/Variables.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Variables.d.ts","sourceRoot":"","sources":["../../../src/types/Variables.ts"],"names":[],"mappings":"AAAA,OAAc,EAAE,aAAa,EAAa,MAAM,OAAO,CAAA;AAEvD,KAAK,SAAS,GAAG;IAEb;;;;;;;;OAQG;IACH,GAAG,EAAE,aAAa,CAAC;QACf,QAAQ,CAAC,EAAE,GAAG,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,YAAY,CAAC,EAAE,GAAG,CAAC;KACtB,CAAC,CAAC;IAEH;;;;;;;;;;OAUG;IACH,GAAG,EAAE,aAAa,CAAC;QACf,QAAQ,CAAC,EAAE,GAAG,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,YAAY,CAAC,EAAE,GAAG,CAAC;QACnB,OAAO,CAAC,EAAE,IAAI,CAAC,mBAAmB,CAAC;KACtC,CAAC,CAAC;IAEH;;;;;;;;;;OAUG;IACH,QAAQ,EAAE,aAAa,CAAC;QACpB,QAAQ,CAAC,EAAE,GAAG,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,YAAY,CAAC,EAAE,GAAG,CAAC;QACnB,OAAO,CAAC,EAAE,IAAI,CAAC,qBAAqB,CAAC;KACxC,CAAC,CAAC;IAEH;;;;;;;;;;;;OAYG;IACH,QAAQ,EAAE,aAAa,CAAC;QACpB,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,IAAI,CAAC,mBAAmB,CAAC;KACtC,CAAC,CAAC;IAGH;;;OAGG;IACH,SAAS,EAAE,MAAM,MAAM,CAAC;IAExB;;;OAGG;IACH,gBAAgB,EAAE,MAAM,MAAM,CAAC;CAElC,CAAA;AAED,eAAe,SAAS,CAAC"}

package/dist/cjs/types/Variables.js

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

package/dist/cjs/types/Variables.js.map

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

package/dist/cjs/types/defaultGTProps.d.ts

@@ -0,0 +1,20 @@
+declare const defaultGTProps: {
+    apiKey: string;
+    projectID: string;
+    cacheURL: string;
+    baseURL: string;
+    remoteSource: boolean;
+    automaticTranslation: boolean;
+    defaultLocale: string;
+    getLocale: () => string;
+    renderPrevious: boolean;
+    renderMethod: string;
+    renderTimeout: number;
+    dictionaryName: string;
+    dictionary: {};
+    maxConcurrentRequests: number;
+    batchInterval: number;
+    getMetadata: () => {};
+};
+export default defaultGTProps;
+//# sourceMappingURL=defaultGTProps.d.ts.map

package/dist/cjs/types/defaultGTProps.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaultGTProps.d.ts","sourceRoot":"","sources":["../../../src/types/defaultGTProps.ts"],"names":[],"mappings":"AAEA,QAAA,MAAM,cAAc;;;;;;;;;;;;;;;;;CAsBnB,CAAA;AAED,eAAe,cAAc,CAAC"}

package/dist/cjs/types/defaultGTProps.js

@@ -0,0 +1,31 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const getDefaultFromEnv_1 = __importDefault(require("../config/local/getDefaultFromEnv"));
+const defaultGTProps = {
+    apiKey: (0, getDefaultFromEnv_1.default)('GT_API_KEY'),
+    projectID: (0, getDefaultFromEnv_1.default)('GT_PROJECT_ID'),
+    cacheURL: "https://cache.gtx.dev",
+    baseURL: "https://prod.gtx.dev",
+    remoteSource: true,
+    automaticTranslation: true,
+    // Locale info
+    defaultLocale: 'en',
+    getLocale: () => { return 'en '; },
+    // Rendering
+    renderPrevious: true,
+    renderMethod: "replace", // "skeleton", "hang", "subtle"
+    renderTimeout: 12500,
+    // Dictionaries
+    dictionaryName: "default",
+    dictionary: {},
+    // Batching config
+    maxConcurrentRequests: 2,
+    batchInterval: 1000,
+    // Other metadata
+    getMetadata: () => { return {}; }
+};
+exports.default = defaultGTProps;
+//# sourceMappingURL=defaultGTProps.js.map

package/dist/cjs/types/defaultGTProps.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaultGTProps.js","sourceRoot":"","sources":["../../../src/types/defaultGTProps.ts"],"names":[],"mappings":";;;;;AAAA,0FAAiE;AAEjE,MAAM,cAAc,GAAG;IACnB,MAAM,EAAE,IAAA,2BAAiB,EAAC,YAAY,CAAC;IACvC,SAAS,EAAE,IAAA,2BAAiB,EAAC,eAAe,CAAC;IAC7C,QAAQ,EAAE,uBAAuB;IACjC,OAAO,EAAE,sBAAsB;IAC/B,YAAY,EAAE,IAAI;IAClB,oBAAoB,EAAE,IAAI;IAC1B,cAAc;IACd,aAAa,EAAE,IAAI;IACnB,SAAS,EAAE,GAAG,EAAE,GAAG,OAAO,KAAK,CAAA,CAAA,CAAC;IAChC,YAAY;IACZ,cAAc,EAAE,IAAI;IACpB,YAAY,EAAE,SAAS,EAAE,+BAA+B;IACxD,aAAa,EAAE,KAAK;IACpB,eAAe;IACf,cAAc,EAAE,SAAS;IACzB,UAAU,EAAE,EAAE;IACd,kBAAkB;IAClB,qBAAqB,EAAE,CAAC;IACxB,aAAa,EAAE,IAAI;IACnB,iBAAiB;IACjB,WAAW,EAAE,GAAG,EAAE,GAAG,OAAO,EAAE,CAAA,CAAC,CAAC;CACnC,CAAA;AAED,kBAAe,cAAc,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gt-react",
-  "version": "3.1.39",
+  "version": "3.1.40",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",