@crowdin/app-project-module 0.4.0 → 0.6.2

package/README.md

@@ -27,6 +27,8 @@ In both options you will need to provide Crowdin App configuration file. Please
 - [OAuth2 login](#oauth2-support)
 - [Settings window](#settings-window)
 - [Info window](#info-window)
+- [Background tasks](#background-tasks)
+- [Error propagation](#error-propagation)
 - [Contributing](#contributing)
 - [Seeking Assistance](#seeking-assistance)
 - [License](#license)
@@ -222,6 +224,54 @@ Main default values:
 - access token field name should be `refresh_token`
 - expires in field name should be `expires_in` (value should be in seconds)
 
+This module rely that OAuth2 protocol is implemented by third party service in this way:
+
+- request for access token should be done via POST request to `accessTokenUrl` with JSON body that will contain at least `clientId`, `clientSecret`, `code` and `redirectUri` (also possible to add extra fields via `extraAccessTokenParameters` property)
+- request to refresh token should be done via POST request to `accessTokenUrl` (or `refreshTokenUrl` if definied) with JSON body that will contain at least `clientId`, `clientSecret` and `refreshToken` (also possible to add extra fields via `extraRefreshTokenParameters` property)
+- both requests will return JSON response with body that contains `accessToken` and, if enabled, `refreshToken` (optional) and `expireIn`
+
+To override those requests please use `performGetTokenRequest` and `performRefreshTokenRequest` (e.g. when requests should be done with different HTTP methods or data should be tranfered as query string or form data).
+
+Mailup example:
+
+```javascript
+const clientId = 'client_id';
+const clientSecret = 'client_secret';
+const tokenUrl = 'https://services.mailup.com/Authorization/OAuth/Token';
+
+configuration.oauthLogin = {
+    authorizationUrl: 'https://services.mailup.com/Authorization/OAuth/LogOn',
+    clientId,
+    clientSecret,
+    extraAutorizationUrlParameters: {
+        response_type: 'code'
+    },
+    refresh: true,
+    performGetTokenRequest: async (code) => {
+        const url = `${tokenUrl}?code=${code}&grant_type=authorization_code`;
+        const headers = {
+            'Authorization': `Bearer ${Buffer.from(`${clientId}:${clientSecret}`).toString('base64')}`
+        };
+        return (await axios.get(url, { headers })).data;
+    },
+    performRefreshTokenRequest: async (credentials) => {
+        const params = {
+            refresh_token: credentials.refreshToken,
+            grant_type: 'refresh_token',
+            client_id: clientId,
+            client_secret: clientSecret
+        };
+        const data = Object.keys(params)
+            .map((key) => `${key}=${encodeURIComponent(params[key])}`)
+            .join('&');
+        const headers = {
+            'Content-Type': 'application/x-www-form-urlencoded'
+        };
+        return (await axios.post(tokenUrl, data, { headers })).data;
+    }
+}
+```
+
 Please refer to jsdoc for more details.
 
 ## Settings window
@@ -239,7 +289,8 @@ configuration.integration.getConfiguration = (projectId, crowdinClient, integrat
         {
             key: 'text',
             label: 'Text input',
-            type: 'text'
+            type: 'text',
+            helpText: 'Help text'
         },
         {
             key: 'option',
@@ -271,6 +322,58 @@ configuration.integration.infoModal = {
 }
 ```
 
+## Background tasks
+
+In order to register background tasks that app will invoke periodically invoke you can use `cronJobs` field.
+
+```javascript
+configuration.integration.cronJobs = [
+    {
+        //every 10 seconds
+        expression: '*/10 * * * * *',
+        task: (projectId, client, apiCredentials, appRootFolder, config) => {
+            console.log(`Running background task for project : ${projectId}`);
+            console.log(`Api credentials : ${JSON.stringify(apiCredentials)}`);
+            console.log(`App config : ${JSON.stringify(config)}`);
+            console.log(appRootFolder ? JSON.stringify(appRootFolder) : 'No root folder');
+        }
+    }
+]
+```
+
+For cron syntax guide please refer to this [documentation](https://github.com/node-cron/node-cron#cron-syntax).
+
+## Error propagation
+
+In case if something is wrong with app settings or credentials are invalid you can throw an explanation message that will be then visible on the UI side.  
+e.g. check if entered credentials are valid:
+
+```javascript
+configuration.integration.checkConnection = (credentials) => {
+    if (!credentials.password  || credentials.password.length < 6) {
+        throw 'Password is too weak';
+    }
+    //or call an service API with those credentials and check if request will be successful
+};
+```
+
+Or if you need to manually control users liveness session you can throw an error with `401` code then your app will automatically do a log out action.  
+e.g. when your service has some specific session duration timeout or extra conditions which are not covered by this framework
+
+```javascript
+configuration.integrartion.getIntegrationFiles = async (credentials, appSettings) => {
+    //do a request/custom logic here
+    const sessionStillValid = false;
+    if (!sessionStillValid) {
+        throw {
+             message: 'session expired',
+             code: 401
+        }
+    }
+    //business logic
+}
+```
+
 ## Contributing
 
 If you want to contribute please read the [Contributing](/CONTRIBUTING.md) guidelines.

package/out/handlers/install.js

@@ -10,6 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const crowdin_apps_functions_1 = require("@crowdin/crowdin-apps-functions");
+const models_1 = require("../models");
 const storage_1 = require("../storage");
 const util_1 = require("../util");
 function handle(config) {
@@ -21,6 +22,7 @@ function handle(config) {
             accessToken: (0, util_1.encryptData)(config.clientSecret, token.accessToken),
             refreshToken: (0, util_1.encryptData)(config.clientSecret, token.refreshToken),
             expire: (new Date().getTime() / 1000 + token.expiresIn).toString(),
+            type: event.domain ? models_1.AccountType.ENTERPRISE : models_1.AccountType.NORMAL,
         };
         yield (0, storage_1.saveCrowdinCredentials)(credentials);
         res.status(204).end();

package/out/handlers/oauth-login.js

@@ -18,18 +18,25 @@ function handle(config) {
     return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
         var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
         const code = req.query[((_b = (_a = config.oauthLogin) === null || _a === void 0 ? void 0 : _a.fieldsMapping) === null || _b === void 0 ? void 0 : _b.code) || 'code'];
-        const request = {};
         const oauthLogin = config.oauthLogin;
-        request[((_c = oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.fieldsMapping) === null || _c === void 0 ? void 0 : _c.code) || 'code'] = code;
-        request[((_d = oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.fieldsMapping) === null || _d === void 0 ? void 0 : _d.clientId) || 'client_id'] = oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.clientId;
-        request[((_e = oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.fieldsMapping) === null || _e === void 0 ? void 0 : _e.clientSecret) || 'client_secret'] = oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.clientSecret;
-        request[((_f = oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.fieldsMapping) === null || _f === void 0 ? void 0 : _f.redirectUri) || 'redirect_uri'] = `${config.baseUrl}${(0, util_1.getOauthRoute)(config)}`;
-        if (oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.extraAccessTokenParameters) {
-            Object.entries(oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.extraAccessTokenParameters).forEach(([key, value]) => (request[key] = value));
+        let credentials;
+        if (oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.performGetTokenRequest) {
+            credentials = yield oauthLogin.performGetTokenRequest(code);
+        }
+        else {
+            const request = {};
+            const oauthLogin = config.oauthLogin;
+            request[((_c = oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.fieldsMapping) === null || _c === void 0 ? void 0 : _c.code) || 'code'] = code;
+            request[((_d = oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.fieldsMapping) === null || _d === void 0 ? void 0 : _d.clientId) || 'client_id'] = oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.clientId;
+            request[((_e = oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.fieldsMapping) === null || _e === void 0 ? void 0 : _e.clientSecret) || 'client_secret'] = oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.clientSecret;
+            request[((_f = oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.fieldsMapping) === null || _f === void 0 ? void 0 : _f.redirectUri) || 'redirect_uri'] = `${config.baseUrl}${(0, util_1.getOauthRoute)(config)}`;
+            if (oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.extraAccessTokenParameters) {
+                Object.entries(oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.extraAccessTokenParameters).forEach(([key, value]) => (request[key] = value));
+            }
+            credentials = (yield axios_1.default.post(((_g = config.oauthLogin) === null || _g === void 0 ? void 0 : _g.accessTokenUrl) || '', request, {
+                headers: { Accept: 'application/json' },
+            })).data;
         }
-        const credentials = (yield axios_1.default.post(((_g = config.oauthLogin) === null || _g === void 0 ? void 0 : _g.accessTokenUrl) || '', request, {
-            headers: { Accept: 'application/json' },
-        })).data;
         const message = {
             uid: 'oauth_popup',
         };

package/out/index.js

@@ -25,6 +25,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createApp = exports.addCrowdinEndpoints = void 0;
 const express_1 = __importStar(require("express"));
 const express_handlebars_1 = __importDefault(require("express-handlebars"));
+const cron = __importStar(require("node-cron"));
 const path_1 = require("path");
 const crowdin_file_progress_1 = __importDefault(require("./handlers/crowdin-file-progress"));
 const crowdin_files_1 = __importDefault(require("./handlers/crowdin-files"));
@@ -81,6 +82,11 @@ function addCrowdinEndpoints(app, config) {
     app.get('/api/integration/data', json_response_1.default, (0, crowdin_client_1.default)(config), (0, integration_credentials_1.default)(config), (0, integration_data_1.default)(config));
     app.post('/api/crowdin/update', json_response_1.default, (0, crowdin_client_1.default)(config), (0, integration_credentials_1.default)(config), (0, crowdin_update_1.default)(config));
     app.post('/api/integration/update', json_response_1.default, (0, crowdin_client_1.default)(config), (0, integration_credentials_1.default)(config), (0, integration_update_1.default)(config));
+    if (config.integration.cronJobs) {
+        config.integration.cronJobs.forEach(job => {
+            cron.schedule(job.expression, () => (0, util_1.runJob)(config, job).catch(console.error));
+        });
+    }
 }
 exports.addCrowdinEndpoints = addCrowdinEndpoints;
 function createApp(config) {

package/out/middlewares/crowdin-client.js

@@ -8,11 +8,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-const crowdin_api_client_1 = __importDefault(require("@crowdin/crowdin-api-client"));
 const crowdin_apps_functions_1 = require("@crowdin/crowdin-apps-functions");
 const storage_1 = require("../storage");
 const util_1 = require("../util");
@@ -43,27 +39,7 @@ function handle(config, optional = false) {
                 }
                 return res.status(403).send({ error: "Can't find organization by id" });
             }
-            const isExpired = +credentials.expire < +new Date().getTime() / 1000;
-            if (!isExpired) {
-                const crowdinToken = (0, util_1.decryptData)(config.clientSecret, credentials.accessToken);
-                req.crowdinApiClient = new crowdin_api_client_1.default({
-                    token: crowdinToken,
-                    organization: req.crowdinContext.jwtPayload.domain ? credentials.id : undefined,
-                });
-            }
-            else {
-                const newCredentials = yield (0, crowdin_apps_functions_1.refreshOAuthToken)(config.clientId, config.clientSecret, (0, util_1.decryptData)(config.clientSecret, credentials.refreshToken));
-                (0, storage_1.updateCrowdinCredentials)({
-                    id: req.crowdinContext.crowdinId,
-                    refreshToken: (0, util_1.encryptData)(config.clientSecret, newCredentials.refreshToken),
-                    accessToken: (0, util_1.encryptData)(config.clientSecret, newCredentials.accessToken),
-                    expire: (new Date().getTime() / 1000 + newCredentials.expiresIn).toString(),
-                });
-                req.crowdinApiClient = new crowdin_api_client_1.default({
-                    token: newCredentials.accessToken,
-                    organization: req.crowdinContext.jwtPayload.domain ? credentials.id : undefined,
-                });
-            }
+            req.crowdinApiClient = yield (0, util_1.prepareCrowdinClient)(config, credentials);
             next();
         }
         catch (e) {

package/out/middlewares/integration-credentials.js

@@ -8,16 +8,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-const axios_1 = __importDefault(require("axios"));
 const storage_1 = require("../storage");
 const util_1 = require("../util");
 function handle(config, optional = false) {
     return (0, util_1.runAsyncWrapper)((req, res, next) => __awaiter(this, void 0, void 0, function* () {
-        var _a, _b, _c, _d, _e, _f, _g, _h;
         const clientId = req.crowdinContext.clientId;
         const integrationCredentials = yield (0, storage_1.getIntegrationCredentials)(clientId);
         if (!integrationCredentials) {
@@ -29,35 +24,13 @@ function handle(config, optional = false) {
         if (integrationCredentials.config) {
             req.integrationSettings = JSON.parse(integrationCredentials.config);
         }
-        const credentials = JSON.parse((0, util_1.decryptData)(config.clientSecret, integrationCredentials.credentials));
-        if ((_a = config.oauthLogin) === null || _a === void 0 ? void 0 : _a.refresh) {
-            const oauthLogin = config.oauthLogin;
-            const { expireIn } = credentials;
-            //2 min as an extra buffer
-            const isExpired = expireIn + 120 < Date.now() / 1000;
-            if (isExpired) {
-                const url = oauthLogin.refreshTokenUrl || oauthLogin.accessTokenUrl;
-                const request = {};
-                request[((_b = oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.fieldsMapping) === null || _b === void 0 ? void 0 : _b.clientId) || 'client_id'] = oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.clientId;
-                request[((_c = oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.fieldsMapping) === null || _c === void 0 ? void 0 : _c.clientSecret) || 'client_secret'] = oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.clientSecret;
-                request[((_d = oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.fieldsMapping) === null || _d === void 0 ? void 0 : _d.refreshToken) || 'refresh_token'] = credentials.refreshToken;
-                if (oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.extraRefreshTokenParameters) {
-                    Object.entries(oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.extraRefreshTokenParameters).forEach(([key, value]) => (request[key] = value));
-                }
-                const newCredentials = (yield axios_1.default.post(url || '', request, {
-                    headers: { Accept: 'application/json' },
-                })).data;
-                credentials.accessToken = newCredentials[((_e = oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.fieldsMapping) === null || _e === void 0 ? void 0 : _e.accessToken) || 'access_token'];
-                credentials.expireIn =
-                    Number(newCredentials[((_f = oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.fieldsMapping) === null || _f === void 0 ? void 0 : _f.expiresIn) || 'expires_in']) + Date.now() / 1000;
-                if (newCredentials[((_g = oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.fieldsMapping) === null || _g === void 0 ? void 0 : _g.refreshToken) || 'refresh_token']) {
-                    credentials.refreshToken =
-                        newCredentials[((_h = oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.fieldsMapping) === null || _h === void 0 ? void 0 : _h.refreshToken) || 'refresh_token'];
-                }
-                yield (0, storage_1.updateIntegrationCredentials)(req.crowdinContext.clientId, (0, util_1.encryptData)(config.clientSecret, JSON.stringify(credentials)));
-            }
+        try {
+            req.integrationCredentials = yield (0, util_1.prepareIntegrationCredentials)(config, integrationCredentials);
+        }
+        catch (e) {
+            console.error(e);
+            throw new util_1.CodeError('Credentials to integration either exprired or invalid', 401);
         }
-        req.integrationCredentials = credentials;
         next();
     }));
 }

package/out/models/index.d.ts

@@ -91,11 +91,16 @@ export interface IntegrationLogic {
         title: string;
         content: string;
     };
+    /**
+     * background jobs that will be executed for each crowdin project and user
+     */
+    cronJobs?: CronJob[];
 }
 export interface ConfigurationField {
     key: string;
     label: string;
     type: 'text' | 'checkbox' | 'select';
+    helpText?: string;
     /**
      * only for select
      */
@@ -199,6 +204,14 @@ export interface OAuthLogin {
     extraRefreshTokenParameters?: {
         [key: string]: any;
     };
+    /**
+     * Override to implement request for retrieving access token (and refresh token if 'refresh' is enabled)
+     */
+    performGetTokenRequest?: (code: string) => Promise<any>;
+    /**
+     * Override to implement request for refreshing token (only if 'refresh' is enabled)
+     */
+    performRefreshTokenRequest?: (currentCredentials: any) => Promise<any>;
 }
 export interface FormField {
     key: string;
@@ -232,6 +245,11 @@ export interface CrowdinCredentials {
     accessToken: string;
     refreshToken: string;
     expire: string;
+    type: AccountType;
+}
+export declare enum AccountType {
+    NORMAL = "normal",
+    ENTERPRISE = "enterprise"
 }
 export interface CrowdinContextInfo {
     jwtPayload: JwtPayload;
@@ -253,3 +271,7 @@ export interface IntegrationFile {
 export interface UpdateIntegrationRequest {
     [fileId: string]: string[];
 }
+export interface CronJob {
+    task: (projectId: number, client: Crowdin, apiCredentials: any, appRootFolder?: SourceFilesModel.Directory, config?: any) => Promise<void>;
+    expression: string;
+}

package/out/models/index.js

@@ -1,2 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.AccountType = void 0;
+var AccountType;
+(function (AccountType) {
+    AccountType["NORMAL"] = "normal";
+    AccountType["ENTERPRISE"] = "enterprise";
+})(AccountType = exports.AccountType || (exports.AccountType = {}));

package/out/static/js/main.js

@@ -44,6 +44,10 @@ function showToast(message) {
 }
 
 function catchRejection(e, message) {
+  //session expired
+  if (e.code && e.code === 401) {
+    reloadLocation();
+  }
   showToast(e.message || message);
 }
 

package/out/storage/index.d.ts

@@ -3,9 +3,11 @@ export declare function connect(folder: string): Promise<void>;
 export declare function saveCrowdinCredentials(credentials: CrowdinCredentials): Promise<void>;
 export declare function updateCrowdinCredentials(credentials: CrowdinCredentials): Promise<void>;
 export declare function getCrowdinCredentials(id: string): Promise<CrowdinCredentials | undefined>;
+export declare function getAllCrowdinCredentials(): Promise<CrowdinCredentials[]>;
 export declare function deleteCrowdinCredentials(id: string): Promise<void>;
 export declare function saveIntegrationCredentials(id: string, credentials: any, crowdinId: string): Promise<void>;
 export declare function updateIntegrationCredentials(id: string, credentials: any): Promise<void>;
 export declare function updateIntegrationConfig(id: string, config: any): Promise<void>;
 export declare function getIntegrationCredentials(id: string): Promise<IntegrationCredentials | undefined>;
+export declare function getAllIntegrationCredentials(crowdinId: string): Promise<IntegrationCredentials[]>;
 export declare function deleteIntegrationCredentials(id: string): Promise<void>;

package/out/storage/index.js

@@ -13,7 +13,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.deleteIntegrationCredentials = exports.getIntegrationCredentials = exports.updateIntegrationConfig = exports.updateIntegrationCredentials = exports.saveIntegrationCredentials = exports.deleteCrowdinCredentials = exports.getCrowdinCredentials = exports.updateCrowdinCredentials = exports.saveCrowdinCredentials = exports.connect = void 0;
+exports.deleteIntegrationCredentials = exports.getAllIntegrationCredentials = exports.getIntegrationCredentials = exports.updateIntegrationConfig = exports.updateIntegrationCredentials = exports.saveIntegrationCredentials = exports.deleteCrowdinCredentials = exports.getAllCrowdinCredentials = exports.getCrowdinCredentials = exports.updateCrowdinCredentials = exports.saveCrowdinCredentials = exports.connect = void 0;
 const path_1 = require("path");
 const sqlite3_1 = __importDefault(require("sqlite3"));
 let _res;
@@ -61,7 +61,8 @@ function connect(folder) {
                 id            varchar not null primary key,
                 access_token  varchar not null,
                 refresh_token varchar not null,
-                expire        varchar not null
+                expire        varchar not null,
+                type          varchar not null
             );
             `, []);
             yield _run(`
@@ -111,13 +112,24 @@ function get(query, params) {
         });
     });
 }
+function each(query, params) {
+    return __awaiter(this, void 0, void 0, function* () {
+        yield dbPromise;
+        return new Promise((res, rej) => {
+            const result = [];
+            db.each(query, params, (err, row) => {
+                if (err) {
+                    rej(err);
+                }
+                else {
+                    result.push(row);
+                }
+            }, () => res(result));
+        });
+    });
+}
 function saveCrowdinCredentials(credentials) {
-    return run('INSERT INTO crowdin_credentials(id, access_token, refresh_token, expire) VALUES (?, ?, ?, ?)', [
-        credentials.id,
-        credentials.accessToken,
-        credentials.refreshToken,
-        credentials.expire,
-    ]);
+    return run('INSERT INTO crowdin_credentials(id, access_token, refresh_token, expire, type) VALUES (?, ?, ?, ?, ?)', [credentials.id, credentials.accessToken, credentials.refreshToken, credentials.expire, credentials.type]);
 }
 exports.saveCrowdinCredentials = saveCrowdinCredentials;
 function updateCrowdinCredentials(credentials) {
@@ -131,13 +143,19 @@ function updateCrowdinCredentials(credentials) {
 exports.updateCrowdinCredentials = updateCrowdinCredentials;
 function getCrowdinCredentials(id) {
     return __awaiter(this, void 0, void 0, function* () {
-        const row = yield get('SELECT id, access_token as accessToken, refresh_token as refreshToken, expire FROM crowdin_credentials WHERE id = ?', [id]);
+        const row = yield get('SELECT id, access_token as accessToken, refresh_token as refreshToken, expire, type FROM crowdin_credentials WHERE id = ?', [id]);
         if (row) {
             return row;
         }
     });
 }
 exports.getCrowdinCredentials = getCrowdinCredentials;
+function getAllCrowdinCredentials() {
+    return __awaiter(this, void 0, void 0, function* () {
+        return each('SELECT id, access_token as accessToken, refresh_token as refreshToken, expire, type FROM crowdin_credentials', []);
+    });
+}
+exports.getAllCrowdinCredentials = getAllCrowdinCredentials;
 function deleteCrowdinCredentials(id) {
     return __awaiter(this, void 0, void 0, function* () {
         yield run('DELETE FROM crowdin_credentials where id = ?', [id]);
@@ -170,6 +188,12 @@ function getIntegrationCredentials(id) {
     });
 }
 exports.getIntegrationCredentials = getIntegrationCredentials;
+function getAllIntegrationCredentials(crowdinId) {
+    return __awaiter(this, void 0, void 0, function* () {
+        return each('SELECT id, credentials, config, crowdin_id as crowdinId FROM integration_credentials WHERE crowdin_id = ?', [crowdinId]);
+    });
+}
+exports.getAllIntegrationCredentials = getAllIntegrationCredentials;
 function deleteIntegrationCredentials(id) {
     return run('DELETE FROM integration_credentials where id = ?', [id]);
 }

package/out/util/index.d.ts

@@ -1,9 +1,16 @@
 import Crowdin, { SourceFilesModel } from '@crowdin/crowdin-api-client';
 import { Request, Response } from 'express';
-import { Config } from '../models';
+import { Config, CronJob, CrowdinCredentials, IntegrationCredentials } from '../models';
+export declare class CodeError extends Error {
+    code: number | undefined;
+    constructor(message: string, code?: number);
+}
 export declare function runAsyncWrapper(callback: Function): (req: Request, res: Response, next: Function) => void;
 export declare function encryptData(secret: string, data: string): string;
 export declare function decryptData(secret: string, data: string): string;
 export declare function getOauthRoute(config: Config): string;
 export declare function getRootFolder(config: Config, client: Crowdin, projectId: number): Promise<SourceFilesModel.Directory | undefined>;
 export declare function applyDefaults(config: Config): void;
+export declare function prepareCrowdinClient(config: Config, credentials: CrowdinCredentials): Promise<Crowdin>;
+export declare function prepareIntegrationCredentials(config: Config, integrationCredentials: IntegrationCredentials): Promise<any>;
+export declare function runJob(config: Config, job: CronJob): Promise<void>;

package/out/util/index.js

@@ -27,13 +27,47 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.applyDefaults = exports.getRootFolder = exports.getOauthRoute = exports.decryptData = exports.encryptData = exports.runAsyncWrapper = void 0;
+exports.runJob = exports.prepareIntegrationCredentials = exports.prepareCrowdinClient = exports.applyDefaults = exports.getRootFolder = exports.getOauthRoute = exports.decryptData = exports.encryptData = exports.runAsyncWrapper = exports.CodeError = void 0;
+const crowdin_api_client_1 = __importDefault(require("@crowdin/crowdin-api-client"));
 const crowdinAppFunctions = __importStar(require("@crowdin/crowdin-apps-functions"));
+const axios_1 = __importDefault(require("axios"));
 const crypto = __importStar(require("crypto-js"));
+const models_1 = require("../models");
+const storage_1 = require("../storage");
+class CodeError extends Error {
+    constructor(message, code) {
+        super(message);
+        this.code = code;
+    }
+}
+exports.CodeError = CodeError;
+function isCrowdinClientRequest(req) {
+    return req.crowdinContext;
+}
+function handleError(err, req, res) {
+    return __awaiter(this, void 0, void 0, function* () {
+        console.error(err);
+        const code = err.code ? err.code : 500;
+        if (code === 401 && isCrowdinClientRequest(req)) {
+            yield (0, storage_1.deleteIntegrationCredentials)(req.crowdinContext.clientId);
+        }
+        if (code === 401 && req.path === '/') {
+            res.redirect('/');
+            return;
+        }
+        res.status(code).send({
+            message: err.message ? err.message : JSON.stringify(err),
+            code,
+        });
+    });
+}
 function runAsyncWrapper(callback) {
     return (req, res, next) => {
-        callback(req, res, next).catch((e) => res.status(500).send({ error: JSON.stringify(e) }));
+        callback(req, res, next).catch((e) => handleError(e, req, res));
     };
 }
 exports.runAsyncWrapper = runAsyncWrapper;
@@ -69,7 +103,11 @@ function applyDefaults(config) {
             if (rootFolder) {
                 allDirectories = (yield client.sourceFilesApi
                     .withFetchAll()
-                    .listProjectDirectories(projectId, undefined, rootFolder.id, undefined, undefined, undefined, 'true')).data.map(d => d.data);
+                    // @ts-expect-error: Method overloading
+                    .listProjectDirectories(projectId, {
+                    directoryId: rootFolder.id,
+                    recursion: 'true',
+                })).data.map(d => d.data);
             }
             else {
                 allDirectories = (yield client.sourceFilesApi.withFetchAll().listProjectDirectories(projectId)).data.map(d => d.data);
@@ -113,3 +151,89 @@ function applyDefaults(config) {
     }
 }
 exports.applyDefaults = applyDefaults;
+function prepareCrowdinClient(config, credentials) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const isExpired = +credentials.expire < +new Date().getTime() / 1000;
+        if (!isExpired) {
+            const crowdinToken = decryptData(config.clientSecret, credentials.accessToken);
+            return new crowdin_api_client_1.default({
+                token: crowdinToken,
+                organization: credentials.type === models_1.AccountType.ENTERPRISE ? credentials.id : undefined,
+            });
+        }
+        else {
+            const newCredentials = yield crowdinAppFunctions.refreshOAuthToken(config.clientId, config.clientSecret, decryptData(config.clientSecret, credentials.refreshToken));
+            yield (0, storage_1.updateCrowdinCredentials)({
+                id: credentials.id,
+                refreshToken: encryptData(config.clientSecret, newCredentials.refreshToken),
+                accessToken: encryptData(config.clientSecret, newCredentials.accessToken),
+                expire: (new Date().getTime() / 1000 + newCredentials.expiresIn).toString(),
+                type: credentials.type,
+            });
+            return new crowdin_api_client_1.default({
+                token: newCredentials.accessToken,
+                organization: credentials.type === models_1.AccountType.ENTERPRISE ? credentials.id : undefined,
+            });
+        }
+    });
+}
+exports.prepareCrowdinClient = prepareCrowdinClient;
+function prepareIntegrationCredentials(config, integrationCredentials) {
+    var _a, _b, _c, _d, _e, _f, _g, _h;
+    return __awaiter(this, void 0, void 0, function* () {
+        const credentials = JSON.parse(decryptData(config.clientSecret, integrationCredentials.credentials));
+        if ((_a = config.oauthLogin) === null || _a === void 0 ? void 0 : _a.refresh) {
+            const oauthLogin = config.oauthLogin;
+            const { expireIn } = credentials;
+            //2 min as an extra buffer
+            const isExpired = expireIn + 120 < Date.now() / 1000;
+            if (isExpired) {
+                let newCredentials;
+                if (oauthLogin.performRefreshTokenRequest) {
+                    newCredentials = yield oauthLogin.performRefreshTokenRequest(credentials);
+                }
+                else {
+                    const url = oauthLogin.refreshTokenUrl || oauthLogin.accessTokenUrl;
+                    const request = {};
+                    request[((_b = oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.fieldsMapping) === null || _b === void 0 ? void 0 : _b.clientId) || 'client_id'] = oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.clientId;
+                    request[((_c = oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.fieldsMapping) === null || _c === void 0 ? void 0 : _c.clientSecret) || 'client_secret'] = oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.clientSecret;
+                    request[((_d = oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.fieldsMapping) === null || _d === void 0 ? void 0 : _d.refreshToken) || 'refresh_token'] = credentials.refreshToken;
+                    if (oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.extraRefreshTokenParameters) {
+                        Object.entries(oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.extraRefreshTokenParameters).forEach(([key, value]) => (request[key] = value));
+                    }
+                    newCredentials = (yield axios_1.default.post(url || '', request, {
+                        headers: { Accept: 'application/json' },
+                    })).data;
+                }
+                credentials.accessToken = newCredentials[((_e = oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.fieldsMapping) === null || _e === void 0 ? void 0 : _e.accessToken) || 'access_token'];
+                credentials.expireIn =
+                    Number(newCredentials[((_f = oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.fieldsMapping) === null || _f === void 0 ? void 0 : _f.expiresIn) || 'expires_in']) + Date.now() / 1000;
+                if (newCredentials[((_g = oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.fieldsMapping) === null || _g === void 0 ? void 0 : _g.refreshToken) || 'refresh_token']) {
+                    credentials.refreshToken = newCredentials[((_h = oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.fieldsMapping) === null || _h === void 0 ? void 0 : _h.refreshToken) || 'refresh_token'];
+                }
+                yield (0, storage_1.updateIntegrationCredentials)(integrationCredentials.id, encryptData(config.clientSecret, JSON.stringify(credentials)));
+            }
+        }
+        return credentials;
+    });
+}
+exports.prepareIntegrationCredentials = prepareIntegrationCredentials;
+function runJob(config, job) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const crowdinCredentialsList = yield (0, storage_1.getAllCrowdinCredentials)();
+        yield Promise.all(crowdinCredentialsList.map((crowdinCredentials) => __awaiter(this, void 0, void 0, function* () {
+            const crowdinClient = yield prepareCrowdinClient(config, crowdinCredentials);
+            const integrationCredentialsList = yield (0, storage_1.getAllIntegrationCredentials)(crowdinCredentials.id);
+            yield Promise.all(integrationCredentialsList.map((integrationCredentials) => __awaiter(this, void 0, void 0, function* () {
+                const projectId = crowdinAppFunctions.getProjectId(integrationCredentials.id);
+                const apiCredentials = yield prepareIntegrationCredentials(config, integrationCredentials);
+                const rootFolder = yield getRootFolder(config, crowdinClient, projectId);
+                const intConfig = integrationCredentials.config
+                    ? JSON.parse(integrationCredentials.config)
+                    : undefined;
+                yield job.task(projectId, crowdinClient, apiCredentials, rootFolder, intConfig);
+            })));
+        })));
+    });
+}
+exports.runJob = runJob;

package/out/views/main.handlebars

@@ -5,13 +5,13 @@
 <body>
     <div class="i_w">
         <div class='top'>
+            {{#if infoModal}}
+            <crowdin-button icon-before="info" onclick="infoModal.open();">{{infoModal.title}}</crowdin-button>
+            {{/if}}
             {{#if configurationFields}}
             <crowdin-button icon-before="settings" onclick="settingsModal.open();fillSettingsForm();">Settings</crowdin-button>
             {{/if}}
             <crowdin-button icon-before="account_circle" onclick="integrationLogout()">Log out</crowdin-button>
-            {{#if infoModal}}
-            <crowdin-button icon-before="info" onclick="infoModal.open();">{{infoModal.title}}</crowdin-button>
-            {{/if}}
         </div>
         <crowdin-simple-integration integration-name="{{name}}" integration-logo="logo.png">
         </crowdin-simple-integration>
@@ -35,6 +35,9 @@
                                 value="false"
                                 id="{{key}}-settings"
                                 key="{{key}}"
+                                {{#if helpText}}
+                                    help-text="{{helpText}}"
+                                {{/if}}
                             >
                             </crowdin-checkbox>
                     {{/ifeq}}
@@ -47,6 +50,9 @@
                                 id="{{key}}-settings"
                                 key="{{key}}"
                                 label="{{label}}"
+                                {{#if helpText}}
+                                    help-text="{{helpText}}"
+                                {{/if}}
                             >
                                 {{#each options}}
                                     <option value="{{value}}">{{label}}</option>
@@ -60,6 +66,9 @@
                                     value=""
                                     id="{{key}}-settings"
                                     key="{{key}}"
+                                    {{#if helpText}}
+                                        help-text="{{helpText}}"
+                                    {{/if}}
                              >
                              </crowdin-input>
                     {{/ifeq}}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crowdin/app-project-module",
-  "version": "0.4.0",
+  "version": "0.6.2",
   "description": "Module that generates for you all common endpoints for serving standalone Crowdin App",
   "main": "out/index.js",
   "types": "out/index.d.ts",
@@ -12,10 +12,11 @@
     "test": "echo \"test not implemented\""
   },
   "dependencies": {
-    "express": "4.17.1",
-    "@crowdin/crowdin-apps-functions": "0.0.2",
+    "@crowdin/crowdin-apps-functions": "0.0.3",
     "crypto-js": "^4.0.0",
+    "express": "4.17.1",
     "express-handlebars": "^5.3.4",
+    "node-cron": "^3.0.0",
     "sqlite3": "^5.0.2"
   },
   "devDependencies": {
@@ -24,6 +25,7 @@
     "@types/express-handlebars": "^5.3.1",
     "@types/node": "^12.0.10",
     "@types/sqlite3": "^3.1.7",
+    "@types/node-cron": "^3.0.0",
     "@typescript-eslint/eslint-plugin": "^2.3.1",
     "@typescript-eslint/parser": "^2.3.1",
     "eslint": "^6.4.0",