smartling-api-sdk-nodejs 2.24.6 → 2.25.0

package/.eslintrc

@@ -26,6 +26,7 @@
     }
   },
   rules: {
+    "lines-between-class-members": "off",
     "no-return-await": "off",
     "import/extensions": "off",
     "no-shadow": "off",

package/.scannerwork/report-task.txt

@@ -2,5 +2,5 @@ projectKey=smartling-api-sdk-nodejs
 serverUrl=https://sonar-next.connectors.stg.smartling.net
 serverVersion=8.6.1.40680
 dashboardUrl=https://sonar-next.connectors.stg.smartling.net/dashboard?id=smartling-api-sdk-nodejs
-ceTaskId=AZk-_ZM1JYLo-yRQ8Fjz
-ceTaskUrl=https://sonar-next.connectors.stg.smartling.net/api/ce/task?id=AZk-_ZM1JYLo-yRQ8Fjz
+ceTaskId=AZnNaTBHjzZQmJO_qatF
+ceTaskUrl=https://sonar-next.connectors.stg.smartling.net/api/ce/task?id=AZnNaTBHjzZQmJO_qatF

package/api/job-batches/params/list-batches-parameters.ts

@@ -38,4 +38,3 @@ export class ListBatchesParameters extends BaseParameters {
         return this;
     }
 }
-

package/api/reports/dto/report-response.ts

@@ -0,0 +1,6 @@
+interface ReportResponse<T> {
+    resultsTruncated: boolean;
+    items: Array<T>;
+}
+
+export { ReportResponse };

package/api/reports/dto/step-types.ts

@@ -0,0 +1,5 @@
+interface StepTypeDto {
+    workflowStepType: string
+}
+
+export { StepTypeDto };

package/api/reports/dto/word-count-dto.ts

@@ -0,0 +1,26 @@
+interface WordCountDto {
+    accountUid: string;
+    accountName: string;
+    projectId: string;
+    projectName: string;
+    targetLocaleId: string;
+    targetLocale: string;
+    jobUid: string;
+    jobName: string;
+    jobReferenceNumber: string;
+    jobNumber: string;
+    translationResourceUid: string;
+    translationResourceName: string;
+    agencyUid: string;
+    agencyName: string;
+    workflowStepType: string;
+    workflowStepUid: string;
+    workflowStepName: string;
+    fuzzyProfileName: string;
+    fuzzyTier: string;
+    wordCount: number;
+    characterCount: number;
+    weightedWordCount: number;
+}
+
+export { WordCountDto };

package/api/reports/index.ts

@@ -0,0 +1,31 @@
+import { WordCountParameters } from "./params/word-count-parameters";
+import { WordCountDto } from "./dto/word-count-dto";
+import { ReportResponse } from "./dto/report-response";
+import { StepTypeDto } from "./dto/step-types";
+import { SmartlingBaseApi } from "../base";
+import { AccessTokenProvider } from "../auth/access-token-provider";
+import { Logger } from "../logger";
+
+export class SmartlingReportServiceApi extends SmartlingBaseApi {
+    constructor(smartlingApiBaseUrl: string, authApi: AccessTokenProvider, logger: Logger) {
+        super(logger);
+
+        this.authApi = authApi;
+        this.entrypoint = `${smartlingApiBaseUrl}/reports-api/v3`;
+    }
+
+    async getWorkflowStepTypes(): Promise<ReportResponse<StepTypeDto>> {
+        return await this.makeRequest(
+            "GET",
+            `${this.entrypoint}/word-count/dictionary/step-types`
+        );
+    }
+
+    async getWordsCountReport(params: WordCountParameters): Promise<ReportResponse<WordCountDto>> {
+        return await this.makeRequest(
+            "GET",
+            `${this.entrypoint}/word-count`,
+            params.export()
+        );
+    }
+}

package/api/reports/params/date-formatter.ts

@@ -0,0 +1,5 @@
+function formatDate(date: Date): string {
+    return date.toISOString().split("T")[0];
+}
+
+export { formatDate };

package/api/reports/params/word-count-parameters.ts

