@crowdin/app-project-module 3.0.0 → 3.1.0

package/out/app-test/integration/index.js

@@ -21,15 +21,15 @@ exports.mockProjectId = 1;
 exports.mockStoragesById = {};
 exports.mockFiles = [];
 exports.mockDirectories = [];
-jest.mock('axios', () => mock_axios_1.mockAxios);
-jest.mock('@crowdin/crowdin-api-client', () => jest.fn().mockImplementation(() => mock_crowdin_api_client_1.mockCrowdinApiClient));
+globals_1.jest.mock('axios', () => mock_axios_1.mockAxios);
+globals_1.jest.mock('@crowdin/crowdin-api-client', () => globals_1.jest.fn().mockImplementation(() => mock_crowdin_api_client_1.mockCrowdinApiClient));
 const runProjectIntegrationTests = ({ getAppConfig, integrationTestConfig, }) => {
     (0, globals_1.describe)('Run integration module tests', () => {
         var _a, _b, _c;
         if (!((_a = integrationTestConfig.getIntegrationFiles) === null || _a === void 0 ? void 0 : _a.expected.length)) {
             throw new Error('Please provide a valid expected files');
         }
-        beforeAll(() => __awaiter(void 0, void 0, void 0, function* () {
+        (0, globals_1.beforeAll)(() => __awaiter(void 0, void 0, void 0, function* () {
             if (integrationTestConfig === null || integrationTestConfig === void 0 ? void 0 : integrationTestConfig.beforeAll) {
                 yield integrationTestConfig.beforeAll();
             }

package/out/app-test/integration/mocks/mock-axios.js

@@ -1,14 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.mockAxios = void 0;
+const globals_1 = require("@jest/globals");
 const index_1 = require("../index");
-const mockOriginalAxios = jest.requireActual('axios');
-const mock = Object.assign(Object.assign({}, mockOriginalAxios), { get: jest.fn((url) => {
-        expect(url).toMatch(/^file-id:(\d+)$/);
+const mockOriginalAxios = globals_1.jest.requireActual('axios');
+const mock = Object.assign(Object.assign({}, mockOriginalAxios), { get: globals_1.jest.fn((url) => {
+        (0, globals_1.expect)(url).toMatch(/^file-id:(\d+)$/);
         const fileId = Number(url.replace('file-id:', ''));
         const file = index_1.mockFiles.find(({ id }) => id === fileId);
         const storageId = file === null || file === void 0 ? void 0 : file.storageId;
-        expect(storageId).not.toBeUndefined();
+        (0, globals_1.expect)(storageId).not.toBeUndefined();
         return {
             // @ts-ignore
             data: index_1.mockStoragesById[storageId].data,

package/out/app-test/integration/mocks/mock-crowdin-api-client.js

@@ -57,7 +57,7 @@ const sleep = () => __awaiter(void 0, void 0, void 0, function* () {
         }, Math.floor(Math.random() * (max - min) + min));
     });
 });
-const mockBuildProjectFileTranslation = jest.fn((projectId, fileId) => __awaiter(void 0, void 0, void 0, function* () {
+const mockBuildProjectFileTranslation = globals_1.jest.fn((projectId, fileId) => __awaiter(void 0, void 0, void 0, function* () {
     (0, globals_1.expect)(projectId).toBe(index_1.mockProjectId);
     yield sleep();
     return {
@@ -98,17 +98,17 @@ const mockProjectsGroupsApi = {
         return getProjectResponse;
     },
 };
-const mockCreateDirectory = jest.fn((projectId, params) => __awaiter(void 0, void 0, void 0, function* () {
+const mockCreateDirectory = globals_1.jest.fn((projectId, params) => __awaiter(void 0, void 0, void 0, function* () {
     (0, globals_1.expect)(projectId).toBe(index_1.mockProjectId);
     yield sleep();
     return crowdin_storage_1.crowdinFolders.create(params);
 }));
-const mockCreateFile = jest.fn((projectId, params) => __awaiter(void 0, void 0, void 0, function* () {
+const mockCreateFile = globals_1.jest.fn((projectId, params) => __awaiter(void 0, void 0, void 0, function* () {
     (0, globals_1.expect)(projectId).toBe(index_1.mockProjectId);
     yield sleep();
     return crowdin_storage_1.crowdinFiles.create(params);
 }));
-const mockListProjectDirectories = jest.fn((projectId) => __awaiter(void 0, void 0, void 0, function* () {
+const mockListProjectDirectories = globals_1.jest.fn((projectId) => __awaiter(void 0, void 0, void 0, function* () {
     (0, globals_1.expect)(projectId).toBe(index_1.mockProjectId);
     return {
         // data: options ? [] : mockDirectories.map((d: SourceFilesModel.Directory) => ({ data: d })),
@@ -119,7 +119,7 @@ const mockListProjectDirectories = jest.fn((projectId) => __awaiter(void 0, void
         },
     };
 }));
-const mockListProjectFiles = jest.fn((projectId) => __awaiter(void 0, void 0, void 0, function* () {
+const mockListProjectFiles = globals_1.jest.fn((projectId) => __awaiter(void 0, void 0, void 0, function* () {
     (0, globals_1.expect)(projectId).toBe(index_1.mockProjectId);
     return {
         data: index_1.mockFiles.map((d) => ({ data: d })),
@@ -129,7 +129,7 @@ const mockListProjectFiles = jest.fn((projectId) => __awaiter(void 0, void 0, vo
         },
     };
 }));
-const mockOriginalClient = jest.requireActual('@crowdin/crowdin-api-client');
+const mockOriginalClient = globals_1.jest.requireActual('@crowdin/crowdin-api-client');
 exports.mockCrowdinApiClient = Object.assign(Object.assign({}, mockOriginalClient), { sourceFilesApi: {
         withFetchAll: () => {
             return {

package/out/app-test/integration/update-crowdin.js

@@ -72,7 +72,7 @@ const updateCrowdinTest = (_a) => __awaiter(void 0, [_a], void 0, function* ({ a
     }
     const client = new crowdin_api_client_1.default({ token: 'fakeToken' });
     const request = getFilesFromTree(expectedTree);
-    const updateProgressMock = jest.fn(() => __awaiter(void 0, void 0, void 0, function* () {
+    const updateProgressMock = globals_1.jest.fn(() => __awaiter(void 0, void 0, void 0, function* () {
         return { isCanceled: false };
     }));
     const rootFolder = (0, crowdin_storage_1.getRootFolder)(appConfig);
@@ -106,10 +106,10 @@ const updateCrowdinTest = (_a) => __awaiter(void 0, [_a], void 0, function* ({ a
                 },
                 update: updateProgressMock,
                 type: types_1.JobClientType.MANUAL,
-                fetchTranslation: jest.fn(),
-                translationUploaded: jest.fn(),
-                markFilesAsUnsynced: jest.fn(),
-                unmarkFilesAsUnsynced: jest.fn(),
+                fetchTranslation: globals_1.jest.fn(),
+                translationUploaded: globals_1.jest.fn(),
+                markFilesAsUnsynced: globals_1.jest.fn(),
+                unmarkFilesAsUnsynced: globals_1.jest.fn(),
             },
         });
     }, 'Fail to run method updateCrowdin()');

package/out/app-test/integration/update-integration.js

@@ -33,7 +33,7 @@ const updateIntegrationTest = (_a) => __awaiter(void 0, [_a], void 0, function*
     }
     const { updateIntegration, settings, integrationCredentials } = integrationTestConfig;
     const client = new crowdin_api_client_1.default({ token: 'fakeToken' });
-    const updateProgressMock = jest.fn(() => __awaiter(void 0, void 0, void 0, function* () {
+    const updateProgressMock = globals_1.jest.fn(() => __awaiter(void 0, void 0, void 0, function* () {
         return { isCanceled: false };
     }));
     const request = (0, exports.getUpdateIntegrationRequest)();
@@ -63,10 +63,10 @@ const updateIntegrationTest = (_a) => __awaiter(void 0, [_a], void 0, function*
                 },
                 update: updateProgressMock,
                 type: types_1.JobClientType.MANUAL,
-                fetchTranslation: jest.fn(),
-                translationUploaded: jest.fn(),
-                markFilesAsUnsynced: jest.fn(),
-                unmarkFilesAsUnsynced: jest.fn(),
+                fetchTranslation: globals_1.jest.fn(),
+                translationUploaded: globals_1.jest.fn(),
+                markFilesAsUnsynced: globals_1.jest.fn(),
+                unmarkFilesAsUnsynced: globals_1.jest.fn(),
             },
         });
     }, 'Fail to run method updateIntegration()');

package/out/modules/integration/handlers/user-error-detail.d.ts

@@ -0,0 +1,2 @@
+import { Response } from 'express';
+export default function handle(): (req: import("express").Request | import("../../..").CrowdinClientRequest, res: Response, next: Function) => void;

package/out/modules/integration/handlers/user-error-detail.js

@@ -0,0 +1,48 @@
+"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 });
+exports.default = handle;
+const storage_1 = require("../../../storage");
+const util_1 = require("../../../util");
+const logger_1 = require("../../../util/logger");
+const INVALID_DATA = JSON.stringify({
+    appData: { Warning: 'Invalid response data. Please contact the Crowdin support manager.' },
+});
+function handle() {
+    return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
+        const id = Number.parseInt(`${req.params.id}`, 10);
+        if (!Number.isInteger(id)) {
+            return res.status(400).json({
+                error: {
+                    message: 'Invalid error log id',
+                },
+            });
+        }
+        const userError = yield (0, storage_1.getStorage)().getUserError({
+            id,
+            crowdinId: req.crowdinContext.crowdinId,
+            integrationId: req.crowdinContext.clientId,
+        });
+        if (!userError) {
+            req.logInfo(`Error log ${id} not found`);
+            return res.status(404).json({
+                error: {
+                    message: `Error log with ID ${id} not found`,
+                },
+            });
+        }
+        if (!userError.data || !(0, util_1.isJson)(userError.data)) {
+            (0, logger_1.logError)(userError);
+            return res.send({ data: INVALID_DATA });
+        }
+        res.send({ data: userError.data });
+    }));
+}

package/out/modules/integration/handlers/user-errors.d.ts

@@ -1,2 +1,8 @@
 import { Response } from 'express';
+export declare function parseUserErrorsQuery(query?: any): {
+    limit: number;
+    offset: number;
+    orderDirection: "asc" | "desc";
+    search: any;
+};
 export default function handle(): (req: import("express").Request | import("../../..").CrowdinClientRequest, res: Response, next: Function) => void;

package/out/modules/integration/handlers/user-errors.js

@@ -9,27 +9,49 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseUserErrorsQuery = parseUserErrorsQuery;
 exports.default = handle;
 const storage_1 = require("../../../storage");
 const util_1 = require("../../../util");
-const logger_1 = require("../../../util/logger");
+const DEFAULT_LIMIT = 10;
+const MAX_LIMIT = 100;
+const MAX_SEARCH_LENGTH = 255;
+function parseInteger(value, fallback) {
+    const parsed = Number.parseInt(`${value}`, 10);
+    return Number.isFinite(parsed) ? parsed : fallback;
+}
+function parseUserErrorsQuery(query = {}) {
+    const search = typeof query.search === 'string' ? query.search.trim().slice(0, MAX_SEARCH_LENGTH) : '';
+    return {
+        limit: Math.min(Math.max(parseInteger(query.limit, DEFAULT_LIMIT), 1), MAX_LIMIT),
+        offset: Math.max(parseInteger(query.offset, 0), 0),
+        orderDirection: (query.order === 'asc' ? 'asc' : 'desc'),
+        search: search || undefined,
+    };
+}
 function handle() {
     return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
-        var _a;
-        const userTimezone = (yield req.crowdinApiClient.usersApi.getAuthenticatedUser()).data.timezone;
-        req.logInfo(`Loading user errors for crowdinId ${req.crowdinContext.crowdinId} and integrationId ${req.crowdinContext.clientId}`);
-        const userErrors = (_a = (yield (0, storage_1.getStorage)().getAllUserErrors(req.crowdinContext.crowdinId, req.crowdinContext.clientId))) === null || _a === void 0 ? void 0 : _a.map((userError) => {
-            if (!(0, util_1.isJson)(userError.data)) {
-                (0, logger_1.logError)(userError);
-                userError.data = JSON.stringify({
-                    appData: { Warning: 'Invalid response data. Please contact the Crowdin support manager.' },
-                });
-            }
-            const date = new Date(+userError.createdAt);
-            const formattedDate = (0, util_1.getFormattedDate)({ date, userTimezone });
-            return Object.assign(Object.assign({}, userError), { formattedDate });
-        });
-        req.logInfo(`Returning ${userErrors === null || userErrors === void 0 ? void 0 : userErrors.length} user errors`);
-        res.send(userErrors);
+        const { limit, offset, orderDirection, search } = parseUserErrorsQuery(req.query);
+        const filter = {
+            crowdinId: req.crowdinContext.crowdinId,
+            integrationId: req.crowdinContext.clientId,
+            search,
+        };
+        req.logInfo(`Loading user errors for crowdinId ${req.crowdinContext.crowdinId} and integrationId ${req.crowdinContext.clientId} (limit ${limit}, offset ${offset})`);
+        const [userTimezone, userErrors, total] = yield Promise.all([
+            req.crowdinApiClient.usersApi
+                .getAuthenticatedUser()
+                .then(({ data }) => data.timezone)
+                .catch((e) => {
+                const errorMessage = e instanceof Error ? e.message : String(e);
+                req.logError(`Can't load user timezone, falling back to server timezone: ${errorMessage}`);
+                return undefined;
+            }),
+            (0, storage_1.getStorage)().getUserErrors(Object.assign(Object.assign({}, filter), { limit, offset, orderDirection })),
+            (0, storage_1.getStorage)().countUserErrors(filter),
+        ]);
+        const data = userErrors.map((userError) => (Object.assign(Object.assign({}, userError), { formattedDate: (0, util_1.getFormattedDate)({ date: new Date(+userError.createdAt), userTimezone }) })));
+        req.logInfo(`Returning ${data.length} of ${total} user errors`);
+        res.send({ data, total });
     }));
 }

package/out/modules/integration/index.js

@@ -43,6 +43,7 @@ const settings_save_1 = __importDefault(require("./handlers/settings-save"));
 const subscription_info_1 = __importDefault(require("./handlers/subscription-info"));
 const sync_settings_1 = __importDefault(require("./handlers/sync-settings"));
 const sync_settings_save_1 = __importDefault(require("./handlers/sync-settings-save"));
+const user_error_detail_1 = __importDefault(require("./handlers/user-error-detail"));
 const user_errors_1 = __importDefault(require("./handlers/user-errors"));
 const users_1 = __importDefault(require("./handlers/users"));
 const invite_users_1 = __importDefault(require("./handlers/invite-users"));
@@ -240,6 +241,13 @@ function register({ config, app }) {
         moduleKey: integrationLogic.key,
         isIntegration: true,
     }), (0, integration_credentials_1.default)({ config, integration: integrationLogic }), (0, user_errors_1.default)());
+    app.get('/api/user-errors/:id', json_response_1.handle, (0, crowdin_client_1.handle)({
+        config,
+        optional: false,
+        checkSubscriptionExpiration: true,
+        moduleKey: integrationLogic.key,
+        isIntegration: true,
+    }), (0, integration_credentials_1.default)({ config, integration: integrationLogic }), (0, user_error_detail_1.default)());
     app.get('/api/users', json_response_1.handle, (0, crowdin_client_1.handle)({
         config,
         optional: false,