@crowdin/app-project-module 0.82.1 → 0.83.0

package/out/index.js

@@ -37,6 +37,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.addCrowdinEndpoints = exports.createApp = exports.metadataStore = exports.express = exports.UserPermissions = exports.Scope = exports.ProjectPermissions = exports.maskKey = exports.postRequestCredentialsMasker = exports.getRequestCredentialsMasker = void 0;
 const logsFormatter = __importStar(require("@crowdin/logs-formatter"));
+const express_rate_limit_1 = require("express-rate-limit");
 const path_1 = require("path");
 const crowdin_client_1 = __importStar(require("./middlewares/crowdin-client"));
 const json_response_1 = __importDefault(require("./middlewares/json-response"));
@@ -46,6 +47,7 @@ const install_1 = __importDefault(require("./modules/install"));
 const manifest_1 = __importDefault(require("./modules/manifest"));
 const subscription_paid_1 = __importDefault(require("./modules/subscription-paid"));
 const uninstall_1 = __importDefault(require("./modules/uninstall"));
+const status_1 = __importDefault(require("./modules/status"));
 const storage = __importStar(require("./storage"));
 const types_1 = require("./types");
 const util_1 = require("./util");
@@ -94,6 +96,15 @@ exports.metadataStore = {
         return storage.getStorage().getMetadata(id);
     },
     saveMetadata: (id, metadata, crowdinId) => __awaiter(void 0, void 0, void 0, function* () {
+        if (!crowdinId) {
+            console.warn('Warning: The crowdinId parameter in saveMetadata will be required. Please update your code to provide this parameter.');
+        }
+        else {
+            const crowdinCredentials = yield storage.getStorage().getCrowdinCredentials(crowdinId);
+            if (!crowdinCredentials) {
+                console.error('Invalid crowdinId parameter: You can get your crowdinId from the JWT payload');
+            }
+        }
         const existing = yield storage.getStorage().getMetadata(id);
         if (existing) {
             yield storage.getStorage().updateMetadata(id, metadata, crowdinId);
@@ -121,6 +132,7 @@ function createApp(clientConfig) {
 }
 exports.createApp = createApp;
 function addCrowdinEndpoints(app, clientConfig) {
+    var _a, _b, _c;
     const config = convertClientConfig(clientConfig);
     if (!config.disableGlobalErrorHandling) {
         handleUncaughtErrors();
@@ -146,6 +158,21 @@ function addCrowdinEndpoints(app, clientConfig) {
     app.set('view engine', 'handlebars');
     app.get((0, util_1.getLogoUrl)(), (req, res) => res.sendFile(config.imagePath));
     app.get('/manifest.json', json_response_1.default, (0, manifest_1.default)(config));
+    if (((_a = config === null || config === void 0 ? void 0 : config.enableStatusPage) === null || _a === void 0 ? void 0 : _a.database) || ((_b = config === null || config === void 0 ? void 0 : config.enableStatusPage) === null || _b === void 0 ? void 0 : _b.filesystem)) {
+        app.set('trust proxy', 1);
+        const limiter = (0, express_rate_limit_1.rateLimit)({
+            windowMs: 60 * 1000,
+            limit: ((_c = config.enableStatusPage) === null || _c === void 0 ? void 0 : _c.rateLimit) || 10,
+            standardHeaders: true,
+            legacyHeaders: false,
+            message: {
+                status: 429,
+                error: 'Too Many Requests',
+                message: 'Rate limit exceeded. Please try again later.',
+            },
+        });
+        app.get('/status', limiter, (0, status_1.default)(config));
+    }
     if (!(0, subscription_1.isAppFree)(config)) {
         app.post('/subscription-paid', (0, subscription_paid_1.default)());
     }
@@ -258,6 +285,7 @@ function convertClientConfig(clientConfig) {
     if (clientConfig.projectIntegration) {
         clientConfig.api = Object.assign({ default: true }, clientConfig.api);
     }
+    clientConfig.enableStatusPage = Object.assign({ database: true, filesystem: true }, (clientConfig.enableStatusPage || {}));
     return Object.assign(Object.assign({}, clientConfig), { baseUrl: baseUrl.endsWith('/') ? baseUrl.slice(0, -1) : baseUrl, clientId,
         clientSecret, awsConfig: {
             tmpBucketName,

package/out/modules/integration/handlers/oauth-login.js

@@ -17,6 +17,7 @@ const util_1 = require("../../../util");
 const defaults_1 = require("../util/defaults");
 const logger_1 = require("../../../util/logger");
 const storage_1 = require("../../../storage");
+const crowdin_apps_functions_1 = require("@crowdin/crowdin-apps-functions");
 function handle(config, integration) {
     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, _l, _m, _o, _p;
@@ -28,6 +29,7 @@ function handle(config, integration) {
         (0, logger_1.log)(`Received request from OAuth login callback. Code ${code}`);
         (0, logger_1.log)(`Received request from OAuth login callback. State ${state}`);
         const clientId = Buffer.from(state, 'base64').toString();
+        const { organization } = (0, crowdin_apps_functions_1.parseCrowdinId)(clientId);
         const redirectUri = `${config.baseUrl}${(0, defaults_1.getOauthRoute)(integration)}`;
         try {
             const oauthLogin = integration.oauthLogin;
@@ -61,7 +63,7 @@ function handle(config, integration) {
             message.data = oauthCredentials;
             if (((_o = integration.oauthLogin) === null || _o === void 0 ? void 0 : _o.mode) === 'polling') {
                 yield (0, storage_1.getStorage)().deleteMetadata((0, defaults_1.getOAuthPollingId)(clientId));
-                yield (0, storage_1.getStorage)().saveMetadata((0, defaults_1.getOAuthPollingId)(clientId), oauthCredentials);
+                yield (0, storage_1.getStorage)().saveMetadata((0, defaults_1.getOAuthPollingId)(clientId), oauthCredentials, organization);
             }
             return res.render('oauth', { message: JSON.stringify(message), oauthMode: (_p = integration.oauthLogin) === null || _p === void 0 ? void 0 : _p.mode });
         }

package/out/modules/integration/handlers/oauth-url.js

@@ -23,7 +23,7 @@ function handle(config, integration) {
         }
         const { loginForm } = req.body;
         yield (0, storage_1.getStorage)().deleteMetadata((0, defaults_1.getOAuthLoginFormId)(req.crowdinContext.clientId));
-        yield (0, storage_1.getStorage)().saveMetadata((0, defaults_1.getOAuthLoginFormId)(req.crowdinContext.clientId), loginForm);
+        yield (0, storage_1.getStorage)().saveMetadata((0, defaults_1.getOAuthLoginFormId)(req.crowdinContext.clientId), loginForm, req.crowdinContext.crowdinId);
         const url = (0, defaults_1.constructOauthUrl)({ config, integration, clientId: req.crowdinContext.clientId, loginForm });
         res.send({ url });
     }));

package/out/modules/manifest.js

@@ -359,7 +359,7 @@ function handle(config) {
         const manifest = Object.assign(Object.assign(Object.assign(Object.assign({ identifier: config.identifier, name: config.name, logo: (0, util_1.getLogoUrl)(), baseUrl: config.baseUrl, authentication: {
                 type: config.authenticationType || types_1.AuthenticationType.APP,
                 clientId: config.clientId,
-            } }, (config.agent && { agent: config.agent })), { events, scopes: config.scopes ? config.scopes : defaultScopes }), (config.defaultPermissions && { default_permissions: config.defaultPermissions })), { modules });
+            }, restrictAiToSameApp: config.restrictAiToSameApp }, (config.agent && { agent: config.agent })), { events, scopes: config.scopes ? config.scopes : defaultScopes }), (config.defaultPermissions && { default_permissions: config.defaultPermissions })), { modules });
         res.send(manifest);
     };
 }

package/out/modules/status.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="qs" />
+import { Request, Response } from 'express';
+import { Config, UnauthorizedConfig } from '../types';
+export default function handle(config: Config | UnauthorizedConfig): (req: import("../types").CrowdinClientRequest | 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/modules/status.js

@@ -0,0 +1,74 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const util_1 = require("../util");
+const logger_1 = require("../util/logger");
+const storage_1 = require("../storage");
+const promises_1 = __importDefault(require("fs/promises"));
+const path_1 = __importDefault(require("path"));
+const os_1 = __importDefault(require("os"));
+function handle(config) {
+    return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
+        var _a, _b;
+        const response = {
+            status: 'ok',
+            timestamp: new Date().toISOString(),
+        };
+        let hasError = false;
+        if (((_a = config === null || config === void 0 ? void 0 : config.enableStatusPage) === null || _a === void 0 ? void 0 : _a.database) === true) {
+            let status = 'ok';
+            let message = 'Database connection successful';
+            try {
+                yield (0, storage_1.getStorage)().getAllMetadata();
+            }
+            catch (e) {
+                status = 'error';
+                message = (e === null || e === void 0 ? void 0 : e.message) || 'Database connection error';
+                hasError = true;
+                (0, logger_1.logError)(e);
+            }
+            response.database = {
+                status,
+                message,
+            };
+        }
+        if (((_b = config === null || config === void 0 ? void 0 : config.enableStatusPage) === null || _b === void 0 ? void 0 : _b.filesystem) === true) {
+            let status = 'ok';
+            let message = 'Filesystem access successful';
+            try {
+                const testFile = path_1.default.join(os_1.default.tmpdir(), 'status-check.txt');
+                yield promises_1.default.writeFile(testFile, 'test');
+                yield promises_1.default.unlink(testFile);
+            }
+            catch (e) {
+                status = 'error';
+                message = (e === null || e === void 0 ? void 0 : e.message) || 'Filesystem error';
+                hasError = true;
+                (0, logger_1.logError)(e);
+            }
+            response.filesystem = {
+                status,
+                message,
+            };
+        }
+        if (hasError) {
+            response.status = 'error';
+            res.status(503).json(response);
+        }
+        else {
+            res.json(response);
+        }
+    }));
+}
+exports.default = handle;