@crowdin/app-project-module 0.61.0 → 0.63.0

package/out/types.d.ts

@@ -364,6 +364,10 @@ export interface UiModule {
      * Module name
      */
     name?: string;
+    /**
+     * Temporary property. Indicates if passwords should be masked. Will be dropped when all existing apps will migrate.
+     */
+    maskPasswords?: boolean;
 }
 export interface ImagePath {
     /**

package/out/util/credentials-masker.d.ts

@@ -0,0 +1,6 @@
+/// <reference types="qs" />
+import { CrowdinClientRequest, UiModule } from '../types';
+import { Request, Response } from 'express';
+declare function postRequestCredentialsMasker(moduleConfig?: UiModule, credentialsExtractor?: Function): (req: 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;
+declare function getRequestCredentialsMasker(moduleConfig?: UiModule): (req: Request | CrowdinClientRequest, res: Response, next: Function) => any;
+export { getRequestCredentialsMasker, postRequestCredentialsMasker };

package/out/util/credentials-masker.js

@@ -0,0 +1,102 @@
+"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 });
+exports.postRequestCredentialsMasker = exports.getRequestCredentialsMasker = void 0;
+const lodash_1 = __importDefault(require("lodash"));
+const index_1 = require("./index");
+const index_2 = require("../index");
+const crowdin_client_1 = require("../middlewares/crowdin-client");
+const crowdin_apps_functions_1 = require("@crowdin/crowdin-apps-functions");
+function maskKey(key) {
+    const maskWith = '*';
+    const unmaskedCharsAtEnd = 3;
+    const repeatCount = key.length > unmaskedCharsAtEnd ? key.length - unmaskedCharsAtEnd : 0;
+    return maskWith.repeat(repeatCount) + key.substring(key.length - 3);
+}
+function getMaskableFieldsKeys(moduleConfig) {
+    if (!moduleConfig.formUiSchema) {
+        return [];
+    }
+    return Object.keys(moduleConfig.formUiSchema).filter((fieldKey) => {
+        return lodash_1.default.get(moduleConfig, `formUiSchema[${fieldKey}]['ui:widget']`) === 'password';
+    });
+}
+function postRequestCredentialsMasker(moduleConfig, credentialsExtractor) {
+    return (0, index_1.runAsyncWrapper)((req, res, next) => __awaiter(this, void 0, void 0, function* () {
+        if (!moduleConfig || !moduleConfig.formSchema || !moduleConfig.formUiSchema) {
+            return next();
+        }
+        // temporary
+        if (!moduleConfig.maskPasswords) {
+            return next();
+        }
+        const fieldsKeysInRequest = Object.keys(req.body.data);
+        let unmaskedFields = {};
+        if (credentialsExtractor) {
+            unmaskedFields = yield credentialsExtractor(req, res);
+        }
+        else {
+            // most common way of storing data
+            const jwtToken = (0, crowdin_client_1.getToken)(req) || '';
+            const jwtPayload = yield (0, crowdin_apps_functions_1.validateJwtToken)(jwtToken, process.env.CROWDIN_CLIENT_SECRET || '');
+            const crowdinId = `${jwtPayload.context.organization_id}`;
+            unmaskedFields = yield index_2.metadataStore.getMetadata(`form-data-${crowdinId}`);
+        }
+        unmaskedFields = unmaskedFields || {};
+        const maskableFieldsKeys = getMaskableFieldsKeys(moduleConfig);
+        Object.keys(unmaskedFields).forEach((fieldKey) => {
+            if (!maskableFieldsKeys.includes(fieldKey) || !fieldsKeysInRequest.includes(fieldKey)) {
+                delete unmaskedFields[fieldKey];
+            }
+        });
+        req.body.data = Object.assign(Object.assign({}, req.body.data), Object.keys(unmaskedFields).reduce((acc, key) => {
+            if (maskKey(unmaskedFields[key]) === req.body.data[key]) {
+                acc[key] = unmaskedFields[key];
+            }
+            return acc;
+        }, {}));
+        next();
+    }));
+}
+exports.postRequestCredentialsMasker = postRequestCredentialsMasker;
+function getRequestCredentialsMasker(moduleConfig) {
+    return function (req, res, next) {
+        // we can't find "password" fields without ui schema
+        if (!moduleConfig || !moduleConfig.formSchema || !moduleConfig.formUiSchema) {
+            return next();
+        }
+        // temporary
+        if (!moduleConfig.maskPasswords) {
+            return next();
+        }
+        const maskableFieldsKeys = getMaskableFieldsKeys(moduleConfig);
+        if (!maskableFieldsKeys.length) {
+            return next();
+        }
+        const originalSend = res.send;
+        res.send = function (body) {
+            if (body.formData) {
+                maskableFieldsKeys.forEach((fieldKey) => {
+                    if (!body.formData[fieldKey]) {
+                        return;
+                    }
+                    body.formData[fieldKey] = maskKey(body.formData[fieldKey]);
+                });
+            }
+            return originalSend.apply(res, [body]);
+        };
+        return next();
+    };
+}
+exports.getRequestCredentialsMasker = getRequestCredentialsMasker;

package/out/util/form-schema.d.ts

@@ -0,0 +1,3 @@
+import { UiModule } from '../types';
+export declare function getLowCodeUiConfigFromModuleConfig(moduleConfig: any): UiModule | null;
+export declare function hasFormSchema(moduleConfig: any): boolean;

package/out/util/form-schema.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hasFormSchema = exports.getLowCodeUiConfigFromModuleConfig = void 0;
+function getLowCodeUiConfigFromModuleConfig(moduleConfig) {
+    var _a;
+    if (typeof moduleConfig !== 'object' || moduleConfig === null) {
+        return null;
+    }
+    if ((_a = moduleConfig.settingsUiModule) === null || _a === void 0 ? void 0 : _a.formSchema) {
+        return moduleConfig.settingsUiModule;
+    }
+    if (moduleConfig.formSchema) {
+        return moduleConfig;
+    }
+    return null;
+}
+exports.getLowCodeUiConfigFromModuleConfig = getLowCodeUiConfigFromModuleConfig;
+function hasFormSchema(moduleConfig) {
+    return !!getLowCodeUiConfigFromModuleConfig(moduleConfig);
+}
+exports.hasFormSchema = hasFormSchema;

package/out/util/index.d.ts

@@ -10,4 +10,3 @@ export declare function decryptData(config: Config, data: string): string;
 export declare function executeWithRetry<T>(func: () => Promise<T>, numOfRetries?: number): Promise<T>;
 export declare function getLogoUrl(moduleConfig?: ImagePath, modulePath?: string): string;
 export declare function isAuthorizedConfig(config: Config | UnauthorizedConfig): config is Config;
-export declare function hasFormSchema(moduleConfig: any): boolean;

package/out/util/index.js

@@ -32,7 +32,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.hasFormSchema = exports.isAuthorizedConfig = exports.getLogoUrl = exports.executeWithRetry = exports.decryptData = exports.encryptData = exports.runAsyncWrapper = exports.CodeError = void 0;
+exports.isAuthorizedConfig = exports.getLogoUrl = exports.executeWithRetry = exports.decryptData = exports.encryptData = exports.runAsyncWrapper = exports.CodeError = void 0;
 const crypto = __importStar(require("crypto-js"));
 const storage_1 = require("../storage");
 const types_1 = require("../types");
@@ -118,11 +118,3 @@ function isAuthorizedConfig(config) {
     return !!config.clientId && !!config.clientSecret && config.authenticationType !== types_1.AuthenticationType.NONE;
 }
 exports.isAuthorizedConfig = isAuthorizedConfig;
-function hasFormSchema(moduleConfig) {
-    var _a;
-    if (typeof moduleConfig === 'object' && moduleConfig !== null) {
-        return moduleConfig.formSchema || ((_a = moduleConfig.settingsUiModule) === null || _a === void 0 ? void 0 : _a.formSchema);
-    }
-    return false;
-}
-exports.hasFormSchema = hasFormSchema;

package/package.json

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