@crowdin/app-project-module 0.24.3 → 0.25.1

package/README.md

@@ -133,26 +133,26 @@ const configuration = {
             const directories = await client.sourceFilesApi
                 .withFetchAll()
                 .listProjectDirectories(projectId);
-            const { folder, files } = await crowdinAppFunctions.getOrCreateFolder(
-                directories.data.map((d) => d.data),
+            const { folder, files } = await crowdinAppFunctions.getOrCreateFolder({
+                directories: directories.data.map((d) => d.data),
                 client,
                 projectId,
-                'Folder from integration',
-                rootFolder
-            );
+                directoryName: 'Folder from integration',
+                parentDirectory: rootFolder
+            });
             const fileContent = {
                 title: 'Hello World',
             };
-            await crowdinAppFunctions.updateOrCreateFile(
+            await crowdinAppFunctions.updateOrCreateFile({
                 client,
                 projectId,
-                'integration.json',
-                'Sample file from integration',
-                'json',
-                folder.id,
-                fileContent,
-                files.find((f) => f.name === 'integration.json'),
-            );
+                name: 'integration.json',
+                title: 'Sample file from integration',
+                type: 'json',
+                directoryId: folder.id,
+                data: fileContent,
+                file: files.find((f) => f.name === 'integration.json'),
+            });
             return {
                 message: 'Some message',
             };
@@ -163,13 +163,13 @@ const configuration = {
             const directories = await client.sourceFilesApi
                 .withFetchAll()
                 .listProjectDirectories(projectId);
-            const { files } = await crowdinAppFunctions.getFolder(
-                directories.data.map((d) => d.data),
+            const { files } = await crowdinAppFunctions.getFolder({
+                directories: directories.data.map((d) => d.data),
                 client,
                 projectId,
-                'Folder from integration',
-                rootFolder
-            );
+                directoryName: 'Folder from integration',
+                parentDirectory: rootFolder
+            });
             const file = files.find((f) => f.name === 'integration.json');
             if (file) {
                 const translationsLink =
@@ -816,7 +816,8 @@ const configuration = {
     projectReports: { //can be editorRightPanel, projectMenu, projectTools, projectMenuCrowdsource
       imagePath: __dirname + '/' + 'reports.png',
       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)
+      uiPath: __dirname + '/' + 'public', // folder where UI of the module is located (js, html, css files)
+      allowUnauthorized: true //make module publicly available without crowdin context
     },
 };
 

package/out/handlers/install.js

@@ -46,14 +46,27 @@ function fetchToken(config, event) {
     var _a, _b;
     return __awaiter(this, void 0, void 0, function* () {
         if (config.authenticationType === models_1.AuthenticationType.CODE) {
-            const token = yield (0, crowdin_apps_functions_1.generateOAuthToken)(config.clientId, config.clientSecret, event.code || '', (_a = config.crowdinUrls) === null || _a === void 0 ? void 0 : _a.accountUrl);
+            const token = yield (0, crowdin_apps_functions_1.generateOAuthToken)({
+                clientId: config.clientId,
+                clientSecret: config.clientSecret,
+                code: event.code || '',
+                url: (_a = config.crowdinUrls) === null || _a === void 0 ? void 0 : _a.accountUrl,
+            });
             return {
                 accessToken: (0, util_1.encryptData)(config, token.accessToken),
                 refreshToken: (0, util_1.encryptData)(config, token.refreshToken),
                 expiresIn: token.expiresIn,
             };
         }
-        const token = yield (0, crowdin_apps_functions_1.fetchAppToken)(config.identifier, event.appSecret, config.clientId, config.clientSecret, event.domain || '', event.userId, (_b = config.crowdinUrls) === null || _b === void 0 ? void 0 : _b.accountUrl);
+        const token = yield (0, crowdin_apps_functions_1.fetchAppToken)({
+            appId: config.identifier,
+            appSecret: event.appSecret,
+            clientId: config.clientId,
+            clientSecret: config.clientSecret,
+            domain: event.domain || '',
+            userId: event.userId,
+            url: (_b = config.crowdinUrls) === null || _b === void 0 ? void 0 : _b.accountUrl,
+        });
         return {
             accessToken: (0, util_1.encryptData)(config, token.accessToken),
             expiresIn: token.expiresIn,

package/out/index.js

@@ -143,28 +143,28 @@ function addCrowdinEndpoints(app, config) {
     }
     if (config.profileResourcesMenu) {
         app.get('/logo/resources/logo.png', (req, res) => { var _a; return res.sendFile(((_a = config.profileResourcesMenu) === null || _a === void 0 ? void 0 : _a.imagePath) || config.imagePath || (0, path_1.join)(__dirname, 'logo.png')); });
-        app.use('/resources', (0, ui_module_1.default)(config), express_1.default.static(config.profileResourcesMenu.uiPath));
+        app.use('/resources', (0, ui_module_1.default)(config, config.profileResourcesMenu.allowUnauthorized), express_1.default.static(config.profileResourcesMenu.uiPath));
     }
     if (config.organizationMenu) {
         app.get('/logo/resources/logo.png', (req, res) => { var _a; return res.sendFile(((_a = config.organizationMenu) === null || _a === void 0 ? void 0 : _a.imagePath) || config.imagePath || (0, path_1.join)(__dirname, 'logo.png')); });
-        app.use('/resources', (0, ui_module_1.default)(config), express_1.default.static(config.organizationMenu.uiPath));
+        app.use('/resources', (0, ui_module_1.default)(config, config.organizationMenu.allowUnauthorized), express_1.default.static(config.organizationMenu.uiPath));
     }
     if (config.editorRightPanel) {
-        app.use('/editor-panels', (0, ui_module_1.default)(config), express_1.default.static(config.editorRightPanel.uiPath));
+        app.use('/editor-panels', (0, ui_module_1.default)(config, config.editorRightPanel.allowUnauthorized), express_1.default.static(config.editorRightPanel.uiPath));
     }
     if (config.projectMenu) {
-        app.use('/project-menu', (0, ui_module_1.default)(config), express_1.default.static(config.projectMenu.uiPath));
+        app.use('/project-menu', (0, ui_module_1.default)(config, config.projectMenu.allowUnauthorized), express_1.default.static(config.projectMenu.uiPath));
     }
     if (config.projectMenuCrowdsource) {
-        app.use('/project-menu-crowdsource', (0, ui_module_1.default)(config), express_1.default.static(config.projectMenuCrowdsource.uiPath));
+        app.use('/project-menu-crowdsource', (0, ui_module_1.default)(config, config.projectMenuCrowdsource.allowUnauthorized), express_1.default.static(config.projectMenuCrowdsource.uiPath));
     }
     if (config.projectTools) {
         app.get('/logo/tools/logo.png', (req, res) => { var _a; return res.sendFile(((_a = config.projectTools) === null || _a === void 0 ? void 0 : _a.imagePath) || config.imagePath || (0, path_1.join)(__dirname, 'logo.png')); });
-        app.use('/tools', (0, ui_module_1.default)(config), express_1.default.static(config.projectTools.uiPath));
+        app.use('/tools', (0, ui_module_1.default)(config, config.projectTools.allowUnauthorized), express_1.default.static(config.projectTools.uiPath));
     }
     if (config.projectReports) {
         app.get('/logo/reports/logo.png', (req, res) => { var _a; return res.sendFile(((_a = config.projectReports) === null || _a === void 0 ? void 0 : _a.imagePath) || config.imagePath || (0, path_1.join)(__dirname, 'logo.png')); });
-        app.use('/reports', (0, ui_module_1.default)(config), express_1.default.static(config.projectReports.uiPath));
+        app.use('/reports', (0, ui_module_1.default)(config, config.projectReports.allowUnauthorized), express_1.default.static(config.projectReports.uiPath));
     }
     return {
         getMetadata: storage.getStorage().getMetadata.bind(storage.getStorage()),

package/out/middlewares/ui-module.d.ts

@@ -1,4 +1,4 @@
 /// <reference types="qs" />
 import { Request, Response } from 'express';
 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;
+export default function handle(config: Config, allowUnauthorized?: boolean): (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/middlewares/ui-module.js

@@ -13,8 +13,12 @@ const crowdin_apps_functions_1 = require("@crowdin/crowdin-apps-functions");
 const storage_1 = require("../storage");
 const util_1 = require("../util");
 const connection_1 = require("../util/connection");
-function handle(config) {
+function handle(config, allowUnauthorized = false) {
     return (0, util_1.runAsyncWrapper)((req, res, next) => __awaiter(this, void 0, void 0, function* () {
+        if (allowUnauthorized) {
+            next();
+            return;
+        }
         const tokenJwt = req.query.tokenJwt;
         if (!tokenJwt) {
             return res.status(403).send({ error: 'Access denied' });

package/out/models/index.d.ts

@@ -566,6 +566,10 @@ export interface UiModule {
      * page name (default index.html)
      */
     fileName?: string;
+    /**
+     * make module publicly available without crowdin context
+     */
+    allowUnauthorized?: boolean;
 }
 export interface EditorPanels extends UiModule {
     /**

package/out/util/connection.js

@@ -23,14 +23,27 @@ function refreshToken(config, credentials) {
     var _a, _b;
     return __awaiter(this, void 0, void 0, function* () {
         if (config.authenticationType === models_1.AuthenticationType.CODE) {
-            const token = yield (0, crowdin_apps_functions_1.refreshOAuthToken)(config.clientId, config.clientSecret, (0, _1.decryptData)(config, credentials.refreshToken), (_a = config.crowdinUrls) === null || _a === void 0 ? void 0 : _a.accountUrl);
+            const token = yield (0, crowdin_apps_functions_1.refreshOAuthToken)({
+                clientId: config.clientId,
+                clientSecret: config.clientSecret,
+                refreshToken: (0, _1.decryptData)(config, credentials.refreshToken),
+                url: (_a = config.crowdinUrls) === null || _a === void 0 ? void 0 : _a.accountUrl,
+            });
             return {
                 accessToken: (0, _1.encryptData)(config, token.accessToken),
                 refreshToken: (0, _1.encryptData)(config, token.refreshToken),
                 expiresIn: token.expiresIn,
             };
         }
-        const token = yield (0, crowdin_apps_functions_1.fetchAppToken)(config.identifier, credentials.appSecret, config.clientId, config.clientSecret, credentials.domain || '', credentials.userId, (_b = config.crowdinUrls) === null || _b === void 0 ? void 0 : _b.accountUrl);
+        const token = yield (0, crowdin_apps_functions_1.fetchAppToken)({
+            appId: config.identifier,
+            appSecret: credentials.appSecret,
+            clientId: config.clientId,
+            clientSecret: config.clientSecret,
+            domain: credentials.domain || '',
+            userId: credentials.userId,
+            url: (_b = config.crowdinUrls) === null || _b === void 0 ? void 0 : _b.accountUrl,
+        });
         return {
             accessToken: (0, _1.encryptData)(config, token.accessToken),
             expiresIn: token.expiresIn,

package/out/util/defaults.js

@@ -37,7 +37,12 @@ function getRootFolder(config, integration, client, projectId) {
         }
         const folder = integration.appFolderName || config.name;
         const directories = (yield client.sourceFilesApi.withFetchAll().listProjectDirectories(projectId)).data.map((d) => d.data);
-        const { folder: rootFolder } = yield crowdinAppFunctions.getOrCreateFolder(directories, client, projectId, folder);
+        const { folder: rootFolder } = yield crowdinAppFunctions.getOrCreateFolder({
+            directories,
+            client,
+            projectId,
+            directoryName: folder,
+        });
         return rootFolder;
     });
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crowdin/app-project-module",
-  "version": "0.24.3",
+  "version": "0.25.1",
   "description": "Module that generates for you all common endpoints for serving standalone Crowdin App",
   "main": "out/index.js",
   "types": "out/index.d.ts",
@@ -13,7 +13,7 @@
     "test": "jest --config jestconfig.json"
   },
   "dependencies": {
-    "@crowdin/crowdin-apps-functions": "~0.2.1",
+    "@crowdin/crowdin-apps-functions": "0.3.1",
     "@types/pg": "^8.6.5",
     "crypto-js": "^4.0.0",
     "express": "4.17.1",