gt-react 8.2.13 → 8.2.14

package/dist/internal.js

@@ -1,69 +1,15 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isTranslationError = exports.defaultRenderSettings = exports.renderSkeleton = exports.renderTranslatedChildren = exports.renderDefaultChildren = exports.getFallbackVariableName = exports.getVariableName = exports.extractEntryMetadata = exports.getPluralBranch = exports.getVariableProps = exports.getDictionaryEntry = exports.flattenDictionary = exports.isVariableObject = exports.writeChildrenAsObjects = exports.addGTIdentifier = void 0;
-var flattenDictionary_1 = __importDefault(require("./internal/flattenDictionary"));
-exports.flattenDictionary = flattenDictionary_1.default;
-var addGTIdentifier_1 = __importDefault(require("./internal/addGTIdentifier"));
-exports.addGTIdentifier = addGTIdentifier_1.default;
-var writeChildrenAsObjects_1 = __importDefault(require("./internal/writeChildrenAsObjects"));
-exports.writeChildrenAsObjects = writeChildrenAsObjects_1.default;
-var getPluralBranch_1 = __importDefault(require("./branches/plurals/getPluralBranch"));
-exports.getPluralBranch = getPluralBranch_1.default;
-var getDictionaryEntry_1 = __importDefault(require("./provider/helpers/getDictionaryEntry"));
-exports.getDictionaryEntry = getDictionaryEntry_1.default;
-var extractEntryMetadata_1 = __importDefault(require("./provider/helpers/extractEntryMetadata"));
-exports.extractEntryMetadata = extractEntryMetadata_1.default;
-var _getVariableProps_1 = __importDefault(require("./variables/_getVariableProps"));
-exports.getVariableProps = _getVariableProps_1.default;
-var isVariableObject_1 = __importDefault(require("./provider/helpers/isVariableObject"));
-exports.isVariableObject = isVariableObject_1.default;
-var getVariableName_1 = __importStar(require("./variables/getVariableName"));
-exports.getVariableName = getVariableName_1.default;
-Object.defineProperty(exports, "getFallbackVariableName", { enumerable: true, get: function () { return getVariableName_1.getFallbackVariableName; } });
-var renderDefaultChildren_1 = __importDefault(require("./provider/rendering/renderDefaultChildren"));
-exports.renderDefaultChildren = renderDefaultChildren_1.default;
-var renderTranslatedChildren_1 = __importDefault(require("./provider/rendering/renderTranslatedChildren"));
-exports.renderTranslatedChildren = renderTranslatedChildren_1.default;
-var defaultRenderSettings_1 = require("./provider/rendering/defaultRenderSettings");
-Object.defineProperty(exports, "defaultRenderSettings", { enumerable: true, get: function () { return defaultRenderSettings_1.defaultRenderSettings; } });
-var renderSkeleton_1 = __importDefault(require("./provider/rendering/renderSkeleton"));
-exports.renderSkeleton = renderSkeleton_1.default;
-var utils_1 = require("./utils/utils");
-Object.defineProperty(exports, "isTranslationError", { enumerable: true, get: function () { return utils_1.isTranslationError; } });
+import flattenDictionary from "./internal/flattenDictionary";
+import addGTIdentifier from "./internal/addGTIdentifier";
+import writeChildrenAsObjects from "./internal/writeChildrenAsObjects";
+import getPluralBranch from "./branches/plurals/getPluralBranch";
+import getDictionaryEntry from "./provider/helpers/getDictionaryEntry";
+import extractEntryMetadata from "./provider/helpers/extractEntryMetadata";
+import getVariableProps from './variables/_getVariableProps';
+import isVariableObject from './provider/helpers/isVariableObject';
+import getVariableName, { getFallbackVariableName } from "./variables/getVariableName";
+import renderDefaultChildren from "./provider/rendering/renderDefaultChildren";
+import renderTranslatedChildren from "./provider/rendering/renderTranslatedChildren";
+import { defaultRenderSettings } from "./provider/rendering/defaultRenderSettings";
+import renderSkeleton from "./provider/rendering/renderSkeleton";
+export { addGTIdentifier, writeChildrenAsObjects, isVariableObject, flattenDictionary, getDictionaryEntry, getVariableProps, getPluralBranch, extractEntryMetadata, getVariableName, getFallbackVariableName, renderDefaultChildren, renderTranslatedChildren, renderSkeleton, defaultRenderSettings };
 //# sourceMappingURL=internal.js.map

package/dist/internal.js.map