@@ -0,0 +1,64 @@
+import { formatDate } from "./date-formatter";
+import { BaseParameters } from "../../parameters";
+
+export class WordCountParameters extends BaseParameters {
+    public setStartDate(startDate: Date): WordCountParameters {
+        this.set("startDate", formatDate(startDate));
+        return this;
+    }
+
+    public setEndDate(endDate: Date): WordCountParameters {
+        this.set("endDate", formatDate(endDate));
+        return this;
+    }
+
+    public setAccountUid(accountUid: string): WordCountParameters {
+        this.set("accountUid", accountUid);
+        return this;
+    }
+
+    public setProjectIds(projectIds: Array<string>): WordCountParameters {
+        this.set("projectIds", projectIds);
+        return this;
+    }
+
+    public setJobUids(jobUids: Array<string>): WordCountParameters {
+        this.set("jobUids", jobUids);
+        return this;
+    }
+
+    public setAgencyUid(agencyUid: string): WordCountParameters {
+        this.set("agencyUid", agencyUid);
+        return this;
+    }
+
+    public setUserUids(userUids: Array<string>): WordCountParameters {
+        this.set("userUids", userUids);
+        return this;
+    }
+
+    public setTargetLocaleIds(targetLocaleIds: Array<string>): WordCountParameters {
+        this.set("targetLocaleIds", targetLocaleIds);
+        return this;
+    }
+
+    public setWorkflowStepTypes(workflowStepTypes: Array<string>): WordCountParameters {
+        this.set("workflowStepTypes", workflowStepTypes);
+        return this;
+    }
+
+    public setFields(fields: string): WordCountParameters {
+        this.set("fields", fields);
+        return this;
+    }
+
+    public setLimit(limit: number): WordCountParameters {
+        this.set("limit", limit);
+        return this;
+    }
+
+    public setOffset(offset: number): WordCountParameters {
+        this.set("offset", offset);
+        return this;
+    }
+}

package/api/strings/index.ts

@@ -39,7 +39,7 @@ export class SmartlingStringsApi extends SmartlingBaseApi {
     async getCreateStringStatus(
         projectUid: string,
         processUid: string
-    ): Promise<SmartlingListResponse<ProcessStatusDto>> {
+    ): Promise<ProcessStatusDto> {
         return await this.makeRequest(
             "get",
             `${this.entrypoint}/${projectUid}/processes/${processUid}`

package/built/api/reports/dto/report-response.d.ts

@@ -0,0 +1,5 @@
+interface ReportResponse<T> {
+    resultsTruncated: boolean;
+    items: Array<T>;
+}
+export { ReportResponse };

package/built/api/reports/dto/report-response.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=report-response.js.map

package/built/api/reports/dto/report-response.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"report-response.js","sourceRoot":"","sources":["../../../../api/reports/dto/report-response.ts"],"names":[],"mappings":""}

package/built/api/reports/dto/step-types.d.ts

@@ -0,0 +1,4 @@
+interface StepTypeDto {
+    workflowStepType: string;
+}
+export { StepTypeDto };

package/built/api/reports/dto/step-types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=step-types.js.map

package/built/api/reports/dto/step-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"step-types.js","sourceRoot":"","sources":["../../../../api/reports/dto/step-types.ts"],"names":[],"mappings":""}

package/built/api/reports/dto/word-count-dto.d.ts

@@ -0,0 +1,25 @@
+interface WordCountDto {
+    accountUid: string;
+    accountName: string;
+    projectId: string;
+    projectName: string;
+    targetLocaleId: string;
+    targetLocale: string;
+    jobUid: string;
+    jobName: string;
+    jobReferenceNumber: string;
+    jobNumber: string;
+    translationResourceUid: string;
+    translationResourceName: string;
+    agencyUid: string;
+    agencyName: string;
+    workflowStepType: string;
+    workflowStepUid: string;
+    workflowStepName: string;
+    fuzzyProfileName: string;
+    fuzzyTier: string;
+    wordCount: number;
+    characterCount: number;
+    weightedWordCount: number;
+}
+export { WordCountDto };

package/built/api/reports/dto/word-count-dto.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=word-count-dto.js.map

package/built/api/reports/dto/word-count-dto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"word-count-dto.js","sourceRoot":"","sources":["../../../../api/reports/dto/word-count-dto.ts"],"names":[],"mappings":""}

