generaltranslation 2.0.55 → 2.0.56

package/dist/mjs/index.d.ts

@@ -1,153 +0,0 @@
-import { LanguageObject } from './codes/codes';
-import { Request } from './translation/_bundleTranslation';
-import { Update } from './translation/_updateRemoteDictionary';
-/**
- * Type representing the constructor parameters for the GT class.
- */
-type GTConstructorParams = {
-    apiKey?: string;
-    defaultLanguage?: string;
-    projectID?: string;
-    baseURL?: string;
-};
-/**
- * GT is the core driver for the General Translation library.
- */
-declare class GT {
-    apiKey: string;
-    defaultLanguage: string;
-    projectID: string;
-    baseURL: string;
-    /**
-     * Constructs an instance of the GT class.
-     *
-     * @param {GTConstructorParams} [params] - The parameters for initializing the GT instance.
-     * @param {string} [params.apiKey=''] - The API key for accessing the translation service.
-     * @param {string} [params.defaultLanguage='en'] - The default language for translations.
-     * @param {string} [params.projectID=''] - The project ID for the translation service.
-     * @param {string} [params.baseURL='https://prod.gtx.dev'] - The base URL for the translation service.
-     */
-    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.
-    */
-    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;
-        [key: string]: any;
-    }): Promise<{
-        translation: string;
-        error?: Error | unknown;
-    }>;
-    /**
-    * Translates the content of React children elements.
-    *
-    * @param {Object} params - The parameters for the translation.
-    * @param {any} params.content - The React children content to be translated.
-    * @param {string} params.targetLanguage - The target language for the translation.
-    * @param {Object} params.metadata - Additional metadata for the translation process.
-    *
-    * @returns {Promise<any>} - A promise that resolves to the translated content.
-    */
-    translateReactChildren(content: any, targetLanguage: string, metadata?: {
-        [key: string]: any;
-    }): Promise<{
-        translation: any | null;
-        error?: Error | unknown;
-    }>;
-    /**
-    * Bundles multiple translation requests and sends them to the server.
-    * @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>>;
-    /**
-    * Pushes updates to a remotely cached translation dictionary.
-    * @param {Update[]} updates - Array of updates with optional targetLanguage.
-    * @param {string[]} [languages] - Array of languages to be updated.
-    * @param {string} [projectID=this.projectID] - The ID of the project. Defaults to the instance's projectID.
-    * @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[]>;
-}
-export default GT;
-/**
- * Gets the writing direction for a given BCP 47 language code.
- * @param {string} code - The BCP 47 language code to check.
- * @returns {string} The language direction ('ltr' for left-to-right or 'rtl' for right-to-left).
- */
-export declare const getLanguageDirection: (code: string) => string;
-/**
- * Checks if a given BCP 47 language code is valid.
- * @param {string} code - The BCP 47 language code to validate.
- * @returns {boolean} True if the BCP 47 code is valid, false otherwise.
- */
-export declare const isValidLanguageCode: (code: string) => boolean;
-/**
- * Standardizes a BCP 47 language code to ensure correct formatting.
- * @param {string} code - The BCP 47 language code to standardize.
- * @returns {string} The standardized BCP 47 language code.
- */
-export declare const standardizeLanguageCode: (code: string) => string;
-/**
- * Gets a language object from a BCP 47 language code.
- * @param {string} code - The BCP 47 language code to convert.
- * @returns {LanguageObject | null} The language object or null if the BCP 47 code is invalid.
- */
-export declare function getLanguageObject(code: string): LanguageObject | null;
-/**
- * Gets language objects from multiple BCP 47 language codes.
- * @param {string[]} codes - The BCP 47 language codes to convert.
- * @returns {(LanguageObject | null)[]} An array of language objects or null for each invalid BCP 47 code.
- */
-export declare function getLanguageObject(codes: string[]): (LanguageObject | null)[];
-/**
- * Gets a BCP 47 language code from a language name.
- * @param {string} language - The language name to convert.
- * @returns {string} The corresponding BCP 47 language code.
- */
-export declare function getLanguageCode(language: string): string;
-/**
- * Gets BCP 47 language codes from multiple language names.
- * @param {string[]} languages - The language names to convert.
- * @returns {string[]} The corresponding BCP 47 language codes.
- */
-export declare function getLanguageCode(languages: string[]): string[];
-/**
- * Gets a language name from a BCP 47 language code.
- * @param {string} code - The BCP 47 language code to convert.
- * @returns {string} The corresponding language name.
- */
-export declare function getLanguageName(code: string): string;
-/**
- * Gets language names from multiple BCP 47 language codes.
- * @param {string[]} codes - The BCP 47 language codes to convert.
- * @returns {string[]} The corresponding language names.
- */
-export declare function getLanguageName(codes: string[]): string[];
-/**
- * Checks if multiple BCP 47 language codes represent the same language.
- * @param {string[]} codes - The BCP 47 language codes to compare.
- * @returns {boolean} True if all BCP 47 codes represent the same language, false otherwise.
- */
-export declare function isSameLanguage(...codes: string[]): boolean;

