@tolgee/cli 2.12.1 → 2.14.0

package/dist/client/errorFromLoadable.js

@@ -1,5 +1,7 @@
+import { getUnresolvedConflictsMessage } from '../utils/printFailedKeys.js';
 export const addErrorDetails = (loadable, showBeError = true) => {
-    var _a, _b, _c;
+    var _a, _b, _c, _d, _e;
+    let additionalInfo = '';
     const items = [];
     items.push(`status: ${loadable.response.status}`);
     if (showBeError && ((_a = loadable.error) === null || _a === void 0 ? void 0 : _a.code)) {
@@ -8,7 +10,11 @@ export const addErrorDetails = (loadable, showBeError = true) => {
     if (loadable.response.status === 403 && ((_c = (_b = loadable.error) === null || _b === void 0 ? void 0 : _b.params) === null || _c === void 0 ? void 0 : _c[0])) {
         items.push(`missing scope: ${loadable.error.params[0]}`);
     }
-    return `[${items.join(', ')}]`;
+    if (((_d = loadable.error) === null || _d === void 0 ? void 0 : _d.code) === 'conflict_is_not_resolved' &&
+        typeof ((_e = loadable.error.params) === null || _e === void 0 ? void 0 : _e[0]) === 'object') {
+        additionalInfo += getUnresolvedConflictsMessage(loadable.error.params, true);
+    }
+    return `[${items.join(', ')}]${additionalInfo ? '\n' + additionalInfo : ''}`;
 };
 export const errorFromLoadable = (loadable) => {
     switch (loadable.response.status) {

package/dist/commands/pull.js

@@ -30,6 +30,7 @@ function fetchZipBlob(opts) {
             filterTagIn: opts.tags,
             filterTagNotIn: opts.excludeTags,
             fileStructureTemplate: opts.fileStructureTemplate,
+            escapeHtml: false,
         });
         handleLoadableError(loadable);
         return loadable.data;

package/dist/commands/push.js

@@ -18,6 +18,7 @@ import { mapImportFormat } from '../utils/mapImportFormat.js';
 import { handleLoadableError } from '../client/TolgeeClient.js';
 import { findFilesByTemplate } from '../utils/filesTemplate.js';
 import { valueToArray } from '../utils/valueToArray.js';
+import { printUnresolvedConflicts } from '../utils/printFailedKeys.js';
 function allInPattern(pattern) {
     return __awaiter(this, void 0, void 0, function* () {
         const files = [];
@@ -100,7 +101,7 @@ function handleMappingError(fileMappings) {
 }
 const pushHandler = (config) => function () {
     return __awaiter(this, void 0, void 0, function* () {
-        var _a, _b, _c, _d;
+        var _a, _b, _c, _d, _e, _f, _g;
         const opts = this.optsWithGlobals();
         let allMatchers = [];
         const filesTemplate = opts.filesTemplate;
@@ -130,12 +131,25 @@ const pushHandler = (config) => function () {
             error('Nothing to import.');
             return;
         }
+        let errorOnUnresolvedConflict;
+        switch (opts.errorOnUnresolvedConflict) {
+            case 'auto':
+                errorOnUnresolvedConflict = undefined;
+                break;
+            case 'yes':
+                errorOnUnresolvedConflict = true;
+                break;
+            case 'no':
+                errorOnUnresolvedConflict = false;
+                break;
+        }
         const params = {
             createNewKeys: true,
             forceMode: opts.forceMode,
             overrideKeyDescriptions: opts.overrideKeyDescriptions,
             convertPlaceholdersToIcu: opts.convertPlaceholdersToIcu,
             tagNewKeys: (_d = opts.tagNewKeys) !== null && _d !== void 0 ? _d : [],
+            overrideMode: (_e = opts.overrideMode) !== null && _e !== void 0 ? _e : 'RECOMMENDED',
             fileMappings: files.map((f) => {
                 var _a;
                 const format = mapImportFormat(opts.format, extname(f.name));
@@ -153,30 +167,34 @@ const pushHandler = (config) => function () {
                 };
             }),
             removeOtherKeys: opts.removeOtherKeys,
+            errorOnUnresolvedConflict: errorOnUnresolvedConflict,
         };
-        const attempt1 = yield loading('Importing...', importData(opts.client, {
+        let attempt = yield loading('Importing...', importData(opts.client, {
             files,
             params,
         }));
-        if (attempt1.error) {
-            if (attempt1.error.code === 'existing_language_not_selected') {
+        if (attempt.error) {
+            if (attempt.error.code === 'existing_language_not_selected') {
                 handleMappingError(params.fileMappings);
             }
-            if (attempt1.error.code !== 'conflict_is_not_resolved') {
-                handleLoadableError(attempt1);
+            if (attempt.error.code !== 'conflict_is_not_resolved') {
+                handleLoadableError(attempt);
             }
             const forceMode = yield promptConflicts(opts);
-            const attempt2 = yield loading('Overriding...', importData(opts.client, {
+            attempt = yield loading('Overriding...', importData(opts.client, {
                 files,
                 params: Object.assign(Object.assign({}, params), { forceMode }),
             }));
-            handleLoadableError(attempt2);
+            handleLoadableError(attempt);
+        }
+        if ((_g = (_f = attempt.data) === null || _f === void 0 ? void 0 : _f.unresolvedConflicts) === null || _g === void 0 ? void 0 : _g.length) {
+            printUnresolvedConflicts(attempt.data.unresolvedConflicts, false);
         }
         success('Done!');
     });
 };
 export default (config) => {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o;
     return new Command()
         .name('push')
         .description('Pushes translations to Tolgee')
@@ -191,5 +209,11 @@ export default (config) => {
         .addOption(new Option('-n, --namespaces <namespaces...>', 'Specifies which namespaces should be pushed (see push.files in config).').default((_h = config.push) === null || _h === void 0 ? void 0 : _h.namespaces))
         .addOption(new Option('--tag-new-keys <tags...>', 'Specify tags that will be added to newly created keys.').default((_j = config.push) === null || _j === void 0 ? void 0 : _j.tagNewKeys))
         .addOption(new Option('--remove-other-keys', 'Remove keys which are not present in the import (within imported namespaces).').default((_k = config.push) === null || _k === void 0 ? void 0 : _k.removeOtherKeys))
+        .addOption(new Option('--override-mode <mode>', 'Specifies what is considered non-overridable translation.')
+        .choices(['RECOMMENDED', 'ALL'])
+        .default((_l = config.push) === null || _l === void 0 ? void 0 : _l.overrideMode))
+        .addOption(new Option('--error-on-unresolved-conflict <choice>', 'Fail the whole import if there are unresolved conflicts.')
+        .choices(['yes', 'no', 'auto'])
+        .default((_o = (_m = config.push) === null || _m === void 0 ? void 0 : _m.errorOnUnresolvedConflict) !== null && _o !== void 0 ? _o : 'auto'))
         .action(pushHandler(config));
 };

package/dist/commands/sync/sync.js

@@ -24,6 +24,7 @@ function backup(client, dest) {
             supportArrays: false,
             filterState: ['UNTRANSLATED', 'TRANSLATED', 'REVIEWED'],
             structureDelimiter: '',
+            escapeHtml: false,
         });
         handleLoadableError(loadable);
         const blob = loadable.data;
@@ -46,7 +47,7 @@ function askForConfirmation(keys, operation) {
 }
 const syncHandler = (config) => function () {
     return __awaiter(this, void 0, void 0, function* () {
-        var _a, _b, _c;
+        var _a, _b, _c, _d, _e, _f;
         const opts = this.optsWithGlobals();
         const rawKeys = yield loading('Analyzing code...', extractKeysOfFiles(opts));
         const warnCount = dumpWarnings(rawKeys);
@@ -55,11 +56,24 @@ const syncHandler = (config) => function () {
             process.exit(1);
         }
         const localKeys = filterExtractionResult(rawKeys);
+        if ((_a = opts.namespaces) === null || _a === void 0 ? void 0 : _a.length) {
+            for (const namespace of Object.keys(localKeys)) {
+                if (!((_b = opts.namespaces) === null || _b === void 0 ? void 0 : _b.includes(namespace))) {
+                    localKeys[namespace].clear();
+                }
+            }
+        }
         const allKeysLoadable = yield opts.client.GET('/v2/projects/{projectId}/all-keys', {
             params: { path: { projectId: opts.client.getProjectId() } },
         });
         handleLoadableError(allKeysLoadable);
-        const remoteKeys = (_c = (_b = (_a = allKeysLoadable.data) === null || _a === void 0 ? void 0 : _a._embedded) === null || _b === void 0 ? void 0 : _b.keys) !== null && _c !== void 0 ? _c : [];
+        let remoteKeys = (_e = (_d = (_c = allKeysLoadable.data) === null || _c === void 0 ? void 0 : _c._embedded) === null || _d === void 0 ? void 0 : _d.keys) !== null && _e !== void 0 ? _e : [];
+        if ((_f = opts.namespaces) === null || _f === void 0 ? void 0 : _f.length) {
+            remoteKeys = remoteKeys.filter((key) => {
+                var _a, _b;
+                return (_a = opts.namespaces) === null || _a === void 0 ? void 0 : _a.includes((_b = key.namespace) !== null && _b !== void 0 ? _b : '');
+            });
+        }
         const diff = compareKeys(localKeys, remoteKeys);
         if (!diff.added.length && !diff.removed.length) {
             console.log(ansi.green('Your code project is in sync with the associated Tolgee project!'));
@@ -127,14 +141,15 @@ const syncHandler = (config) => function () {
     });
 };
 export default (config) => {
-    var _a, _b, _c, _d, _e, _f;
+    var _a, _b, _c, _d, _e, _f, _g;
     return new Command()
         .name('sync')
         .description('Synchronizes the keys in your code project and in the Tolgee project, by creating missing keys and optionally deleting unused ones. For a dry-run, use `tolgee compare`.')
         .addOption(new Option('-B, --backup <path>', 'Store translation files backup (only translation files, not states, comments, tags, etc.). If something goes wrong, the backup can be used to restore the project to its previous state.').default((_b = (_a = config.sync) === null || _a === void 0 ? void 0 : _a.backup) !== null && _b !== void 0 ? _b : false))
         .addOption(new Option('--continue-on-warning', 'Set this flag to continue the sync if warnings are detected during string extraction. By default, as warnings may indicate an invalid extraction, the CLI will abort the sync.').default((_d = (_c = config.sync) === null || _c === void 0 ? void 0 : _c.continueOnWarning) !== null && _d !== void 0 ? _d : false))
+        .addOption(new Option('-n, --namespaces <namespaces...>', 'Specifies which namespaces should be synchronized.').default((_e = config.sync) === null || _e === void 0 ? void 0 : _e.namespaces))
         .addOption(new Option('-Y, --yes', 'Skip prompts and automatically say yes to them. You will not be asked for confirmation before creating/deleting keys.').default(false))
-        .addOption(new Option('--remove-unused', 'Delete unused keys from the Tolgee project.').default((_f = (_e = config.sync) === null || _e === void 0 ? void 0 : _e.removeUnused) !== null && _f !== void 0 ? _f : false))
+        .addOption(new Option('--remove-unused', 'Delete unused keys from the Tolgee project (within selected namespaces if specified).').default((_g = (_f = config.sync) === null || _f === void 0 ? void 0 : _f.removeUnused) !== null && _g !== void 0 ? _g : false))
         .option('--tag-new-keys <tags...>', 'Specify tags that will be added to newly created keys.')
         .action(syncHandler(config));
 };

package/dist/commands/sync/syncUtils.js

@@ -1,4 +1,3 @@
-import { NullNamespace } from '../../extractor/runner.js';
 import ansi from 'ansi-colors';
 /**
  * Prints information about a key, with coloring and formatting.
@@ -6,15 +5,20 @@ import ansi from 'ansi-colors';
  * @param key The key to print.
  * @param deletion True if the key is about to be deleted.
  */
-export function printKey(key, deletion) {
+export function printKey(key, deletion, color, note) {
+    const colorFunc = color !== null && color !== void 0 ? color : (deletion ? ansi.red : ansi.green);
     const namespace = key.namespace
         ? ` ${ansi.italic(`(namespace: ${key.namespace})`)}`
         : '';
-    if (deletion) {
-        console.log(`${ansi.red(`- ${key.keyName}`)}${namespace}`);
+    const renderedNote = note ? ` ${note}` : '';
+    if (deletion === undefined) {
+        console.log(`${colorFunc(`${key.keyName}`)}${namespace}${renderedNote}`);
+    }
+    else if (deletion) {
+        console.log(`${colorFunc(`- ${key.keyName}`)}${namespace}${renderedNote}`);
     }
     else {
-        console.log(`${ansi.green(`+ ${key.keyName}`)}${namespace}`);
+        console.log(`${colorFunc(`+ ${key.keyName}`)}${namespace}${renderedNote}`);
     }
 }
 /**
@@ -30,18 +34,18 @@ export function compareKeys(local, remote) {
     const result = { added: [], removed: [] };
     // Deleted keys
     for (const remoteKey of remote) {
-        const namespace = remoteKey.namespace || NullNamespace;
+        const namespace = remoteKey.namespace || '';
         const keyExists = (_a = local[namespace]) === null || _a === void 0 ? void 0 : _a.delete(remoteKey.name);
         if (!keyExists) {
             result.removed.push({
                 id: remoteKey.id,
                 keyName: remoteKey.name,
-                namespace: remoteKey.namespace || undefined,
+                namespace: remoteKey.namespace || '',
             });
         }
     }
     // Added keys
-    const namespaces = [NullNamespace, ...Object.keys(local).sort()];
+    const namespaces = [...Object.keys(local).sort()];
     for (const namespace of namespaces) {
         if (namespace in local && local[namespace].size) {
             const keys = local[namespace];
@@ -49,7 +53,7 @@ export function compareKeys(local, remote) {
             for (const keyName of keyNames) {
                 result.added.push({
                     keyName: keyName,
-                    namespace: namespace === NullNamespace ? undefined : namespace,
+                    namespace: namespace || '',
                     defaultValue: keys.get(keyName) || undefined,
                 });
             }

package/dist/extractor/runner.js

@@ -11,7 +11,6 @@ import { glob } from 'tinyglobby';
 import { extname } from 'path';
 import { callWorker } from './worker.js';
 import { exitWithError } from '../utils/logger.js';
-export const NullNamespace = Symbol('namespace.null');
 function parseVerbose(v) {
     return Array.isArray(v) ? v : v ? [] : undefined;
 }
@@ -101,7 +100,7 @@ export function filterExtractionResult(data) {
     const result = Object.create(null);
     for (const { keys } of data.values()) {
         for (const key of keys) {
-            const namespace = key.namespace || NullNamespace;
+            const namespace = key.namespace || '';
             if (!(namespace in result)) {
                 result[namespace] = new Map();
             }

package/dist/utils/getStackTrace.js

@@ -1,7 +1,9 @@
 export const getStackTrace = () => {
-    const obj = {};
-    Error.captureStackTrace(obj, getStackTrace);
-    const stack = obj.stack;
-    const parts = stack.split('\n');
-    return parts.slice(2).join('\n');
+    var _a, _b;
+    if (typeof Error.captureStackTrace === 'function') {
+        const obj = {};
+        Error.captureStackTrace(obj, getStackTrace);
+        return (_a = obj.stack) !== null && _a !== void 0 ? _a : '';
+    }
+    return (_b = new Error().stack) !== null && _b !== void 0 ? _b : '';
 };

package/dist/utils/printFailedKeys.js

@@ -0,0 +1,26 @@
+import ansi from 'ansi-colors';
+export function renderKey(key, note) {
+    const colorFunc = ansi.yellow;
+    const namespace = key.namespace
+        ? ` ${ansi.italic(`(namespace: ${key.namespace})`)}`
+        : '';
+    const renderedNote = note ? ` ${note}` : '';
+    return `${colorFunc(`${key.keyName}`)}${namespace}${renderedNote}`;
+}
+export function getUnresolvedConflictsMessage(translations, isError) {
+    const someOverridable = Boolean(translations.find((c) => c.isOverridable));
+    const result = [''];
+    result.push(`🟡 Some translations cannot be updated:`);
+    translations.forEach((c) => {
+        result.push(renderKey({ keyName: c.keyName, namespace: c.keyNamespace }, `${c.language}` + (c.isOverridable ? ' (overridable)' : '')));
+    });
+    result.push('');
+    if (someOverridable) {
+        result.push('HINT: Overridable translations can be updated with the `--override-mode ALL`');
+        result.push('');
+    }
+    return result.join('\n');
+}
+export function printUnresolvedConflicts(translations, isError) {
+    console.log(getUnresolvedConflictsMessage(translations, isError));
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tolgee/cli",
-  "version": "2.12.1",
+  "version": "2.14.0",
   "type": "module",
   "description": "A tool to interact with the Tolgee Platform through CLI",
   "repository": {

package/schema.json

@@ -90,6 +90,12 @@
         "removeOtherKeys": {
           "description": "Remove keys which are not present in the import (within imported namespaces).",
           "type": "boolean"
+        },
+        "errorOnUnresolvedConflict": {
+          "$ref": "#/$defs/errorOnUnresolvedConflict"
+        },
+        "overrideMode": {
+          "$ref": "#/$defs/overrideMode"
         }
       }
     },
@@ -165,8 +171,15 @@
           "type": "boolean"
         },
         "removeUnused": {
-          "description": "Delete unused keys from the Tolgee project",
+          "description": "Delete unused keys from the Tolgee project (within selected namespaces if specified).",
           "type": "boolean"
+        },
+        "namespaces": {
+          "description": "Specifies which namespaces should be synchronized.",
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
         }
       }
     },
@@ -244,6 +257,16 @@
       "type": "string",
       "enum": ["OVERRIDE", "KEEP", "NO_FORCE"]
     },
+    "overrideMode": {
+      "description": "Specifies what is considered non-overridable translation: \n - RECOMMENDED - protected reviewed translations are considered as non-overridable\n - ALL - translations that user has permissions for",
+      "type": "string",
+      "enum": ["ALL", "RECOMMENDED"]
+    },
+    "errorOnUnresolvedConflict": {
+      "description": "Fail the whole import if there are unresolved conflicts in import: \n - yes - fail if any unresolved conflict is present\n no - don't fail and just print unresolved conflicts\n auto - fails when when forceMode=KEEP, otherwise doesn't fail",
+      "type": "string",
+      "enum": ["yes", "no", "auto"]
+    },
     "path": {
       "description": "File glob specifying which files to include.",
       "type": "string"