gtx-cli 2.6.31 → 2.7.0

package/dist/workflows/enqueue.d.ts

@@ -1,17 +0,0 @@
-import { Settings, TranslateFlags } from '../types/index.js';
-import { EnqueueFilesResult, FileToUpload } from 'generaltranslation/types';
-/**
- * Enqueues translations for a given set of files
- *  - Only enqueues uploaded files
- *  - Don't have to worry about double enqueuing files because dedupe on API side
- *
- * @param {FileTranslationData} fileVersionData - The file version data
- * @param {TranslateFlags} options - The options for the enqueue operation
- * @param {Settings} settings - The settings for the enqueue operation
- * @returns {Promise<EnqueueFilesResult>} The enqueue result
- */
-export declare function runEnqueueWorkflow({ files, options, settings, }: {
-    files: FileToUpload[];
-    options: TranslateFlags;
-    settings: Settings;
-}): Promise<EnqueueFilesResult>;

package/dist/workflows/enqueue.js

@@ -1,59 +0,0 @@
-import { logCollectedFiles, logErrorAndExit } from '../console/logging.js';
-import { gt } from '../utils/gt.js';
-import { EnqueueStep } from './steps/EnqueueStep.js';
-import { BranchStep } from './steps/BranchStep.js';
-import { logger } from '../console/logger.js';
-/**
- * Enqueues translations for a given set of files
- *  - Only enqueues uploaded files
- *  - Don't have to worry about double enqueuing files because dedupe on API side
- *
- * @param {FileTranslationData} fileVersionData - The file version data
- * @param {TranslateFlags} options - The options for the enqueue operation
- * @param {Settings} settings - The settings for the enqueue operation
- * @returns {Promise<EnqueueFilesResult>} The enqueue result
- */
-export async function runEnqueueWorkflow({ files, options, settings, }) {
-    try {
-        // Log files to be enqueued
-        logCollectedFiles(files);
-        logger.debug('Files: ' + JSON.stringify(files, null, 2));
-        // Create workflow with steps
-        const branchStep = new BranchStep(gt, settings);
-        // const queryFileDataStep = new QueryFileDataStep(gt);
-        const enqueueStep = new EnqueueStep(gt, settings, options.force);
-        // (1) run the branch step
-        const branchData = await branchStep.run();
-        await branchStep.wait();
-        if (!branchData) {
-            return logErrorAndExit('Failed to resolve git branch information.');
-        }
-        logger.debug('Branch data: ' + JSON.stringify(branchData, null, 2));
-        // (2) Enqueue the files
-        const enqueueResult = await enqueueStep.run(files.map((files) => ({
-            branchId: branchData.currentBranch.id,
-            ...files,
-        })));
-        await enqueueStep.wait();
-        logger.debug('Enqueue result: ' + JSON.stringify(enqueueResult, null, 2));
-        logEnqueueResult(enqueueResult, files);
-        return enqueueResult;
-    }
-    catch (error) {
-        return logErrorAndExit('Failed to enqueue translations. ' + error);
-    }
-}
-// ----- Helper functions ----- //
-/**
- * Logs the enqueue result
- * @param enqueueResult - The enqueue result
- * @returns void
- */
-function logEnqueueResult(enqueueResult, files) {
-    if (Object.keys(enqueueResult.jobData).length === 0) {
-        logger.success(`All ${files.length} files already translated. 0 files enqueued.`);
-    }
-    else {
-        logger.success(enqueueResult.message);
-    }
-}

package/dist/workflows/setupProject.d.ts

@@ -1,13 +0,0 @@
-import { Settings, TranslateFlags } from '../types/index.js';
-import { FileToUpload } from 'generaltranslation/types';
-import { BranchData } from '../types/branch.js';
-/**
- * Sets up a project by uploading files running the setup step
- * @param files - Array of file objects to upload
- * @param options - The options for the API call
- * @param settings - Settings configuration
- * @returns The branch data
- */
-export declare function runSetupProjectWorkflow(files: FileToUpload[], options: TranslateFlags, settings: Settings): Promise<{
-    branchData: BranchData;
-}>;

package/dist/workflows/setupProject.js

