gtx-cli 1.1.6 → 1.1.7-alpha.1

package/dist/api/sendFiles.d.ts

@@ -1,9 +1,10 @@
 import { Settings } from '../types';
-import { FileFormats } from '../types/data';
+import { FileFormats, DataFormat } from '../types/data';
 export interface FileToTranslate {
     content: string;
     fileName: string;
     fileFormat: FileFormats;
+    dataFormat: DataFormat;
 }
 type ApiOptions = Settings & {
     publish: boolean;

package/dist/api/sendFiles.js

@@ -35,6 +35,7 @@ function sendFiles(files, options) {
             files.forEach((file, index) => {
                 formData.append(`file${index}`, new Blob([file.content]), file.fileName);
                 formData.append(`fileFormat${index}`, file.fileFormat);
+                formData.append(`fileDataFormat${index}`, file.dataFormat); // Only used when translating JSON files
                 formData.append(`fileName${index}`, file.fileName);
             });
             // Add number of files

package/dist/cli/base.js

@@ -1,37 +1,4 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -52,17 +19,15 @@ const console_2 = require("../console/console");
 const setupConfig_1 = __importDefault(require("../fs/config/setupConfig"));
 const prompts_1 = require("@inquirer/prompts");
 const generaltranslation_1 = require("generaltranslation");
-const findFilepath_1 = __importStar(require("../fs/findFilepath"));
+const findFilepath_1 = __importDefault(require("../fs/findFilepath"));
 const errors_1 = require("../console/errors");
 const path_1 = __importDefault(require("path"));
 const fs_1 = __importDefault(require("fs"));
-const translate_1 = require("../formats/json/translate");
 const utils_1 = require("../fs/utils");
 const generateSettings_1 = require("../config/generateSettings");
 const chalk_1 = __importDefault(require("chalk"));
 const internal_1 = require("generaltranslation/internal");
-const translate_2 = require("../formats/files/translate");
-const SUPPORTED_DATA_FORMATS = ['JSX', 'ICU', 'I18NEXT'];
+const translate_1 = require("../formats/files/translate");
 class BaseCLI {
     // Constructor is shared amongst all CLI class types
     constructor(library, additionalModules) {
@@ -134,36 +99,8 @@ class BaseCLI {
                 dataFormat = 'JSX';
             }
             const { resolvedPaths: sourceFiles, placeholderPaths, transformPaths, } = settings.files;
-            // ---- CREATING UPDATES ---- //
-            if (sourceFiles.json) {
-                // Only translate JSON files if not using gt-react or gt-next
-                // ReactCLI will handle the JSON files differently
-                if (this.library !== 'gt-react' && this.library !== 'gt-next') {
-                    const rawSource = (0, findFilepath_1.readFile)(sourceFiles.json[0]);
-                    if (!rawSource) {
-                        console.error(errors_1.noSourceFileError);
-                        process.exit(1);
-                    }
-                    if (!dataFormat) {
-                        console.error(errors_1.noDataFormatError);
-                        process.exit(1);
-                    }
-                    else if (!SUPPORTED_DATA_FORMATS.includes(dataFormat)) {
-                        console.error(errors_1.noSupportedDataFormatError);
-                        process.exit(1);
-                    }
-                    const source = JSON.parse(rawSource);
-                    yield (0, translate_1.translateJson)(source, settings, dataFormat, placeholderPaths);
-                }
-            }
-            if (sourceFiles.mdx || sourceFiles.md) {
-                if (sourceFiles.mdx) {
-                    yield (0, translate_2.translateFiles)(sourceFiles, placeholderPaths, transformPaths, 'MDX', settings);
-                }
-                if (sourceFiles.md) {
-                    yield (0, translate_2.translateFiles)(sourceFiles, placeholderPaths, transformPaths, 'MD', settings);
-                }
-            }
+            // Process all file types at once with a single call
+            yield (0, translate_1.translateFiles)(sourceFiles, placeholderPaths, transformPaths, dataFormat, settings);
         });
     }
     setupInitCommand() {
@@ -261,8 +198,8 @@ class BaseCLI {
                     defaultLocale,
                     locales: locales.split(' '),
                     files: {
-                        json: {
-                            include: [translationsDirWithFormat],
+                        gt: {
+                            output: translationsDirWithFormat,
                         },
                     },
                 });

package/dist/cli/react.js

@@ -401,13 +401,6 @@ class ReactCLI extends base_1.BaseCLI {
             if (options.dictionary) {
                 sourceFile = options.dictionary;
             }
-            else {
-                // If it is not provided, use the first json file in the files object
-                const resolvedFiles = options.files.resolvedPaths;
-                if (resolvedFiles.json) {
-                    sourceFile = resolvedFiles.json[0];
-                }
-            }
             // Separate defaultLocale from locales
             options.locales = options.locales.filter((locale) => locale !== options.defaultLocale);
             // validate timeout
@@ -431,8 +424,8 @@ class ReactCLI extends base_1.BaseCLI {
                     process.exit(1);
                 }
             }
-            // If files.json is not provided, publish the translations
-            if (!((_b = (_a = settings.files) === null || _a === void 0 ? void 0 : _a.resolvedPaths) === null || _b === void 0 ? void 0 : _b.json)) {
+            // If files.gt.output is not provided in the config, publish the translations
+            if (!((_b = (_a = settings.files) === null || _a === void 0 ? void 0 : _a.resolvedPaths) === null || _b === void 0 ? void 0 : _b.gt)) {
                 options.publish = true;
             }
             if (options.dryRun) {
@@ -448,8 +441,8 @@ class ReactCLI extends base_1.BaseCLI {
                     throw new Error('No General Translation Project ID found. Use the --project-id flag to provide one.');
                 const updateResponse = yield (0, sendUpdates_1.sendUpdates)(updates, Object.assign(Object.assign({}, settings), { publish: options.publish, wait: options.wait, timeout: options.timeout, dataFormat: 'JSX' }));
                 const versionId = updateResponse === null || updateResponse === void 0 ? void 0 : updateResponse.versionId;
-                // Save translations to local directory if files.json is provided
-                if (versionId && options.files.placeholderPaths.json) {
+                // Save translations to local directory if files.gt.output is provided
+                if (versionId && options.files.placeholderPaths.gt) {
                     console.log();
                     const translations = yield (0, fetchTranslations_1.fetchTranslations)(settings.baseUrl, settings.apiKey, versionId);
                     (0, save_1.saveTranslations)(translations, options.files.placeholderPaths, 'JSX');

package/dist/formats/files/translate.d.ts

@@ -1,9 +1,13 @@
 import { ResolvedFiles, Settings, TransformFiles } from '../../types';
-import { FileFormats } from '../../types/data';
+import { DataFormat } from '../../types/data';
 /**
- * Sends an entire file to the API for translation
- * @param fileContent - The raw content of the file to translate
+ * Sends multiple files to the API for translation
+ * @param filePaths - Resolved file paths for different file types
+ * @param placeholderPaths - Placeholder paths for translated files
+ * @param transformPaths - Transform paths for file naming
+ * @param fileFormat - Format of the files
+ * @param dataFormat - Format of the data within the files
  * @param options - Translation options including API settings
- * @returns The translated file content or null if translation failed
+ * @returns Promise that resolves when translation is complete
  */
-export declare function translateFiles(filePaths: ResolvedFiles, placeholderPaths: ResolvedFiles, transformPaths: TransformFiles, fileFormat: FileFormats, options: Settings): Promise<void>;
+export declare function translateFiles(filePaths: ResolvedFiles, placeholderPaths: ResolvedFiles, transformPaths: TransformFiles, dataFormat: DataFormat | undefined, options: Settings): Promise<void>;

package/dist/formats/files/translate.js

@@ -15,68 +15,113 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.translateFiles = translateFiles;
 const checkFileTranslations_1 = require("../../api/checkFileTranslations");
 const sendFiles_1 = require("../../api/sendFiles");
+const errors_1 = require("../../console/errors");
 const parseFilesConfig_1 = require("../../fs/config/parseFilesConfig");
 const findFilepath_1 = require("../../fs/findFilepath");
+const flattenDictionary_1 = require("../../react/utils/flattenDictionary");
 const path_1 = __importDefault(require("path"));
+const SUPPORTED_DATA_FORMATS = ['JSX', 'ICU', 'I18NEXT'];
 /**
- * Sends an entire file to the API for translation
- * @param fileContent - The raw content of the file to translate
+ * Sends multiple files to the API for translation
+ * @param filePaths - Resolved file paths for different file types
+ * @param placeholderPaths - Placeholder paths for translated files
+ * @param transformPaths - Transform paths for file naming
+ * @param fileFormat - Format of the files
+ * @param dataFormat - Format of the data within the files
  * @param options - Translation options including API settings
- * @returns The translated file content or null if translation failed
+ * @returns Promise that resolves when translation is complete
  */
-function translateFiles(filePaths, placeholderPaths, transformPaths, fileFormat, options) {
-    return __awaiter(this, void 0, void 0, function* () {
-        let typeIndex = 'json';
-        if (fileFormat === 'MDX') {
-            typeIndex = 'mdx';
-        }
-        else if (fileFormat === 'MD') {
-            typeIndex = 'md';
+function translateFiles(filePaths_1, placeholderPaths_1, transformPaths_1) {
+    return __awaiter(this, arguments, void 0, function* (filePaths, placeholderPaths, transformPaths, dataFormat = 'JSX', options) {
+        // Collect all files to translate
+        const allFiles = [];
+        // Process JSON files
+        if (filePaths.json) {
+            if (!SUPPORTED_DATA_FORMATS.includes(dataFormat)) {
+                console.error(errors_1.noSupportedDataFormatError);
+                process.exit(1);
+            }
+            const jsonFiles = filePaths.json.map((filePath) => {
+                const content = (0, findFilepath_1.readFile)(filePath);
+                const json = JSON.parse(content);
+                // Just to validate the JSON is valid
+                (0, flattenDictionary_1.flattenJsonDictionary)(json);
+                const relativePath = (0, findFilepath_1.getRelative)(filePath);
+                return {
+                    content,
+                    fileName: relativePath,
+                    fileFormat: 'JSON',
+                    dataFormat,
+                };
+            });
+            allFiles.push(...jsonFiles);
         }
-        else if (fileFormat === 'JSON') {
-            typeIndex = 'json';
+        // Process MDX files
+        if (filePaths.mdx) {
+            const mdxFiles = filePaths.mdx.map((filePath) => {
+                const content = (0, findFilepath_1.readFile)(filePath);
+                const relativePath = (0, findFilepath_1.getRelative)(filePath);
+                return {
+                    content,
+                    fileName: relativePath,
+                    fileFormat: 'MDX',
+                    dataFormat,
+                };
+            });
+            allFiles.push(...mdxFiles);
         }
-        const sourcePaths = filePaths[typeIndex];
-        try {
-            if (!sourcePaths) {
-                console.error('No files to translate');
-                return;
-            }
-            const files = sourcePaths.map((filePath) => {
+        // Process MD files
+        if (filePaths.md) {
+            const mdFiles = filePaths.md.map((filePath) => {
                 const content = (0, findFilepath_1.readFile)(filePath);
                 const relativePath = (0, findFilepath_1.getRelative)(filePath);
                 return {
                     content,
                     fileName: relativePath,
-                    fileFormat,
+                    fileFormat: 'MD',
+                    dataFormat,
                 };
             });
-            const response = yield (0, sendFiles_1.sendFiles)(files, Object.assign(Object.assign({}, options), { publish: false, wait: true }));
+            allFiles.push(...mdFiles);
+        }
+        if (allFiles.length === 0) {
+            console.error('No files to translate');
+            return;
+        }
+        try {
+            // Send all files in a single API call
+            const response = yield (0, sendFiles_1.sendFiles)(allFiles, Object.assign(Object.assign({}, options), { publish: false, wait: true }));
             const { data, locales } = response;
+            // Create file mapping for all file types
             const fileMapping = {};
             for (const locale of locales) {
                 const translatedPaths = (0, parseFilesConfig_1.resolveLocaleFiles)(placeholderPaths, locale);
-                let translatedFiles = translatedPaths[typeIndex];
-                if (!translatedFiles) {
-                    continue; // shouldn't happen; typing
-                }
-                const transformPath = transformPaths[typeIndex];
-                if (transformPath) {
-                    translatedFiles = translatedFiles.map((filePath) => {
-                        const directory = path_1.default.dirname(filePath);
-                        const fileName = path_1.default.basename(filePath);
-                        const baseName = fileName.split('.')[0];
-                        const transformedFileName = transformPath
-                            .replace('*', baseName)
-                            .replace('[locale]', locale);
-                        return path_1.default.join(directory, transformedFileName);
-                    });
-                }
                 const localeMapping = {};
-                for (let i = 0; i < sourcePaths.length; i++) {
-                    const sourceFile = (0, findFilepath_1.getRelative)(sourcePaths[i]);
-                    const translatedFile = (0, findFilepath_1.getRelative)(translatedFiles[i]);
-                    localeMapping[sourceFile] = translatedFile;
+                // Process each file type
+                for (const typeIndex of ['json', 'mdx', 'md']) {
+                    if (!filePaths[typeIndex] || !translatedPaths[typeIndex])
+                        continue;
+                    const sourcePaths = filePaths[typeIndex];
+                    let translatedFiles = translatedPaths[typeIndex];
+                    if (!translatedFiles)
+                        continue;
+                    const transformPath = transformPaths[typeIndex];
+                    if (transformPath) {
+                        translatedFiles = translatedFiles.map((filePath) => {
+                            const directory = path_1.default.dirname(filePath);
+                            const fileName = path_1.default.basename(filePath);
+                            const baseName = fileName.split('.')[0];
+                            const transformedFileName = transformPath
+                                .replace('*', baseName)
+                                .replace('[locale]', locale);
+                            return path_1.default.join(directory, transformedFileName);
+                        });
+                    }
+                    for (let i = 0; i < sourcePaths.length; i++) {
+                        const sourceFile = (0, findFilepath_1.getRelative)(sourcePaths[i]);
+                        const translatedFile = (0, findFilepath_1.getRelative)(translatedFiles[i]);
+                        localeMapping[sourceFile] = translatedFile;
+                    }
                 }
                 fileMapping[locale] = localeMapping;
             }
@@ -85,7 +130,7 @@ function translateFiles(filePaths, placeholderPaths, transformPaths, fileFormat,
             });
         }
         catch (error) {
-            console.error('Error translating file:', error);
+            console.error('Error translating files:', error);
         }
     });
 }

package/dist/formats/gt/save.js

@@ -18,11 +18,11 @@ function saveTranslations(translations, placeholderPaths, dataFormat) {
     for (const translation of translations) {
         const locale = translation.locale;
         const translationFiles = (0, parseFilesConfig_1.resolveLocaleFiles)(placeholderPaths, locale);
-        if (!translationFiles.json) {
+        if (!translationFiles.gt) {
             console.error(errors_1.noFilesError);
             process.exit(1);
         }
-        const filepath = translationFiles.json[0];
+        const filepath = translationFiles.gt;
         const translationData = translation.translation;
         // Ensure directory exists
         fs_1.default.mkdirSync(path_1.default.dirname(filepath), { recursive: true });

package/dist/formats/json/save.d.ts

@@ -6,5 +6,6 @@ import { ResolvedFiles } from '../../types';
  * @param translations - The translations to save
  * @param filePath - The file path to save the translations to
  * @param dataFormat - The data format to save the translations as
+ * @deprecated Use saveFiles instead
  */
 export declare function saveTranslations(translations: RetrievedTranslations, placeholderPaths: ResolvedFiles, dataFormat: DataFormat): void;

package/dist/formats/json/save.js

@@ -13,6 +13,7 @@ const errors_1 = require("../../console/errors");
  * @param translations - The translations to save
  * @param filePath - The file path to save the translations to
  * @param dataFormat - The data format to save the translations as
+ * @deprecated Use saveFiles instead
  */
 function saveTranslations(translations, placeholderPaths, dataFormat) {
     for (const translation of translations) {

package/dist/formats/json/translate.d.ts

@@ -12,5 +12,6 @@ import { ResolvedFiles } from '../../types';
  * @param config - The config file path
  * @param translationsDir - The directory to save the translations to
  * @param fileType - The file type to save the translations as (file extension)
+ * @deprecated Use translateFiles instead
  */
 export declare function translateJson(sourceJson: any, settings: Settings, dataFormat: DataFormat, placeholderPaths: ResolvedFiles): Promise<void>;

package/dist/formats/json/translate.js

@@ -25,6 +25,7 @@ const save_1 = require("./save");
  * @param config - The config file path
  * @param translationsDir - The directory to save the translations to
  * @param fileType - The file type to save the translations as (file extension)
+ * @deprecated Use translateFiles instead
  */
 function translateJson(sourceJson, settings, dataFormat, placeholderPaths) {
     return __awaiter(this, void 0, void 0, function* () {

package/dist/fs/config/parseFilesConfig.js

@@ -16,7 +16,7 @@ const fast_glob_1 = __importDefault(require("fast-glob"));
  * @returns The resolved files
  */
 function resolveLocaleFiles(files, locale) {
-    var _a, _b, _c;
+    var _a, _b, _c, _d;
     const result = {};
     // Replace [locale] with locale in all paths
     result.json = (_a = files.json) === null || _a === void 0 ? void 0 : _a.map((filepath) => filepath.replace(/\[locale\]/g, locale));
@@ -24,6 +24,8 @@ function resolveLocaleFiles(files, locale) {
     result.md = (_b = files.md) === null || _b === void 0 ? void 0 : _b.map((filepath) => filepath.replace(/\[locale\]/g, locale));
     // Replace [locale] with locale in all paths
     result.mdx = (_c = files.mdx) === null || _c === void 0 ? void 0 : _c.map((filepath) => filepath.replace(/\[locale\]/g, locale));
+    // Replace [locale] with locale in all paths
+    result.gt = (_d = files.gt) === null || _d === void 0 ? void 0 : _d.replace(/\[locale\]/g, locale);
     return result;
 }
 /**
@@ -35,44 +37,38 @@ function resolveLocaleFiles(files, locale) {
  * @returns The resolved files
  */
 function resolveFiles(files, locale) {
-    var _a, _b, _c, _d, _e, _f, _g, _h;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j;
     // Initialize result object with empty arrays for each file type
     const result = {};
     const placeholderResult = {};
     const transformPaths = {};
+    // Process GT files
+    if ((_a = files.gt) === null || _a === void 0 ? void 0 : _a.output) {
+        placeholderResult.gt = files.gt.output;
+    }
     // Process JSON files
-    if ((_a = files.json) === null || _a === void 0 ? void 0 : _a.include) {
-        if (files.json.include.length > 1) {
-            console.error('Only one JSON file is supported at the moment.');
-            process.exit(1);
-        }
-        if (files.json.include.length === 1) {
-            const jsonPaths = expandGlobPatterns([files.json.include[0]], ((_b = files.json) === null || _b === void 0 ? void 0 : _b.exclude) || [], locale);
-            if (jsonPaths.resolvedPaths.length > 1) {
-                console.error('JSON glob pattern matched multiple files. Only one JSON file is supported.');
-                process.exit(1);
-            }
-            result.json = jsonPaths.resolvedPaths;
-            placeholderResult.json = jsonPaths.placeholderPaths;
-        }
+    if ((_b = files.json) === null || _b === void 0 ? void 0 : _b.include) {
+        const jsonPaths = expandGlobPatterns(files.json.include, ((_c = files.json) === null || _c === void 0 ? void 0 : _c.exclude) || [], locale);
+        result.json = jsonPaths.resolvedPaths;
+        placeholderResult.json = jsonPaths.placeholderPaths;
     }
     // Process MD files
-    if ((_c = files.md) === null || _c === void 0 ? void 0 : _c.include) {
-        const mdPaths = expandGlobPatterns(files.md.include, ((_d = files.md) === null || _d === void 0 ? void 0 : _d.exclude) || [], locale);
+    if ((_d = files.md) === null || _d === void 0 ? void 0 : _d.include) {
+        const mdPaths = expandGlobPatterns(files.md.include, ((_e = files.md) === null || _e === void 0 ? void 0 : _e.exclude) || [], locale);
         result.md = mdPaths.resolvedPaths;
         placeholderResult.md = mdPaths.placeholderPaths;
     }
     // Process MDX files
-    if ((_e = files.mdx) === null || _e === void 0 ? void 0 : _e.include) {
-        const mdxPaths = expandGlobPatterns(files.mdx.include, ((_f = files.mdx) === null || _f === void 0 ? void 0 : _f.exclude) || [], locale);
+    if ((_f = files.mdx) === null || _f === void 0 ? void 0 : _f.include) {
+        const mdxPaths = expandGlobPatterns(files.mdx.include, ((_g = files.mdx) === null || _g === void 0 ? void 0 : _g.exclude) || [], locale);
         result.mdx = mdxPaths.resolvedPaths;
         placeholderResult.mdx = mdxPaths.placeholderPaths;
     }
     // ==== TRANSFORMS ==== //
-    if (((_g = files.mdx) === null || _g === void 0 ? void 0 : _g.transform) && !Array.isArray(files.mdx.transform)) {
+    if (((_h = files.mdx) === null || _h === void 0 ? void 0 : _h.transform) && !Array.isArray(files.mdx.transform)) {
         transformPaths.mdx = files.mdx.transform;
     }
-    if (((_h = files.md) === null || _h === void 0 ? void 0 : _h.transform) && !Array.isArray(files.md.transform)) {
+    if (((_j = files.md) === null || _j === void 0 ? void 0 : _j.transform) && !Array.isArray(files.md.transform)) {
         transformPaths.md = files.md.transform;
     }
     return {

package/dist/types/index.d.ts

@@ -60,6 +60,9 @@ export interface ContentScanner {
     }>;
 }
 export type FilesOptions = {
+    gt?: {
+        output: string;
+    };
     json?: {
         include: string[];
         exclude?: string[];
@@ -83,6 +86,7 @@ export type ResolvedFiles = {
     json?: string[];
     md?: string[];
     mdx?: string[];
+    gt?: string;
 };
 export type TransformFiles = {
     json?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gtx-cli",
-  "version": "1.1.6",
+  "version": "1.1.7-alpha.1",
   "main": "dist/index.js",
   "bin": "dist/main.js",
   "scripts": {