@tolgee/cli 1.3.2 → 2.0.0

package/dist/utils/getStackTrace.js

@@ -0,0 +1,7 @@
+export const getStackTrace = () => {
+    const obj = {};
+    Error.captureStackTrace(obj, getStackTrace);
+    const stack = obj.stack;
+    const parts = stack.split('\n');
+    return parts.slice(2).join('\n');
+};

package/dist/utils/logger.js

@@ -1,3 +1,4 @@
+import { getStackTrace } from './getStackTrace.js';
 const SYMBOLS = ['      🐁', '    🐁  ', '  🐁    ', '🐁      '];
 let debugEnabled = false;
 /**
@@ -58,6 +59,13 @@ export function warn(msg) {
 export function error(msg) {
     console.log(`🔴 ${msg}`);
 }
+export function exitWithError(msg) {
+    error(msg);
+    if (debugEnabled) {
+        console.log(getStackTrace());
+    }
+    process.exit(1);
+}
 /**
  * Shows a loading indicator for a Promise until it resolves.
  *

package/dist/utils/mapExportFormat.js

@@ -0,0 +1,62 @@
+export const mapExportFormat = (format) => {
+    switch (format) {
+        case 'ANDROID_XML':
+            return { format: 'ANDROID_XML', messageFormat: 'JAVA_STRING_FORMAT' };
+        case 'APPLE_STRINGS':
+            return {
+                format: 'APPLE_STRINGS_STRINGSDICT',
+                messageFormat: 'APPLE_SPRINTF',
+            };
+        case 'APPLE_XLIFF':
+            return { format: 'APPLE_XLIFF', messageFormat: 'APPLE_SPRINTF' };
+        case 'FLUTTER_ARB':
+            return { format: 'FLUTTER_ARB', messageFormat: 'ICU' };
+        case 'JSON_C':
+            return { format: 'JSON', messageFormat: 'C_SPRINTF' };
+        case 'JSON_ICU':
+            return { format: 'JSON', messageFormat: 'ICU' };
+        case 'JSON_JAVA':
+            return { format: 'JSON', messageFormat: 'JAVA_STRING_FORMAT' };
+        case 'JSON_PHP':
+            return { format: 'JSON', messageFormat: 'PHP_SPRINTF' };
+        case 'JSON_RUBY':
+            return { format: 'JSON', messageFormat: 'RUBY_SPRINTF' };
+        case 'JSON_TOLGEE':
+            return { format: 'JSON_TOLGEE', messageFormat: 'ICU' };
+        case 'PO_C':
+            return { format: 'PO', messageFormat: 'C_SPRINTF' };
+        case 'PO_ICU':
+            return { format: 'PO', messageFormat: 'ICU' };
+        case 'PO_JAVA':
+            return { format: 'PO', messageFormat: 'JAVA_STRING_FORMAT' };
+        case 'PO_PHP':
+            return { format: 'PO', messageFormat: 'PHP_SPRINTF' };
+        case 'PO_RUBY':
+            return { format: 'PO', messageFormat: 'RUBY_SPRINTF' };
+        case 'PROPERTIES_ICU':
+            return {
+                format: 'PROPERTIES',
+                messageFormat: 'ICU',
+            };
+        case 'PROPERTIES_JAVA':
+            return { format: 'PROPERTIES', messageFormat: 'JAVA_STRING_FORMAT' };
+        case 'XLIFF_ICU':
+            return { format: 'XLIFF', messageFormat: 'ICU' };
+        case 'XLIFF_JAVA':
+            return { format: 'XLIFF', messageFormat: 'JAVA_STRING_FORMAT' };
+        case 'XLIFF_PHP':
+            return { format: 'XLIFF', messageFormat: 'PHP_SPRINTF' };
+        case 'XLIFF_RUBY':
+            return { format: 'XLIFF', messageFormat: 'RUBY_SPRINTF' };
+        case 'YAML_ICU':
+            return { format: 'YAML', messageFormat: 'ICU' };
+        case 'YAML_JAVA':
+            return { format: 'YAML', messageFormat: 'JAVA_STRING_FORMAT' };
+        case 'YAML_PHP':
+            return { format: 'YAML', messageFormat: 'PHP_SPRINTF' };
+        case 'YAML_RUBY':
+            return { format: 'YAML_RUBY', messageFormat: 'RUBY_SPRINTF' };
+        case undefined:
+            return { format: 'JSON_TOLGEE', messageFormat: 'ICU' };
+    }
+};

package/dist/utils/mapImportFormat.js

@@ -0,0 +1,18 @@
+export const mapImportFormat = (format, extension) => {
+    switch (format) {
+        case 'APPLE_STRINGS': {
+            // apple separates translations to two separate files
+            // we keep it under one format for the cli
+            if (extension === '.stringsdict') {
+                return 'STRINGSDICT';
+            }
+            else {
+                return 'STRINGS';
+            }
+        }
+        case 'JSON_TOLGEE':
+            return 'JSON_ICU';
+        default:
+            return format ?? 'JSON_ICU';
+    }
+};

package/dist/utils/prepareDir.js

@@ -0,0 +1,12 @@
+import { mkdir, rm } from 'fs/promises';
+import { existsSync } from 'fs';
+export async function prepareDir(path, emptyDir) {
+    const exists = existsSync(path);
+    if (emptyDir && exists) {
+        await rm(path, { recursive: true });
+    }
+    if (!exists || emptyDir) {
+        // Create the directory
+        await mkdir(path, { recursive: true });
+    }
+}

package/dist/utils/zip.js

@@ -1,4 +1,4 @@
-import { createWriteStream } from 'fs';
+import { createWriteStream, existsSync } from 'fs';
 import { mkdir } from 'fs/promises';
 import { join, dirname } from 'path';
 import { fromBuffer } from 'yauzl';
@@ -53,11 +53,6 @@ export function unzip(zip, dest) {
     return new Promise((resolve, reject) => {
         zip.on('error', reject);
         zip.on('end', resolve);
-        // There is no mechanism for zip files to contain directories
-        // by standards, and implementations diverge. Some make an explicit
-        // directory entry (ending with /), some don't make any specific treatment.
-        // The "safest" way is to check the path on files and create them as necessary.
-        const seenDirectories = new Set([dest]);
         zip.readEntry();
         zip.on('entry', (entry) => {
             if (entry.fileName.endsWith('/')) {
@@ -67,7 +62,7 @@ export function unzip(zip, dest) {
             const entryPath = join(dest, entry.fileName);
             // Handle directory creation
             const entryDirName = dirname(entryPath);
-            if (!seenDirectories.has(entryDirName)) {
+            if (!existsSync(entryDirName)) {
                 mkdir(entryDirName, { recursive: true }).then(() => dumpFile(zip, entry, entryPath));
             }
             else {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tolgee/cli",
-  "version": "1.3.2",
+  "version": "2.0.0",
   "type": "module",
   "description": "A tool to interact with the Tolgee Platform through CLI",
   "repository": {
@@ -8,14 +8,12 @@
     "url": "https://github.com/tolgee/tolgee-cli.git"
   },
   "bin": {
-    "tolgee": "./dist/index.js"
+    "tolgee": "./dist/cli.js"
   },
   "scripts": {
-    "build": "rimraf dist dist-types && tsc && cp dist-types/extractor/index.d.ts extractor.d.ts",
+    "build": "rimraf dist dist-types && tsc && node scripts/copyExtractorTypes.mjs",
     "test": "npm run test:unit && npm run test:e2e && npm run test:package",
     "test:unit": "cross-env NODE_OPTIONS=\"--experimental-vm-modules\" jest -c jest.unit.config.ts",
-    "pretest:e2e": "npm run build && npm run tolgee:start",
-    "posttest:e2e": "npm run tolgee:stop",
     "test:e2e": "cross-env NODE_OPTIONS=\"--experimental-vm-modules\" jest -c jest.e2e.config.ts --runInBand",
     "test:e2e-run": "cross-env NODE_OPTIONS=\"--experimental-vm-modules\" jest -c jest.e2e.config.ts --runInBand",
     "test:package": "node scripts/validatePackage.js",
@@ -23,20 +21,23 @@
     "tolgee:stop": "docker stop tolgee_cli_e2e",
     "lint": "eslint --ext .ts --ext .js --ext .cjs ./src ./test ./scripts jest.config.ts jest.*.config.ts",
     "prettier": "prettier --write ./src ./test ./scripts jest.config.ts jest.*.config.ts",
-    "run-dev": "cross-env NODE_OPTIONS=\"--loader=ts-node/esm\" node ./src/index.ts",
+    "run-dev": "cross-env NODE_OPTIONS=\"--import=./scripts/registerTsNode.js\" node ./src/cli.ts",
     "schema": "openapi-typescript http://localhost:22222/v3/api-docs/All%20Internal%20-%20for%20Tolgee%20Web%20application --output src/client/internal/schema.generated.ts",
-    "release": "semantic-release"
+    "release": "semantic-release",
+    "config:type": "node scripts/configType.mjs"
   },
   "author": "Jan Cizmar",
   "license": "MIT",
   "dependencies": {
     "ansi-colors": "^4.1.3",
     "base32-decode": "^1.0.0",
-    "commander": "^11.0.0",
+    "commander": "^12.0.0",
     "cosmiconfig": "^8.2.0",
     "form-data": "^4.0.0",
     "glob": "^10.3.3",
     "json5": "^2.2.3",
+    "jsonschema": "^1.4.1",
+    "openapi-fetch": "^0.9.7",
     "undici": "^5.22.1",
     "vscode-oniguruma": "^1.7.0",
     "vscode-textmate": "^9.0.0",
@@ -55,15 +56,17 @@
     "eslint": "^8.45.0",
     "eslint-plugin-jest": "^27.2.3",
     "eslint-plugin-prettier": "^5.0.0",
-    "jest": "^29.6.1",
+    "jest": "^29.7.0",
     "js-yaml": "^4.1.0",
-    "openapi-typescript": "^6.3.9",
+    "json-schema-to-typescript": "^13.1.2",
+    "openapi-typescript": "^6.7.6",
     "prettier": "^3.0.0",
     "rimraf": "^5.0.1",
     "semantic-release": "^21.0.7",
-    "ts-jest": "^29.1.1",
-    "ts-node": "^10.9.1",
-    "typescript": "^5.1.6"
+    "tree-cli": "^0.6.7",
+    "ts-jest": "^29.1.3",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.4.5"
   },
   "engines": {
     "node": ">= 18"
@@ -72,6 +75,7 @@
     "dist",
     "textmate",
     "extractor.d.ts",
+    "schema.json",
     "README.md",
     "LICENSE"
   ],

package/schema.json

@@ -0,0 +1,175 @@
+{
+  "type": "object",
+  "properties": {
+    "projectId": {
+      "description": "Project ID. Only required when using a Personal Access Token.",
+      "type": ["number", "string"]
+    },
+    "extractor": {
+      "description": "A path to a custom extractor to use instead of the default one.",
+      "type": "string"
+    },
+    "apiUrl": {
+      "description": "The url of Tolgee API.",
+      "type": "string"
+    },
+    "patterns": {
+      "description": "File glob patterns to your source code, used for keys extraction.",
+      "type": "array",
+      "items": {
+        "type": "string"
+      }
+    },
+    "format": {
+      "$ref": "#/$defs/format"
+    },
+    "push": {
+      "type": "object",
+      "properties": {
+        "files": {
+          "description": "Define, which files should be pushed and attach language/namespace to them. By default Tolgee pushes all files specified here, you can filter them by languages and namespaces properties.",
+          "type": "array",
+          "items": { "$ref": "#/$defs/fileMatch" }
+        },
+        "languages": {
+          "description": "Specifies which languages should be pushed from push.files.",
+          "type": "array",
+          "items": { "type": "string" }
+        },
+        "namespaces": {
+          "description": "Specifies which namespaces should be pushed from push.files.",
+          "type": "array",
+          "items": { "type": "string" }
+        },
+        "forceMode": {
+          "$ref": "#/$defs/forceMode"
+        },
+        "overrideKeyDescriptions": {
+          "description": "Override existing key descriptions from local files (only relevant for some formats).",
+          "type": "boolean"
+        },
+        "convertPlaceholdersToIcu": {
+          "description": "Convert placeholders in local files to ICU format. (Default: true)",
+          "type": "boolean"
+        },
+        "tagNewKeys": {
+          "description": "Specify tags that will be added to newly created keys.",
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "pull": {
+      "type": "object",
+      "properties": {
+        "path": {
+          "description": "Path to a folder where the localization files are stored. (Structure itself can be defined with `fileStructureTemplate`)",
+          "type": "string"
+        },
+        "languages": {
+          "description": "List of languages to pull. Leave unspecified to export them all.",
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "namespaces": {
+          "description": "List of namespaces to pull. Defaults to all namespaces.",
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "states": {
+          "description": "List of translation states to include. Defaults all except untranslated.",
+          "type": "array",
+          "items": {
+            "enum": ["UNTRANSLATED", "TRANSLATED", "REVIEWED"]
+          }
+        },
+        "tags": {
+          "description": "List of tags which to include.",
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "excludeTags": {
+          "description": "List of tags which to exclude.",
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "supportArrays": {
+          "description": "Export keys with array syntax (e.g. item[0]) as arrays.",
+          "type": "boolean"
+        },
+        "fileStructureTemplate": {
+          "description": "Defines exported file structure: https://tolgee.io/tolgee-cli/push-pull-strings#file-structure-template-format",
+          "type": "string"
+        },
+        "emptyDir": {
+          "description": "Empty [path] folder before inserting pulled files.",
+          "type": "boolean"
+        },
+        "delimiter": {
+          "description": "Structure delimiter to use. By default, Tolgee interprets `.` as a nested structure. You can change the delimiter, or disable structure formatting by not specifying any value to the option.",
+          "type": ["string", "null"]
+        }
+      }
+    }
+  },
+  "$defs": {
+    "fileMatch": {
+      "type": "object",
+      "properties": {
+        "path": { "$ref": "#/$defs/path" },
+        "language": { "type": "string" },
+        "namespace": { "type": "string" }
+      },
+      "required": ["path", "language"]
+    },
+    "forceMode": {
+      "description": "Specifies how to solve potential conflicts in the pushed data.\n\nOptions:\n\n  `OVERRIDE` - update everything according to local files\n  `KEEP` - create only non-existent strings, don't touch existing ones\n  `NO_FORCE` - throw an error, if there are any conflict",
+      "type": "string",
+      "enum": ["OVERRIDE", "KEEP", "NO_FORCE"]
+    },
+    "path": {
+      "description": "File glob specifying which files to include.",
+      "type": "string"
+    },
+    "format": {
+      "description": "Localization files format for push and pull operations.",
+      "enum": [
+        "JSON_TOLGEE",
+        "JSON_ICU",
+        "JSON_JAVA",
+        "JSON_PHP",
+        "JSON_RUBY",
+        "JSON_C",
+        "PO_PHP",
+        "PO_C",
+        "PO_JAVA",
+        "PO_ICU",
+        "PO_RUBY",
+        "APPLE_STRINGS",
+        "APPLE_XLIFF",
+        "PROPERTIES_ICU",
+        "PROPERTIES_JAVA",
+        "ANDROID_XML",
+        "FLUTTER_ARB",
+        "YAML_RUBY",
+        "YAML_JAVA",
+        "YAML_ICU",
+        "YAML_PHP",
+        "XLIFF_ICU",
+        "XLIFF_JAVA",
+        "XLIFF_PHP",
+        "XLIFF_RUBY"
+      ]
+    }
+  }
+}

package/dist/client/errors.js

@@ -1,37 +0,0 @@
-import { STATUS_CODES } from 'http';
-export class HttpError extends Error {
-    request;
-    response;
-    constructor(request, response, options) {
-        super(`HTTP Error ${response.statusCode} ${STATUS_CODES[response.statusCode]}`, options);
-        this.request = request;
-        this.response = response;
-    }
-    getErrorText() {
-        // Unauthorized
-        if (this.response.statusCode === 400) {
-            return 'Invalid request data.';
-        }
-        // Unauthorized
-        if (this.response.statusCode === 401) {
-            return 'Missing or invalid authentication token.';
-        }
-        // Forbidden
-        if (this.response.statusCode === 403) {
-            return 'You are not allowed to perform this operation.';
-        }
-        // Rate limited
-        if (this.response.statusCode === 429) {
-            return "You've been rate limited. Please try again later.";
-        }
-        // Service Unavailable
-        if (this.response.statusCode === 503) {
-            return 'API is temporarily unavailable. Please try again later.';
-        }
-        // Server error
-        if (this.response.statusCode >= 500) {
-            return `API reported a server error (${this.response.statusCode}). Please try again later.`;
-        }
-        return `Unknown error (HTTP ${this.response.statusCode})`;
-    }
-}

package/dist/client/export.js

@@ -1,20 +0,0 @@
-export default class ExportClient {
-    requester;
-    constructor(requester) {
-        this.requester = requester;
-    }
-    async export(req) {
-        return this.requester.requestBlob({
-            method: 'POST',
-            path: `${this.requester.projectUrl}/export`,
-            body: { ...req, zip: true },
-        });
-    }
-    async exportSingle(req) {
-        return this.requester.requestJson({
-            method: 'POST',
-            path: `${this.requester.projectUrl}/export`,
-            body: { ...req, zip: false },
-        });
-    }
-}

package/dist/client/import.js

@@ -1,55 +0,0 @@
-import FormData from 'form-data';
-import { HttpError } from './errors.js';
-export default class ImportClient {
-    requester;
-    constructor(requester) {
-        this.requester = requester;
-    }
-    async addFiles(req) {
-        const body = new FormData();
-        for (const file of req.files) {
-            body.append('files', file.data, { filepath: file.name });
-        }
-        return this.requester.requestJson({
-            method: 'POST',
-            path: `${this.requester.projectUrl}/import`,
-            body: body,
-        });
-    }
-    async conflictsOverrideAll(languageId) {
-        await this.requester.requestVoid({
-            method: 'PUT',
-            path: `${this.requester.projectUrl}/import/result/languages/${languageId}/resolve-all/set-override`,
-        });
-    }
-    async conflictsKeepExistingAll(languageId) {
-        await this.requester.requestVoid({
-            method: 'PUT',
-            path: `${this.requester.projectUrl}/import/result/languages/${languageId}/resolve-all/set-keep-existing`,
-        });
-    }
-    async applyImport(req) {
-        await this.requester.requestVoid({
-            method: 'PUT',
-            path: `${this.requester.projectUrl}/import/apply`,
-            query: { forceMode: req?.forceMode },
-        });
-    }
-    async deleteImport() {
-        await this.requester.requestVoid({
-            method: 'DELETE',
-            path: `${this.requester.projectUrl}/import`,
-        });
-    }
-    /* Helper functions */
-    async deleteImportIfExists() {
-        try {
-            await this.deleteImport();
-        }
-        catch (e) {
-            if (e instanceof HttpError && e.response.statusCode === 404)
-                return;
-            throw e;
-        }
-    }
-}