@@ -1,48 +0,0 @@
-import { logErrorAndExit } from '../console/logging.js';
-import { gt } from '../utils/gt.js';
-import { UploadSourcesStep } from './steps/UploadSourcesStep.js';
-import { SetupStep } from './steps/SetupStep.js';
-import { BranchStep } from './steps/BranchStep.js';
-import { logCollectedFiles } from '../console/logging.js';
-/**
- * Helper: Calculate timeout with validation
- */
-function calculateTimeout(timeout) {
-    const value = timeout !== undefined ? Number(timeout) : 600;
-    return (Number.isFinite(value) ? value : 600) * 1000;
-}
-/**
- * Sets up a project by uploading files running the setup step
- * @param files - Array of file objects to upload
- * @param options - The options for the API call
- * @param settings - Settings configuration
- * @returns The branch data
- */
-export async function runSetupProjectWorkflow(files, options, settings) {
-    try {
-        // Log files to be translated
-        logCollectedFiles(files);
-        // Calculate timeout for setup step
-        const timeoutMs = calculateTimeout(options.timeout);
-        // Create workflow with steps
-        const branchStep = new BranchStep(gt, settings);
-        const uploadStep = new UploadSourcesStep(gt, settings);
-        const setupStep = new SetupStep(gt, settings, timeoutMs);
-        // first run the branch step
-        const branchData = await branchStep.run();
-        await branchStep.wait();
-        if (!branchData) {
-            return logErrorAndExit('Failed to resolve git branch information.');
-        }
-        // then run the upload step
-        const uploadedFiles = await uploadStep.run({ files, branchData });
-        await uploadStep.wait();
-        // then run the setup step
-        await setupStep.run(uploadedFiles, options.force ?? false);
-        await setupStep.wait();
-        return { branchData };
-    }
-    catch (error) {
-        return logErrorAndExit('Failed to run project setup. ' + error);
-    }
-}

package/dist/workflows/stage.d.ts

@@ -1,18 +0,0 @@
-import { Settings, TranslateFlags } from '../types/index.js';
-import { EnqueueFilesResult, FileToUpload } from 'generaltranslation/types';
-import { BranchData } from '../types/branch.js';
-/**
- * Sends multiple files for translation to the API using a workflow pattern
- * @param files - Array of file objects to translate
- * @param options - The options for the API call
- * @param settings - Settings configuration
- * @returns The translated content or version ID
- */
-export declare function runStageFilesWorkflow({ files, options, settings, }: {
-    files: FileToUpload[];
-    options: TranslateFlags;
-    settings: Settings;
-}): Promise<{
-    branchData: BranchData;
-    enqueueResult: EnqueueFilesResult;
-}>;

package/dist/workflows/stage.js

@@ -1,59 +0,0 @@
-import { logCollectedFiles, logErrorAndExit } from '../console/logging.js';
-import { gt } from '../utils/gt.js';
-import { UploadSourcesStep } from './steps/UploadSourcesStep.js';
-import { SetupStep } from './steps/SetupStep.js';
-import { EnqueueStep } from './steps/EnqueueStep.js';
-import { BranchStep } from './steps/BranchStep.js';
-import { UserEditDiffsStep } from './steps/UserEditDiffsStep.js';
-/**
- * Helper: Calculate timeout with validation
- */
-function calculateTimeout(timeout) {
-    const value = timeout !== undefined ? Number(timeout) : 600;
-    return (Number.isFinite(value) ? value : 600) * 1000;
-}
-/**
- * Sends multiple files for translation to the API using a workflow pattern
- * @param files - Array of file objects to translate
- * @param options - The options for the API call
- * @param settings - Settings configuration
- * @returns The translated content or version ID
- */
-export async function runStageFilesWorkflow({ files, options, settings, }) {
-    try {
-        // Log files to be translated
-        logCollectedFiles(files);
-        // Calculate timeout for setup step
-        const timeoutMs = calculateTimeout(options.timeout);
-        // Create workflow with steps
-        const branchStep = new BranchStep(gt, settings);
-        const uploadStep = new UploadSourcesStep(gt, settings);
-        const userEditDiffsStep = new UserEditDiffsStep(settings);
-        const setupStep = new SetupStep(gt, settings, timeoutMs);
-        const enqueueStep = new EnqueueStep(gt, settings, options.force);
-        // first run the branch step
-        const branchData = await branchStep.run();
-        await branchStep.wait();
-        if (!branchData) {
-            return logErrorAndExit('Failed to resolve git branch information.');
-        }
-        // then run the upload step
-        const uploadedFiles = await uploadStep.run({ files, branchData });
-        await uploadStep.wait();
-        // optionally run the user edit diffs step
-        if (options?.saveLocal) {
-            await userEditDiffsStep.run(uploadedFiles);
-            await userEditDiffsStep.wait();
-        }
-        // then run the setup step
-        await setupStep.run(uploadedFiles);
-        await setupStep.wait();
-        // then run the enqueue step
-        const enqueueResult = await enqueueStep.run(uploadedFiles);
-        await enqueueStep.wait();
-        return { branchData, enqueueResult };
-    }
-    catch (error) {
-        return logErrorAndExit('Failed to send files for translation. ' + error);
-    }
-}

