@crowdin/app-project-module 0.8.0 → 0.9.0

package/README.md

@@ -31,6 +31,7 @@ In both options you will need to provide Crowdin App configuration file. Please
 - [Error propagation](#error-propagation)
 - [Custom File Format](#custom-file-format)
 - [Custom MT](#custom-mt)
+- [Resources](#resources)
 - [Contributing](#contributing)
 - [Seeking Assistance](#seeking-assistance)
 - [License](#license)
@@ -426,7 +427,7 @@ const configuration = {
 crowdinModule.createApp(configuration);
 ```
 
-## Custom MT (Machine Translation)
+## Custom MT
 
 Example of [custom mt module](https://support.crowdin.com/crowdin-apps-modules/#custom-mt-machine-translation-module).
 
@@ -443,7 +444,7 @@ const configuration = {
     dbFolder: __dirname,
     imagePath: __dirname + '/' + 'logo.png',
     customMT: {
-        translate: async (client, source, target, strings) => {
+        translate: async (client, context, projectId, source, target, strings) => {
             //translate strings
             const translations = ['hello', 'world'];
             return translations;
@@ -454,6 +455,95 @@ const configuration = {
 crowdinModule.createApp(configuration);
 ```
 
+## Resources
+
+Example of [resources module](https://support.crowdin.com/crowdin-apps-modules/#resources-module).
+
+```javascript
+const crowdinModule = require('@crowdin/app-project-module');
+
+const configuration = {
+    baseUrl: 'https://123.ngrok.io',
+    clientId: 'clientId',
+    clientSecret: 'clientSecret',
+    name: 'Sample App',
+    identifier: 'sample-app',
+    description: 'Sample App description',
+    dbFolder: __dirname,
+    imagePath: __dirname + '/' + 'logo.png',
+    resources: {
+      fileName: 'setup.html',
+      uiPath: __dirname + '/' + 'public'
+    },
+};
+
+crowdinModule.createApp(configuration);
+```
+
+The resources module can work as an extension to other modules be something like a configuration UI for them.
+
+```javascript
+const crowdinModule = require('@crowdin/app-project-module');
+const express = require('express');
+
+const app = express();
+
+const configuration = {
+    baseUrl: 'https://123.ngrok.io',
+    clientId: 'clientId',
+    clientSecret: 'clientSecret',
+    name: 'Sample App',
+    identifier: 'sample-app',
+    description: 'Sample App description',
+    dbFolder: __dirname,
+    imagePath: __dirname + '/' + 'logo.png',
+    resources: {
+      fileName: 'setup.html',
+      uiPath: __dirname + '/' + 'public'
+    },
+    customMT: {
+        translate,
+    },
+    onUninstall: cleanup
+};
+
+const crowdinApp = crowdinModule.addCrowdinEndpoints(app, configuration);
+
+async function cleanup(organization) {
+    await crowdinApp.deleteMetadata(organization);
+}
+
+async function translate(crowdinClient, context, projectId, source, target, strings) {
+    const organization = context.jwtPayload.domain || context.jwtPayload.context.organization_id;
+    const metadata = await crowdinApp.getMetadata(organization);
+    //do translation based on metadata
+    const translations = ['hello', 'world'];
+    return translations;
+}
+
+//extra endpoints for resources UI
+app.post('/metadata', async (req, res) => {
+    const { context } = await crowdinApp.establishCrowdinConnection(req.query.jwt);
+    const organization = context.jwtPayload.domain || context.jwtPayload.context.organization_id;
+    const metadata = await crowdinApp.getMetadata(organization);
+    if (metadata) {
+        await crowdinApp.updateMetadata(organization, req.body);
+    } else {
+        await crowdinApp.saveMetadata(organization, req.body);
+    }
+    res.status(204).end();
+});
+
+app.get('/metadata', async (req, res) => {
+    const { context } = await crowdinApp.establishCrowdinConnection(req.query.jwt);
+    const organization = context.jwtPayload.domain || context.jwtPayload.context.organization_id;
+    const metadata = await crowdinApp.getMetadata(organization) || {};
+    res.status(200).send(metadata);
+});
+
+app.listen(3000, () =>  console.log('Crowdin app started'));
+```
+
 ## Contributing
 
 If you want to contribute please read the [Contributing](/CONTRIBUTING.md) guidelines.

package/out/handlers/custom-mt/translate.js

@@ -15,6 +15,7 @@ function handle(config) {
         const source = req.query.source;
         const target = req.query.target;
         const body = req.body;
+        const projectId = Number(req.query.project_id);
         if (source === 'en' && target === 'de' && body.strings && body.strings[0] === 'validation') {
             if (config.validate) {
                 yield config.validate(req.crowdinApiClient);
@@ -22,7 +23,7 @@ function handle(config) {
             res.send({ data: { translations: [] } });
         }
         else {
-            const translations = yield config.translate(req.crowdinApiClient, source, target, body.strings);
+            const translations = yield config.translate(req.crowdinApiClient, req.crowdinContext, projectId, source, target, body.strings);
             res.send({ data: { translations } });
         }
     }));

package/out/handlers/manifest.js

@@ -5,7 +5,7 @@ function handle(config) {
     if (config.integration) {
         modules.integrations = [
             {
-                key: config.identifier,
+                key: config.identifier + '-int',
                 name: config.name,
                 description: config.description,
                 logo: '/logo.png',
@@ -16,7 +16,7 @@ function handle(config) {
     if (config.customFileFormat) {
         modules['custom-file-format'] = [
             {
-                key: config.identifier,
+                key: config.identifier + '-ff',
                 type: config.customFileFormat.type,
                 signaturePatterns: config.customFileFormat.signaturePatterns,
                 url: '/process',
@@ -26,12 +26,30 @@ function handle(config) {
     if (config.customMT) {
         modules['custom-mt'] = [
             {
-                key: config.identifier,
+                key: config.identifier + '-mt',
                 name: config.name,
                 url: '/translate',
             },
         ];
     }
+    if (config.resources) {
+        modules['organization-menu'] = [
+            {
+                key: config.identifier + '-resources',
+                name: config.name,
+                url: '/resources/' + (config.resources.fileName || 'index.html'),
+                icon: '/logo.png',
+            },
+        ];
+        modules['resources'] = [
+            {
+                key: config.identifier + '-resources',
+                name: config.name,
+                url: '/resources/' + (config.resources.fileName || 'index.html'),
+                icon: '/logo.png',
+            },
+        ];
+    }
     return (_req, res) => {
         const manifest = {
             identifier: config.identifier,

package/out/handlers/uninstall.d.ts

@@ -1,3 +1,4 @@
 /// <reference types="qs" />
 import { Request, Response } from 'express';
-export default function handle(): (req: Request<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: Function) => void;
+import { Config } from '../models';
+export default function handle(config: Config): (req: 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/uninstall.js

@@ -11,10 +11,14 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 Object.defineProperty(exports, "__esModule", { value: true });
 const storage_1 = require("../storage");
 const util_1 = require("../util");
-function handle() {
+function handle(config) {
     return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
         const event = req.body;
-        yield (0, storage_1.deleteCrowdinCredentials)((event.domain || event.organizationId).toString());
+        const organization = (event.domain || event.organizationId).toString();
+        yield (0, storage_1.deleteCrowdinCredentials)(organization);
+        if (config.onUninstall) {
+            yield config.onUninstall(organization);
+        }
         res.status(204).end();
     }));
 }

package/out/index.d.ts

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

package/out/index.js

@@ -44,13 +44,13 @@ const manifest_1 = __importDefault(require("./handlers/manifest"));
 const oauth_login_1 = __importDefault(require("./handlers/oauth-login"));
 const settings_save_1 = __importDefault(require("./handlers/settings-save"));
 const uninstall_1 = __importDefault(require("./handlers/uninstall"));
-const crowdin_client_1 = __importDefault(require("./middlewares/crowdin-client"));
+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 storage_1 = require("./storage");
+const storage = __importStar(require("./storage"));
 const util_1 = require("./util");
 function addCrowdinEndpoints(app, config) {
-    (0, storage_1.connect)(config.dbFolder);
+    storage.connect(config.dbFolder);
     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'));
@@ -69,7 +69,7 @@ function addCrowdinEndpoints(app, config) {
     app.set('view engine', 'handlebars');
     app.get('/logo.png', (req, res) => res.sendFile(config.imagePath || (0, path_1.join)(__dirname, 'logo.png')));
     app.post('/installed', (0, install_1.default)(config));
-    app.post('/uninstall', (0, uninstall_1.default)());
+    app.post('/uninstall', (0, uninstall_1.default)(config));
     app.get('/manifest.json', json_response_1.default, (0, manifest_1.default)(config));
     const integrationLogic = config.integration;
     if (integrationLogic) {
@@ -100,6 +100,16 @@ function addCrowdinEndpoints(app, config) {
     if (config.customMT) {
         app.post('/translate', (0, crowdin_client_1.default)(config), (0, translate_1.default)(config.customMT));
     }
+    if (config.resources) {
+        app.use('/resources', express_1.default.static(config.resources.uiPath));
+    }
+    return {
+        getMetadata: storage.getMetadata,
+        saveMetadata: storage.saveMetadata,
+        updateMetadata: storage.updateMetadata,
+        deleteMetadata: storage.deleteMetadata,
+        establishCrowdinConnection: jwtToken => (0, crowdin_client_1.prepareCrowdinRequest)(jwtToken, config),
+    };
 }
 exports.addCrowdinEndpoints = addCrowdinEndpoints;
 function createApp(config) {

package/out/middlewares/crowdin-client.d.ts

@@ -1,4 +1,9 @@
 /// <reference types="qs" />
+import Crowdin from '@crowdin/crowdin-api-client';
 import { Response } from 'express';
-import { Config } from '../models';
+import { Config, CrowdinContextInfo } from '../models';
+export declare function prepareCrowdinRequest(jwtToken: string, config: Config, optional?: boolean): Promise<{
+    context: CrowdinContextInfo;
+    client?: Crowdin;
+}>;
 export default function handle(config: Config, optional?: boolean): (req: 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/middlewares/crowdin-client.js

@@ -9,40 +9,60 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.prepareCrowdinRequest = void 0;
 const crowdin_apps_functions_1 = require("@crowdin/crowdin-apps-functions");
 const storage_1 = require("../storage");
 const util_1 = require("../util");
-function handle(config, optional = false) {
-    return (0, util_1.runAsyncWrapper)((req, res, next) => __awaiter(this, void 0, void 0, function* () {
-        const tokenJwt = (req.query.tokenJwt || req.query.jwtToken);
-        if (!tokenJwt) {
-            return res.status(403).send({ error: 'Access denied' });
-        }
+function prepareCrowdinRequest(jwtToken, config, optional = false) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let context;
+        let client;
         try {
-            const jwtPayload = yield (0, crowdin_apps_functions_1.validateJwtToken)(tokenJwt, config.clientSecret);
-            req.crowdinContext = {
+            const jwtPayload = yield (0, crowdin_apps_functions_1.validateJwtToken)(jwtToken, config.clientSecret);
+            context = {
                 jwtPayload,
                 clientId: (0, crowdin_apps_functions_1.constructCrowdinIdFromJwtPayload)(jwtPayload),
                 crowdinId: `${jwtPayload.domain || jwtPayload.context.organization_id}`,
             };
         }
         catch (e) {
-            return res.status(403).send({ error: "Can't verify" });
+            throw new Error("Can't verify");
         }
         try {
-            const credentials = yield (0, storage_1.getCrowdinCredentials)(req.crowdinContext.crowdinId);
+            const credentials = yield (0, storage_1.getCrowdinCredentials)(context.crowdinId);
             if (!credentials) {
                 if (optional) {
-                    return next();
+                    return { context };
                 }
-                return res.status(403).send({ error: "Can't find organization by id" });
+                throw new Error("Can't find organization by id");
             }
-            req.crowdinApiClient = yield (0, util_1.prepareCrowdinClient)(config, credentials);
-            next();
+            client = yield (0, util_1.prepareCrowdinClient)(config, credentials);
         }
         catch (e) {
+            throw new Error('Access denied');
+        }
+        return { context, client };
+    });
+}
+exports.prepareCrowdinRequest = prepareCrowdinRequest;
+function handle(config, optional = false) {
+    return (0, util_1.runAsyncWrapper)((req, res, next) => __awaiter(this, void 0, void 0, function* () {
+        const tokenJwt = (req.query.tokenJwt || req.query.jwtToken);
+        if (!tokenJwt) {
             return res.status(403).send({ error: 'Access denied' });
         }
+        try {
+            const data = yield prepareCrowdinRequest(tokenJwt, config, optional);
+            req.crowdinContext = data.context;
+            if (data.client) {
+                req.crowdinApiClient = data.client;
+            }
+            next();
+        }
+        catch (e) {
+            const message = typeof e === 'string' ? e : e.message;
+            return res.status(403).send({ error: message || 'Error' });
+        }
     }));
 }
 exports.default = handle;

package/out/models/index.d.ts

@@ -50,6 +50,14 @@ export interface Config {
      * custom MT module logic
      */
     customMT?: CustomMTLogic;
+    /**
+     * resources module
+     */
+    resources?: Resources;
+    /**
+     * Uninstall hook for cleanup logic
+     */
+    onUninstall?: (organization: string) => Promise<void>;
 }
 export interface IntegrationLogic {
     /**
@@ -350,9 +358,29 @@ export interface ProcessFileString {
     translations?: any;
 }
 export interface CustomMTLogic {
-    translate: (client: Crowdin, source: string, target: string, strings: string[]) => Promise<string[]>;
+    translate: (client: Crowdin, context: CrowdinContextInfo, projectId: number, source: string, target: string, strings: string[]) => Promise<string[]>;
     validate?: (client: Crowdin) => Promise<void>;
 }
 export interface CustomMTRequest {
     strings: string[];
 }
+export interface Resources {
+    /**
+     * path to ui folder (e.g. {@example join(__dirname, 'public')})
+     */
+    uiPath: string;
+    /**
+     * page name (default index.html)
+     */
+    fileName?: string;
+}
+export interface CrowdinAppUtilities {
+    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>;
+    establishCrowdinConnection: (jwtToken: string) => Promise<{
+        context: CrowdinContextInfo;
+        client?: Crowdin;
+    }>;
+}

package/out/storage/index.d.ts

@@ -11,3 +11,7 @@ export declare function updateIntegrationConfig(id: string, config: any): Promis
 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>;

package/out/storage/index.js

@@ -13,7 +13,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.deleteIntegrationCredentials = exports.getAllIntegrationCredentials = exports.getIntegrationCredentials = exports.updateIntegrationConfig = exports.updateIntegrationCredentials = exports.saveIntegrationCredentials = exports.deleteCrowdinCredentials = exports.getAllCrowdinCredentials = exports.getCrowdinCredentials = exports.updateCrowdinCredentials = exports.saveCrowdinCredentials = exports.connect = void 0;
+exports.deleteMetadata = exports.getMetadata = exports.updateMetadata = exports.saveMetadata = exports.deleteIntegrationCredentials = exports.getAllIntegrationCredentials = exports.getIntegrationCredentials = exports.updateIntegrationConfig = exports.updateIntegrationCredentials = exports.saveIntegrationCredentials = exports.deleteCrowdinCredentials = exports.getAllCrowdinCredentials = exports.getCrowdinCredentials = exports.updateCrowdinCredentials = exports.saveCrowdinCredentials = exports.connect = void 0;
 const path_1 = require("path");
 const sqlite3_1 = __importDefault(require("sqlite3"));
 let _res;
@@ -74,6 +74,13 @@ function connect(folder) {
                 crowdin_id  varchar not null
             );
             `, []);
+            yield _run(`
+            create table if not exists app_metadata
+            (
+                id        varchar not null primary key,
+                data      varchar     null
+            );
+            `, []);
             _res();
         }
         catch (e) {
@@ -198,3 +205,26 @@ function deleteIntegrationCredentials(id) {
     return run('DELETE FROM integration_credentials where id = ?', [id]);
 }
 exports.deleteIntegrationCredentials = deleteIntegrationCredentials;
+function saveMetadata(id, metadata) {
+    return run('INSERT INTO app_metadata(id, data) VALUES (?, ?)', [id, JSON.stringify(metadata)]);
+}
+exports.saveMetadata = saveMetadata;
+function updateMetadata(id, metadata) {
+    return run('UPDATE app_metadata SET data = ? WHERE id = ?', [JSON.stringify(metadata), id]);
+}
+exports.updateMetadata = updateMetadata;
+function getMetadata(id) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const row = yield get('SELECT data FROM app_metadata WHERE id = ?', [id]);
+        if (row) {
+            return JSON.parse(row.data);
+        }
+    });
+}
+exports.getMetadata = getMetadata;
+function deleteMetadata(id) {
+    return __awaiter(this, void 0, void 0, function* () {
+        yield run('DELETE FROM app_metadata where id = ?', [id]);
+    });
+}
+exports.deleteMetadata = deleteMetadata;

package/package.json

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