@crowdin/app-project-module 0.35.1 → 0.36.0

package/out/handlers/file-processing/pre-post-process.js

@@ -52,6 +52,10 @@ function handle(baseConfig, config, folderName) {
             });
         }
         const fileProcessResult = yield config.fileProcess(body, fileContent, req.crowdinApiClient, req.crowdinContext, req.crowdinContext.jwtPayload.context.project_id);
+        if (fileProcessResult.notModified) {
+            res.sendStatus(304);
+            return;
+        }
         switch (body.jobType) {
             case models_1.ProcessFileJobType.PRE_IMPORT:
             case models_1.ProcessFileJobType.POST_EXPORT:

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

@@ -9,12 +9,61 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const models_1 = require("../../models");
 const storage_1 = require("../../storage");
+const logger_1 = require("../../util/logger");
 const util_1 = require("../../util");
 const cron_1 = require("../../util/cron");
-const file_snapshot_1 = require("../../util/file-snapshot");
 const webhooks_1 = require("../../util/webhooks");
+const models_1 = require("../../models");
+function filterSyncFiles(args) {
+    var _a, _b;
+    return __awaiter(this, void 0, void 0, function* () {
+        const { projectId, crowdinClient, events, syncFileSettings, appSettings } = args;
+        const files = {};
+        let projectData;
+        const addFileToResponse = (fileId, languages) => {
+            if (files[fileId]) {
+                files[fileId] = [...new Set([...files[fileId], ...languages])];
+            }
+            else {
+                files[fileId] = languages;
+            }
+        };
+        for (const event of events) {
+            const fileId = event.fileId;
+            const language = event.language;
+            // sync all new files
+            if (event.event === webhooks_1.HookEvents.fileAdded && appSettings['new-crowdin-files']) {
+                if (!projectData) {
+                    projectData = yield crowdinClient.projectsGroupsApi.getProject(projectId);
+                }
+                addFileToResponse(fileId, projectData.data.targetLanguageIds);
+                continue;
+            }
+            // sync file that was selected for sync schedule
+            if (syncFileSettings[fileId]) {
+                if (!syncFileSettings[fileId].includes(language)) {
+                    continue;
+                }
+                addFileToResponse(fileId, [language]);
+            }
+            else {
+                try {
+                    const crowdinFile = yield crowdinClient.sourceFilesApi.getFile(projectId, fileId);
+                    // sync file that in selected for sync schedule directory
+                    if (syncFileSettings[(_a = crowdinFile === null || crowdinFile === void 0 ? void 0 : crowdinFile.data) === null || _a === void 0 ? void 0 : _a.directoryId] &&
+                        syncFileSettings[(_b = crowdinFile === null || crowdinFile === void 0 ? void 0 : crowdinFile.data) === null || _b === void 0 ? void 0 : _b.directoryId].includes(language)) {
+                        addFileToResponse(fileId, [language]);
+                    }
+                }
+                catch (e) {
+                    (0, logger_1.logError)(e);
+                }
+            }
+        }
+        return files;
+    });
+}
 function handle(config, integration) {
     return (0, util_1.runAsyncWrapper)((req, res) => __awaiter(this, void 0, void 0, function* () {
         var _a, _b;
@@ -22,31 +71,45 @@ function handle(config, integration) {
         const webhookUrlParam = req.query[urlParam];
         let filesToSync;
         if (webhookUrlParam) {
-            const { projectId, crowdinClient, preparedIntegrationCredentials, rootFolder, appSettings, syncSettings, newFiles, } = yield (0, webhooks_1.prepareWebhookData)(config, integration, webhookUrlParam, models_1.Provider.CROWDIN);
+            const { projectId, crowdinClient, rootFolder, appSettings, syncSettings } = yield (0, webhooks_1.prepareWebhookData)(config, integration, webhookUrlParam, models_1.Provider.CROWDIN);
             if (!crowdinClient) {
                 return res.status(403).send({ error: 'Access denied' });
             }
             if (!syncSettings) {
                 return res.status(200).send({ message: 'Sync is not configured' });
             }
+            const syncFileSettings = JSON.parse(syncSettings.files);
             if ((_b = integration.webhooks) === null || _b === void 0 ? void 0 : _b.crowdinWebhookInterceptor) {
                 filesToSync = yield integration.webhooks.crowdinWebhookInterceptor(projectId, crowdinClient.client, rootFolder, appSettings, syncSettings, req.body);
             }
             else {
-                filesToSync = (0, webhooks_1.filterSyncFiles)(req.body.events, JSON.parse(syncSettings.files));
+                filesToSync = yield filterSyncFiles({
+                    projectId,
+                    crowdinClient: crowdinClient.client,
+                    events: req.body.events,
+                    syncFileSettings,
+                    appSettings,
+                });
+            }
+            for (const eventPayload of req.body.events) {
+                if (eventPayload.event === webhooks_1.HookEvents.fileDeleted) {
+                    yield (0, storage_1.getStorage)().deleteWebhooks([eventPayload.fileId], syncSettings.integrationId, syncSettings.crowdinId, syncSettings.provider);
+                    delete filesToSync[eventPayload.fileId];
+                    delete syncFileSettings[eventPayload.fileId];
+                }
             }
-            const crowdinFiles = yield (0, cron_1.skipFoldersFromIntegrationRequest)(config, integration, projectId, Object.assign(Object.assign({}, filesToSync), newFiles), crowdinClient.client);
-            const result = yield integration.updateIntegration(projectId, crowdinClient.client, preparedIntegrationCredentials, crowdinFiles, rootFolder, appSettings);
-            if (Object.keys(newFiles).length) {
-                yield (0, storage_1.getStorage)().updateSyncSettings(JSON.stringify(Object.assign(Object.assign({}, filesToSync), newFiles)), syncSettings.integrationId, syncSettings.crowdinId, 'schedule', syncSettings.provider);
-                const currentFileSnapshot = yield (0, file_snapshot_1.getCrowdinSnapshot)(config, integration, crowdinClient.client, projectId, appSettings);
-                yield (0, storage_1.getStorage)().updateFilesSnapshot(JSON.stringify(currentFileSnapshot), syncSettings.integrationId, syncSettings.crowdinId, syncSettings.provider);
+            const crowdinFiles = yield (0, cron_1.skipFoldersFromIntegrationRequest)(config, integration, projectId, filesToSync, crowdinClient.client);
+            for (const fileId in crowdinFiles) {
+                const webhook = yield (0, storage_1.getStorage)().getWebhooks(fileId, syncSettings.integrationId, syncSettings.crowdinId, syncSettings.provider);
+                if (!webhook) {
+                    yield (0, storage_1.getStorage)().saveWebhooks(fileId, syncSettings.integrationId, syncSettings.crowdinId, syncSettings.provider);
+                }
             }
-            let message;
-            if ((0, util_1.isExtendedResultType)(result)) {
-                message = result.message;
+            const newFileIds = Object.keys(crowdinFiles).filter((fileId) => !syncFileSettings[fileId]);
+            if (newFileIds.length) {
+                yield (0, storage_1.getStorage)().updateSyncSettings(JSON.stringify(Object.assign(Object.assign({}, syncFileSettings), crowdinFiles)), syncSettings.integrationId, syncSettings.crowdinId, 'schedule', syncSettings.provider);
             }
-            res.send({ message });
+            res.send({});
         }
     }));
 }

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

@@ -25,12 +25,8 @@ function handle(config, integration) {
             if (!webhookData.syncSettings) {
                 return res.status(200).send({ message: 'Sync is not configured' });
             }
-            const result = yield (0, webhooks_1.updateCrowdinFromWebhookRequest)({ integration, webhookData, req });
-            let message;
-            if ((0, util_1.isExtendedResultType)(result)) {
-                message = result.message;
-            }
-            res.send({ message });
+            yield (0, webhooks_1.updateCrowdinFromWebhookRequest)({ integration, webhookData, req });
+            res.send({});
         }
         else {
             return res.status(403).send({ error: 'Access denied' });

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

@@ -23,11 +23,13 @@ function handle(config, integration) {
         if (integration.webhooks) {
             yield (0, webhooks_1.registerWebhooks)(config, integration, req.crowdinApiClient, req.crowdinContext, req.integrationCredentials, appSettings);
         }
-        if (appSettings['new-crowdin-files']) {
-            (0, file_snapshot_1.createOrUpdateFileSnapshot)(config, integration, req, models_1.Provider.CROWDIN);
-        }
-        if (appSettings['new-integration-files']) {
-            (0, file_snapshot_1.createOrUpdateFileSnapshot)(config, integration, req, models_1.Provider.INTEGRATION);
+        else {
+            if (appSettings['new-crowdin-files']) {
+                (0, file_snapshot_1.createOrUpdateFileSnapshot)(config, integration, req, models_1.Provider.CROWDIN);
+            }
+            if (appSettings['new-integration-files']) {
+                (0, file_snapshot_1.createOrUpdateFileSnapshot)(config, integration, req, models_1.Provider.INTEGRATION);
+            }
         }
         if (integration.syncNewElements) {
             yield (0, cron_1.createOrUpdateSyncSettings)(config, req, {}, models_1.Provider.CROWDIN, true);

package/out/models/index.d.ts

@@ -618,16 +618,16 @@ export interface CustomFileFormatLogic extends FileProcessLogic {
 export type FileImportExportLogic = FilePreImportLogic | FilePostImportLogic | FilePreExportLogic | FilePostExportLogic;
 export type FileImportExportContent = ProcessFileString[] | Buffer | undefined;
 export interface FilePreImportLogic extends FileProcessLogic {
-    fileProcess: (req: ProcessFileRequest, content: FileImportExportContent, client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<BuildFileResponse>;
+    fileProcess: (req: ProcessFileRequest, content: FileImportExportContent, client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<ContentFileResponse>;
 }
 export interface FilePostImportLogic extends FileProcessLogic {
-    fileProcess: (req: ProcessFileRequest, content: FileImportExportContent, client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<ParseFileResponse>;
+    fileProcess: (req: ProcessFileRequest, content: FileImportExportContent, client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<StringsFileResponse>;
 }
 export interface FilePreExportLogic extends FileProcessLogic {
-    fileProcess: (req: ProcessFileRequest, content: FileImportExportContent, client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<ParseFileResponse>;
+    fileProcess: (req: ProcessFileRequest, content: FileImportExportContent, client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<StringsFileResponse>;
 }
 export interface FilePostExportLogic extends FileProcessLogic {
-    fileProcess: (req: ProcessFileRequest, content: FileImportExportContent, client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<BuildFileResponse>;
+    fileProcess: (req: ProcessFileRequest, content: FileImportExportContent, client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<ContentFileResponse>;
 }
 export interface SignaturePatterns {
     fileName?: string;
@@ -668,6 +668,12 @@ export interface BuildFileResponse {
     fileName?: string;
     fileType?: string;
 }
+export interface StringsFileResponse extends Omit<ParseFileResponse, 'previewFile'> {
+    notModified?: boolean;
+}
+export interface ContentFileResponse extends BuildFileResponse {
+    notModified?: boolean;
+}
 export interface ProcessFileString {
     previewId?: number;
     id: number;
@@ -827,6 +833,13 @@ export interface IntegrationFilesSnapshot {
     crowdinId: string;
     provider: Provider;
 }
+export interface IntegrationWebhooks {
+    id: number;
+    fileId: number;
+    integrationId: string;
+    crowdinId: string;
+    provider: Provider;
+}
 export interface ImagePath {
     /**
      * path to app logo (e.g. {@example join(__dirname, 'logo.png')})
@@ -869,10 +882,10 @@ export interface Webhooks {
     crowdinWebhookUrl?: string;
     integrationWebhookUrl?: string;
     urlParam?: string;
-    crowdinWebhooks?: (client: Crowdin, projectId: number, available: boolean, config?: any) => Promise<void>;
-    integrationWebhooks?: (apiCredentials: any, urlParam: string, available: boolean, config?: any, syncSettings?: any) => Promise<void>;
+    crowdinWebhooks?: (client: Crowdin, projectId: number, available: boolean, config?: AppSettings) => Promise<void>;
+    integrationWebhooks?: (apiCredentials: any, urlParam: string, available: boolean, config?: AppSettings, syncSettings?: any) => Promise<void>;
     crowdinWebhookInterceptor?: (projectId: number, client: Crowdin, appRootFolder?: SourceFilesModel.Directory, config?: any, syncSettings?: any, webhookRequest?: any) => Promise<UpdateIntegrationRequest>;
-    integrationWebhookInterceptor?: (projectId: number, client: Crowdin, apiCredentials: any, appRootFolder?: SourceFilesModel.Directory, config?: any, syncSettings?: any, webhookRequest?: any) => Promise<IntegrationFile[]>;
+    integrationWebhookInterceptor?: (projectId: number, client: Crowdin, apiCredentials: any, appRootFolder?: SourceFilesModel.Directory, config?: AppSettings, syncSettings?: any, webhookRequest?: any) => Promise<IntegrationFile[]>;
     queueUrl: string;
 }
 export declare enum SyncCondition {
@@ -880,10 +893,9 @@ export declare enum SyncCondition {
     TRANSLATED = 1,
     APPROVED = 2
 }
-export declare enum SyncType {
-    NONE = 0,
-    SCHEDULE = 1,
-    WEBHOOKS = 2
+export declare enum SyncSchedule {
+    DISABLED = 0,
+    ACTIVE
 }
 export type Payload = {
     event: string;
@@ -912,6 +924,20 @@ export interface UpdateCrowdinWebhookPayloadsArgs {
     webhookData: any;
     req: Request;
 }
+export interface FilterSyncFilesArgs {
+    projectId: number;
+    crowdinClient: Crowdin;
+    events: Payload[];
+    syncFileSettings: UpdateIntegrationRequest;
+    appSettings: AppSettings;
+}
+export interface AppSettings {
+    schedule?: number;
+    condition?: number;
+    'new-crowdin-files'?: boolean;
+    'new-integration-files'?: boolean;
+    [key: string]: any;
+}
 export declare enum UserPermissions {
     OWNER = "owner",
     MANAGERS = "managers",

package/out/models/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ProjectPermissions = exports.UserPermissions = exports.SyncType = exports.SyncCondition = exports.RequestMethods = exports.Provider = exports.ContextOptionsTypes = exports.ContextOptionsLocations = exports.EditorPanelsMode = exports.ProcessFileJobType = exports.SubscriptionInfoType = exports.AccountType = exports.Scope = exports.AuthenticationType = void 0;
+exports.ProjectPermissions = exports.UserPermissions = exports.SyncSchedule = exports.SyncCondition = exports.RequestMethods = exports.Provider = exports.ContextOptionsTypes = exports.ContextOptionsLocations = exports.EditorPanelsMode = exports.ProcessFileJobType = exports.SubscriptionInfoType = exports.AccountType = exports.Scope = exports.AuthenticationType = void 0;
 var AuthenticationType;
 (function (AuthenticationType) {
     AuthenticationType["CODE"] = "authorization_code";
@@ -85,12 +85,11 @@ var SyncCondition;
     SyncCondition[SyncCondition["TRANSLATED"] = 1] = "TRANSLATED";
     SyncCondition[SyncCondition["APPROVED"] = 2] = "APPROVED";
 })(SyncCondition = exports.SyncCondition || (exports.SyncCondition = {}));
-var SyncType;
-(function (SyncType) {
-    SyncType[SyncType["NONE"] = 0] = "NONE";
-    SyncType[SyncType["SCHEDULE"] = 1] = "SCHEDULE";
-    SyncType[SyncType["WEBHOOKS"] = 2] = "WEBHOOKS";
-})(SyncType = exports.SyncType || (exports.SyncType = {}));
+var SyncSchedule;
+(function (SyncSchedule) {
+    SyncSchedule[SyncSchedule["DISABLED"] = 0] = "DISABLED";
+    SyncSchedule[SyncSchedule["ACTIVE"] = 1 || 3 || 6 || 12 || 24] = "ACTIVE";
+})(SyncSchedule = exports.SyncSchedule || (exports.SyncSchedule = {}));
 var UserPermissions;
 (function (UserPermissions) {
     UserPermissions["OWNER"] = "owner";