Merge pull request #16 from crowdin/master

[pull] master from crowdin:master

Author: devkadirselcuk

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npm run lint-ci && npm test

package-lock.json

@@ -1,6 +1,6 @@
 {
     "name": "@crowdin/crowdin-api-client",
-    "version": "1.12.0",
+    "version": "1.12.2",
     "description": "JavaScript library for Crowdin API v2.",
     "main": "out/index.js",
     "types": "out/index.d.ts",
@@ -12,6 +12,7 @@
         "out/**/*"
     ],
     "scripts": {
+        "prepare": "husky install",
         "test": "jest --config jestconfig.json",
         "build": "tsc -p ./",
         "watch": "tsc -watch -p ./",
@@ -25,31 +26,26 @@
     "license": "MIT",
     "devDependencies": {
         "@types/node": "^12.0.10",
-        "@types/jest": "^26.0.0",
+        "@types/jest": "^27.0.0",
         "@types/nock": "^10.0.3",
         "@typescript-eslint/eslint-plugin": "^2.3.1",
         "@typescript-eslint/parser": "^2.3.1",
         "eslint": "^6.4.0",
         "eslint-config-prettier": "^6.3.0",
         "eslint-plugin-prettier": "^3.1.1",
-        "husky": ">=1",
-        "jest": "^26.4.0",
-        "jest-circus": "^26.4.0",
+        "husky": "^7.0.0",
+        "jest": "^27.0.0",
+        "jest-circus": "^27.0.0",
         "lint-staged": ">=8",
         "nock": "^10.0.6",
         "prettier": "^1.18.2",
-        "ts-jest": "^26.4.0",
+        "ts-jest": "^27.0.0",
         "typescript": "^4.1.2",
         "jest-junit": "^12.0.0"
     },
     "dependencies": {
         "axios": "0.21.3"
     },
-    "husky": {
-        "hooks": {
-            "pre-commit": "lint-staged && npm run test"
-        }
-    },
     "lint-staged": {
         "*.js": [
             "eslint --fix",

package.json

@@ -17,6 +17,7 @@ export class SourceStrings extends CrowdinApi {
      * @param scope specify field to be the target of filtering
      * @param croql filter strings by CroQL (Can't be used with `labelIds`, `filter` or `scope` in same request)
      * @param branchId filter by branch identifier
+     * @param directoryId filter by directory identifier
      */
     listProjectStrings(
         projectId: number,
@@ -29,6 +30,7 @@ export class SourceStrings extends CrowdinApi {
         scope?: SourceStringsModel.Scope,
         croql?: string,
         branchId?: number,
+        directoryId?: number,
     ): Promise<ResponseList<SourceStringsModel.String>>;
 
     listProjectStrings(
@@ -42,6 +44,7 @@ export class SourceStrings extends CrowdinApi {
         scope?: SourceStringsModel.Scope,
         croql?: string,
         branchId?: number,
+        directoryId?: number,
     ): Promise<ResponseList<SourceStringsModel.String>> {
         let url = `${this.url}/projects/${projectId}/strings`;
         let request: SourceStringsModel.ListProjectStringsRequest;
@@ -58,6 +61,7 @@ export class SourceStrings extends CrowdinApi {
                 scope,
                 croql,
                 branchId,
+                directoryId,
             };
         }
         url = this.addQueryParam(url, 'fileId', request.fileId);
@@ -67,6 +71,7 @@ export class SourceStrings extends CrowdinApi {
         url = this.addQueryParam(url, 'scope', request.scope);
         url = this.addQueryParam(url, 'croql', request.croql);
         url = this.addQueryParam(url, 'branchId', request.branchId);
+        url = this.addQueryParam(url, 'directoryId', request.directoryId);
         return this.getList(url, request.limit, request.offset);
     }
 
@@ -126,6 +131,7 @@ export namespace SourceStringsModel {
         scope?: SourceStringsModel.Scope;
         croql?: string;
         branchId?: number;
+        directoryId?: number;
     }
 
     export interface String {

src/sourceStrings/index.ts

@@ -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,