feat: generate report fnc

README.md

@@ -97,6 +97,7 @@ Please refer to JSDoc for more details.
 | `getSubscription`                  | returns an information about app subscription                   |
 | `convertString`                    | converts source or translation according to specified config    |
 | `getBundleConfigurationForm`       | returns UI template config for custom formatters                |
+| `generateReport`                   | generates Crowdin report, covers check if finished              |
 
 Also please have a look to working example of the [Crowdin App](https://github.com/crowdin/create-crowdin-app). It can be used as a basis for your app.
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crowdin/crowdin-apps-functions",
-  "version": "0.5.1",
+  "version": "0.6.0",
   "description": "Utility library to easily and quickly develop Crowdin App",
   "main": "out/index.js",
   "types": "out/index.d.ts",

src/crowdin.ts

@@ -1,5 +1,5 @@
 /* eslint-disable @typescript-eslint/ban-ts-ignore */
-import Crowdin, { SourceFilesModel, TranslationsModel, WebhooksModel } from '@crowdin/crowdin-api-client';
+import Crowdin, { ReportsModel, SourceFilesModel, TranslationsModel, WebhooksModel } from '@crowdin/crowdin-api-client';
 import axios from 'axios';
 
 interface UpdateOrCreateFileArgs {
@@ -9,7 +9,7 @@
     title?: string;
     type?: SourceFilesModel.FileType;
     directoryId?: number;
     data: any;
     file?: SourceFilesModel.File;
 }
 
@@ -37,7 +37,7 @@
     title: string,
     type: SourceFilesModel.FileType,
     directoryId: number,
     data: any,
     file?: SourceFilesModel.File,
 ): Promise<number>;
 
@@ -50,7 +50,7 @@
     title?: string,
     type?: SourceFilesModel.FileType,
     directoryId?: number,
     data?: any,
     file?: SourceFilesModel.File,
 ): Promise<number> {
     let options: UpdateOrCreateFileArgs;
@@ -223,7 +223,7 @@
     fileId: number;
     language: string;
     fileName: string;
     fileContent: any;
     request?: Omit<TranslationsModel.UploadTranslationRequest, 'fileId' | 'storageId'>;
 }
 
@@ -249,7 +249,7 @@
     fileId: number,
     language: string,
     fileName: string,
     fileContent: any,
     request?: Omit<TranslationsModel.UploadTranslationRequest, 'fileId' | 'storageId'>,
 ): Promise<TranslationsModel.UploadTranslationResponse>;
 
@@ -263,7 +263,7 @@
     fileId?: number,
     language?: string,
     fileName?: string,
     fileContent?: any,
     request?: Omit<TranslationsModel.UploadTranslationRequest, 'fileId' | 'storageId'>,
 ): Promise<TranslationsModel.UploadTranslationResponse> {
     let args: UploadTranslationsArgs;
@@ -361,7 +361,7 @@
     directory: string;
     request: TranslationsRequest;
     parentDirectory?: SourceFilesModel.Directory;
     handleFn: (translations: any, language: string, file: SourceFilesModel.File) => Promise<void>;
 }
 
 function isHandleTranslationsArgs(args: HandleTranslationsArgs | Crowdin): args is HandleTranslationsArgs {
@@ -383,7 +383,7 @@
     projectId: number,
     directory: string,
     request: TranslationsRequest,
     handleFn: (translations: any, language: string, file: SourceFilesModel.File) => Promise<void>,
     parentDirectory?: SourceFilesModel.Directory,
 ): Promise<void>;
 
@@ -394,7 +394,7 @@
     projectId?: number,
     directory?: string,
     request?: TranslationsRequest,
     handleFn?: (translations: any, language: string, file: SourceFilesModel.File) => Promise<void>,
     parentDirectory?: SourceFilesModel.Directory,
 ): Promise<void> {
     let args: HandleTranslationsArgs;
@@ -446,7 +446,7 @@
     projectId: number;
     url: string;
     events: WebhooksModel.Event[];
     payload: any;
     name: string;
     requestType?: WebhooksModel.RequestType;
     batchingEnabled?: boolean;
@@ -574,6 +574,29 @@
     }
 }
 
+export async function generateReport({
+    client,
+    projectId,
+    request,
+}: {
+    client: Crowdin;
+    projectId: number;
+    request: ReportsModel.GenerateReportRequest;
+}): Promise<any | undefined> {
+    const report = await client.reportsApi.generateReport(projectId, request);
+
+    while (true) {
+        const status = await client.reportsApi.checkReportStatus(projectId, report.data.identifier);
+
+        if (status.data.status === 'finished') {
+            const downloadRes = await client.reportsApi.downloadReport(projectId, report.data.identifier);
+
+            const reportBlob = await axios.get(downloadRes.data.url);
+            return reportBlob.data;
+        }
+    }
+}
+
 export interface FileEntity {
     name: string;
     title: string;

tests/crowdin.spec.ts

@@ -8,10 +8,12 @@ import Crowdin, {
     UploadStorageModel,
     WebhooksModel,
 } from '@crowdin/crowdin-api-client';
+import axios from 'axios';
 import { createMock } from 'ts-auto-mock';
 import {
     FileEntity,
     createOrUpdateWebhook,
+    generateReport,
     getFolder,
     getOrCreateFolder,
     updateOrCreateFile,
@@ -491,3 +493,32 @@ describe('CreateOrUpdateWebhook function', () => {
         });
     });
 });
+
+describe('generateReport function', () => {
+    let client: Crowdin;
+    const projectId = 1;
+    const reportId = '123';
+    const reportUrl = 'report-url';
+    const reportBlob = 'some-data';
+    const generateReportMock = jest.fn().mockImplementation(() => ({ data: { identifier: reportId } }));
+    const checkReportStatustMock = jest.fn().mockImplementation(() => ({ data: { status: 'finished' } }));
+    const downloadReportMock = jest.fn().mockImplementation(() => ({ data: { url: reportUrl } }));
+    const axiosGet = jest.fn().mockImplementation(() => ({ data: reportBlob }));
+
+    beforeEach(() => {
+        jest.mock('axios');
+        client = createMock<Crowdin>({
+            reportsApi: {
+                generateReport: generateReportMock,
+                checkReportStatus: checkReportStatustMock,
+                downloadReport: downloadReportMock,
+            },
+        });
+        axios.get = axiosGet;
+    });
+
+    it('should generate report', async () => {
+        const res = await generateReport({ client, projectId, request: { name: 'test', schema: {} } });
+        expect(res).toBe(reportBlob);
+    });
+});