package/dist/mjs/index.js

@@ -1,130 +0,0 @@
-// `generaltranslation` language toolkit
-// © 2024, General Translation, Inc.
-// ----- IMPORTS ----- //
-import { _isValidLanguageCode, _standardizeLanguageCode, _getLanguageObject, _getLanguageCode, _getLanguageName, _isSameLanguage } from './codes/codes';
-import _getLanguageDirection from './codes/getLanguageDirection';
-import _bundleTranslation from './translation/_bundleTranslation';
-import _intl from './translation/_intl';
-import _translate from './translation/_translate';
-import _translateReactChildren from './translation/_translateReactChildren';
-import _updateRemoteDictionary from './translation/_updateRemoteDictionary';
-// ----- CORE CLASS ----- // 
-const getDefaultFromEnv = (VARIABLE) => {
-    if (typeof process !== 'undefined' && process.env) {
-        return process.env[VARIABLE] || '';
-    }
-    return '';
-};
-/**
- * GT is the core driver for the General Translation library.
- */
-class GT {
-    /**
-     * Constructs an instance of the GT class.
-     *
-     * @param {GTConstructorParams} [params] - The parameters for initializing the GT instance.
-     * @param {string} [params.apiKey=''] - The API key for accessing the translation service.
-     * @param {string} [params.defaultLanguage='en'] - The default language for translations.
-     * @param {string} [params.projectID=''] - The project ID for the translation service.
-     * @param {string} [params.baseURL='https://prod.gtx.dev'] - The base URL for the translation service.
-     */
-    constructor({ apiKey = '', defaultLanguage = 'en', projectID = '', baseURL = 'https://prod.gtx.dev' } = {}) {
-        this.apiKey = apiKey || getDefaultFromEnv('GT_API_KEY');
-        this.projectID = projectID || getDefaultFromEnv('GT_PROJECT_ID');
-        this.defaultLanguage = defaultLanguage.toLowerCase();
-        this.baseURL = baseURL;
-    }
-    /**
-    * 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.
-    */
-    async translate(content, targetLanguage, metadata) {
-        return await _translate(this, content, targetLanguage, { projectID: this.projectID, defaultLanguage: this.defaultLanguage, ...metadata });
-    }
-    /**
-    * 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.
-    */
-    async intl(content, targetLanguage, projectID, metadata) {
-        return await _intl(this, content, targetLanguage, projectID || this.projectID, { projectID: projectID || this.projectID, defaultLanguage: this.defaultLanguage, ...metadata });
-    }
-    /**
-    * Translates the content of React children elements.
-    *
-    * @param {Object} params - The parameters for the translation.
-    * @param {any} params.content - The React children content to be translated.
-    * @param {string} params.targetLanguage - The target language for the translation.
-    * @param {Object} params.metadata - Additional metadata for the translation process.
-    *
-    * @returns {Promise<any>} - A promise that resolves to the translated content.
-    */
-    async translateReactChildren(content, targetLanguage, metadata) {
-        return await _translateReactChildren(this, content, targetLanguage, { projectID: this.projectID, defaultLanguage: this.defaultLanguage, ...metadata });
-    }
-    /**
-    * Bundles multiple translation requests and sends them to the server.
-    * @param requests - Array of requests to be processed and sent.
-    * @returns A promise that resolves to an array of processed results.
-    */
-    async bundleTranslation(requests) {
-        return _bundleTranslation(this, requests);
-    }
-    /**
-    * Pushes updates to a remotely cached translation dictionary.
-    * @param {Update[]} updates - Array of updates with optional targetLanguage.
-    * @param {string[]} [languages] - Array of languages to be updated.
-    * @param {string} [projectID=this.projectID] - The ID of the project. Defaults to the instance's projectID.
-    * @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.
-    */
-    async updateRemoteDictionary(updates, languages = [], projectID = this.projectID, replace = false) {
-        return _updateRemoteDictionary(this, updates, languages, projectID, replace);
-    }
-}
-// ----- EXPORTS ----- //
-// Export the class
-export default GT;
-// Export the functions 
-/**
- * Gets the writing direction for a given BCP 47 language code.
- * @param {string} code - The BCP 47 language code to check.
- * @returns {string} The language direction ('ltr' for left-to-right or 'rtl' for right-to-left).
- */
-export const getLanguageDirection = (code) => _getLanguageDirection(code);
-/**
- * Checks if a given BCP 47 language code is valid.
- * @param {string} code - The BCP 47 language code to validate.
- * @returns {boolean} True if the BCP 47 code is valid, false otherwise.
- */
-export const isValidLanguageCode = (code) => _isValidLanguageCode(code);
-/**
- * Standardizes a BCP 47 language code to ensure correct formatting.
- * @param {string} code - The BCP 47 language code to standardize.
- * @returns {string} The standardized BCP 47 language code.
- */
-export const standardizeLanguageCode = (code) => _standardizeLanguageCode(code);
-export function getLanguageObject(codes) {
-    return Array.isArray(codes) ? _getLanguageObject(codes) : _getLanguageObject(codes);
-}
-export function getLanguageCode(languages) {
-    return _getLanguageCode(languages);
-}
-export function getLanguageName(codes) {
-    return _getLanguageName(codes);
-}
-/**
- * Checks if multiple BCP 47 language codes represent the same language.
- * @param {string[]} codes - The BCP 47 language codes to compare.
- * @returns {boolean} True if all BCP 47 codes represent the same language, false otherwise.
- */
-export function isSameLanguage(...codes) {
-    return _isSameLanguage(...codes);
-}
-;

