gt 2.11.2 → 2.11.3

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # gtx-cli
 
+## 2.11.3
+
+### Patch Changes
+
+- [#1133](https://github.com/generaltranslation/gt/pull/1133) [`4de22d7`](https://github.com/generaltranslation/gt/commit/4de22d7548b5d34c0d7e465132878d192c2f41e0) Thanks [@fernando-aviles](https://github.com/fernando-aviles)! - Extending publish step to save-local and upload commands
+
 ## 2.11.2
 
 ### Patch Changes

package/dist/api/collectUserEditDiffs.d.ts

@@ -6,4 +6,4 @@ import { FileReference } from 'generaltranslation/types';
  *
  * Must run before enqueueing new translations so rules are available to the generator.
  */
-export declare function collectAndSendUserEditDiffs(files: FileReference[], settings: Settings): Promise<void>;
+export declare function collectAndSendUserEditDiffs(files: FileReference[], settings: Settings): Promise<boolean>;

package/dist/api/collectUserEditDiffs.js

@@ -26,7 +26,7 @@ const findLatestDownloadedVersion = (entryMap, fileId, locale) => {
  */
 export async function collectAndSendUserEditDiffs(files, settings) {
     if (!settings.files)
-        return;
+        return false;
     const { resolvedPaths, placeholderPaths, transformPaths } = settings.files;
     const fileMapping = createFileMapping(resolvedPaths, placeholderPaths, transformPaths, settings.locales, settings.defaultLocale);
     const { entryMap } = readLockfile(settings);
@@ -153,4 +153,5 @@ export async function collectAndSendUserEditDiffs(files, settings) {
     if (collectedDiffs.length > 0) {
         await gt.submitUserEditDiffs({ diffs: collectedDiffs });
     }
+    return collectedDiffs.length > 0;
 }

package/dist/api/saveLocalEdits.js

@@ -5,6 +5,7 @@ import { BranchStep } from '../workflows/steps/BranchStep.js';
 import { logErrorAndExit } from '../console/logging.js';
 import { logger } from '../console/logger.js';
 import chalk from 'chalk';
+import { runPublishWorkflow } from '../workflows/publish.js';
 /**
  * Uploads current source files to obtain file references, then collects and sends
  * diffs for all locales based on last downloaded versions. Does not enqueue translations.
@@ -13,7 +14,7 @@ export async function saveLocalEdits(settings) {
     if (!settings.files)
         return;
     // Collect current files from config
-    const { files } = await aggregateFiles(settings);
+    const { files, publishMap } = await aggregateFiles(settings);
     if (!files.length)
         return;
     // run branch query to get branch id
@@ -33,6 +34,10 @@ export async function saveLocalEdits(settings) {
     }));
     const spinner = logger.createSpinner('dots');
     spinner.start('Saving local edits...');
-    await collectAndSendUserEditDiffs(uploads, settings);
+    const hadDiffs = await collectAndSendUserEditDiffs(uploads, settings);
     spinner.stop(chalk.green('Local edits saved successfully'));
+    // Publish files to CDN if diffs were detected and publish config exists
+    if (hadDiffs) {
+        await runPublishWorkflow(files, publishMap, branchResult.currentBranch.id, settings);
+    }
 }

package/dist/cli/base.js

@@ -121,7 +121,9 @@ export class BaseCLI {
     setupSendDiffsCommand() {
         attachSharedFlags(this.program
             .command('save-local')
-            .description('Save local edits for all configured files by sending diffs (no translation enqueued)')).action(async (initOptions) => {
+            .description('Save local edits for all configured files by sending diffs (no translation enqueued)'))
+            .option('--publish', 'Publish translations to the CDN', false)
+            .action(async (initOptions) => {
             displayHeader('Saving local edits...');
             const settings = await generateSettings(initOptions);
             await saveLocalEdits(settings);

package/dist/cli/commands/translate.js

@@ -9,9 +9,7 @@ import processOpenApi from '../../utils/processOpenApi.js';
 import localizeStaticImports from '../../utils/localizeStaticImports.js';
 import { getDownloadedMeta } from '../../state/recentDownloads.js';
 import { persistPostProcessHashes } from '../../utils/persistPostprocessHashes.js';
-import { PublishStep } from '../../workflows/steps/PublishStep.js';
-import { gt } from '../../utils/gt.js';
-import { hasPublishConfig } from '../../utils/resolvePublish.js';
+import { runPublishWorkflow } from '../../workflows/publish.js';
 // Downloads translations that were completed
 export async function handleTranslate(options, settings, fileVersionData, jobData, branchData, publishMap) {
     if (fileVersionData) {
@@ -30,19 +28,13 @@ export async function handleTranslate(options, settings, fileVersionData, jobDat
             forceDownload: options.forceDownload || options.force, // if force is true should also force download
         });
         // Publish/unpublish files after translations are downloaded
-        if (publishMap && hasPublishConfig(settings)) {
-            const allFileRefs = Object.entries(fileVersionData)
-                .filter(([fileId]) => publishMap.has(fileId))
-                .map(([fileId, data]) => ({
+        if (publishMap && branchData?.currentBranch.id) {
+            const files = Object.entries(fileVersionData).map(([fileId, data]) => ({
                 fileId,
                 versionId: data.versionId,
-                branchId: branchData?.currentBranch.id,
-                publish: publishMap.get(fileId),
                 fileName: data.fileName,
             }));
-            const publishStep = new PublishStep(gt);
-            await publishStep.run(allFileRefs);
-            await publishStep.wait();
+            await runPublishWorkflow(files, publishMap, branchData.currentBranch.id, settings);
         }
     }
 }

package/dist/cli/commands/upload.js

@@ -13,6 +13,8 @@ import { createFileMapping } from '../../formats/files/fileMapping.js';
 import parseYaml from '../../formats/yaml/parseYaml.js';
 import { hashStringSync } from '../../utils/hash.js';
 import { hasValidCredentials } from './utils/validation.js';
+import { buildPublishMap } from '../../utils/resolvePublish.js';
+import { runPublishWorkflow } from '../../workflows/publish.js';
 const SUPPORTED_DATA_FORMATS = ['JSX', 'ICU', 'I18NEXT'];
 /**
  * Sends multiple files to the API for translation
@@ -180,7 +182,13 @@ export async function upload(filePaths, placeholderPaths, transformPaths, dataFo
     });
     try {
         // Send all files in a single API call
-        await runUploadFilesWorkflow({ files: uploadData, options: settings });
+        const { branchData } = await runUploadFilesWorkflow({
+            files: uploadData,
+            options: settings,
+        });
+        // Publish files to CDN if publish config exists
+        const publishMap = buildPublishMap(filePaths, settings);
+        await runPublishWorkflow(allFiles, publishMap, branchData.currentBranch.id, settings);
     }
     catch (error) {
         logErrorAndExit(`Error uploading files: ${error}`);

package/dist/formats/files/aggregateFiles.js

@@ -11,7 +11,7 @@ import { determineLibrary } from '../../fs/determineFramework/index.js';
 import { hashStringSync } from '../../utils/hash.js';
 import { preprocessContent } from './preprocessContent.js';
 import { parseKeyedMetadata, } from '../parseKeyedMetadata.js';
-import { shouldPublishFile } from '../../utils/resolvePublish.js';
+import { buildPublishMap } from '../../utils/resolvePublish.js';
 /**
  * Checks if a file path is a metadata companion file (e.g. foo.metadata.json)
  * AND its corresponding source file (e.g. foo.json) exists in the file list.
@@ -29,32 +29,15 @@ export const SUPPORTED_DATA_FORMATS = ['JSX', 'ICU', 'I18NEXT'];
 export async function aggregateFiles(settings) {
     // Aggregate all files to translate
     const files = [];
-    const publishMap = new Map();
     if (!settings.files ||
         (Object.keys(settings.files.placeholderPaths).length === 1 &&
             settings.files.placeholderPaths.gt)) {
-        return { files, publishMap };
+        return { files, publishMap: new Map() };
     }
     const { resolvedPaths: filePaths } = settings.files;
     const skipValidation = settings.options?.skipFileValidation;
     // Build publish map upfront from resolved paths.
-    // Only include files that have an explicit publish config or when a global
-    // publish flag is defined. Files without any config are left out of the map
-    // so the publish endpoint is never called for them.
-    const hasGlobalPublish = settings.publish !== undefined;
-    for (const fileType of SUPPORTED_FILE_EXTENSIONS) {
-        if (filePaths[fileType]) {
-            for (const absolutePath of filePaths[fileType]) {
-                const hasExplicitConfig = settings.files.publishPaths?.has(absolutePath) ||
-                    settings.files.unpublishPaths?.has(absolutePath);
-                if (hasGlobalPublish || hasExplicitConfig) {
-                    const relativePath = getRelative(absolutePath);
-                    const fileId = hashStringSync(relativePath);
-                    publishMap.set(fileId, shouldPublishFile(absolutePath, settings));
-                }
-            }
-        }
-    }
+    const publishMap = buildPublishMap(filePaths, settings);
     // Process JSON files
     if (filePaths.json) {
         const { library, additionalModules } = determineLibrary();

package/dist/generated/version.d.ts

@@ -1 +1 @@
-export declare const PACKAGE_VERSION = "2.11.2";
+export declare const PACKAGE_VERSION = "2.11.3";

package/dist/generated/version.js

@@ -1,2 +1,2 @@
 // This file is auto-generated. Do not edit manually.
-export const PACKAGE_VERSION = '2.11.2';
+export const PACKAGE_VERSION = '2.11.3';

package/dist/utils/resolvePublish.d.ts

@@ -1,4 +1,4 @@
-import { Settings } from '../types/index.js';
+import { Settings, ResolvedFiles } from '../types/index.js';
 /**
  * Determines whether a file should be published based on the publish resolution logic:
  * - If the file is explicitly opted OUT (unpublishPaths), never publish
@@ -6,6 +6,13 @@ import { Settings } from '../types/index.js';
  * - Otherwise, fall back to the global publish setting
  */
 export declare function shouldPublishFile(resolvedPath: string, settings: Settings): boolean;
+/**
+ * Builds a publish map from resolved file paths.
+ * Only includes files that have an explicit publish config or when a global
+ * publish flag is defined. Files without any config are left out of the map
+ * so the publish endpoint is never called for them.
+ */
+export declare function buildPublishMap(filePaths: ResolvedFiles, settings: Settings): Map<string, boolean>;
 /**
  * Returns true if the user has any explicit publish configuration —
  * global flag, gt-specific flag, or per-file publish/unpublish patterns.

package/dist/utils/resolvePublish.js

@@ -1,3 +1,6 @@
+import { SUPPORTED_FILE_EXTENSIONS } from '../formats/files/supportedFiles.js';
+import { getRelative } from '../fs/findFilepath.js';
+import { hashStringSync } from './hash.js';
 /**
  * Determines whether a file should be published based on the publish resolution logic:
  * - If the file is explicitly opted OUT (unpublishPaths), never publish
@@ -11,6 +14,30 @@ export function shouldPublishFile(resolvedPath, settings) {
         return true;
     return settings.publish ?? false;
 }
+/**
+ * Builds a publish map from resolved file paths.
+ * Only includes files that have an explicit publish config or when a global
+ * publish flag is defined. Files without any config are left out of the map
+ * so the publish endpoint is never called for them.
+ */
+export function buildPublishMap(filePaths, settings) {
+    const publishMap = new Map();
+    const hasGlobalPublish = settings.publish !== undefined;
+    for (const fileType of SUPPORTED_FILE_EXTENSIONS) {
+        if (filePaths[fileType]) {
+            for (const absolutePath of filePaths[fileType]) {
+                const hasExplicitConfig = settings.files.publishPaths?.has(absolutePath) ||
+                    settings.files.unpublishPaths?.has(absolutePath);
+                if (hasGlobalPublish || hasExplicitConfig) {
+                    const relativePath = getRelative(absolutePath);
+                    const fileId = hashStringSync(relativePath);
+                    publishMap.set(fileId, shouldPublishFile(absolutePath, settings));
+                }
+            }
+        }
+    }
+    return publishMap;
+}
 /**
  * Returns true if the user has any explicit publish configuration —
  * global flag, gt-specific flag, or per-file publish/unpublish patterns.

package/dist/workflows/publish.d.ts

@@ -0,0 +1,10 @@
+import { Settings } from '../types/index.js';
+/**
+ * Publishes files to the CDN if publish config exists and the publishMap is non-empty.
+ * Shared by translate, upload, and save-local commands.
+ */
+export declare function runPublishWorkflow(files: {
+    fileId: string;
+    versionId: string;
+    fileName: string;
+}[], publishMap: Map<string, boolean>, branchId: string, settings: Settings): Promise<void>;

package/dist/workflows/publish.js

@@ -0,0 +1,31 @@
+import { PublishStep } from './steps/PublishStep.js';
+import { gt } from '../utils/gt.js';
+import { hasPublishConfig } from '../utils/resolvePublish.js';
+import { logger } from '../console/logger.js';
+/**
+ * Publishes files to the CDN if publish config exists and the publishMap is non-empty.
+ * Shared by translate, upload, and save-local commands.
+ */
+export async function runPublishWorkflow(files, publishMap, branchId, settings) {
+    if (publishMap.size === 0 || !hasPublishConfig(settings))
+        return;
+    try {
+        const allFileRefs = files
+            .filter((file) => publishMap.has(file.fileId))
+            .map((file) => ({
+            fileId: file.fileId,
+            versionId: file.versionId,
+            branchId,
+            publish: publishMap.get(file.fileId),
+            fileName: file.fileName,
+        }));
+        if (allFileRefs.length === 0)
+            return;
+        const publishStep = new PublishStep(gt);
+        await publishStep.run(allFileRefs);
+        await publishStep.wait();
+    }
+    catch (error) {
+        logger.warn(`Failed to publish files: ${error instanceof Error ? error.message : String(error)}`);
+    }
+}

package/dist/workflows/upload.d.ts

@@ -1,10 +1,11 @@
 import { Settings } from '../types/index.js';
 import type { FileToUpload } from 'generaltranslation/types';
+import { BranchData } from '../types/branch.js';
 /**
  * Uploads multiple files to the API using a workflow pattern
  * @param files - Array of file objects to upload
  * @param options - The options for the API call
- * @returns The uploaded content or version ID
+ * @returns The branch data resolved during the workflow
  */
 export declare function runUploadFilesWorkflow({ files, options, }: {
     files: {
@@ -12,4 +13,6 @@ export declare function runUploadFilesWorkflow({ files, options, }: {
         translations: FileToUpload[];
     }[];
     options: Settings;
-}): Promise<undefined>;
+}): Promise<{
+    branchData: BranchData;
+}>;

package/dist/workflows/upload.js

@@ -9,7 +9,7 @@ import { UploadTranslationsStep } from './steps/UploadTranslationsStep.js';
  * Uploads multiple files to the API using a workflow pattern
  * @param files - Array of file objects to upload
  * @param options - The options for the API call
- * @returns The uploaded content or version ID
+ * @returns The branch data resolved during the workflow
  */
 export async function runUploadFilesWorkflow({ files, options, }) {
     try {
@@ -40,6 +40,7 @@ export async function runUploadFilesWorkflow({ files, options, }) {
             await uploadTranslationsStep.wait();
         }
         logger.success('All files uploaded successfully');
+        return { branchData };
     }
     catch (error) {
         return logErrorAndExit('Failed to upload files. ' + error);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gt",
-  "version": "2.11.2",
+  "version": "2.11.3",
   "main": "dist/index.js",
   "bin": "dist/main.js",
   "files": [
@@ -110,8 +110,8 @@
     "unified": "^11.0.5",
     "unist-util-visit": "^5.0.0",
     "yaml": "^2.8.0",
-    "@generaltranslation/python-extractor": "0.1.6",
     "generaltranslation": "8.1.20",
+    "@generaltranslation/python-extractor": "0.1.6",
     "gt-remark": "1.0.6"
   },
   "devDependencies": {