@crowdin/app-project-module 0.42.0 → 0.43.0

package/out/handlers/custom-spell-check/get-languages-list.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="qs" />
+import { Response } from 'express';
+import { CrowdinClientRequest, CustomSpellcheckerModule } from '../../models';
+export default function handle(customSpellchecker: CustomSpellcheckerModule): (req: CrowdinClientRequest | 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/custom-spell-check/get-languages-list.js

@@ -0,0 +1,29 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const util_1 = require("../../util");
+const logger_1 = require("../../util/logger");
+function handle(customSpellchecker) {
+    return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
+        try {
+            const data = yield customSpellchecker.getSupportedLanguage({
+                client: req.crowdinApiClient,
+                context: req.crowdinContext,
+            });
+            res.send({ data });
+        }
+        catch (e) {
+            req.logError(e);
+            res.send({ error: { message: (0, logger_1.getErrorMessage)(e) } });
+        }
+    }));
+}
+exports.default = handle;

package/out/handlers/custom-spell-check/spell-check.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="qs" />
+import { Response } from 'express';
+import { CrowdinClientRequest, CustomSpellcheckerModule } from '../../models';
+export default function handle(customSpellchecker: CustomSpellcheckerModule): (req: CrowdinClientRequest | 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/custom-spell-check/spell-check.js

@@ -0,0 +1,34 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const util_1 = require("../../util");
+const logger_1 = require("../../util/logger");
+function handle(customSpellchecker) {
+    return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
+        const body = req.body;
+        (0, logger_1.log)('Received request for custom spellcheck');
+        (0, logger_1.log)(`Language ${body.language}, Payload ${JSON.stringify(body, null, 2)}`);
+        try {
+            const response = yield customSpellchecker.runSpellCheck({
+                client: req.crowdinApiClient,
+                context: req.crowdinContext,
+                language: body.language,
+                texts: body.texts,
+            });
+            res.send({ data: response.texts, error: response.error ? { message: response.error } : undefined });
+        }
+        catch (e) {
+            req.logError(e);
+            res.send({ error: { message: (0, logger_1.getErrorMessage)(e) } });
+        }
+    }));
+}
+exports.default = handle;

package/out/handlers/manifest.js

