gtx-cli 1.2.25-alpha.11 → 1.2.25-alpha.12

package/dist/api/sendFiles.d.ts

@@ -1,17 +1,17 @@
 import { Settings } from '../types';
-import { FileExtension, Format } from '../types/data';
+import { FileExtension, DataFormat } from '../types/data';
 /**
  * File object structure
  * @param content - The content of the file
  * @param fileName - The name of the file
  * @param fileExtension - The format of the file (JSON, MDX, MD, etc.)
- * @param format - The format of the data within the file
+ * @param dataFormat - The format of the data within the file
  */
 export interface FileToTranslate {
     content: string;
     fileName: string;
     fileExtension: FileExtension;
-    format: Format;
+    dataFormat: DataFormat;
 }
 type ApiOptions = Settings & {
     publish: boolean;

package/dist/api/sendFiles.js

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

package/dist/api/sendUpdates.d.ts

@@ -1,8 +1,8 @@
 import { Settings, SupportedLibraries, Updates } from '../types';
-import { Format } from '../types/data';
+import { DataFormat } from '../types/data';
 type ApiOptions = Settings & {
     timeout: string;
-    format: Format;
+    dataFormat: DataFormat;
     description?: string;
     requireApproval?: boolean;
 };

package/dist/api/sendUpdates.js

@@ -15,7 +15,7 @@ const utils_1 = require("../config/utils");
  * @returns The versionId of the updated project
  */
 async function sendUpdates(updates, options, library) {
-    const { apiKey, projectId, defaultLocale, format } = options;
+    const { apiKey, projectId, defaultLocale, dataFormat } = options;
     const globalMetadata = {
         ...(projectId && { projectId }),
         ...(defaultLocale && { sourceLocale: defaultLocale }),
@@ -27,7 +27,7 @@ async function sendUpdates(updates, options, library) {
         updates,
         ...(options.locales && { locales: options.locales }),
         metadata: globalMetadata,
-        ...(format && { format }),
+        ...(dataFormat && { dataFormat }),
         ...(options.version && { versionId: options.version }),
         ...(options.description && { description: options.description }),
         ...(options.requireApproval && {

package/dist/cli/base.js

@@ -187,21 +187,21 @@ See the docs for more information: https://generaltranslation.com/docs/react/tut
         });
     }
     async handleGenericTranslate(settings) {
-        // format for JSONs
-        let format;
+        // dataFormat for JSONs
+        let dataFormat;
         if (this.library === 'next-intl') {
-            format = 'ICU';
+            dataFormat = 'ICU';
         }
         else if (this.library === 'i18next') {
             if (this.additionalModules.includes('i18next-icu')) {
-                format = 'ICU';
+                dataFormat = 'ICU';
             }
             else {
-                format = 'I18NEXT';
+                dataFormat = 'I18NEXT';
             }
         }
         else {
-            format = 'JSX';
+            dataFormat = 'JSX';
         }
         if (!settings.files ||
             (Object.keys(settings.files.placeholderPaths).length === 1 &&
@@ -210,7 +210,7 @@ See the docs for more information: https://generaltranslation.com/docs/react/tut
         }
         const { resolvedPaths: sourceFiles, placeholderPaths, transformPaths, } = settings.files;
         // Process all file types at once with a single call
-        await (0, translate_1.translateFiles)(sourceFiles, placeholderPaths, transformPaths, format, settings);
+        await (0, translate_1.translateFiles)(sourceFiles, placeholderPaths, transformPaths, dataFormat, settings);
     }
     async handleSetupReactCommand(options) {
         await (0, wizard_1.handleSetupReactCommand)(options);

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

@@ -1,5 +1,5 @@
-import { Format } from '../../types/data';
+import { DataFormat } from '../../types/data';
 /**
  * Saves translated MDX/MD file content to the appropriate location
  */
-export declare function saveTranslatedFile(translatedContent: string, outputDir: string, fileName: string, format: Format, locales: string[]): Promise<void>;
+export declare function saveTranslatedFile(translatedContent: string, outputDir: string, fileName: string, dataFormat: DataFormat, locales: string[]): Promise<void>;

package/dist/formats/files/save.js

@@ -10,7 +10,7 @@ const console_1 = require("../../console");
 /**
  * Saves translated MDX/MD file content to the appropriate location
  */
-async function saveTranslatedFile(translatedContent, outputDir, fileName, format, locales) {
+async function saveTranslatedFile(translatedContent, outputDir, fileName, dataFormat, locales) {
     // Create locale-specific directories if they don't exist
     for (const locale of locales) {
         const localeDir = node_path_1.default.join(outputDir, locale);
@@ -18,6 +18,6 @@ async function saveTranslatedFile(translatedContent, outputDir, fileName, format
         // Save the translated file with the appropriate extension
         const outputPath = node_path_1.default.join(localeDir, fileName);
         await promises_1.default.writeFile(outputPath, translatedContent);
-        (0, console_1.logSuccess)(`Saved translated ${format} file to: ${outputPath}`);
+        (0, console_1.logSuccess)(`Saved translated ${dataFormat} file to: ${outputPath}`);
     }
 }

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

@@ -1,13 +1,13 @@
 import { ResolvedFiles, Settings, TransformFiles } from '../../types';
-import { Format } from '../../types/data';
+import { DataFormat } from '../../types/data';
 import { TranslateOptions } from '../../cli/base';
 /**
  * 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 format - Format of the data within the files
+ * @param dataFormat - Format of the data within the files
  * @param options - Translation options including API settings
  * @returns Promise that resolves when translation is complete
  */
-export declare function translateFiles(filePaths: ResolvedFiles, placeholderPaths: ResolvedFiles, transformPaths: TransformFiles, format: Format | undefined, options: Settings & TranslateOptions): Promise<void>;
+export declare function translateFiles(filePaths: ResolvedFiles, placeholderPaths: ResolvedFiles, transformPaths: TransformFiles, dataFormat: DataFormat | undefined, options: Settings & TranslateOptions): Promise<void>;

package/dist/formats/files/translate.js

@@ -21,16 +21,16 @@ const SUPPORTED_FORMATS = ['JSX', 'ICU', 'I18NEXT'];
  * @param filePaths - Resolved file paths for different file types
  * @param placeholderPaths - Placeholder paths for translated files
  * @param transformPaths - Transform paths for file naming
- * @param format - Format of the data within the files
+ * @param dataFormat - Format of the data within the files
  * @param options - Translation options including API settings
  * @returns Promise that resolves when translation is complete
  */
-async function translateFiles(filePaths, placeholderPaths, transformPaths, format = 'JSX', options) {
+async function translateFiles(filePaths, placeholderPaths, transformPaths, dataFormat = 'JSX', options) {
     // Collect all files to translate
     const allFiles = [];
     // Process JSON files
     if (filePaths.json) {
-        if (!SUPPORTED_FORMATS.includes(format)) {
+        if (!SUPPORTED_FORMATS.includes(dataFormat)) {
             (0, console_1.logErrorAndExit)(console_1.noSupportedFormatError);
         }
         const jsonFiles = filePaths.json.map((filePath) => {
@@ -43,7 +43,7 @@ async function translateFiles(filePaths, placeholderPaths, transformPaths, forma
                 content,
                 fileName: relativePath,
                 fileExtension: 'JSON',
-                format,
+                dataFormat,
             };
         });
         allFiles.push(...jsonFiles);
@@ -59,7 +59,7 @@ async function translateFiles(filePaths, placeholderPaths, transformPaths, forma
                     content,
                     fileName: relativePath,
                     fileExtension: fileType.toUpperCase(),
-                    format,
+                    dataFormat,
                 };
             });
             allFiles.push(...files);

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

@@ -1,10 +1,10 @@
 import { RetrievedTranslations } from '../../types/api';
 import { ResolvedFiles } from '../../types';
-import { Format } from '../../types/data';
+import { DataFormat } from '../../types/data';
 /**
  * Saves translations to a local directory
  * @param translations - The translations to save
  * @param translationsDir - The directory to save the translations to
  * @param fileType - The file type to save the translations as (file extension)
  */
-export declare function saveTranslations(translations: RetrievedTranslations, placeholderPaths: ResolvedFiles, format: Format): Promise<void>;
+export declare function saveTranslations(translations: RetrievedTranslations, placeholderPaths: ResolvedFiles, dataFormat: DataFormat): Promise<void>;

package/dist/formats/gt/save.js

@@ -14,7 +14,7 @@ const parseFilesConfig_1 = require("../../fs/config/parseFilesConfig");
  * @param translationsDir - The directory to save the translations to
  * @param fileType - The file type to save the translations as (file extension)
  */
-async function saveTranslations(translations, placeholderPaths, format) {
+async function saveTranslations(translations, placeholderPaths, dataFormat) {
     for (const translation of translations) {
         const locale = translation.locale;
         const translationFiles = (0, parseFilesConfig_1.resolveLocaleFiles)(placeholderPaths, locale);
@@ -27,7 +27,7 @@ async function saveTranslations(translations, placeholderPaths, format) {
         // Ensure directory exists
         await node_fs_1.default.promises.mkdir(node_path_1.default.dirname(filepath), { recursive: true });
         // Handle different file types
-        if (format === 'JSX') {
+        if (dataFormat === 'JSX') {
             await node_fs_1.default.promises.writeFile(filepath, JSON.stringify(translationData, null, 2));
         }
     }

package/dist/react/jsx/parse/parseStringFunction.js

@@ -98,7 +98,7 @@ function parseStrings(importName, path, updates, errors, file) {
                                 });
                             }
                             updates.push({
-                                format: 'ICU',
+                                dataFormat: 'ICU',
                                 source,
                                 metadata,
                             });

package/dist/react/jsx/utils/parseJsx.js

@@ -246,7 +246,7 @@ function parseJSXElement(importAliases, node, updates, errors, file) {
             return;
         // <T> is valid here
         updates.push({
-            format: 'JSX',
+            dataFormat: 'JSX',
             source: componentObj.tree,
             metadata: componentObj.props,
         });

package/dist/react/jsx/utils/parseStringFunction.js

@@ -87,7 +87,7 @@ function processTranslationCall(tPath, updates, errors, file) {
                 });
             }
             updates.push({
-                format: 'ICU',
+                dataFormat: 'ICU',
                 source,
                 metadata,
             });

package/dist/react/parse/createDictionaryUpdates.js

@@ -63,11 +63,11 @@ async function createDictionaryUpdates(options, dictionaryPath, esbuildConfig) {
                 source: entry,
                 ...(context && { context }),
                 ...(id && { id }),
-                format: 'ICU',
+                dataFormat: 'ICU',
             }),
         };
         updates.push({
-            format: 'ICU',
+            dataFormat: 'ICU',
             source: entry,
             metadata,
         });

package/dist/react/parse/createInlineUpdates.js

@@ -132,7 +132,7 @@ async function createInlineUpdates(options, pkg) {
             source: update.source,
             ...(context && { context }),
             ...(update.metadata.id && { id: update.metadata.id }),
-            format: update.format,
+            dataFormat: update.dataFormat,
         });
         update.metadata.hash = hash;
     }));

package/dist/translation/stage.js

@@ -73,7 +73,7 @@ async function stageProject(settings, pkg) {
     const updateResponse = await (0, sendUpdates_1.sendUpdates)(updates, {
         ...settings,
         timeout: settings.timeout,
-        format: 'JSX',
+        dataFormat: 'JSX',
     }, pkg);
     const { versionId, locales } = updateResponse;
     return { versionId, locales };

package/dist/types/data.d.ts

@@ -17,7 +17,7 @@ export type JSONDictionary = {
 export type FlattenedJSONDictionary = {
     [key: string]: string;
 };
-export type Format = 'JSX' | 'ICU' | 'I18NEXT';
+export type DataFormat = 'JSX' | 'ICU' | 'I18NEXT';
 export type FileExtension = 'JSON' | 'YAML' | 'MDX' | 'MD' | 'TS' | 'JS';
 export type JsxChildren = string | string[] | any;
 export type Translations = {

package/dist/types/index.d.ts

@@ -3,13 +3,13 @@ import { SUPPORTED_FILE_EXTENSIONS } from '../formats/files/supportedFiles';
 export type Updates = ({
     metadata: Record<string, any>;
 } & ({
-    format: 'JSX';
+    dataFormat: 'JSX';
     source: JsxChildren;
 } | {
-    format: 'ICU';
+    dataFormat: 'ICU';
     source: string;
 } | {
-    format: 'I18NEXT';
+    dataFormat: 'I18NEXT';
     source: string;
 }))[];
 export type Options = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gtx-cli",
-  "version": "1.2.25-alpha.11",
+  "version": "1.2.25-alpha.12",
   "main": "dist/index.js",
   "bin": "dist/main.js",
   "files": [
@@ -79,7 +79,7 @@
     "esbuild": "^0.25.4",
     "fast-glob": "^3.3.3",
     "form-data": "^4.0.2",
-    "generaltranslation": "^7.0.0-alpha.11",
+    "generaltranslation": "^7.0.0-alpha.12",
     "open": "^10.1.1",
     "ora": "^8.2.0",
     "resolve": "^1.22.10",