@crowdin/app-project-module 0.19.0 → 0.20.0

package/README.md

@@ -30,6 +30,7 @@ In both options you will need to provide Crowdin App configuration file. Please
 - [Storage](#storage)
   - [SQLite](#sqlite)
   - [PostgreSQL](#postgresql)
+  - [MySQL](#mysql)
 - [Settings window](#settings-window)
 - [Info window](#info-window)
 - [Background tasks](#background-tasks)
@@ -341,6 +342,17 @@ configuration.postgreConfig = {
 };
 ```
 
+### MySQL
+
+```javascript
+configuration.mysqlConfig = {
+    host: 'localhost',
+    user: 'root',
+    password: 'password',
+    database: 'test'
+};
+```
+
 ## Settings window
 
 It is also possible to define settings window for your app where users can customize integration flow.

package/out/index.js

@@ -161,7 +161,7 @@ function addCrowdinEndpoints(app, config) {
         app.use('/reports', (0, ui_module_1.default)(config), express_1.default.static(config.projectReports.uiPath));
     }
     return {
-        getMetadata: storage.getStorage().getMetadata,
+        getMetadata: storage.getStorage().getMetadata.bind(storage.getStorage()),
         saveMetadata: (id, metadata) => __awaiter(this, void 0, void 0, function* () {
             const existing = yield storage.getStorage().getMetadata(id);
             if (existing) {
@@ -171,7 +171,7 @@ function addCrowdinEndpoints(app, config) {
                 yield storage.getStorage().saveMetadata(id, metadata);
             }
         }),
-        deleteMetadata: storage.getStorage().deleteMetadata,
+        deleteMetadata: storage.getStorage().deleteMetadata.bind(storage.getStorage()),
         getUserSettings: (clientId) => __awaiter(this, void 0, void 0, function* () {
             const integrationCredentials = yield storage.getStorage().getIntegrationCredentials(clientId);
             if (integrationCredentials === null || integrationCredentials === void 0 ? void 0 : integrationCredentials.config) {

package/out/models/index.d.ts

@@ -1,6 +1,7 @@
 import Crowdin, { LanguagesModel, SourceFilesModel, SourceStringsModel } from '@crowdin/crowdin-api-client';
 import { JwtPayload } from '@crowdin/crowdin-apps-functions';
 import { Request } from 'express';
+import { MySQLStorageConfig } from '../storage/mysql';
 import { PostgreStorageConfig } from '../storage/postgre';
 export interface Config extends ImagePath {
     /**
@@ -48,9 +49,13 @@ export interface Config extends ImagePath {
      */
     dbFolder?: string;
     /**
-     * config to configure PostgreSQL  as a storage
+     * config to configure PostgreSQL as a storage
      */
     postgreConfig?: PostgreStorageConfig;
+    /**
+     * config to configure MySQL as a storage
+     */
+    mysqlConfig?: MySQLStorageConfig;
     /**
      * integration module logic
      */
@@ -539,7 +544,7 @@ export interface CrowdinAppUtilities {
     }>;
 }
 export interface IntegrationSyncSettings {
-    id: string;
+    id: number;
     files?: any;
     integrationId: string;
     crowdinId: string;

package/out/storage/index.js

@@ -11,6 +11,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getStorage = exports.initialize = void 0;
 const util_1 = require("../util");
+const mysql_1 = require("./mysql");
 const postgre_1 = require("./postgre");
 const sqlite_1 = require("./sqlite");
 let storage;
@@ -30,6 +31,13 @@ function initialize(config) {
             yield postgre.connect(config.postgreConfig);
             return;
         }
+        if (config.mysqlConfig) {
+            (0, util_1.log)('Using MySQL database', config.logger);
+            const mysql = new mysql_1.MySQLStorage();
+            storage = mysql;
+            yield mysql.connect(config.mysqlConfig);
+            return;
+        }
         throw new Error('Database is not configured');
     });
 }

package/out/storage/mysql.d.ts

@@ -0,0 +1,38 @@
+import { Storage } from '.';
+import { CrowdinCredentials, IntegrationCredentials, IntegrationSyncSettings } from '../models';
+export interface MySQLStorageConfig {
+    uri?: string;
+    host?: string;
+    user?: string;
+    password?: string;
+    database?: string;
+    port?: number;
+}
+export declare class MySQLStorage implements Storage<MySQLStorageConfig> {
+    private connection;
+    private _res?;
+    private _rej?;
+    private dbPromise;
+    connect(config: MySQLStorageConfig): Promise<void>;
+    migrate(): Promise<void>;
+    saveCrowdinCredentials(credentials: CrowdinCredentials): Promise<void>;
+    updateCrowdinCredentials(credentials: CrowdinCredentials): Promise<void>;
+    getCrowdinCredentials(id: string): Promise<CrowdinCredentials | undefined>;
+    getAllCrowdinCredentials(): Promise<CrowdinCredentials[]>;
+    deleteCrowdinCredentials(id: string): Promise<void>;
+    saveIntegrationCredentials(id: string, credentials: any, crowdinId: string): Promise<void>;
+    updateIntegrationCredentials(id: string, credentials: any): Promise<void>;
+    updateIntegrationConfig(id: string, config: any): Promise<void>;
+    getIntegrationCredentials(id: string): Promise<IntegrationCredentials | undefined>;
+    getAllIntegrationCredentials(crowdinId: string): Promise<IntegrationCredentials[]>;
+    deleteIntegrationCredentials(id: string): Promise<void>;
+    saveMetadata(id: string, metadata: any): Promise<void>;
+    updateMetadata(id: string, metadata: any): Promise<void>;
+    getMetadata(id: string): Promise<any>;
+    deleteMetadata(id: string): Promise<void>;
+    getSyncSettingsByProvider(integrationId: string, provider: string): Promise<IntegrationSyncSettings | undefined>;
+    getAllSyncSettingsByType(type: string): Promise<IntegrationSyncSettings[]>;
+    saveSyncSettings(files: any, integrationId: string, crowdinId: string, type: string, provider: string): Promise<void>;
+    updateSyncSettings(files: any, integrationId: string, crowdinId: string, type: string, provider: string): Promise<void>;
+    getSyncSettings(integrationId: string, crowdinId: string, type: string, provider: string): Promise<IntegrationSyncSettings | undefined>;
+}

package/out/storage/mysql.js

@@ -0,0 +1,262 @@
+"use strict";
+/* eslint-disable no-unused-expressions */
+/* eslint-disable @typescript-eslint/no-var-requires */
+/* eslint-disable @typescript-eslint/ban-ts-ignore */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MySQLStorage = void 0;
+class MySQLStorage {
+    constructor() {
+        this.dbPromise = new Promise((res, rej) => {
+            this._res = res;
+            this._rej = rej;
+        });
+    }
+    connect(config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const mysql = require('mysql2/promise');
+                this.connection = yield mysql.createConnection(config);
+                yield this.migrate();
+                this._res && this._res();
+            }
+            catch (e) {
+                console.error(e);
+                this._rej && this._rej();
+            }
+        });
+    }
+    migrate() {
+        var _a, _b, _c, _d;
+        return __awaiter(this, void 0, void 0, function* () {
+            yield ((_a = this.connection) === null || _a === void 0 ? void 0 : _a.execute(`
+            create table if not exists crowdin_credentials
+            (
+                id              varchar(255) primary key,
+                app_secret      text,
+                domain          varchar(255),
+                user_id         varchar(255),
+                organization_id varchar(255),
+                base_url        varchar(255),
+                access_token    text not null,
+                refresh_token   text not null,
+                expire          varchar(255) not null,
+                type            varchar(255) not null
+            )
+            `));
+            yield ((_b = this.connection) === null || _b === void 0 ? void 0 : _b.execute(`
+            create table if not exists integration_credentials
+            (
+                id              varchar(255) primary key,
+                credentials     text,
+                config          text,
+                crowdin_id      varchar(255) not null
+            )
+            `));
+            yield ((_c = this.connection) === null || _c === void 0 ? void 0 : _c.execute(`
+            create table if not exists sync_settings
+            (
+                id             int auto_increment primary key,
+                files          text,
+                integration_id varchar(255) not null,
+                crowdin_id     varchar(255) not null,
+                type           varchar(255) not null,
+                provider       varchar(255) not null
+            )
+            `));
+            yield ((_d = this.connection) === null || _d === void 0 ? void 0 : _d.execute(`
+            create table if not exists app_metadata
+            (
+                id             varchar(255) primary key,
+                data           text
+            )
+            `));
+        });
+    }
+    saveCrowdinCredentials(credentials) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.dbPromise;
+            yield ((_a = this.connection) === null || _a === void 0 ? void 0 : _a.execute('INSERT INTO crowdin_credentials(id, app_secret, domain, user_id, organization_id, base_url, access_token, refresh_token, expire, type) VALUES (?, ?, ?, ?, ?, ?, ?, ?, ?, ?)', [
+                credentials.id,
+                credentials.appSecret,
+                credentials.domain,
+                credentials.userId,
+                credentials.organizationId,
+                credentials.baseUrl,
+                credentials.accessToken,
+                credentials.refreshToken,
+                credentials.expire,
+                credentials.type,
+            ]));
+        });
+    }
+    updateCrowdinCredentials(credentials) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.dbPromise;
+            yield ((_a = this.connection) === null || _a === void 0 ? void 0 : _a.execute('UPDATE crowdin_credentials SET app_secret = ?, domain = ?, user_id = ?, organization_id = ?, base_url = ?, access_token = ?, refresh_token = ?, expire = ? WHERE id = ?', [
+                credentials.appSecret,
+                credentials.domain,
+                credentials.userId,
+                credentials.organizationId,
+                credentials.baseUrl,
+                credentials.accessToken,
+                credentials.refreshToken,
+                credentials.expire,
+                credentials.id,
+            ]));
+        });
+    }
+    getCrowdinCredentials(id) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.dbPromise;
+            const [rows,] = yield ((_a = this.connection) === null || _a === void 0 ? void 0 : _a.execute('SELECT id, app_secret as "appSecret", domain, user_id as "userId", organization_id as "organizationId", base_url as "baseUrl", access_token as "accessToken", refresh_token as "refreshToken", expire, type FROM crowdin_credentials WHERE id = ?', [id]));
+            return (rows || [])[0];
+        });
+    }
+    getAllCrowdinCredentials() {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.dbPromise;
+            const [rows] = yield ((_a = this.connection) === null || _a === void 0 ? void 0 : _a.execute('SELECT id, app_secret as "appSecret", domain, user_id as "userId", organization_id as "organizationId", base_url as "baseUrl", access_token as "accessToken", refresh_token as "refreshToken", expire, type FROM crowdin_credentials', []));
+            return rows || [];
+        });
+    }
+    deleteCrowdinCredentials(id) {
+        var _a, _b, _c;
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.dbPromise;
+            yield ((_a = this.connection) === null || _a === void 0 ? void 0 : _a.execute('DELETE FROM crowdin_credentials where id = ?', [id]));
+            yield ((_b = this.connection) === null || _b === void 0 ? void 0 : _b.execute('DELETE FROM integration_credentials where crowdin_id = ?', [id]));
+            yield ((_c = this.connection) === null || _c === void 0 ? void 0 : _c.execute('DELETE FROM sync_settings WHERE crowdin_id = ?', [id]));
+        });
+    }
+    saveIntegrationCredentials(id, credentials, crowdinId) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.dbPromise;
+            yield ((_a = this.connection) === null || _a === void 0 ? void 0 : _a.execute('INSERT INTO integration_credentials(id, credentials, crowdin_id) VALUES (?, ?, ?)', [id, credentials, crowdinId]));
+        });
+    }
+    updateIntegrationCredentials(id, credentials) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.dbPromise;
+            yield ((_a = this.connection) === null || _a === void 0 ? void 0 : _a.execute('UPDATE integration_credentials SET credentials = ? WHERE id = ?', [
+                credentials,
+                id,
+            ]));
+        });
+    }
+    updateIntegrationConfig(id, config) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.dbPromise;
+            yield ((_a = this.connection) === null || _a === void 0 ? void 0 : _a.execute('UPDATE integration_credentials SET config = ? WHERE id = ?', [config, id]));
+        });
+    }
+    getIntegrationCredentials(id) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.dbPromise;
+            const [rows,] = yield ((_a = this.connection) === null || _a === void 0 ? void 0 : _a.execute('SELECT id, credentials, config, crowdin_id as "crowdinId" FROM integration_credentials WHERE id = ?', [id]));
+            return (rows || [])[0];
+        });
+    }
+    getAllIntegrationCredentials(crowdinId) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.dbPromise;
+            const [rows,] = yield ((_a = this.connection) === null || _a === void 0 ? void 0 : _a.execute('SELECT id, credentials, config, crowdin_id as "crowdinId" FROM integration_credentials WHERE crowdin_id = ?', [crowdinId]));
+            return rows || [];
+        });
+    }
+    deleteIntegrationCredentials(id) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.dbPromise;
+            yield ((_a = this.connection) === null || _a === void 0 ? void 0 : _a.execute('DELETE FROM integration_credentials where id = ?', [id]));
+            yield ((_b = this.connection) === null || _b === void 0 ? void 0 : _b.execute('DELETE FROM sync_settings where integration_id = ?', [id]));
+        });
+    }
+    saveMetadata(id, metadata) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.dbPromise;
+            yield ((_a = this.connection) === null || _a === void 0 ? void 0 : _a.execute('INSERT INTO app_metadata(id, data) VALUES (?, ?)', [id, metadata]));
+        });
+    }
+    updateMetadata(id, metadata) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.dbPromise;
+            yield ((_a = this.connection) === null || _a === void 0 ? void 0 : _a.execute('UPDATE app_metadata SET data = ? WHERE id = ?', [id, metadata]));
+        });
+    }
+    getMetadata(id) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.dbPromise;
+            const [rows] = yield ((_a = this.connection) === null || _a === void 0 ? void 0 : _a.execute('SELECT data FROM app_metadata WHERE id = ?', [id]));
+            if (rows && rows[0]) {
+                return JSON.parse(rows[0].data);
+            }
+        });
+    }
+    deleteMetadata(id) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.dbPromise;
+            yield ((_a = this.connection) === null || _a === void 0 ? void 0 : _a.execute('DELETE FROM app_metadata where id = ?', [id]));
+        });
+    }
+    getSyncSettingsByProvider(integrationId, provider) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.dbPromise;
+            const [rows,] = yield ((_a = this.connection) === null || _a === void 0 ? void 0 : _a.execute('SELECT id, files, integration_id as "integrationId", crowdin_id as "crowdinId", type, provider FROM sync_settings WHERE integration_id = ? AND provider = ?', [integrationId, provider]));
+            return (rows || [])[0];
+        });
+    }
+    getAllSyncSettingsByType(type) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.dbPromise;
+            const [rows,] = yield ((_a = this.connection) === null || _a === void 0 ? void 0 : _a.execute('SELECT id, files, integration_id as "integrationId", crowdin_id as "crowdinId", type, provider FROM sync_settings WHERE type = ?', [type]));
+            return rows || [];
+        });
+    }
+    saveSyncSettings(files, integrationId, crowdinId, type, provider) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.dbPromise;
+            yield ((_a = this.connection) === null || _a === void 0 ? void 0 : _a.execute('INSERT INTO sync_settings(files, integration_id, crowdin_id, type, provider) VALUES (?, , ?, ?, ?)', [files, integrationId, crowdinId, type, provider]));
+        });
+    }
+    updateSyncSettings(files, integrationId, crowdinId, type, provider) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.dbPromise;
+            yield ((_a = this.connection) === null || _a === void 0 ? void 0 : _a.execute('UPDATE sync_settings SET files = ? WHERE integration_id = ? AND crowdin_id = ? AND type = ? AND provider = ?', [files, integrationId, crowdinId, type, provider]));
+        });
+    }
+    getSyncSettings(integrationId, crowdinId, type, provider) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.dbPromise;
+            const [rows,] = yield ((_a = this.connection) === null || _a === void 0 ? void 0 : _a.execute('SELECT id, files, integration_id as "integrationId", crowdin_id as "crowdinId", type FROM sync_settings WHERE integration_id = ? AND crowdin_id = ? AND type = ? AND provider = ?', [integrationId, crowdinId, type, provider]));
+            return (rows || [])[0];
+        });
+    }
+}
+exports.MySQLStorage = MySQLStorage;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crowdin/app-project-module",
-  "version": "0.19.0",
+  "version": "0.20.0",
   "description": "Module that generates for you all common endpoints for serving standalone Crowdin App",
   "main": "out/index.js",
   "types": "out/index.d.ts",
@@ -17,6 +17,7 @@
     "crypto-js": "^4.0.0",
     "express": "4.17.1",
     "express-handlebars": "^5.3.4",
+    "mysql2": "^2.3.3",
     "node-cron": "^3.0.0",
     "pg": "^8.8.0",
     "sqlite3": "^5.0.2",