@@ -1 +1 @@
-{"version":3,"file":"internal.js","sourceRoot":"","sources":["../src/internal.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mFAA6D;AAiB7C,4BAjBT,2BAAiB,CAiBS;AAhBjC,+EAAyD;AAerD,0BAfG,yBAAe,CAeH;AAdnB,6FAAuE;AAclD,iCAdd,gCAAsB,CAcc;AAb3C,uFAAiE;AAe7D,0BAfG,yBAAe,CAeH;AAdnB,6FAAuE;AAapC,6BAb5B,4BAAkB,CAa4B;AAZrD,iGAA2E;AAatD,+BAbd,8BAAoB,CAac;AAZzC,oFAA6D;AAWN,2BAXhD,2BAAgB,CAWgD;AAVvE,yFAAmE;AAStB,2BATtC,0BAAgB,CASsC;AAR7D,6EAAuF;AAWnF,0BAXG,yBAAe,CAWH;AAAE,wGAXK,yCAAuB,OAWL;AAV5C,qGAA+E;AAW3E,gCAXG,+BAAqB,CAWH;AAVzB,2GAAqF;AAU1D,mCAVpB,kCAAwB,CAUoB;AATnD,oFAAmF;AAWjE,sGAXT,6CAAqB,OAWS;AAVvC,uFAAiE;AAS7D,yBATG,wBAAc,CASH;AAPlB,uCAAmD;AAS8B,mGATxE,0BAAkB,OASwE"}
+{"version":3,"file":"internal.js","sourceRoot":"","sources":["../src/internal.ts"],"names":[],"mappings":"AAAA,OAAO,iBAAiB,MAAM,8BAA8B,CAAC;AAC7D,OAAO,eAAe,MAAM,4BAA4B,CAAC;AACzD,OAAO,sBAAsB,MAAM,mCAAmC,CAAC;AACvE,OAAO,eAAe,MAAM,oCAAoC,CAAC;AACjE,OAAO,kBAAkB,MAAM,uCAAuC,CAAC;AACvE,OAAO,oBAAoB,MAAM,yCAAyC,CAAC;AAC3E,OAAO,gBAAgB,MAAM,+BAA+B,CAAC;AAC7D,OAAO,gBAAgB,MAAM,qCAAqC,CAAC;AACnE,OAAO,eAAe,EAAE,EAAE,uBAAuB,EAAE,MAAM,6BAA6B,CAAC;AACvF,OAAO,qBAAqB,MAAM,4CAA4C,CAAC;AAC/E,OAAO,wBAAwB,MAAM,+CAA+C,CAAC;AACrF,OAAO,EAAE,qBAAqB,EAAE,MAAM,4CAA4C,CAAC;AACnF,OAAO,cAAc,MAAM,qCAAqC,CAAC;AAEjE,OAAO,EACH,eAAe,EAAE,sBAAsB,EAAE,gBAAgB,EAC7C,iBAAiB,EAAE,kBAAkB,EAAE,gBAAgB,EACnE,eAAe,EAAE,oBAAoB,EACrC,eAAe,EAAE,uBAAuB,EACxC,qBAAqB,EAAE,wBAAwB,EAC/C,cAAc,EACA,qBAAqB,EAGtC,CAAA"}

package/dist/messages/createMessages.d.ts

@@ -0,0 +1,17 @@
+export declare const projectIdMissingError = "gt-react Error: General Translation cloud services require a project ID! Find yours at www.generaltranslation.com/dashboard.";
+export declare const createPluralMissingError: (children: any) => string;
+export declare const createClientSideTWithoutIdError: (children: any) => string;
+export declare const createStringTranslationError: (content: string, id?: string) => string;
+export declare const createClientSideTDictionaryCollisionError: (id: string) => string;
+export declare const createClientSideTHydrationError: (id: string) => string;
+export declare const createNestedDataGTError: (child: any) => string;
+export declare const createNestedTError: (child: any) => string;
+export declare const renderingError = "General Translation: Rendering error.";
+export declare const dynamicTranslationError = "Error fetching batched translations:";
+export declare const createGenericRuntimeTranslationError: (id: string | undefined, hash: string) => string;
+export declare const createLibraryNoEntryWarning: (id: string) => string;
+export declare const createNoEntryWarning: (id: string, prefixedId: string) => string;
+export declare const createInvalidElementEntryWarning: (id: string, prefixedId: string) => string;
+export declare const createMismatchingHashWarning: (expectedHash: string, receivedHash: string) => string;
+export declare const createMismatchingIdHashWarning: (expectedId: string, expectedHash: string, receivedId: string, receivedHash: string) => string;
+//# sourceMappingURL=createMessages.d.ts.map

package/dist/messages/createMessages.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createMessages.d.ts","sourceRoot":"","sources":["../../src/messages/createMessages.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,qBAAqB,iIAAiI,CAAA;AAEnK,eAAO,MAAM,wBAAwB,aAAc,GAAG,WAA0E,CAAA;AAEhI,eAAO,MAAM,+BAA+B,aAAc,GAAG,WAA0E,CAAA;AAEvI,eAAO,MAAM,4BAA4B,YAAa,MAAM,OAAO,MAAM,WAAiG,CAAA;AAE1K,eAAO,MAAM,yCAAyC,OAAQ,MAAM,WAAoI,CAAA;AAExM,eAAO,MAAM,+BAA+B,OAAQ,MAAM,WACuE,CAAA;AAEjI,eAAO,MAAM,uBAAuB,UAAW,GAAG,WAAmM,CAAA;AAErP,eAAO,MAAM,kBAAkB,UAAW,GAAG,WAAmG,CAAA;AAEhJ,eAAO,MAAM,cAAc,0CAA0C,CAAA;AAErE,eAAO,MAAM,uBAAuB,yCAAyC,CAAA;AAE7E,eAAO,MAAM,oCAAoC,OAAQ,MAAM,GAAG,SAAS,QAAQ,MAAM,WAMxF,CAAA;AAID,eAAO,MAAM,2BAA2B,OAAQ,MAAM,WAA0D,CAAA;AAEhH,eAAO,MAAM,oBAAoB,OAAQ,MAAM,cAAc,MAAM,WAA4E,CAAA;AAE/I,eAAO,MAAM,gCAAgC,OAAQ,MAAM,cAAc,MAAM,WAA6J,CAAA;AAE5O,eAAO,MAAM,4BAA4B,iBAAkB,MAAM,gBAAgB,MAAM,WAA+M,CAAA;AAEtS,eAAO,MAAM,8BAA8B,eAAgB,MAAM,gBAAgB,MAAM,cAAc,MAAM,gBAAgB,MAAM,WAA4P,CAAA"}

package/dist/messages/createMessages.js

@@ -0,0 +1,27 @@
+// ---- ERRORS ---- //
+export var projectIdMissingError = 'gt-react Error: General Translation cloud services require a project ID! Find yours at www.generaltranslation.com/dashboard.';
+export var createPluralMissingError = function (children) { return "<Plural> component with children \"".concat(children, "\" requires \"n\" option."); };
+export var createClientSideTWithoutIdError = function (children) { return "Client-side <T> with no provided 'id' prop. Children: \"".concat(children, "\""); };
+export var createStringTranslationError = function (content, id) { return "gt-next string translation error. tx(\"".concat(content, "\")").concat(id ? " with id \"".concat(id, "\"") : '', " failed."); };
+export var createClientSideTDictionaryCollisionError = function (id) { return "<T id=\"".concat(id, "\">, \"").concat(id, "\" is also used as a key in the dictionary. Don't give <T> components the same ID as dictionary entries."); };
+export var createClientSideTHydrationError = function (id) { return "<T id=\"".concat(id, "\"> is used in a client component without a valid saved translation. This can cause hydration errors.")
+    + "\n\nTo fix this error, consider using a dictionary with useGT() or pushing translations from the command line in advance."; };
+export var createNestedDataGTError = function (child) { return "General Translation already in use on child with props: ".concat(child.props, ". This usually occurs when you nest <T> components within the same file. Remove one of the <T> components to continue."); };
+export var createNestedTError = function (child) { var _a; return "General Translation: Nested <T> components. The inner <T> has the id: \"".concat((_a = child === null || child === void 0 ? void 0 : child.props) === null || _a === void 0 ? void 0 : _a.id, "\"."); };
+export var renderingError = 'General Translation: Rendering error.';
+export var dynamicTranslationError = "Error fetching batched translations:";
+export var createGenericRuntimeTranslationError = function (id, hash) {
+    if (!id) {
+        return "Translation failed for hash: ".concat(hash);
+    }
+    else {
+        return "Translation failed for id: ".concat(id, ", hash: ").concat(hash, " ");
+    }
+};
+// ---- WARNINGS ---- //
+export var createLibraryNoEntryWarning = function (id) { return "gt-react: No dictionary entry found for id: \"".concat(id, "\""); };
+export var createNoEntryWarning = function (id, prefixedId) { return "t('".concat(id, "') finding no translation for dictionary item ").concat(prefixedId, " !"); };
+export var createInvalidElementEntryWarning = function (id, prefixedId) { return "t('".concat(id, "') invalid dictionary entry for ").concat(prefixedId, " ! useElement() can only be used to render JSX elements. Strings and other types are not allowed."); };
+export var createMismatchingHashWarning = function (expectedHash, receivedHash) { return "Mismatching hashes! Expected hash: ".concat(expectedHash, ", but got hash: ").concat(receivedHash, ". We will still render your translation, but make sure to update to the newest version: www.generaltranslation.com/docs"); };
+export var createMismatchingIdHashWarning = function (expectedId, expectedHash, receivedId, receivedHash) { return "Mismatching ids or hashes! Expected id: ".concat(expectedId, ", hash: ").concat(expectedHash, ", but got id: ").concat(receivedId, ", hash: ").concat(receivedHash, ". We will still render your translation, but make sure to update to the newest version: www.generaltranslation.com/docs"); };
+//# sourceMappingURL=createMessages.js.map

package/dist/messages/createMessages.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createMessages.js","sourceRoot":"","sources":["../../src/messages/createMessages.ts"],"names":[],"mappings":"AAAA,sBAAsB;AAEtB,MAAM,CAAC,IAAM,qBAAqB,GAAG,8HAA8H,CAAA;AAEnK,MAAM,CAAC,IAAM,wBAAwB,GAAG,UAAC,QAAa,IAAK,OAAA,6CAAqC,QAAQ,8BAAwB,EAArE,CAAqE,CAAA;AAEhI,MAAM,CAAC,IAAM,+BAA+B,GAAG,UAAC,QAAa,IAAK,OAAA,kEAA0D,QAAQ,OAAG,EAArE,CAAqE,CAAA;AAEvI,MAAM,CAAC,IAAM,4BAA4B,GAAG,UAAC,OAAe,EAAE,EAAW,IAAK,OAAA,iDAAyC,OAAO,gBAAK,EAAE,CAAC,CAAC,CAAC,qBAAa,EAAE,OAAG,CAAC,CAAC,CAAC,EAAE,aAAW,EAA5F,CAA4F,CAAA;AAE1K,MAAM,CAAC,IAAM,yCAAyC,GAAG,UAAC,EAAU,IAAK,OAAA,kBAAU,EAAE,oBAAQ,EAAE,6GAAyG,EAA/H,CAA+H,CAAA;AAExM,MAAM,CAAC,IAAM,+BAA+B,GAAG,UAAC,EAAU,IAAK,OAAA,kBAAU,EAAE,0GAAsG;MAC3K,2HAA2H,EADlE,CACkE,CAAA;AAEjI,MAAM,CAAC,IAAM,uBAAuB,GAAG,UAAC,KAAU,IAAK,OAAA,kEAA2D,KAAK,CAAC,KAAK,2HAAwH,EAA9L,CAA8L,CAAA;AAErP,MAAM,CAAC,IAAM,kBAAkB,GAAG,UAAC,KAAU,YAAK,OAAA,kFAA0E,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,KAAK,0CAAE,EAAE,QAAI,CAAA,EAAA,CAAA;AAEhJ,MAAM,CAAC,IAAM,cAAc,GAAG,uCAAuC,CAAA;AAErE,MAAM,CAAC,IAAM,uBAAuB,GAAG,sCAAsC,CAAA;AAE7E,MAAM,CAAC,IAAM,oCAAoC,GAAG,UAAC,EAAsB,EAAE,IAAY;IACrF,IAAI,CAAC,EAAE,EAAE,CAAC;QACN,OAAO,uCAAgC,IAAI,CAAE,CAAC;IAClD,CAAC;SAAM,CAAC;QACJ,OAAO,qCAA8B,EAAE,qBAAW,IAAI,MAAG,CAAC;IAC9D,CAAC;AACL,CAAC,CAAA;AAED,wBAAwB;AAExB,MAAM,CAAC,IAAM,2BAA2B,GAAG,UAAC,EAAU,IAAK,OAAA,wDAAgD,EAAE,OAAG,EAArD,CAAqD,CAAA;AAEhH,MAAM,CAAC,IAAM,oBAAoB,GAAG,UAAC,EAAU,EAAE,UAAkB,IAAK,OAAA,aAAM,EAAE,2DAAiD,UAAU,OAAI,EAAvE,CAAuE,CAAA;AAE/I,MAAM,CAAC,IAAM,gCAAgC,GAAG,UAAC,EAAU,EAAE,UAAkB,IAAK,OAAA,aAAM,EAAE,6CAAmC,UAAU,sGAAmG,EAAxJ,CAAwJ,CAAA;AAE5O,MAAM,CAAC,IAAM,4BAA4B,GAAG,UAAC,YAAoB,EAAE,YAAoB,IAAK,OAAA,6CAAsC,YAAY,6BAAmB,YAAY,4HAAyH,EAA1M,CAA0M,CAAA;AAEtS,MAAM,CAAC,IAAM,8BAA8B,GAAG,UAAC,UAAkB,EAAE,YAAoB,EAAE,UAAkB,EAAE,YAAoB,IAAK,OAAA,kDAA2C,UAAU,qBAAW,YAAY,2BAAiB,UAAU,qBAAW,YAAY,4HAAyH,EAAvP,CAAuP,CAAA"}

package/dist/provider/GTContext.js

@@ -1,13 +1,9 @@
-"use strict";
 'use client';
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.GTContext = void 0;
-exports.default = useGTContext;
-var react_1 = require("react");
-exports.GTContext = (0, react_1.createContext)(undefined);
-function useGTContext(errorString) {
+import { createContext, useContext } from "react";
+export var GTContext = createContext(undefined);
+export default function useGTContext(errorString) {
     if (errorString === void 0) { errorString = 'useGTContext() must be used within a <GTProvider>!'; }
-    var context = (0, react_1.useContext)(exports.GTContext);
+    var context = useContext(GTContext);
     if (typeof context === 'undefined') {
         throw new Error(errorString);
     }

package/dist/provider/GTContext.js.map

@@ -1 +1 @@
-{"version":3,"file":"GTContext.js","sourceRoot":"","sources":["../../src/provider/GTContext.ts"],"names":[],"mappings":";AAAA,YAAY,CAAA;;;AAQZ,+BAMC;AAZD,+BAAkD;AAIrC,QAAA,SAAS,GAAG,IAAA,qBAAa,EAA4B,SAAS,CAAC,CAAC;AAE7E,SAAwB,YAAY,CAAC,WAAkE;IAAlE,4BAAA,EAAA,kEAAkE;IACnG,IAAM,OAAO,GAAG,IAAA,kBAAU,EAAC,iBAAS,CAAC,CAAC;IACtC,IAAI,OAAO,OAAO,KAAK,WAAW,EAAE,CAAC;QACjC,MAAM,IAAI,KAAK,CAAC,WAAW,CAAC,CAAC;IACjC,CAAC;IACD,OAAO,OAAO,CAAC;AACnB,CAAC;AAAA,CAAC"}
+{"version":3,"file":"GTContext.js","sourceRoot":"","sources":["../../src/provider/GTContext.ts"],"names":[],"mappings":"AAAA,YAAY,CAAA;AAEZ,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AAIlD,MAAM,CAAC,IAAM,SAAS,GAAG,aAAa,CAA4B,SAAS,CAAC,CAAC;AAE7E,MAAM,CAAC,OAAO,UAAU,YAAY,CAAC,WAAkE;IAAlE,4BAAA,EAAA,kEAAkE;IACnG,IAAM,OAAO,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC;IACtC,IAAI,OAAO,OAAO,KAAK,WAAW,EAAE,CAAC;QACjC,MAAM,IAAI,KAAK,CAAC,WAAW,CAAC,CAAC;IACjC,CAAC;IACD,OAAO,OAAO,CAAC;AACnB,CAAC;AAAA,CAAC"}

package/dist/provider/GTProvider.d.ts

@@ -1,4 +1,4 @@
-import { Dictionary, RenderMethod } from "../types/types";
+import { RenderMethod } from "../types/types";
 import React from "react";
 /**
  * Provides General Translation context to its children, which can then access `useGT`, `useLocale`, and `useDefaultLocale`.
@@ -14,9 +14,9 @@ import React from "react";
  * @returns {JSX.Element} The provider component for General Translation context.
  */
 export default function GTProvider({ children, projectId, dictionary, locales, defaultLocale, locale, cacheUrl, runtimeUrl, renderSettings, devApiKey, ...metadata }: {
-    children?: any;
+    children?: React.ReactNode;
     projectId: string;
-    dictionary?: Dictionary;
+    dictionary?: any;
     locales?: string[];
     defaultLocale?: string;
     locale?: string;

package/dist/provider/GTProvider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"GTProvider.d.ts","sourceRoot":"","sources":["../../src/provider/GTProvider.tsx"],"names":[],"mappings":"AAMA,OAAO,EACL,UAAU,EACV,YAAY,EAIb,MAAM,gBAAgB,CAAC;AAqBxB,OAAO,KAAK,MAAM,OAAO,CAAC;AAG1B;;;;;;;;;;;;GAYG;AAEH,MAAM,CAAC,OAAO,UAAU,UAAU,CAAC,EACjC,QAAQ,EACR,SAAS,EACT,UAAe,EACf,OAAgC,EAChC,aAAoC,EACpC,MAAkE,EAClE,QAA0B,EAC1B,UAAiC,EACjC,cAAsC,EACtC,SAAS,EACT,GAAG,QAAQ,EACZ,EAAE;IACC,QAAQ,CAAC,EAAE,GAAG,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,cAAc,CAAC,EAAE;QACb,MAAM,EAAE,YAAY,CAAC;QACrB,OAAO,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;IACF,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CACrB,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,CAyLpB"}
+{"version":3,"file":"GTProvider.d.ts","sourceRoot":"","sources":["../../src/provider/GTProvider.tsx"],"names":[],"mappings":"AAMA,OAAO,EAEL,YAAY,EAGb,MAAM,gBAAgB,CAAC;AAgBxB,OAAO,KAAK,MAAM,OAAO,CAAC;AAG1B;;;;;;;;;;;;GAYG;AAEH,MAAM,CAAC,OAAO,UAAU,UAAU,CAAC,EACjC,QAAQ,EACR,SAAS,EACT,UAAe,EACf,OAAgC,EAChC,aAAoC,EACpC,MAAkE,EAClE,QAA0B,EAC1B,UAAiC,EACjC,cAAsC,EACtC,SAAS,EACT,GAAG,QAAQ,EACZ,EAAE;IACC,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,GAAG,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,cAAc,CAAC,EAAE;QACb,MAAM,EAAE,YAAY,CAAC;QACrB,OAAO,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;IACF,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CACrB,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,CA0NpB"}

package/dist/provider/GTProvider.js

@@ -1,4 +1,3 @@
-"use strict";
 var __assign = (this && this.__assign) || function () {
     __assign = Object.assign || function(t) {
         for (var s, i = 1, n = arguments.length; i < n; i++) {
@@ -57,30 +56,22 @@ var __rest = (this && this.__rest) || function (s, e) {
         }
     return t;
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = GTProvider;
-var jsx_runtime_1 = require("react/jsx-runtime");
-var react_1 = require("react");
-var generaltranslation_1 = require("generaltranslation");
-var react_2 = require("react");
-var useBrowserLocale_1 = __importDefault(require("../hooks/useBrowserLocale"));
-var GTContext_1 = require("./GTContext");
-var getDictionaryEntry_1 = __importDefault(require("./helpers/getDictionaryEntry"));
-var internal_1 = require("../internal");
-var extractEntryMetadata_1 = __importDefault(require("./helpers/extractEntryMetadata"));
-var renderDefaultChildren_1 = __importDefault(require("./rendering/renderDefaultChildren"));
-var renderTranslatedChildren_1 = __importDefault(require("./rendering/renderTranslatedChildren"));
-var internal_2 = require("generaltranslation/internal");
-var renderVariable_1 = __importDefault(require("./rendering/renderVariable"));
-var createErrors_1 = require("../errors/createErrors");
-var supported_locales_1 = require("@generaltranslation/supported-locales");
-var useRuntimeTranslation_1 = __importDefault(require("./dynamic/useRuntimeTranslation"));
-var defaultRenderSettings_1 = require("./rendering/defaultRenderSettings");
-var id_1 = require("generaltranslation/id");
-var renderSkeleton_1 = __importDefault(require("./rendering/renderSkeleton"));
+import { jsx as _jsx } from "react/jsx-runtime";
+import { useMemo } from "react";
+import { isSameLanguage, renderContentToString, requiresTranslation, splitStringToContent } from "generaltranslation";
+import { useCallback, useEffect, useState } from "react";
+import useBrowserLocale from "../hooks/useBrowserLocale";
+import { GTContext } from "./GTContext";
+import getDictionaryEntry from "./helpers/getDictionaryEntry";
+import { flattenDictionary } from "../internal";
+import extractEntryMetadata from "./helpers/extractEntryMetadata";
+import { defaultCacheUrl, defaultRuntimeApiUrl, libraryDefaultLocale, } from "generaltranslation/internal";
+import { projectIdMissingError } from "../messages/createMessages";
+import { listSupportedLocales } from "@generaltranslation/supported-locales";
+import useRuntimeTranslation from "./runtime/useRuntimeTranslation";
+import { defaultRenderSettings } from "./rendering/defaultRenderSettings";
+import { hashJsxChildren } from "generaltranslation/id";
+import T from "../inline/T";
 /**
  * Provides General Translation context to its children, which can then access `useGT`, `useLocale`, and `useDefaultLocale`.
  *
@@ -94,11 +85,11 @@ var renderSkeleton_1 = __importDefault(require("./rendering/renderSkeleton"));
  *
  * @returns {JSX.Element} The provider component for General Translation context.
  */
-function GTProvider(_a) {
+export default function GTProvider(_a) {
     var _this = this;
-    var children = _a.children, projectId = _a.projectId, _b = _a.dictionary, dictionary = _b === void 0 ? {} : _b, _c = _a.locales, locales = _c === void 0 ? (0, supported_locales_1.listSupportedLocales)() : _c, _d = _a.defaultLocale, defaultLocale = _d === void 0 ? internal_2.libraryDefaultLocale : _d, _e = _a.locale, locale = _e === void 0 ? (0, useBrowserLocale_1.default)(defaultLocale, locales) || defaultLocale : _e, _f = _a.cacheUrl, cacheUrl = _f === void 0 ? internal_2.defaultCacheUrl : _f, _g = _a.runtimeUrl, runtimeUrl = _g === void 0 ? internal_2.defaultRuntimeApiUrl : _g, _h = _a.renderSettings, renderSettings = _h === void 0 ? defaultRenderSettings_1.defaultRenderSettings : _h, devApiKey = _a.devApiKey, metadata = __rest(_a, ["children", "projectId", "dictionary", "locales", "defaultLocale", "locale", "cacheUrl", "runtimeUrl", "renderSettings", "devApiKey"]);
-    if (!projectId && (cacheUrl === internal_2.defaultCacheUrl || runtimeUrl === internal_2.defaultRuntimeApiUrl)) {
-        throw new Error(createErrors_1.projectIdMissingError);
+    var children = _a.children, projectId = _a.projectId, _b = _a.dictionary, dictionary = _b === void 0 ? {} : _b, _c = _a.locales, locales = _c === void 0 ? listSupportedLocales() : _c, _d = _a.defaultLocale, defaultLocale = _d === void 0 ? libraryDefaultLocale : _d, _e = _a.locale, locale = _e === void 0 ? useBrowserLocale(defaultLocale, locales) || defaultLocale : _e, _f = _a.cacheUrl, cacheUrl = _f === void 0 ? defaultCacheUrl : _f, _g = _a.runtimeUrl, runtimeUrl = _g === void 0 ? defaultRuntimeApiUrl : _g, _h = _a.renderSettings, renderSettings = _h === void 0 ? defaultRenderSettings : _h, devApiKey = _a.devApiKey, metadata = __rest(_a, ["children", "projectId", "dictionary", "locales", "defaultLocale", "locale", "cacheUrl", "runtimeUrl", "renderSettings", "devApiKey"]);
+    if (!projectId && (cacheUrl === defaultCacheUrl || runtimeUrl === defaultRuntimeApiUrl)) {
+        throw new Error(projectIdMissingError);
     }
     ;
     // disable subtle for development
@@ -107,153 +98,171 @@ function GTProvider(_a) {
         renderSettings.method = 'default';
     }
     // get tx required info
-    var _j = (0, react_1.useMemo)(function () {
-        var regionalTranslation = (0, generaltranslation_1.requiresRegionalTranslation)(defaultLocale, locale, locales);
-        return [(0, generaltranslation_1.requiresTranslation)(defaultLocale, locale, locales) || regionalTranslation, regionalTranslation];
-    }, [defaultLocale, locale, locales]), translationRequired = _j[0], regionalTranslationRequired = _j[1];
+    var _j = useMemo(function () {
+        var translationRequired = requiresTranslation(defaultLocale, locale, locales);
+        var dialectTranslationRequired = translationRequired && isSameLanguage(defaultLocale, locale);
+        return [translationRequired, dialectTranslationRequired];
+    }, [defaultLocale, locale, locales]), translationRequired = _j[0], dialectTranslationRequired = _j[1];
     // tracking translations
-    var _k = (0, react_2.useState)(cacheUrl ? null : {}), translations = _k[0], setTranslations = _k[1];
-    // fetch from cache
-    (0, react_2.useEffect)(function () {
-        if (!translations) {
-            if (!translationRequired) {
-                setTranslations({}); // no translation required
-            }
-            else {
-                (function () { return __awaiter(_this, void 0, void 0, function () {
-                    var response, result, error_1;
-                    return __generator(this, function (_a) {
-                        switch (_a.label) {
-                            case 0:
-                                _a.trys.push([0, 3, , 4]);
-                                return [4 /*yield*/, fetch("".concat(cacheUrl, "/").concat(projectId, "/").concat(locale))];
-                            case 1:
-                                response = _a.sent();
-                                return [4 /*yield*/, response.json()];
-                            case 2:
-                                result = _a.sent();
-                                setTranslations(result);
-                                return [3 /*break*/, 4];
-                            case 3:
-                                error_1 = _a.sent();
-                                setTranslations({}); // not classified as a tx error, bc we can still fetch from API
-                                return [3 /*break*/, 4];
-                            case 4: return [2 /*return*/];
-                        }
-                    });
-                }); })();
-            }
-        }
-    }, [translationRequired, cacheUrl, projectId, locale]);
-    // translate function for dictionaries
-    var translate = (0, react_2.useCallback)(function (id, options) {
+    /** Key for translation tracking:
+     * Cache Loading            -> translations = null
+     * Cache Fail (for locale)  -> translations = {}
+     * Cache Fail (for id)      -> translations[id] = undefined
+     * Cache Fail (for hash)    -> translations[id][hash] = undefined
+     *
+     * API Loading              -> translations[id][hash] = TranslationLoading
+     * API Fail (for batch)     -> translations[id][hash] = TranslationError
+     * API Fail (for hash)      -> translations[id][hash] = TranslationError
+     *
+     * Success (Cache/API)      -> translations[id][hash] = TranslationSuccess
+     *
+     * Possible scenarios:
+     * Cache Loading -> Success
+     * Cache Loading -> Cache Fail -> API Loading -> Success
+     * Cache Loading -> Cache Fail -> API Loading -> API Fail
+     */
+    var _k = useState((cacheUrl && translationRequired) ? null : {}), translations = _k[0], setTranslations = _k[1];
+    // ----- CHECK CACHE FOR TX ----- //
+    useEffect(function () {
+        // check if cache fetch is necessary
+        if (translations || !translationRequired)
+            return;
+        // fetch translations from cache
+        (function () { return __awaiter(_this, void 0, void 0, function () {
+            var response, result, parsedResult, error_1;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 3, , 4]);
+                        return [4 /*yield*/, fetch("".concat(cacheUrl, "/").concat(projectId, "/").concat(locale))];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.json()];
+                    case 2:
+                        result = _a.sent();
+                        parsedResult = Object.entries(result).reduce(function (acc, _a) {
+                            var id = _a[0], hashToTranslation = _a[1];
+                            acc[id] = Object.entries(hashToTranslation).reduce(function (acc, _a) {
+                                var hash = _a[0], content = _a[1];
+                                acc[hash] = { state: 'success', entry: content };
+                                return acc;
+                            }, {});
+                            return acc;
+                        }, {});
+                        setTranslations(parsedResult);
+                        return [3 /*break*/, 4];
+                    case 3:
+                        error_1 = _a.sent();
+                        setTranslations({}); // not classified as a tx error, bc we can still fetch from API
+                        return [3 /*break*/, 4];
+                    case 4: return [2 /*return*/];
+                }
+            });
+        }); })();
+    }, [translations, translationRequired, cacheUrl, projectId, locale]);
+    // ----- PERFORM DICTIONARY TRANSLATION ----- //
+    // Flatten dictionaries for processing while waiting for translations
+    var flattenedDictionary = useMemo(function () { return flattenDictionary(dictionary); }, [dictionary]);
+    var stringData = useMemo(function () {
+        if (!translationRequired)
+            return {};
+        return Object.entries(flattenedDictionary).filter(function (_a) {
+            var _ = _a[0], entryWithMetadata = _a[1];
+            var entry = extractEntryMetadata(entryWithMetadata).entry;
+            if (typeof entry === 'string')
+                return true;
+        }).reduce(function (acc, _a) {
+            var id = _a[0], entryWithMetadata = _a[1];
+            var _b = extractEntryMetadata(entryWithMetadata), entry = _b.entry, metadata = _b.metadata;
+            var context = metadata === null || metadata === void 0 ? void 0 : metadata.context;
+            var source = splitStringToContent(entry);
+            var hash = hashJsxChildren(__assign({ source: source }, (context && { context: context })));
+            acc[id] = { source: source, hash: hash };
+            return acc;
+        }, {});
+    }, [flattenedDictionary, translationRequired]);
+    var _l = useMemo(function () {
+        var stringIsLoading = false;
+        var unresolvedDictionaryStringsAndHashes = Object.entries(stringData).filter(function (_a) {
+            var _b, _c, _d;
+            var id = _a[0], hash = _a[1].hash;
+            if (((_c = (_b = translations === null || translations === void 0 ? void 0 : translations[id]) === null || _b === void 0 ? void 0 : _b[hash]) === null || _c === void 0 ? void 0 : _c.state) === 'loading')
+                stringIsLoading = true;
+            return !((_d = translations === null || translations === void 0 ? void 0 : translations[id]) === null || _d === void 0 ? void 0 : _d[hash]);
+        });
+        var dictionaryStringsResolved = !stringIsLoading && unresolvedDictionaryStringsAndHashes.length === 0;
+        return [unresolvedDictionaryStringsAndHashes, dictionaryStringsResolved];
+    }, [translations, stringData]), unresolvedDictionaryStringsAndHashes = _l[0], dictionaryStringsResolved = _l[1];
+    // do translation strings (API)
+    // this useEffect is for translating strings in the dictionary before the page loads
+    // page will block until strings are loaded (so errors or translations)
+    useEffect(function () {
+        // tx required or dict strings already resolved
+        if (!translationRequired || !unresolvedDictionaryStringsAndHashes.length)
+            return;
+        // iterate through unresolvedDictionaryStringsAndHashes
+        unresolvedDictionaryStringsAndHashes.forEach(function (_a) {
+            var id = _a[0], _b = _a[1], hash = _b.hash, source = _b.source;
+            var metadata = extractEntryMetadata(flattenedDictionary[id]).metadata;
+            // Translate the content
+            translateContent({
+                source: source,
+                targetLocale: locale,
+                metadata: __assign(__assign({}, metadata), { id: id, hash: hash })
+            });
+        });
+        // is this already translated? if so, skip
+    }, [translationRequired, unresolvedDictionaryStringsAndHashes, flattenedDictionary]);
+    // ----- TRANSLATE FUNCTION FOR DICTIONARIES ----- //
+    var translateDictionaryEntry = useCallback(function (id, options) {
+        // ----- SETUP ----- //
         var _a;
         if (options === void 0) { options = {}; }
         // get the dictionary entry
-        var dictionaryEntry = (0, getDictionaryEntry_1.default)(dictionary, id);
-        if (dictionaryEntry === undefined ||
-            dictionaryEntry === null ||
-            (typeof dictionaryEntry === "object" && !Array.isArray(dictionaryEntry))) {
-            console.warn((0, createErrors_1.createLibraryNoEntryWarning)(id));
-            return undefined;
+        var dictionaryEntry = getDictionaryEntry(flattenedDictionary, id);
+        if (dictionaryEntry === undefined) {
+            return undefined; // dictionary entry not found
         }
-        var _b = (0, extractEntryMetadata_1.default)(dictionaryEntry), entry = _b.entry, metadata = _b.metadata;
-        // Get variables and variable options
+        // Parse the dictionary entry
+        var _b = extractEntryMetadata(dictionaryEntry), entry = _b.entry, metadata = _b.metadata;
         var variables = options;
         var variablesOptions = metadata === null || metadata === void 0 ? void 0 : metadata.variablesOptions;
-        var taggedEntry = (0, internal_1.addGTIdentifier)(entry, id);
-        // ----- RENDER METHODS ----- //
-        // render default locale string
-        var renderDefaultContent = function () {
-            return (0, generaltranslation_1.renderContentToString)(taggedEntry, defaultLocale, variables, variablesOptions);
-        };
-        // render default locale
-        var renderDefaultLocale = function () {
-            if (typeof taggedEntry === 'string')
-                return renderDefaultContent();
-            return (0, renderDefaultChildren_1.default)({
-                children: taggedEntry,
-                variables: variables,
-                variablesOptions: variablesOptions,
-                defaultLocale: defaultLocale,
-                renderVariable: renderVariable_1.default
-            });
-        };
-        // render skeleton
-        var renderLoadingSkeleton = function () {
-            if (typeof taggedEntry === 'string')
-                return renderDefaultContent();
-            return (0, renderSkeleton_1.default)({
-                children: taggedEntry,
-                variables: variables,
-                defaultLocale: defaultLocale,
-                renderVariable: renderVariable_1.default
-            });
-        };
-        // default behavior (skeleton except when language is same ie en-US -> en-GB)
-        var renderDefault = function () {
-            if (regionalTranslationRequired)
-                return renderDefaultLocale();
-            return renderLoadingSkeleton();
-        };
-        // render translated content
-        var renderTranslation = function (target) {
-            if (typeof taggedEntry === 'string')
-                return (0, generaltranslation_1.renderContentToString)(target, [locale, defaultLocale], variables, variablesOptions);
-            return (0, renderTranslatedChildren_1.default)({
-                source: taggedEntry,
-                target: target,
-                variables: variables,
-                variablesOptions: variablesOptions,
-                locales: [locale, defaultLocale],
-                renderVariable: renderVariable_1.default
-            });
-        };
-        // ----- RENDER LOGIC ----- // 
-        // If no translations are required
-        if (!translationRequired) {
-            renderDefaultLocale();
-        }
-        // get hash
-        var context = metadata === null || metadata === void 0 ? void 0 : metadata.context;
-        var childrenAsObjects = (0, internal_1.writeChildrenAsObjects)(taggedEntry);
-        var hash = (0, id_1.hashJsxChildren)(context
-            ? { source: childrenAsObjects, context: context }
-            : { source: childrenAsObjects });
-        // error behavior -> fallback to default language
-        if ((0, internal_1.isTranslationError)(translations === null || translations === void 0 ? void 0 : translations[id])) {
-            return renderDefaultLocale();
-        }
-        // loading
-        if (!translations || !((_a = translations[id]) === null || _a === void 0 ? void 0 : _a[hash])) {
-            if (renderSettings.method === 'skeleton') {
-                return renderLoadingSkeleton();
-            }
-            if (renderSettings.method === 'replace') {
-                return renderDefaultLocale();
+        // ----- RENDER STRINGS ----- //
+        if (typeof entry === 'string') { // render strings
+            // no translation required
+            var source = splitStringToContent(entry);
+            if (!translationRequired) {
+                return renderContentToString(source, locales, variables, variablesOptions);
             }
-            if (renderSettings.method === 'subtle') {
-                return renderDefaultLocale();
+            // get translation entry
+            var context = metadata === null || metadata === void 0 ? void 0 : metadata.context;
+            var hash = (metadata === null || metadata === void 0 ? void 0 : metadata.hash) || hashJsxChildren(__assign({ source: source }, (context && { context: context })));
+            var translationEntry = (_a = translations === null || translations === void 0 ? void 0 : translations[id]) === null || _a === void 0 ? void 0 : _a[hash];
+            // error behavior
+            if (!translationEntry || (translationEntry === null || translationEntry === void 0 ? void 0 : translationEntry.state) !== 'success') {
+                return renderContentToString(source, locales, variables, variablesOptions);
             }
-            return renderDefault(); // default
+            // render translated content
+            return renderContentToString(translationEntry.entry, [locale, defaultLocale], variables, variablesOptions);
         }
-        // render translated content
-        var target = translations[id][hash];
-        return renderTranslation(target);
-    }, [dictionary, translations, translationRequired, defaultLocale]);
-    var _l = (0, useRuntimeTranslation_1.default)(__assign({ targetLocale: locale, projectId: projectId, defaultLocale: defaultLocale, devApiKey: devApiKey, runtimeUrl: runtimeUrl, setTranslations: setTranslations }, metadata)), translateChildren = _l.translateChildren, translateContent = _l.translateContent, translationEnabled = _l.translationEnabled;
-    return ((0, jsx_runtime_1.jsx)(GTContext_1.GTContext.Provider, { value: {
-            translate: translate,
+        // ----- RENDER JSX ----- //
+        return _jsx(T, __assign({ id: id, variables: variables, variablesOptions: variablesOptions }, metadata, { children: entry }));
+    }, [dictionary, translations, translationRequired, defaultLocale, flattenedDictionary, dictionaryStringsResolved]);
+    var _m = useRuntimeTranslation(__assign({ targetLocale: locale, projectId: projectId, defaultLocale: defaultLocale, devApiKey: devApiKey, runtimeUrl: runtimeUrl, setTranslations: setTranslations }, metadata)), translateChildren = _m.translateChildren, translateContent = _m.translateContent, translationEnabled = _m.translationEnabled;
+    // hang until cache response, then render translations or loading state (when waiting on API response)
+    return (_jsx(GTContext.Provider, { value: {
+            translateDictionaryEntry: translateDictionaryEntry,
             translateContent: translateContent,
             translateChildren: translateChildren,
             locale: locale,
             defaultLocale: defaultLocale,
+            dictionary: dictionary,
             translations: translations,
             translationRequired: translationRequired,
-            regionalTranslationRequired: regionalTranslationRequired,
+            dialectTranslationRequired: dialectTranslationRequired,
             projectId: projectId,
             translationEnabled: translationEnabled,
             renderSettings: renderSettings,
-        }, children: children }));
+        }, children: dictionaryStringsResolved && translations && children }));
 }
 //# sourceMappingURL=GTProvider.js.map