package/dist/workflows/steps/BranchStep.d.ts

@@ -1,13 +0,0 @@
-import { WorkflowStep } from './WorkflowStep.js';
-import { GT } from 'generaltranslation';
-import { Settings } from '../../types/index.js';
-import { BranchData } from '../../types/branch.js';
-export declare class BranchStep extends WorkflowStep<null, BranchData | null> {
-    private spinner;
-    private branchData;
-    private settings;
-    private gt;
-    constructor(gt: GT, settings: Settings);
-    run(): Promise<BranchData | null>;
-    wait(): Promise<void>;
-}

package/dist/workflows/steps/BranchStep.js

@@ -1,161 +0,0 @@
-import { WorkflowStep } from './WorkflowStep.js';
-import { logErrorAndExit } from '../../console/logging.js';
-import { logger } from '../../console/logger.js';
-import chalk from 'chalk';
-import { getCurrentBranch, getIncomingBranches, getCheckedOutBranches, } from '../../git/branches.js';
-import { ApiError } from 'generaltranslation/errors';
-// Step 1: Resolve the current branch id & update API with branch information
-export class BranchStep extends WorkflowStep {
-    spinner = logger.createSpinner('dots');
-    branchData;
-    settings;
-    gt;
-    constructor(gt, settings) {
-        super();
-        this.gt = gt;
-        this.settings = settings;
-        this.branchData = {
-            currentBranch: {
-                id: '',
-                name: '',
-            },
-            incomingBranch: null,
-            checkedOutBranch: null,
-        };
-    }
-    async run() {
-        this.spinner.start(`Resolving branch information...`);
-        // First get some info about the branches we're working with
-        let current = null;
-        let incoming = [];
-        let checkedOut = [];
-        let useDefaultBranch = true;
-        let detectedDefaultBranchName = 'main';
-        let autoDetectFailed = !this.settings.branchOptions.autoDetectBranches;
-        if (this.settings.branchOptions.enabled &&
-            this.settings.branchOptions.autoDetectBranches) {
-            const [currentResult, incomingResult, checkedOutResult] = await Promise.all([
-                getCurrentBranch(this.settings.branchOptions.remoteName),
-                getIncomingBranches(this.settings.branchOptions.remoteName),
-                getCheckedOutBranches(this.settings.branchOptions.remoteName),
-            ]);
-            current = currentResult;
-            incoming = incomingResult;
-            checkedOut = checkedOutResult;
-            if (currentResult) {
-                detectedDefaultBranchName = currentResult.defaultBranchName;
-            }
-            // Try env var detection if git commands failed (e.g. Vercel)
-            if (!currentResult) {
-                autoDetectFailed = true;
-                const vercelBranch = process.env.VERCEL_GIT_COMMIT_REF;
-                if (vercelBranch) {
-                    current = { currentBranchName: vercelBranch, defaultBranch: false };
-                }
-            }
-            // If detection succeeded, use the detected branch; otherwise fall back to default
-            if (current) {
-                useDefaultBranch = false;
-            }
-        }
-        if (this.settings.branchOptions.enabled &&
-            this.settings.branchOptions.currentBranch) {
-            current = {
-                currentBranchName: this.settings.branchOptions.currentBranch,
-                defaultBranch: current?.defaultBranch ?? false, // we have no way of knowing if this is the default branch without using the auto-detection logic
-            };
-            useDefaultBranch = false;
-        }
-        const branchData = await this.gt.queryBranchData({
-            branchNames: [
-                ...(current ? [current.currentBranchName] : []),
-                ...incoming,
-                ...checkedOut,
-            ],
-        });
-        if (useDefaultBranch) {
-            if (autoDetectFailed) {
-                logger.warn('Branch auto-detection failed. Falling back to the default branch. Use --branch to specify a branch manually.');
-            }
-            if (!branchData.defaultBranch) {
-                const createBranchResult = await this.gt.createBranch({
-                    branchName: detectedDefaultBranchName,
-                    defaultBranch: true,
-                });
-                this.branchData.currentBranch = createBranchResult.branch;
-            }
-            else {
-                this.branchData.currentBranch = branchData.defaultBranch;
-            }
-        }
-        else {
-            if (!current) {
-                return logErrorAndExit('Failed to determine the current branch. Please specify a custom branch or enable automatic branch detection.');
-            }
-            const currentBranch = branchData.branches.find((b) => b.name === current.currentBranchName);
-            if (!currentBranch) {
-                try {
-                    const createBranchResult = await this.gt.createBranch({
-                        branchName: current.currentBranchName,
-                        defaultBranch: current.defaultBranch,
-                    });
-                    this.branchData.currentBranch = createBranchResult.branch;
-                }
-                catch (error) {
-                    if (error instanceof ApiError && error.code === 403) {
-                        logger.warn('To enable translation branching, please upgrade your plan. Falling back to default branch.');
-                        // retry with default branch
-                        try {
-                            const createBranchResult = await this.gt.createBranch({
-                                branchName: detectedDefaultBranchName,
-                                defaultBranch: true,
-                            });
-                            this.branchData.currentBranch = createBranchResult.branch;
-                        }
-                        catch { }
-                    }
-                }
-            }
-            else {
-                this.branchData.currentBranch = currentBranch;
-            }
-        }
-        if (this.branchData.currentBranch.id === '') {
-            return logErrorAndExit('Something went wrong while resolving branch information. Please try again.');
-        }
-        // Now set the incoming and checked out branches (first one that exists)
-        this.branchData.incomingBranch =
-            incoming
-                .map((b) => {
-                const branch = branchData.branches.find((bb) => bb.name === b);
-                if (branch) {
-                    return branch;
-                }
-                else {
-                    return null;
-                }
-            })
-                .filter((b) => b !== null)[0] ?? null;
-        this.branchData.checkedOutBranch =
-            checkedOut
-                .map((b) => {
-                const branch = branchData.branches.find((bb) => bb.name === b);
-                if (branch) {
-                    return branch;
-                }
-                else {
-                    return null;
-                }
-            })
-                .filter((b) => b !== null)[0] ?? null;
-        // ALWAYS fallback to default branch for checked out branch (to avoid retranslation)
-        if (!this.branchData.checkedOutBranch && branchData.defaultBranch) {
-            this.branchData.checkedOutBranch = branchData.defaultBranch;
-        }
-        this.spinner.stop(chalk.green('Branch information resolved successfully'));
-        return this.branchData;
-    }
-    async wait() {
-        return;
-    }
-}

