@crowdin/app-project-module 0.20.0 → 0.20.2

package/README.md

@@ -143,7 +143,7 @@ const configuration = {
             );
         },
         updateIntegration: async (projectId, client, credentials, request, rootFolder, appSettings) => {
-            ////here should be logic to get translations from Crowdin and upload them to integration
+            //here should be logic to get translations from Crowdin and upload them to integration
             console.log(`Request for updating data in Integration ${JSON.stringify(request)}`);
             const directories = await client.sourceFilesApi
                 .withFetchAll()
@@ -170,6 +170,9 @@ const configuration = {
                 console.log(response.data);
             }
         },
+        onLogout: async (projectId, client, credentials, appSettings) => {
+            //cleanup logic
+        }
     }
 };
 
@@ -293,7 +296,9 @@ configuration.projectIntegration.oauthLogin = {
         response_type: 'code'
     },
     refresh: true,
-    performGetTokenRequest: async (code) => {
+    performGetTokenRequest: async (code, query, url) => {
+        //query is an object with all query params
+        //url is an url string that OAuth server used to call us back
         const url = `${tokenUrl}?code=${code}&grant_type=authorization_code`;
         const headers = {
             'Authorization': `Bearer ${Buffer.from(`${clientId}:${clientSecret}`).toString('base64')}`
@@ -681,7 +686,8 @@ const configuration = {
 
 const crowdinApp = crowdinModule.addCrowdinEndpoints(app, configuration);
 
-async function cleanup(organization) {
+async function cleanup(organization, allCredentials) {
+    //Cleanup logic
     await crowdinApp.deleteMetadata(organization);
 }
 

package/out/handlers/integration-logout.d.ts

@@ -1,4 +1,4 @@
 /// <reference types="qs" />
 import { Response } from 'express';
-import { Config } from '../models';
-export default function handle(config: Config): (req: import("express").Request<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: Function) => void;
+import { Config, IntegrationLogic } from '../models';
+export default function handle(config: Config, integration: IntegrationLogic): (req: import("express").Request<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: Function) => void;

package/out/handlers/integration-logout.js

@@ -12,9 +12,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const storage_1 = require("../storage");
 const util_1 = require("../util");
 const connection_1 = require("../util/connection");
-function handle(config) {
+function handle(config, integration) {
     return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
         (0, util_1.log)('Recieved integration logout request', config.logger);
+        if (integration.onLogout) {
+            (0, util_1.log)('Invoking onLogout hook', config.logger);
+            yield integration.onLogout(req.crowdinContext.jwtPayload.context.project_id, req.crowdinApiClient, req.integrationCredentials, req.integrationSettings);
+        }
+        (0, util_1.log)(`Deleting integration credentials for ${req.crowdinContext.clientId} client`, config.logger);
         yield (0, storage_1.getStorage)().deleteIntegrationCredentials(req.crowdinContext.clientId);
         (0, connection_1.clearCache)(req.crowdinContext.crowdinId);
         res.status(204).end();

package/out/handlers/oauth-login.js

@@ -28,7 +28,7 @@ function handle(config, integration) {
             let credentials;
             if (oauthLogin === null || oauthLogin === void 0 ? void 0 : oauthLogin.performGetTokenRequest) {
                 (0, util_1.log)('Performing custom get bearer token request', config.logger);
-                credentials = yield oauthLogin.performGetTokenRequest(code);
+                credentials = yield oauthLogin.performGetTokenRequest(code, req.query, req.originalUrl);
             }
             else {
                 const request = {};

package/out/handlers/uninstall.js

@@ -11,15 +11,35 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 const storage_1 = require("../storage");
 const util_1 = require("../util");
+const connection_1 = require("../util/connection");
 function handle(config) {
     return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
         const event = req.body;
         (0, util_1.log)(`Recieved uninstall request ${JSON.stringify(event, null, 2)}`, config.logger);
+        const projectIntegration = config.projectIntegration;
         const organization = (event.domain || event.organizationId).toString();
-        yield (0, storage_1.getStorage)().deleteCrowdinCredentials(organization);
         if (config.onUninstall) {
-            yield config.onUninstall(organization);
+            let allCredentials = [];
+            if (projectIntegration) {
+                const loadedCredentials = yield (0, storage_1.getStorage)().getAllIntegrationCredentials(organization);
+                allCredentials = yield Promise.all(loadedCredentials.map((creds) => __awaiter(this, void 0, void 0, function* () {
+                    let settings;
+                    if (creds.config) {
+                        settings = JSON.parse(creds.config);
+                    }
+                    const credentials = yield (0, connection_1.prepareIntegrationCredentials)(config, projectIntegration, creds);
+                    return { settings, credentials };
+                })));
+            }
+            (0, util_1.log)('Invoking onUninstall hook', config.logger);
+            yield config.onUninstall(organization, allCredentials);
+        }
+        if (projectIntegration) {
+            (0, util_1.log)(`Deleting all integration credentials for ${organization} organization`, config.logger);
+            yield (0, storage_1.getStorage)().deleteAllIntegrationCredentials(organization);
         }
+        (0, util_1.log)(`Deleting crowdin credentials for ${organization} organization`, config.logger);
+        yield (0, storage_1.getStorage)().deleteCrowdinCredentials(organization);
         (0, util_1.log)('App has been uninstalled', config.logger);
         res.status(204).end();
     }), config.onError);

package/out/index.js

@@ -106,7 +106,7 @@ function addCrowdinEndpoints(app, config) {
         app.get('/api/subscription-info', json_response_1.default, (0, crowdin_client_1.default)(config), (0, subscription_info_1.default)(config));
         app.post('/api/settings', (0, crowdin_client_1.default)(config), (0, integration_credentials_1.default)(config, integrationLogic), (0, settings_save_1.default)(config));
         app.post('/api/login', (0, crowdin_client_1.default)(config, false, false), (0, integration_login_1.default)(config, integrationLogic));
-        app.post('/api/logout', (0, crowdin_client_1.default)(config, false, false), (0, integration_logout_1.default)(config));
+        app.post('/api/logout', (0, crowdin_client_1.default)(config, false, false), (0, integration_credentials_1.default)(config, integrationLogic), (0, integration_logout_1.default)(config, integrationLogic));
         app.get('/api/crowdin/files', json_response_1.default, (0, crowdin_client_1.default)(config), (0, integration_credentials_1.default)(config, integrationLogic), (0, crowdin_files_1.default)(config, integrationLogic));
         app.get('/api/crowdin/project', json_response_1.default, (0, crowdin_client_1.default)(config), (0, crowdin_project_1.default)(config));
         app.get('/api/crowdin/file-progress/:fileId', (0, crowdin_client_1.default)(config), (0, crowdin_file_progress_1.default)(config));

package/out/models/index.d.ts

@@ -95,7 +95,10 @@ export interface Config extends ImagePath {
     /**
      * Uninstall hook for cleanup logic
      */
-    onUninstall?: (organization: string) => Promise<void>;
+    onUninstall?: (organization: string, allCredentials: {
+        settings?: any;
+        credentials: any;
+    }[]) => Promise<void>;
     /**
      * Error interceptor (can be used to log error in centralized place)
      */
@@ -170,6 +173,10 @@ export interface IntegrationLogic {
      * function to define configuration(settings) modal for you app (by default app will not have any custom settings)
      */
     getConfiguration?: (projectId: number, client: Crowdin, apiCredentials: any) => Promise<ConfigurationModalEntity[]>;
+    /**
+     * Logout hook for cleanup logic
+     */
+    onLogout?: (projectId: number, client: Crowdin, apiCredentials: any, config?: any) => Promise<void>;
     /**
      * flag to turn on auto reload of the tree whenever user updates the configuration
      */
@@ -317,7 +324,9 @@ export interface OAuthLogin {
     /**
      * Override to implement request for retrieving access token (and refresh token if 'refresh' is enabled)
      */
-    performGetTokenRequest?: (code: string) => Promise<any>;
+    performGetTokenRequest?: (code: string, query: {
+        [key: string]: any;
+    }, url: string) => Promise<any>;
     /**
      * Override to implement request for refreshing token (only if 'refresh' is enabled)
      */

package/out/storage/index.d.ts

@@ -12,6 +12,7 @@ export interface Storage<T> {
     getIntegrationCredentials(id: string): Promise<IntegrationCredentials | undefined>;
     getAllIntegrationCredentials(crowdinId: string): Promise<IntegrationCredentials[]>;
     deleteIntegrationCredentials(id: string): Promise<void>;
+    deleteAllIntegrationCredentials(crowdinId: string): Promise<void>;
     saveMetadata(id: string, metadata: any): Promise<void>;
     updateMetadata(id: string, metadata: any): Promise<void>;
     getMetadata(id: string): Promise<any | undefined>;

package/out/storage/mysql.d.ts

@@ -26,6 +26,7 @@ export declare class MySQLStorage implements Storage<MySQLStorageConfig> {
     getIntegrationCredentials(id: string): Promise<IntegrationCredentials | undefined>;
     getAllIntegrationCredentials(crowdinId: string): Promise<IntegrationCredentials[]>;
     deleteIntegrationCredentials(id: string): Promise<void>;
+    deleteAllIntegrationCredentials(crowdinId: string): Promise<void>;
     saveMetadata(id: string, metadata: any): Promise<void>;
     updateMetadata(id: string, metadata: any): Promise<void>;
     getMetadata(id: string): Promise<any>;

package/out/storage/mysql.js

@@ -189,6 +189,14 @@ class MySQLStorage {
             yield ((_b = this.connection) === null || _b === void 0 ? void 0 : _b.execute('DELETE FROM sync_settings where integration_id = ?', [id]));
         });
     }
+    deleteAllIntegrationCredentials(crowdinId) {
+        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 crowdin_id = ?', [crowdinId]));
+            yield ((_b = this.connection) === null || _b === void 0 ? void 0 : _b.execute('DELETE FROM sync_settings where crowdin_id = ?', [crowdinId]));
+        });
+    }
     saveMetadata(id, metadata) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {

package/out/storage/postgre.d.ts

@@ -30,6 +30,7 @@ export declare class PostgreStorage implements Storage<PostgreStorageConfig> {
     getIntegrationCredentials(id: string): Promise<IntegrationCredentials | undefined>;
     getAllIntegrationCredentials(crowdinId: string): Promise<IntegrationCredentials[]>;
     deleteIntegrationCredentials(id: string): Promise<void>;
+    deleteAllIntegrationCredentials(crowdinId: string): Promise<void>;
     saveMetadata(id: string, metadata: any): Promise<void>;
     updateMetadata(id: string, metadata: any): Promise<void>;
     getMetadata(id: string): Promise<any>;

package/out/storage/postgre.js

@@ -188,6 +188,14 @@ class PostgreStorage {
             yield ((_b = this.client) === null || _b === void 0 ? void 0 : _b.query('DELETE FROM sync_settings where integration_id = $1', [id]));
         });
     }
+    deleteAllIntegrationCredentials(crowdinId) {
+        var _a, _b;
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.dbPromise;
+            yield ((_a = this.client) === null || _a === void 0 ? void 0 : _a.query('DELETE FROM integration_credentials where crowdin_id = $1', [crowdinId]));
+            yield ((_b = this.client) === null || _b === void 0 ? void 0 : _b.query('DELETE FROM sync_settings where crowdin_id = $1', [crowdinId]));
+        });
+    }
     saveMetadata(id, metadata) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {

package/out/storage/sqlite.d.ts

@@ -25,6 +25,7 @@ export declare class SQLiteStorage implements Storage<SQLiteStorageConfig> {
     getIntegrationCredentials(id: string): Promise<IntegrationCredentials | undefined>;
     getAllIntegrationCredentials(crowdinId: string): Promise<IntegrationCredentials[]>;
     deleteIntegrationCredentials(id: string): Promise<void>;
+    deleteAllIntegrationCredentials(crowdinId: string): Promise<void>;
     saveMetadata(id: string, metadata: any): Promise<void>;
     updateMetadata(id: string, metadata: any): Promise<void>;
     getMetadata(id: string): Promise<any>;

package/out/storage/sqlite.js

@@ -253,6 +253,12 @@ class SQLiteStorage {
             yield this.run('DELETE FROM sync_settings where integration_id = ?', [id]);
         });
     }
+    deleteAllIntegrationCredentials(crowdinId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.run('DELETE FROM integration_credentials where crowdin_id = ?', [crowdinId]);
+            yield this.run('DELETE FROM sync_settings where crowdin_id = ?', [crowdinId]);
+        });
+    }
     saveMetadata(id, metadata) {
         return this.run('INSERT INTO app_metadata(id, data) VALUES (?, ?)', [id, JSON.stringify(metadata)]);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crowdin/app-project-module",
-  "version": "0.20.0",
+  "version": "0.20.2",
   "description": "Module that generates for you all common endpoints for serving standalone Crowdin App",
   "main": "out/index.js",
   "types": "out/index.d.ts",