package/dist/mjs/translation/_bundleTranslation.d.ts

@@ -1,22 +0,0 @@
-export type Request = {
-    type: 'translate';
-    data: {
-        content: string;
-        targetLanguage: string;
-        metadata: Record<string, any>;
-    };
-} | {
-    type: 'intl';
-    data: {
-        content: string;
-        targetLanguage: string;
-        metadata: Record<string, any>;
-    };
-} | {
-    type: 'react';
-    data: {
-        children: object | string;
-        targetLanguage: string;
-        metadata: Record<string, any>;
-    };
-};

package/dist/mjs/translation/_bundleTranslation.js

@@ -1,39 +0,0 @@
-/**
- * Bundles multiple requests and sends them to the server.
- * @param {{ baseURL: string, apiKey: string }} gt - Contains the baseURL and apiKey for the server request.
- * @param {Request[]} requests - Array of requests to be processed and sent.
- * @param {{ timeout?: number }} options - Additional options for the request, including timeout.
- * @returns {Promise<Array<any | null>>} A promise that resolves to an array of processed results.
- * @internal
- */
-export default async function _bundleTranslation(gt, requests) {
-    const controller = new AbortController();
-    const signal = controller.signal;
-    if (requests[0]?.data?.metadata?.timeout) {
-        setTimeout(() => controller.abort(), requests[0].data.metadata.timeout);
-    }
-    try {
-        const response = await fetch(`${gt.baseURL}/bundle`, {
-            method: 'POST',
-            headers: {
-                'Content-Type': 'application/json',
-                'gtx-api-key': gt.apiKey,
-            },
-            body: JSON.stringify(requests),
-            signal
-        });
-        if (!response.ok) {
-            throw new Error(`${response.status}: ${await response.text()}`);
-        }
-        const resultArray = await response.json();
-        return resultArray;
-    }
-    catch (error) {
-        if (error instanceof Error && error.name === 'AbortError') {
-            console.error('Request timed out');
-            return Array.from(requests, () => ({ translation: null, error: 'Request timed out' }));
-        }
-        console.error(error);
-        return Array.from(requests, () => ({ translation: null, error: error }));
-    }
-}

