@crowdin/app-project-module 0.12.4 → 0.13.1

package/README.md

@@ -16,6 +16,7 @@ In both options you will need to provide Crowdin App configuration file. Please
 - `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)
+- `getUserSettings` to get settings that users manage in the integration module
 - `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
@@ -66,6 +67,10 @@ const configuration = {
     baseUrl: 'https://123.ngrok.io',
     clientId: 'clientId',
     clientSecret: 'clientSecret',
+    scopes: [
+        crowdinModule.Scope.PROJECTS,
+        crowdinModule.Scope.TRANSLATION_MEMORIES
+    ],
     name: 'Sample App',
     identifier: 'sample-app',
     description: 'Sample App description',
@@ -73,6 +78,10 @@ const configuration = {
     imagePath: __dirname + '/' + 'logo.png',
     integration: {
         withRootFolder: true,
+        withCronSync: {
+            crowdin: true,
+            integration: true,
+        },
         getIntegrationFiles: async (credentials, appSettings) => {
             //here you need to fetch files/objects from integration
             return [
@@ -427,14 +436,14 @@ const configuration = {
         signaturePatterns: {
             fileName: '^.+\.xml$'
         },
-        parseFile: async (file, req) => {
+        parseFile: async (file, req, client, context, projectId) => {
             const xml = convert.xml2json(file, { compact: true, spaces: 4 });
             const fileContent = JSON.parse(xml);
             //parse logic
             const strings = [];
             return { strings };
         },
-        buildFile: async (file, req, strings) => {
+        buildFile: async (file, req, strings, client, context, projectId) => {
             const xml = convert.xml2json(file, { compact: true, spaces: 4 });
             const fileContent = JSON.parse(xml);
             //build logic

package/out/handlers/custom-file-format/process.d.ts

@@ -1,4 +1,4 @@
 /// <reference types="qs" />
-import { Request, Response } from 'express';
+import { Response } from 'express';
 import { Config, CustomFileFormatLogic } from '../../models';
-export default function handle(baseConfig: Config, baseUrl: string, folder: string, config: CustomFileFormatLogic): (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;
+export default function handle(baseConfig: Config, baseUrl: string, folder: string, config: CustomFileFormatLogic): (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/handlers/custom-file-format/process.js

@@ -29,7 +29,7 @@ function storeFile(fileContent, folder) {
         }
     }));
 }
-function handleBuildFile(baseUrl, dataFolder, config, file, req) {
+function handleBuildFile(baseUrl, dataFolder, config, file, req, client, context, projectId) {
     return __awaiter(this, void 0, void 0, function* () {
         const response = {};
         if (!req.strings && !req.stringsUrl) {
@@ -42,7 +42,7 @@ function handleBuildFile(baseUrl, dataFolder, config, file, req) {
         else {
             strings = (yield axios_1.default.get(req.stringsUrl)).data;
         }
-        const res = yield config.buildFile(file, req, strings);
+        const res = yield config.buildFile(file, req, strings, client, context, projectId);
         const contentFileEncoded = Buffer.from(res.contentFile).toString('base64');
         if (Buffer.byteLength(contentFileEncoded, 'utf8') < MAX_BODY_SIZE) {
             response.content = contentFileEncoded;
@@ -54,10 +54,10 @@ function handleBuildFile(baseUrl, dataFolder, config, file, req) {
         return response;
     });
 }
-function handleParseFile(baseUrl, dataFolder, config, file, req) {
+function handleParseFile(baseUrl, dataFolder, config, file, req, client, context, projectId) {
     return __awaiter(this, void 0, void 0, function* () {
         const response = {};
-        const res = yield config.parseFile(file, req);
+        const res = yield config.parseFile(file, req, client, context, projectId);
         if (res.previewFile) {
             const previewFileEncoded = Buffer.from(res.previewFile).toString('base64');
             if (Buffer.byteLength(previewFileEncoded, 'utf8') < MAX_BODY_SIZE) {
@@ -108,10 +108,10 @@ function handle(baseConfig, baseUrl, folder, config) {
         let response = {};
         switch (body.jobType) {
             case models_1.ProcessFileJobType.BUILD_FILE:
-                response = yield handleBuildFile(baseFilesUrl, folder, config, file, body);
+                response = yield handleBuildFile(baseFilesUrl, folder, config, file, body, req.crowdinApiClient, req.crowdinContext, req.crowdinContext.jwtPayload.context.project_id);
                 break;
             case models_1.ProcessFileJobType.PARSE_FILE:
-                response = yield handleParseFile(baseFilesUrl, folder, config, file, body);
+                response = yield handleParseFile(baseFilesUrl, folder, config, file, body, req.crowdinApiClient, req.crowdinContext, req.crowdinContext.jwtPayload.context.project_id);
                 break;
         }
         res.send({ data: response });

package/out/handlers/manifest.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const models_1 = require("../models");
 function handle(config) {
     const modules = {};
     // TEMPORARY CODE drop on step 3 of CN-30453
@@ -179,7 +180,7 @@ function handle(config) {
                 installed: '/installed',
                 uninstall: '/uninstall',
             },
-            scopes: ['project'],
+            scopes: config.scopes ? config.scopes : [models_1.Scope.PROJECTS],
             modules,
         };
         res.send(manifest);

package/out/index.d.ts

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

package/out/index.js

@@ -31,7 +31,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createApp = exports.addCrowdinEndpoints = void 0;
+exports.createApp = exports.addCrowdinEndpoints = exports.Scope = void 0;
 const express_1 = __importDefault(require("express"));
 const express_handlebars_1 = __importDefault(require("express-handlebars"));
 const cron = __importStar(require("node-cron"));
@@ -60,6 +60,8 @@ const integration_credentials_1 = __importDefault(require("./middlewares/integra
 const json_response_1 = __importDefault(require("./middlewares/json-response"));
 const storage = __importStar(require("./storage"));
 const util_1 = require("./util");
+var models_1 = require("./models");
+Object.defineProperty(exports, "Scope", { enumerable: true, get: function () { return models_1.Scope; } });
 function addCrowdinEndpoints(app, config) {
     storage.connect(config.dbFolder);
     app.use(express_1.default.json({ limit: '50mb' }));
@@ -121,7 +123,7 @@ function addCrowdinEndpoints(app, config) {
         }
     }
     if (config.customFileFormat) {
-        app.post('/process', (0, process_1.default)(config, config.baseUrl, config.customFileFormat.filesFolder || config.dbFolder, config.customFileFormat));
+        app.post('/process', (0, crowdin_client_1.default)(config), (0, process_1.default)(config, config.baseUrl, config.customFileFormat.filesFolder || config.dbFolder, config.customFileFormat));
         app.get('/file/download', (0, download_1.default)(config, config.customFileFormat.filesFolder || config.dbFolder));
     }
     if (config.customMT) {
@@ -184,6 +186,12 @@ function addCrowdinEndpoints(app, config) {
             }
         }),
         deleteMetadata: storage.deleteMetadata,
+        getUserSettings: (clientId) => __awaiter(this, void 0, void 0, function* () {
+            const integrationCredentials = yield storage.getIntegrationCredentials(clientId);
+            if (integrationCredentials === null || integrationCredentials === void 0 ? void 0 : integrationCredentials.config) {
+                return JSON.parse(integrationCredentials.config);
+            }
+        }),
         establishCrowdinConnection: jwtToken => (0, crowdin_client_1.prepareCrowdinRequest)(jwtToken, config),
     };
 }

package/out/middlewares/crowdin-client.js

@@ -13,6 +13,17 @@ 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 getToken(req) {
+    const tokenJwt = (req.query.tokenJwt || req.query.jwtToken);
+    if (tokenJwt) {
+        return tokenJwt;
+    }
+    if (req.headers.authorization) {
+        if (req.headers.authorization.startsWith('Bearer ') || req.headers.authorization.startsWith('bearer ')) {
+            return req.headers.authorization.substring(7);
+        }
+    }
+}
 function prepareCrowdinRequest(jwtToken, config, optional = false) {
     return __awaiter(this, void 0, void 0, function* () {
         let context;
@@ -47,7 +58,7 @@ function prepareCrowdinRequest(jwtToken, config, optional = false) {
 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);
+        const tokenJwt = getToken(req);
         if (!tokenJwt) {
             return res.status(403).send({ error: 'Access denied' });
         }

package/out/models/index.d.ts

@@ -14,6 +14,10 @@ export interface Config extends ImagePath {
      * https url where an app is reachable from the internet (e.g. the one that ngrok generates for us)
      */
     baseUrl: string;
+    /**
+     * Set of scopes requested by this app (default 'project')
+     */
+    scopes?: Scope[];
     /**
      * app name
      */
@@ -99,6 +103,21 @@ export interface Config extends ImagePath {
      */
     onError?: (error: any) => void;
 }
+export declare enum Scope {
+    ALL_SCOPES = "all",
+    NOTIFICATIONS = "notification",
+    TRANSLATION_MEMORIES = "tm",
+    MACHINE_TRANSLATION_ENGINES = "mt",
+    GLOSSARIES = "glossary",
+    PROJECTS = "project",
+    TASKS = "project.task",
+    REPORTS = "project.report",
+    TRANSLATION_STATUS = "project.status",
+    SOURCE_FILES_AND_STRINGS = "project.source",
+    WEBHOOKS = "project.webhook",
+    TRANSLATIONS = "project.translation",
+    SCREENSHOTS = "project.screenshot"
+}
 export interface IntegrationLogic {
     /**
      * Customize your app login form
@@ -363,11 +382,11 @@ export interface CustomFileFormatLogic {
     /**
      * Used for initial source file upload, source file update, and translation upload
      */
-    parseFile: (fileContent: string | object, req: Omit<ProcessFileRequest, 'jobType' | 'file'>) => Promise<ParseFileResponse>;
+    parseFile: (fileContent: string | object, req: Omit<ProcessFileRequest, 'jobType' | 'file'>, client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<ParseFileResponse>;
     /**
      * Used for translation download
      */
-    buildFile: (fileContent: string | object, req: Omit<ProcessFileRequest, 'jobType' | 'file'>, strings: ProcessFileString[]) => Promise<BuildFileResponse>;
+    buildFile: (fileContent: string | object, req: Omit<ProcessFileRequest, 'jobType' | 'file'>, strings: ProcessFileString[], client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<BuildFileResponse>;
 }
 export interface SignaturePatterns {
     fileName?: string;
@@ -447,6 +466,10 @@ export interface CrowdinAppUtilities {
     saveMetadata: (id: string, metadata: any) => Promise<void>;
     getMetadata: (id: string) => Promise<any | undefined>;
     deleteMetadata: (id: string) => Promise<void>;
+    /**
+     * Settings that users manage in the integration module
+     */
+    getUserSettings: (clientId: string) => Promise<any | undefined>;
     establishCrowdinConnection: (jwtToken: string) => Promise<{
         context: CrowdinContextInfo;
         client?: Crowdin;

package/out/models/index.js

@@ -1,6 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.EditorPanelsMode = exports.ProcessFileJobType = exports.AccountType = void 0;
+exports.EditorPanelsMode = exports.ProcessFileJobType = exports.AccountType = exports.Scope = void 0;
+var Scope;
+(function (Scope) {
+    Scope["ALL_SCOPES"] = "all";
+    Scope["NOTIFICATIONS"] = "notification";
+    Scope["TRANSLATION_MEMORIES"] = "tm";
+    Scope["MACHINE_TRANSLATION_ENGINES"] = "mt";
+    Scope["GLOSSARIES"] = "glossary";
+    Scope["PROJECTS"] = "project";
+    Scope["TASKS"] = "project.task";
+    Scope["REPORTS"] = "project.report";
+    Scope["TRANSLATION_STATUS"] = "project.status";
+    Scope["SOURCE_FILES_AND_STRINGS"] = "project.source";
+    Scope["WEBHOOKS"] = "project.webhook";
+    Scope["TRANSLATIONS"] = "project.translation";
+    Scope["SCREENSHOTS"] = "project.screenshot";
+})(Scope = exports.Scope || (exports.Scope = {}));
 var AccountType;
 (function (AccountType) {
     AccountType["NORMAL"] = "normal";

package/out/util/index.js

@@ -115,10 +115,7 @@ function applyDefaults(config, integration) {
         integration.getCrowdinFiles = (projectId, client, rootFolder) => __awaiter(this, void 0, void 0, function* () {
             let allDirectories;
             if (rootFolder) {
-                allDirectories = (yield client.sourceFilesApi
-                    .withFetchAll()
-                    // @ts-expect-error: Method overloading
-                    .listProjectDirectories(projectId, {
+                allDirectories = (yield client.sourceFilesApi.withFetchAll().listProjectDirectories(projectId, {
                     directoryId: rootFolder.id,
                     recursion: 'true',
                 })).data.map(d => d.data);

package/out/views/main.handlebars

@@ -166,10 +166,10 @@
             .then((res) => {
                 project = res;
                 appComponent.setCrowdinLanguagesData(project.targetLanguages)
-                {{#if withCronSync}}
-                    getSyncSettings('crowdin');
-                {{/if}}
             })
+            {{#if withCronSync}}
+                .then(() => getSyncSettings('crowdin'))
+            {{/if}}
             .catch(e => catchRejection(e, 'Can\'t fetch Crowdin data'))
             .finally(() => (appComponent.setAttribute('is-crowdin-loading', false)));
     }
@@ -204,11 +204,16 @@
     }
 
     function getSyncSettings(provider) {
-        const filesComponent = appComponent.querySelector(`#${provider}-files`);
         checkOrigin()
             .then(restParams => fetch(`/api/sync-settings/${provider}` + restParams))
             .then(checkResponse)
-            .then((res) => filesComponent.addScheduledFiles(res))
+            .then((res) => {
+                if (provider === 'crowdin') {
+                    appComponent.setCrowdinScheduleSync(res);
+                } else {
+                    appComponent.setIntegrationScheduleSync(res);
+                }
+            })
             .catch(e => catchRejection(e, 'Can\'t fetch file progress'));
     }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crowdin/app-project-module",
-  "version": "0.12.4",
+  "version": "0.13.1",
   "description": "Module that generates for you all common endpoints for serving standalone Crowdin App",
   "main": "out/index.js",
   "types": "out/index.d.ts",
@@ -12,7 +12,7 @@
     "test": "echo \"test not implemented\""
   },
   "dependencies": {
-    "@crowdin/crowdin-apps-functions": "0.0.3",
+    "@crowdin/crowdin-apps-functions": "0.1.0",
     "crypto-js": "^4.0.0",
     "express": "4.17.1",
     "express-handlebars": "^5.3.4",