smartling-api-sdk-nodejs 2.35.3 → 3.1.0

package/index.ts

@@ -43,7 +43,9 @@ export * from "./api/files/params/file-filter";
 export * from "./api/files/params/file-locale-mode";
 export * from "./api/files/params/file-locales";
 export * from "./api/files/params/recently-uploaded-files";
+export * from "./api/files/params/files-order-by";
 export * from "./api/files/params/retrieval-type";
+export * from "./api/files/params/page-count-status";
 export * from "./api/files/params/file-type";
 export * from "./api/files/params/filename-mode";
 export * from "./api/files/params/translation-file-name-mode";
@@ -52,9 +54,11 @@ export * from "./api/files/params/import-file-parameters";
 export * from "./api/files/params/translation-state";
 export * from "./api/files/dto/file-status-for-all-locales-dto";
 export * from "./api/files/dto/file-status-for-locale-item-dto";
+export * from "./api/files/dto/file-namespace-dto";
 export * from "./api/files/dto/last-modified-for-locale-dto";
 export * from "./api/files/dto/uploaded-file-dto";
 export * from "./api/files/dto/imported-file-dto";
+export * from "./api/files/dto/file-status-for-project-dto";
 export * from "./api/glossaries/index";
 export * from "./api/glossaries/dto/glossary-dto";
 export * from "./api/glossaries/dto/fallback-locale-dto";
@@ -85,6 +89,9 @@ export * from "./api/job-batches/dto/batch-status-dto";
 export * from "./api/job-batches/dto/batch-list-item-dto";
 export * from "./api/job-batches/dto/job-batches-parameters-mode";
 export * from "./api/job-batches/dto/job-batches-parameters-salt";
+export * from "./api/job-batches/dto/locale-workflow-content-assignment-dto";
+export * from "./api/job-batches/dto/translation-job-workflow-step-due-date-dto";
+export * from "./api/job-batches/dto/locale-workflow-dto";
 export * from "./api/job-batches/params/create-batch-parameters";
 export * from "./api/job-batches/params/job-batches-parameters";
 export * from "./api/job-batches/params/upload-batch-file-parameters";

package/package.json

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

package/test/files.spec.ts

@@ -12,6 +12,7 @@ import { FileType } from "../api/files/params/file-type";
 import { streamToString } from "./stream-to-string";
 import { DownloadFileAllTranslationsParameters } from "../api/files/params/download-file-all-translations-parameters";
 import { RecentlyUploadedFilesParameters } from "../api/files/params/recently-uploaded-files";
+import { FilesOrderBy } from "../api/files/params/files-order-by";
 import { FileNameMode } from "../api/files/params/filename-mode";
 import { DownloadMultipleFilesTranslationsParameters } from "../api/files/params/download-multiple-files-translations-parameters";
 import { FileLocales } from "../api/files/params/file-locales";
@@ -91,6 +92,33 @@ describe("SmartlingFilesApi class tests.", () => {
             );
         });
 
+        it("Get recently uploaded files for project with all filters", async () => {
+            const params = new RecentlyUploadedFilesParameters()
+                .setOffset(0)
+                .setLimit(99)
+                .setUriMask("TEST")
+                .setFileTypes([FileType.JSON, FileType.XML])
+                .setLastUploadedAfter(new Date("2020-01-01T00:00:00.000Z"))
+                .setLastUploadedBefore(new Date("2020-02-01T00:00:00.000Z"))
+                .setOrderBy(FilesOrderBy.LAST_UPLOADED_DESC);
+
+            await filesApi.getRecentlyUploadedFiles(projectId, params);
+
+            sinon.assert.calledOnce(filesApiFetchStub);
+            sinon.assert.calledWithExactly(
+                filesApiFetchStub,
+                `https://test.com/files-api/v2/projects/${projectId}/files/list?offset=0&limit=99&uriMask=TEST&fileTypes%5B%5D=json&fileTypes%5B%5D=xml&lastUploadedAfter=2020-01-01T00%3A00%3A00Z&lastUploadedBefore=2020-02-01T00%3A00%3A00Z&orderBy=lastUploaded_desc`,
+                {
+                    headers: {
+                        Authorization: "test_token_type test_access_token",
+                        "Content-Type": "application/json",
+                        "User-Agent": "test_user_agent"
+                    },
+                    method: "get"
+                }
+            );
+        });
+
         it("Get last modified", async () => {
             await filesApi.getLastModified(projectId, fileUri);
 
@@ -518,6 +546,53 @@ describe("SmartlingFilesApi class tests.", () => {
                     }
                 );
             });
