smartling-api-sdk-nodejs 2.27.0 → 2.29.0

package/test/files.spec.ts

@@ -5,12 +5,20 @@ import { SmartlingFilesApi } from "../api/files/index";
 import { authMock, loggerMock, responseMock } from "./mock";
 import { RetrievalType } from "../api/files/params/retrieval-type";
 import { DownloadFileParameters } from "../api/files/params/download-file-parameters";
+import { DownloadFileWithMetadataParameters } from "../api/files/params/download-file-with-metadata-parameters";
 import { UploadFileParameters } from "../api/files/params/upload-file-parameters";
 import { SmartlingAuthApi } from "../api/auth/index";
 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 { 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";
+import { SmartlingException } from "../api/exception";
+import { TranslationFileNameMode } from "../api/files/params/translation-file-name-mode";
+import { FileLocaleMode } from "../api/files/params/file-locale-mode";
+import { FileFilter } from "../api/files/params/file-filter";
 
 describe("SmartlingFilesApi class tests.", () => {
     const projectId = "testProjectId";
@@ -210,6 +218,276 @@ describe("SmartlingFilesApi class tests.", () => {
             });
         });
 
+        describe("Download file with metadata", () => {
+            let getHeaderStub;
+            const localeId = "fr-FR";
+            let params: DownloadFileWithMetadataParameters;
+
+            beforeEach(() => {
+                params = new DownloadFileWithMetadataParameters();
+                getHeaderStub = sinon.stub(responseMock.headers, "get");
+                getHeaderStub.returns(null);
+            });
+
+            afterEach(() => {
+                getHeaderStub.restore();
+            });
+
+            it("Download file when no headers in response", async () => {
+                const fileWithMetadata = await filesApi.downloadFileWithMetadata(
+                    projectId,
+                    fileUri,
+                    localeId,
+                    params
+                );
+
+                sinon.assert.calledOnce(filesApiFetchStub);
+                sinon.assert.calledWithExactly(
+                    filesApiFetchStub,
+                    `https://test.com/files-api/v2/projects/${projectId}/locales/${localeId}/file?fileUri=testFileUri`,
+                    {
+                        headers: {
+                            Authorization: "test_token_type test_access_token",
+                            "Content-Type": "application/json",
+                            "User-Agent": "test_user_agent"
+                        },
+                        method: "get"
+                    }
+                );
+
+                assert.ok(fileWithMetadata.contentType === undefined);
+                assert.ok(fileWithMetadata.fileName === undefined);
+                assert.ok(fileWithMetadata.fileContent.byteLength === 1);
+            });
+
+            it("Download file with metadata", async () => {
+                getHeaderStub.onCall(0).returns("application/xml");
+                getHeaderStub.onCall(1).returns("attachment; filename=\"test.xml\"");
+                getHeaderStub.returns(null);
+
+                const fileWithMetadata = await filesApi.downloadFileWithMetadata(
+                    projectId,
+                    fileUri,
+                    localeId,
+                    params
+                );
+
+                sinon.assert.calledOnce(filesApiFetchStub);
+                sinon.assert.calledWithExactly(
+                    filesApiFetchStub,
+                    `https://test.com/files-api/v2/projects/${projectId}/locales/${localeId}/file?fileUri=testFileUri`,
+                    {
+                        headers: {
+                            Authorization: "test_token_type test_access_token",
+                            "Content-Type": "application/json",
+                            "User-Agent": "test_user_agent"
+                        },
+                        method: "get"
+                    }
+                );
+
+                assert.ok(fileWithMetadata.contentType === "application/xml");
+                assert.ok(fileWithMetadata.fileName === "test.xml");
+                assert.ok(fileWithMetadata.fileContent.byteLength === 1);
+            });
+
+            it("Download file with fileNameMode original", async () => {
+                params.setFileNameMode(FileNameMode.ORIGINAL);
+
+                getHeaderStub.onCall(0).returns("application/xml");
+                getHeaderStub.onCall(1).returns("attachment; filename=\"test.xml\"");
+                getHeaderStub.returns(null);
+
+                const fileWithMetadata = await filesApi.downloadFileWithMetadata(
+                    projectId,
+                    fileUri,
+                    localeId,
+                    params
+                );
+
+                sinon.assert.calledOnce(filesApiFetchStub);
+                sinon.assert.calledWithExactly(
+                    filesApiFetchStub,
+                    `https://test.com/files-api/v2/projects/${projectId}/locales/${localeId}/file?fileUri=testFileUri`,
+                    {
+                        headers: {
+                            Authorization: "test_token_type test_access_token",
+                            "Content-Type": "application/json",
+                            "User-Agent": "test_user_agent"
+                        },
+                        method: "get"
+                    }
+                );
+
+                assert.ok(fileWithMetadata.contentType === "application/xml");
+                assert.ok(fileWithMetadata.fileName === "test.xml");
+                assert.ok(fileWithMetadata.fileContent.byteLength === 1);
+            });
+
+            it("Download file with fileNameMode transformed", async () => {
+                params.setFileNameMode(FileNameMode.TRANSFORMED);
+
+                getHeaderStub.onCall(0).returns("application/xml");
+                getHeaderStub.onCall(1).returns("attachment; filename=\"test.xml\"");
+                getHeaderStub.returns(null);
+
+                const fileWithMetadata = await filesApi.downloadFileWithMetadata(
+                    projectId,
+                    fileUri,
+                    localeId,
+                    params
+                );
+
+                sinon.assert.calledOnce(filesApiFetchStub);
+                sinon.assert.calledWithExactly(
+                    filesApiFetchStub,
+                    `https://test.com/files-api/v2/projects/${projectId}/locales/${localeId}/file?changeFileName=true&fileUri=testFileUri`,
+                    {
+                        headers: {
+                            Authorization: "test_token_type test_access_token",
+                            "Content-Type": "application/json",
+                            "User-Agent": "test_user_agent"
+                        },
+                        method: "get"
+                    }
+                );
+
+                assert.ok(fileWithMetadata.contentType === "application/xml");
+                assert.ok(fileWithMetadata.fileName === "test.xml");
+                assert.ok(fileWithMetadata.fileContent.byteLength === 1);
+            });
+
+            it("Download file with debugMode enabled and retrievalType published", async () => {
+                params
+                    .setRetrievalType(RetrievalType.PUBLISHED)
+                    .enableDebugMode();
+
+                getHeaderStub.onCall(0).returns("application/json");
+                getHeaderStub.onCall(1).returns("attachment; filename=\"test.json\"");
+                getHeaderStub.returns(null);
+
+                const fileWithMetadata = await filesApi.downloadFileWithMetadata(
+                    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"
+                    }
+                );
+                assert.ok(fileWithMetadata.contentType === "application/json");
+                assert.ok(fileWithMetadata.fileName === "test.json");
+                assert.ok(fileWithMetadata.fileContent.byteLength === 1);
+            });
+
+            it("Download file with debugMode disabled and retrievalType published", async () => {
+                params.setRetrievalType(RetrievalType.PUBLISHED);
+
+                getHeaderStub.onCall(0).returns("application/json");
+                getHeaderStub.onCall(1).returns("attachment; filename=\"test.json\"");
+                getHeaderStub.returns(null);
+
+                const fileWithMetadata = await filesApi.downloadFileWithMetadata(
+                    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"
+                    }
+                );
+                assert.ok(fileWithMetadata.contentType === "application/json");
+                assert.ok(fileWithMetadata.fileName === "test.json");
+                assert.ok(fileWithMetadata.fileContent.byteLength === 1);
+            });
+
+            it("Download file with includeOriginalStrings enabled", async() => {
+                params.setRetrievalType(RetrievalType.PUBLISHED).includeOriginalStrings();
+
+                getHeaderStub.onCall(0).returns("application/json");
+                getHeaderStub.onCall(1).returns("attachment; filename=\"test.json\"");
+                getHeaderStub.returns(null);
+
+                const fileWithMetadata = await filesApi.downloadFileWithMetadata(
+                    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"
+                    }
+                );
+                assert.ok(fileWithMetadata.contentType === "application/json");
+                assert.ok(fileWithMetadata.fileName === "test.json");
+                assert.ok(fileWithMetadata.fileContent.byteLength === 1);
+            });
+
+            it("Download file with includeOriginalStrings disabled", async() => {
+                params.setRetrievalType(RetrievalType.PUBLISHED).excludeOriginalStrings();
+
+                getHeaderStub.onCall(0).returns("application/json");
+                getHeaderStub.onCall(1).returns("attachment; filename=\"test.json\"");
+                getHeaderStub.returns(null);
+
+                const fileWithMetadata = await filesApi.downloadFileWithMetadata(
+                    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"
+                    }
+                );
+                assert.ok(fileWithMetadata.contentType === "application/json");
+                assert.ok(fileWithMetadata.fileName === "test.json");
+                assert.ok(fileWithMetadata.fileContent.byteLength === 1);
+            });
+        });
+
         describe("Download file - all translations", () => {
             let params: DownloadFileAllTranslationsParameters;
 
@@ -374,5 +652,106 @@ describe("SmartlingFilesApi class tests.", () => {
                 )
             );
         });
