gtx-cli 2.6.9 → 2.6.10

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # gtx-cli
 
+## 2.6.10
+
+### Patch Changes
+
+- [#986](https://github.com/generaltranslation/gt/pull/986) [`b943ac2`](https://github.com/generaltranslation/gt/commit/b943ac200d8ec41219b3c09a669f94590fec0f65) Thanks [@ErnestM1234](https://github.com/ErnestM1234)! - chore: include branchid in gt config
+
 ## 2.6.9
 
 ### Patch Changes

package/dist/cli/base.js

@@ -105,8 +105,7 @@ export class BaseCLI {
         if (!settings.stageTranslations) {
             // Update settings.stageTranslations to true
             settings.stageTranslations = true;
-            await updateConfig({
-                configFilepath: settings.config,
+            await updateConfig(settings.config, {
                 stageTranslations: true,
             });
         }

package/dist/cli/commands/stage.js

@@ -56,12 +56,19 @@ export async function handleStage(options, settings, library, stage) {
         }
         const templateData = allFiles.find((file) => file.fileId === TEMPLATE_FILE_ID);
         if (templateData?.versionId) {
-            await updateConfig({
-                configFilepath: settings.config,
+            await updateConfig(settings.config, {
                 _versionId: templateData.versionId,
+                _branchId: branchData.currentBranch.id,
             });
         }
     }
+    // Always delete branch id from config if branching is disabled
+    // Avoids incorrect CDN queries at runtime
+    if (!settings.branchOptions.enabled) {
+        await updateConfig(settings.config, {
+            _branchId: null,
+        });
+    }
     return {
         fileVersionData,
         jobData,

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

@@ -1,10 +1,21 @@
+/**
+ * Options for updating the config file.
+ *
+ * Since these are all string values, we can use null to mark them for removal
+ */
+type UpdateConfigOptions = {
+    projectId?: string | null;
+    _versionId?: string | null;
+    _branchId?: string | null;
+    stageTranslations?: boolean | null;
+};
 /**
  * Update the config file version id, locales, and projectId (if necessary)
- * @param {Record<string, any>} configObject - The config object to write if the file does not exist.
+ * @param {string} configFilepath - The path to the config file.
+ * @param {UpdateConfigOptions} options - The options to update the config file with.
+ * @returns {Promise<void>} - A promise that resolves when the config file is updated.
+ *
+ * Hint: Mark a field as null to remove it from the config file.
  */
-export default function updateConfig({ configFilepath, projectId, _versionId, stageTranslations, }: {
-    configFilepath: string;
-    projectId?: string;
-    _versionId?: string;
-    stageTranslations?: boolean;
-}): Promise<void>;
+export default function updateConfig(configFilepath: string, options: UpdateConfigOptions): Promise<void>;
+export {};

package/dist/fs/config/updateConfig.js

@@ -3,15 +3,21 @@ import { displayUpdatedConfigFile } from '../../console/logging.js';
 import { logger } from '../../console/logger.js';
 /**
  * Update the config file version id, locales, and projectId (if necessary)
- * @param {Record<string, any>} configObject - The config object to write if the file does not exist.
+ * @param {string} configFilepath - The path to the config file.
+ * @param {UpdateConfigOptions} options - The options to update the config file with.
+ * @returns {Promise<void>} - A promise that resolves when the config file is updated.
+ *
+ * Hint: Mark a field as null to remove it from the config file.
  */
-export default async function updateConfig({ configFilepath, projectId, _versionId, stageTranslations, }) {
+export default async function updateConfig(configFilepath, options) {
     // Filter out empty string values from the config object
+    const { projectId, _versionId, _branchId, stageTranslations } = options;
     const newContent = {
         ...(projectId && { projectId }),
         ...(_versionId && { _versionId }),
+        ...(_branchId && { _branchId }),
+        // Omit when false
         ...(stageTranslations && { stageTranslations }),
-        // ...(locales && { locales }), // Don't override locales
     };
     try {
         // if file exists
@@ -24,9 +30,11 @@ export default async function updateConfig({ configFilepath, projectId, _version
             ...oldContent,
             ...newContent,
         };
+        // Apply null filter to remove values that were marked for removal
+        const filteredContent = applyNullFilter(mergedContent, options);
         // write to file
-        const mergedJsonContent = JSON.stringify(mergedContent, null, 2);
-        await fs.promises.writeFile(configFilepath, mergedJsonContent, 'utf-8');
+        const jsonContent = JSON.stringify(filteredContent, null, 2);
+        await fs.promises.writeFile(configFilepath, jsonContent, 'utf-8');
         // show update in console
         displayUpdatedConfigFile(configFilepath);
     }
@@ -34,3 +42,16 @@ export default async function updateConfig({ configFilepath, projectId, _version
         logger.error(`An error occurred while updating ${configFilepath}: ${error}`);
     }
 }
+// --- Helper functions --- //
+/**
+ * Remove values from object if they were marked for removal
+ */
+function applyNullFilter(obj, filter) {
+    const result = { ...obj };
+    for (const key of Object.keys(filter)) {
+        if (filter[key] === null) {
+            delete result[key];
+        }
+    }
+    return result;
+}

package/dist/generated/version.d.ts

@@ -1 +1 @@
-export declare const PACKAGE_VERSION = "2.6.9";
+export declare const PACKAGE_VERSION = "2.6.10";

package/dist/generated/version.js

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

package/package.json

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