package/dist/workflows/steps/DownloadStep.d.ts

@@ -1,19 +0,0 @@
-import { WorkflowStep } from './WorkflowStep.js';
-import { GT } from 'generaltranslation';
-import { Settings } from '../../types/index.js';
-import { FileStatusTracker } from './PollJobsStep.js';
-export type DownloadTranslationsInput = {
-    fileTracker: FileStatusTracker;
-    resolveOutputPath: (sourcePath: string, locale: string) => string | null;
-    forceDownload?: boolean;
-};
-export declare class DownloadTranslationsStep extends WorkflowStep<DownloadTranslationsInput, boolean> {
-    private gt;
-    private settings;
-    private spinner;
-    constructor(gt: GT, settings: Settings);
-    run({ fileTracker, resolveOutputPath, forceDownload, }: DownloadTranslationsInput): Promise<boolean>;
-    private downloadFiles;
-    private downloadFilesWithRetry;
-    wait(): Promise<void>;
-}

package/dist/workflows/steps/DownloadStep.js

@@ -1,131 +0,0 @@
-import chalk from 'chalk';
-import { WorkflowStep } from './WorkflowStep.js';
-import { logger } from '../../console/logger.js';
-import { downloadFileBatch, } from '../../api/downloadFileBatch.js';
-import { recordWarning } from '../../state/translateWarnings.js';
-export class DownloadTranslationsStep extends WorkflowStep {
-    gt;
-    settings;
-    spinner = null;
-    constructor(gt, settings) {
-        super();
-        this.gt = gt;
-        this.settings = settings;
-    }
-    async run({ fileTracker, resolveOutputPath, forceDownload, }) {
-        this.spinner = logger.createProgressBar(fileTracker.completed.size);
-        this.spinner.start('Downloading files...');
-        // Download ready files
-        const success = await this.downloadFiles(fileTracker, resolveOutputPath, forceDownload);
-        if (success) {
-            this.spinner.stop(chalk.green('Downloaded files successfully'));
-        }
-        else {
-            this.spinner.stop(chalk.red('Failed to download files'));
-        }
-        return success;
-    }
-    async downloadFiles(fileTracker, resolveOutputPath, forceDownload) {
-        try {
-            // Only download files that are marked as completed
-            const currentQueryData = Array.from(fileTracker.completed.values());
-            // If no files to download, we're done
-            if (currentQueryData.length === 0) {
-                return true;
-            }
-            // Check for translations
-            const responseData = await this.gt.queryFileData({
-                translatedFiles: currentQueryData.map((item) => ({
-                    fileId: item.fileId,
-                    versionId: item.versionId,
-                    branchId: item.branchId,
-                    locale: item.locale,
-                })),
-            });
-            const translatedFiles = responseData.translatedFiles || [];
-            // Filter for ready translations
-            const readyTranslations = translatedFiles.filter((file) => file.completedAt !== null);
-            // Prepare batch download data
-            const batchFiles = readyTranslations
-                .map((translation) => {
-                const fileKey = `${translation.branchId}:${translation.fileId}:${translation.versionId}:${translation.locale}`;
-                const fileProperties = fileTracker.completed.get(fileKey);
-                if (!fileProperties) {
-                    return null;
-                }
-                const outputPath = resolveOutputPath(fileProperties.fileName, translation.locale);
-                // Skip downloading GTJSON files that are not in the files configuration
-                if (outputPath === null) {
-                    fileTracker.completed.delete(fileKey);
-                    fileTracker.skipped.set(fileKey, fileProperties);
-                    return null;
-                }
-                return {
-                    branchId: translation.branchId,
-                    fileId: translation.fileId,
-                    versionId: translation.versionId,
-                    locale: translation.locale,
-                    inputPath: fileProperties.fileName,
-                    outputPath,
-                };
-            })
-                .filter((file) => file !== null);
-            if (batchFiles.length > 0) {
-                const batchResult = await this.downloadFilesWithRetry(fileTracker, batchFiles, forceDownload);
-                this.spinner?.stop(chalk.green(`Downloaded ${batchResult.successful.length} files${batchResult.skipped.length > 0 ? `, skipped ${batchResult.skipped.length} files` : ''}`));
-                if (batchResult.failed.length > 0) {
-                    logger.warn(`Failed to download ${batchResult.failed.length} files: ${batchResult.failed.map((f) => f.inputPath).join('\n')}`);
-                    for (const f of batchResult.failed) {
-                        recordWarning('failed_download', f.inputPath, `Failed to download for locale ${f.locale}`);
-                    }
-                }
-            }
-            else {
-                this.spinner?.stop(chalk.green('No files to download'));
-            }
-            return true;
-        }
-        catch (error) {
-            this.spinner?.stop(chalk.red('An error occurred while downloading translations'));
-            logger.error(chalk.red('Error: ') + error);
-            return false;
-        }
-    }
-    async downloadFilesWithRetry(fileTracker, files, forceDownload, maxRetries = 3, initialDelay = 1000) {
-        let remainingFiles = files;
-        let allSuccessful = [];
-        let retryCount = 0;
-        let allSkipped = [];
-        while (remainingFiles.length > 0 && retryCount <= maxRetries) {
-            const batchResult = await downloadFileBatch(fileTracker, remainingFiles, this.settings, forceDownload);
-            allSuccessful = [...allSuccessful, ...batchResult.successful];
-            allSkipped = [...allSkipped, ...batchResult.skipped];
-            this.spinner?.advance(batchResult.successful.length +
-                batchResult.skipped.length +
-                batchResult.failed.length);
-            // If no failures or we've exhausted retries, we're done
-            if (batchResult.failed.length === 0 || retryCount === maxRetries) {
-                return {
-                    successful: allSuccessful,
-                    failed: batchResult.failed,
-                    skipped: allSkipped,
-                };
-            }
-            // Calculate exponential backoff delay
-            const delay = initialDelay * Math.pow(2, retryCount);
-            logger.error(chalk.yellow(`Retrying ${batchResult.failed.length} failed file(s) in ${delay}ms (attempt ${retryCount + 1}/${maxRetries})...`));
-            // Wait before retrying
-            await new Promise((resolve) => setTimeout(resolve, delay));
-            remainingFiles = batchResult.failed;
-            retryCount++;
-        }
-        return {
-            successful: allSuccessful,
-            failed: remainingFiles,
-            skipped: allSkipped,
-        };
-    }
-    async wait() {
-        return;
-    }
-}

