@crowdin/app-project-module 0.28.0-11 → 0.28.0-13

package/out/handlers/file-processing/file-download.js

@@ -16,7 +16,7 @@ const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const util_1 = require("../../util");
 function handle(config, processingConfig, folderName) {
-    const folder = processingConfig.filesFolder || config.dbFolder || '/';
+    const folder = processingConfig.filesFolder || config.dbFolder;
     return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
         const filePath = path_1.default.join(folder, folderName, req.query.file);
         (0, util_1.log)(`Downloading file ${filePath}`, config.logger);

package/out/handlers/file-processing/pre-post-process.js

@@ -18,7 +18,7 @@ const models_1 = require("../../models");
 const util_1 = require("../../util");
 const files_1 = require("../../util/files");
 function handle(baseConfig, config, folderName) {
-    const folderPath = config.filesFolder || baseConfig.dbFolder || '/';
+    const folderPath = config.filesFolder || baseConfig.dbFolder;
     if (!fs_1.default.existsSync(path_1.default.join(folderPath, folderName))) {
         fs_1.default.mkdirSync(path_1.default.join(folderPath, folderName), { recursive: true });
     }
@@ -44,7 +44,7 @@ function handle(baseConfig, config, folderName) {
         switch (body.jobType) {
             case models_1.ProcessFileJobType.PRE_IMPORT:
             case models_1.ProcessFileJobType.POST_EXPORT:
-                const { contentFile, fileName, error: contentFileError } = fileProcessResult;
+                const { contentFile, fileName, fileType, error: contentFileError, } = fileProcessResult;
                 if (contentFile) {
                     const contentFileEncoded = Buffer.from(contentFile).toString('base64');
                     if (Buffer.byteLength(contentFileEncoded, 'utf8') < files_1.MAX_BODY_SIZE) {
@@ -65,6 +65,9 @@ function handle(baseConfig, config, folderName) {
                 if (fileName) {
                     response.fileName = fileName;
                 }
+                if (fileType) {
+                    response.fileType = fileType;
+                }
                 processingError = contentFileError;
                 break;
             case models_1.ProcessFileJobType.POST_IMPORT:

package/out/index.d.ts

@@ -1,5 +1,5 @@
 import { Express } from 'express';
-import { Config, CrowdinAppUtilities } from './models';
+import { ClientConfig, Config, CrowdinAppUtilities } from './models';
 export { Scope } from './models';
-export declare function addCrowdinEndpoints(app: Express, plainConfig: Config): CrowdinAppUtilities;
-export declare function createApp(config: Config): void;
+export declare function addCrowdinEndpoints(app: Express, clientConfig: Config | ClientConfig): CrowdinAppUtilities;
+export declare function createApp(clientConfig: ClientConfig): void;

package/out/index.js

@@ -45,23 +45,23 @@ const crowdin_files_1 = __importDefault(require("./handlers/crowdin-files"));
 const crowdin_project_1 = __importDefault(require("./handlers/crowdin-project"));
 const crowdin_update_1 = __importDefault(require("./handlers/crowdin-update"));
 const crowdin_webhook_1 = __importDefault(require("./handlers/crowdin-webhook"));
-const integration_webhook_1 = __importDefault(require("./handlers/integration-webhook"));
-const file_download_1 = __importDefault(require("./handlers/file-processing/file-download"));
+const translate_1 = __importDefault(require("./handlers/custom-mt/translate"));
 const custom_file_format_1 = __importDefault(require("./handlers/file-processing/custom-file-format"));
+const file_download_1 = __importDefault(require("./handlers/file-processing/file-download"));
 const pre_post_process_1 = __importDefault(require("./handlers/file-processing/pre-post-process"));
-const translate_1 = __importDefault(require("./handlers/custom-mt/translate"));
+const form_data_display_1 = __importDefault(require("./handlers/form-data-display"));
+const form_data_save_1 = __importDefault(require("./handlers/form-data-save"));
 const install_1 = __importDefault(require("./handlers/install"));
 const integration_data_1 = __importDefault(require("./handlers/integration-data"));
 const integration_login_1 = __importDefault(require("./handlers/integration-login"));
 const integration_logout_1 = __importDefault(require("./handlers/integration-logout"));
 const integration_update_1 = __importDefault(require("./handlers/integration-update"));
+const integration_webhook_1 = __importDefault(require("./handlers/integration-webhook"));
 const main_1 = __importDefault(require("./handlers/main"));
 const manifest_1 = __importDefault(require("./handlers/manifest"));
 const oauth_login_1 = __importDefault(require("./handlers/oauth-login"));
 const oauth_url_1 = __importDefault(require("./handlers/oauth-url"));
 const settings_save_1 = __importDefault(require("./handlers/settings-save"));
-const form_data_display_1 = __importDefault(require("./handlers/form-data-display"));
-const form_data_save_1 = __importDefault(require("./handlers/form-data-save"));
 const subscription_info_1 = __importDefault(require("./handlers/subscription-info"));
 const subscription_paid_1 = __importDefault(require("./handlers/subscription-paid"));
 const sync_settings_1 = __importDefault(require("./handlers/sync-settings"));
@@ -70,8 +70,8 @@ const uninstall_1 = __importDefault(require("./handlers/uninstall"));
 const crowdin_client_1 = __importStar(require("./middlewares/crowdin-client"));
 const integration_credentials_1 = __importDefault(require("./middlewares/integration-credentials"));
 const json_response_1 = __importDefault(require("./middlewares/json-response"));
-const ui_module_1 = __importDefault(require("./middlewares/ui-module"));
 const render_ui_module_1 = __importDefault(require("./middlewares/render-ui-module"));
+const ui_module_1 = __importDefault(require("./middlewares/ui-module"));
 const models_1 = require("./models");
 const storage = __importStar(require("./storage"));
 const util_1 = require("./util");
@@ -81,12 +81,12 @@ const defaults_1 = require("./util/defaults");
 const webhooks_1 = require("./util/webhooks");
 var models_2 = require("./models");
 Object.defineProperty(exports, "Scope", { enumerable: true, get: function () { return models_2.Scope; } });
-function addCrowdinEndpoints(app, plainConfig) {
+function addCrowdinEndpoints(app, clientConfig) {
     var _a, _b, _c;
-    if (!plainConfig.disableGlobalErrorHandling) {
-        handleUncaughtErrors(plainConfig);
+    const config = (0, defaults_1.convertClientConfig)(clientConfig);
+    if (!config.disableGlobalErrorHandling) {
+        handleUncaughtErrors(config);
     }
-    const config = Object.assign(Object.assign({}, plainConfig), { baseUrl: plainConfig.baseUrl.endsWith('/') ? plainConfig.baseUrl.slice(0, -1) : plainConfig.baseUrl });
     storage.initialize(config);
     app.use(express_1.default.json({ limit: '50mb' }));
     app.use('/assets', express_1.default.static((0, path_1.join)(__dirname, 'static')));
@@ -119,7 +119,7 @@ function addCrowdinEndpoints(app, plainConfig) {
         },
     }));
     app.set('view engine', 'handlebars');
-    app.get('/logo.png', (req, res) => res.sendFile(config.imagePath || (0, path_1.join)(__dirname, 'logo.png')));
+    app.get('/logo.png', (req, res) => res.sendFile(config.imagePath));
     app.post('/installed', (0, install_1.default)(config));
     app.post('/uninstall', (0, uninstall_1.default)(config));
     app.get('/manifest.json', json_response_1.default, (0, manifest_1.default)(config));
@@ -128,8 +128,8 @@ function addCrowdinEndpoints(app, plainConfig) {
     }
     const integrationLogic = config.projectIntegration;
     if (integrationLogic) {
-        (0, defaults_1.applyDefaults)(config, integrationLogic);
-        app.get('/logo/integration/logo.png', (req, res) => res.sendFile(integrationLogic.imagePath || config.imagePath || (0, path_1.join)(__dirname, 'logo.png')));
+        (0, defaults_1.applyIntegrationModuleDefaults)(config, integrationLogic);
+        app.get('/logo/integration/logo.png', (req, res) => res.sendFile(integrationLogic.imagePath || config.imagePath));
         app.get('/', (0, crowdin_client_1.default)(config, true, false), (0, integration_credentials_1.default)(config, integrationLogic, true), (0, main_1.default)(config, integrationLogic));
         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, integrationLogic));
@@ -174,7 +174,7 @@ function addCrowdinEndpoints(app, plainConfig) {
         }
     }
     if (config.customFileFormat) {
-        app.post('/process', (0, crowdin_client_1.default)(config), (0, custom_file_format_1.default)(config, config.baseUrl, config.customFileFormat.filesFolder || config.dbFolder || '/', config.customFileFormat));
+        app.post('/process', (0, crowdin_client_1.default)(config), (0, custom_file_format_1.default)(config, config.baseUrl, config.customFileFormat.filesFolder || config.dbFolder, config.customFileFormat));
         app.get('/file/download', (0, file_download_1.default)(config, config.customFileFormat, 'custom-file-format'));
     }
     if (config.filePreImport) {
@@ -194,15 +194,15 @@ function addCrowdinEndpoints(app, plainConfig) {
         app.get(`/file/download/${models_1.ProcessFileJobType.POST_EXPORT}`, (0, file_download_1.default)(config, config.filePostExport, models_1.ProcessFileJobType.POST_EXPORT));
     }
     if (config.customMT) {
-        app.get('/logo/mt/logo.png', (req, res) => { var _a; return res.sendFile(((_a = config.customMT) === null || _a === void 0 ? void 0 : _a.imagePath) || config.imagePath || (0, path_1.join)(__dirname, 'logo.png')); });
+        app.get('/logo/mt/logo.png', (req, res) => { var _a; return res.sendFile(((_a = config.customMT) === null || _a === void 0 ? void 0 : _a.imagePath) || config.imagePath); });
         app.post('/translate', (0, crowdin_client_1.default)(config), (0, translate_1.default)(config, config.customMT));
     }
     if (config.profileResourcesMenu) {
-        app.get('/logo/resources/logo.png', (req, res) => { var _a; return res.sendFile(((_a = config.profileResourcesMenu) === null || _a === void 0 ? void 0 : _a.imagePath) || config.imagePath || (0, path_1.join)(__dirname, 'logo.png')); });
+        app.get('/logo/resources/logo.png', (req, res) => { var _a; return res.sendFile(((_a = config.profileResourcesMenu) === null || _a === void 0 ? void 0 : _a.imagePath) || config.imagePath); });
         app.use('/resources', (0, ui_module_1.default)(config, config.profileResourcesMenu.allowUnauthorized), (0, render_ui_module_1.default)(config, config.profileResourcesMenu));
     }
     if (config.organizationMenu) {
-        app.get('/logo/resources/logo.png', (req, res) => { var _a; return res.sendFile(((_a = config.organizationMenu) === null || _a === void 0 ? void 0 : _a.imagePath) || config.imagePath || (0, path_1.join)(__dirname, 'logo.png')); });
+        app.get('/logo/resources/logo.png', (req, res) => { var _a; return res.sendFile(((_a = config.organizationMenu) === null || _a === void 0 ? void 0 : _a.imagePath) || config.imagePath); });
         app.use('/resources', (0, ui_module_1.default)(config, config.organizationMenu.allowUnauthorized), (0, render_ui_module_1.default)(config, config.organizationMenu));
     }
     if (config.editorRightPanel) {
@@ -215,11 +215,11 @@ function addCrowdinEndpoints(app, plainConfig) {
         app.use('/project-menu-crowdsource', (0, ui_module_1.default)(config, config.projectMenuCrowdsource.allowUnauthorized), (0, render_ui_module_1.default)(config, config.projectMenuCrowdsource));
     }
     if (config.projectTools) {
-        app.get('/logo/tools/logo.png', (req, res) => { var _a; return res.sendFile(((_a = config.projectTools) === null || _a === void 0 ? void 0 : _a.imagePath) || config.imagePath || (0, path_1.join)(__dirname, 'logo.png')); });
+        app.get('/logo/tools/logo.png', (req, res) => { var _a; return res.sendFile(((_a = config.projectTools) === null || _a === void 0 ? void 0 : _a.imagePath) || config.imagePath); });
         app.use('/tools', (0, ui_module_1.default)(config, config.projectTools.allowUnauthorized), (0, render_ui_module_1.default)(config, config.projectTools));
     }
     if (config.projectReports) {
-        app.get('/logo/reports/logo.png', (req, res) => { var _a; return res.sendFile(((_a = config.projectReports) === null || _a === void 0 ? void 0 : _a.imagePath) || config.imagePath || (0, path_1.join)(__dirname, 'logo.png')); });
+        app.get('/logo/reports/logo.png', (req, res) => { var _a; return res.sendFile(((_a = config.projectReports) === null || _a === void 0 ? void 0 : _a.imagePath) || config.imagePath); });
         app.use('/reports', (0, ui_module_1.default)(config, config.projectReports.allowUnauthorized), (0, render_ui_module_1.default)(config, config.projectReports));
     }
     if (Object.keys(config).some((moduleKey) => {
@@ -251,11 +251,12 @@ function addCrowdinEndpoints(app, plainConfig) {
     };
 }
 exports.addCrowdinEndpoints = addCrowdinEndpoints;
-function createApp(config) {
+function createApp(clientConfig) {
     const app = (0, express_1.default)();
+    const config = (0, defaults_1.convertClientConfig)(clientConfig);
     addCrowdinEndpoints(app, config);
     /* eslint no-console: "off" */
-    app.listen(config.port || 3000, () => console.log(`App started on port ${config.port || 3000}`));
+    app.listen(config.port, () => console.log(`App started on port ${config.port}`));
 }
 exports.createApp = createApp;
 function handleUncaughtErrors(config) {

package/out/models/index.d.ts

@@ -3,7 +3,7 @@ import { JwtPayload, VerifyOptions } from '@crowdin/crowdin-apps-functions';
 import { Request } from 'express';
 import { MySQLStorageConfig } from '../storage/mysql';
 import { PostgreStorageConfig } from '../storage/postgre';
-export interface Config extends ImagePath {
+export interface ClientConfig extends ImagePath {
     /**
      * Authentication Crowdin App type: "authorization_code", "crowdin_app". Default: "crowdin_app"
      */
@@ -11,11 +11,11 @@ export interface Config extends ImagePath {
     /**
      * client id that we received when registering the app
      */
-    clientId: string;
+    clientId?: string;
     /**
      * client secret that we received when registering the app
      */
-    clientSecret: string;
+    clientSecret?: string;
     /**
      * Secret to encrypt/decrypt credentials (by default @clientSecret will be used)
      */
@@ -27,7 +27,7 @@ export interface Config extends ImagePath {
     /**
      * https url where an app is reachable from the internet (e.g. the one that ngrok generates for us)
      */
-    baseUrl: string;
+    baseUrl?: string;
     /**
      * define custom Crowdin urls (e.g. to work against local Crowdin server)
      */
@@ -132,6 +132,14 @@ export interface Config extends ImagePath {
     filePreExport?: FilePreExportLogic;
     filePostExport?: FilePostExportLogic;
 }
+export type Config = ClientConfig & {
+    baseUrl: string;
+    clientId: string;
+    clientSecret: string;
+    port: number;
+    dbFolder: string;
+    imagePath: string;
+};
 export declare enum AuthenticationType {
     CODE = "authorization_code",
     APP = "crowdin_app"
@@ -593,6 +601,7 @@ export interface BuildFileResponse {
     contentFile: string;
     error?: string;
     fileName?: string;
+    fileType?: string;
 }
 export interface ProcessFileString {
     previewId?: number;

package/out/storage/index.js

@@ -17,20 +17,17 @@ const sqlite_1 = require("./sqlite");
 let storage;
 function initialize(config) {
     return __awaiter(this, void 0, void 0, function* () {
-        if (config.dbFolder) {
-            (0, util_1.log)('Using SQLite database', config.logger);
-            storage = new sqlite_1.SQLiteStorage({ dbFolder: config.dbFolder });
-        }
         if (config.postgreConfig) {
             (0, util_1.log)('Using PostgreSQL database', config.logger);
             storage = new postgre_1.PostgreStorage(config.postgreConfig);
         }
-        if (config.mysqlConfig) {
+        else if (config.mysqlConfig) {
             (0, util_1.log)('Using MySQL database', config.logger);
             storage = new mysql_1.MySQLStorage(config.mysqlConfig);
         }
-        if (!storage) {
-            throw new Error('Database is not configured');
+        else {
+            (0, util_1.log)('Using SQLite database', config.logger);
+            storage = new sqlite_1.SQLiteStorage({ dbFolder: config.dbFolder });
         }
         yield storage.migrate();
     });

package/out/util/defaults.d.ts

@@ -1,6 +1,7 @@
 import Crowdin, { SourceFilesModel } from '@crowdin/crowdin-api-client';
-import { Config, IntegrationLogic } from '../models';
+import { ClientConfig, Config, IntegrationLogic } from '../models';
 export declare function getRootFolder(config: Config, integration: IntegrationLogic, client: Crowdin, projectId: number): Promise<SourceFilesModel.Directory | undefined>;
 export declare function getOauthRoute(integration: IntegrationLogic): string;
-export declare function applyDefaults(config: Config, integration: IntegrationLogic): void;
+export declare function applyIntegrationModuleDefaults(config: Config, integration: IntegrationLogic): void;
 export declare function constructOauthUrl(config: Config, integration: IntegrationLogic): string;
+export declare function convertClientConfig(clientConfig: ClientConfig): Config;

package/out/util/defaults.js

@@ -32,8 +32,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.constructOauthUrl = exports.applyDefaults = exports.getOauthRoute = exports.getRootFolder = void 0;
+exports.convertClientConfig = exports.constructOauthUrl = exports.applyIntegrationModuleDefaults = exports.getOauthRoute = exports.getRootFolder = void 0;
 const crowdinAppFunctions = __importStar(require("@crowdin/crowdin-apps-functions"));
+const path_1 = require("path");
 function getRootFolder(config, integration, client, projectId) {
     return __awaiter(this, void 0, void 0, function* () {
         if (!integration.withRootFolder) {
@@ -56,7 +57,7 @@ function getOauthRoute(integration) {
     return ((_a = integration.oauthLogin) === null || _a === void 0 ? void 0 : _a.redirectUriRoute) || '/oauth/code';
 }
 exports.getOauthRoute = getOauthRoute;
-function applyDefaults(config, integration) {
+function applyIntegrationModuleDefaults(config, integration) {
     var _a;
     if (!integration.getCrowdinFiles) {
         integration.getCrowdinFiles = (projectId, client, rootFolder) => __awaiter(this, void 0, void 0, function* () {
@@ -245,7 +246,7 @@ function applyDefaults(config, integration) {
         integration.webhooks.urlParam = 'crowdinData';
     }
 }
-exports.applyDefaults = applyDefaults;
+exports.applyIntegrationModuleDefaults = applyIntegrationModuleDefaults;
 function constructOauthUrl(config, integration) {
     var _a, _b, _c;
     const oauth = integration.oauthLogin;
@@ -261,3 +262,15 @@ function constructOauthUrl(config, integration) {
     return url;
 }
 exports.constructOauthUrl = constructOauthUrl;
+function convertClientConfig(clientConfig) {
+    const baseUrl = clientConfig.baseUrl || process.env.URL;
+    const clientId = clientConfig.clientId || process.env.CROWDIN_CLIENT_ID;
+    const clientSecret = clientConfig.clientSecret || process.env.CROWDIN_CLIENT_SECRET;
+    const port = clientConfig.port || process.env.PORT || 3000;
+    if (!baseUrl || !clientId || !clientSecret) {
+        throw new Error('One of following parameters are not defined [baseUrl, clientId, clientSecret]');
+    }
+    return Object.assign(Object.assign({}, clientConfig), { baseUrl: baseUrl.endsWith('/') ? baseUrl.slice(0, -1) : baseUrl, clientId,
+        clientSecret, port: Number(port), dbFolder: clientConfig.dbFolder || (0, path_1.join)(process.cwd(), 'db'), imagePath: clientConfig.imagePath || (0, path_1.join)(process.cwd(), 'logo.png') });
+}
+exports.convertClientConfig = convertClientConfig;

package/package.json

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