gt-react 4.0.11 → 4.0.13

package/dist/cookies/getLocaleCookie.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Function to get the value of a specific cookie by its name.
+ *
+ * @param {string} name - The name of the cookie to retrieve.
+ * @returns {string|null} - The value of the cookie, or null if not found.
+ */
+export default function getLocaleCookie(name?: string): string | null;
+//# sourceMappingURL=getLocaleCookie.d.ts.map

package/dist/cookies/getLocaleCookie.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getLocaleCookie.d.ts","sourceRoot":"","sources":["../../src/cookies/getLocaleCookie.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,eAAe,CAAC,IAAI,GAAE,MAAyB,GAAG,MAAM,GAAG,IAAI,CAkBtF"}

package/dist/cookies/getLocaleCookie.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = getLocaleCookie;
+var primitives_1 = require("../primitives/primitives");
+/**
+ * Function to get the value of a specific cookie by its name.
+ *
+ * @param {string} name - The name of the cookie to retrieve.
+ * @returns {string|null} - The value of the cookie, or null if not found.
+ */
+function getLocaleCookie(name) {
+    if (name === void 0) { name = primitives_1.localeCookieName; }
+    var cookieString = document.cookie;
+    // Split the cookies string by "; " to get an array of "key=value" strings
+    var cookiesArray = cookieString.split("; ");
+    // Loop through the array to find the cookie with the specified name
+    for (var _i = 0, cookiesArray_1 = cookiesArray; _i < cookiesArray_1.length; _i++) {
+        var cookie = cookiesArray_1[_i];
+        var _a = cookie.split("="), cookieName = _a[0], cookieValue = _a[1];
+        // Check if this cookie has the name we are looking for
+        if (cookieName === name) {
+            return decodeURIComponent(cookieValue);
+        }
+    }
+    // If the cookie is not found, return null
+    return null;
+}
+//# sourceMappingURL=getLocaleCookie.js.map

package/dist/cookies/getLocaleCookie.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getLocaleCookie.js","sourceRoot":"","sources":["../../src/cookies/getLocaleCookie.ts"],"names":[],"mappings":";;AAQA,kCAkBC;AA1BD,uDAA4D;AAE5D;;;;;GAKG;AACH,SAAwB,eAAe,CAAC,IAA+B;IAA/B,qBAAA,EAAA,OAAe,6BAAgB;IACnE,IAAM,YAAY,GAAG,QAAQ,CAAC,MAAM,CAAC;IAErC,0EAA0E;IAC1E,IAAM,YAAY,GAAG,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAE9C,oEAAoE;IACpE,KAAmB,UAAY,EAAZ,6BAAY,EAAZ,0BAAY,EAAZ,IAAY,EAAE,CAAC;QAA7B,IAAI,MAAM,qBAAA;QACP,IAAA,KAA4B,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,EAA5C,UAAU,QAAA,EAAE,WAAW,QAAqB,CAAC;QAEpD,uDAAuD;QACvD,IAAI,UAAU,KAAK,IAAI,EAAE,CAAC;YACxB,OAAO,kBAAkB,CAAC,WAAW,CAAC,CAAC;QACzC,CAAC;IACH,CAAC;IAED,0CAA0C;IAC1C,OAAO,IAAI,CAAC;AAChB,CAAC"}

package/dist/hooks/useBrowserLocale.d.ts

@@ -1,7 +1,22 @@
 /**
- * Custom hook to get the browser's default language.
- * @param {string} defaultLocale - The default locale to use if browser locale is not available.
- * @returns {string} The default language of the browser.
+ * Hook to retrieve the browser's default language, with support for a fallback and locale stored in a cookie.
+ *
+ * @param {string} [defaultLocale=libraryDefaultLocale] - The default locale to use if the browser locale is not available.
+ * @param {string} [cookieName=localeCookieName] - The name of the cookie to check for a stored locale. If omitted, no cookie is used.
+ * @returns {string} The resolved browser locale, either from the cookie, browser settings, or the default locale.
+ *
+ * @example
+ * const browserLocale = useBrowserLocale('en-US');
+ * console.log(browserLocale); // Outputs the browser's locale, or 'en-US' if unavailable
+ *
+ * @example
+ * const browserLocale = useBrowserLocale('fr', 'localeCookie');
+ * console.log(browserLocale); // Outputs locale from cookie 'localeCookie' if available, or browser's locale otherwise
+ *
+ * @description
+ * This hook attempts to determine the browser's preferred language. If a locale is stored in a cookie (specified by `cookieName`),
+ * it will take precedence. If not, it falls back to the `navigator.language` or `navigator.userLanguage`. If none of these are available,
+ * the provided `defaultLocale` is used.
  */
-export default function useBrowserLocale(defaultLocale?: string): string;
+export default function useBrowserLocale(defaultLocale?: string, cookieName?: string): string;
 //# sourceMappingURL=useBrowserLocale.d.ts.map