package/dist/client/index.js

@@ -1,73 +0,0 @@
-import base32Decode from 'base32-decode';
-import Requester from './internal/requester.js';
-import ProjectClient from './project.js';
-import LanguagesClient from './languages.js';
-import ImportClient from './import.js';
-import ExportClient from './export.js';
-import { API_KEY_PAK_PREFIX } from '../constants.js';
-export default class RestClient {
-    params;
-    requester;
-    project;
-    languages;
-    import;
-    export;
-    constructor(params) {
-        this.params = params;
-        this.requester = new Requester(params);
-        this.project = new ProjectClient(this.requester);
-        this.languages = new LanguagesClient(this.requester);
-        this.import = new ImportClient(this.requester);
-        this.export = new ExportClient(this.requester);
-    }
-    async getProjectApiKeyInformation() {
-        return this.requester.requestJson({
-            path: '/v2/api-keys/current',
-            method: 'GET',
-        });
-    }
-    getProjectId() {
-        return this.params.projectId;
-    }
-    static projectIdFromKey(key) {
-        const keyBuffer = base32Decode(key.slice(API_KEY_PAK_PREFIX.length).toUpperCase(), 'RFC4648');
-        const decoded = Buffer.from(keyBuffer).toString('utf8');
-        return Number(decoded.split('_')[0]);
-    }
-    static getProjectApiKeyInformation(api, key) {
-        return new Requester({ apiUrl: api, apiKey: key }).requestJson({
-            path: '/v2/api-keys/current',
-            method: 'GET',
-        });
-    }
-    static getPersonalAccessTokenInformation(api, key) {
-        return new Requester({ apiUrl: api, apiKey: key }).requestJson({
-            path: '/v2/pats/current',
-            method: 'GET',
-        });
-    }
-    static async getApiKeyInformation(api, key) {
-        if (key.startsWith(API_KEY_PAK_PREFIX)) {
-            const info = await RestClient.getProjectApiKeyInformation(api, key);
-            const username = info.userFullName || info.username || '<unknown user>';
-            return {
-                type: 'PAK',
-                key: key,
-                username: username,
-                project: {
-                    id: info.projectId,
-                    name: info.projectName,
-                },
-                expires: info.expiresAt ?? 0,
-            };
-        }
-        const info = await RestClient.getPersonalAccessTokenInformation(api, key);
-        const username = info.user.name || info.user.username;
-        return {
-            type: 'PAT',
-            key: key,
-            username: username,
-            expires: info.expiresAt ?? 0,
-        };
-    }
-}

