generaltranslation 2.0.60 → 2.0.62

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { LanguageObject } from './codes/codes';
-import { Request } from './translation/_translateBundle';
-import { Update } from './translation/_updateProjectDictionary';
+import { StringWithVariables } from './translation/strings/_translate';
+import { Content, Update, Request } from './types/types';
 /**
  * Type representing the constructor parameters for the GT class.
  */
@@ -29,36 +29,36 @@ declare class GT {
      */
     constructor({ apiKey, defaultLanguage, projectID, baseURL }?: GTConstructorParams);
     /**
-     * Translates a string into a target language.
+     * Translates a string or an array of strings/variables 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 {Content} content - The string or array of strings/variables 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.
+     * @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?: {
+    translate(content: Content, targetLanguage: string, metadata?: {
         context?: string;
         store?: boolean;
         [key: string]: any;
     }): Promise<{
-        translation: string;
+        translation: StringWithVariables | [];
         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 {any} params.children - 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.
     */
-    translateReact(content: any, targetLanguage: string, metadata?: {
+    translateReact(children: any, targetLanguage: string, metadata?: {
         context?: string;
         store?: boolean;
         [key: string]: any;

package/dist/index.js

@@ -63,10 +63,10 @@ exports.formatCurrency = formatCurrency;
 // ----- IMPORTS ----- //
 var codes_1 = require("./codes/codes");
 var getLanguageDirection_1 = __importDefault(require("./codes/getLanguageDirection"));
-var _translateBundle_1 = __importDefault(require("./translation/_translateBundle"));
-var _translate_1 = __importDefault(require("./translation/_translate"));
-var _translateReact_1 = __importDefault(require("./translation/_translateReact"));
-var _updateProjectDictionary_1 = __importDefault(require("./translation/_updateProjectDictionary"));
+var _translateBundle_1 = __importDefault(require("./translation/dictionaries/_translateBundle"));
+var _translate_1 = __importDefault(require("./translation/strings/_translate"));
+var _translateReact_1 = __importDefault(require("./translation/react/_translateReact"));
+var _updateProjectDictionary_1 = __importDefault(require("./translation/dictionaries/_updateProjectDictionary"));
 var _format_1 = require("./format/_format");
 // ----- CORE CLASS ----- // 
 var getDefaultFromEnv = function (VARIABLE) {
@@ -96,16 +96,16 @@ var GT = /** @class */ (function () {
         this.baseURL = baseURL;
     }
     /**
-     * Translates a string into a target language.
+     * Translates a string or an array of strings/variables 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 {Content} content - The string or array of strings/variables 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.
+     * @returns {Promise<{ translation: string, error?: Error | unknown }>} A promise that resolves to the translated content, or an error if the translation fails.
      */
     GT.prototype.translate = function (content, targetLanguage, metadata) {
         return __awaiter(this, void 0, void 0, function () {
@@ -121,17 +121,17 @@ var GT = /** @class */ (function () {
     * 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 {any} params.children - 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.
     */
-    GT.prototype.translateReact = function (content, targetLanguage, metadata) {
+    GT.prototype.translateReact = function (children, targetLanguage, metadata) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, (0, _translateReact_1.default)(this, content, targetLanguage, __assign({ projectID: this.projectID, defaultLanguage: this.defaultLanguage }, metadata))];
+                    case 0: return [4 /*yield*/, (0, _translateReact_1.default)(this, children, targetLanguage, __assign({ projectID: this.projectID, defaultLanguage: this.defaultLanguage }, metadata))];
                     case 1: return [2 /*return*/, _a.sent()];
                 }
             });

package/dist/translation/{_updateProjectDictionary.js → dictionaries/_updateProjectDictionary.js}

@@ -37,6 +37,9 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.default = _updateProjectDictionary;
+/**
+ * @internal
+ */
 function _updateProjectDictionary(gt, updates, languages, projectID, replace) {
     return __awaiter(this, void 0, void 0, function () {
         var response, _a, _b, _c, result, error_1;

package/dist/translation/react/_translateReact.d.ts

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

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

@@ -0,0 +1,7 @@
+export type StringWithVariables = string | {
+    variable?: string;
+    key: string;
+} | Array<string | {
+    variable?: string;
+    key: string;
+}>;

package/dist/types/types.d.ts

@@ -0,0 +1,33 @@
+export type Variable = {
+    variable?: string;
+    key: string;
+};
+export type Content = string | Array<string | Variable>;
+export type Update = {
+    type: 'react';
+    data: {
+        children: any;
+        metadata: Record<string, any>;
+    };
+} | {
+    type: 'string';
+    data: {
+        content: Content;
+        metadata: Record<string, any>;
+    };
+};
+export type Request = {
+    type: 'string';
+    data: {
+        content: Content;
+        targetLanguage: string;
+        metadata: Record<string, any>;
+    };
+} | {
+    type: 'react';
+    data: {
+        children: any;
+        targetLanguage: string;
+        metadata: Record<string, any>;
+    };
+};

package/dist/types/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "generaltranslation",
-  "version": "2.0.60",
+  "version": "2.0.62",
   "description": "A language toolkit for AI developers",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/dist/translation/_translateBundle.d.ts

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

package/dist/translation/_updateProjectDictionary.d.ts

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