package/dist/hooks/useBrowserLocale.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useBrowserLocale.d.ts","sourceRoot":"","sources":["../../src/hooks/useBrowserLocale.ts"],"names":[],"mappings":"AA+BA;;;;GAIG;AACH,MAAM,CAAC,OAAO,UAAU,gBAAgB,CAAC,aAAa,GAAE,MAA6B,GAAG,MAAM,CAQ7F"}
+{"version":3,"file":"useBrowserLocale.d.ts","sourceRoot":"","sources":["../../src/hooks/useBrowserLocale.ts"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,CAAC,OAAO,UAAU,gBAAgB,CAAC,aAAa,GAAE,MAA6B,EAAE,UAAU,GAAE,MAAyB,GAAG,MAAM,CAOpI"}

package/dist/hooks/useBrowserLocale.js

@@ -1,42 +1,39 @@
 "use strict";
 'use client';
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = useBrowserLocale;
 var react_1 = require("react");
 var primitives_1 = require("../primitives/primitives");
+var getLocaleCookie_1 = __importDefault(require("../cookies/getLocaleCookie"));
 /**
- * Function to get the value of a specific cookie by its name.
+ * Hook to retrieve the browser's default language, with support for a fallback and locale stored in a cookie.
  *
- * @param {string} name - The name of the cookie to retrieve.
- * @returns {string|null} - The value of the cookie, or null if not found.
- */
-function getCookieValue(name) {
-    var cookieString = document.cookie;
-    // Split the cookies string by "; " to get an array of "key=value" strings
-    var cookiesArray = cookieString.split("; ");
-    // Loop through the array to find the cookie with the specified name
-    for (var _i = 0, cookiesArray_1 = cookiesArray; _i < cookiesArray_1.length; _i++) {
-        var cookie = cookiesArray_1[_i];
-        var _a = cookie.split("="), cookieName = _a[0], cookieValue = _a[1];
-        // Check if this cookie has the name we are looking for
-        if (cookieName === name) {
-            return decodeURIComponent(cookieValue);
-        }
-    }
-    // If the cookie is not found, return null
-    return null;
-}
-/**
- * Custom hook to get the browser's default language.
- * @param {string} defaultLocale - The default locale to use if browser locale is not available.
- * @returns {string} The default language of the browser.
+ * @param {string} [defaultLocale=libraryDefaultLocale] - The default locale to use if the browser locale is not available.
+ * @param {string} [cookieName=localeCookieName] - The name of the cookie to check for a stored locale. If omitted, no cookie is used.
+ * @returns {string} The resolved browser locale, either from the cookie, browser settings, or the default locale.
+ *
+ * @example
+ * const browserLocale = useBrowserLocale('en-US');
+ * console.log(browserLocale); // Outputs the browser's locale, or 'en-US' if unavailable
+ *
+ * @example
+ * const browserLocale = useBrowserLocale('fr', 'localeCookie');
+ * console.log(browserLocale); // Outputs locale from cookie 'localeCookie' if available, or browser's locale otherwise
+ *
+ * @description
+ * This hook attempts to determine the browser's preferred language. If a locale is stored in a cookie (specified by `cookieName`),
+ * it will take precedence. If not, it falls back to the `navigator.language` or `navigator.userLanguage`. If none of these are available,
+ * the provided `defaultLocale` is used.
  */
-function useBrowserLocale(defaultLocale) {
+function useBrowserLocale(defaultLocale, cookieName) {
     if (defaultLocale === void 0) { defaultLocale = primitives_1.libraryDefaultLocale; }
+    if (cookieName === void 0) { cookieName = primitives_1.localeCookieName; }
     var _a = (0, react_1.useState)(''), locale = _a[0], setLocale = _a[1];
     (0, react_1.useEffect)(function () {
-        var localeFromCookie = getCookieValue(primitives_1.localeCookieName);
-        var browserLocale = localeFromCookie || navigator.language || (navigator === null || navigator === void 0 ? void 0 : navigator.userLanguage) || defaultLocale;
+        var browserLocale = (cookieName ? (0, getLocaleCookie_1.default)(cookieName) : undefined) || navigator.language || (navigator === null || navigator === void 0 ? void 0 : navigator.userLanguage) || defaultLocale;
         setLocale(browserLocale);
     }, [defaultLocale]);
     return locale;

package/dist/hooks/useBrowserLocale.js.map

@@ -1 +1 @@
-{"version":3,"file":"useBrowserLocale.js","sourceRoot":"","sources":["../../src/hooks/useBrowserLocale.ts"],"names":[],"mappings":";AAAA,YAAY,CAAA;;AAoCZ,mCAQC;AA1CD,+BAA4C;AAC5C,uDAAkF;AAElF;;;;;GAKG;AACH,SAAS,cAAc,CAAC,IAAY;IAChC,IAAM,YAAY,GAAG,QAAQ,CAAC,MAAM,CAAC;IAErC,0EAA0E;IAC1E,IAAM,YAAY,GAAG,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAE9C,oEAAoE;IACpE,KAAmB,UAAY,EAAZ,6BAAY,EAAZ,0BAAY,EAAZ,IAAY,EAAE,CAAC;QAA7B,IAAI,MAAM,qBAAA;QACP,IAAA,KAA4B,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,EAA5C,UAAU,QAAA,EAAE,WAAW,QAAqB,CAAC;QAEpD,uDAAuD;QACvD,IAAI,UAAU,KAAK,IAAI,EAAE,CAAC;YACxB,OAAO,kBAAkB,CAAC,WAAW,CAAC,CAAC;QACzC,CAAC;IACH,CAAC;IAED,0CAA0C;IAC1C,OAAO,IAAI,CAAC;AAChB,CAAC;AAED;;;;GAIG;AACH,SAAwB,gBAAgB,CAAC,aAA4C;IAA5C,8BAAA,EAAA,gBAAwB,iCAAoB;IAC3E,IAAA,KAAsB,IAAA,gBAAQ,EAAS,EAAE,CAAC,EAAzC,MAAM,QAAA,EAAE,SAAS,QAAwB,CAAC;IACjD,IAAA,iBAAS,EAAC;QACN,IAAM,gBAAgB,GAAG,cAAc,CAAC,6BAAgB,CAAC,CAAC;QAC1D,IAAM,aAAa,GAAG,gBAAgB,IAAI,SAAS,CAAC,QAAQ,KAAK,SAAiB,aAAjB,SAAS,uBAAT,SAAS,CAAU,YAAY,CAAA,IAAI,aAAa,CAAC;QAClH,SAAS,CAAC,aAAa,CAAC,CAAC;IAC7B,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC;IACpB,OAAO,MAAM,CAAC;AAClB,CAAC"}
+{"version":3,"file":"useBrowserLocale.js","sourceRoot":"","sources":["../../src/hooks/useBrowserLocale.ts"],"names":[],"mappings":";AAAA,YAAY,CAAA;;;;;AA0BZ,mCAOC;AA/BD,+BAA4C;AAC5C,uDAAkF;AAClF,+EAAyD;AAEzD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,SAAwB,gBAAgB,CAAC,aAA4C,EAAE,UAAqC;IAAnF,8BAAA,EAAA,gBAAwB,iCAAoB;IAAE,2BAAA,EAAA,aAAqB,6BAAgB;IAClH,IAAA,KAAsB,IAAA,gBAAQ,EAAS,EAAE,CAAC,EAAzC,MAAM,QAAA,EAAE,SAAS,QAAwB,CAAC;IACjD,IAAA,iBAAS,EAAC;QACN,IAAM,aAAa,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,IAAA,yBAAe,EAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,SAAS,CAAC,QAAQ,KAAK,SAAiB,aAAjB,SAAS,uBAAT,SAAS,CAAU,YAAY,CAAA,IAAI,aAAa,CAAC;QACxJ,SAAS,CAAC,aAAa,CAAC,CAAC;IAC7B,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC;IACpB,OAAO,MAAM,CAAC;AAClB,CAAC"}

package/dist/hooks/useDefaultLocale.d.ts

@@ -1,5 +1,13 @@
 /**
- * @returns {string} The default locale.
+ * Retrieves the application's default locale from the `<GTProvider>` context.
+ *
+ * If no default locale is passed to the `<GTProvider>`, it defaults to providing 'en'.
+ *
+ * @returns {string} The application's default locale, e.g., 'en-US'.
+ *
+ * @example
+ * const locale = useDefaultLocale();
+ * console.log(locale); // 'en-US'
  */
 export default function useDefaultLocale(): string;
 //# sourceMappingURL=useDefaultLocale.d.ts.map

package/dist/hooks/useDefaultLocale.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useDefaultLocale.d.ts","sourceRoot":"","sources":["../../src/hooks/useDefaultLocale.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,MAAM,CAAC,OAAO,UAAU,gBAAgB,IAAI,MAAM,CAIjD"}
+{"version":3,"file":"useDefaultLocale.d.ts","sourceRoot":"","sources":["../../src/hooks/useDefaultLocale.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;GAUG;AACH,MAAM,CAAC,OAAO,UAAU,gBAAgB,IAAI,MAAM,CAIjD"}

package/dist/hooks/useDefaultLocale.js

@@ -7,7 +7,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = useDefaultLocale;
 var GTContext_1 = __importDefault(require("../provider/GTContext"));
 /**
- * @returns {string} The default locale.
+ * Retrieves the application's default locale from the `<GTProvider>` context.
+ *
+ * If no default locale is passed to the `<GTProvider>`, it defaults to providing 'en'.
+ *
+ * @returns {string} The application's default locale, e.g., 'en-US'.
+ *
+ * @example
+ * const locale = useDefaultLocale();
+ * console.log(locale); // 'en-US'
  */
 function useDefaultLocale() {
     return (0, GTContext_1.default)("useDefaultLocale(): Unable to access default locale outside of a <GTProvider>").defaultLocale;

package/dist/hooks/useDefaultLocale.js.map

@@ -1 +1 @@
-{"version":3,"file":"useDefaultLocale.js","sourceRoot":"","sources":["../../src/hooks/useDefaultLocale.ts"],"names":[],"mappings":";AAAA,YAAY,CAAA;;;;;AAOZ,mCAIC;AATD,oEAAiD;AAEjD;;GAEG;AACH,SAAwB,gBAAgB;IACpC,OAAO,IAAA,mBAAY,EACf,+EAA+E,CAClF,CAAC,aAAa,CAAC;AACpB,CAAC"}
+{"version":3,"file":"useDefaultLocale.js","sourceRoot":"","sources":["../../src/hooks/useDefaultLocale.ts"],"names":[],"mappings":";AAAA,YAAY,CAAA;;;;;AAeZ,mCAIC;AAjBD,oEAAiD;AAEjD;;;;;;;;;;GAUG;AACH,SAAwB,gBAAgB;IACpC,OAAO,IAAA,mBAAY,EACf,+EAA+E,CAClF,CAAC,aAAa,CAAC;AACpB,CAAC"}

package/dist/hooks/useGT.d.ts

@@ -1,11 +1,16 @@
 import { ReactNode } from "react";
 /**
- * Custom hook to provide a translation function using a given context.
- *
- * This hook allows for optional prefixing of translation keys with a provided `id`.
+ * Gets the translation function `t` provided by `<GTProvider>`.
  *
  * @param {string} [id] - Optional prefix to prepend to the translation keys.
  * @returns {Function} A translation function that accepts a key string and returns the translated value.
+ *
+ * @example
+ * const t = useGT('user');
+ * console.log(t('name')); // Translates item 'user.name'
+ *
+ * const t = useTranslation();
+ * console.log(t('hello')); // Translates item 'hello'
  */
 export default function useGT(id?: string): (id: string, options?: Record<string, any>, f?: Function) => ReactNode;
 //# sourceMappingURL=useGT.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"useGT.d.ts","sourceRoot":"","sources":["../../src/hooks/useGT.ts"],"names":[],"mappings":"AAEA,OAAc,EAAE,SAAS,EAAe,MAAM,OAAO,CAAC;AAGtD;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,UAAU,KAAK,CAAC,EAAE,GAAE,MAAW,GACzC,CACI,EAAE,EAAE,MAAM,EACV,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC7B,CAAC,CAAC,EAAE,QAAQ,KACX,SAAS,CAuBjB"}
+{"version":3,"file":"useGT.d.ts","sourceRoot":"","sources":["../../src/hooks/useGT.ts"],"names":[],"mappings":"AAEA,OAAc,EAAE,SAAS,EAAe,MAAM,OAAO,CAAC;AAGtD;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,OAAO,UAAU,KAAK,CAAC,EAAE,GAAE,MAAW,GACzC,CACI,EAAE,EAAE,MAAM,EACV,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC7B,CAAC,CAAC,EAAE,QAAQ,KACX,SAAS,CAuBjB"}

package/dist/hooks/useGT.js

@@ -7,12 +7,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = useGT;
 var GTContext_1 = __importDefault(require("../provider/GTContext"));
 /**
- * Custom hook to provide a translation function using a given context.
- *
- * This hook allows for optional prefixing of translation keys with a provided `id`.
+ * Gets the translation function `t` provided by `<GTProvider>`.
  *
  * @param {string} [id] - Optional prefix to prepend to the translation keys.
  * @returns {Function} A translation function that accepts a key string and returns the translated value.
+ *
+ * @example
+ * const t = useGT('user');
+ * console.log(t('name')); // Translates item 'user.name'
+ *
+ * const t = useTranslation();
+ * console.log(t('hello')); // Translates item 'hello'
  */
 function useGT(id) {
     if (id === void 0) { id = ''; }

package/dist/hooks/useGT.js.map

@@ -1 +1 @@
-{"version":3,"file":"useGT.js","sourceRoot":"","sources":["../../src/hooks/useGT.ts"],"names":[],"mappings":";AAAA,YAAY,CAAA;;;;;AAaZ,wBA4BC;AAtCD,oEAAiD;AAEjD;;;;;;;GAOG;AACH,SAAwB,KAAK,CAAC,EAAe;IAAf,mBAAA,EAAA,OAAe;IAOzC,4DAA4D;IAC5D,IAAM,KAAK,GAAG,UAAC,MAAc;QACzB,IAAI,EAAE,IAAI,MAAM;YAAE,OAAO,UAAG,EAAE,cAAI,MAAM,CAAE,CAAC;QAC3C,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC;IAC5B,CAAC,CAAA;IAED,8BAA8B;IACtB,IAAA,SAAS,GAAK,IAAA,mBAAY,EAC9B,iBAAU,EAAE,gIAA6H,CAC5I,UAFgB,CAEf;IAEF,gFAAgF;IAChF,OAAO,UAAC,EAAe,EAAE,OAGnB,EAAE,CAAY;QAHZ,mBAAA,EAAA,OAAe;QAAE,wBAAA,EAAA,YAGnB;QACF,IAAM,UAAU,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC;QAC7B,IAAM,WAAW,GAAG,SAAS,CAAC,UAAU,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;QACtD,IAAI,CAAC,WAAW;YAAE,OAAO,CAAC,IAAI,CAAC,aAAM,EAAE,2DAAiD,UAAU,OAAI,CAAC,CAAA;QACvG,OAAO,WAAW,CAAC;IACvB,CAAC,CAAC;AACN,CAAC"}
+{"version":3,"file":"useGT.js","sourceRoot":"","sources":["../../src/hooks/useGT.ts"],"names":[],"mappings":";AAAA,YAAY,CAAA;;;;;AAkBZ,wBA4BC;AA3CD,oEAAiD;AAEjD;;;;;;;;;;;;GAYG;AACH,SAAwB,KAAK,CAAC,EAAe;IAAf,mBAAA,EAAA,OAAe;IAOzC,4DAA4D;IAC5D,IAAM,KAAK,GAAG,UAAC,MAAc;QACzB,IAAI,EAAE,IAAI,MAAM;YAAE,OAAO,UAAG,EAAE,cAAI,MAAM,CAAE,CAAC;QAC3C,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC;IAC5B,CAAC,CAAA;IAED,8BAA8B;IACtB,IAAA,SAAS,GAAK,IAAA,mBAAY,EAC9B,iBAAU,EAAE,gIAA6H,CAC5I,UAFgB,CAEf;IAEF,gFAAgF;IAChF,OAAO,UAAC,EAAe,EAAE,OAGnB,EAAE,CAAY;QAHZ,mBAAA,EAAA,OAAe;QAAE,wBAAA,EAAA,YAGnB;QACF,IAAM,UAAU,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC;QAC7B,IAAM,WAAW,GAAG,SAAS,CAAC,UAAU,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;QACtD,IAAI,CAAC,WAAW;YAAE,OAAO,CAAC,IAAI,CAAC,aAAM,EAAE,2DAAiD,UAAU,OAAI,CAAC,CAAA;QACvG,OAAO,WAAW,CAAC;IACvB,CAAC,CAAC;AACN,CAAC"}

package/dist/hooks/useLocale.d.ts

@@ -1,5 +1,11 @@
 /**
- * @returns {string} The user's locale.
+ * Retrieves the user's locale from the `<GTProvider>` context.
+ *
+ * @returns {string} The user's locale, e.g., 'en-US'.
+ *
+ * @example
+ * const locale = useLocale();
+ * console.log(locale); // 'en-US'
  */
 export default function useLocale(): string;
 //# sourceMappingURL=useLocale.d.ts.map

package/dist/hooks/useLocale.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useLocale.d.ts","sourceRoot":"","sources":["../../src/hooks/useLocale.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,MAAM,CAAC,OAAO,UAAU,SAAS,IAAI,MAAM,CAI1C"}
+{"version":3,"file":"useLocale.d.ts","sourceRoot":"","sources":["../../src/hooks/useLocale.ts"],"names":[],"mappings":"AAIA;;;;;;;;GAQG;AACH,MAAM,CAAC,OAAO,UAAU,SAAS,IAAI,MAAM,CAI1C"}

package/dist/hooks/useLocale.js

@@ -7,7 +7,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = useLocale;
 var GTContext_1 = __importDefault(require("../provider/GTContext"));
 /**
- * @returns {string} The user's locale.
+ * Retrieves the user's locale from the `<GTProvider>` context.
+ *
+ * @returns {string} The user's locale, e.g., 'en-US'.
+ *
+ * @example
+ * const locale = useLocale();
+ * console.log(locale); // 'en-US'
  */
 function useLocale() {
     return (0, GTContext_1.default)("useLocale(): Unable to access user's locale outside of a <GTProvider>").locale;

package/dist/hooks/useLocale.js.map

@@ -1 +1 @@
-{"version":3,"file":"useLocale.js","sourceRoot":"","sources":["../../src/hooks/useLocale.ts"],"names":[],"mappings":";AAAA,YAAY,CAAA;;;;;AAOZ,4BAIC;AATD,oEAAiD;AAEjD;;GAEG;AACH,SAAwB,SAAS;IAC7B,OAAO,IAAA,mBAAY,EACf,uEAAuE,CAC1E,CAAC,MAAM,CAAC;AACb,CAAC"}
+{"version":3,"file":"useLocale.js","sourceRoot":"","sources":["../../src/hooks/useLocale.ts"],"names":[],"mappings":";AAAA,YAAY,CAAA;;;;;AAaZ,4BAIC;AAfD,oEAAiD;AAEjD;;;;;;;;GAQG;AACH,SAAwB,SAAS;IAC7B,OAAO,IAAA,mBAAY,EACf,uEAAuE,CAC1E,CAAC,MAAM,CAAC;AACb,CAAC"}

package/dist/provider/GTProvider.d.ts

@@ -1,4 +1,18 @@
 import { Dictionary } from "../primitives/types";
+/**
+ * Provides General Translation context to its children, which can then access `useGT`, `useLocale`, and `useDefaultLocale`.
+ *
+ * @param {React.ReactNode} children - The children components that will use the translation context.
+ * @param {string} [projectID] - The project ID required for General Translation cloud services.
+ * @param {Dictionary} [dictionary=defaultDictionary] - The translation dictionary for the project.
+ * @param {string} [dictionaryName=defaultDictionaryName] - The name of the translation dictionary.
+ * @param {string[]} [approvedLocales] - The list of approved locales for the project.
+ * @param {string} [defaultLocale=libraryDefaultLocale] - The default locale to use if no other locale is found.
+ * @param {string} [locale] - The current locale, if already set.
+ * @param {string} [cacheURL='https://cache.gtx.dev'] - The URL of the cache service for fetching translations.
+ *
+ * @returns {JSX.Element} The provider component for General Translation context.
+ */
 export default function GTProvider({ children, projectID, dictionary, dictionaryName, approvedLocales, defaultLocale, locale, cacheURL }: {
     children?: any;
     projectID?: string;

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

@@ -1 +1 @@
-{"version":3,"file":"GTProvider.d.ts","sourceRoot":"","sources":["../../src/provider/GTProvider.tsx"],"names":[],"mappings":"AASA,OAAO,EAAE,UAAU,EAAgC,MAAM,qBAAqB,CAAC;AAU/E,MAAM,CAAC,OAAO,UAAU,UAAU,CAAC,EAC/B,QAAQ,EACR,SAAS,EACT,UAA8B,EAC9B,cAAsC,EACtC,eAAe,EACf,aAA4D,EAC5D,MAAM,EACN,QAAkC,EACrC,EAAE;IACC,QAAQ,CAAC,EAAE,GAAG,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB,GAAG,GAAG,CAAC,OAAO,CA2Hd"}
+{"version":3,"file":"GTProvider.d.ts","sourceRoot":"","sources":["../../src/provider/GTProvider.tsx"],"names":[],"mappings":"AAOA,OAAO,EAAE,UAAU,EAAgC,MAAM,qBAAqB,CAAC;AAQ/E;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,OAAO,UAAU,UAAU,CAAC,EAC/B,QAAQ,EACR,SAAS,EACT,UAA8B,EAC9B,cAAsC,EACtC,eAAe,EACf,aAA4D,EAC5D,MAAM,EACN,QAAkC,EACrC,EAAE;IACC,QAAQ,CAAC,EAAE,GAAG,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB,GAAG,GAAG,CAAC,OAAO,CA8Hd"}

package/dist/provider/GTProvider.js

@@ -53,7 +53,20 @@ var extractEntryMetadata_1 = __importDefault(require("./helpers/extractEntryMeta
 var renderDefaultChildren_1 = __importDefault(require("./rendering/renderDefaultChildren"));
 var getPluralBranch_1 = __importDefault(require("../plurals/getPluralBranch"));
 var renderTranslatedChildren_1 = __importDefault(require("./rendering/renderTranslatedChildren"));
-// intended for purely client-side apps, put at the root of the project
+/**
+ * Provides General Translation context to its children, which can then access `useGT`, `useLocale`, and `useDefaultLocale`.
+ *
+ * @param {React.ReactNode} children - The children components that will use the translation context.
+ * @param {string} [projectID] - The project ID required for General Translation cloud services.
+ * @param {Dictionary} [dictionary=defaultDictionary] - The translation dictionary for the project.
+ * @param {string} [dictionaryName=defaultDictionaryName] - The name of the translation dictionary.
+ * @param {string[]} [approvedLocales] - The list of approved locales for the project.
+ * @param {string} [defaultLocale=libraryDefaultLocale] - The default locale to use if no other locale is found.
+ * @param {string} [locale] - The current locale, if already set.
+ * @param {string} [cacheURL='https://cache.gtx.dev'] - The URL of the cache service for fetching translations.
+ *
+ * @returns {JSX.Element} The provider component for General Translation context.
+ */
 function GTProvider(_a) {
     var _this = this;
     var children = _a.children, projectID = _a.projectID, _b = _a.dictionary, dictionary = _b === void 0 ? primitives_1.defaultDictionary : _b, _c = _a.dictionaryName, dictionaryName = _c === void 0 ? primitives_1.defaultDictionaryName : _c, approvedLocales = _a.approvedLocales, _d = _a.defaultLocale, defaultLocale = _d === void 0 ? (approvedLocales === null || approvedLocales === void 0 ? void 0 : approvedLocales[0]) || primitives_1.libraryDefaultLocale : _d, locale = _a.locale, _e = _a.cacheURL, cacheURL = _e === void 0 ? 'https://cache.gtx.dev' : _e;
@@ -62,6 +75,9 @@ function GTProvider(_a) {
     }
     var browserLocale = (0, useBrowserLocale_1.default)(defaultLocale);
     locale = locale || browserLocale;
+    if (approvedLocales) {
+        locale = (0, generaltranslation_1.determineLanguage)([locale, browserLocale], approvedLocales) || locale;
+    }
     var translationRequired = (0, generaltranslation_1.isSameLanguage)(locale, defaultLocale) ? false : true;
     var _f = (0, react_1.useState)(cacheURL ? null : {}), translations = _f[0], setTranslations = _f[1];
     (0, react_1.useEffect)(function () {

package/dist/provider/GTProvider.js.map

@@ -1 +1 @@
-{"version":3,"file":"GTProvider.js","sourceRoot":"","sources":["../../src/provider/GTProvider.tsx"],"names":[],"mappings":";AAAA,YAAY,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmBZ,6BA6IC;;AA7JD,yDAA2E;AAE3E,+BAAuE;AACvE,+EAAyD;AACzD,uDAA6H;AAC7H,yCAAwC;AAExC,oFAA8D;AAC9D,wCAA8C;AAC9C,wFAAkE;AAClE,4FAAsE;AACtE,+EAAyD;AACzD,kGAA4E;AAE5E,uEAAuE;AAEvE,SAAwB,UAAU,CAAC,EAkBlC;IAlBD,iBA6IC;QA5IG,QAAQ,cAAA,EACR,SAAS,eAAA,EACT,kBAA8B,EAA9B,UAAU,mBAAG,8BAAiB,KAAA,EAC9B,sBAAsC,EAAtC,cAAc,mBAAG,kCAAqB,KAAA,EACtC,eAAe,qBAAA,EACf,qBAA4D,EAA5D,aAAa,mBAAG,CAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAG,CAAC,CAAC,KAAI,iCAAoB,KAAA,EAC5D,MAAM,YAAA,EACN,gBAAkC,EAAlC,QAAQ,mBAAG,uBAAuB,KAAA;IAYlC,IAAI,CAAC,SAAS,IAAI,QAAQ,KAAK,uBAAuB,EAAE,CAAC;QACrD,MAAM,IAAI,KAAK,CAAC,8HAA8H,CAAC,CAAA;IACnJ,CAAC;IAED,IAAM,aAAa,GAAG,IAAA,0BAAgB,EAAC,aAAa,CAAC,CAAC;IACtD,MAAM,GAAG,MAAM,IAAI,aAAa,CAAC;IAEjC,IAAM,mBAAmB,GAAG,IAAA,mCAAc,EAAC,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;IAE3E,IAAA,KAAkC,IAAA,gBAAQ,EAC5C,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CACvB,EAFM,YAAY,QAAA,EAAE,eAAe,QAEnC,CAAA;IAED,IAAA,iBAAS,EAAC;QACN,IAAI,CAAC,YAAY,EAAE,CAAC;YAChB,IAAI,CAAC,mBAAmB,EAAE,CAAC;gBACvB,eAAe,CAAC,EAAE,CAAC,CAAC,CAAC,0BAA0B;YACnD,CAAC;iBAAM,CAAC;gBACJ,CAAC;;;;oCACoB,qBAAM,KAAK,CAAC,UAAG,QAAQ,cAAI,SAAS,cAAI,MAAM,cAAI,cAAc,CAAE,CAAC,EAAA;;gCAA9E,QAAQ,GAAG,SAAmE;gCACrE,qBAAM,QAAQ,CAAC,IAAI,EAAE,EAAA;;gCAA9B,MAAM,GAAG,SAAqB;gCACpC,eAAe,CAAC,MAAM,CAAC,CAAC;;;;qBAC3B,CAAC,EAAE,CAAA;YACR,CAAC;QACL,CAAC;IACL,CAAC,EAAE,CAAC,YAAY,EAAE,mBAAmB,CAAC,CAAC,CAAA;IAEvC,IAAM,SAAS,GAAG,IAAA,mBAAW,EAAC,UAC1B,EAAU,EACV,OAAiC,EACjC,CAAY;;QADZ,wBAAA,EAAA,YAAiC;QAIjC,2BAA2B;QACvB,IAAA,KAAsB,IAAA,8BAAoB,EAC1C,IAAA,4BAAkB,EAAC,UAAU,EAAE,EAAE,CAAoB,CACxD,EAFK,KAAK,WAAA,EAAE,QAAQ,cAEpB,CAAC;QAEF,qCAAqC;QACrC,IAAI,SAAS,CAAC;QAAC,IAAI,gBAAgB,CAAC;QACpC,IAAI,OAAO,EAAE,CAAC;YACV,SAAS,GAAG,OAAO,CAAC;YACpB,IAAI,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,gBAAgB,EAAE,CAAC;gBAC7B,gBAAgB,GAAG,QAAQ,CAAC,gBAAgB,CAAC;YACjD,CAAC;QACL,CAAC;QAED,oCAAoC;QACpC,IAAI,OAAO,CAAC,KAAK,UAAU,EAAE,CAAC;YAC1B,KAAK,GAAG,CAAC,CAAC,OAAO,CAAiB,CAAC;QACvC,CAAC;aAAM,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;YACrC,KAAK,GAAG,KAAK,CAAC,OAAO,CAAiB,CAAC;QAC3C,CAAC;QAED,IAAM,WAAW,GAAG,IAAA,0BAAe,EAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QAErD,IAAI,MAAM,CAAC;QAEX,yEAAyE;QACzE,IAAM,QAAQ,GAAG,QAAQ,IAAI,8BAAiB,CAAC,IAAI,CAAC,UAAA,UAAU,IAAI,OAAA,UAAU,IAAI,QAAQ,EAAtB,CAAsB,CAAC,CAAC;QAC1F,IAAI,QAAQ,EAAE,CAAC;YACX,IAAI,OAAO,CAAA,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,CAAC,CAAA,KAAK,QAAQ;gBAChC,MAAM,IAAI,KAAK,CAAC,cAAM,EAAE,uCAAiC,CAAC,CAAA;YAC9D,MAAM,GAAG,IAAA,yBAAe,EACpB,SAAS,CAAC,CAAC,EACX,CAAC,MAAM,EAAE,aAAa,CAAC,EACvB,MAAA,WAAW,CAAC,KAAK,0CAAG,yBAAyB,EAAE,QAAQ,CAC1D,IAAI,WAAW,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,oCAAoC;QACzE,CAAC;aAAM,CAAC;YACJ,MAAM,GAAG,WAAW,CAAC;QACzB,CAAC;QAED,kCAAkC;QAClC,IAAI,CAAC,mBAAmB,EAAE,CAAC;YACvB,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;gBAClC,OAAO,IAAA,0CAAqB,EACxB,MAAM,EAAE,aAAa,EACrB,SAAS,EAAE,gBAAgB,CAC9B,CAAA;YACL,CAAC;YACD,OAAO,IAAA,+BAAqB,EAAC;gBACzB,KAAK,EAAE,MAAM;gBAAE,SAAS,WAAA;gBAAE,gBAAgB,kBAAA;aAC7C,CAAC,CAAA;QACN,CAAC;QAED,+BAA+B;QAC/B,IAAI,YAAY,EAAE,CAAC;YACf,IAAM,WAAW,GAAG,YAAY,CAAC,EAAE,CAAC,CAAC;YACrC,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;gBAClC,OAAO,IAAA,0CAAqB,EACxB,WAAW,CAAC,CAAQ,EAAE,CAAC,MAAM,EAAE,aAAa,CAAC,EAC7C,SAAS,EAAE,gBAAgB,CAC9B,CAAA;YACL,CAAC;YACD,IAAI,MAAM,GAAG,WAAW,CAAC,CAAC,CAAC;YAC3B,IAAI,QAAQ,EAAE,CAAC;gBACX,MAAM,GAAG,IAAA,yBAAe,EACpB,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,CAAW,EACtB,CAAC,MAAM,EAAE,aAAa,CAAC,EACvB,MAAA,MAAC,MAAc,CAAC,KAAK,0CAAG,yBAAyB,CAAC,0CAAE,QAAQ,CAC/D,KAAI,MAAC,MAAc,aAAd,MAAM,uBAAN,MAAM,CAAU,KAAK,0CAAE,QAAQ,CAAA,CAAC;YAC1C,CAAC;YACD,OAAO,IAAA,kCAAwB,EAAC;gBAC5B,MAAM,QAAA;gBACN,MAAM,QAAA;gBACN,SAAS,WAAA;gBAAE,gBAAgB,kBAAA;aAC9B,CAAC,CAAC;QACP,CAAC;IACL,CAAC,EAAE,CAAC,UAAU,EAAE,YAAY,EAAE,mBAAmB,CAAC,CAAC,CAAC;IAEpD,OAAO,CACH,uBAAC,qBAAS,CAAC,QAAQ,IAAC,KAAK,EAAE;YACvB,SAAS,WAAA;YAAE,MAAM,QAAA;YAAE,aAAa,eAAA;SACnC,YAEO,YAAY,CAAC,CAAC;YACd,QAAQ,CAAC,CAAC,CAAC,SAAS,GAEP,CACxB,CAAA;AAEL,CAAC"}
+{"version":3,"file":"GTProvider.js","sourceRoot":"","sources":["../../src/provider/GTProvider.tsx"],"names":[],"mappings":";AAAA,YAAY,CAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6BZ,6BAgJC;;AA3KD,yDAA8F;AAC9F,+BAAuE;AACvE,+EAAyD;AACzD,uDAA6H;AAC7H,yCAAwC;AAExC,oFAA8D;AAC9D,wCAA8C;AAC9C,wFAAkE;AAClE,4FAAsE;AACtE,+EAAyD;AACzD,kGAA4E;AAE5E;;;;;;;;;;;;;GAaG;AACH,SAAwB,UAAU,CAAC,EAkBlC;IAlBD,iBAgJC;QA/IG,QAAQ,cAAA,EACR,SAAS,eAAA,EACT,kBAA8B,EAA9B,UAAU,mBAAG,8BAAiB,KAAA,EAC9B,sBAAsC,EAAtC,cAAc,mBAAG,kCAAqB,KAAA,EACtC,eAAe,qBAAA,EACf,qBAA4D,EAA5D,aAAa,mBAAG,CAAA,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAG,CAAC,CAAC,KAAI,iCAAoB,KAAA,EAC5D,MAAM,YAAA,EACN,gBAAkC,EAAlC,QAAQ,mBAAG,uBAAuB,KAAA;IAYlC,IAAI,CAAC,SAAS,IAAI,QAAQ,KAAK,uBAAuB,EAAE,CAAC;QACrD,MAAM,IAAI,KAAK,CAAC,8HAA8H,CAAC,CAAA;IACnJ,CAAC;IAED,IAAM,aAAa,GAAG,IAAA,0BAAgB,EAAC,aAAa,CAAC,CAAC;IACtD,MAAM,GAAG,MAAM,IAAI,aAAa,CAAC;IACjC,IAAI,eAAe,EAAE,CAAC;QAClB,MAAM,GAAG,IAAA,sCAAiB,EAAC,CAAC,MAAM,EAAE,aAAa,CAAC,EAAE,eAAe,CAAC,IAAI,MAAM,CAAC;IACnF,CAAC;IAED,IAAM,mBAAmB,GAAG,IAAA,mCAAc,EAAC,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;IAE3E,IAAA,KAAkC,IAAA,gBAAQ,EAC5C,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CACvB,EAFM,YAAY,QAAA,EAAE,eAAe,QAEnC,CAAA;IAED,IAAA,iBAAS,EAAC;QACN,IAAI,CAAC,YAAY,EAAE,CAAC;YAChB,IAAI,CAAC,mBAAmB,EAAE,CAAC;gBACvB,eAAe,CAAC,EAAE,CAAC,CAAC,CAAC,0BAA0B;YACnD,CAAC;iBAAM,CAAC;gBACJ,CAAC;;;;oCACoB,qBAAM,KAAK,CAAC,UAAG,QAAQ,cAAI,SAAS,cAAI,MAAM,cAAI,cAAc,CAAE,CAAC,EAAA;;gCAA9E,QAAQ,GAAG,SAAmE;gCACrE,qBAAM,QAAQ,CAAC,IAAI,EAAE,EAAA;;gCAA9B,MAAM,GAAG,SAAqB;gCACpC,eAAe,CAAC,MAAM,CAAC,CAAC;;;;qBAC3B,CAAC,EAAE,CAAA;YACR,CAAC;QACL,CAAC;IACL,CAAC,EAAE,CAAC,YAAY,EAAE,mBAAmB,CAAC,CAAC,CAAA;IAEvC,IAAM,SAAS,GAAG,IAAA,mBAAW,EAAC,UAC1B,EAAU,EACV,OAAiC,EACjC,CAAY;;QADZ,wBAAA,EAAA,YAAiC;QAIjC,2BAA2B;QACvB,IAAA,KAAsB,IAAA,8BAAoB,EAC1C,IAAA,4BAAkB,EAAC,UAAU,EAAE,EAAE,CAAoB,CACxD,EAFK,KAAK,WAAA,EAAE,QAAQ,cAEpB,CAAC;QAEF,qCAAqC;QACrC,IAAI,SAAS,CAAC;QAAC,IAAI,gBAAgB,CAAC;QACpC,IAAI,OAAO,EAAE,CAAC;YACV,SAAS,GAAG,OAAO,CAAC;YACpB,IAAI,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,gBAAgB,EAAE,CAAC;gBAC7B,gBAAgB,GAAG,QAAQ,CAAC,gBAAgB,CAAC;YACjD,CAAC;QACL,CAAC;QAED,oCAAoC;QACpC,IAAI,OAAO,CAAC,KAAK,UAAU,EAAE,CAAC;YAC1B,KAAK,GAAG,CAAC,CAAC,OAAO,CAAiB,CAAC;QACvC,CAAC;aAAM,IAAI,OAAO,KAAK,KAAK,UAAU,EAAE,CAAC;YACrC,KAAK,GAAG,KAAK,CAAC,OAAO,CAAiB,CAAC;QAC3C,CAAC;QAED,IAAM,WAAW,GAAG,IAAA,0BAAe,EAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QAErD,IAAI,MAAM,CAAC;QAEX,yEAAyE;QACzE,IAAM,QAAQ,GAAG,QAAQ,IAAI,8BAAiB,CAAC,IAAI,CAAC,UAAA,UAAU,IAAI,OAAA,UAAU,IAAI,QAAQ,EAAtB,CAAsB,CAAC,CAAC;QAC1F,IAAI,QAAQ,EAAE,CAAC;YACX,IAAI,OAAO,CAAA,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,CAAC,CAAA,KAAK,QAAQ;gBAChC,MAAM,IAAI,KAAK,CAAC,cAAM,EAAE,uCAAiC,CAAC,CAAA;YAC9D,MAAM,GAAG,IAAA,yBAAe,EACpB,SAAS,CAAC,CAAC,EACX,CAAC,MAAM,EAAE,aAAa,CAAC,EACvB,MAAA,WAAW,CAAC,KAAK,0CAAG,yBAAyB,EAAE,QAAQ,CAC1D,IAAI,WAAW,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,oCAAoC;QACzE,CAAC;aAAM,CAAC;YACJ,MAAM,GAAG,WAAW,CAAC;QACzB,CAAC;QAED,kCAAkC;QAClC,IAAI,CAAC,mBAAmB,EAAE,CAAC;YACvB,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;gBAClC,OAAO,IAAA,0CAAqB,EACxB,MAAM,EAAE,aAAa,EACrB,SAAS,EAAE,gBAAgB,CAC9B,CAAA;YACL,CAAC;YACD,OAAO,IAAA,+BAAqB,EAAC;gBACzB,KAAK,EAAE,MAAM;gBAAE,SAAS,WAAA;gBAAE,gBAAgB,kBAAA;aAC7C,CAAC,CAAA;QACN,CAAC;QAED,+BAA+B;QAC/B,IAAI,YAAY,EAAE,CAAC;YACf,IAAM,WAAW,GAAG,YAAY,CAAC,EAAE,CAAC,CAAC;YACrC,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;gBAClC,OAAO,IAAA,0CAAqB,EACxB,WAAW,CAAC,CAAQ,EAAE,CAAC,MAAM,EAAE,aAAa,CAAC,EAC7C,SAAS,EAAE,gBAAgB,CAC9B,CAAA;YACL,CAAC;YACD,IAAI,MAAM,GAAG,WAAW,CAAC,CAAC,CAAC;YAC3B,IAAI,QAAQ,EAAE,CAAC;gBACX,MAAM,GAAG,IAAA,yBAAe,EACpB,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,CAAW,EACtB,CAAC,MAAM,EAAE,aAAa,CAAC,EACvB,MAAA,MAAC,MAAc,CAAC,KAAK,0CAAG,yBAAyB,CAAC,0CAAE,QAAQ,CAC/D,KAAI,MAAC,MAAc,aAAd,MAAM,uBAAN,MAAM,CAAU,KAAK,0CAAE,QAAQ,CAAA,CAAC;YAC1C,CAAC;YACD,OAAO,IAAA,kCAAwB,EAAC;gBAC5B,MAAM,QAAA;gBACN,MAAM,QAAA;gBACN,SAAS,WAAA;gBAAE,gBAAgB,kBAAA;aAC9B,CAAC,CAAC;QACP,CAAC;IACL,CAAC,EAAE,CAAC,UAAU,EAAE,YAAY,EAAE,mBAAmB,CAAC,CAAC,CAAC;IAEpD,OAAO,CACH,uBAAC,qBAAS,CAAC,QAAQ,IAAC,KAAK,EAAE;YACvB,SAAS,WAAA;YAAE,MAAM,QAAA;YAAE,aAAa,eAAA;SACnC,YAEO,YAAY,CAAC,CAAC;YACd,QAAQ,CAAC,CAAC,CAAC,SAAS,GAEP,CACxB,CAAA;AAEL,CAAC"}

package/dist/variables/Currency.d.ts

@@ -1,13 +1,33 @@
-import { ReactNode } from 'react';
-declare const Currency: {
-    ({ children, name, defaultValue, currency, options }?: {
-        children?: any;
-        name?: string;
-        defaultValue?: any;
-        currency?: string;
-        options?: Intl.NumberFormatOptions;
-    }): ReactNode;
-    gtTransformation: string;
-};
+/**
+ * The `<Currency>` component renders a formatted currency string, allowing customization of name, default value, currency type, and formatting options.
+ * Must be used inside a `<GTProvider>`.
+ *
+ * @example
+ * ```jsx
+ * <Currency
+ *    name="price"
+ *    currency="USD"
+ * >
+ *    1000
+ * </Currency>
+ * ```
+ *
+ * @param {any} [children] - Optional content to render inside the currency component.
+ * @param {string} [name] - Optional name for the currency field.
+ * @param {any} [defaultValue] - The default value to be used.
+ * @param {string} [currency] - The currency type (e.g., USD, EUR, etc.).
+ * @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, name, defaultValue, currency, options }?: {
+    children?: any;
+    name?: string;
+    defaultValue?: any;
+    currency?: string;
+    options?: Intl.NumberFormatOptions;
+}): JSX.Element;
+declare namespace Currency {
+    var gtTransformation: string;
+}
 export default Currency;
 //# sourceMappingURL=Currency.d.ts.map

package/dist/variables/Currency.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Currency.d.ts","sourceRoot":"","sources":["../../src/variables/Currency.tsx"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAKlC,QAAA,MAAM,QAAQ;2DAA+E;QACzF,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,GAAsB,SAAS;;CAiB/B,CAAC;AAKF,eAAe,QAAQ,CAAC"}
+{"version":3,"file":"Currency.d.ts","sourceRoot":"","sources":["../../src/variables/Currency.tsx"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,iBAAS,QAAQ,CAAC,EAAE,QAAQ,EAAE,IAAa,EAAE,YAAY,EAAE,QAAgB,EAAE,OAAY,EAAE,GAAE;IACzF,QAAQ,CAAC,EAAE,GAAG,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,IAAI,CAAC,mBAAmB,CAAC;CACnB,GAAG,GAAG,CAAC,OAAO,CAiBjC;kBAvBQ,QAAQ;;;AA4BjB,eAAe,QAAQ,CAAC"}

package/dist/variables/Currency.js

@@ -19,7 +19,28 @@ var jsx_runtime_1 = require("react/jsx-runtime");
 var generaltranslation_1 = require("generaltranslation");
 var useLocale_1 = __importDefault(require("../hooks/useLocale"));
 var useDefaultLocale_1 = __importDefault(require("../hooks/useDefaultLocale"));
-var Currency = function (_a) {
+/**
+ * The `<Currency>` component renders a formatted currency string, allowing customization of name, default value, currency type, and formatting options.
+ * Must be used inside a `<GTProvider>`.
+ *
+ * @example
+ * ```jsx
+ * <Currency
+ *    name="price"
+ *    currency="USD"
+ * >
+ *    1000
+ * </Currency>
+ * ```
+ *
+ * @param {any} [children] - Optional content to render inside the currency component.
+ * @param {string} [name] - Optional name for the currency field.
+ * @param {any} [defaultValue] - The default value to be used.
+ * @param {string} [currency] - The currency type (e.g., USD, EUR, etc.).
+ * @param {Intl.NumberFormatOptions} [options] - Optional formatting options to customize how the currency is displayed.
+ * @returns {JSX.Element} The formatted currency component.
+ */
+function Currency(_a) {
     var _b = _a === void 0 ? { name: "cost" } : _a, children = _b.children, _c = _b.name, name = _c === void 0 ? "cost" : _c, defaultValue = _b.defaultValue, _d = _b.currency, currency = _d === void 0 ? "USD" : _d, _e = _b.options, options = _e === void 0 ? {} : _e;
     var locales = [(0, useLocale_1.default)(), (0, useDefaultLocale_1.default)()];
     var value = (typeof children !== 'undefined' && typeof defaultValue === 'undefined') ? children : defaultValue;
@@ -29,7 +50,8 @@ var Currency = function (_a) {
         value = (0, generaltranslation_1.formatCurrency)({ value: value, languages: locales, currency: currency, options: options });
     }
     return ((0, jsx_runtime_1.jsx)("span", { "data-gt-variable-name": name, "data-gt-variable-type": "currency", "data-gt-variable-options": __assign({ style: 'currency', currency: currency }, options), children: value }));
-};
+}
+;
 // Static property to indicate the transformation type
 Currency.gtTransformation = "variable-currency";
 exports.default = Currency;

package/dist/variables/Currency.js.map

@@ -1 +1 @@
-{"version":3,"file":"Currency.js","sourceRoot":"","sources":["../../src/variables/Currency.tsx"],"names":[],"mappings":";AAAA,YAAY,CAAA;;;;;;;;;;;;;;;;;AAGZ,yDAAoD;AACpD,iEAA2C;AAC3C,+EAAyD;AAEzD,IAAM,QAAQ,GAAG,UAAC,EAME;QANF,qBAMd,EAAE,IAAI,EAAE,MAAM,EAAE,KAAA,EANA,QAAQ,cAAA,EAAE,YAAa,EAAb,IAAI,mBAAG,MAAM,KAAA,EAAE,YAAY,kBAAA,EAAE,gBAAgB,EAAhB,QAAQ,mBAAG,KAAK,KAAA,EAAE,eAAY,EAAZ,OAAO,mBAAG,EAAE,KAAA;IAQrF,IAAM,OAAO,GAAG,CAAC,IAAA,mBAAS,GAAE,EAAE,IAAA,0BAAgB,GAAE,CAAC,CAAA;IAEjD,IAAI,KAAK,GAAG,CAAC,OAAO,QAAQ,KAAK,WAAW,IAAI,OAAO,YAAY,KAAK,WAAW,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC;IAC/G,KAAK,GAAG,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAChE,2CAA2C;IAC3C,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC5B,KAAK,GAAG,IAAA,mCAAc,EAAC,EAAE,KAAK,OAAA,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,UAAA,EAAE,OAAO,SAAA,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED,OAAO,CACH,0DAA6B,IAAI,2BAAyB,UAAU,yCAA8B,KAAK,EAAE,UAAU,EAAE,QAAQ,UAAA,IAAK,OAAO,aACpI,KAAK,GACH,CACV,CAAC;AAEN,CAAC,CAAC;AAEF,sDAAsD;AACtD,QAAQ,CAAC,gBAAgB,GAAG,mBAAmB,CAAC;AAEhD,kBAAe,QAAQ,CAAC"}
+{"version":3,"file":"Currency.js","sourceRoot":"","sources":["../../src/variables/Currency.tsx"],"names":[],"mappings":";AAAA,YAAY,CAAA;;;;;;;;;;;;;;;;;AAEZ,yDAAoD;AACpD,iEAA2C;AAC3C,+EAAyD;AAEzD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,SAAS,QAAQ,CAAC,EAME;QANF,qBAMd,EAAE,IAAI,EAAE,MAAM,EAAE,KAAA,EANA,QAAQ,cAAA,EAAE,YAAa,EAAb,IAAI,mBAAG,MAAM,KAAA,EAAE,YAAY,kBAAA,EAAE,gBAAgB,EAAhB,QAAQ,mBAAG,KAAK,KAAA,EAAE,eAAY,EAAZ,OAAO,mBAAG,EAAE,KAAA;IAQrF,IAAM,OAAO,GAAG,CAAC,IAAA,mBAAS,GAAE,EAAE,IAAA,0BAAgB,GAAE,CAAC,CAAA;IAEjD,IAAI,KAAK,GAAG,CAAC,OAAO,QAAQ,KAAK,WAAW,IAAI,OAAO,YAAY,KAAK,WAAW,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC;IAC/G,KAAK,GAAG,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAChE,2CAA2C;IAC3C,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC5B,KAAK,GAAG,IAAA,mCAAc,EAAC,EAAE,KAAK,OAAA,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,UAAA,EAAE,OAAO,SAAA,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED,OAAO,CACH,0DAA6B,IAAI,2BAAyB,UAAU,yCAA8B,KAAK,EAAE,UAAU,EAAE,QAAQ,UAAA,IAAK,OAAO,aACpI,KAAK,GACH,CACV,CAAC;AAEN,CAAC;AAAA,CAAC;AAEF,sDAAsD;AACtD,QAAQ,CAAC,gBAAgB,GAAG,mBAAmB,CAAC;AAEhD,kBAAe,QAAQ,CAAC"}

package/dist/variables/DateTime.d.ts

@@ -1,11 +1,30 @@
-import { ReactNode } from 'react';
+/**
+ * The `<DateTime>` component renders a formatted date or time string, allowing customization of the name, default value, and formatting options.
+ * It utilizes the current locale and optional format settings to display the date.
+ * Must be used inside a `<GTProvider>`.
+ *
+ * @example
+ * ```jsx
+ * <DateTime
+ *    name="createdAt"
+ * >
+ *    {new Date()}
+ * </DateTime>
+ * ```
+ *
+ * @param {any} [children] - Optional content (typically a date) to render inside the component.
+ * @param {string} [name="date"] - Optional name for the date field, used for metadata purposes.
+ * @param {string|number|Date} [defaultValue] - The default value for the date. Can be a string, number (timestamp), or `Date` object.
+ * @param {Intl.DateTimeFormatOptions} [options={}] - Optional formatting options for the date, following `Intl.DateTimeFormatOptions` specifications.
+ * @returns {JSX.Element} The formatted date or time component.
+ */
 declare const DateTime: {
     ({ children, name, defaultValue, options }?: {
         children?: any;
         name?: string;
         defaultValue?: any;
         options?: Intl.DateTimeFormatOptions;
-    }): ReactNode;
+    }): JSX.Element;
     gtTransformation: string;
 };
 export default DateTime;

package/dist/variables/DateTime.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"DateTime.d.ts","sourceRoot":"","sources":["../../src/variables/DateTime.tsx"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAKlC,QAAA,MAAM,QAAQ;iDAA6D;QACvE,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,GAAsB,SAAS;;CA0B/B,CAAC;AAKF,eAAe,QAAQ,CAAC"}
+{"version":3,"file":"DateTime.d.ts","sourceRoot":"","sources":["../../src/variables/DateTime.tsx"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,QAAA,MAAM,QAAQ;iDAA6D;QACvE,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,GAAsB,GAAG,CAAC,OAAO;;CAyBjC,CAAC;AAKF,eAAe,QAAQ,CAAC"}

package/dist/variables/DateTime.js

@@ -8,14 +8,32 @@ var jsx_runtime_1 = require("react/jsx-runtime");
 var generaltranslation_1 = require("generaltranslation");
 var useLocale_1 = __importDefault(require("../hooks/useLocale"));
 var useDefaultLocale_1 = __importDefault(require("../hooks/useDefaultLocale"));
+/**
+ * The `<DateTime>` component renders a formatted date or time string, allowing customization of the name, default value, and formatting options.
+ * It utilizes the current locale and optional format settings to display the date.
+ * Must be used inside a `<GTProvider>`.
+ *
+ * @example
+ * ```jsx
+ * <DateTime
+ *    name="createdAt"
+ * >
+ *    {new Date()}
+ * </DateTime>
+ * ```
+ *
+ * @param {any} [children] - Optional content (typically a date) to render inside the component.
+ * @param {string} [name="date"] - Optional name for the date field, used for metadata purposes.
+ * @param {string|number|Date} [defaultValue] - The default value for the date. Can be a string, number (timestamp), or `Date` object.
+ * @param {Intl.DateTimeFormatOptions} [options={}] - Optional formatting options for the date, following `Intl.DateTimeFormatOptions` specifications.
+ * @returns {JSX.Element} The formatted date or time component.
+ */
 var DateTime = function (_a) {
     var _b = _a === void 0 ? { name: "date" } : _a, children = _b.children, _c = _b.name, name = _c === void 0 ? "date" : _c, defaultValue = _b.defaultValue, _d = _b.options, options = _d === void 0 ? {} : _d;
     var locales = [(0, useLocale_1.default)(), (0, useDefaultLocale_1.default)()];
     var final;
     var dateValue;
     defaultValue = (typeof children !== 'undefined' && typeof defaultValue === 'undefined') ? children : defaultValue;
-    if (!defaultValue)
-        return '';
     if (typeof defaultValue === 'number') {
         dateValue = new Date(defaultValue);
     }

package/dist/variables/DateTime.js.map

@@ -1 +1 @@
-{"version":3,"file":"DateTime.js","sourceRoot":"","sources":["../../src/variables/DateTime.tsx"],"names":[],"mappings":";AAAA,YAAY,CAAA;;;;;;AAGZ,yDAAoD;AACpD,iEAA2C;AAC3C,+EAAyD;AAEzD,IAAM,QAAQ,GAAG,UAAC,EAKE;QALF,qBAKd,EAAE,IAAI,EAAE,MAAM,EAAE,KAAA,EALA,QAAQ,cAAA,EAAE,YAAa,EAAb,IAAI,mBAAG,MAAM,KAAA,EAAE,YAAY,kBAAA,EAAE,eAAY,EAAZ,OAAO,mBAAG,EAAE,KAAA;IAOnE,IAAM,OAAO,GAAG,CAAC,IAAA,mBAAS,GAAE,EAAE,IAAA,0BAAgB,GAAE,CAAC,CAAA;IAEjD,IAAI,KAAK,CAAC;IAEV,IAAI,SAA2B,CAAC;IAChC,YAAY,GAAG,CAAC,OAAO,QAAQ,KAAK,WAAW,IAAI,OAAO,YAAY,KAAK,WAAW,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC;IAClH,IAAI,CAAC,YAAY;QAAE,OAAO,EAAE,CAAC;IAC7B,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE,CAAC;QACnC,SAAS,GAAG,IAAI,IAAI,CAAC,YAAY,CAAC,CAAC;IACvC,CAAC;SAAM,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE,CAAC;QAC1C,SAAS,GAAG,IAAI,IAAI,CAAC,YAAY,CAAC,CAAC;IACvC,CAAC;SAAM,IAAI,YAAY,YAAY,IAAI,EAAE,CAAC;QACtC,SAAS,GAAG,YAAY,CAAC;IAC7B,CAAC;IACD,IAAI,OAAO,SAAS,KAAK,WAAW,EAAE,CAAC;QACnC,KAAK,GAAG,CAAC,IAAA,mCAAc,EAAC,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,SAAA,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,uBAAuB,EAAE,EAAE,CAAC,CAAC;IACrH,CAAC;IAED,kDAAkD;IAClD,OAAO,CACH,0DAA6B,IAAI,2BAAyB,MAAM,8BAA4B,OAAO,YAC9F,KAAK,GACH,CACV,CAAC;AACN,CAAC,CAAC;AAEF,0CAA0C;AAC1C,QAAQ,CAAC,gBAAgB,GAAG,mBAAmB,CAAC;AAEhD,kBAAe,QAAQ,CAAC"}
+{"version":3,"file":"DateTime.js","sourceRoot":"","sources":["../../src/variables/DateTime.tsx"],"names":[],"mappings":";AAAA,YAAY,CAAA;;;;;;AAEZ,yDAAoD;AACpD,iEAA2C;AAC3C,+EAAyD;AAEzD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,IAAM,QAAQ,GAAG,UAAC,EAKE;QALF,qBAKd,EAAE,IAAI,EAAE,MAAM,EAAE,KAAA,EALA,QAAQ,cAAA,EAAE,YAAa,EAAb,IAAI,mBAAG,MAAM,KAAA,EAAE,YAAY,kBAAA,EAAE,eAAY,EAAZ,OAAO,mBAAG,EAAE,KAAA;IAOnE,IAAM,OAAO,GAAG,CAAC,IAAA,mBAAS,GAAE,EAAE,IAAA,0BAAgB,GAAE,CAAC,CAAA;IAEjD,IAAI,KAAK,CAAC;IAEV,IAAI,SAA2B,CAAC;IAChC,YAAY,GAAG,CAAC,OAAO,QAAQ,KAAK,WAAW,IAAI,OAAO,YAAY,KAAK,WAAW,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC;IAClH,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE,CAAC;QACnC,SAAS,GAAG,IAAI,IAAI,CAAC,YAAY,CAAC,CAAC;IACvC,CAAC;SAAM,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE,CAAC;QAC1C,SAAS,GAAG,IAAI,IAAI,CAAC,YAAY,CAAC,CAAC;IACvC,CAAC;SAAM,IAAI,YAAY,YAAY,IAAI,EAAE,CAAC;QACtC,SAAS,GAAG,YAAY,CAAC;IAC7B,CAAC;IACD,IAAI,OAAO,SAAS,KAAK,WAAW,EAAE,CAAC;QACnC,KAAK,GAAG,CAAC,IAAA,mCAAc,EAAC,EAAE,KAAK,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,SAAA,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,uBAAuB,EAAE,EAAE,CAAC,CAAC;IACrH,CAAC;IAED,kDAAkD;IAClD,OAAO,CACH,0DAA6B,IAAI,2BAAyB,MAAM,8BAA4B,OAAO,YAC9F,KAAK,GACH,CACV,CAAC;AACN,CAAC,CAAC;AAEF,0CAA0C;AAC1C,QAAQ,CAAC,gBAAgB,GAAG,mBAAmB,CAAC;AAEhD,kBAAe,QAAQ,CAAC"}

package/dist/variables/Num.d.ts

@@ -1,12 +1,32 @@
-import { ReactNode } from 'react';
-declare const Num: {
-    ({ children, name, defaultValue, options }?: {
-        children?: any;
-        name?: string;
-        defaultValue?: any;
-        options?: Intl.NumberFormatOptions;
-    }): ReactNode;
-    gtTransformation: string;
-};
+/**
+ * The `<Num>` component renders a formatted number string, allowing customization of the name, default value, and formatting options.
+ * It formats the number according to the current locale and optionally passed formatting options.
+ * Must be used inside a `<GTProvider>`.
+ *
+ * @example
+ * ```jsx
+ * <Num
+ *    name="quantity"
+ *    options={{ style: "decimal", maximumFractionDigits: 2 }}
+ * >
+ *    1000
+ * </Num>
+ * ```
+ *
+ * @param {any} [children] - Optional content (typically a number) to render inside the component.
+ * @param {string} [name="n"] - Optional name for the number field, used for metadata purposes.
+ * @param {string|number} [defaultValue] - The default value for the number. Can be a string or number. Strings will be parsed to numbers.
+ * @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, defaultValue, options }?: {
+    children?: any;
+    name?: string;
+    defaultValue?: any;
+    options?: Intl.NumberFormatOptions;
+}): JSX.Element;
+declare namespace Num {
+    var gtTransformation: string;
+}
 export default Num;
 //# sourceMappingURL=Num.d.ts.map

package/dist/variables/Num.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Num.d.ts","sourceRoot":"","sources":["../../src/variables/Num.tsx"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAKlC,QAAA,MAAM,GAAG;iDAA0D;QAC/D,QAAQ,CAAC,EAAE,GAAG,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,YAAY,CAAC,EAAE,GAAG,CAAC;QACnB,OAAO,CAAC,EAAE,IAAI,CAAC,mBAAmB,CAAA;KACrC,GAAmB,SAAS;;CAgB5B,CAAC;AAIF,eAAe,GAAG,CAAC"}
+{"version":3,"file":"Num.d.ts","sourceRoot":"","sources":["../../src/variables/Num.tsx"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,iBAAS,GAAG,CAAC,EAAE,QAAQ,EAAE,IAAU,EAAE,YAAY,EAAE,OAAY,EAAE,GAAE;IAC/D,QAAQ,CAAC,EAAE,GAAG,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,GAAG,CAAC;IACnB,OAAO,CAAC,EAAE,IAAI,CAAC,mBAAmB,CAAA;CACrB,GAAG,GAAG,CAAC,OAAO,CAgB9B;kBArBQ,GAAG;;;AAyBZ,eAAe,GAAG,CAAC"}

package/dist/variables/Num.js

@@ -8,7 +8,28 @@ var jsx_runtime_1 = require("react/jsx-runtime");
 var generaltranslation_1 = require("generaltranslation");
 var useLocale_1 = __importDefault(require("../hooks/useLocale"));
 var useDefaultLocale_1 = __importDefault(require("../hooks/useDefaultLocale"));
-var Num = function (_a) {
+/**
+ * The `<Num>` component renders a formatted number string, allowing customization of the name, default value, and formatting options.
+ * It formats the number according to the current locale and optionally passed formatting options.
+ * Must be used inside a `<GTProvider>`.
+ *
+ * @example
+ * ```jsx
+ * <Num
+ *    name="quantity"
+ *    options={{ style: "decimal", maximumFractionDigits: 2 }}
+ * >
+ *    1000
+ * </Num>
+ * ```
+ *
+ * @param {any} [children] - Optional content (typically a number) to render inside the component.
+ * @param {string} [name="n"] - Optional name for the number field, used for metadata purposes.
+ * @param {string|number} [defaultValue] - The default value for the number. Can be a string or number. Strings will be parsed to numbers.
+ * @param {Intl.NumberFormatOptions} [options={}] - Optional formatting options for the number, following `Intl.NumberFormatOptions` specifications.
+ * @returns {JSX.Element} The formatted number component.
+ */
+function Num(_a) {
     var _b = _a === void 0 ? { name: "n" } : _a, children = _b.children, _c = _b.name, name = _c === void 0 ? "n" : _c, defaultValue = _b.defaultValue, _d = _b.options, options = _d === void 0 ? {} : _d;
     var locales = [(0, useLocale_1.default)(), (0, useDefaultLocale_1.default)()];
     var value = (typeof children !== 'undefined' && typeof defaultValue === 'undefined') ? children : defaultValue;
@@ -18,7 +39,8 @@ var Num = function (_a) {
         value = (0, generaltranslation_1.formatNum)({ value: value, languages: locales, options: options });
     }
     return ((0, jsx_runtime_1.jsx)("span", { "data-gt-variable-name": name, "data-gt-variable-type": "number", "data-gt-variable-options": JSON.stringify(options), children: value }));
-};
+}
+;
 Num.gtTransformation = "variable-number";
 exports.default = Num;
 //# sourceMappingURL=Num.js.map

package/dist/variables/Num.js.map

@@ -1 +1 @@
-{"version":3,"file":"Num.js","sourceRoot":"","sources":["../../src/variables/Num.tsx"],"names":[],"mappings":";AAAA,YAAY,CAAA;;;;;;AAGZ,yDAA+C;AAC/C,iEAA2C;AAC3C,+EAAyD;AAEzD,IAAM,GAAG,GAAG,UAAC,EAKI;QALJ,qBAKT,EAAE,IAAI,EAAE,GAAG,EAAE,KAAA,EALF,QAAQ,cAAA,EAAE,YAAU,EAAV,IAAI,mBAAG,GAAG,KAAA,EAAE,YAAY,kBAAA,EAAE,eAAY,EAAZ,OAAO,mBAAG,EAAE,KAAA;IAO3D,IAAM,OAAO,GAAG,CAAC,IAAA,mBAAS,GAAE,EAAE,IAAA,0BAAgB,GAAE,CAAC,CAAA;IAEjD,IAAI,KAAK,GAAG,CAAC,OAAO,QAAQ,KAAK,WAAW,IAAI,OAAO,YAAY,KAAK,WAAW,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC;IAC/G,KAAK,GAAG,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAChE,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC5B,2DAA2D;QAC3D,KAAK,GAAG,IAAA,8BAAS,EAAC,EAAE,KAAK,OAAA,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,SAAA,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED,OAAO,CACH,0DAA6B,IAAI,2BAAyB,QAAQ,8BAA4B,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,YAChH,KAAK,GACH,CACV,CAAC;AACN,CAAC,CAAC;AAEF,GAAG,CAAC,gBAAgB,GAAG,iBAAiB,CAAC;AAEzC,kBAAe,GAAG,CAAC"}
+{"version":3,"file":"Num.js","sourceRoot":"","sources":["../../src/variables/Num.tsx"],"names":[],"mappings":";AAAA,YAAY,CAAA;;;;;;AAEZ,yDAA+C;AAC/C,iEAA2C;AAC3C,+EAAyD;AAEzD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,SAAS,GAAG,CAAC,EAKI;QALJ,qBAKT,EAAE,IAAI,EAAE,GAAG,EAAE,KAAA,EALF,QAAQ,cAAA,EAAE,YAAU,EAAV,IAAI,mBAAG,GAAG,KAAA,EAAE,YAAY,kBAAA,EAAE,eAAY,EAAZ,OAAO,mBAAG,EAAE,KAAA;IAO3D,IAAM,OAAO,GAAG,CAAC,IAAA,mBAAS,GAAE,EAAE,IAAA,0BAAgB,GAAE,CAAC,CAAA;IAEjD,IAAI,KAAK,GAAG,CAAC,OAAO,QAAQ,KAAK,WAAW,IAAI,OAAO,YAAY,KAAK,WAAW,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC;IAC/G,KAAK,GAAG,CAAC,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;IAChE,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC5B,2DAA2D;QAC3D,KAAK,GAAG,IAAA,8BAAS,EAAC,EAAE,KAAK,OAAA,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,SAAA,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED,OAAO,CACH,0DAA6B,IAAI,2BAAyB,QAAQ,8BAA4B,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,YAChH,KAAK,GACH,CACV,CAAC;AACN,CAAC;AAAA,CAAC;AAEF,GAAG,CAAC,gBAAgB,GAAG,iBAAiB,CAAC;AAEzC,kBAAe,GAAG,CAAC"}

package/dist/variables/Var.d.ts

@@ -1,11 +1,28 @@
-import { ReactNode } from 'react';
-declare const Var: {
-    ({ children, name, defaultValue }: {
-        children?: any;
-        name?: string;
-        defaultValue?: any;
-    }): ReactNode;
-    gtTransformation: string;
-};
+/**
+ * The `<Var>` component renders a variable value, which can either be passed as `children` or a `defaultValue`.
+ * If `children` is provided, it will be used; otherwise, the `defaultValue` is rendered.
+ *
+ * @example
+ * ```jsx
+ * <Var
+ *    name="username"
+ * >
+ *    John
+ * </Var>
+ * ```
+ *
+ * @param {any} [children] - The content to render inside the component. If provided, it will take precedence over `defaultValue`.
+ * @param {string} [name] - Optional name for the variable, used for metadata purposes.
+ * @param {any} [defaultValue] - The default value to be displayed if `children` is not provided.
+ * @returns {JSX.Element} The rendered variable component with either `children` or `defaultValue`.
+ */
+declare function Var({ children, name, defaultValue }: {
+    children?: any;
+    name?: string;
+    defaultValue?: any;
+}): JSX.Element;
+declare namespace Var {
+    var gtTransformation: string;
+}
 export default Var;
 //# sourceMappingURL=Var.d.ts.map

package/dist/variables/Var.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Var.d.ts","sourceRoot":"","sources":["../../src/variables/Var.tsx"],"names":[],"mappings":"AAEA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAElC,QAAA,MAAM,GAAG;uCAAsC;QAC3C,QAAQ,CAAC,EAAE,GAAG,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,YAAY,CAAC,EAAE,GAAG,CAAC;KACtB,GAAG,SAAS;;CAUZ,CAAC;AAIF,eAAe,GAAG,CAAC"}
+{"version":3,"file":"Var.d.ts","sourceRoot":"","sources":["../../src/variables/Var.tsx"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;GAiBG;AACH,iBAAS,GAAG,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,YAAY,EAAE,EAAE;IAC3C,QAAQ,CAAC,EAAE,GAAG,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,GAAG,CAAC;CACtB,GAAG,GAAG,CAAC,OAAO,CAUd;kBAdQ,GAAG;;;AAkBZ,eAAe,GAAG,CAAC"}

package/dist/variables/Var.js

@@ -2,11 +2,30 @@
 'use client';
 Object.defineProperty(exports, "__esModule", { value: true });
 var jsx_runtime_1 = require("react/jsx-runtime");
-var Var = function (_a) {
+/**
+ * The `<Var>` component renders a variable value, which can either be passed as `children` or a `defaultValue`.
+ * If `children` is provided, it will be used; otherwise, the `defaultValue` is rendered.
+ *
+ * @example
+ * ```jsx
+ * <Var
+ *    name="username"
+ * >
+ *    John
+ * </Var>
+ * ```
+ *
+ * @param {any} [children] - The content to render inside the component. If provided, it will take precedence over `defaultValue`.
+ * @param {string} [name] - Optional name for the variable, used for metadata purposes.
+ * @param {any} [defaultValue] - The default value to be displayed if `children` is not provided.
+ * @returns {JSX.Element} The rendered variable component with either `children` or `defaultValue`.
+ */
+function Var(_a) {
     var children = _a.children, name = _a.name, defaultValue = _a.defaultValue;
     var final = typeof children !== 'undefined' ? children : defaultValue;
     return ((0, jsx_runtime_1.jsx)("span", { "data-gt-variable-name": name, "data-gt-variable-type": "variable", children: final }));
-};
+}
+;
 Var.gtTransformation = "variable-variable";
 exports.default = Var;
 //# sourceMappingURL=Var.js.map

package/dist/variables/Var.js.map

@@ -1 +1 @@
-{"version":3,"file":"Var.js","sourceRoot":"","sources":["../../src/variables/Var.tsx"],"names":[],"mappings":";AAAA,YAAY,CAAA;;;AAIZ,IAAM,GAAG,GAAG,UAAC,EAIZ;QAJc,QAAQ,cAAA,EAAE,IAAI,UAAA,EAAE,YAAY,kBAAA;IAMvC,IAAI,KAAK,GAAG,OAAO,QAAQ,KAAK,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC;IAEtE,OAAO,CACH,0DAA6B,IAAI,2BAAyB,UAAU,YAC/D,KAAK,GACH,CACV,CAAC;AAEN,CAAC,CAAC;AAEF,GAAG,CAAC,gBAAgB,GAAG,mBAAmB,CAAC;AAE3C,kBAAe,GAAG,CAAC"}
+{"version":3,"file":"Var.js","sourceRoot":"","sources":["../../src/variables/Var.tsx"],"names":[],"mappings":";AAAA,YAAY,CAAA;;;AAEZ;;;;;;;;;;;;;;;;;GAiBG;AACH,SAAS,GAAG,CAAC,EAIZ;QAJc,QAAQ,cAAA,EAAE,IAAI,UAAA,EAAE,YAAY,kBAAA;IAMvC,IAAI,KAAK,GAAG,OAAO,QAAQ,KAAK,WAAW,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,YAAY,CAAC;IAEtE,OAAO,CACH,0DAA6B,IAAI,2BAAyB,UAAU,YAC/D,KAAK,GACH,CACV,CAAC;AAEN,CAAC;AAAA,CAAC;AAEF,GAAG,CAAC,gBAAgB,GAAG,mBAAmB,CAAC;AAE3C,kBAAe,GAAG,CAAC"}

package/package.json

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

package/scratchpad.js

@@ -1,34 +1,10 @@
 /*
 
-gt-react
-- works for client-side React, React native
+Main functions:
 
-import { 
-    GTProvider, useGT, useLocale, useDefaultLocale, useBrowserLocale,
-    Var, Num, Currency, DateTime
-} from 'gt-react'
-import { calculateHash, addGTIdentifier, writeChildrenAsObjects } from 'gt-react/internal'
-
-*/
-/*
-
-gt-next
-- initGT in next.js plugin
-
-import { useBrowserLocale } from 'gt-next/client'
-import { 
-    getGT, GTProvider, getLocale, getDefaultLocale,
-    Var, Num, Currency, DateTime 
-} from 'gt-next'
-import { initGT } from 'gt-next/plugin'
-import { T, Plural } from 'gt-next/server'
-import { createMiddleware } from 'gt-next/middleware'
-
-*/
-/*
-
-generaltranslation
-
-import { determineLocale }
+Var, Num, Currency, DateTime
+GTProvider,
+useGT, useDefaultLocale, useLocale
+useBrowserLocale
 
 */

package/dist/primitives/settings.d.ts

@@ -1,4 +0,0 @@
-export declare const localeCookieName = "generaltranslation-locale";
-export declare const libraryDefaultLocale = "en";
-export declare const pluralBranchNames: string[];
-//# sourceMappingURL=settings.d.ts.map

package/dist/primitives/settings.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"settings.d.ts","sourceRoot":"","sources":["../../src/primitives/settings.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,gBAAgB,8BAA8B,CAAC;AAE5D,eAAO,MAAM,oBAAoB,OAAO,CAAC;AAEzC,eAAO,MAAM,iBAAiB,UAA+E,CAAA"}

package/dist/primitives/settings.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.pluralBranchNames = exports.libraryDefaultLocale = exports.localeCookieName = void 0;
-exports.localeCookieName = "generaltranslation-locale";
-exports.libraryDefaultLocale = "en"; // language to use as default if none is provided
-exports.pluralBranchNames = ["singular", "plural", "dual", "zero", "one", "two", "few", "many", "other"];
-//# sourceMappingURL=settings.js.map

package/dist/primitives/settings.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"settings.js","sourceRoot":"","sources":["../../src/primitives/settings.ts"],"names":[],"mappings":";;;AAAa,QAAA,gBAAgB,GAAG,2BAA2B,CAAC;AAE/C,QAAA,oBAAoB,GAAG,IAAI,CAAC,CAAC,iDAAiD;AAE9E,QAAA,iBAAiB,GAAG,CAAC,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA"}