@crowdin/app-project-module 0.34.2 → 0.35.1

package/out/handlers/file-processing/custom-file-format.js

@@ -37,8 +37,7 @@ function handle(baseUrl, folder, config) {
             file = Buffer.from(body.file.content, 'base64');
         }
         else if (body.file.contentUrl) {
-            const rawContent = yield (0, files_1.getFileContent)(body.file.contentUrl);
-            file = Buffer.from(rawContent).toString('base64');
+            file = yield (0, files_1.getFileContent)(body.file.contentUrl);
         }
         let response = {};
         let error;
@@ -71,7 +70,7 @@ function handleBuildFile(baseUrl, dataFolder, config, req, client, context, proj
             strings = req.strings;
         }
         else {
-            strings = yield (0, files_1.getFileContent)(req.stringsUrl, true);
+            strings = yield (0, files_1.getFileStrings)(req.stringsUrl);
         }
         let res;
         if ((req.file.id || !file) && config.exportStrings) {
@@ -113,9 +112,8 @@ function handleParseFile(baseUrl, dataFolder, config, req, client, context, proj
             maxSize = maxSize / 2;
         }
         if (res.previewFile) {
-            const previewFileEncoded = Buffer.from(res.previewFile).toString('base64');
-            if (Buffer.byteLength(previewFileEncoded, 'utf8') < maxSize) {
-                response.preview = previewFileEncoded;
+            if (Buffer.byteLength(res.previewFile) < maxSize) {
+                response.preview = res.previewFile.toString('base64');
             }
             else {
                 let url;
@@ -141,16 +139,17 @@ function handleParseFile(baseUrl, dataFolder, config, req, client, context, proj
                 });
             }
             const stringsNDJson = strings.map((s) => JSON.stringify(s)).join('\n\r');
-            if (Buffer.byteLength(stringsNDJson, 'utf8') < maxSize) {
+            const bufferData = Buffer.from(stringsNDJson, 'utf8');
+            if (Buffer.byteLength(bufferData) < maxSize) {
                 response.strings = strings;
             }
             else {
                 let url;
                 if (config.storeFile) {
-                    url = yield config.storeFile(stringsNDJson);
+                    url = yield config.storeFile(bufferData);
                 }
                 else {
-                    const storedFile = yield (0, files_1.storeFile)(stringsNDJson, path_1.default.join(dataFolder, 'custom-file-format'));
+                    const storedFile = yield (0, files_1.storeFile)(bufferData, path_1.default.join(dataFolder, 'custom-file-format'));
                     url = `${baseUrl}?file=${storedFile}`;
                 }
                 response.stringsUrl = url;

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

@@ -30,14 +30,14 @@ function handle(baseConfig, config, folderName) {
         let fileContent;
         let rawContent;
         if (body.stringsUrl) {
-            fileContent = yield (0, files_1.getFileContent)(body.stringsUrl, true);
+            fileContent = yield (0, files_1.getFileStrings)(body.stringsUrl);
         }
         else if (body.strings) {
             fileContent = body.strings;
         }
         else if (body.file.contentUrl) {
             rawContent = yield (0, files_1.getFileContent)(body.file.contentUrl);
-            fileContent = Buffer.from(rawContent).toString('base64');
+            fileContent = rawContent;
         }
         else if (body.file.content) {
             rawContent = body.file.content;
@@ -45,18 +45,20 @@ function handle(baseConfig, config, folderName) {
         }
         if (body.jobType === models_1.ProcessFileJobType.PRE_IMPORT || body.jobType === models_1.ProcessFileJobType.POST_EXPORT) {
             body.getRawContent = (encoding) => __awaiter(this, void 0, void 0, function* () {
-                return Buffer.from(rawContent, 'base64').toString(encoding);
+                if (typeof rawContent === 'string') {
+                    return Buffer.from(rawContent, 'base64').toString(encoding);
+                }
+                return rawContent;
             });
         }
         const fileProcessResult = yield config.fileProcess(body, fileContent, req.crowdinApiClient, req.crowdinContext, req.crowdinContext.jwtPayload.context.project_id);
         switch (body.jobType) {
             case models_1.ProcessFileJobType.PRE_IMPORT:
             case models_1.ProcessFileJobType.POST_EXPORT:
-                const { contentFile, base64EncodedContent, fileName, fileType, error: contentFileError, } = fileProcessResult;
+                const { contentFile, fileName, fileType, error: contentFileError, } = fileProcessResult;
                 if (contentFile) {
-                    const contentFileEncoded = base64EncodedContent || Buffer.from(contentFile).toString('base64');
-                    if (Buffer.byteLength(contentFileEncoded, 'utf8') < files_1.MAX_BODY_SIZE) {
-                        response.content = contentFileEncoded;
+                    if (Buffer.byteLength(contentFile) < files_1.MAX_BODY_SIZE) {
+                        response.content = contentFile.toString('base64');
                     }
                     else {
                         let url;
@@ -83,16 +85,17 @@ function handle(baseConfig, config, folderName) {
                 const { strings, error: stringsFileError } = fileProcessResult;
                 if (strings) {
                     const stringsNDJson = strings.map((s) => JSON.stringify(s)).join('\n\r');
-                    if (Buffer.byteLength(stringsNDJson, 'utf8') < files_1.MAX_BODY_SIZE) {
+                    const bufferData = Buffer.from(stringsNDJson, 'utf-8');
+                    if (Buffer.byteLength(bufferData) < files_1.MAX_BODY_SIZE) {
                         response.strings = strings;
                     }
                     else {
                         let url;
                         if (config.storeFile) {
-                            url = yield config.storeFile(stringsNDJson);
+                            url = yield config.storeFile(bufferData);
                         }
                         else {
-                            const storedFile = yield (0, files_1.storeFile)(stringsNDJson, path_1.default.join(folderPath, folderName));
+                            const storedFile = yield (0, files_1.storeFile)(bufferData, path_1.default.join(folderPath, folderName));
                             url = `${baseFilesUrl}?file=${storedFile}`;
                         }
                         response.stringsUrl = url;

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

@@ -37,7 +37,7 @@ function handle(config, integration) {
             }
             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 (newFiles) {
+            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);

package/out/handlers/integration/main.js

@@ -65,6 +65,7 @@ function handle(config, integration) {
                 appIdentifier: config.identifier,
             }
             : null;
+        options.notice = integration.notice;
         logger(`Routing user to ${view} view`);
         return res.render(view, options);
     }));

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

@@ -17,7 +17,8 @@ function handle(config, integration) {
         var _a;
         const { files, provider } = req.body;
         yield (0, cron_1.createOrUpdateSyncSettings)(config, req, files, provider);
-        if ((_a = integration.syncNewElements) === null || _a === void 0 ? void 0 : _a[provider]) {
+        const appSettings = req.integrationSettings || {};
+        if (((_a = integration.syncNewElements) === null || _a === void 0 ? void 0 : _a[provider]) && appSettings[`new-${provider}-files`]) {
             yield (0, file_snapshot_1.createOrUpdateFileSnapshot)(config, integration, req, provider);
         }
         res.status(204).end();

package/out/index.js

@@ -186,22 +186,27 @@ function addCrowdinEndpoints(app, clientConfig) {
         }
     }
     if (config.customFileFormat) {
+        (0, defaults_1.applyFileProcessorsModuleDefaults)(config, config.customFileFormat);
         app.post('/process', (0, crowdin_client_1.default)(config), (0, custom_file_format_1.default)(config.baseUrl, config.customFileFormat.filesFolder || config.dbFolder, config.customFileFormat));
         app.get('/file/download', (0, file_download_1.default)(config, config.customFileFormat, 'custom-file-format'));
     }
     if (config.filePreImport) {
+        (0, defaults_1.applyFileProcessorsModuleDefaults)(config, config.filePreImport);
         app.post('/pre-import', (0, crowdin_client_1.default)(config), (0, pre_post_process_1.default)(config, config.filePreImport, models_1.ProcessFileJobType.PRE_IMPORT));
         app.get(`/file/download/${models_1.ProcessFileJobType.PRE_IMPORT}`, (0, file_download_1.default)(config, config.filePreImport, models_1.ProcessFileJobType.PRE_IMPORT));
     }
     if (config.filePostImport) {
+        (0, defaults_1.applyFileProcessorsModuleDefaults)(config, config.filePostImport);
         app.post('/post-import', (0, crowdin_client_1.default)(config), (0, pre_post_process_1.default)(config, config.filePostImport, models_1.ProcessFileJobType.POST_IMPORT));
         app.get(`/file/download/${models_1.ProcessFileJobType.POST_IMPORT}`, (0, file_download_1.default)(config, config.filePostImport, models_1.ProcessFileJobType.POST_IMPORT));
     }
     if (config.filePreExport) {
+        (0, defaults_1.applyFileProcessorsModuleDefaults)(config, config.filePreExport);
         app.post('/pre-export', (0, crowdin_client_1.default)(config), (0, pre_post_process_1.default)(config, config.filePreExport, models_1.ProcessFileJobType.PRE_EXPORT));
         app.get(`/file/download/${models_1.ProcessFileJobType.PRE_EXPORT}`, (0, file_download_1.default)(config, config.filePreExport, models_1.ProcessFileJobType.PRE_EXPORT));
     }
     if (config.filePostExport) {
+        (0, defaults_1.applyFileProcessorsModuleDefaults)(config, config.filePostExport);
         app.post('/post-export', (0, crowdin_client_1.default)(config), (0, pre_post_process_1.default)(config, config.filePostExport, models_1.ProcessFileJobType.POST_EXPORT));
         app.get(`/file/download/${models_1.ProcessFileJobType.POST_EXPORT}`, (0, file_download_1.default)(config, config.filePostExport, models_1.ProcessFileJobType.POST_EXPORT));
     }

package/out/models/index.d.ts

@@ -1,3 +1,4 @@
+/// <reference types="node" />
 import Crowdin, { LanguagesModel, SourceFilesModel, SourceStringsModel, TranslationStatusModel } from '@crowdin/crowdin-api-client';
 import { JwtPayload, VerifyOptions } from '@crowdin/crowdin-apps-functions';
 import { Request } from 'express';
@@ -156,6 +157,12 @@ export interface ClientConfig extends ImagePath {
      * Disable formatting logs
      */
     disableLogsFormatter?: boolean;
+    /**
+     * AWS configuration for uploading big files to temporary bucket. Used with customFileFormat and file processors modules.
+     *
+     * Not necessary to configure if environment variables AWS_REGION and AWS_TMP_BUCKET_NAME are properly set.
+     */
+    awsConfig?: AWSConfig;
 }
 export type Config = ClientConfig & {
     baseUrl: string;
@@ -296,6 +303,16 @@ export interface IntegrationLogic {
      * Register Crowdin webhook to get notified when translations are ready
      */
     webhooks?: Webhooks;
+    /**
+     * define a notification for your application at the top of the screen
+     */
+    notice?: {
+        title: string;
+        content: string;
+        type: NoticeType;
+        icon: boolean;
+        close: boolean;
+    };
 }
 export type FormEntity = FormField | FormDelimiter;
 export interface FormDelimiter {
@@ -554,7 +571,7 @@ export interface FileProcessLogic {
     /**
      * Override to store huge responses (by default they will be stored in fs)
      */
-    storeFile?: (content: string) => Promise<string>;
+    storeFile?: (content: Buffer) => Promise<string>;
 }
 export interface CustomFileFormatLogic extends FileProcessLogic {
     /**
@@ -588,28 +605,29 @@ export interface CustomFileFormatLogic extends FileProcessLogic {
     /**
      * Used for initial source file upload, source file update, and translation upload
      */
-    parseFile?: (fileContent: string | object, req: Omit<ProcessFileRequest, 'jobType' | 'file'>, client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<ParseFileResponse>;
+    parseFile?: (fileContent: Buffer, req: Omit<ProcessFileRequest, 'jobType' | 'file'>, client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<ParseFileResponse>;
     /**
      * Used for translation download
      */
-    buildFile?: (fileContent: string | object, req: Omit<ProcessFileRequest, 'jobType' | 'file'>, strings: ProcessFileString[], client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<BuildFileResponse>;
+    buildFile?: (fileContent: Buffer, req: Omit<ProcessFileRequest, 'jobType' | 'file'>, strings: ProcessFileString[], client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<BuildFileResponse>;
     /**
      * Used for strings export
      */
     exportStrings?: (req: Omit<ProcessFileRequest, 'jobType'>, strings: ProcessFileString[], client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<BuildFileResponse>;
 }
 export type FileImportExportLogic = FilePreImportLogic | FilePostImportLogic | FilePreExportLogic | FilePostExportLogic;
+export type FileImportExportContent = ProcessFileString[] | Buffer | undefined;
 export interface FilePreImportLogic extends FileProcessLogic {
-    fileProcess: (req: ProcessFileRequest, content: string, client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<BuildFileResponse>;
+    fileProcess: (req: ProcessFileRequest, content: FileImportExportContent, client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<BuildFileResponse>;
 }
 export interface FilePostImportLogic extends FileProcessLogic {
-    fileProcess: (req: ProcessFileRequest, content: string, client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<ParseFileResponse>;
+    fileProcess: (req: ProcessFileRequest, content: FileImportExportContent, client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<ParseFileResponse>;
 }
 export interface FilePreExportLogic extends FileProcessLogic {
-    fileProcess: (req: ProcessFileRequest, content: string, client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<ParseFileResponse>;
+    fileProcess: (req: ProcessFileRequest, content: FileImportExportContent, client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<ParseFileResponse>;
 }
 export interface FilePostExportLogic extends FileProcessLogic {
-    fileProcess: (req: ProcessFileRequest, content: string, client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<BuildFileResponse>;
+    fileProcess: (req: ProcessFileRequest, content: FileImportExportContent, client: Crowdin, context: CrowdinContextInfo, projectId: number) => Promise<BuildFileResponse>;
 }
 export interface SignaturePatterns {
     fileName?: string;
@@ -622,7 +640,7 @@ export interface ProcessFileRequest {
     targetLanguages: LanguagesModel.Language[];
     strings: ProcessFileString[];
     stringsUrl: string;
-    getRawContent?: (encoding: string) => Promise<string>;
+    getRawContent?: (encoding: BufferEncoding) => Promise<string | Buffer>;
 }
 export interface ProcessFileRecord {
     content?: string;
@@ -640,13 +658,12 @@ export declare enum ProcessFileJobType {
     POST_EXPORT = "post-export-file"
 }
 export interface ParseFileResponse {
-    previewFile?: string;
+    previewFile?: Buffer;
     strings?: ProcessFileString[];
     error?: string;
 }
 export interface BuildFileResponse {
-    contentFile: string;
-    base64EncodedContent?: string;
+    contentFile: Buffer;
     error?: string;
     fileName?: string;
     fileType?: string;
@@ -909,4 +926,15 @@ export interface DefaultPermissions {
     user?: UserPermissions;
     project?: ProjectPermissions;
 }
+type NoticeType = 'info' | 'warning' | 'danger' | 'success' | 'error' | 'dataLostWarning';
+export interface AWSConfig {
+    /**
+     * AWS bucket name for temporary files
+     */
+    tmpBucketName?: string;
+    /**
+     * AWS region
+     */
+    region?: string;
+}
 export {};