generaltranslation 2.0.55 → 2.0.57

package/dist/{cjs/codes → codes}/codes.js

@@ -10,28 +10,28 @@ exports._getLanguageObject = _getLanguageObject;
 exports._isSameLanguage = _isSameLanguage;
 // ----- IMPORTS ----- //
 // Import modules for mapping ISO 639 codes to language names and vice versa
-const CodeToLanguage_json_1 = __importDefault(require("./639-1/CodeToLanguage.json"));
-const LanguageToCode_json_1 = __importDefault(require("./639-1/LanguageToCode.json"));
-const CodeToLanguage = CodeToLanguage_json_1.default;
-const LanguageToCode = LanguageToCode_json_1.default;
+var CodeToLanguage_json_1 = __importDefault(require("./639-1/CodeToLanguage.json"));
+var LanguageToCode_json_1 = __importDefault(require("./639-1/LanguageToCode.json"));
+var CodeToLanguage = CodeToLanguage_json_1.default;
+var LanguageToCode = LanguageToCode_json_1.default;
 // Import modules for mapping ISO 639-3 codes (for languages without two-letter codes)
-const CodeToLanguageTriletter_json_1 = __importDefault(require("./639-3/CodeToLanguageTriletter.json"));
-const LanguageToCodeTriletter_json_1 = __importDefault(require("./639-3/LanguageToCodeTriletter.json"));
-const CodeToLanguageTriletter = CodeToLanguageTriletter_json_1.default;
-const LanguageToCodeTriletter = LanguageToCodeTriletter_json_1.default;
+var CodeToLanguageTriletter_json_1 = __importDefault(require("./639-3/CodeToLanguageTriletter.json"));
+var LanguageToCodeTriletter_json_1 = __importDefault(require("./639-3/LanguageToCodeTriletter.json"));
+var CodeToLanguageTriletter = CodeToLanguageTriletter_json_1.default;
+var LanguageToCodeTriletter = LanguageToCodeTriletter_json_1.default;
 // Import module for mapping ISO 15924 script codes to script names
-const ScriptToCode_json_1 = __importDefault(require("./15924/ScriptToCode.json"));
-const CodeToScript_json_1 = __importDefault(require("./15924/CodeToScript.json"));
-const ScriptToCode = ScriptToCode_json_1.default;
-const CodeToScript = CodeToScript_json_1.default;
+var ScriptToCode_json_1 = __importDefault(require("./15924/ScriptToCode.json"));
+var CodeToScript_json_1 = __importDefault(require("./15924/CodeToScript.json"));
+var ScriptToCode = ScriptToCode_json_1.default;
+var CodeToScript = CodeToScript_json_1.default;
 // Import module for mapping ISO 3166 region codes to region names
-const RegionToCode_json_1 = __importDefault(require("./3166/RegionToCode.json"));
-const CodeToRegion_json_1 = __importDefault(require("./3166/CodeToRegion.json"));
-const RegionToCode = RegionToCode_json_1.default;
-const CodeToRegion = CodeToRegion_json_1.default;
+var RegionToCode_json_1 = __importDefault(require("./3166/RegionToCode.json"));
+var CodeToRegion_json_1 = __importDefault(require("./3166/CodeToRegion.json"));
+var RegionToCode = RegionToCode_json_1.default;
+var CodeToRegion = CodeToRegion_json_1.default;
 // Import predefined common regions