package/dist/workflows/steps/EnqueueStep.d.ts

@@ -1,15 +0,0 @@
-import type { EnqueueFilesResult } from 'generaltranslation/types';
-import { WorkflowStep } from './WorkflowStep.js';
-import { GT } from 'generaltranslation';
-import { Settings } from '../../types/index.js';
-import type { FileReference } from 'generaltranslation/types';
-export declare class EnqueueStep extends WorkflowStep<FileReference[], EnqueueFilesResult> {
-    private gt;
-    private settings;
-    private force?;
-    private spinner;
-    private result;
-    constructor(gt: GT, settings: Settings, force?: boolean | undefined);
-    run(files: FileReference[]): Promise<EnqueueFilesResult>;
-    wait(): Promise<void>;
-}

package/dist/workflows/steps/EnqueueStep.js

@@ -1,33 +0,0 @@
-import { WorkflowStep } from './WorkflowStep.js';
-import { logger } from '../../console/logger.js';
-import chalk from 'chalk';
-export class EnqueueStep extends WorkflowStep {
-    gt;
-    settings;
-    force;
-    spinner = logger.createSpinner('dots');
-    result = null;
-    constructor(gt, settings, force) {
-        super();
-        this.gt = gt;
-        this.settings = settings;
-        this.force = force;
-    }
-    async run(files) {
-        this.spinner.start('Enqueuing translations...');
-        this.result = await this.gt.enqueueFiles(files, {
-            sourceLocale: this.settings.defaultLocale,
-            targetLocales: this.settings.locales,
-            publish: this.settings.publish,
-            requireApproval: this.settings.stageTranslations,
-            modelProvider: this.settings.modelProvider,
-            force: this.force,
-        });
-        return this.result;
-    }
-    async wait() {
-        if (this.result) {
-            this.spinner.stop(chalk.green('Translations enqueued successfully'));
-        }
-    }
-}

