@crowdin/app-project-module 0.9.0 → 0.10.1

package/README.md

@@ -11,6 +11,13 @@ Module expose two main methods:
 
 In both options you will need to provide Crowdin App configuration file. Please refer to jsdoc for more details.
 
+`addCrowdinEndpoints` will return an object with several methods to help you add your own custom logic [see example](#resources).
+
+- `saveMetadata` to save metadata (may be associated with an organization, project, etc)
+- `getMetadata` to get metadata
+- `deleteMetadata` to delete metadata (usually useful in `onUninstall` hook)
+- `establishCrowdinConnection` method that accept jwt token that you may forward from module UI and it will return back Crowdin client instance and the context.
+
 ## Status
 
 [![npm](https://img.shields.io/npm/v/@crowdin/app-project-module?logo=npm&cacheSeconds=1800)](https://www.npmjs.com/package/@crowdin/app-project-module)
@@ -32,6 +39,7 @@ In both options you will need to provide Crowdin App configuration file. Please
 - [Custom File Format](#custom-file-format)
 - [Custom MT](#custom-mt)
 - [Resources](#resources)
+- [Other modules](#other-modules)
 - [Contributing](#contributing)
 - [Seeking Assistance](#seeking-assistance)
 - [License](#license)
@@ -526,11 +534,7 @@ 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);
-    }
+    await crowdinApp.saveMetadata(organization, req.body);
     res.status(204).end();
 });
 
@@ -544,6 +548,38 @@ app.get('/metadata', async (req, res) => {
 app.listen(3000, () =>  console.log('Crowdin app started'));
 ```
 
+## Other modules
+
+Framework also supports following modules:
+
+- [editor-panels module](https://support.crowdin.com/crowdin-apps-modules/#editor-panels-module)
+- [project menu module](https://support.crowdin.com/crowdin-apps-modules/#project-menu-module)
+- [tools module](https://support.crowdin.com/crowdin-apps-modules/#tools-module)
+- [reports module](https://support.crowdin.com/crowdin-apps-modules/#reports-module)
+
+Example of Reports 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',
+    reports: { //can be editorPanels, projectMenu, tools
+      fileName: 'reports.html', //optional, only needed if file is not index.html
+      uiPath: __dirname + '/' + 'public' // folder where UI of the module is located (js, html, css files)
+    },
+};
+
+crowdinModule.createApp(configuration);
+```
+
 ## Contributing
 
 If you want to contribute please read the [Contributing](/CONTRIBUTING.md) guidelines.

package/out/handlers/integration-login.js

@@ -16,6 +16,10 @@ function handle(config, integration) {
         if (integration.checkConnection) {
             yield integration.checkConnection(req.body.credentials);
         }
+        const existing = yield (0, storage_1.getIntegrationCredentials)(req.crowdinContext.clientId);
+        if (!!existing) {
+            yield (0, storage_1.deleteIntegrationCredentials)(req.crowdinContext.clientId);
+        }
         yield (0, storage_1.saveIntegrationCredentials)(req.crowdinContext.clientId, (0, util_1.encryptData)(config.clientSecret, JSON.stringify(req.body.credentials)), req.crowdinContext.crowdinId);
         res.status(204).end();
     }));

package/out/handlers/manifest.js

@@ -50,6 +50,48 @@ function handle(config) {
             },
         ];
     }
+    if (config.editorPanels) {
+        modules['editor-panels'] = [
+            {
+                key: config.identifier + '-editor-panels',
+                name: config.name,
+                position: 'right',
+                url: '/editor-panels/' + (config.editorPanels.fileName || 'index.html'),
+                modes: config.editorPanels.modes,
+            },
+        ];
+    }
+    if (config.projectMenu) {
+        modules['project-menu'] = [
+            {
+                key: config.identifier + '-project-menu',
+                name: config.name,
+                url: '/project-menu/' + (config.projectMenu.fileName || 'index.html'),
+            },
+        ];
+    }
+    if (config.tools) {
+        modules['tools'] = [
+            {
+                key: config.identifier + '-tools',
+                name: config.name,
+                description: config.description,
+                logo: '/logo.png',
+                icon: '/logo.png',
+                url: '/tools/' + (config.tools.fileName || 'index.html'),
+            },
+        ];
+    }
+    if (config.reports) {
+        modules['reports'] = [
+            {
+                key: config.identifier + '-reports',
+                name: config.name,
+                description: config.description,
+                url: '/reports/' + (config.reports.fileName || 'index.html'),
+            },
+        ];
+    }
     return (_req, res) => {
         const manifest = {
             identifier: config.identifier,

package/out/index.js

@@ -18,6 +18,15 @@ var __importStar = (this && this.__importStar) || function (mod) {
     __setModuleDefault(result, mod);
     return result;
 };
+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 };
 };
@@ -103,10 +112,29 @@ function addCrowdinEndpoints(app, config) {
     if (config.resources) {
         app.use('/resources', express_1.default.static(config.resources.uiPath));
     }
+    if (config.editorPanels) {
+        app.use('/editor-panels', express_1.default.static(config.editorPanels.uiPath));
+    }
+    if (config.projectMenu) {
+        app.use('/project-menu', express_1.default.static(config.projectMenu.uiPath));
+    }
+    if (config.tools) {
+        app.use('/tools', express_1.default.static(config.tools.uiPath));
+    }
+    if (config.reports) {
+        app.use('/reports', express_1.default.static(config.reports.uiPath));
+    }
     return {
         getMetadata: storage.getMetadata,
-        saveMetadata: storage.saveMetadata,
-        updateMetadata: storage.updateMetadata,
+        saveMetadata: (id, metadata) => __awaiter(this, void 0, void 0, function* () {
+            const existing = yield storage.getMetadata(id);
+            if (existing) {
+                yield storage.updateMetadata(id, metadata);
+            }
+            else {
+                yield storage.saveMetadata(id, metadata);
+            }
+        }),
         deleteMetadata: storage.deleteMetadata,
         establishCrowdinConnection: jwtToken => (0, crowdin_client_1.prepareCrowdinRequest)(jwtToken, config),
     };

package/out/models/index.d.ts

@@ -53,7 +53,23 @@ export interface Config {
     /**
      * resources module
      */
-    resources?: Resources;
+    resources?: UiModule;
+    /**
+     * editor-panels module
+     */
+    editorPanels?: EditorPanels;
+    /**
+     * project menu module
+     */
+    projectMenu?: UiModule;
+    /**
+     * tools module
+     */
+    tools?: UiModule;
+    /**
+     * reports module
+     */
+    reports?: UiModule;
     /**
      * Uninstall hook for cleanup logic
      */
@@ -234,7 +250,7 @@ export interface FormField {
     helpText?: string;
     helpTextHtml?: string;
     label: string;
-    type?: 'text' | 'password';
+    type?: 'text' | 'password' | 'checkbox';
 }
 export declare type TreeItem = File | Folder;
 export interface File {
@@ -364,7 +380,7 @@ export interface CustomMTLogic {
 export interface CustomMTRequest {
     strings: string[];
 }
-export interface Resources {
+export interface UiModule {
     /**
      * path to ui folder (e.g. {@example join(__dirname, 'public')})
      */
@@ -374,9 +390,20 @@ export interface Resources {
      */
     fileName?: string;
 }
+export interface EditorPanels extends UiModule {
+    /**
+     * The Editor's mode list where the module will be available.
+     */
+    modes: EditorPanelsMode[];
+}
+export declare enum EditorPanelsMode {
+    ASSETS = "assets",
+    REVIEW = "review",
+    TRANSLATE = "TRANSLATE",
+    PROOFREAD = "proofread"
+}
 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<{

package/out/models/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ProcessFileJobType = exports.AccountType = void 0;
+exports.EditorPanelsMode = exports.ProcessFileJobType = exports.AccountType = void 0;
 var AccountType;
 (function (AccountType) {
     AccountType["NORMAL"] = "normal";
@@ -11,3 +11,10 @@ var ProcessFileJobType;
     ProcessFileJobType["PARSE_FILE"] = "parse-file";
     ProcessFileJobType["BUILD_FILE"] = "build-file";
 })(ProcessFileJobType = exports.ProcessFileJobType || (exports.ProcessFileJobType = {}));
+var EditorPanelsMode;
+(function (EditorPanelsMode) {
+    EditorPanelsMode["ASSETS"] = "assets";
+    EditorPanelsMode["REVIEW"] = "review";
+    EditorPanelsMode["TRANSLATE"] = "TRANSLATE";
+    EditorPanelsMode["PROOFREAD"] = "proofread";
+})(EditorPanelsMode = exports.EditorPanelsMode || (exports.EditorPanelsMode = {}));

package/out/views/login.handlebars

@@ -12,20 +12,36 @@
                 {{else}}
                     <div class="inputs">
                         {{#each loginFields}}
-                        <crowdin-input
-                            id="{{key}}"
-                            label="{{label}}"
-                            {{#if helpText}}
-                                help-text="{{helpText}}"
-                            {{/if}}
-                            {{#if helpTextHtml}}
-                                help-text-html="{{helpTextHtml}}"
-                            {{/if}}
-                            {{#if type}}
-                                type="{{type}}"
-                            {{/if}}
-                            value="">
-                        </crowdin-input>
+                            {{#ifeq type "checkbox"}}
+                                <crowdin-checkbox
+                                    id="{{key}}"
+                                    label="{{label}}"
+                                    value="false"
+                                    use-switch
+                                    {{#if helpText}}
+                                        help-text="{{helpText}}"
+                                    {{/if}}
+                                    {{#if helpTextHtml}}
+                                        help-text-html="{{helpTextHtml}}"
+                                    {{/if}}
+                                >
+                                </crowdin-checkbox>
+                            {{else}}
+                                <crowdin-input
+                                    id="{{key}}"
+                                    label="{{label}}"
+                                    {{#if helpText}}
+                                        help-text="{{helpText}}"
+                                    {{/if}}
+                                    {{#if helpTextHtml}}
+                                        help-text-html="{{helpTextHtml}}"
+                                    {{/if}}
+                                    {{#if type}}
+                                        type="{{type}}"
+                                    {{/if}}
+                                    value="">
+                                </crowdin-input>
+                            {{/ifeq}}
                         {{/each}}
                     </div>
                 {{/if}}
@@ -63,7 +79,11 @@
     function integrationLogin(oauthCredentials) {
         const credentials = oauthCredentials || {
             {{#each loginFields}}
-                '{{key}}': document.querySelector('#{{key}}').getAttribute('value'),
+                {{#ifeq type "checkbox"}}
+                    '{{key}}': !!document.querySelector('#{{key}}').checked,
+                {{else}}
+                    '{{key}}': document.querySelector('#{{key}}').getAttribute('value'),
+                {{/ifeq}}
             {{/each}}
         };
         checkOrigin()

package/package.json

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