generaltranslation 1.1.23 → 1.1.25

package/README.md

@@ -18,7 +18,6 @@ npm i generaltranslation
 
 ```
 import GT from 'generaltranslation'
-// or const GT = require('generaltranslation')
 
 const gt = new GT()
 ```
@@ -55,35 +54,27 @@ const codes = gt.getLanguageCodes(['French', 'Spanish'])
 console.log(codes) // ['fr', 'es']
 ```
 
-## Which languages do AI models understand?
+## Get a user's language
 
-We continually benchmark AI models and add new models as they are released. That means these functions have to be <code>async</code>. This information is provided as a public service. It's completely free and requires no API key.
+### getUserLanguage() 
 
-### async getModelList()
-
-Get the latest list of models for which there is data. Returns an array of model names.
+Returns a user's default browser language. Meant for use in a web browser.
 
 ```
-const models = await gt.getModelList();
-console.log(models) // ['gpt-4', ... ]
+const userLanguage = getUserLanguage();
+console.log(userLanguage) // 'en'
 ```
 
-### async getModelLanguages(model)
-
-Get all languages known to be compatible with a given AI model. Returns an array of languages codes, or null if the model is unknown.
+If invoked on an instance of the GT class, this function will return the default language of that instance, similar to accessing the `defaultLanguage` property.
 
 ```
-const languages = await gt.getModelLanguages('mixtral-8x7b')
-console.log(languages) // ['en', 'fr', 'de', 'es', 'it']
-```
-
-### async isSupportedLanguage(model, code)
+import GT from 'generaltranslation'
 
-Returns true if a model is known to be compatible with a given language, represented by an ISO-639 language code. Returns false otherwise.
+const gt = new GT({
+    defaultLanguage: 'en'
+});
 
-```
-const supported = await gt.isSupportedLanguage('gpt-4', 'fr')
-console.log(supported) // true
+console.log(gt.getUserLanguage()) // same as gt.defaultLanguage
 ```
 
 ## Prompt Internationalization API
@@ -150,4 +141,35 @@ This also works:
 
 ```
 const translatedPrompt = await gt.translatePrompt({ text: 'Tell me a story' }, 'es');
-```
+```
+
+## Which languages do AI models understand?
+
+We continually benchmark AI models and add new models as they are released. That means these functions have to be <code>async</code>. This information is provided as a public service. It's completely free and requires no API key.
+
+### async getModelList()
+
+Get the latest list of models for which there is data. Returns an array of model names.
+
+```
+const models = await gt.getModelList();
+console.log(models) // ['gpt-4', ... ]
+```
+
+### async getModelLanguages(model)
+
+Get all languages known to be compatible with a given AI model. Returns an array of languages codes, or null if the model is unknown.
+
+```
+const languages = await gt.getModelLanguages('mixtral-8x7b')
+console.log(languages) // ['en', 'fr', 'de', 'es', 'it']
+```
+
+### async isSupportedLanguage(model, code)
+
+Returns true if a model is known to be compatible with a given language, represented by an ISO-639 language code. Returns false otherwise.
+
+```
+const supported = await gt.isSupportedLanguage('gpt-4', 'fr')
+console.log(supported) // true
+```

package/client/getUserLanguage.js

@@ -0,0 +1,14 @@
+// Returns a user's default browser language
+// e.g. 'en-US', not necessarily 'en'
+// generaltranslation handles this well, but other libraries may not
+// (it's a skill issue I'm afraid) 
+export default function _getUserLanguage({defaultLanguage = ''} = {}) {
+    if (typeof window !== 'undefined' && window?.navigator) {
+        return navigator?.language || navigator?.userLanguage || defaultLanguage || '';
+    } else if (defaultLanguage) {
+        return defaultLanguage;
+    } else {
+        console.error("getUserLanguage error. It's likely you've called getUserLanguage() on the server. This is inadvisable and without a default language will return an empty string.")
+        return ''
+    }
+}