package/dist/mjs/translation/_intl.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/mjs/translation/_intl.js

@@ -1,49 +0,0 @@
-/**
-    * Translates a single piece of content and caches for use in a public project.
-    * @param {{ baseURL: string, apiKey: string }} gt - The translation service configuration.
-    * @param {string} content - The content to translate.
-    * @param {string} targetLanguage - The target language for the translation.
-    * @param {string} projectID - The ID of the project
-    * @param {{ dictionaryName?: string, notes?: string, timeout?: number, [key: string]: any }} metadata - Additional metadata for the translation request.
-    * @returns {Promise<{ translation: string, error?: Error | unknown }>} - The translated content with optional error information.
-    * @internal
-*/
-export default async function _translate(gt, content, targetLanguage, projectID, metadata) {
-    const controller = new AbortController();
-    const signal = controller.signal;
-    if (metadata.timeout) {
-        setTimeout(() => controller.abort(), metadata.timeout);
-    }
-    try {
-        const response = await fetch(`${gt.baseURL}/translate`, {
-            method: 'POST',
-            headers: {
-                'Content-Type': 'application/json',
-                'gtx-api-key': gt.apiKey,
-            },
-            body: JSON.stringify({
-                content, targetLanguage, projectID, metadata
-            }),
-            signal
-        });
-        if (!response.ok) {
-            throw new Error(`${response.status}: ${await response.text()}`);
-        }
-        const result = await response.json();
-        return result;
-    }
-    catch (error) {
-        if (error instanceof Error && error.name === 'AbortError') {
-            console.error('Request timed out');
-            return {
-                translation: content,
-                error: 'Request timed out'
-            };
-        }
-        console.error(error);
-        return {
-            translation: content,
-            error: error
-        };
-    }
-}

package/dist/mjs/translation/_translate.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/mjs/translation/_translate.js

@@ -1,48 +0,0 @@
-/**
- * Translates a string.
- * @param {{ baseURL: string, apiKey: string }} gt - The translation service configuration.
- * @param {string} content - The content to translate.
- * @param {string} targetLanguage - The target language for the translation.
- * @param {{ notes?: string, timeout?: number, [key: string]: any }} metadata - Additional metadata for the translation request.
- * @returns {Promise<{ translation: string, error?: Error | unknown }>} - The translated content with optional error information.
- * @internal
- */
-export default async function _translate(gt, content, targetLanguage, metadata) {
-    const controller = new AbortController();
-    const signal = controller.signal;
-    if (metadata.timeout) {
-        setTimeout(() => controller.abort(), metadata.timeout);
-    }
-    try {
-        const response = await fetch(`${gt.baseURL}/translate`, {
-            method: 'POST',
-            headers: {
-                'Content-Type': 'application/json',
-                'gtx-api-key': gt.apiKey,
-            },
-            body: JSON.stringify({
-                content, targetLanguage, metadata
-            }),
-            signal
-        });
-        if (!response.ok) {
-            throw new Error(`${response.status}: ${await response.text()}`);
-        }
-        const result = await response.json();
-        return result;
-    }
-    catch (error) {
-        if (error instanceof Error && error.name === 'AbortError') {
-            console.error('Request timed out');
-            return {
-                translation: content,
-                error: 'Request timed out'
-            };
-        }
-        console.error(error);
-        return {
-            translation: content,
-            error: error
-        };
-    }
-}

