@crowdin/app-project-module 0.92.0 → 0.94.0

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

@@ -16,7 +16,7 @@ const types_1 = require("../types");
 const storage_1 = require("../../../storage");
 function handle(integration) {
     return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
-        var _a, _b, _c, _d, _e, _f, _g, _h;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j;
         const { parent_id: parentId, search, page } = req.query;
         req.logInfo('Received request to get integration data');
         let message;
@@ -34,15 +34,18 @@ function handle(integration) {
             else {
                 files = result || [];
             }
-            files = (0, files_1.skipFilesByRegex)(files, integration.skipIntegrationNodes);
+            if ((appSettings === null || appSettings === void 0 ? void 0 : appSettings.skipIntegrationNodesToggle) === true ||
+                ((appSettings === null || appSettings === void 0 ? void 0 : appSettings.skipIntegrationNodesToggle) === undefined && ((_a = integration.skipIntegrationNodesToggle) === null || _a === void 0 ? void 0 : _a.value))) {
+                files = (0, files_1.skipFilesByRegex)(files, integration.skipIntegrationNodes);
+            }
             if (integration.filterByPathIntegrationFiles) {
-                const includePatterns = (_a = appSettings === null || appSettings === void 0 ? void 0 : appSettings.includeByFilePath) === null || _a === void 0 ? void 0 : _a.split('\n').filter(Boolean);
-                const excludePatterns = (_b = appSettings === null || appSettings === void 0 ? void 0 : appSettings.excludeByFilePath) === null || _b === void 0 ? void 0 : _b.split('\n').filter(Boolean);
+                const includePatterns = (_b = appSettings === null || appSettings === void 0 ? void 0 : appSettings.includeByFilePath) === null || _b === void 0 ? void 0 : _b.split('\n').filter(Boolean);
+                const excludePatterns = (_c = appSettings === null || appSettings === void 0 ? void 0 : appSettings.excludeByFilePath) === null || _c === void 0 ? void 0 : _c.split('\n').filter(Boolean);
                 files = (0, files_1.filterFilesByPath)(files, includePatterns, excludePatterns);
             }
-            if (((_d = (_c = integration.filtering) === null || _c === void 0 ? void 0 : _c.integrationFileStatus) === null || _d === void 0 ? void 0 : _d.isNew) ||
-                ((_f = (_e = integration.filtering) === null || _e === void 0 ? void 0 : _e.integrationFileStatus) === null || _f === void 0 ? void 0 : _f.isUpdated) ||
-                ((_h = (_g = integration.filtering) === null || _g === void 0 ? void 0 : _g.integrationFileStatus) === null || _h === void 0 ? void 0 : _h.notSynced)) {
+            if (((_e = (_d = integration.filtering) === null || _d === void 0 ? void 0 : _d.integrationFileStatus) === null || _e === void 0 ? void 0 : _e.isNew) ||
+                ((_g = (_f = integration.filtering) === null || _f === void 0 ? void 0 : _f.integrationFileStatus) === null || _g === void 0 ? void 0 : _g.isUpdated) ||
+                ((_j = (_h = integration.filtering) === null || _h === void 0 ? void 0 : _h.integrationFileStatus) === null || _j === void 0 ? void 0 : _j.notSynced)) {
                 const syncedData = yield (0, storage_1.getStorage)().getSyncedData(clientId, crowdinId, types_1.Provider.INTEGRATION);
                 const syncedFiles = (syncedData === null || syncedData === void 0 ? void 0 : syncedData.files) ? JSON.parse(syncedData.files) : [];
                 const lastSyncTimestamp = (syncedData === null || syncedData === void 0 ? void 0 : syncedData.updatedAt) ? Number(syncedData.updatedAt) : null;

package/out/modules/integration/handlers/settings-save.js

@@ -25,6 +25,21 @@ function handle(config, integration) {
                 },
             });
         }
+        if (integration.validateSettings) {
+            const validationResult = yield integration.validateSettings({
+                client: req.crowdinApiClient,
+                credentials: req.integrationCredentials,
+                appSettings,
+            });
+            if (validationResult && Object.keys(validationResult).length > 0) {
+                return res.status(400).json({
+                    error: {
+                        type: 'validation_error',
+                        details: validationResult,
+                    },
+                });
+            }
+        }
         const clientId = req.crowdinContext.clientId;
         req.logInfo(`Saving settings ${JSON.stringify(appSettings, null, 2)}`);
         const integrationConfig = yield (0, storage_1.getStorage)().getIntegrationConfig(clientId);

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

@@ -19,6 +19,16 @@ export interface IntegrationLogic extends ModuleKey {
      * flag that defines if the app should have a dedicated root folder in Crowdin files, default 'false'
      */
     withRootFolder?: boolean;
+    /**
+     * Validate integration settings before saving
+     */
+    validateSettings?: ({ client, credentials, appSettings, }: {
+        client: Crowdin;
+        credentials: any;
+        appSettings: AppSettings;
+    }) => Promise<{
+        [key: string]: string;
+    } | null>;
     /**
      * function which will be used to check connection with integration service
      */
@@ -186,7 +196,18 @@ export interface IntegrationLogic extends ModuleKey {
         icon: boolean;
         close: boolean;
     };
+    /**
+     * Skip integration nodes
+     */
     skipIntegrationNodes?: SkipIntegrationNodes;
+    /**
+     * Configuration for toggling skipIntegrationNodes functionality with custom title and description
+     */
+    skipIntegrationNodesToggle?: {
+        title: string;
+        description: string;
+        value: boolean;
+    };
     /**
      * Async progress checking time interval to update job progress, im ms.
      *

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

@@ -287,6 +287,17 @@ function applyIntegrationModuleDefaults(config, integration) {
                 helpText: 'Enter the path patterns for files or folders to exclude. Use wildcard selectors like `*` and `**` to match multiple files. Example: `/drafts/**`',
             });
         }
+        if (integration.skipIntegrationNodes && integration.skipIntegrationNodesToggle) {
+            defaultSettings.push({
+                key: 'skipIntegrationNodesToggle',
+                label: integration.skipIntegrationNodesToggle.title,
+                type: 'checkbox',
+                helpText: integration.skipIntegrationNodesToggle.description,
+                defaultValue: integration.skipIntegrationNodesToggle.value,
+                category: types_1.DefaultCategory.GENERAL,
+                position: 7,
+            });
+        }
         return [...defaultSettings, ...fields];
     });
     if (!integration.checkConnection) {
@@ -391,13 +402,11 @@ function getOAuthLoginFormId(clientId) {
 exports.getOAuthLoginFormId = getOAuthLoginFormId;
 function groupFieldsByCategory(fields) {
     const groupedFields = fields.reduce((acc, field) => {
-        if ('key' in field) {
-            const category = field.category || types_1.DefaultCategory.GENERAL;
-            if (!acc[category]) {
-                acc[category] = [];
-            }
-            acc[category].push(field);
+        const category = (field === null || field === void 0 ? void 0 : field.category) || types_1.DefaultCategory.GENERAL;
+        if (!acc[category]) {
+            acc[category] = [];
         }
+        acc[category].push(field);
         return acc;
     }, {});
     // Sort fields by position within each category

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

@@ -51,6 +51,7 @@ function getOneLevelFetchingFiles(integration, integrationCredentials, integrati
     });
 }
 function getIntegrationSnapshot(integration, integrationCredentials, integrationSettings) {
+    var _a;
     return __awaiter(this, void 0, void 0, function* () {
         let files = [];
         let integrationData = [];
@@ -59,7 +60,10 @@ function getIntegrationSnapshot(integration, integrationCredentials, integration
         if (integration.integrationOneLevelFetching) {
             files = yield getOneLevelFetchingFiles(integration, integrationCredentials, integrationSettings, files);
         }
-        files = (0, files_1.skipFilesByRegex)(files, integration.skipIntegrationNodes);
+        if ((integrationSettings === null || integrationSettings === void 0 ? void 0 : integrationSettings.skipIntegrationNodesToggle) === true ||
+            ((integrationSettings === null || integrationSettings === void 0 ? void 0 : integrationSettings.skipIntegrationNodesToggle) === null && ((_a = integration.skipIntegrationNodesToggle) === null || _a === void 0 ? void 0 : _a.value))) {
+            files = (0, files_1.skipFilesByRegex)(files, integration.skipIntegrationNodes);
+        }
         // trick for compatibility in requests and set files
         files = files.map((file) => (Object.assign(Object.assign({}, file), { parentId: file.parent_id || file.parentId, 
             // eslint-disable-next-line @typescript-eslint/camelcase