feat: build project directory translations (crowdin#128)

Author: yevheniyJ

package-lock.json

@@ -1,6 +1,6 @@
 {
     "name": "@crowdin/crowdin-api-client",
-    "version": "1.12.1",
+    "version": "1.12.2",
     "description": "JavaScript library for Crowdin API v2.",
     "main": "out/index.js",
     "types": "out/index.d.ts",

package.json

@@ -25,6 +25,21 @@ export class Translations extends CrowdinApi {
         return this.get(url, this.defaultConfig());
     }
 
+    /**
+     * @param projectId project identifier
+     * @param directoryId directory identifier
+     * @param request request body
+     */
+    buildProjectDirectoryTranslation(
+        projectId: number,
+        directoryId: number,
+        request: TranslationsModel.BuildProjectDirectoryTranslationRequest,
+    ): Promise<ResponseObject<TranslationsModel.BuildProjectDirectoryTranslationResponse>> {
+        const url = `${this.url}/projects/${projectId}/translations/builds/directories/${directoryId}`;
+        const config = this.defaultConfig();
+        return this.post(url, request, config);
+    }
+
     /**
      * @param projectId project identifier
      * @param fileId file identifier
@@ -141,6 +156,29 @@ export namespace TranslationsModel {
         markAddedTranslationsAsDone?: boolean;
     }
 
+    export interface BuildProjectDirectoryTranslationRequest {
+        targetLanguageIds?: string[];
+        skipUntranslatedStrings?: boolean;
+        skipUntranslatedFiles?: boolean;
+        exportApprovedOnly?: boolean;
+        exportWithMinApprovalsCount?: number;
+    }
+
+    export interface BuildProjectDirectoryTranslationResponse {
+        id: number;
+        projectId: number;
+        status: BuildStatus;
+        progress: number;
+    }
+
+    export enum BuildStatus {
+        CREATED = 'created',
+        IN_PROGRESS = 'inProgress',
+        CANCELED = 'canceled',
+        FAILED = 'failed',
+        FINISHED = 'finished',
+    }
+
     export interface BuildProjectFileTranslationRequest {
         targetLanguageId: string;
         exportAsXliff?: boolean;

src/translations/index.ts

@@ -15,6 +15,8 @@ describe('Translations API', () => {
     const url = 'test.com';
     const storageId = 5;
     const fileId = 51;
+    const directoryId = 61;
+    const progress = 50;
     const languageId = 'uk';
 
     const limit = 25;
@@ -48,6 +50,22 @@ describe('Translations API', () => {
                     identifier: preTranslationId,
                 },
             })
+            .post(
+                `/projects/${projectId}/translations/builds/directories/${directoryId}`,
+                {
+                    targetLanguageIds: [languageId],
+                },
+                {
+                    reqheaders: {
+                        Authorization: `Bearer ${api.token}`,
+                    },
+                },
+            )
+            .reply(200, {
+                data: {
+                    progress,
+                },
+            })
             .post(
                 `/projects/${projectId}/translations/builds/files/${fileId}`,
                 {
@@ -177,6 +195,13 @@ describe('Translations API', () => {
         expect(preTranslation.data.identifier).toBe(preTranslationId);
     });
 
+    it('Build Project Direcotry Translation', async () => {
+        const result = await api.buildProjectDirectoryTranslation(projectId, directoryId, {
+            targetLanguageIds: [languageId],
+        });
+        expect(result.data.progress).toBe(progress);
+    });
+
     it('Build Project File Translation', async () => {
         const preTranslation = await api.buildProjectFileTranslation(projectId, fileId, {
             targetLanguageId: languageId,