package/dist/client/languages.js

@@ -1,13 +0,0 @@
-export default class LanguagesClient {
-    requester;
-    constructor(requester) {
-        this.requester = requester;
-    }
-    async getLanguages(req) {
-        return this.requester.requestPaginatedResource({
-            method: 'GET',
-            path: `${this.requester.projectUrl}/languages`,
-            query: req,
-        });
-    }
-}

package/dist/client/project.js

@@ -1,41 +0,0 @@
-export default class ProjectClient {
-    requester;
-    constructor(requester) {
-        this.requester = requester;
-    }
-    async fetchProjectInformation() {
-        return this.requester.requestJson({
-            method: 'GET',
-            path: this.requester.projectUrl,
-        });
-    }
-    async fetchAllKeys() {
-        return this.requester
-            .requestJson({
-            method: 'GET',
-            path: `${this.requester.projectUrl}/all-keys`,
-        })
-            .then((r) => r._embedded?.keys || []);
-    }
-    async createKey(key) {
-        return this.requester.requestJson({
-            method: 'POST',
-            path: `${this.requester.projectUrl}/keys`,
-            body: key,
-        });
-    }
-    async createBulkKey(keys) {
-        return this.requester.requestVoid({
-            method: 'POST',
-            path: `${this.requester.projectUrl}/keys/import`,
-            body: { keys },
-        });
-    }
-    async deleteBulkKeys(keyIds) {
-        return this.requester.requestVoid({
-            method: 'DELETE',
-            path: `${this.requester.projectUrl}/keys`,
-            body: { ids: keyIds },
-        });
-    }
-}