Merge pull request #98 from Smartling/ZD-795-Export-FTS-API-types

ZD-795 Export File Translations API types

Author: vfisyuk-smartling

api/file-translations/dto/fts-uploaded-file-dto.ts

@@ -0,0 +1,5 @@
+interface FtsUploadedFileDto {
+    fileUid: string
+}
+
+export { FtsUploadedFileDto };

api/file-translations/dto/uploaded-file-dto.ts

@@ -2,8 +2,8 @@ import FormData from "form-data";
 import { SmartlingBaseApi } from "../base";
 import { SmartlingAuthApi } from "../auth";
 import { Logger } from "../logger";
-import { UploadedFileDto } from "./dto/uploaded-file-dto";
-import { UploadFileParameters } from "./params/upload-file-parameters";
+import { FtsUploadedFileDto } from "./dto/fts-uploaded-file-dto";
+import { FtsUploadFileParameters } from "./params/fts-upload-file-parameters";
 import { TranslationDto } from "./dto/translation-dto";
 import { TranslateFileParameters } from "./params/translate-file-parameters";
 import { TranslationStatusDto } from "./dto/translation-status-dto";
@@ -18,8 +18,8 @@ export class SmartlingFileTranslationsApi extends SmartlingBaseApi {
     }
 
     async uploadFile(
-        accountUid: string, parameters: UploadFileParameters
-    ): Promise<UploadedFileDto> {
+        accountUid: string, parameters: FtsUploadFileParameters
+    ): Promise<FtsUploadedFileDto> {
         const formData = new FormData();
         const exported = parameters.export();
 

api/file-translations/index.ts

@@ -3,26 +3,26 @@ import string2fileStream from "string-to-file-stream";
 import { BaseParameters } from "../../parameters";
 import { FileType } from "../../files/params/file-type";
 
-export class UploadFileParameters extends BaseParameters {
+export class FtsUploadFileParameters extends BaseParameters {
     constructor(parameters: Record<string, unknown> = {}) {
         super(parameters);
 
         this.set("request", {});
     }
 
-    setFileFromLocalFilePath(filePath: string): UploadFileParameters {
+    setFileFromLocalFilePath(filePath: string): FtsUploadFileParameters {
         this.set("file", fs.createReadStream(
             fs.realpathSync(filePath)
         ));
         return this;
     }
 
-    setFileContent(fileContent: string): UploadFileParameters {
+    setFileContent(fileContent: string): FtsUploadFileParameters {
         this.set("file", string2fileStream(fileContent));
         return this;
     }
 
-    setFileType(fileType: FileType): UploadFileParameters {
+    setFileType(fileType: FileType): FtsUploadFileParameters {
         this.parameters.request.fileType = fileType.toUpperCase();
         return this;
     }

api/file-translations/params/upload-file-parameters.ts renamed to api/file-translations/params/fts-upload-file-parameters.ts

@@ -15,6 +15,19 @@ export * from "./api/context/params/create-bindings-parameters";
 export * from "./api/context/params/list-parameters";
 export * from "./api/context/context-http-response";
 export * from "./api/exception/index";
+export * from "./api/file-translations/index";
+export * from "./api/file-translations/params/fts-upload-file-parameters";
+export * from "./api/file-translations/params/translate-file-parameters";
+export * from "./api/file-translations/dto/error";
+export * from "./api/file-translations/dto/fts-uploaded-file-dto";
+export * from "./api/file-translations/dto/language-detection-dto";
+export * from "./api/file-translations/dto/language-detection-state";
+export * from "./api/file-translations/dto/language-detection-status-dto";
+export * from "./api/file-translations/dto/language-dto";
+export * from "./api/file-translations/dto/mt-state";
+export * from "./api/file-translations/dto/translation-dto";
+export * from "./api/file-translations/dto/translation-locale-status-dto";
+export * from "./api/file-translations/dto/translation-status-dto";
 export * from "./api/files/index";
 export * from "./api/files/params/download-file-parameters";
 export * from "./api/files/params/retrieval-type";

index.ts

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

package-lock.json

@@ -5,7 +5,7 @@ import sinon from "sinon";
 import { loggerMock, authMock, responseMock } from "./mock";
 import { SmartlingFileTranslationsApi } from "../api/file-translations";
 import { SmartlingAuthApi } from "../api/auth";
-import { UploadFileParameters } from "../api/file-translations/params/upload-file-parameters";
+import { FtsUploadFileParameters } from "../api/file-translations/params/fts-upload-file-parameters";
 import { FileType } from "../api/files/params/file-type";
 import { streamToString } from "./stream-to-string";
 import { TranslateFileParameters } from "../api/file-translations/params/translate-file-parameters";
@@ -47,7 +47,7 @@ describe("SmartlingFileTranslationsApi class tests.", () => {
 
     describe("Methods", () => {
         it("Upload file: from disk", async () => {
-            const params = new UploadFileParameters();
+            const params = new FtsUploadFileParameters();
 
             params
                 .setFileType(FileType.XML)
@@ -96,7 +96,7 @@ describe("SmartlingFileTranslationsApi class tests.", () => {
         });
 
         it("Upload file: as string", async () => {
-            const params = new UploadFileParameters();
+            const params = new FtsUploadFileParameters();
 
             const testFileContent = fs.readFileSync(
                 fs.realpathSync("./test/data/file.xml"),