package/dist/workflows/steps/PollJobsStep.d.ts

@@ -1,31 +0,0 @@
-import { WorkflowStep } from './WorkflowStep.js';
-import { GT } from 'generaltranslation';
-import { EnqueueFilesResult } from 'generaltranslation/types';
-import type { FileProperties } from '../../types/files.js';
-export type PollJobsInput = {
-    fileTracker: FileStatusTracker;
-    fileQueryData: FileProperties[];
-    jobData: EnqueueFilesResult;
-    timeoutDuration: number;
-    forceRetranslation?: boolean;
-};
-export type FileStatusTracker = {
-    completed: Map<string, FileProperties>;
-    inProgress: Map<string, FileProperties>;
-    failed: Map<string, FileProperties>;
-    skipped: Map<string, FileProperties>;
-};
-export type PollJobsOutput = {
-    success: boolean;
-    fileTracker: FileStatusTracker;
-};
-export declare class PollTranslationJobsStep extends WorkflowStep<PollJobsInput, PollJobsOutput> {
-    private gt;
-    private spinner;
-    private previousProgress;
-    constructor(gt: GT);
-    run({ fileTracker, fileQueryData, jobData, timeoutDuration, forceRetranslation, }: PollJobsInput): Promise<PollJobsOutput>;
-    private updateSpinner;
-    private generateStatusSuffixText;
-    wait(): Promise<void>;
-}