package/dist/mjs/translation/_translateReactChildren.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/mjs/translation/_translateReactChildren.js

@@ -1,53 +0,0 @@
-/**
- * Translates the given content into the target language using a specified API.
- *
- * @param {{ baseURL: string, apiKey: string }} gt - An object containing baseURL and apiKey for the API.
- * @param {any} content - The content to be translated. This can be of any type.
- * @param {string} targetLanguage - The target language code (e.g., 'en', 'fr') for the translation.
- * @param {{ [key: string]: any }} metadata - Additional metadata to be sent with the translation request.
- *
- * @returns {Promise<{ translation: any | null, error?: Error | unknown }>} - A promise that resolves to the translated content as an object, or null if an error occurs.
- *
- * @throws {Error} - Throws an error if the response from the API is not ok (status code not in the range 200-299).
- * @internal
-**/
-export default async function _translateReactChildren(gt, content, targetLanguage, metadata) {
-    const controller = new AbortController();
-    const signal = controller.signal;
-    if (metadata.timeout) {
-        setTimeout(() => controller.abort(), metadata.timeout);
-    }
-    try {
-        const response = await fetch(`${gt.baseURL}/react`, {
-            method: 'POST',
-            headers: {
-                'Content-Type': 'application/json',
-                'gtx-api-key': gt.apiKey,
-            },
-            body: JSON.stringify({
-                content: content,
-                targetLanguage: targetLanguage,
-                metadata: metadata
-            }),
-            signal
-        });
-        if (!response.ok) {
-            throw new Error(`${response.status}: ${await response.text()}`);
-        }
-        return await response.json();
-    }
-    catch (error) {
-        if (error instanceof Error && error.name === 'AbortError') {
-            console.error('Request timed out');
-            return {
-                translation: null,
-                error: 'Request timed out'
-            };
-        }
-        console.error(error);
-        return {
-            translation: null,
-            error: error
-        };
-    }
-}

package/dist/mjs/translation/_updateRemoteDictionary.d.ts

@@ -1,17 +0,0 @@
-export type Update = {
-    type: 'react';
-    data: {
-        children: object | string;
-        metadata: Record<string, any>;
-    };
-} | {
-    type: 'intl';
-    data: {
-        content: string;
-        metadata: Record<string, any>;
-    };
-};
-export default function _updateRemoteDictionary(gt: {
-    baseURL: string;
-    apiKey: string;
-}, updates: Update[], languages: string[], projectID: string, replace: boolean): Promise<string[]>;

package/dist/mjs/translation/_updateRemoteDictionary.js

@@ -1,27 +0,0 @@
-export default async function _updateRemoteDictionary(gt, updates, languages, projectID, replace) {
-    try {
-        const response = await fetch(`${gt.baseURL}/update`, {
-            method: 'POST',
-            headers: {
-                'Content-Type': 'application/json',
-                'gtx-api-key': gt.apiKey,
-            },
-            body: JSON.stringify({
-                updates, languages, projectID, replace
-            })
-        });
-        if (!response.ok) {
-            throw new Error(`${response.status}: ${await response.text()}`);
-        }
-        const result = await response.json();
-        return result.languages;
-    }
-    catch (error) {
-        if (error instanceof Error && error.name === 'AbortError') {
-            console.error('Request timed out');
-            return [];
-        }
-        console.error(error);
-        return [];
-    }
-}