gtx-cli 2.4.15 → 2.5.0-alpha.1

package/dist/api/checkFileTranslations.js

@@ -1,281 +0,0 @@
-import chalk from 'chalk';
-import { createOraSpinner, logError } from '../console/logging.js';
-import { getLocaleProperties } from 'generaltranslation';
-import { downloadFileBatch } from './downloadFileBatch.js';
-import { gt } from '../utils/gt.js';
-import { TEMPLATE_FILE_NAME } from '../cli/commands/stage.js';
-import { clearLocaleDirs } from '../fs/clearLocaleDirs.js';
-import path from 'node:path';
-/**
- * Checks the status of translations for a given version ID
- * @param apiKey - The API key for the General Translation API
- * @param baseUrl - The base URL for the General Translation API
- * @param versionId - The version ID of the project
- * @param locales - The locales to wait for
- * @param startTime - The start time of the wait
- * @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, forceDownload) {
-    const startTime = Date.now();
-    console.log();
-    const spinner = await createOraSpinner();
-    const spinnerMessage = forceRetranslation
-        ? 'Waiting for retranslation...'
-        : 'Waiting for translation...';
-    spinner.start(spinnerMessage);
-    // Initialize the query data
-    const fileQueryData = prepareFileQueryData(data, locales);
-    // Clear translated files before any downloads (if enabled)
-    if (options.options?.experimentalClearLocaleDirs === true &&
-        fileQueryData.length > 0) {
-        const translatedFiles = new Set(fileQueryData
-            .map((file) => {
-            const outputPath = resolveOutputPath(file.fileName, file.locale);
-            // Only clear if the output path is different from the source (i.e., there's a transform)
-            return outputPath !== null && outputPath !== file.fileName
-                ? outputPath
-                : null;
-        })
-            .filter((path) => path !== null));
-        // Derive cwd from config path
-        const cwd = path.dirname(options.config);
-        await clearLocaleDirs(translatedFiles, locales, options.options?.clearLocaleDirsExclude, cwd);
-    }
-    const downloadStatus = {
-        downloaded: new Set(),
-        failed: new Set(),
-        skipped: new Set(),
-    };
-    // Do first check immediately, but skip if force retranslation is enabled
-    if (!forceRetranslation) {
-        const initialCheck = await checkTranslationDeployment(fileQueryData, downloadStatus, spinner, resolveOutputPath, options, forceDownload);
-        if (initialCheck) {
-            spinner.succeed(chalk.green('Files translated!'));
-            return true;
-        }
-    }
-    // Calculate time until next 5-second interval since startTime
-    const msUntilNextInterval = Math.max(0, 5000 - ((Date.now() - startTime) % 5000));
-    return new Promise((resolve) => {
-        let intervalCheck;
-        // Start the interval aligned with the original request time
-        setTimeout(() => {
-            intervalCheck = setInterval(async () => {
-                const isDeployed = await checkTranslationDeployment(fileQueryData, downloadStatus, spinner, resolveOutputPath, options, forceDownload);
-                const elapsed = Date.now() - startTime;
-                if (isDeployed || elapsed >= timeoutDuration * 1000) {
-                    clearInterval(intervalCheck);
-                    if (isDeployed) {
-                        spinner.succeed(chalk.green('All files translated!'));
-                        resolve(true);
-                    }
-                    else {
-                        spinner.fail(chalk.red('Timed out waiting for translations'));
-                        resolve(false);
-                    }
-                }
-            }, 5000);
-        }, msUntilNextInterval);
-    });
-}
-/**
- * Prepares the file query data from input data and locales
- */
-function prepareFileQueryData(data, locales) {
-    const fileQueryData = [];
-    for (const file in data) {
-        for (const locale of locales) {
-            fileQueryData.push({
-                versionId: data[file].versionId,
-                fileName: data[file].fileName,
-                locale,
-            });
-        }
-    }
-    return fileQueryData;
-}
-/**
- * Generates a formatted status text showing translation progress
- * @param downloadedFiles - Set of downloaded file+locale combinations
- * @param fileQueryData - Array of file query data objects
- * @returns Formatted status text
- */
-function generateStatusSuffixText(downloadStatus, fileQueryData) {
-    // Simple progress indicator
-    const progressText = chalk.green(`[${downloadStatus.downloaded.size +
-        downloadStatus.failed.size +
-        downloadStatus.skipped.size}/${fileQueryData.length}]`) + ` translations completed`;
-    // Get terminal height to adapt our output
-    const terminalHeight = process.stdout.rows || 24; // Default to 24 if undefined
-    // If terminal is very small, just show the basic progress
-    if (terminalHeight < 6) {
-        return `${progressText}`;
-    }
-    const newSuffixText = [`${progressText}`];
-    // Organize data by filename
-    const fileStatus = new Map();
-    // Initialize with all files and locales from fileQueryData
-    for (const item of fileQueryData) {
-        if (!fileStatus.has(item.fileName)) {
-            fileStatus.set(item.fileName, {
-                completed: new Set(),
-                pending: new Set([item.locale]),
-                failed: new Set(),
-                skipped: new Set(),
-            });
-        }
-        else {
-            fileStatus.get(item.fileName)?.pending.add(item.locale);
-        }
-    }
-    // Mark which ones are completed or failed
-    for (const fileLocale of downloadStatus.downloaded) {
-        const [fileName, locale] = fileLocale.split(':');
-        const status = fileStatus.get(fileName);
-        if (status) {
-            status.pending.delete(locale);
-            status.completed.add(locale);
-        }
-    }
-    for (const fileLocale of downloadStatus.failed) {
-        const [fileName, locale] = fileLocale.split(':');
-        const status = fileStatus.get(fileName);
-        if (status) {
-            status.pending.delete(locale);
-            status.failed.add(locale);
-        }
-    }
-    for (const fileLocale of downloadStatus.skipped) {
-        const [fileName, locale] = fileLocale.split(':');
-        const status = fileStatus.get(fileName);
-        if (status) {
-            status.pending.delete(locale);
-            status.skipped.add(locale);
-        }
-    }
-    // Calculate how many files we can show based on terminal height
-    const filesArray = Array.from(fileStatus.entries());
-    const maxFilesToShow = Math.min(filesArray.length, terminalHeight - 3 // Header + progress + buffer
-    );
-    // Display each file with its status on a single line
-    for (let i = 0; i < maxFilesToShow; i++) {
-        const [fileName, status] = filesArray[i];
-        // Create condensed locale status
-        const localeStatuses = [];
-        // Add completed locales
-        if (status.completed.size > 0) {
-            const completedCodes = Array.from(status.completed)
-                .map((locale) => getLocaleProperties(locale).code)
-                .join(', ');
-            localeStatuses.push(chalk.green(`${completedCodes}`));
-        }
-        // Add (translated but not downloaded) skipped locales
-        if (status.skipped.size > 0) {
-            const skippedCodes = Array.from(status.skipped)
-                .map((locale) => getLocaleProperties(locale).code)
-                .join(', ');
-            localeStatuses.push(chalk.green(`${skippedCodes}`));
-        }
-        // Add failed locales
-        if (status.failed.size > 0) {
-            const failedCodes = Array.from(status.failed)
-                .map((locale) => getLocaleProperties(locale).code)
-                .join(', ');
-            localeStatuses.push(chalk.red(`${failedCodes}`));
-        }
-        // Add pending locales
-        if (status.pending.size > 0) {
-            const pendingCodes = Array.from(status.pending)
-                .map((locale) => getLocaleProperties(locale).code)
-                .join(', ');
-            localeStatuses.push(chalk.yellow(`${pendingCodes}`));
-        }
-        // Format the line
-        const prettyFileName = fileName === TEMPLATE_FILE_NAME ? '<React Elements>' : fileName;
-        newSuffixText.push(`${chalk.bold(prettyFileName)} [${localeStatuses.join(', ')}]`);
-    }
-    // If we couldn't show all files, add an indicator
-    if (filesArray.length > maxFilesToShow) {
-        newSuffixText.push(`... and ${filesArray.length - maxFilesToShow} more files`);
-    }
-    return newSuffixText.join('\n');
-}
-/**
- * Checks translation status and downloads ready files
- */
-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}`) &&
-            !downloadStatus.failed.has(`${item.fileName}:${item.locale}`) &&
-            !downloadStatus.skipped.has(`${item.fileName}:${item.locale}`));
-        // If all files have been downloaded, we're done
-        if (currentQueryData.length === 0) {
-            return true;
-        }
-        // Check for translations
-        const responseData = await gt.checkFileTranslations(currentQueryData);
-        const translations = responseData.translations || [];
-        // 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) => {
-                const locale = gt.resolveAliasLocale(translation.locale);
-                const fileName = translation.fileName;
-                const translationId = translation.id;
-                const outputPath = resolveOutputPath(fileName, locale);
-                // Skip downloading GTJSON files that are not in the files configuration
-                if (outputPath === null) {
-                    downloadStatus.skipped.add(`${fileName}:${locale}`);
-                    return null;
-                }
-                return {
-                    translationId,
-                    inputPath: fileName,
-                    outputPath,
-                    locale,
-                    fileLocale: `${fileName}:${locale}`,
-                    fileId: translation.fileId,
-                    versionId: versionMap.get(`${fileName}:${locale}`),
-                };
-            })
-                .filter((file) => file !== null);
-            if (batchFiles.length > 0) {
-                const batchResult = await downloadFileBatch(batchFiles, options, 3, 1000, Boolean(forceDownload));
-                // Process results
-                batchFiles.forEach((file) => {
-                    const { translationId, fileLocale } = file;
-                    if (batchResult.successful.includes(translationId)) {
-                        downloadStatus.downloaded.add(fileLocale);
-                    }
-                    else if (batchResult.failed.includes(translationId)) {
-                        downloadStatus.failed.add(fileLocale);
-                    }
-                });
-            }
-        }
-        // Force a refresh of the spinner display
-        const statusText = generateStatusSuffixText(downloadStatus, fileQueryData);
-        // Clear and reapply the suffix to force a refresh
-        spinner.text = statusText;
-        // If all files have been downloaded, we're done
-        if (downloadStatus.downloaded.size +
-            downloadStatus.failed.size +
-            downloadStatus.skipped.size ===
-            fileQueryData.length) {
-            return true;
-        }
-    }
-    catch (error) {
-        logError(chalk.red('Error checking translation status: ') + error);
-    }
-    return false;
-}

package/dist/api/sendFiles.d.ts

@@ -1,17 +0,0 @@
-import { Settings, TranslateFlags } from '../types/index.js';
-import { CompletedFileTranslationData, FileToTranslate } from 'generaltranslation/types';
-export type SendFilesResult = {
-    data: Record<string, {
-        fileName: string;
-        versionId: string;
-    }>;
-    locales: string[];
-    translations: CompletedFileTranslationData[];
-};
-/**
- * Sends multiple files for translation to the API
- * @param files - Array of file objects to translate
- * @param options - The options for the API call
- * @returns The translated content or version ID
- */
-export declare function sendFiles(files: FileToTranslate[], options: TranslateFlags, settings: Settings): Promise<SendFilesResult>;

package/dist/api/sendFiles.js

@@ -1,127 +0,0 @@
-import chalk from 'chalk';
-import { createSpinner, logErrorAndExit, logMessage, logSuccess, } from '../console/logging.js';
-import { gt } from '../utils/gt.js';
-import { TEMPLATE_FILE_NAME } from '../cli/commands/stage.js';
-import { collectAndSendUserEditDiffs } from './collectUserEditDiffs.js';
-/**
- * Sends multiple files for translation to the API
- * @param files - Array of file objects to translate
- * @param options - The options for the API call
- * @returns The translated content or version ID
- */
-export async function sendFiles(files, options, settings) {
-    // Keep track of the most recent spinner so we can stop it on error
-    let currentSpinner = null;
-    logMessage(chalk.cyan('Files to translate:') +
-        '\n' +
-        files
-            .map((file) => {
-            if (file.fileName === TEMPLATE_FILE_NAME) {
-                return `- <React Elements>`;
-            }
-            return `- ${file.fileName}`;
-        })
-            .join('\n'));
-    try {
-        // Step 1: Upload files (get references)
-        const uploadSpinner = createSpinner('dots');
-        currentSpinner = uploadSpinner;
-        uploadSpinner.start(`Uploading ${files.length} file${files.length !== 1 ? 's' : ''} to General Translation API...`);
-        const sourceLocale = settings.defaultLocale;
-        if (!sourceLocale) {
-            uploadSpinner.stop(chalk.red('Missing default source locale'));
-            logErrorAndExit('sendFiles: settings.defaultLocale is required to upload source files');
-        }
-        // Convert FileToTranslate[] -> { source: FileUpload }[]
-        const uploads = files.map(({ content, fileName, fileFormat, dataFormat }) => ({
-            source: {
-                content,
-                fileName,
-                fileFormat,
-                dataFormat,
-                locale: sourceLocale,
-            },
-        }));
-        const upload = await gt.uploadSourceFiles(uploads, {
-            sourceLocale,
-            modelProvider: settings.modelProvider,
-        });
-        uploadSpinner.stop(chalk.green('Files uploaded successfully'));
-        // Calculate timeout once for setup fetching
-        // Accept number or numeric string, default to 600s
-        const timeoutVal = options?.timeout !== undefined ? Number(options.timeout) : 600;
-        const setupTimeoutMs = (Number.isFinite(timeoutVal) ? timeoutVal : 600) * 1000;
-        const setupResult = await gt.setupProject(upload.uploadedFiles, {
-            locales: settings.locales,
-        });
-        if (setupResult?.status === 'queued') {
-            const { setupJobId } = setupResult;
-            const setupSpinner = createSpinner('dots');
-            currentSpinner = setupSpinner;
-            setupSpinner.start('Setting up project...');
-            const start = Date.now();
-            const pollInterval = 2000;
-            let setupCompleted = false;
-            let setupFailedMessage = null;
-            while (true) {
-                const status = await gt.checkSetupStatus(setupJobId);
-                if (status.status === 'completed') {
-                    setupCompleted = true;
-                    break;
-                }
-                if (status.status === 'failed') {
-                    setupFailedMessage = status.error?.message || 'Unknown error';
-                    break;
-                }
-                if (Date.now() - start > setupTimeoutMs) {
-                    setupFailedMessage = 'Timed out while waiting for setup generation';
-                    break;
-                }
-                await new Promise((r) => setTimeout(r, pollInterval));
-            }
-            if (setupCompleted) {
-                setupSpinner.stop(chalk.green('Setup successfully completed'));
-            }
-            else {
-                setupSpinner.stop(chalk.yellow(`Setup ${setupFailedMessage ? 'failed' : 'timed out'} — proceeding without setup${setupFailedMessage ? ` (${setupFailedMessage})` : ''}`));
-            }
-        }
-        // Step 3 (optional): Prior to enqueue, detect and submit user edit diffs
-        if (options?.saveLocal) {
-            const prepSpinner = createSpinner('dots');
-            currentSpinner = prepSpinner;
-            prepSpinner.start('Updating translations...');
-            try {
-                await collectAndSendUserEditDiffs(upload.uploadedFiles, settings);
-            }
-            catch {
-                // Non-fatal; keep going to enqueue
-            }
-            finally {
-                prepSpinner.stop('Updated translations');
-            }
-        }
-        // Step 4: Enqueue translations by reference
-        const enqueueSpinner = createSpinner('dots');
-        currentSpinner = enqueueSpinner;
-        enqueueSpinner.start('Enqueuing translations...');
-        const enqueueResult = await gt.enqueueFiles(upload.uploadedFiles, {
-            sourceLocale: settings.defaultLocale,
-            targetLocales: settings.locales,
-            publish: settings.publish,
-            requireApproval: settings.stageTranslations,
-            modelProvider: settings.modelProvider,
-            force: options?.force,
-        });
-        const { data, message, locales, translations } = enqueueResult;
-        enqueueSpinner.stop(chalk.green('Files for translation uploaded successfully'));
-        logSuccess(message);
-        return { data, locales, translations };
-    }
-    catch {
-        if (currentSpinner) {
-            currentSpinner.stop();
-        }
-        logErrorAndExit('Failed to send files for translation');
-    }
-}

package/dist/api/sendUserEdits.d.ts

@@ -1,19 +0,0 @@
-import { Settings } from '../types/index.js';
-export type UserEditDiff = {
-    fileName: string;
-    locale: string;
-    diff: string;
-    versionId?: string;
-    fileId?: string;
-    localContent?: string;
-};
-export type SendUserEditsPayload = {
-    projectId?: string;
-    diffs: UserEditDiff[];
-};
-/**
- * Sends user edit diffs to the API for persistence/rule extraction.
- * This function is intentionally decoupled from the translate pipeline
- * so it can be called as an independent action.
- */
-export declare function sendUserEditDiffs(diffs: UserEditDiff[], settings: Settings): Promise<void>;

package/dist/api/sendUserEdits.js

@@ -1,15 +0,0 @@
-import { gt } from '../utils/gt.js';
-/**
- * Sends user edit diffs to the API for persistence/rule extraction.
- * This function is intentionally decoupled from the translate pipeline
- * so it can be called as an independent action.
- */
-export async function sendUserEditDiffs(diffs, settings) {
-    if (!diffs.length)
-        return;
-    const payload = {
-        projectId: settings.projectId,
-        diffs,
-    };
-    await gt.submitUserEditDiffs(payload);
-}

package/dist/cli/commands/edits.d.ts

@@ -1,8 +0,0 @@
-import { Settings } from '../../types/index.js';
-export type SendDiffsFlags = {
-    fileName: string;
-    locale: string;
-    old: string;
-    next: string;
-};
-export declare function handleSendDiffs(flags: SendDiffsFlags, settings: Settings): Promise<void>;

package/dist/cli/commands/edits.js

@@ -1,32 +0,0 @@
-import fs from 'node:fs';
-import { getGitUnifiedDiff } from '../../utils/gitDiff.js';
-import { sendUserEditDiffs } from '../../api/sendUserEdits.js';
-import { logErrorAndExit, logMessage } from '../../console/logging.js';
-export async function handleSendDiffs(flags, settings) {
-    const { fileName, locale, old, next } = flags;
-    if (!fs.existsSync(old)) {
-        logErrorAndExit(`Old/original file not found: ${old}`);
-    }
-    if (!fs.existsSync(next)) {
-        logErrorAndExit(`New/local file not found: ${next}`);
-    }
-    let diff;
-    try {
-        diff = await getGitUnifiedDiff(old, next);
-    }
-    catch (e) {
-        logErrorAndExit('Git is required to compute diffs. Please install Git and ensure it is available on your PATH.');
-        return; // unreachable
-    }
-    if (!diff || diff.trim().length === 0) {
-        logMessage('No differences detected — nothing to send.');
-        return;
-    }
-    await sendUserEditDiffs([
-        {
-            fileName,
-            locale,
-            diff,
-        },
-    ], settings);
-}