-const Predefined_json_1 = __importDefault(require("./predefined/Predefined.json"));
-const Predefined = Predefined_json_1.default;
+var Predefined_json_1 = __importDefault(require("./predefined/Predefined.json"));
+var Predefined = Predefined_json_1.default;
 // ----- VALIDITY CHECKS ----- //
 /**
  * Ensures correct capitalization and formatting of a language code.
@@ -42,17 +42,17 @@ const Predefined = Predefined_json_1.default;
 function _standardizeLanguageCode(code) {
     if (!_isValidLanguageCode(code))
         return '';
-    const codeParts = code.split('-');
-    let result = `${codeParts[0].toLowerCase()}`;
+    var codeParts = code.split('-');
+    var result = "".concat(codeParts[0].toLowerCase());
     if (codeParts[1]) {
         if (codeParts[1].length === 4) {
-            result += `-${_capitalize(codeParts[1])}`;
+            result += "-".concat(_capitalize(codeParts[1]));
             if (codeParts[2] && codeParts[2].length === 2) {
-                result += `-${codeParts[2].toUpperCase()}`;
+                result += "-".concat(codeParts[2].toUpperCase());
             }
         }
         else if (codeParts[1].length === 2) {
-            result += `-${codeParts[1].toUpperCase()}`;
+            result += "-".concat(codeParts[1].toUpperCase());
         }
     }
     return result;
@@ -66,7 +66,7 @@ function _standardizeLanguageCode(code) {
 function _isValidLanguageCode(code) {
     if (!code || typeof code !== 'string')
         return false;
-    const codeParts = code.split('-');
+    var codeParts = code.split('-');
     if (!_mapCodeToLanguage(codeParts[0]))
         return false;
     if (codeParts[1]) {
@@ -91,7 +91,7 @@ function _isValidLanguageCode(code) {
  * @param {string} code - The code to capitalize.
  * @returns {string} The capitalized code.
  */