package/built/api/reports/index.d.ts

@@ -0,0 +1,12 @@
+import { WordCountParameters } from "./params/word-count-parameters";
+import { WordCountDto } from "./dto/word-count-dto";
+import { ReportResponse } from "./dto/report-response";
+import { StepTypeDto } from "./dto/step-types";
+import { SmartlingBaseApi } from "../base";
+import { AccessTokenProvider } from "../auth/access-token-provider";
+import { Logger } from "../logger";
+export declare class SmartlingReportServiceApi extends SmartlingBaseApi {
+    constructor(smartlingApiBaseUrl: string, authApi: AccessTokenProvider, logger: Logger);
+    getWorkflowStepTypes(): Promise<ReportResponse<StepTypeDto>>;
+    getWordsCountReport(params: WordCountParameters): Promise<ReportResponse<WordCountDto>>;
+}

package/built/api/reports/index.js

@@ -0,0 +1,32 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SmartlingReportServiceApi = void 0;
+const base_1 = require("../base");
+class SmartlingReportServiceApi extends base_1.SmartlingBaseApi {
+    constructor(smartlingApiBaseUrl, authApi, logger) {
+        super(logger);
+        this.authApi = authApi;
+        this.entrypoint = `${smartlingApiBaseUrl}/reports-api/v3`;
+    }
+    getWorkflowStepTypes() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.makeRequest("GET", `${this.entrypoint}/word-count/dictionary/step-types`);
+        });
+    }
+    getWordsCountReport(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.makeRequest("GET", `${this.entrypoint}/word-count`, params.export());
+        });
+    }
+}
+exports.SmartlingReportServiceApi = SmartlingReportServiceApi;
+//# sourceMappingURL=index.js.map

package/built/api/reports/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../api/reports/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAIA,kCAA2C;AAI3C,MAAa,yBAA0B,SAAQ,uBAAgB;IAC3D,YAAY,mBAA2B,EAAE,OAA4B,EAAE,MAAc;QACjF,KAAK,CAAC,MAAM,CAAC,CAAC;QAEd,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,UAAU,GAAG,GAAG,mBAAmB,iBAAiB,CAAC;IAC9D,CAAC;IAEK,oBAAoB;;YACtB,OAAO,MAAM,IAAI,CAAC,WAAW,CACzB,KAAK,EACL,GAAG,IAAI,CAAC,UAAU,mCAAmC,CACxD,CAAC;QACN,CAAC;KAAA;IAEK,mBAAmB,CAAC,MAA2B;;YACjD,OAAO,MAAM,IAAI,CAAC,WAAW,CACzB,KAAK,EACL,GAAG,IAAI,CAAC,UAAU,aAAa,EAC/B,MAAM,CAAC,MAAM,EAAE,CAClB,CAAC;QACN,CAAC;KAAA;CACJ;AAtBD,8DAsBC"}

package/built/api/reports/params/date-formatter.d.ts

@@ -0,0 +1,2 @@
+declare function formatDate(date: Date): string;
+export { formatDate };

package/built/api/reports/params/date-formatter.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatDate = void 0;
+function formatDate(date) {
+    return date.toISOString().split("T")[0];
+}
+exports.formatDate = formatDate;
+//# sourceMappingURL=date-formatter.js.map

package/built/api/reports/params/date-formatter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"date-formatter.js","sourceRoot":"","sources":["../../../../api/reports/params/date-formatter.ts"],"names":[],"mappings":";;;AAAA,SAAS,UAAU,CAAC,IAAU;IAC1B,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;AAC5C,CAAC;AAEQ,gCAAU"}

package/built/api/reports/params/word-count-parameters.d.ts

