smartling-api-sdk-nodejs 1.4.1 → 1.5.1

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=AYaeDUlIgRVcM-XZbdjJ
-ceTaskUrl=https://sonar-next.connectors.stg.smartling.net/api/ce/task?id=AYaeDUlIgRVcM-XZbdjJ
+ceTaskId=AYb_wiRQgRVcM-XZbdmD
+ceTaskUrl=https://sonar-next.connectors.stg.smartling.net/api/ce/task?id=AYb_wiRQgRVcM-XZbdmD

package/api/files/params/download-file-parameters.ts

@@ -13,4 +13,16 @@ export class DownloadFileParameters extends BaseParameters {
 
         return this;
     }
+
+    includeOriginalStrings(): DownloadFileParameters {
+        this.set("includeOriginalStrings", true);
+
+        return this;
+    }
+
+    excludeOriginalStrings(): DownloadFileParameters {
+        this.set("includeOriginalStrings", false);
+
+        return this;
+    }
 }

package/api/jobs/dto/full-source-file-dto.ts

@@ -1,7 +1,7 @@
 import { SourceFileDto } from "./source-file-dto";
 
 interface FullSourceFileDto extends SourceFileDto {
-    name: string;
+    localeIds: Array<string>;
 }
 
 export { FullSourceFileDto };

package/api/jobs/dto/job-details-dto.ts

@@ -1,9 +1,9 @@
 import { JobDto } from "./job-dto";
-import { FullSourceFileDto } from "./full-source-file-dto";
+import { SourceFileDto } from "./source-file-dto";
 
 interface JobDetailsDto extends JobDto {
     priority: string;
-    sourceFiles: Array<FullSourceFileDto>;
+    sourceFiles: Array<SourceFileDto>;
 }
 
 export { JobDetailsDto };

package/api/jobs/dto/source-file-dto.ts

@@ -1,5 +1,7 @@
 interface SourceFileDto {
     uri: string;
+    name: string;
+    fileUid: string;
 }
 
 export { SourceFileDto };

package/api/jobs/index.ts

@@ -11,12 +11,12 @@ import { JobDetailsDto } from "./dto/job-details-dto";
 import { SmartlingListResponse } from "../http/smartling-list-response";
 import { BaseJobDto } from "./dto/base-job-dto";
 import { FileProgressDto } from "./dto/file-progress-dto";
-import { SourceFileDto } from "./dto/source-file-dto";
 import { RemovedFileDto } from "./dto/removed-file-dto";
 import { JobProgressDto } from "./dto/job-progress-dto";
 import { JobProgressParameters } from "./params/job-progress-parameters";
 import { CancelJobParameters } from "./params/cancel-job-parameters";
 import { SearchJobsParameters } from "./params/search-jobs-parameters";
