gtx-cli 2.3.10 → 2.3.11

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # gtx-cli
 
+## 2.3.11
+
+### Patch Changes
+
+- [#732](https://github.com/generaltranslation/gt/pull/732) [`bcd8272`](https://github.com/generaltranslation/gt/commit/bcd8272576ff02432e39cf1887a48b4f566eb752) Thanks [@fernando-aviles](https://github.com/fernando-aviles)! - Added freezing when fetching translations for unmodified source files. This will keep any local changes until retranslation is triggered or --force-download is used
+
 ## 2.3.10
 
 ### Patch Changes

package/dist/api/checkFileTranslations.d.ts

@@ -20,4 +20,4 @@ export declare function checkFileTranslations(data: {
         versionId: string;
         fileName: string;
     };
-}, locales: string[], timeoutDuration: number, resolveOutputPath: (sourcePath: string, locale: string) => string | null, options: Settings, forceRetranslation?: boolean): Promise<boolean>;
+}, locales: string[], timeoutDuration: number, resolveOutputPath: (sourcePath: string, locale: string) => string | null, options: Settings, forceRetranslation?: boolean, forceDownload?: boolean): Promise<boolean>;

package/dist/api/checkFileTranslations.js

@@ -16,7 +16,7 @@ import path from 'node:path';
  * @param timeoutDuration - The timeout duration for the wait in seconds
  * @returns True if all translations are deployed, false otherwise
  */
