@crowdin/app-project-module 0.53.0 → 0.54.0

package/out/modules/integration/handlers/crowdin-webhook.js

@@ -37,7 +37,11 @@ function filterSyncFiles(args) {
                 if (!projectData) {
                     projectData = yield crowdinClient.projectsGroupsApi.getProject(projectId);
                 }
-                addFileToResponse(fileId, projectData.data.targetLanguageIds);
+                const projectLanguages = projectData.data.targetLanguageIds;
+                if (projectData.data.inContext) {
+                    projectLanguages.push(projectData.data.inContextPseudoLanguageId);
+                }
+                addFileToResponse(fileId, projectLanguages);
                 continue;
             }
             // sync file that was selected for sync schedule

package/out/modules/integration/handlers/integration-data.js

@@ -38,6 +38,7 @@ function handle(integration) {
                 crowdinId: req.crowdinContext.crowdinId,
                 clientId: req.crowdinContext.clientId,
             });
+            res.send({ data: [], message: (e === null || e === void 0 ? void 0 : e.message) || e });
             throw e;
         }
         req.logInfo(`Integration data response ${JSON.stringify(files, null, 2)}`);

package/out/modules/integration/handlers/integration-login.js

@@ -14,11 +14,18 @@ const util_1 = require("../../../util");
 const logger_1 = require("../../../util/logger");
 function handle(config, integration) {
     return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
+        var _a;
         req.logInfo('Received integration login request');
+        let credentials = req.body.credentials;
+        if ((_a = integration.loginForm) === null || _a === void 0 ? void 0 : _a.performGetTokenRequest) {
+            req.logInfo('Performing custom get bearer token request');
+            const tokenCredentials = yield integration.loginForm.performGetTokenRequest(credentials);
+            credentials = Object.assign(Object.assign({}, credentials), { expireIn: Number(tokenCredentials.expires_in) + Date.now() / 1000, accessToken: tokenCredentials.access_token, refreshToken: tokenCredentials.refresh_token });
+        }
         if (integration.checkConnection) {
             try {
                 req.logInfo('Checking the integration credentials');
-                yield integration.checkConnection(req.body.credentials);
+                yield integration.checkConnection(credentials);
             }
             catch (e) {
                 yield (0, logger_1.handleUserError)({
@@ -35,7 +42,7 @@ function handle(config, integration) {
             req.logInfo('Deleting old credentials');
             yield (0, storage_1.getStorage)().deleteIntegrationCredentials(req.crowdinContext.clientId);
         }
-        yield (0, storage_1.getStorage)().saveIntegrationCredentials(req.crowdinContext.clientId, (0, util_1.encryptData)(config, JSON.stringify(req.body.credentials)), req.crowdinContext.crowdinId);
+        yield (0, storage_1.getStorage)().saveIntegrationCredentials(req.crowdinContext.clientId, (0, util_1.encryptData)(config, JSON.stringify(credentials)), req.crowdinContext.crowdinId);
         res.status(204).end();
     }));
 }

package/out/modules/integration/types.d.ts

@@ -145,6 +145,18 @@ export interface IntegrationLogic {
 }
 export interface LoginForm {
     fields: FormEntity[];
+    /**
+     * Override to implement request for retrieving access token (and refresh token if 'refresh' is enabled)
+     */
+    performGetTokenRequest?: (fieldsCredentials: any) => Promise<LoginFormTokenResponse>;
+    /**
+     * Override to implement request for refreshing token (only if 'refresh' is enabled)
+     */
+    performRefreshTokenRequest?: (currentCredentials: any) => Promise<LoginFormTokenResponse>;
+    /**
+     * default 'false' which means that the access token has no expiration date
+     */
+    refresh?: boolean;
 }
 export interface OAuthLogin {
     /**
@@ -287,7 +299,7 @@ export interface FormField {
     helpText?: string;
     helpTextHtml?: string;
     label: string;
-    type?: 'text' | 'password' | 'checkbox' | 'select' | 'textarea' | 'file';
+    type?: 'text' | 'password' | 'checkbox' | 'select' | 'textarea' | 'file' | 'notice';
     defaultValue?: any;
     /**
      * only for select
@@ -312,6 +324,14 @@ export interface FormField {
      * field dependency settings
      */
     dependencySettings?: string;
+    /**
+     * only for notice type
+     */
+    noticeType?: string;
+    /**
+     * only for notice type
+     */
+    noIcon?: boolean;
 }
 type NoticeType = 'info' | 'warning' | 'danger' | 'success' | 'error' | 'dataLostWarning';
 export interface IntegrationCredentials {
@@ -432,4 +452,9 @@ export interface AppSettings {
     'new-integration-files'?: boolean;
     [key: string]: any;
 }
+interface LoginFormTokenResponse {
+    access_token: string;
+    expires_in: number;
+    refresh_token: string;
+}
 export {};

package/out/modules/integration/util/cron.js

@@ -131,6 +131,10 @@ function filesCron({ config, integration, period, }) {
                 (0, logger_1.log)(`Subscription expired. Skipping job [${period}] for organization ${crowdinCredentials.id}`);
                 continue;
             }
+            const projectData = (yield crowdinClient.projectsGroupsApi.getProject(projectId))
+                .data;
+            // eslint-disable-next-line @typescript-eslint/camelcase
+            context.jwtPayload.context.project_identifier = projectData.identifier;
             const rootFolder = yield (0, defaults_1.getRootFolder)(config, integration, crowdinClient, projectId);
             const apiCredentials = yield (0, connection_1.prepareIntegrationCredentials)(config, integration, integrationCredentials);
             if (!integration.webhooks &&
@@ -139,13 +143,13 @@ function filesCron({ config, integration, period, }) {
                 newFiles = yield getAllNewFiles({
                     config,
                     integration,
+                    projectData,
+                    syncSettings,
                     crowdinApiClient: crowdinClient,
                     crowdinId: crowdinCredentials.id,
                     integrationCredentials: apiCredentials,
                     integrationId: integrationCredentials.id,
-                    projectId,
                     integrationSettings: intConfig,
-                    syncSettings,
                 });
             }
             if (integration.webhooks) {
@@ -192,6 +196,9 @@ function filesCron({ config, integration, period, }) {
                     }
                 }
                 const apiCredentials = yield (0, connection_1.prepareIntegrationCredentials)(config, integration, integrationCredentials);
+                if (!(intConfig === null || intConfig === void 0 ? void 0 : intConfig.inContext)) {
+                    removeInContextLanguage(filesToProcess, projectData);
+                }
                 try {
                     yield (0, job_1.runAsJob)({
                         integrationId: syncSettings.integrationId,
@@ -215,7 +222,7 @@ function filesCron({ config, integration, period, }) {
                 }
                 catch (e) {
                     (0, logger_1.logError)(e, context);
-                    throw e;
+                    continue;
                 }
                 if (Object.keys(newFiles).length) {
                     yield (0, storage_1.getStorage)().updateSyncSettings(JSON.stringify(Object.assign(Object.assign({}, files), newFiles)), syncSettings.integrationId, syncSettings.crowdinId, 'schedule', syncSettings.provider);
@@ -256,7 +263,7 @@ function filesCron({ config, integration, period, }) {
                 }
                 catch (e) {
                     (0, logger_1.logError)(e, context);
-                    throw e;
+                    continue;
                 }
                 if (Object.keys(newFiles).length) {
                     const newSyncSettingsFields = allIntFiles.map((file) => (Object.assign(Object.assign({}, file), { schedule: true, sync: false })));
@@ -276,12 +283,12 @@ function getFileDiff(currentFiles, savedFiles) {
 }
 function getAllNewFiles(args) {
     return __awaiter(this, void 0, void 0, function* () {
-        const { config, integration, crowdinApiClient, crowdinId, integrationCredentials, integrationId, projectId, integrationSettings, syncSettings, } = args;
+        const { config, integration, crowdinApiClient, crowdinId, integrationCredentials, integrationId, projectData, integrationSettings, syncSettings, } = args;
         let currentFileSnapshot = [];
         const fileSnapshotData = yield (0, storage_1.getStorage)().getFilesSnapshot(integrationId, crowdinId, syncSettings.provider);
         const snapshotFiles = (fileSnapshotData === null || fileSnapshotData === void 0 ? void 0 : fileSnapshotData.files) ? JSON.parse(fileSnapshotData.files) : [];
         if (syncSettings.provider === types_1.Provider.CROWDIN) {
-            currentFileSnapshot = yield (0, snapshot_1.getCrowdinSnapshot)(config, integration, crowdinApiClient, projectId, integrationSettings);
+            currentFileSnapshot = yield (0, snapshot_1.getCrowdinSnapshot)(config, integration, crowdinApiClient, projectData.id, integrationSettings);
         }
         else {
             currentFileSnapshot = yield (0, snapshot_1.getIntegrationSnapshot)(integration, integrationCredentials, integrationSettings);
@@ -298,8 +305,10 @@ function getAllNewFiles(args) {
         }
         else {
             const files = {};
-            const projectData = yield crowdinApiClient.projectsGroupsApi.getProject(projectId);
-            const targetLanguages = projectData.data.targetLanguageIds;
+            const targetLanguages = projectData.targetLanguageIds;
+            if (projectData.inContext) {
+                targetLanguages.push(projectData.inContextPseudoLanguageId);
+            }
             if (integrationSettings[`new-${syncSettings.provider}-files`]) {
                 for (const file of onlyFiles) {
                     files[file.id] = targetLanguages;
@@ -429,3 +438,13 @@ function removeFinishedJobs() {
     });
 }
 exports.removeFinishedJobs = removeFinishedJobs;
+function removeInContextLanguage(filesToProcess, projectData) {
+    (0, logger_1.log)('Removing in-context language from files to process');
+    if (!projectData.inContext) {
+        return;
+    }
+    for (const fileId in filesToProcess) {
+        filesToProcess[fileId] = filesToProcess[fileId].filter((language) => language !== projectData.inContextPseudoLanguageId);
+    }
+    (0, logger_1.log)('In-context language(' + projectData.inContextPseudoLanguageId + ') removed from files to process');
+}

package/out/modules/integration/util/defaults.js

@@ -138,15 +138,24 @@ function applyIntegrationModuleDefaults(config, integration) {
             ],
         };
     }
-    if (integration.withCronSync || integration.webhooks) {
-        const getUserSettings = integration.getConfiguration;
-        integration.getConfiguration = (projectId, crowdinClient, integrationCredentials) => __awaiter(this, void 0, void 0, function* () {
-            var _c, _d;
-            let fields = [];
-            if (getUserSettings) {
-                fields = yield getUserSettings(projectId, crowdinClient, integrationCredentials);
-            }
-            const defaultSettings = [];
+    const getUserSettings = integration.getConfiguration;
+    integration.getConfiguration = (projectId, crowdinClient, integrationCredentials) => __awaiter(this, void 0, void 0, function* () {
+        var _c, _d;
+        let fields = [];
+        const project = (yield crowdinClient.projectsGroupsApi.getProject(projectId));
+        if (getUserSettings) {
+            fields = yield getUserSettings(projectId, crowdinClient, integrationCredentials);
+        }
+        const defaultSettings = [];
+        if (project.data.inContext) {
+            defaultSettings.push({
+                key: 'inContext',
+                label: 'Show In-Context Pseudo Language',
+                type: 'checkbox',
+                defaultValue: 'false',
+            });
+        }
+        if (integration.withCronSync || integration.webhooks) {
             defaultSettings.push({
                 key: 'schedule',
                 label: 'Auto sync',
@@ -211,33 +220,30 @@ function applyIntegrationModuleDefaults(config, integration) {
                     type: 'checkbox',
                 });
             }
-            return [
-                ...defaultSettings,
-                {
-                    key: 'condition',
-                    label: 'Files export settings',
-                    type: 'select',
-                    defaultValue: '0',
-                    dependencySettings: JSON.stringify([{ '#schedule-settings': { type: '!equal', value: ['0'] } }]),
-                    options: [
-                        {
-                            value: '0',
-                            label: 'Export all',
-                        },
-                        {
-                            value: '1',
-                            label: 'Export translated only',
-                        },
-                        {
-                            value: '2',
-                            label: 'Export approved only',
-                        },
-                    ],
-                },
-                ...fields,
-            ];
-        });
-    }
+            defaultSettings.push({
+                key: 'condition',
+                label: 'Files export settings',
+                type: 'select',
+                defaultValue: '0',
+                dependencySettings: JSON.stringify([{ '#schedule-settings': { type: '!equal', value: ['0'] } }]),
+                options: [
+                    {
+                        value: '0',
+                        label: 'Export all',
+                    },
+                    {
+                        value: '1',
+                        label: 'Export translated only',
+                    },
+                    {
+                        value: '2',
+                        label: 'Export approved only',
+                    },
+                ],
+            });
+        }
+        return [...defaultSettings, ...fields];
+    });
     if (!integration.checkConnection) {
         integration.checkConnection = (apiCredentials) => __awaiter(this, void 0, void 0, function* () {
             yield integration.getIntegrationFiles(apiCredentials);

package/out/modules/integration/util/types.d.ts

@@ -1,4 +1,4 @@
-import Crowdin from '@crowdin/crowdin-api-client';
+import Crowdin, { ProjectsGroupsModel } from '@crowdin/crowdin-api-client';
 import { Config } from '../../../types';
 import { IntegrationLogic, IntegrationSyncSettings } from '../types';
 export declare enum JobType {
@@ -59,7 +59,7 @@ export interface GetAllNewFilesArgs {
     crowdinId: string;
     integrationCredentials: any;
     integrationId: string;
-    projectId: number;
+    projectData: ProjectsGroupsModel.ProjectSettings;
     integrationSettings: any;
     syncSettings: IntegrationSyncSettings;
 }