generaltranslation 2.0.11 → 2.0.13

package/README.md

@@ -2,7 +2,7 @@
 
 <a href='https://www.generaltranslation.com' target="_blank">generaltranslation.com</a>
 
-A language toolkit for AI developers. Used in `@generaltranslation/react`.
+A language toolkit for AI developers. Used in `gt-react`.
 
 Full documentation coming soon!
 

package/dist/codes/codes.d.ts

@@ -1,3 +1,9 @@
+/**
+ * Check if a given language-country-script code is valid.
+ * @param {string} code - The language-country-script code to validate.
+ * @returns {boolean} - Returns true if valid, false otherwise.
+ */
+declare function _isValidLanguageCode(code: string): boolean;
 type LanguageObject = {
     language: string;
     script?: string;
@@ -31,4 +37,4 @@ declare const _getLanguageCode: (languages: string | string[]) => string | strin
  */
 declare function _isSameLanguage(...codes: string[]): boolean;
 declare function _isSameLanguage(codes: string[]): boolean;
-export { _getLanguageObject, _getLanguageName, _getLanguageCode, _isSameLanguage };
+export { _isValidLanguageCode, _getLanguageObject, _getLanguageName, _getLanguageCode, _isSameLanguage };

package/dist/codes/codes.js

@@ -5,6 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports._getLanguageCode = exports._getLanguageName = void 0;
+exports._isValidLanguageCode = _isValidLanguageCode;
 exports._getLanguageObject = _getLanguageObject;
 exports._isSameLanguage = _isSameLanguage;
 // Import modules for mapping ISO 639 codes to language names and vice versa
@@ -30,6 +31,23 @@ const CodeToRegion = CodeToRegion_json_1.default;
 // Import predefined common regions
 const Predefined_json_1 = __importDefault(require("./predefined/Predefined.json"));
 const Predefined = Predefined_json_1.default;
+// ----- VALIDITY CHECKS ----- //
+/**
+ * Check if a given language-country-script code is valid.
+ * @param {string} code - The language-country-script code to validate.
+ * @returns {boolean} - Returns true if valid, false otherwise.
+ */
+function _isValidLanguageCode(code) {
+    if (!code)
+        return false;
+    try {
+        const locale = new Intl.Locale(code);
+        return locale.baseName === code; // The baseName includes only the canonical language, script, and region
+    }
+    catch (error) {
+        return false;
+    }
+}
 // ----- FORMATTING HELPER FUNCTIONS ----- //
 /**
  * Capitalizes the first letter of a code and converts the rest to lowercase.
@@ -112,41 +130,19 @@ function _getLanguageObject(codes) {
  * @returns {LanguageObject|null} The language object.
  */
 const _handleGetLanguageObject = (code) => {
-    if (!code)
-        return null;
-    let languageObject = {
-        language: '',
-        script: '',
-        region: ''
-    };
-    const subtags = code.split('-');
-    // Look for language
-    const languageCode = subtags[0];
-    languageObject.language = _mapCodeToLanguage(languageCode);
-    // Look for script and region
-    if (subtags.length === 3) { // language-script-region
-        languageObject.script = _mapCodeToScript(subtags[1]);
-        languageObject.region = _mapCodeToRegion(subtags[2]);
+    try {
+        const locale = new Intl.Locale(code);
+        let languageObject = {
+            language: _mapCodeToLanguage(locale.language) || '',
+            script: locale.script ? _mapCodeToScript(locale.script) : '' || '',
+            region: locale.region ? _mapCodeToRegion(locale.region) : '' || ''
+        };
+        return languageObject.language ? languageObject : null;
     }
-    else if (subtags.length === 2) { // either language-script or language-region
-        if (_isScriptCode(subtags[1])) {
-            languageObject.script = _mapCodeToScript(subtags[1]);
-        }
-        else {
-            languageObject.region = _mapCodeToRegion(subtags[1]);
-        }
+    catch (error) {
+        // If the code is not a valid locale, return null
+        return null;
     }
-    return languageObject.language ? languageObject : null;
-};
-/**
- * Helper function to determine if a code is a script code.
- * @param {string} code - The code to check.
- * @returns {boolean} True if the code is a script code, false otherwise.
- */
-const _isScriptCode = (code) => {
-    if (code.length !== 4)
-        return false;
-    return true;
 };
 // ----- LANGUAGE NAMES FROM CODES ----- //
 /**
@@ -164,7 +160,7 @@ exports._getLanguageName = _getLanguageName;
  * @returns {string} The language name.
  */
 const _handleGetLanguageName = (code) => {
-    if (!code)
+    if (!_isValidLanguageCode(code))
         return '';
     if (Predefined[code])
         return Predefined[code];
@@ -245,7 +241,7 @@ const _handleGetLanguageCodeFromObject = (languageObject) => {
     if (languageObject.region) {
         code += `-${languageObject.region.toUpperCase()}`;
     }
-    return code;
+    return _isValidLanguageCode(code) ? code : '';
 };
 function _isSameLanguage(...codes) {
     // Flatten the array in case the codes are provided as an array

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { _getLanguageObject, _isSameLanguage } from './codes/codes';
+import { _isValidLanguageCode, _getLanguageObject, _isSameLanguage } from './codes/codes';
 /**
  * Type representing the constructor parameters for the GT class.
  */
@@ -80,6 +80,7 @@ declare class GT {
     bundleRequests(requests: any[]): Promise<Array<any | null>>;
 }
 export default GT;
+export declare const isValidLanguageCode: typeof _isValidLanguageCode;
 export declare const getLanguageObject: typeof _getLanguageObject;
 export declare const getLanguageCode: (languages: string | string[]) => string | string[];
 export declare const getLanguageName: (codes: string | string[]) => string | string[];

package/dist/index.js

@@ -14,7 +14,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isSameLanguage = exports.getLanguageName = exports.getLanguageCode = exports.getLanguageObject = void 0;
+exports.isSameLanguage = exports.getLanguageName = exports.getLanguageCode = exports.getLanguageObject = exports.isValidLanguageCode = void 0;
 // ----- IMPORTS ----- //
 const codes_1 = require("./codes/codes");
 const _bundleRequests_1 = __importDefault(require("./translation/_bundleRequests"));
@@ -105,6 +105,7 @@ class GT {
 // Export the class
 exports.default = GT;
 // Export the functions 
+exports.isValidLanguageCode = codes_1._isValidLanguageCode;
 exports.getLanguageObject = codes_1._getLanguageObject;
 exports.getLanguageCode = codes_1._getLanguageCode;
 exports.getLanguageName = codes_1._getLanguageName;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "generaltranslation",
-  "version": "2.0.11",
+  "version": "2.0.13",
   "description": "A language toolkit for AI developers",
   "main": "dist/index.js",
   "scripts": {
@@ -12,10 +12,12 @@
     "url": "git+https://github.com/General-Translation/generaltranslation.git"
   },
   "keywords": [
-    "LLM",
-    "prompting",
     "language",
     "translation",
+    "internationalization",
+    "localization",
+    "translate",
+    "i18n",
     "toolkit"
   ],
   "author": "General Translation, Inc.",