+
+            it("Supports zip file name parameter", async () => {
+                params.setZipFileName("custom-name.zip");
+
+                await filesApi.downloadFileAllTranslations(projectId, fileUri, params);
+
+                sinon.assert.calledOnce(filesApiFetchStub);
+                sinon.assert.calledWithExactly(
+                    filesApiFetchStub,
+                    `https://test.com/files-api/v2/projects/${projectId}/locales/all/file/zip?zipFileName=custom-name.zip&fileUri=testFileUri`,
+                    {
+                        headers: {
+                            Authorization: "test_token_type test_access_token",
+                            "Content-Type": "application/json",
+                            "User-Agent": "test_user_agent"
+                        },
+                        method: "get"
+                    }
+                );
+            });
+
+            it("Returns an ArrayBuffer", async () => {
+                const result = await filesApi
+                    .downloadFileAllTranslations(projectId, fileUri, params);
+
+                assert.ok(result instanceof ArrayBuffer);
+            });
+
+            it("Supports contextMatchingInstrumented retrieval type", async () => {
+                params.setRetrievalType(RetrievalType.CONTEXT_MATCHING_INSTRUMENTED);
+
+                await filesApi.downloadFileAllTranslations(projectId, fileUri, params);
+
+                sinon.assert.calledOnce(filesApiFetchStub);
+                sinon.assert.calledWithExactly(
+                    filesApiFetchStub,
+                    `https://test.com/files-api/v2/projects/${projectId}/locales/all/file/zip?retrievalType=contextMatchingInstrumented&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 () => {
@@ -556,6 +631,34 @@ describe("SmartlingFilesApi class tests.", () => {
             );
         });
 
+        it("Rename file", async () => {
+            await filesApi.renameFile(projectId, fileUri, "newTestFileUri");
+
+            sinon.assert.calledOnce(filesApiFetchStub);
+
+            assert.equal(
+                filesApiFetchStub.getCall(0).args[0],
+                `https://test.com/files-api/v2/projects/${projectId}/file/rename`
+            );
+
+            assert.equal(
+                filesApiFetchStub.getCall(0).args[1].method,
+                "post"
+            );
+
+            const body = filesApiFetchStub.getCall(0).args[1].body.getBuffer().toString();
+
+            assert.equal(
+                body.includes(`Content-Disposition: form-data; name="fileUri"\r\n\r\n${fileUri}`),
+                true
+            );
+
+            assert.equal(
+                body.includes("Content-Disposition: form-data; name=\"newFileUri\"\r\n\r\nnewTestFileUri"),
+                true
+            );
+        });
+
         it("Upload file: from disk", async () => {
             const params = new UploadFileParameters();
 

package/test/job-batches.spec.ts

@@ -52,10 +52,23 @@ describe("SmartlingJobBatchesAPI class tests.", () => {
             params
                 .setTranslationJobUid(jobUid)
                 .setAuthorize(true)
+                .setRushJob(true)
                 .addFileUri("test_file_uri_1")
                 .addFileUri("test_file_uri_2")
-                .addLocaleWorkflows("fr", "wf1")
-                .addLocaleWorkflows("de", "wf2");
+                .addLocaleWorkflow({
+                    targetLocaleId: "fr",
+                    workflowUid: "wf1",
+                    contentAssignments: [
+                        { workflowStepUid: "step1", userUids: ["user1"] }
+                    ],
+                    translationJobWorkflowStepDueDates: [
+                        { workflowStepUid: "step1", dueDate: "2026-12-31T23:59:59Z" }
+                    ]
+                })
+                .addLocaleWorkflow({
+                    targetLocaleId: "de",
+                    workflowUid: "wf2"
+                });
 
             await jobBatchesApi.createBatch(projectId, params);
 
@@ -64,7 +77,7 @@ describe("SmartlingJobBatchesAPI class tests.", () => {
                 jobBatchesApiFetchStub,
                 `https://test.com/job-batches-api/v2/projects/${projectId}/batches`,
                 {
-                    body: "{\"fileUris\":[\"test_file_uri_1\",\"test_file_uri_2\"],\"localeWorkflows\":[{\"targetLocaleId\":\"fr\",\"workflowUid\":\"wf1\"},{\"targetLocaleId\":\"de\",\"workflowUid\":\"wf2\"}],\"translationJobUid\":\"testJobUid\",\"authorize\":true}",
+                    body: "{\"fileUris\":[\"test_file_uri_1\",\"test_file_uri_2\"],\"localeWorkflows\":[{\"targetLocaleId\":\"fr\",\"workflowUid\":\"wf1\",\"contentAssignments\":[{\"workflowStepUid\":\"step1\",\"userUids\":[\"user1\"]}],\"translationJobWorkflowStepDueDates\":[{\"workflowStepUid\":\"step1\",\"dueDate\":\"2026-12-31T23:59:59Z\"}]},{\"targetLocaleId\":\"de\",\"workflowUid\":\"wf2\"}],\"translationJobUid\":\"testJobUid\",\"authorize\":true,\"rushJob\":true}",
                     headers: {
                         Authorization: "test_token_type test_access_token",
                         "Content-Type": "application/json",
@@ -246,6 +259,59 @@ describe("SmartlingJobBatchesAPI class tests.", () => {
             );
         });
 
+        it("Upload batch file: from buffer", async () => {
+            const params = new UploadBatchFileParameters();
+
+            params
+                .setFileContentFromBuffer(fs.readFileSync(
+                    fs.realpathSync("./test/data/file.xml")
+                ))
+                .setFileUri("test-file-uri")
+                .setFileType(FileType.XML)
+                .setDirective("foo", "bar")
+                .setLocalesToApprove(["fr-FR", "de-DE"])
+                .setCallbackUrl("testCallbackUrl")
+                .setClientLibId("clientLibId", "clientLibVersion");
+
+            await jobBatchesApi.uploadBatchFile(projectId, batchUid, params);
+
+            sinon.assert.calledOnce(jobBatchesApiFetchStub);
+
+            assert.equal(
+                jobBatchesApiFetchStub.getCall(0).args[0],
+                `https://test.com/job-batches-api/v2/projects/${projectId}/batches/${batchUid}/file`
+            );
+
+            assert.equal(
+                jobBatchesApiFetchStub.getCall(0).args[1].method,
+                "post"
+            );
+
+            assert.equal(
+                jobBatchesApiFetchStub.getCall(0).args[1].headers.Authorization,
+                "test_token_type test_access_token"
+            );
+
+            assert.equal(
+                jobBatchesApiFetchStub.getCall(0).args[1].headers["User-Agent"],
+                "test_user_agent"
+            );
+
+            const expectedBuffer = fs.readFileSync(
+                fs.realpathSync("./test/data/file.xml")
+            );
+
+            assert.ok(
+                // eslint-disable-next-line no-underscore-dangle
+                jobBatchesApiFetchStub.getCall(0).args[1].body._streams[1].equals(expectedBuffer)
+            );
+
+            assert.ok(
+                // eslint-disable-next-line no-underscore-dangle
+                jobBatchesApiFetchStub.getCall(0).args[1].body._streams[0].includes("filename=")
+            );
+        });
+
         it("Get batch status", async () => {
             await jobBatchesApi.getBatchStatus(projectId, batchUid);
 
@@ -279,7 +345,7 @@ describe("SmartlingJobBatchesAPI class tests.", () => {
             sinon.assert.calledOnce(jobBatchesApiFetchStub);
             sinon.assert.calledWithExactly(
                 jobBatchesApiFetchStub,
-                `https://test.com/job-batches-api/v2/projects/${projectId}/batches?translationJobUid=${jobUid}&limit=100&offset=10&status=${BatchStatus.COMPLETED}&sortBy=${sortByParam}&sortDirection=${(Order.ASC).toLowerCase()}`,
+                `https://test.com/job-batches-api/v2/projects/${projectId}/batches?translationJobUid=${jobUid}&limit=100&offset=10&status=${BatchStatus.COMPLETED}&sortBy=${sortByParam}&orderBy=${Order.ASC}`,
                 {
                     method: "get",
                     headers: {