package/codes/639-1/{CodeToLanguage.json → CodeToLanguage.js}

@@ -1,4 +1,4 @@
-{
+const CodeToLanguage = {
     "ab": "Abkhazian",
     "aa": "Afar",
     "af": "Afrikaans",
@@ -182,4 +182,5 @@
     "yo": "Yoruba",
     "za": "Zhuang",
     "zu": "Zulu"
-}
+}
+export default CodeToLanguage;

package/codes/639-1/{LanguageToCode.json → LanguageToCode.js}

@@ -1,4 +1,4 @@
-{
+const LanguageToCode = {
     "abkhazian": "ab",
     "afar": "aa",
     "afrikaans": "af",
@@ -224,4 +224,5 @@
     "zhuang": "za",
     "chuang": "za",
     "zulu": "zu"
-}
+}
+export default LanguageToCode;

package/codes/639-3/{CodeToLanguageTriletter.json → CodeToLanguageTriletter.js}

@@ -1,4 +1,4 @@
-{
+const CodeToLanguageTriletter = {
     "abk": "Abkhazian",
     "aar": "Afar",
     "afr": "Afrikaans",
@@ -184,3 +184,4 @@
     "zha": "Zhuang",
     "zul": "Zulu"
 }
+export default CodeToLanguageTriletter;

package/codes/639-3/{LanguageToCodeTriletter.json → LanguageToCodeTriletter.js}

@@ -1,4 +1,4 @@
-{
+const LanguageToCodeTriletter = {
     "abkhazian": "abk",
     "afar": "aar",
     "afrikaans": "afr",
@@ -225,4 +225,5 @@
     "zhuang": "zha",
     "chuang": "zha",
     "zulu": "zul"
-}
+}
+export default LanguageToCodeTriletter;

package/codes/codes.js

@@ -1,17 +1,27 @@
 // ----- IMPORTS ----- //
 
-const CodeToLanguage = require('./639-1/CodeToLanguage.json');
-const LanguageToCode = require('./639-1/LanguageToCode.json');
+import CodeToLanguage from './639-1/CodeToLanguage.js'
+import LanguageToCode from './639-1/LanguageToCode.js'
 
 // only for languages which have no two-letter code
-const CodeToLanguageTriletter = require('./639-3/CodeToLanguageTriletter.json');
-const LanguageToCodeTriletter = require('./639-3/LanguageToCodeTriletter.json');
+import CodeToLanguageTriletter from './639-3/CodeToLanguageTriletter.js'
+import LanguageToCodeTriletter from './639-3/LanguageToCodeTriletter.js'
 
 // ----- LANGUAGE CODES ----- //
 
 // Returns the name of a language from an ISO 639 code or an array of codes
-const _mapCodeToLanguage = code => CodeToLanguage[code] || CodeToLanguageTriletter[code] || '';
-const _getLanguageName = codes => {
+const _mapCodeToLanguage = code => {
+    if (code.length === 2) {
+        return CodeToLanguage[code]
+    } 
+    if (code.length === 3) {
+        CodeToLanguageTriletter[code]
+    }
+    else {
+        return CodeToLanguage[code.slice(0, 2)] || '';
+    }
+}
+export const _getLanguageName = codes => {
     return Array.isArray(codes) ? codes.map(_mapCodeToLanguage) : _mapCodeToLanguage(codes);
 }
 
@@ -21,10 +31,6 @@ const _mapLanguageToCode = language => {
     const lowerCaseLanguage = language.toLowerCase();
     return LanguageToCode[lowerCaseLanguage] || LanguageToCodeTriletter[lowerCaseLanguage] || '';
 }
-const _getLanguageCode = languages => {
+export const _getLanguageCode = languages => {
     return Array.isArray(languages) ? languages.map(_mapLanguageToCode) : _mapLanguageToCode(languages);
-}
-
-module.exports = {
-    _getLanguageName, _getLanguageCode
 }

package/index.js

@@ -3,20 +3,21 @@
 
 // ----- IMPORTS ----- //
 
-const { _getLanguageName, _getLanguageCode } = require('./codes/codes.js');
-const { _getModelList, _getModelInfo, _getAllModelInfo, _getModelLanguages, _isLanguageSupported, _getModelsByDeveloper, _getModelsByLanguage, } = require('./models/models.js');
-const { _translatePrompt } = require('./prompts/translate.js');
+import _getUserLanguage from "./client/getUserLanguage.js";
+import { _getLanguageCode, _getLanguageName } from "./codes/codes.js"
+import { _getModelInfo, _getModelList, _getModelLanguages, _isLanguageSupported, _getModelsByDeveloper, _getModelsByLanguage } from "./models/models.js"
+import _translatePrompt from "./prompts/translate.js"
 
 // ----- CORE CLASS ----- // 
 
-class GT {
+export default class GT {
 
     constructor({
         apiKey = '', 
         defaultLanguage = 'en',
         baseURL = 'https://translate.gtx.dev'
     } = {}) {
-        this.apiKey = apiKey;
+        this.apiKey = apiKey || (typeof process !== 'undefined' ? process.env.GT_API_KEY : '');
         this.defaultLanguage = defaultLanguage;
         this.baseURL = baseURL;
     }
@@ -28,12 +29,18 @@ class GT {
     // Model information functions
     getModelList = _getModelList; // returns array of supported model names
     getModelInfo = _getModelInfo; // returns model object
-    getAllModelInfo =  _getAllModelInfo; // returns all info on all models
     getModelLanguages = _getModelLanguages; // e.g. 'mistral-7b' => ['en']
     isLanguageSupported = _isLanguageSupported; // e.g. ('mistral-7b', 'en') => true
     getModelsByLanguage = _getModelsByLanguage; // returns array of model names
     getModelsByDeveloper = _getModelsByDeveloper; // returns array of model names
 
+    // Get a user's browser language
+    getUserLanguage = () => {
+        return _getUserLanguage({
+            defaultLanguage: this.defaultLanguage
+        });
+    }
+
     // Prompt I18N
     translatePrompt = async (prompt, language) => {
         return await _translatePrompt({
@@ -43,15 +50,16 @@ class GT {
 
 }
 
-// ----- EXPORTS ----- //
-
-module.exports = GT;
-module.exports.getLanguageCode = _getLanguageCode;
-module.exports.getLanguageName = _getLanguageName;
-module.exports.getModelList = _getModelList;
-module.exports.getModelInfo = _getModelInfo;
-module.exports.getAllModelInfo = _getAllModelInfo;
-module.exports.getModelLanguages = _getModelLanguages;
-module.exports.isLanguageSupported = _isLanguageSupported;
-module.exports.getModelsByDeveloper = _getModelsByDeveloper;
-module.exports.getModelsByLanguage = _getModelsByLanguage;
+// ----- SECONDARY EXPORTS ----- //
+
+export {
+    _getLanguageCode as getLanguageCode,
+    _getLanguageName as getLanguageName,
+    _getModelList as getModelList,
+    _getModelInfo as getModelInfo,
+    _getModelLanguages as getModelLanguages,
+    _isLanguageSupported as isLanguageSupported,
+    _getModelsByDeveloper as getModelsByDeveloper,
+    _getModelsByLanguage as getModelsByLanguage,
+    _getUserLanguage as getUserLanguage
+};

package/models/models.js

@@ -1,7 +1,7 @@
 // ----- MODEL INFORMATION ----- //
 
 // Get all info on all models
-const _getAllModelInfo = async () => {
+export const _getAllModelInfo = async () => {
     try {
         const result = await fetch(`https://models.gtx.dev/all`);
         return await result.json();
@@ -13,7 +13,7 @@ const _getAllModelInfo = async () => {
 
 // Get all models by a given developer
 // Returns an empty array if none
-const _getModelsByDeveloper = async developer => {
+export const _getModelsByDeveloper = async developer => {
     if (!developer) return null;
     developer = developer?.toLowerCase();
     try {
@@ -28,7 +28,7 @@ const _getModelsByDeveloper = async developer => {
 
 // Get all models certified for a given language
 // Returns an empty array if none
-const _getModelsByLanguage = async language => {
+export const _getModelsByLanguage = async language => {
     if (!language) return null;
     language = language?.toLowerCase();
     try {
@@ -43,7 +43,7 @@ const _getModelsByLanguage = async language => {
 
 // Get all models
 // Returns an array of model names
-const _getModelList = async () => {
+export const _getModelList = async () => {
     try {
         const result = await fetch(`https://models.gtx.dev/models`);
         const models = await result.json();
@@ -56,7 +56,7 @@ const _getModelList = async () => {
 
 // Get all info about a given model
 // Returns an object or null if invalid
-const _getModelInfo = async model => {
+export const _getModelInfo = async model => {
     if (!model) return null;
     model = model?.toLowerCase();
     try {
@@ -69,27 +69,19 @@ const _getModelInfo = async model => {
     }
 }
 
+// ----- FUNCTIONS FROM MODEL INFO ----- //
+
 // Get all languages known to be compatible with a given LLM
 // Returns an array of languages codes, or null if unknown
-const _getModelLanguages = async model => {
+export const _getModelLanguages = async model => {
     const modelInfo = await _getModelInfo(model);
     return modelInfo?.languages;
 }
 
 // Returns true if a model is known to be compatible with a language
 // Returns false otherwise
-const _isLanguageSupported = async (model, code) => {
+export const _isLanguageSupported = async (model, code) => {
     if (!code) return false;
     const modelLanguages = await _getModelLanguages(model);
     return modelLanguages?.includes(code) ? true : false;
-}
-
-module.exports = {
-    _getModelList,
-    _getModelInfo,
-    _getModelLanguages,
-    _isLanguageSupported,
-    _getModelsByDeveloper,
-    _getModelsByLanguage,
-    _getAllModelInfo
 }

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "generaltranslation",
-  "version": "1.1.23",
+  "version": "1.1.25",
   "description": "A language toolkit for AI developers",
   "main": "index.js",
+  "type": "module",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },

package/prompts/translate.js

@@ -5,7 +5,7 @@ const _shouldTranslate = item => typeof item?.translate === 'boolean' ? item.tra
 
 // Pre-processes content to send to the API
 // Separates out text that shouldn't be translated.
-const _processContent = ({ content }) => {
+const _processPrompt = ({ content }) => {
     const processed = [];
     const untranslated = [];
     if (Array.isArray(content)) {
@@ -40,7 +40,7 @@ const _processContent = ({ content }) => {
 }
 
 // Build content string from array or single item
-const _constructContent = ({ content, untranslated = null}) => {
+const _constructPrompt = ({ content, untranslated = null}) => {
     if (Array.isArray(content)) {
         let final = '';
         for (const item of content) {
@@ -75,10 +75,10 @@ const _translatePrompt = async ({
 
     const defaultLanguage = context?.defaultLanguage;
     if (language === defaultLanguage) {
-        return _constructContent({ content: content });
+        return _constructPrompt({ content: content });
     };
 
-    const { processed, untranslated } = _processContent({ content });
+    const { processed, untranslated } = _processPrompt({ content });
     
     try {
         const response = await fetch(`${context?.baseURL}/prompt`, {
@@ -98,15 +98,13 @@ const _translatePrompt = async ({
             throw new Error(`${result || response.status}`);
         } else {
             const result = await response.json();
-            return _constructContent({content: result, untranslated: untranslated });
+            return _constructPrompt({content: result, untranslated: untranslated });
         }
     } catch (error) {
         console.error(error)
-        return _constructContent({ content: content })
+        return _constructPrompt({ content: content })
     }
 
 }
 
-module.exports = {
-    _translatePrompt
-}
+export default _translatePrompt;