+
+        describe("Download multiple files translations", () => {
+            const localeId = "fr-FR";
+            const anotherLocaleId = "de-DE";
+            const files: FileLocales[] = [
+                {
+                    fileUri,
+                    localeIds: [localeId, anotherLocaleId]
+                }
+            ];
+            let params: DownloadMultipleFilesTranslationsParameters;
+
+            beforeEach(() => {
+                params = new DownloadMultipleFilesTranslationsParameters(files);
+            });
+
+            it("throws error if file is missing", () => {
+                assert.throws(() => {
+                    // eslint-disable-next-line no-new
+                    new DownloadMultipleFilesTranslationsParameters([]);
+                }, SmartlingException);
+            });
+
+            it("throws error if localeId is missing", () => {
+                assert.throws(() => {
+                    // eslint-disable-next-line no-new
+                    new DownloadMultipleFilesTranslationsParameters([{
+                        fileUri,
+                        localeIds: []
+                    }]);
+                }, SmartlingException);
+            });
+
+            it("Download mutliple files translations", async () => {
+                await filesApi.downloadMultipleFilesTranslations(
+                    projectId,
+                    params
+                );
+
+                sinon.assert.calledOnce(filesApiFetchStub);
+                sinon.assert.calledWithExactly(
+                    filesApiFetchStub,
+                    `https://test.com/files-api/v2/projects/${projectId}/files/zip`,
+                    {
+                        headers: {
+                            Authorization: "test_token_type test_access_token",
+                            "Content-Type": "application/json",
+                            "User-Agent": "test_user_agent"
+                        },
+                        method: "post",
+                        body: JSON.stringify({
+                            files: [{
+                                fileUri,
+                                localeIds: [localeId, anotherLocaleId]
+                            }]
+                        })
+                    }
+                );
+            });
+
+            it("Download mutliple files translations with parameters", async () => {
+                params
+                    .setRetrievalType(RetrievalType.PUBLISHED)
+                    .includeOriginalStrings()
+                    .setFileNameMode(TranslationFileNameMode.UNCHANGED)
+                    .setFileLocaleMode(FileLocaleMode.LOCALE_IN_PATH)
+                    .setZipFileName("translations.zip")
+                    .setFileFilter(FileFilter.ALL_FILES);
+
+                await filesApi.downloadMultipleFilesTranslations(
+                    projectId,
+                    params
+                );
+
+                sinon.assert.calledOnce(filesApiFetchStub);
+                sinon.assert.calledWithExactly(
+                    filesApiFetchStub,
+                    `https://test.com/files-api/v2/projects/${projectId}/files/zip`,
+                    {
+                        headers: {
+                            Authorization: "test_token_type test_access_token",
+                            "Content-Type": "application/json",
+                            "User-Agent": "test_user_agent"
+                        },
+                        method: "post",
+                        body: JSON.stringify({
+                            files: [{
+                                fileUri,
+                                localeIds: [localeId, anotherLocaleId]
+                            }],
+                            retrievalType: "published",
+                            includeOriginalStrings: true,
+                            fileNameMode: "unchanged",
+                            localeMode: "locale_in_path",
+                            zipFileName: "translations.zip",
+                            fileFilter: "all_files"
+                        })
+                    }
+                );
+            });
+        });
     });
 });

package/built/api/file-translations/dto/translated-file-dto.js.map

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