@@ -0,0 +1,15 @@
+import { BaseParameters } from "../../parameters";
+export declare class WordCountParameters extends BaseParameters {
+    setStartDate(startDate: Date): WordCountParameters;
+    setEndDate(endDate: Date): WordCountParameters;
+    setAccountUid(accountUid: string): WordCountParameters;
+    setProjectIds(projectIds: Array<string>): WordCountParameters;
+    setJobUids(jobUids: Array<string>): WordCountParameters;
+    setAgencyUid(agencyUid: string): WordCountParameters;
+    setUserUids(userUids: Array<string>): WordCountParameters;
+    setTargetLocaleIds(targetLocaleIds: Array<string>): WordCountParameters;
+    setWorkflowStepTypes(workflowStepTypes: Array<string>): WordCountParameters;
+    setFields(fields: string): WordCountParameters;
+    setLimit(limit: number): WordCountParameters;
+    setOffset(offset: number): WordCountParameters;
+}

package/built/api/reports/params/word-count-parameters.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WordCountParameters = void 0;
+const date_formatter_1 = require("./date-formatter");
+const parameters_1 = require("../../parameters");
+class WordCountParameters extends parameters_1.BaseParameters {
+    setStartDate(startDate) {
+        this.set("startDate", (0, date_formatter_1.formatDate)(startDate));
+        return this;
+    }
+    setEndDate(endDate) {
+        this.set("endDate", (0, date_formatter_1.formatDate)(endDate));
+        return this;
+    }
+    setAccountUid(accountUid) {
+        this.set("accountUid", accountUid);
+        return this;
+    }
+    setProjectIds(projectIds) {
+        this.set("projectIds", projectIds);
+        return this;
+    }
+    setJobUids(jobUids) {
+        this.set("jobUids", jobUids);
+        return this;
+    }
+    setAgencyUid(agencyUid) {
+        this.set("agencyUid", agencyUid);
+        return this;
+    }
+    setUserUids(userUids) {
+        this.set("userUids", userUids);
+        return this;
+    }
+    setTargetLocaleIds(targetLocaleIds) {
+        this.set("targetLocaleIds", targetLocaleIds);
+        return this;
+    }
+    setWorkflowStepTypes(workflowStepTypes) {
+        this.set("workflowStepTypes", workflowStepTypes);
+        return this;
+    }
+    setFields(fields) {
+        this.set("fields", fields);
+        return this;
+    }
+    setLimit(limit) {
+        this.set("limit", limit);
+        return this;
+    }
+    setOffset(offset) {
+        this.set("offset", offset);
+        return this;
+    }
+}
+exports.WordCountParameters = WordCountParameters;
+//# sourceMappingURL=word-count-parameters.js.map

package/built/api/reports/params/word-count-parameters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"word-count-parameters.js","sourceRoot":"","sources":["../../../../api/reports/params/word-count-parameters.ts"],"names":[],"mappings":";;;AAAA,qDAA8C;AAC9C,iDAAkD;AAElD,MAAa,mBAAoB,SAAQ,2BAAc;IAC5C,YAAY,CAAC,SAAe;QAC/B,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,IAAA,2BAAU,EAAC,SAAS,CAAC,CAAC,CAAC;QAC7C,OAAO,IAAI,CAAC;IAChB,CAAC;IAEM,UAAU,CAAC,OAAa;QAC3B,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,IAAA,2BAAU,EAAC,OAAO,CAAC,CAAC,CAAC;QACzC,OAAO,IAAI,CAAC;IAChB,CAAC;IAEM,aAAa,CAAC,UAAkB;QACnC,IAAI,CAAC,GAAG,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;QACnC,OAAO,IAAI,CAAC;IAChB,CAAC;IAEM,aAAa,CAAC,UAAyB;QAC1C,IAAI,CAAC,GAAG,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;QACnC,OAAO,IAAI,CAAC;IAChB,CAAC;IAEM,UAAU,CAAC,OAAsB;QACpC,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QAC7B,OAAO,IAAI,CAAC;IAChB,CAAC;IAEM,YAAY,CAAC,SAAiB;QACjC,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;QACjC,OAAO,IAAI,CAAC;IAChB,CAAC;IAEM,WAAW,CAAC,QAAuB;QACtC,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QAC/B,OAAO,IAAI,CAAC;IAChB,CAAC;IAEM,kBAAkB,CAAC,eAA8B;QACpD,IAAI,CAAC,GAAG,CAAC,iBAAiB,EAAE,eAAe,CAAC,CAAC;QAC7C,OAAO,IAAI,CAAC;IAChB,CAAC;IAEM,oBAAoB,CAAC,iBAAgC;QACxD,IAAI,CAAC,GAAG,CAAC,mBAAmB,EAAE,iBAAiB,CAAC,CAAC;QACjD,OAAO,IAAI,CAAC;IAChB,CAAC;IAEM,SAAS,CAAC,MAAc;QAC3B,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QAC3B,OAAO,IAAI,CAAC;IAChB,CAAC;IAEM,QAAQ,CAAC,KAAa;QACzB,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QACzB,OAAO,IAAI,CAAC;IAChB,CAAC;IAEM,SAAS,CAAC,MAAc;QAC3B,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QAC3B,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AA5DD,kDA4DC"}