-export async function checkFileTranslations(data, locales, timeoutDuration, resolveOutputPath, options, forceRetranslation) {
+export async function checkFileTranslations(data, locales, timeoutDuration, resolveOutputPath, options, forceRetranslation, forceDownload) {
     const startTime = Date.now();
     console.log();
     const spinner = await createOraSpinner();
@@ -49,7 +49,7 @@ export async function checkFileTranslations(data, locales, timeoutDuration, reso
     };
     // Do first check immediately, but skip if force retranslation is enabled
     if (!forceRetranslation) {
-        const initialCheck = await checkTranslationDeployment(fileQueryData, downloadStatus, spinner, resolveOutputPath, options);
+        const initialCheck = await checkTranslationDeployment(fileQueryData, downloadStatus, spinner, resolveOutputPath, options, forceDownload);
         if (initialCheck) {
             spinner.succeed(chalk.green('Files translated!'));
             return true;
@@ -62,7 +62,7 @@ export async function checkFileTranslations(data, locales, timeoutDuration, reso
         // Start the interval aligned with the original request time
         setTimeout(() => {
             intervalCheck = setInterval(async () => {
-                const isDeployed = await checkTranslationDeployment(fileQueryData, downloadStatus, spinner, resolveOutputPath, options);
+                const isDeployed = await checkTranslationDeployment(fileQueryData, downloadStatus, spinner, resolveOutputPath, options, forceDownload);
                 const elapsed = Date.now() - startTime;
                 if (isDeployed || elapsed >= timeoutDuration * 1000) {
                     clearInterval(intervalCheck);
@@ -186,7 +186,7 @@ function generateStatusSuffixText(downloadStatus, fileQueryData) {
 /**
  * Checks translation status and downloads ready files
  */
-async function checkTranslationDeployment(fileQueryData, downloadStatus, spinner, resolveOutputPath, options) {
+async function checkTranslationDeployment(fileQueryData, downloadStatus, spinner, resolveOutputPath, options, forceDownload) {
     try {
         // Only query for files that haven't been downloaded yet
         const currentQueryData = fileQueryData.filter((item) => !downloadStatus.downloaded.has(`${item.fileName}:${item.locale}`) &&
@@ -202,6 +202,11 @@ async function checkTranslationDeployment(fileQueryData, downloadStatus, spinner
         // Filter for ready translations
         const readyTranslations = translations.filter((translation) => translation.isReady && translation.fileName);
         if (readyTranslations.length > 0) {
+            // Build version map by fileName:locale for this batch
+            const versionMap = new Map(fileQueryData.map((item) => [
+                `${item.fileName}:${gt.resolveAliasLocale(item.locale)}`,
+                item.versionId,
+            ]));
             // Prepare batch download data
             const batchFiles = readyTranslations
                 .map((translation) => {
@@ -220,10 +225,11 @@ async function checkTranslationDeployment(fileQueryData, downloadStatus, spinner
                     outputPath,
                     locale,
                     fileLocale: `${fileName}:${locale}`,
+                    versionId: versionMap.get(`${fileName}:${locale}`),
                 };
             })
                 .filter((file) => file !== null);
-            const batchResult = await downloadFileBatch(batchFiles, options);
+            const batchResult = await downloadFileBatch(batchFiles, options, 3, 1000, Boolean(forceDownload));
             // Process results
             batchFiles.forEach((file) => {
                 const { translationId, fileLocale } = file;

package/dist/api/downloadFileBatch.d.ts

@@ -5,6 +5,8 @@ export type BatchedFiles = Array<{
     inputPath: string;
     locale: string;
     fileLocale: string;
+    fileId?: string;
+    versionId?: string;
 }>;
 export type DownloadFileBatchResult = {
     successful: string[];
@@ -17,4 +19,4 @@ export type DownloadFileBatchResult = {
  * @param retryDelay - Delay between retries in milliseconds
  * @returns Object containing successful and failed file IDs
  */
-export declare function downloadFileBatch(files: BatchedFiles, options: Settings, maxRetries?: number, retryDelay?: number): Promise<DownloadFileBatchResult>;
+export declare function downloadFileBatch(files: BatchedFiles, options: Settings, maxRetries?: number, retryDelay?: number, forceDownload?: boolean): Promise<DownloadFileBatchResult>;

package/dist/api/downloadFileBatch.js

@@ -6,6 +6,7 @@ import { validateJsonSchema } from '../formats/json/utils.js';
 import { validateYamlSchema } from '../formats/yaml/utils.js';
 import { mergeJson } from '../formats/json/mergeJson.js';
 import mergeYaml from '../formats/yaml/mergeYaml.js';
+import { getDownloadedVersions, saveDownloadedVersions, } from '../fs/config/downloadedVersions.js';
 /**
  * Downloads multiple translation files in a single batch request
  * @param files - Array of files to download with their output paths
@@ -13,17 +14,22 @@ import mergeYaml from '../formats/yaml/mergeYaml.js';
  * @param retryDelay - Delay between retries in milliseconds
  * @returns Object containing successful and failed file IDs
  */
-export async function downloadFileBatch(files, options, maxRetries = 3, retryDelay = 1000) {
+export async function downloadFileBatch(files, options, maxRetries = 3, retryDelay = 1000, forceDownload = false) {
+    // Local record of what version was last downloaded for each fileName:locale
+    const downloadedVersions = getDownloadedVersions(options.configDirectory);
+    let didUpdateDownloadedLock = false;
     let retries = 0;
     const fileIds = files.map((file) => file.translationId);
     const result = { successful: [], failed: [] };
     // Create a map of translationId to outputPath for easier lookup
     const outputPathMap = new Map(files.map((file) => [file.translationId, file.outputPath]));
     const inputPathMap = new Map(files.map((file) => [file.translationId, file.inputPath]));
+    const fileIdMap = new Map(files.map((file) => [file.translationId, file.fileId]));
     const localeMap = new Map(files.map((file) => [
         file.translationId,
         gt.resolveAliasLocale(file.locale),
     ]));
+    const versionMap = new Map(files.map((file) => [file.translationId, file.versionId]));
     while (retries <= maxRetries) {
         try {
             // Download the files
@@ -36,6 +42,8 @@ export async function downloadFileBatch(files, options, maxRetries = 3, retryDel
                     const outputPath = outputPathMap.get(translationId);
                     const inputPath = inputPathMap.get(translationId);
                     const locale = localeMap.get(translationId);
+                    const fileId = fileIdMap.get(translationId);
+                    const versionId = versionMap.get(translationId);
                     if (!outputPath || !inputPath) {
                         logWarning(`No input/output path found for file: ${translationId}`);
                         result.failed.push(translationId);
@@ -46,6 +54,18 @@ export async function downloadFileBatch(files, options, maxRetries = 3, retryDel
                     if (!fs.existsSync(dir)) {
                         fs.mkdirSync(dir, { recursive: true });
                     }
+                    // If a local translation already exists for the same source version, skip overwrite
+                    const keyId = fileId || inputPath;
+                    const downloadedKey = `${keyId}:${locale}`;
+                    const alreadyDownloadedVersion = downloadedVersions.entries[downloadedKey]?.versionId;
+                    const fileExists = fs.existsSync(outputPath);
+                    if (!forceDownload &&
+                        fileExists &&
+                        versionId &&
+                        alreadyDownloadedVersion === versionId) {
+                        result.successful.push(translationId);
+                        continue;
+                    }
                     let data = file.data;
                     if (options.options?.jsonSchema && locale) {
                         const jsonSchema = validateJsonSchema(options.options, inputPath);
@@ -78,6 +98,15 @@ export async function downloadFileBatch(files, options, maxRetries = 3, retryDel
                     // Write the file to disk
                     await fs.promises.writeFile(outputPath, data);
                     result.successful.push(translationId);
+                    if (versionId) {
+                        downloadedVersions.entries[downloadedKey] = {
+                            versionId,
+                            fileId: fileId || undefined,
+                            fileName: inputPath,
+                            updatedAt: new Date().toISOString(),
+                        };
+                        didUpdateDownloadedLock = true;
+                    }
                 }
                 catch (error) {
                     logError(`Error saving file ${file.id}: ` + error);
@@ -91,6 +120,11 @@ export async function downloadFileBatch(files, options, maxRetries = 3, retryDel
                     result.failed.push(fileId);
                 }
             }
+            // Persist any updates to the downloaded map at the end of a successful cycle
+            if (didUpdateDownloadedLock) {
+                saveDownloadedVersions(options.configDirectory, downloadedVersions);
+                didUpdateDownloadedLock = false;
+            }
             return result;
         }
         catch (error) {
@@ -100,6 +134,9 @@ export async function downloadFileBatch(files, options, maxRetries = 3, retryDel
                     error);
                 // Mark all files as failed
                 result.failed = [...fileIds];
+                if (didUpdateDownloadedLock) {
+                    saveDownloadedVersions(options.configDirectory, downloadedVersions);
+                }
                 return result;
             }
             // Increment retry counter and wait before next attempt
@@ -109,5 +146,8 @@ export async function downloadFileBatch(files, options, maxRetries = 3, retryDel
     }
     // Mark all files as failed if we get here
     result.failed = [...fileIds];
+    if (didUpdateDownloadedLock) {
+        saveDownloadedVersions(options.configDirectory, downloadedVersions);
+    }
     return result;
 }

package/dist/cli/commands/translate.js

@@ -15,7 +15,7 @@ export async function handleTranslate(options, settings, filesTranslationRespons
         const fileMapping = createFileMapping(resolvedPaths, placeholderPaths, transformPaths, settings.locales, settings.defaultLocale);
         const { data } = filesTranslationResponse;
         // Check for remaining translations
-        await checkFileTranslations(data, settings.locales, options.timeout, (sourcePath, locale) => fileMapping[locale][sourcePath] ?? null, settings, options.force);
+        await checkFileTranslations(data, settings.locales, options.timeout, (sourcePath, locale) => fileMapping[locale][sourcePath] ?? null, settings, options.force, options.forceDownload);
     }
 }
 // Downloads translations that were originally staged
@@ -33,8 +33,8 @@ export async function handleDownload(options, settings) {
     const fileMapping = createFileMapping(resolvedPaths, placeholderPaths, transformPaths, settings.locales, settings.defaultLocale);
     const stagedVersionData = await getStagedVersions(settings.configDirectory);
     // Check for remaining translations
-    await checkFileTranslations(stagedVersionData, settings.locales, options.timeout, (sourcePath, locale) => fileMapping[locale][sourcePath] ?? null, settings, false // force is not applicable for downloading staged translations
-    );
+    await checkFileTranslations(stagedVersionData, settings.locales, options.timeout, (sourcePath, locale) => fileMapping[locale][sourcePath] ?? null, settings, false, // force is not applicable for downloading staged translations
+    options.forceDownload);
 }
 export async function postProcessTranslations(settings) {
     // Localize static urls (/docs -> /[locale]/docs) and preserve anchor IDs for non-default locales

package/dist/cli/flags.js

@@ -26,6 +26,7 @@ export function attachTranslateFlags(command) {
         .option('--experimental-flatten-json-files', 'Triggering this will flatten the json files into a single file. This is useful for projects that have a lot of json files.', false)
         .option('--experimental-localize-static-imports', 'Triggering this will run a script after the cli tool that localizes all static imports in content files. Currently only supported for md and mdx files.', false)
         .option('--force', 'Force a retranslation, invalidating all existing cached translations if they exist.', false)
+        .option('--force-download', 'Force download and overwrite local files, bypassing downloaded-versions checks.', false)
         .option('--experimental-clear-locale-dirs', 'Clear locale directories before downloading new translations', false);
     return command;
 }

package/dist/fs/config/downloadedVersions.d.ts

@@ -0,0 +1,12 @@
+export type DownloadedVersionEntry = {
+    versionId: string;
+    fileId?: string;
+    fileName?: string;
+    updatedAt?: string;
+};
+export type DownloadedVersions = {
+    version: number;
+    entries: Record<string, DownloadedVersionEntry>;
+};
+export declare function getDownloadedVersions(configDirectory: string): DownloadedVersions;
+export declare function saveDownloadedVersions(configDirectory: string, lock: DownloadedVersions): void;

package/dist/fs/config/downloadedVersions.js

@@ -0,0 +1,30 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import { logError } from '../../console/logging.js';
+const DOWNLOADED_VERSIONS_FILE = 'downloaded-versions.json';
+export function getDownloadedVersions(configDirectory) {
+    try {
+        const filepath = path.join(configDirectory, DOWNLOADED_VERSIONS_FILE);
+        if (!fs.existsSync(filepath))
+            return { version: 1, entries: {} };
+        const raw = JSON.parse(fs.readFileSync(filepath, 'utf8'));
+        if (raw && typeof raw === 'object' && raw.version && raw.entries) {
+            return raw;
+        }
+        return { version: 1, entries: {} };
+    }
+    catch (error) {
+        logError(`An error occurred while getting downloaded versions: ${error}`);
+        return { version: 1, entries: {} };
+    }
+}
+export function saveDownloadedVersions(configDirectory, lock) {
+    try {
+        const filepath = path.join(configDirectory, DOWNLOADED_VERSIONS_FILE);
+        fs.mkdirSync(configDirectory, { recursive: true });
+        fs.writeFileSync(filepath, JSON.stringify(lock, null, 2));
+    }
+    catch (error) {
+        logError(`An error occurred while updating ${DOWNLOADED_VERSIONS_FILE}: ${error}`);
+    }
+}

package/dist/types/index.d.ts

@@ -41,6 +41,7 @@ export type TranslateFlags = {
     stageTranslations?: boolean;
     publish?: boolean;
     force?: boolean;
+    forceDownload?: boolean;
     experimentalLocalizeStaticUrls?: boolean;
     experimentalHideDefaultLocale?: boolean;
     experimentalFlattenJsonFiles?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gtx-cli",
-  "version": "2.3.10",
+  "version": "2.3.11",
   "main": "dist/index.js",
   "bin": "dist/main.js",
   "files": [