@@ -198,6 +198,12 @@ function handle(config) {
     if (config.api) {
         modules['api'] = (0, api_1.getApiManifest)(config, config.api);
     }
+    if (config.customSpellchecker) {
+        const uiModule = config.customSpellchecker.settingsUiModule;
+        modules['custom-spellchecker'] = [
+            Object.assign({ key: config.identifier + '-spellchecker', name: config.customSpellchecker.name || config.name, description: config.customSpellchecker.description || config.description, listSupportedLanguagesUrl: '/languages', checkSpellingUrl: '/spellcheck', environments: config.customSpellchecker.environments }, (uiModule ? { url: '/settings/' + (uiModule.fileName || 'index.html') } : {})),
+        ];
+    }
     const events = {
         installed: '/installed',
         uninstall: '/uninstall',

package/out/index.js

@@ -70,6 +70,8 @@ const user_errors_1 = __importDefault(require("./handlers/integration/user-error
 const manifest_1 = __importDefault(require("./handlers/manifest"));
 const subscription_paid_1 = __importDefault(require("./handlers/subscription-paid"));
 const uninstall_1 = __importDefault(require("./handlers/uninstall"));
+const get_languages_list_1 = __importDefault(require("./handlers/custom-spell-check/get-languages-list"));
+const spell_check_1 = __importDefault(require("./handlers/custom-spell-check/spell-check"));
 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"));
@@ -285,6 +287,13 @@ function addCrowdinEndpoints(app, clientConfig) {
         }
         (0, api_1.addSwagerApiDocumentation)(app, config);
     }
+    if (config.customSpellchecker) {
+        if (config.customSpellchecker.settingsUiModule) {
+            app.use('/settings', (0, ui_module_1.default)(config, config.customSpellchecker.settingsUiModule.allowUnauthorized), (0, render_ui_module_1.default)(config.customSpellchecker.settingsUiModule));
+        }
+        app.get('/languages', json_response_1.default, (0, crowdin_client_1.default)(config), (0, get_languages_list_1.default)(config.customSpellchecker));
+        app.post('/spellcheck', json_response_1.default, (0, crowdin_client_1.default)(config), (0, spell_check_1.default)(config.customSpellchecker));
+    }
     if (Object.keys(config).some((moduleKey) => {
         const moduleConfig = config[moduleKey];
         return typeof moduleConfig === 'object' && moduleConfig.hasOwnProperty('formSchema');

package/out/models/index.d.ts

@@ -164,6 +164,7 @@ export interface ClientConfig extends ImagePath {
      * Not necessary to configure if environment variables AWS_REGION and AWS_TMP_BUCKET_NAME are properly set.
      */
     awsConfig?: AWSConfig;
+    customSpellchecker?: CustomSpellcheckerModule;
 }
 export type Config = ClientConfig & {
     baseUrl: string;
@@ -933,6 +934,60 @@ export interface ApiModule {
     endpoints?: ApiEndpoints[];
     docFile?: string;
 }
+export interface CustomSpellCheckRequest {
+    language: string;
+    texts: string[];
+}
+export type SpellCheckCategory = 'typography' | 'casing' | 'grammar' | 'typos' | 'punctuation' | 'confused_words' | 'redundancy' | 'style' | 'gender_neutrality' | 'semantics' | 'colloquialisms' | 'wikipedia' | 'barbarism' | 'misc';
+export interface SupportedLanguage {
+    code: string;
+    name: string;
+}
+export interface SpellCheckMatch {
+    category: SpellCheckCategory;
+    message: string;
+    shortMessage: string;
+    offset: number;
+    length: number;
+    replacements: string[];
+}
+export interface CustomSpellCheckResponse {
+    texts: {
+        text: string;
+        matches: SpellCheckMatch[];
+    }[];
+    error?: string;
+}
+export interface CustomSpellcheckerModule extends Environments {
+    /**
+     * module description
+     */
+    description?: string;
+    /**
+     * module name
+     */
+    name?: string;
+    /**
+     * Settings UI module
+     */
+    settingsUiModule?: UiModule;
+    /**
+     * function to get list of supported languages that are supports by current spellchecker
+     */
+    getSupportedLanguage: ({ client, context, }: {
+        client: Crowdin;
+        context: CrowdinContextInfo;
+    }) => Promise<SupportedLanguage[]>;
+    /**
+     * function to check spelling
+     */
+    runSpellCheck: ({ client, context, language, texts, }: {
+        client: Crowdin;
+        context: CrowdinContextInfo;
+        language: string;
+        texts: string[];
+    }) => Promise<CustomSpellCheckResponse>;
+}
 export interface Logger {
     enabled: boolean;
     log?: (message: string, context?: CrowdinContextInfo) => void;

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@crowdin/app-project-module",
-  "version": "0.42.0",
+  "version": "0.43.0",
   "description": "Module that generates for you all common endpoints for serving standalone Crowdin App",
   "main": "out/index.js",
   "types": "out/index.d.ts",
   "scripts": {
     "build": "tsc -p ./ && cp -R views out && cp -R static out && cp logo.png out && rollup -c rollup.config.mjs",
     "build-main": "tsc -p ./ && cp -R views out && cp -R static out && cp logo.png out",
+    "watch-main": "tsc --watch -p ./ && cp -R views out && cp -R static out && cp logo.png out",
     "lint": "eslint --fix \"{src,tests}/**/*.{js,ts}\"",
     "prettier": "prettier --config .prettierrc src/**/*.ts --write",
     "lint-ci": "eslint \"{src,tests}/**/*.{js,ts}\"",