package/built/api/strings/index.d.ts

@@ -11,5 +11,5 @@ export declare class SmartlingStringsApi extends SmartlingBaseApi {
     constructor(smartlingApiBaseUrl: string, authApi: AccessTokenProvider, logger: Logger);
     getSourceStrings(projectId: string, params: FetchSourceStringsParameters): Promise<SmartlingListResponse<SourceStringDto>>;
     createStrings(projectUid: string, params: CreateStringsParameters): Promise<CreateStringsResponseDto>;
-    getCreateStringStatus(projectUid: string, processUid: string): Promise<SmartlingListResponse<ProcessStatusDto>>;
+    getCreateStringStatus(projectUid: string, processUid: string): Promise<ProcessStatusDto>;
 }

package/built/package.json

@@ -1,6 +1,6 @@
 {
   "name": "smartling-api-sdk-nodejs",
-  "version": "2.24.6",
+  "version": "2.25.0",
   "description": "Package for Smartling API",
   "main": "built/index.js",
   "engines": {
@@ -45,7 +45,7 @@
     "ansi-regex": "^5.0.1",
     "babel-eslint": "^10.1.0",
     "eslint": "^7.31.0",
-    "eslint-config-airbnb": "^16.1.0",
+    "eslint-config-airbnb": "^19.0.4",
     "eslint-plugin-flowtype": "^2.41.0",
     "eslint-plugin-fp": "^2.3.0",
     "eslint-plugin-import": "^2.8.0",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "smartling-api-sdk-nodejs",
-  "version": "2.24.6",
+  "version": "2.25.0",
   "description": "Package for Smartling API",
   "main": "built/index.js",
   "engines": {
@@ -45,7 +45,7 @@
     "ansi-regex": "^5.0.1",
     "babel-eslint": "^10.1.0",
     "eslint": "^7.31.0",
-    "eslint-config-airbnb": "^16.1.0",
+    "eslint-config-airbnb": "^19.0.4",
     "eslint-plugin-flowtype": "^2.41.0",
     "eslint-plugin-fp": "^2.3.0",
     "eslint-plugin-import": "^2.8.0",

package/test/files.spec.ts

@@ -217,7 +217,6 @@ describe("SmartlingFilesApi class tests.", () => {
                 params = new DownloadFileAllTranslationsParameters();
             });
 
-
             it("Supports all parameters of single file download", async () => {
                 params
                     .setRetrievalType(RetrievalType.PUBLISHED)

package/test/jobs.spec.ts

@@ -59,7 +59,6 @@ describe("SmartlingJobsAPI class tests.", () => {
                 .setTargetLocaleIds(["pt-PT"])
                 .setCallbackUrl("testCallbackUrl");
 
-
             await jobApi.createJob(projectId, params);
 
             sinon.assert.calledOnce(jobServiceApiFetchStub);

package/test/locales.spec.ts

@@ -34,7 +34,8 @@ describe("SmartlingLocalesApi class tests.", () => {
         sinon.assert.calledOnce(localesApiFetchStub);
         sinon.assert.calledWithExactly(
             localesApiFetchStub,
-            "https://test.com/locales-api/v2/dictionary/locales", {
+            "https://test.com/locales-api/v2/dictionary/locales",
+            {
                 headers: {
                     Authorization: "test_token_type test_access_token",
                     "Content-Type": "application/json",
@@ -55,7 +56,8 @@ describe("SmartlingLocalesApi class tests.", () => {
         sinon.assert.calledOnce(localesApiFetchStub);
         sinon.assert.calledWithExactly(
             localesApiFetchStub,
-            "https://test.com/locales-api/v2/dictionary/locales?localeIds=fr-FR&localeIds=de-DE&supportedOnly=true", {
+            "https://test.com/locales-api/v2/dictionary/locales?localeIds=fr-FR&localeIds=de-DE&supportedOnly=true",
+            {
                 headers: {
                     Authorization: "test_token_type test_access_token",
                     "Content-Type": "application/json",

package/test/mt.spec.ts

@@ -45,7 +45,8 @@ describe("SmartlinMachineTranslationsApi class tests.", () => {
         sinon.assert.calledOnce(mtApiFetchStub);
         sinon.assert.calledWithExactly(
             mtApiFetchStub,
-            `https://test.com/mt-router-api/v2/accounts/${accountUid}/smartling-mt`, {
+            `https://test.com/mt-router-api/v2/accounts/${accountUid}/smartling-mt`,
+            {
                 headers: {
                     Authorization: "test_token_type test_access_token",
                     "Content-Type": "application/json",

package/test/published-files.spec.ts

@@ -43,7 +43,8 @@ describe("SmartlingPublishedFilesApi class tests.", () => {
         sinon.assert.calledOnce(publishedFilesApiFetchStub);
         sinon.assert.calledWithExactly(
             publishedFilesApiFetchStub,
-            "https://test.com/published-files-api/v2/projects/test_project/files/list/recently-published?publishedAfter=2020-09-24T00%3A00%3A00Z&fileUris%5B%5D=test%3A_1.xml&fileUris%5B%5D=test%2Ffile%26_2.xml&localeIds%5B%5D=fr&localeIds%5B%5D=de&offset=0&limit=100", {
+            "https://test.com/published-files-api/v2/projects/test_project/files/list/recently-published?publishedAfter=2020-09-24T00%3A00%3A00Z&fileUris%5B%5D=test%3A_1.xml&fileUris%5B%5D=test%2Ffile%26_2.xml&localeIds%5B%5D=fr&localeIds%5B%5D=de&offset=0&limit=100",
+            {
                 headers: {
                     Authorization: "test_token_type test_access_token",
                     "Content-Type": "application/json",

package/test/report-api.spec.ts

@@ -0,0 +1,146 @@
+import sinon from "sinon";
+import assert from "assert";
+import { SmartlingReportServiceApi } from "../api/reports";
+import { WordCountParameters } from "../api/reports/params/word-count-parameters";
+import { loggerMock, authMock, responseMock } from "./mock";
+import { SmartlingAuthApi } from "../api/auth";
+
+describe("SmartlingReportServiceApi class tests.", () => {
+    let reportServiceApi: SmartlingReportServiceApi;
+    let reportServiceApiFetchStub: sinon.SinonStub;
+    let reportServiceApiUaStub: sinon.SinonStub;
+    let responseMockTextStub: sinon.SinonStub;
+
+    beforeEach(() => {
+        reportServiceApi = new SmartlingReportServiceApi("https://test.com", authMock as unknown as SmartlingAuthApi, loggerMock);
+
+        reportServiceApiFetchStub = sinon.stub(reportServiceApi, "fetch");
+        reportServiceApiUaStub = sinon.stub(reportServiceApi, "ua");
+        responseMockTextStub = sinon.stub(responseMock, "text");
+
+        reportServiceApiUaStub.returns("test_user_agent");
+        reportServiceApiFetchStub.returns(responseMock);
+    });
+
+    afterEach(() => {
+        reportServiceApiFetchStub.restore();
+        responseMockTextStub.restore();
+        reportServiceApiUaStub.restore();
+    });
+
+    function smartlingResponse(body: unknown) {
+        return {
+            response: {
+                code: "SUCCESS",
+                data: body
+            }
+        };
+    }
+
+    describe("getWorkflowStepTypes", () => {
+        it("Should call correct endpoint and return workflow step types", async () => {
+            const payload = {
+                resultsTruncated: false,
+                items: [
+                    { workflowStepType: "TRANSLATION" },
+                    { workflowStepType: "REVIEW" },
+                    { workflowStepType: "APPROVAL" }
+                ]
+            };
+            const mockResponse = smartlingResponse(payload);
+
+            responseMockTextStub.returns(JSON.stringify(mockResponse));
+
+            const result = await reportServiceApi.getWorkflowStepTypes();
+
+            sinon.assert.calledOnce(reportServiceApiFetchStub);
+            const callArgs = reportServiceApiFetchStub.getCall(0).args;
+
+            assert.strictEqual(callArgs[0], "https://test.com/reports-api/v3/word-count/dictionary/step-types");
+            assert.strictEqual(callArgs[1].method, "GET");
+            assert.deepStrictEqual(callArgs[1].headers, {
+                Authorization: "test_token_type test_access_token",
+                "Content-Type": "application/json",
+                "User-Agent": "test_user_agent"
+            });
+
+            assert.deepStrictEqual(result, payload);
+        });
+    });
+
+    describe("getWordsCountReport", () => {
+        it("Should call correct endpoint with parameters", async () => {
+            const payload = {
+                resultsTruncated: false,
+                items: [
+                    {
+                        accountUid: "account123",
+                        accountName: "Test Account",
+                        projectUid: "project123",
+                        projectName: "Test Project",
+                        jobUid: "job123",
+                        jobName: "Test Job",
+                        translationResourceUid: "resource123",
+                        translationResourceName: "Test Resource",
+                        agencyUid: "agency123",
+                        agencyName: "Test Agency",
+                        targetLocale: "es-ES",
+                        workflowStepType: "TRANSLATION",
+                        fuzzyProfileName: "Standard",
+                        fuzzyTier: "100%",
+                        wordCount: 1000,
+                        weightedWordCount: 950
+                    }
+                ]
+            };
+            const mockResponse = smartlingResponse(payload);
+
+            responseMockTextStub.returns(JSON.stringify(mockResponse));
+
+            const startDate = new Date("2024-01-01T00:00:00Z");
+            const endDate = new Date("2024-12-31T23:59:59Z");
+
+            const params = new WordCountParameters()
+                .setStartDate(startDate)
+                .setEndDate(endDate)
+                .setAccountUid("account123")
+                .setProjectIds(["project123"])
+                .setUserUids(["user123"])
+                .setAgencyUid("agency123")
+                .setJobUids(["job123"])
+                .setTargetLocaleIds(["fr-FR"])
+                .setWorkflowStepTypes(["TRANSLATION", "REVIEW"])
+                .setFields("includeTranslationResource,includeJob,includeFuzzyMatchProfile")
+                .setLimit(100)
+                .setOffset(0);
+
+            const result = await reportServiceApi.getWordsCountReport(params);
+
+            sinon.assert.calledOnce(reportServiceApiFetchStub);
+            const callArgs = reportServiceApiFetchStub.getCall(0).args;
+
+            assert.strictEqual(callArgs[0], "https://test.com/reports-api/v3/word-count"
+                + "?startDate=2024-01-01"
+                + "&endDate=2024-12-31"
+                + "&accountUid=account123"
+                + "&projectIds=project123"
+                + "&userUids=user123"
+                + "&agencyUid=agency123"
+                + "&jobUids=job123"
+                + "&targetLocaleIds=fr-FR"
+                + "&workflowStepTypes=TRANSLATION"
+                + "&workflowStepTypes=REVIEW"
+                + "&fields=includeTranslationResource%2CincludeJob%2CincludeFuzzyMatchProfile"
+                + "&limit=100"
+                + "&offset=0");
+            assert.strictEqual(callArgs[1].method, "GET");
+            assert.deepStrictEqual(callArgs[1].headers, {
+                Authorization: "test_token_type test_access_token",
+                "Content-Type": "application/json",
+                "User-Agent": "test_user_agent"
+            });
+
+            assert.deepStrictEqual(result, payload);
+        });
+    });
+});

package/test/stream-to-string.ts

@@ -7,8 +7,8 @@ function streamToString(stream: Readable): Promise<string> {
 
     return new Promise((resolve, reject) => {
         // eslint-disable-next-line fp/no-mutating-methods
-        stream.on("data", chunk => chunks.push(Buffer.from(chunk)));
-        stream.on("error", err => reject(err));
+        stream.on("data", (chunk) => chunks.push(Buffer.from(chunk)));
+        stream.on("error", (err) => reject(err));
         stream.on("end", () => resolve(Buffer.concat(chunks).toString("utf8")));
     });
 }

package/test/strings.spec.ts

@@ -14,7 +14,7 @@ describe("SmartlingStringsApi class tests.", () => {
     const limit = 25;
     const offset = 0;
     const hashCodes = ["testStringHashCode1", "testStringHashCode2"];
-    const hashCodesParams = hashCodes.map(hashCode => `hashcodes=${hashCode}`).join("&");
+    const hashCodesParams = hashCodes.map((hashCode) => `hashcodes=${hashCode}`).join("&");
     const expectedFetchSourceStringsParams = `${hashCodesParams}&fileUri=${fileUri}&limit=${limit}&offset=${offset}`;
     let stringsApi: SmartlingStringsApi;
     let fetchSourceStringsParameters: FetchSourceStringsParameters;
@@ -77,7 +77,8 @@ describe("SmartlingStringsApi class tests.", () => {
             sinon.assert.calledOnce(stringsServiceApiFetchStub);
             sinon.assert.calledWithExactly(
                 stringsServiceApiFetchStub,
-                `https://test.com/strings-api/v2/projects/${projectId}`, {
+                `https://test.com/strings-api/v2/projects/${projectId}`,
+                {
                     headers: {
                         Authorization: "test_token_type test_access_token",
                         "Content-Type": "application/json",
@@ -99,7 +100,8 @@ describe("SmartlingStringsApi class tests.", () => {
             sinon.assert.calledOnce(stringsServiceApiFetchStub);
             sinon.assert.calledWithExactly(
                 stringsServiceApiFetchStub,
-                `https://test.com/strings-api/v2/projects/${projectId}`, {
+                `https://test.com/strings-api/v2/projects/${projectId}`,
+                {
                     headers: {
                         Authorization: "test_token_type test_access_token",
                         "Content-Type": "application/json",
@@ -130,7 +132,8 @@ describe("SmartlingStringsApi class tests.", () => {
             sinon.assert.calledOnce(stringsServiceApiFetchStub);
             sinon.assert.calledWithExactly(
                 stringsServiceApiFetchStub,
-                `https://test.com/strings-api/v2/projects/${projectId}`, {
+                `https://test.com/strings-api/v2/projects/${projectId}`,
+                {
                     headers: {
                         Authorization: "test_token_type test_access_token",
                         "Content-Type": "application/json",
@@ -157,7 +160,8 @@ describe("SmartlingStringsApi class tests.", () => {
             sinon.assert.calledOnce(stringsServiceApiFetchStub);
             sinon.assert.calledWithExactly(
                 stringsServiceApiFetchStub,
-                `https://test.com/strings-api/v2/projects/${projectId}`, {
+                `https://test.com/strings-api/v2/projects/${projectId}`,
+                {
                     headers: {
                         Authorization: "test_token_type test_access_token",
                         "Content-Type": "application/json",
@@ -187,7 +191,8 @@ describe("SmartlingStringsApi class tests.", () => {
             sinon.assert.calledOnce(stringsServiceApiFetchStub);
             sinon.assert.calledWithExactly(
                 stringsServiceApiFetchStub,
-                `https://test.com/strings-api/v2/projects/${projectId}`, {
+                `https://test.com/strings-api/v2/projects/${projectId}`,
+                {
                     headers: {
                         Authorization: "test_token_type test_access_token",
                         "Content-Type": "application/json",
@@ -232,7 +237,8 @@ describe("SmartlingStringsApi class tests.", () => {
             sinon.assert.calledOnce(stringsServiceApiFetchStub);
             sinon.assert.calledWithExactly(
                 stringsServiceApiFetchStub,
-                `https://test.com/strings-api/v2/projects/${projectId}/processes/${testProcessUid}`, {
+                `https://test.com/strings-api/v2/projects/${projectId}/processes/${testProcessUid}`,
+                {
                     headers: {
                         Authorization: "test_token_type test_access_token",
                         "Content-Type": "application/json",