-const _capitalize = (code) => {
+var _capitalize = function (code) {
     if (code.length === 0)
         return code;
     return code.charAt(0).toUpperCase() + code.slice(1).toLowerCase();
@@ -102,12 +102,12 @@ const _capitalize = (code) => {
  * @param {string} code - The ISO 639 code.
  * @returns {string} The language name.
  */
-const _mapCodeToLanguage = (code) => {
-    code = code?.toLowerCase();
-    if (code?.length === 2) {
+var _mapCodeToLanguage = function (code) {
+    code = code === null || code === void 0 ? void 0 : code.toLowerCase();
+    if ((code === null || code === void 0 ? void 0 : code.length) === 2) {
         return CodeToLanguage[code];
     }
-    if (code?.length === 3) {
+    if ((code === null || code === void 0 ? void 0 : code.length) === 3) {
         return CodeToLanguageTriletter[code];
     }
     return '';
@@ -118,8 +118,8 @@ const _mapCodeToLanguage = (code) => {
  * @param {string} language - The language name.
  * @returns {string} BCP 47 language tag.
  */
-const _mapLanguageToCode = (language) => {
-    language = language?.toLowerCase();
+var _mapLanguageToCode = function (language) {
+    language = language === null || language === void 0 ? void 0 : language.toLowerCase();
     return LanguageToCode[language] || LanguageToCodeTriletter[language] || '';
 };
 /**
@@ -127,7 +127,7 @@ const _mapLanguageToCode = (language) => {
  * @param {string} code - The ISO 15924 code.
  * @returns {string} The script name.
  */
-const _mapCodeToScript = (code) => {
+var _mapCodeToScript = function (code) {
     code = _capitalize(code);
     return CodeToScript[code] || '';
 };
@@ -136,8 +136,8 @@ const _mapCodeToScript = (code) => {
  * @param {string} script - The script name.
  * @returns {string} The ISO 15924 code.
  */
-const _mapScriptToCode = (script) => {
-    script = script?.toLowerCase();
+var _mapScriptToCode = function (script) {
+    script = script === null || script === void 0 ? void 0 : script.toLowerCase();
     return ScriptToCode[script] || '';
 };
 /**
@@ -145,8 +145,8 @@ const _mapScriptToCode = (script) => {
  * @param {string} code - The ISO 3166 code.
  * @returns {string} The region name.
  */
-const _mapCodeToRegion = (code) => {
-    code = code?.toUpperCase();
+var _mapCodeToRegion = function (code) {
+    code = code === null || code === void 0 ? void 0 : code.toUpperCase();
     return CodeToRegion[code] || '';
 };
 /**
@@ -154,8 +154,8 @@ const _mapCodeToRegion = (code) => {
  * @param {string} region - The region name.
  * @returns {string} The ISO 3166 code.
  */
-const _mapRegionToCode = (region) => {
-    region = region?.toLowerCase();
+var _mapRegionToCode = function (region) {
+    region = region === null || region === void 0 ? void 0 : region.toLowerCase();
     return RegionToCode[region] || '';
 };
 /**
@@ -169,11 +169,11 @@ function _getLanguageObject(codes) {
  * @param {string} code - The language code.
  * @returns {LanguageObject|null} The language object.
  */
-const _handleGetLanguageObject = (code) => {
+var _handleGetLanguageObject = function (code) {
     if (!_isValidLanguageCode(code))
         return null;
-    const codeParts = code.split('-');
-    let languageObject = {
+    var codeParts = code.split('-');
+    var languageObject = {
         language: _mapCodeToLanguage(codeParts[0]),
     };
     if (codeParts[1]) {
@@ -196,7 +196,7 @@ const _handleGetLanguageObject = (code) => {
  * @returns {string|string[]} The language name(s).
  * @internal
  */
-const _getLanguageName = (codes) => {
+var _getLanguageName = function (codes) {
     return Array.isArray(codes) ? codes.map(_handleGetLanguageName) : _handleGetLanguageName(codes);
 };
 exports._getLanguageName = _getLanguageName;
@@ -205,20 +205,20 @@ exports._getLanguageName = _getLanguageName;
  * @param {string} code - The language code.
  * @returns {string} The language name.
  */
-const _handleGetLanguageName = (code) => {
+var _handleGetLanguageName = function (code) {
     if (!_isValidLanguageCode(code))
         return '';
     if (Predefined[code])
         return Predefined[code];
-    const languageObject = _handleGetLanguageObject(code);
+    var languageObject = _handleGetLanguageObject(code);
     if (!languageObject)
         return '';
-    let result = languageObject.language;
+    var result = languageObject.language;
     if (languageObject.script) {
-        result += `, ${languageObject.script}`;
+        result += ", ".concat(languageObject.script);
     }
     if (languageObject.region) {
-        result += `, ${languageObject.region}`;
+        result += ", ".concat(languageObject.region);
     }
     return result;
 };
@@ -229,7 +229,7 @@ const _handleGetLanguageName = (code) => {
  * @returns {string|string[]} The language code(s).
  * @internal
  */
-const _getLanguageCode = (languages) => {
+var _getLanguageCode = function (languages) {
     return Array.isArray(languages) ? languages.map(_handleGetLanguageCode) : _handleGetLanguageCode(languages);
 };
 exports._getLanguageCode = _getLanguageCode;
@@ -238,7 +238,7 @@ exports._getLanguageCode = _getLanguageCode;
  * @param {string|LanguageObject} language - The language name or object.
  * @returns {string} The language code.
  */
-const _handleGetLanguageCode = (language) => {
+var _handleGetLanguageCode = function (language) {
     if (typeof language === 'string')
         return _handleGetLanguageCodeFromString(language);
     return _handleGetLanguageCodeFromObject(language);
@@ -248,24 +248,24 @@ const _handleGetLanguageCode = (language) => {
  * @param {string} language - The language name.
  * @returns {string} The language code.
  */
-const _handleGetLanguageCodeFromString = (language) => {
-    const subtagStrings = language.split(',').map(string => string.trim());
-    let code = _mapLanguageToCode(subtagStrings[0]);
+var _handleGetLanguageCodeFromString = function (language) {
+    var subtagStrings = language.split(',').map(function (string) { return string.trim(); });
+    var code = _mapLanguageToCode(subtagStrings[0]);
     if (code) {
         if (subtagStrings.length === 3) {
-            code += `-${_mapScriptToCode(subtagStrings[1])}`;
-            code += `-${_mapRegionToCode(subtagStrings[2])}`;
+            code += "-".concat(_mapScriptToCode(subtagStrings[1]));
+            code += "-".concat(_mapRegionToCode(subtagStrings[2]));
         }
         else if (subtagStrings.length === 2) {
-            let tag = _mapScriptToCode(subtagStrings[1]);
+            var tag = _mapScriptToCode(subtagStrings[1]);
             if (!tag)
                 tag = _mapRegionToCode(subtagStrings[1]);
             if (tag)
-                code += `-${tag}`;
+                code += "-".concat(tag);
         }
     }
     if (!code) {
-        for (const key in Predefined) {
+        for (var key in Predefined) {
             if (Predefined[key] === language) {
                 return key;
             }
@@ -278,34 +278,38 @@ const _handleGetLanguageCodeFromString = (language) => {
  * @param {LanguageObject} languageObject - The language object.
  * @returns {string} The language code.
  */
-const _handleGetLanguageCodeFromObject = (languageObject) => {
-    if (!languageObject?.language)
+var _handleGetLanguageCodeFromObject = function (languageObject) {
+    if (!(languageObject === null || languageObject === void 0 ? void 0 : languageObject.language))
         return '';
-    let code = languageObject.language.toLowerCase();
+    var code = languageObject.language.toLowerCase();
     if (languageObject.script) {
-        code += `-${_capitalize(languageObject.script)}`;
+        code += "-".concat(_capitalize(languageObject.script));
     }
     if (languageObject.region) {
-        code += `-${languageObject.region.toUpperCase()}`;
+        code += "-".concat(languageObject.region.toUpperCase());
     }
     return _isValidLanguageCode(code) ? code : '';
 };
 /**
  * @internal
  */
-function _isSameLanguage(...codes) {
+function _isSameLanguage() {
+    var codes = [];
+    for (var _i = 0; _i < arguments.length; _i++) {
+        codes[_i] = arguments[_i];
+    }
     // Flatten the array in case the codes are provided as an array
     if (codes.length === 1 && Array.isArray(codes[0])) {
         codes = codes[0];
     }
     if (codes.length < 2)
         return false;
-    let language = null;
-    for (let i = 0; i < codes.length; i++) {
+    var language = null;
+    for (var i = 0; i < codes.length; i++) {
         if (typeof codes[i] !== 'string')
             return false;
-        const languageCode = codes[i].split('-')[0];
-        const currentLanguage = _mapCodeToLanguage(languageCode);
+        var languageCode = codes[i].split('-')[0];
+        var currentLanguage = _mapCodeToLanguage(languageCode);
         if (language === null) {
             language = currentLanguage;
         }

package/dist/{cjs/codes → codes}/getLanguageDirection.js

@@ -27,7 +27,7 @@ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
  *
  * @type {string[]}
  */
-const rtlLanguages = [
+var rtlLanguages = [
     'ae', /* Avestan */
     'ar', /* 'العربية', Arabic */
     'arc', /* Aramaic */
@@ -50,7 +50,7 @@ const rtlLanguages = [
     'yi' /* 'ייִדיש', Yiddish */
 ];
 /* ----- END YAHOO COPYRIGHT ----- */
-const codes_js_1 = require("./codes.js");
+var codes_js_1 = require("./codes.js");
 /**
  * Get the text direction for a given language code.
  *
@@ -59,9 +59,9 @@ const codes_js_1 = require("./codes.js");
 * @internal
 */
 function _getLanguageDirection(code) {
-    return rtlLanguages.some(language => {
-        const lo = (0, codes_js_1._getLanguageObject)(language);
-        const clo = (0, codes_js_1._getLanguageObject)(code);
+    return rtlLanguages.some(function (language) {
+        var lo = (0, codes_js_1._getLanguageObject)(language);
+        var clo = (0, codes_js_1._getLanguageObject)(code);
         if (!lo || !clo)
             return false;
         if (lo.script && clo.script && lo.script !== clo.script)

package/dist/format/_format.js

@@ -0,0 +1,62 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports._num = _num;
+exports._datetime = _datetime;
+exports._currency = _currency;
+/**
+ * Formats a number according to the specified languages and options.
+ *
+ * @param {Object} params - The parameters for the number formatting.
+ * @param {number} params.value - The number to format.
+ * @param {string | string[]} [params.languages=['en']] - The languages to use for formatting.
+ * @param {Intl.NumberFormatOptions} [params.options={}] - Additional options for number formatting.
+ *
+ * @returns {string} The formatted number.
+ * @internal
+ */
+function _num(_a) {
+    var value = _a.value, _b = _a.languages, languages = _b === void 0 ? ['en'] : _b, _c = _a.options, options = _c === void 0 ? {} : _c;
+    return new Intl.NumberFormat(languages, __assign({ numberingSystem: 'latn' }, options)).format(value);
+}
+/**
+ * Formats a date according to the specified languages and options.
+ *
+ * @param {Object} params - The parameters for the date formatting.
+ * @param {Date} params.value - The date to format.
+ * @param {string | string[]} [params.languages=['en']] - The languages to use for formatting.
+ * @param {Intl.DateTimeFormatOptions} [params.options={}] - Additional options for date formatting.
+ *
+ * @returns {string} The formatted date.
+ * @internal
+ */
+function _datetime(_a) {
+    var value = _a.value, _b = _a.languages, languages = _b === void 0 ? ['en'] : _b, _c = _a.options, options = _c === void 0 ? {} : _c;
+    return new Intl.DateTimeFormat(languages, __assign({ calendar: "gregory", numberingSystem: "latn" }, options)).format(value);
+}
+/**
+ * Formats a currency value according to the specified languages, currency, and options.
+ *
+ * @param {Object} params - The parameters for the currency formatting.
+ * @param {number} params.value - The currency value to format.
+ * @param {string} params.currency - The currency code (e.g., 'USD').
+ * @param {string | string[]} [params.languages=['en']] - The languages to use for formatting.
+ * @param {Intl.NumberFormatOptions} [params.options={}] - Additional options for currency formatting.
+ *
+ * @returns {string} The formatted currency value.
+ * @internal
+ */
+function _currency(_a) {
+    var value = _a.value, _b = _a.languages, languages = _b === void 0 ? ['en'] : _b, _c = _a.currency, currency = _c === void 0 ? 'USD' : _c, _d = _a.options, options = _d === void 0 ? {} : _d;
+    return new Intl.NumberFormat(languages, __assign({ style: 'currency', currency: currency, numberingSystem: 'latn' }, options)).format(value);
+}

package/dist/{cjs/index.d.ts → index.d.ts}

@@ -1,6 +1,7 @@
 import { LanguageObject } from './codes/codes';
-import { Request } from './translation/_bundleTranslation';
-import { Update } from './translation/_updateRemoteDictionary';
+import { Request } from './translation/_translateBundle';
+import { Update } from './translation/_updateProjectDictionary';
+import { _num, _datetime, _currency } from './format/_format';
 /**
  * Type representing the constructor parameters for the GT class.
  */
@@ -29,30 +30,20 @@ declare class GT {
      */
     constructor({ apiKey, defaultLanguage, projectID, baseURL }?: GTConstructorParams);
     /**
-    * Translates a string into a target language.
-    * @param {string} content - A string to translate.
-    * @param {string} targetLanguage - The target language for the translation.
-    * @param {{ notes?: string, [key: string]: any }} metadata - Additional metadata for the translation request.
-    * @returns {Promise<{ translation: string, error?: Error | unknown }>} - The translated content with optional error information.
-    */
+     * Translates a string into a target language.
+     * If `metadata.store` is provided, the translation is cached for use in a public project.
+     *
+     * @param {string} content - The string to be translated.
+     * @param {string} targetLanguage - The target language code (e.g., 'en', 'fr') for the translation.
+     * @param {{ context?: string, store?: boolean, [key: string]: any }} [metadata] - Additional metadata for the translation request.
+     * @param {string} [metadata.context] - Contextual information to assist with the translation.
+     * @param {boolean} [metadata.store] - Whether to cache the translation for use in a public project.
+     *
+     * @returns {Promise<{ translation: string, error?: Error | unknown }>} - A promise that resolves to the translated content, or an error if the translation fails.
+     */
     translate(content: string, targetLanguage: string, metadata?: {
-        notes?: string;
-        [key: string]: any;
-    }): Promise<{
-        translation: string;
-        error?: Error | unknown;
-    }>;
-    /**
-    * Translates a string and caches for use in a public project.
-    * @param {string} content - A string to translate.
-    * @param {string} targetLanguage - The target language for the translation.
-    * @param {string} projectID - The ID of the project.
-    * @param {dictionaryName?: string, context?: string, [key: string]: any }} metadata - Additional metadata for the translation request.
-    * @returns {Promise<{ translation: string, error?: Error | unknown }>} The translated content with optional error information.
-    */
-    intl(content: string, targetLanguage: string, projectID?: string, metadata?: {
-        dictionaryName?: string;
         context?: string;
+        store?: boolean;
         [key: string]: any;
     }): Promise<{
         translation: string;
@@ -68,7 +59,9 @@ declare class GT {
     *
     * @returns {Promise<any>} - A promise that resolves to the translated content.
     */
-    translateReactChildren(content: any, targetLanguage: string, metadata?: {
+    translateReact(content: any, targetLanguage: string, metadata?: {
+        context?: string;
+        store?: boolean;
         [key: string]: any;
     }): Promise<{
         translation: any | null;
@@ -79,7 +72,7 @@ declare class GT {
     * @param requests - Array of requests to be processed and sent.
     * @returns A promise that resolves to an array of processed results.
     */
-    bundleTranslation(requests: Request[]): Promise<Array<any | null>>;
+    translateBundle(requests: Request[]): Promise<Array<any | null>>;
     /**
     * Pushes updates to a remotely cached translation dictionary.
     * @param {Update[]} updates - Array of updates with optional targetLanguage.
@@ -88,7 +81,7 @@ declare class GT {
     * @param {boolean} [replace=false] - Whether to replace the existing dictionary. Defaults to false.
     * @returns {Promise<string[]>} A promise that resolves to an array of strings indicating the languages which have been updated.
     */
-    updateRemoteDictionary(updates: Update[], languages?: string[], projectID?: string, replace?: boolean): Promise<string[]>;
+    updateProjectDictionary(updates: Update[], languages?: string[], projectID?: string, replace?: boolean): Promise<string[]>;
 }
 export default GT;
 /**
@@ -151,3 +144,31 @@ export declare function getLanguageName(codes: string[]): string[];
  * @returns {boolean} True if all BCP 47 codes represent the same language, false otherwise.
  */
 export declare function isSameLanguage(...codes: string[]): boolean;
+/**
+ * Formats a number according to the specified languages and options.
+ * @param {Object} params - The parameters for the number formatting.
+ * @param {number} params.value - The number to format.
+ * @param {string | string[]} [params.languages=['en']] - The languages to use for formatting.
+ * @param {Intl.NumberFormatOptions} [params.options={}] - Additional options for number formatting.
+ * @returns {string} The formatted number.
+ */
+export declare const num: typeof _num;
+/**
+ * Formats a date according to the specified languages and options.
+ * @param {Object} params - The parameters for the date formatting.
+ * @param {Date} params.value - The date to format.
+ * @param {string | string[]} [params.languages=['en']] - The languages to use for formatting.
+ * @param {Intl.DateTimeFormatOptions} [params.options={}] - Additional options for date formatting.
+ * @returns {string} The formatted date.
+ */
+export declare const datetime: typeof _datetime;
+/**
+ * Formats a currency value according to the specified languages, currency, and options.
+ * @param {Object} params - The parameters for the currency formatting.
+ * @param {number} params.value - The currency value to format.
+ * @param {string} params.currency - The currency code (e.g., 'USD').
+ * @param {string | string[]} [params.languages=['en']] - The languages to use for formatting.
+ * @param {Intl.NumberFormatOptions} [params.options={}] - Additional options for currency formatting.
+ * @returns {string} The formatted currency value.
+ */
+export declare const currency: typeof _currency;