+import { FullSourceFileDto } from "./dto/full-source-file-dto";
 
 export class SmartlingJobsApi extends SmartlingBaseApi {
     constructor(smartlingApiBaseUrl: string, authApi: SmartlingAuthApi, logger: Logger) {
@@ -42,7 +42,7 @@ export class SmartlingJobsApi extends SmartlingBaseApi {
 
     async getJobFiles(
         projectId: string, translationJobUid: string, params: ListJobFilesParameters
-    ): Promise<SmartlingListResponse<SourceFileDto>> {
+    ): Promise<SmartlingListResponse<FullSourceFileDto>> {
         return await this.makeRequest(
             "get",
             `${this.entrypoint}/${projectId}/jobs/${translationJobUid}/files`,

package/built/api/files/params/download-file-parameters.d.ts

@@ -3,4 +3,6 @@ import { RetrievalType } from "./retrieval-type";
 export declare class DownloadFileParameters extends BaseParameters {
     enableDebugMode(): DownloadFileParameters;
     setRetrievalType(retrievalType: RetrievalType): DownloadFileParameters;
+    includeOriginalStrings(): DownloadFileParameters;
+    excludeOriginalStrings(): DownloadFileParameters;
 }

package/built/api/files/params/download-file-parameters.js

@@ -11,6 +11,14 @@ class DownloadFileParameters extends index_1.BaseParameters {
         this.set("retrievalType", retrievalType);
         return this;
     }
+    includeOriginalStrings() {
+        this.set("includeOriginalStrings", true);
+        return this;
+    }
+    excludeOriginalStrings() {
+        this.set("includeOriginalStrings", false);
+        return this;
+    }
 }
 exports.DownloadFileParameters = DownloadFileParameters;
 //# sourceMappingURL=download-file-parameters.js.map

package/built/api/files/params/download-file-parameters.js.map

@@ -1 +1 @@
-{"version":3,"file":"download-file-parameters.js","sourceRoot":"","sources":["../../../../api/files/params/download-file-parameters.ts"],"names":[],"mappings":";;;AAAA,kDAAwD;AAGxD,MAAa,sBAAuB,SAAQ,sBAAc;IACtD,eAAe;QACX,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;QAEzB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,gBAAgB,CAAC,aAA4B;QACzC,IAAI,CAAC,GAAG,CAAC,eAAe,EAAE,aAAa,CAAC,CAAC;QAEzC,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AAZD,wDAYC"}
+{"version":3,"file":"download-file-parameters.js","sourceRoot":"","sources":["../../../../api/files/params/download-file-parameters.ts"],"names":[],"mappings":";;;AAAA,kDAAwD;AAGxD,MAAa,sBAAuB,SAAQ,sBAAc;IACtD,eAAe;QACX,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;QAEzB,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,gBAAgB,CAAC,aAA4B;QACzC,IAAI,CAAC,GAAG,CAAC,eAAe,EAAE,aAAa,CAAC,CAAC;QAEzC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,sBAAsB;QAClB,IAAI,CAAC,GAAG,CAAC,wBAAwB,EAAE,IAAI,CAAC,CAAC;QAEzC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,sBAAsB;QAClB,IAAI,CAAC,GAAG,CAAC,wBAAwB,EAAE,KAAK,CAAC,CAAC;QAE1C,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AAxBD,wDAwBC"}

package/built/api/jobs/dto/full-source-file-dto.d.ts

@@ -1,5 +1,5 @@
 import { SourceFileDto } from "./source-file-dto";
 interface FullSourceFileDto extends SourceFileDto {
-    name: string;
+    localeIds: Array<string>;
 }
 export { FullSourceFileDto };

package/built/api/jobs/dto/job-details-dto.d.ts

@@ -1,7 +1,7 @@
 import { JobDto } from "./job-dto";
-import { FullSourceFileDto } from "./full-source-file-dto";
+import { SourceFileDto } from "./source-file-dto";
 interface JobDetailsDto extends JobDto {
     priority: string;
-    sourceFiles: Array<FullSourceFileDto>;
+    sourceFiles: Array<SourceFileDto>;
 }
 export { JobDetailsDto };

package/built/api/jobs/dto/source-file-dto.d.ts

@@ -1,4 +1,6 @@
 interface SourceFileDto {
     uri: string;
+    name: string;
+    fileUid: string;
 }
 export { SourceFileDto };

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

@@ -11,17 +11,17 @@ import { JobDetailsDto } from "./dto/job-details-dto";
 import { SmartlingListResponse } from "../http/smartling-list-response";
 import { BaseJobDto } from "./dto/base-job-dto";
 import { FileProgressDto } from "./dto/file-progress-dto";
-import { SourceFileDto } from "./dto/source-file-dto";
 import { RemovedFileDto } from "./dto/removed-file-dto";
 import { JobProgressDto } from "./dto/job-progress-dto";
 import { JobProgressParameters } from "./params/job-progress-parameters";
 import { CancelJobParameters } from "./params/cancel-job-parameters";
 import { SearchJobsParameters } from "./params/search-jobs-parameters";
+import { FullSourceFileDto } from "./dto/full-source-file-dto";
 export declare class SmartlingJobsApi extends SmartlingBaseApi {
     constructor(smartlingApiBaseUrl: string, authApi: SmartlingAuthApi, logger: Logger);
     createJob(projectId: string, params: CreateJobParameters): Promise<JobDto>;
     getJob(projectId: string, translationJobUid: string): Promise<JobDetailsDto>;
-    getJobFiles(projectId: string, translationJobUid: string, params: ListJobFilesParameters): Promise<SmartlingListResponse<SourceFileDto>>;
+    getJobFiles(projectId: string, translationJobUid: string, params: ListJobFilesParameters): Promise<SmartlingListResponse<FullSourceFileDto>>;
     listJobs(projectId: string, params: ListJobsParameters): Promise<SmartlingListResponse<BaseJobDto>>;
     searchJobs(projectId: string, params: SearchJobsParameters): Promise<SmartlingListResponse<BaseJobDto>>;
     removeFileFromJob(projectId: string, translationJobUid: string, params: RemoveFileParameters): Promise<RemovedFileDto>;

package/built/package.json

@@ -1,6 +1,6 @@
 {
   "name": "smartling-api-sdk-nodejs",
-  "version": "1.4.1",
+  "version": "1.5.1",
   "description": "Package for Smartling API",
   "main": "built/index.js",
   "scripts": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "smartling-api-sdk-nodejs",
-  "version": "1.4.1",
+  "version": "1.5.1",
   "description": "Package for Smartling API",
   "main": "built/index.js",
   "scripts": {

package/test/files.spec.ts

@@ -74,29 +74,95 @@ describe("SmartlingFilesApi class tests.", () => {
             );
         });
 
-        it("Download file", async () => {
+        describe("Download file", () => {
             const localeId = "fr-FR";
-            const params = new DownloadFileParameters();
-
-            params
-                .setRetrievalType(RetrievalType.PUBLISHED)
-                .enableDebugMode();
-
-            await filesApi.downloadFile(projectId, fileUri, localeId, params);
-
-            sinon.assert.calledOnce(filesApiFetchStub);
-            sinon.assert.calledWithExactly(
-                filesApiFetchStub,
-                `https://test.com/files-api/v2/projects/${projectId}/locales/${localeId}/file?retrievalType=published&debugMode=1&fileUri=testFileUri`,
-                {
-                    headers: {
-                        Authorization: "test_token_type test_access_token",
-                        "Content-Type": "application/json",
-                        "User-Agent": "test_user_agent"
-                    },
-                    method: "get"
-                }
-            );
+            let params: DownloadFileParameters;
+
+            beforeEach(() => {
+                params = new DownloadFileParameters();
+            });
+
+            it("Download file with debugMode enabled and retrievalType published", async () => {
+                params
+                    .setRetrievalType(RetrievalType.PUBLISHED)
+                    .enableDebugMode();
+
+                await filesApi.downloadFile(projectId, fileUri, localeId, params);
+
+                sinon.assert.calledOnce(filesApiFetchStub);
+                sinon.assert.calledWithExactly(
+                    filesApiFetchStub,
+                    `https://test.com/files-api/v2/projects/${projectId}/locales/${localeId}/file?retrievalType=published&debugMode=1&fileUri=testFileUri`,
+                    {
+                        headers: {
+                            Authorization: "test_token_type test_access_token",
+                            "Content-Type": "application/json",
+                            "User-Agent": "test_user_agent"
+                        },
+                        method: "get"
+                    }
+                );
+            });
+
+            it("Download file with debugMode disabled and retrievalType published", async () => {
+                params.setRetrievalType(RetrievalType.PUBLISHED);
+
+                await filesApi.downloadFile(projectId, fileUri, localeId, params);
+
+                sinon.assert.calledOnce(filesApiFetchStub);
+                sinon.assert.calledWithExactly(
+                    filesApiFetchStub,
+                    `https://test.com/files-api/v2/projects/${projectId}/locales/${localeId}/file?retrievalType=published&fileUri=testFileUri`,
+                    {
+                        headers: {
+                            Authorization: "test_token_type test_access_token",
+                            "Content-Type": "application/json",
+                            "User-Agent": "test_user_agent"
+                        },
+                        method: "get"
+                    }
+                );
+            });
+
+            it("Download file with includeOriginalStrings enabled", async() => {
+                params.setRetrievalType(RetrievalType.PUBLISHED).includeOriginalStrings();
+
+                await filesApi.downloadFile(projectId, fileUri, localeId, params);
+
+                sinon.assert.calledOnce(filesApiFetchStub);
+                sinon.assert.calledWithExactly(
+                    filesApiFetchStub,
+                    `https://test.com/files-api/v2/projects/${projectId}/locales/${localeId}/file?retrievalType=published&includeOriginalStrings=true&fileUri=testFileUri`,
+                    {
+                        headers: {
+                            Authorization: "test_token_type test_access_token",
+                            "Content-Type": "application/json",
+                            "User-Agent": "test_user_agent"
+                        },
+                        method: "get"
+                    }
+                );
+            });
+
+            it("Download file with includeOriginalStrings disabled", async() => {
+                params.setRetrievalType(RetrievalType.PUBLISHED).excludeOriginalStrings();
+
+                await filesApi.downloadFile(projectId, fileUri, localeId, params);
+
+                sinon.assert.calledOnce(filesApiFetchStub);
+                sinon.assert.calledWithExactly(
+                    filesApiFetchStub,
+                    `https://test.com/files-api/v2/projects/${projectId}/locales/${localeId}/file?retrievalType=published&includeOriginalStrings=false&fileUri=testFileUri`,
+                    {
+                        headers: {
+                            Authorization: "test_token_type test_access_token",
+                            "Content-Type": "application/json",
+                            "User-Agent": "test_user_agent"
+                        },
+                        method: "get"
+                    }
+                );
+            });
         });
 
         it("Delete file", async () => {