@crowdin/app-project-module 0.17.8 → 0.18.0

package/README.md

@@ -27,6 +27,9 @@ In both options you will need to provide Crowdin App configuration file. Please
 - [Authorization](#authorization)
   - [Custom login form](#customize-your-app-login-form)
   - [OAuth2 login](#oauth2-support)
+- [Storage](#storage)
+  - [SQLite](#sqlite)
+  - [PostgreSQL](#postgresql)
 - [Settings window](#settings-window)
 - [Info window](#info-window)
 - [Background tasks](#background-tasks)
@@ -74,9 +77,9 @@ const configuration = {
     dbFolder: __dirname,
     imagePath: __dirname + '/' + 'logo.png',
     crowdinUrls: { // custom urls to override
-        // apiUrl: 'https://local.crowdin.dev/api/v2'
-        // accountUrl: 'https://local.crowdin.dev/oauth/token' // (default https://accounts.crowdin.com/oauth/token)
-        // subscriptionUrl: 'https://local.crowdin.dev' // (default https://crowdin.com or https://org.api.crowdin.com)
+        // apiUrl: 'https://<copy_name>.crowdin.dev/api/v2', // 'https://<org_name>.<copy_name>.crowdin.dev/api/v2' for enterprise
+        // accountUrl: 'https://accounts.<copy_name>.crowdin.dev/oauth/token', // (default https://accounts.crowdin.com/oauth/token)
+        // subscriptionUrl: 'https://<copy_name>.crowdin.dev' // (default https://crowdin.com or https://org.api.crowdin.com)
     },
     projectIntegration: {
         withRootFolder: true,
@@ -314,6 +317,28 @@ configuration.projectIntegration.oauthLogin = {
 
 Please refer to jsdoc for more details.
 
+## Storage
+
+Module can be configured to use following storages:
+
+### SQLite
+
+```javascript
+//specify folder where sqlite db file will be located
+configuration.dbFolder = __dirname;
+```
+
+### PostgreSQL
+
+```javascript
+configuration.postgreConfig = {
+    host: 'localhost',
+    user: 'postgres',
+    password: 'password',
+    database: 'test'
+};
+```
+
 ## Settings window
 
 It is also possible to define settings window for your app where users can customize integration flow.
@@ -480,6 +505,7 @@ const configuration = {
     dbFolder: __dirname,
     imagePath: __dirname + '/' + 'logo.png',
     customFileFormat: {
+        filesFolder: __dirname,
         type: 'type-xyz',
         multilingual: false,
         autoUploadTranslations: true, //useful when single language format
@@ -530,6 +556,7 @@ const configuration = {
     dbFolder: __dirname,
     imagePath: __dirname + '/' + 'logo.png',
     customFileFormat: {
+        filesFolder: __dirname,
         type: 'type-xyz',
         stringsExport: true,
         extensions: [

package/out/handlers/custom-file-format/process.js

@@ -17,7 +17,7 @@ const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const models_1 = require("../../models");
 const util_1 = require("../../util");
-const MAX_BODY_SIZE = 5 * 1024 * 1024; //5mb
+const MAX_BODY_SIZE = 4.9 * 1024 * 1024; //4.9mb
 function storeFile(fileContent, folder) {
     const fileName = `file${Date.now()}`;
     return new Promise((res, rej) => fs_1.default.writeFile(path_1.default.join(folder, 'custom-file-format', fileName), fileContent, err => {
@@ -70,9 +70,13 @@ function handleParseFile(baseUrl, dataFolder, config, req, client, context, proj
             return { response };
         }
         const res = yield config.parseFile(file, req, client, context, projectId);
+        let maxSize = MAX_BODY_SIZE;
+        if (res.strings && res.previewFile) {
+            maxSize = maxSize / 2;
+        }
         if (res.previewFile) {
             const previewFileEncoded = Buffer.from(res.previewFile).toString('base64');
-            if (Buffer.byteLength(previewFileEncoded, 'utf8') < MAX_BODY_SIZE) {
+            if (Buffer.byteLength(previewFileEncoded, 'utf8') < maxSize) {
                 response.preview = previewFileEncoded;
             }
             else {
@@ -92,7 +96,7 @@ function handleParseFile(baseUrl, dataFolder, config, req, client, context, proj
                 });
             }
             const stringsJson = JSON.stringify(strings);
-            if (Buffer.byteLength(stringsJson, 'utf8') < MAX_BODY_SIZE) {
+            if (Buffer.byteLength(stringsJson, 'utf8') < maxSize) {
                 response.strings = strings;
             }
             else {

package/out/handlers/install.js

@@ -31,13 +31,13 @@ function handle(config) {
             expire: (new Date().getTime() / 1000 + token.expiresIn).toString(),
             type: event.domain ? models_1.AccountType.ENTERPRISE : models_1.AccountType.NORMAL,
         };
-        const existingCredentials = yield (0, storage_1.getCrowdinCredentials)(credentials.id);
+        const existingCredentials = yield (0, storage_1.getStorage)().getCrowdinCredentials(credentials.id);
         if (!!existingCredentials) {
-            yield (0, storage_1.updateCrowdinCredentials)(credentials);
+            yield (0, storage_1.getStorage)().updateCrowdinCredentials(credentials);
             (0, util_1.log)('An existing App has been reinstalled', config.logger);
         }
         else {
-            yield (0, storage_1.saveCrowdinCredentials)(credentials);
+            yield (0, storage_1.getStorage)().saveCrowdinCredentials(credentials);
             (0, util_1.log)('A new App has been installed', config.logger);
         }
         res.status(204).end();

package/out/handlers/integration-login.js

@@ -18,12 +18,12 @@ function handle(config, integration) {
             (0, util_1.log)('Checking the integration credentials', config.logger);
             yield integration.checkConnection(req.body.credentials);
         }
-        const existing = yield (0, storage_1.getIntegrationCredentials)(req.crowdinContext.clientId);
+        const existing = yield (0, storage_1.getStorage)().getIntegrationCredentials(req.crowdinContext.clientId);
         if (!!existing) {
             (0, util_1.log)('Deleting old credentials', config.logger);
-            yield (0, storage_1.deleteIntegrationCredentials)(req.crowdinContext.clientId);
+            yield (0, storage_1.getStorage)().deleteIntegrationCredentials(req.crowdinContext.clientId);
         }
-        yield (0, storage_1.saveIntegrationCredentials)(req.crowdinContext.clientId, (0, util_1.encryptData)(config, JSON.stringify(req.body.credentials)), req.crowdinContext.crowdinId);
+        yield (0, storage_1.getStorage)().saveIntegrationCredentials(req.crowdinContext.clientId, (0, util_1.encryptData)(config, JSON.stringify(req.body.credentials)), req.crowdinContext.crowdinId);
         res.status(204).end();
     }), config.onError);
 }

package/out/handlers/integration-logout.js

@@ -15,7 +15,7 @@ const connection_1 = require("../util/connection");
 function handle(config) {
     return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
         (0, util_1.log)('Recieved integration logout request', config.logger);
-        yield (0, storage_1.deleteIntegrationCredentials)(req.crowdinContext.clientId);
+        yield (0, storage_1.getStorage)().deleteIntegrationCredentials(req.crowdinContext.clientId);
         (0, connection_1.clearCache)(req.crowdinContext.crowdinId);
         res.status(204).end();
     }), config.onError);

package/out/handlers/settings-save.js

@@ -14,7 +14,7 @@ const util_1 = require("../util");
 function handle(config) {
     return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
         (0, util_1.log)(`Saving settings ${JSON.stringify(req.body.config, null, 2)}`, config.logger);
-        yield (0, storage_1.updateIntegrationConfig)(req.crowdinContext.clientId, JSON.stringify(req.body.config));
+        yield (0, storage_1.getStorage)().updateIntegrationConfig(req.crowdinContext.clientId, JSON.stringify(req.body.config));
         res.status(204).end();
     }), config.onError);
 }

package/out/handlers/sync-settings-save.js

@@ -14,14 +14,14 @@ const util_1 = require("../util");
 function handle(config) {
     return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
         const { files, type, provider } = req.body;
-        const existingSettings = yield (0, storage_1.getSyncSettings)(req.crowdinContext.clientId, req.crowdinContext.crowdinId, type, provider);
+        const existingSettings = yield (0, storage_1.getStorage)().getSyncSettings(req.crowdinContext.clientId, req.crowdinContext.crowdinId, type, provider);
         if (existingSettings) {
             (0, util_1.log)(`Updating sync settings for type ${type} and provider ${provider} ${JSON.stringify(files, null, 2)}`, config.logger);
-            yield (0, storage_1.updateSyncSettings)(JSON.stringify(files), req.crowdinContext.clientId, req.crowdinContext.crowdinId, type, provider);
+            yield (0, storage_1.getStorage)().updateSyncSettings(JSON.stringify(files), req.crowdinContext.clientId, req.crowdinContext.crowdinId, type, provider);
         }
         else {
             (0, util_1.log)(`Saving sync settings for type ${type} and provider ${provider} ${JSON.stringify(files, null, 2)}`, config.logger);
-            yield (0, storage_1.saveSyncSettings)(JSON.stringify(files), req.crowdinContext.clientId, req.crowdinContext.crowdinId, type, provider);
+            yield (0, storage_1.getStorage)().saveSyncSettings(JSON.stringify(files), req.crowdinContext.clientId, req.crowdinContext.crowdinId, type, provider);
         }
         res.status(204).end();
     }), config.onError);

package/out/handlers/sync-settings.js

@@ -16,7 +16,7 @@ function handle(config) {
         let files = {};
         const provider = req.params.provider;
         (0, util_1.log)(`Loading sync settings for provider ${provider}`, config.logger);
-        const syncSettings = yield (0, storage_1.getSyncSettingsByProvider)(req.crowdinContext.clientId, provider);
+        const syncSettings = yield (0, storage_1.getStorage)().getSyncSettingsByProvider(req.crowdinContext.clientId, provider);
         if (syncSettings) {
             files = JSON.parse(syncSettings.files) || [];
         }

package/out/handlers/uninstall.js

@@ -16,7 +16,7 @@ function handle(config) {
         const event = req.body;
         (0, util_1.log)(`Recieved uninstall request ${JSON.stringify(event, null, 2)}`, config.logger);
         const organization = (event.domain || event.organizationId).toString();
-        yield (0, storage_1.deleteCrowdinCredentials)(organization);
+        yield (0, storage_1.getStorage)().deleteCrowdinCredentials(organization);
         if (config.onUninstall) {
             yield config.onUninstall(organization);
         }

package/out/index.js

@@ -68,7 +68,7 @@ const defaults_1 = require("./util/defaults");
 var models_1 = require("./models");
 Object.defineProperty(exports, "Scope", { enumerable: true, get: function () { return models_1.Scope; } });
 function addCrowdinEndpoints(app, config) {
-    storage.connect(config.dbFolder);
+    storage.initialize(config);
     app.use(express_1.default.json({ limit: '50mb' }));
     app.use('/assets', express_1.default.static((0, path_1.join)(__dirname, 'static')));
     app.set('views', (0, path_1.join)(__dirname, 'views'));
@@ -132,8 +132,8 @@ function addCrowdinEndpoints(app, config) {
         }
     }
     if (config.customFileFormat) {
-        app.post('/process', (0, crowdin_client_1.default)(config), (0, process_1.default)(config, config.baseUrl, config.customFileFormat.filesFolder || config.dbFolder, config.customFileFormat));
-        app.get('/file/download', (0, download_1.default)(config, config.customFileFormat.filesFolder || config.dbFolder));
+        app.post('/process', (0, crowdin_client_1.default)(config), (0, process_1.default)(config, config.baseUrl, config.customFileFormat.filesFolder || config.dbFolder || '/', config.customFileFormat));
+        app.get('/file/download', (0, download_1.default)(config, config.customFileFormat.filesFolder || config.dbFolder || '/'));
     }
     if (config.customMT) {
         app.post('/translate', (0, crowdin_client_1.default)(config), (0, translate_1.default)(config, config.customMT));
@@ -161,19 +161,19 @@ function addCrowdinEndpoints(app, config) {
         app.use('/reports', (0, ui_module_1.default)(config), express_1.default.static(config.projectReports.uiPath));
     }
     return {
-        getMetadata: storage.getMetadata,
+        getMetadata: storage.getStorage().getMetadata,
         saveMetadata: (id, metadata) => __awaiter(this, void 0, void 0, function* () {
-            const existing = yield storage.getMetadata(id);
+            const existing = yield storage.getStorage().getMetadata(id);
             if (existing) {
-                yield storage.updateMetadata(id, metadata);
+                yield storage.getStorage().updateMetadata(id, metadata);
             }
             else {
-                yield storage.saveMetadata(id, metadata);
+                yield storage.getStorage().saveMetadata(id, metadata);
             }
         }),
-        deleteMetadata: storage.deleteMetadata,
+        deleteMetadata: storage.getStorage().deleteMetadata,
         getUserSettings: (clientId) => __awaiter(this, void 0, void 0, function* () {
-            const integrationCredentials = yield storage.getIntegrationCredentials(clientId);
+            const integrationCredentials = yield storage.getStorage().getIntegrationCredentials(clientId);
             if (integrationCredentials === null || integrationCredentials === void 0 ? void 0 : integrationCredentials.config) {
                 return JSON.parse(integrationCredentials.config);
             }

package/out/middlewares/crowdin-client.js

@@ -35,7 +35,7 @@ function prepareCrowdinRequest(jwtToken, config, optional = false, checkSubscrip
             crowdinId: `${jwtPayload.domain || jwtPayload.context.organization_id}`,
         };
         (0, util_1.log)('Loading crowdin credentials', config.logger);
-        const credentials = yield (0, storage_1.getCrowdinCredentials)(context.crowdinId);
+        const credentials = yield (0, storage_1.getStorage)().getCrowdinCredentials(context.crowdinId);
         if (!credentials) {
             if (optional) {
                 return { context };

package/out/middlewares/integration-credentials.js

@@ -16,7 +16,7 @@ function handle(config, integration, optional = false) {
     return (0, util_1.runAsyncWrapper)((req, res, next) => __awaiter(this, void 0, void 0, function* () {
         const clientId = req.crowdinContext.clientId;
         (0, util_1.log)(`Loading integration credentials for client ${clientId}`, config.logger);
-        const integrationCredentials = yield (0, storage_1.getIntegrationCredentials)(clientId);
+        const integrationCredentials = yield (0, storage_1.getStorage)().getIntegrationCredentials(clientId);
         if (!integrationCredentials) {
             if (optional) {
                 return next();

package/out/middlewares/ui-module.js

@@ -23,7 +23,7 @@ function handle(config) {
         const jwtPayload = yield (0, crowdin_apps_functions_1.validateJwtToken)(tokenJwt, config.clientSecret);
         const id = `${jwtPayload.domain || jwtPayload.context.organization_id}`;
         (0, util_1.log)('Loading crowdin credentials', config.logger);
-        const credentials = yield (0, storage_1.getCrowdinCredentials)(id);
+        const credentials = yield (0, storage_1.getStorage)().getCrowdinCredentials(id);
         if (!credentials) {
             throw new Error("Can't find organization by id");
         }

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 { PostgreStorageConfig } from '../storage/postgre';
 export interface Config extends ImagePath {
     /**
      * client id that we received when registering the app
@@ -45,7 +46,11 @@ export interface Config extends ImagePath {
     /**
      * folder where module will create sqlite db file to persist credentials (e.g. {@example __dirname})
      */
-    dbFolder: string;
+    dbFolder?: string;
+    /**
+     * config to configure PostgreSQL  as a storage
+     */
+    postgreConfig?: PostgreStorageConfig;
     /**
      * integration module logic
      */

package/out/storage/index.d.ts

@@ -1,22 +1,26 @@
-import { CrowdinCredentials, IntegrationCredentials, IntegrationSyncSettings } from '../models';
-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>;
-export declare function saveMetadata(id: string, metadata: any): Promise<void>;
-export declare function updateMetadata(id: string, metadata: any): Promise<void>;
-export declare function getMetadata(id: string): Promise<any | undefined>;
-export declare function deleteMetadata(id: string): Promise<void>;
-export declare function getSyncSettingsByProvider(integrationId: string, provider: string): Promise<IntegrationSyncSettings | undefined>;
-export declare function getAllSyncSettingsByType(type: string): Promise<IntegrationSyncSettings[]>;
-export declare function saveSyncSettings(files: any, integrationId: string, crowdinId: string, type: string, provider: string): Promise<void>;
-export declare function updateSyncSettings(files: any, integrationId: string, crowdinId: string, type: string, provider: string): Promise<void>;
-export declare function getSyncSettings(integrationId: string, crowdinId: string, type: string, provider: string): Promise<IntegrationSyncSettings | undefined>;
+import { Config, CrowdinCredentials, IntegrationCredentials, IntegrationSyncSettings } from '../models';
+export interface Storage<T> {
+    connect(config: T): 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 | undefined>;
+    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>;
+}
+export declare function initialize(config: Config): Promise<void>;
+export declare function getStorage(): Storage<any>;