smartling-api-sdk-nodejs 2.3.0 → 2.5.0

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

package/api/file-translations/dto/error.ts

@@ -0,0 +1,7 @@
+interface Error {
+    key: string,
+    message: string,
+    details: unknown
+}
+
+export { Error };

package/api/file-translations/dto/language-detection-dto.ts

@@ -0,0 +1,5 @@
+interface LanguageDetectionDto {
+    languageDetectionUid: string,
+}
+
+export { LanguageDetectionDto };

package/api/file-translations/dto/language-detection-state.ts

@@ -0,0 +1,5 @@
+export enum LanguageDetectionState {
+    QUEUED = "QUEUED",
+    FAILED = "FAILED",
+    COMPLETED = "COMPLETED"
+}

package/api/file-translations/dto/language-detection-status-dto.ts

@@ -0,0 +1,11 @@
+import { Error } from "./error";
+import { LanguageDetectionState } from "./language-detection-state";
+import { LanguageDto } from "./language-dto";
+
+interface LanguageDetectionStatusDto {
+    state: LanguageDetectionState,
+    error?: Error,
+    detectedSourceLanguages: LanguageDto[]
+}
+
+export { LanguageDetectionStatusDto };

package/api/file-translations/dto/language-dto.ts

@@ -0,0 +1,6 @@
+interface LanguageDto {
+    languageId: string,
+    defaultLocaleId: string
+}
+
+export { LanguageDto };

package/api/file-translations/dto/mt-state.ts

@@ -0,0 +1,7 @@
+export enum MTState {
+    QUEUED = "QUEUED",
+    PROCESSING = "PROCESSING",
+    FAILED = "FAILED",
+    CANCELED = "CANCELED",
+    COMPLETED = "COMPLETED"
+}

package/api/file-translations/dto/translation-dto.ts

@@ -0,0 +1,5 @@
+interface TranslationDto {
+    mtUid: string
+}
+
+export { TranslationDto };

package/api/file-translations/dto/translation-locale-status-dto.ts

@@ -0,0 +1,11 @@
+import { MTState } from "./mt-state";
+import { Error } from "./error";
+
+interface TranslationLocaleStatusDto {
+    localeId: string,
+    state: MTState,
+    processedStringCount: number,
+    error?: Error,
+}
+
+export { TranslationLocaleStatusDto };

package/api/file-translations/dto/translation-status-dto.ts

@@ -0,0 +1,12 @@
+import { MTState } from "./mt-state";
+import { Error } from "./error";
+import { TranslationLocaleStatusDto } from "./translation-locale-status-dto";
+
+interface TranslationStatusDto {
+    state: MTState,
+    requestedStringCount: number,
+    error?: Error,
+    localeProcessStatuses: TranslationLocaleStatusDto[]
+}
+
+export { TranslationStatusDto };

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

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

package/api/file-translations/index.ts

@@ -0,0 +1,114 @@
+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 { TranslationDto } from "./dto/translation-dto";
+import { TranslateFileParameters } from "./params/translate-file-parameters";
+import { TranslationStatusDto } from "./dto/translation-status-dto";
+import { LanguageDetectionDto } from "./dto/language-detection-dto";
+import { LanguageDetectionStatusDto } from "./dto/language-detection-status-dto";
+
+export class SmartlingFileTranslationsApi extends SmartlingBaseApi {
+    constructor(smartlingApiBaseUrl: string, authApi: SmartlingAuthApi, logger: Logger) {
+        super(logger);
+        this.authApi = authApi;
+        this.entrypoint = `${smartlingApiBaseUrl}/file-translations-api/v2/accounts`;
+    }
+
+    async uploadFile(
+        accountUid: string, parameters: UploadFileParameters
+    ): Promise<UploadedFileDto> {
+        const formData = new FormData();
+        const exported = parameters.export();
+
+        formData.append("file", exported.file);
+        formData.append("request", JSON.stringify(exported.request), {
+            contentType: "application/json"
+        });
+
+        return await this.makeRequest(
+            "post",
+            `${this.entrypoint}/${accountUid}/files`,
+            formData,
+            false,
+            SmartlingFileTranslationsApi.fixContentTypeHeaderCase(formData)
+        );
+    }
+
+    async translateFile(
+        accountUid: string, fileUid: string, params: TranslateFileParameters
+    ): Promise<TranslationDto> {
+        return await this.makeRequest(
+            "post",
+            `${this.entrypoint}/${accountUid}/files/${fileUid}/mt`,
+            JSON.stringify(params.export())
+        );
+    }
+
+    async getTranslationProgress(
+        accountUid: string, fileUid: string, mtUid: string
+    ): Promise<TranslationStatusDto> {
+        return await this.makeRequest(
+            "get",
+            `${this.entrypoint}/${accountUid}/files/${fileUid}/mt/${mtUid}/status`
+        );
+    }
+
+    async downloadTranslatedFile(
+        accountUid: string, fileUid: string, mtUid: string, localeId: string
+    ): Promise<string> {
+        return await this.makeRequest(
+            "get",
+            `${this.entrypoint}/${accountUid}/files/${fileUid}/mt/${mtUid}/locales/${localeId}/file`,
+            null,
+            true
+        );
+    }
+
+    async downloadTranslatedFiles(
+        accountUid: string, fileUid: string, mtUid: string
+    ): Promise<string> {
+        return await this.makeRequest(
+            "get",
+            `${this.entrypoint}/${accountUid}/files/${fileUid}/mt/${mtUid}/locales/all/file/zip`,
+            null,
+            true
+        );
+    }
+
+    async cancelFileTranslation(
+        accountUid: string, fileUid: string, mtUid: string
+    ): Promise<void> {
+        await this.makeRequest(
+            "post",
+            `${this.entrypoint}/${accountUid}/files/${fileUid}/mt/${mtUid}/cancel`
+        );
+    }
+
+    async detectFileLanguage(accountUid: string, fileUid: string): Promise<LanguageDetectionDto> {
+        return await this.makeRequest(
+            "post",
+            `${this.entrypoint}/${accountUid}/files/${fileUid}/language-detection`
+        );
+    }
+
+    async getLanguageDetectionProgress(
+        accountUid: string, fileUid: string, languageDetectionUid: string
+    ): Promise<LanguageDetectionStatusDto> {
+        return await this.makeRequest(
+            "get",
+            `${this.entrypoint}/${accountUid}/files/${fileUid}/language-detection/${languageDetectionUid}/status`
+        );
+    }
+
+    static fixContentTypeHeaderCase(form: FormData): Record<string, unknown> {
+        const headers = form.getHeaders();
+
+        headers["Content-Type"] = headers["content-type"];
+        // eslint-disable-next-line fp/no-delete
+        delete headers["content-type"];
+        return headers;
+    }
+}

package/api/file-translations/params/translate-file-parameters.ts

@@ -0,0 +1,13 @@
+import { BaseParameters } from "../../parameters";
+
+export class TranslateFileParameters extends BaseParameters {
+    setSourceLocaleId(sourceLocaleId: string): TranslateFileParameters {
+        this.set("sourceLocaleId", sourceLocaleId);
+        return this;
+    }
+
+    setTargetLocaleIds(targetLocaleIds: string[]): TranslateFileParameters {
+        this.set("targetLocaleIds", targetLocaleIds);
+        return this;
+    }
+}

package/api/file-translations/params/upload-file-parameters.ts

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

package/api/files/index.ts

@@ -56,7 +56,7 @@ export class SmartlingFilesApi extends SmartlingBaseApi {
     ): Promise<string> {
         return await this.makeRequest(
             "get",
-            `${this.entrypoint}/${projectId}/locales/all/file`,
+            `${this.entrypoint}/${projectId}/locales/all/file/zip`,
             Object.assign(params.export(), { fileUri }),
             true
         );

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

@@ -1,9 +1,3 @@
 import { DownloadFileParameters } from "./download-file-parameters";
 
-
-export class DownloadFileAllTranslationsParameters extends DownloadFileParameters {
-    setZipFileName(fileName: string): DownloadFileAllTranslationsParameters {
-        this.set("zipFileName", fileName);
-        return this;
-    }
-}
+export class DownloadFileAllTranslationsParameters extends DownloadFileParameters {}

package/api/job-batches/dto/batch-list-item-dto.ts

@@ -0,0 +1,14 @@
+import { BatchStatus } from "../params/batch-status";
+import { BatchDto } from "./batch-dto";
+
+interface BatchListItemDto extends BatchDto {
+    status: BatchStatus;
+    authorized: boolean;
+    translationJobUid: string;
+    projectId: string;
+    createdDate: Date
+    modifiedDate: Date
+
+}
+
+export { BatchListItemDto };

package/api/job-batches/index.ts

@@ -8,6 +8,9 @@ import { BatchStatusDto } from "./dto/batch-status-dto";
 import { BatchDto } from "./dto/batch-dto";
 import { CancelBatchFileParameters } from "./params/cancel-batch-file-parameters";
 import { RegisterBatchFileParameters } from "./params/register-batch-file-parameters";
+import { BatchListItemDto } from "./dto/batch-list-item-dto";
+import { SmartlingListResponse } from "../http/smartling-list-response";
+import { ListBatchesParameters } from "./params/list-batches-parameters";
 
 export class SmartlingJobBatchesApi extends SmartlingBaseApi {
     constructor(smartlingApiBaseUrl: string, authApi: SmartlingAuthApi, logger: Logger) {
@@ -82,4 +85,14 @@ export class SmartlingJobBatchesApi extends SmartlingBaseApi {
             `${this.entrypoint}/${projectId}/batches/${batchUid}`
         );
     }
+
+    async listBatches(projectId: string, params: ListBatchesParameters
+    ): Promise<SmartlingListResponse<BatchListItemDto>> {
+        return await this.makeRequest(
+            "get",
+            `${this.entrypoint}/${projectId}/batches`,
+            params.export()
+
+        );
+    }
 }

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

@@ -0,0 +1,41 @@
+import { BaseParameters } from "../../parameters/index";
+import { Order } from "../../parameters/order";
+import { BatchStatus } from "./batch-status";
+
+export class ListBatchesParameters extends BaseParameters {
+    setTranslationJobUid(uid: string): ListBatchesParameters {
+        this.set("translationJobUid", uid);
+
+        return this;
+    }
+
+    setLimit(limit: number): ListBatchesParameters {
+        if (limit > 0) {
+            this.set("limit", limit);
+        }
+
+        return this;
+    }
+
+    setOffset(offset: number): ListBatchesParameters {
+        if (offset >= 0) {
+            this.set("offset", offset);
+        }
+
+        return this;
+    }
+
+    setStatus(status: BatchStatus): ListBatchesParameters {
+        this.set("status", status);
+
+        return this;
+    }
+
+    setSort(field: "createdDate" | "status", order: Order): ListBatchesParameters {
+        this.set("sortBy", field);
+        this.set("sortDirection", order.toLowerCase());
+
+        return this;
+    }
+}
+

package/api/jobs/params/create-job-parameters.ts

@@ -37,4 +37,10 @@ export class CreateJobParameters extends BaseParameters {
 
         return this;
     }
+
+    setCallbackUrl(callbackUrl: string): CreateJobParameters {
+        this.set("callbackUrl", callbackUrl);
+
+        return this;
+    }
 }

package/built/api/file-translations/dto/error.d.ts

@@ -0,0 +1,6 @@
+interface Error {
+    key: string;
+    message: string;
+    details: unknown;
+}
+export { Error };

package/built/api/file-translations/dto/error.js

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

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

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

package/built/api/file-translations/dto/language-detection-dto.d.ts

@@ -0,0 +1,4 @@
+interface LanguageDetectionDto {
+    languageDetectionUid: string;
+}
+export { LanguageDetectionDto };

package/built/api/file-translations/dto/language-detection-dto.js

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

package/built/api/file-translations/dto/language-detection-dto.js.map

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

package/built/api/file-translations/dto/language-detection-state.d.ts

@@ -0,0 +1,5 @@
+export declare enum LanguageDetectionState {
+    QUEUED = "QUEUED",
+    FAILED = "FAILED",
+    COMPLETED = "COMPLETED"
+}

package/built/api/file-translations/dto/language-detection-state.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LanguageDetectionState = void 0;
+var LanguageDetectionState;
+(function (LanguageDetectionState) {
+    LanguageDetectionState["QUEUED"] = "QUEUED";
+    LanguageDetectionState["FAILED"] = "FAILED";
+    LanguageDetectionState["COMPLETED"] = "COMPLETED";
+})(LanguageDetectionState = exports.LanguageDetectionState || (exports.LanguageDetectionState = {}));
+//# sourceMappingURL=language-detection-state.js.map

package/built/api/file-translations/dto/language-detection-state.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"language-detection-state.js","sourceRoot":"","sources":["../../../../api/file-translations/dto/language-detection-state.ts"],"names":[],"mappings":";;;AAAA,IAAY,sBAIX;AAJD,WAAY,sBAAsB;IAC9B,2CAAiB,CAAA;IACjB,2CAAiB,CAAA;IACjB,iDAAuB,CAAA;AAC3B,CAAC,EAJW,sBAAsB,GAAtB,8BAAsB,KAAtB,8BAAsB,QAIjC"}

package/built/api/file-translations/dto/language-detection-status-dto.d.ts

@@ -0,0 +1,9 @@
+import { Error } from "./error";
+import { LanguageDetectionState } from "./language-detection-state";
+import { LanguageDto } from "./language-dto";
+interface LanguageDetectionStatusDto {
+    state: LanguageDetectionState;
+    error?: Error;
+    detectedSourceLanguages: LanguageDto[];
+}
+export { LanguageDetectionStatusDto };

package/built/api/file-translations/dto/language-detection-status-dto.js

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

package/built/api/file-translations/dto/language-detection-status-dto.js.map

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

package/built/api/file-translations/dto/language-dto.d.ts

@@ -0,0 +1,5 @@
+interface LanguageDto {
+    languageId: string;
+    defaultLocaleId: string;
+}
+export { LanguageDto };

package/built/api/file-translations/dto/language-dto.js

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

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

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

package/built/api/file-translations/dto/mt-state.d.ts

@@ -0,0 +1,7 @@
+export declare enum MTState {
+    QUEUED = "QUEUED",
+    PROCESSING = "PROCESSING",
+    FAILED = "FAILED",
+    CANCELED = "CANCELED",
+    COMPLETED = "COMPLETED"
+}

package/built/api/file-translations/dto/mt-state.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MTState = void 0;
+var MTState;
+(function (MTState) {
+    MTState["QUEUED"] = "QUEUED";
+    MTState["PROCESSING"] = "PROCESSING";
+    MTState["FAILED"] = "FAILED";
+    MTState["CANCELED"] = "CANCELED";
+    MTState["COMPLETED"] = "COMPLETED";
+})(MTState = exports.MTState || (exports.MTState = {}));
+//# sourceMappingURL=mt-state.js.map

package/built/api/file-translations/dto/mt-state.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mt-state.js","sourceRoot":"","sources":["../../../../api/file-translations/dto/mt-state.ts"],"names":[],"mappings":";;;AAAA,IAAY,OAMX;AAND,WAAY,OAAO;IACf,4BAAiB,CAAA;IACjB,oCAAyB,CAAA;IACzB,4BAAiB,CAAA;IACjB,gCAAqB,CAAA;IACrB,kCAAuB,CAAA;AAC3B,CAAC,EANW,OAAO,GAAP,eAAO,KAAP,eAAO,QAMlB"}

package/built/api/file-translations/dto/translation-dto.d.ts

@@ -0,0 +1,4 @@
+interface TranslationDto {
+    mtUid: string;
+}
+export { TranslationDto };

package/built/api/file-translations/dto/translation-dto.js

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

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

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

package/built/api/file-translations/dto/translation-locale-status-dto.d.ts

@@ -0,0 +1,9 @@
+import { MTState } from "./mt-state";
+import { Error } from "./error";
+interface TranslationLocaleStatusDto {
+    localeId: string;
+    state: MTState;
+    processedStringCount: number;
+    error?: Error;
+}
+export { TranslationLocaleStatusDto };

package/built/api/file-translations/dto/translation-locale-status-dto.js

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

package/built/api/file-translations/dto/translation-locale-status-dto.js.map

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

package/built/api/file-translations/dto/translation-status-dto.d.ts

@@ -0,0 +1,10 @@
+import { MTState } from "./mt-state";
+import { Error } from "./error";
+import { TranslationLocaleStatusDto } from "./translation-locale-status-dto";
+interface TranslationStatusDto {
+    state: MTState;
+    requestedStringCount: number;
+    error?: Error;
+    localeProcessStatuses: TranslationLocaleStatusDto[];
+}
+export { TranslationStatusDto };

package/built/api/file-translations/dto/translation-status-dto.js

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

package/built/api/file-translations/dto/translation-status-dto.js.map

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

package/built/api/file-translations/dto/uploaded-file-dto.d.ts

@@ -0,0 +1,4 @@
+interface UploadedFileDto {
+    fileUid: string;
+}
+export { UploadedFileDto };

package/built/api/file-translations/dto/uploaded-file-dto.js

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

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

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

package/built/api/file-translations/index.d.ts

@@ -0,0 +1,23 @@
+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 { TranslationDto } from "./dto/translation-dto";
+import { TranslateFileParameters } from "./params/translate-file-parameters";
+import { TranslationStatusDto } from "./dto/translation-status-dto";
+import { LanguageDetectionDto } from "./dto/language-detection-dto";
+import { LanguageDetectionStatusDto } from "./dto/language-detection-status-dto";
+export declare class SmartlingFileTranslationsApi extends SmartlingBaseApi {
+    constructor(smartlingApiBaseUrl: string, authApi: SmartlingAuthApi, logger: Logger);
+    uploadFile(accountUid: string, parameters: UploadFileParameters): Promise<UploadedFileDto>;
+    translateFile(accountUid: string, fileUid: string, params: TranslateFileParameters): Promise<TranslationDto>;
+    getTranslationProgress(accountUid: string, fileUid: string, mtUid: string): Promise<TranslationStatusDto>;
+    downloadTranslatedFile(accountUid: string, fileUid: string, mtUid: string, localeId: string): Promise<string>;
+    downloadTranslatedFiles(accountUid: string, fileUid: string, mtUid: string): Promise<string>;
+    cancelFileTranslation(accountUid: string, fileUid: string, mtUid: string): Promise<void>;
+    detectFileLanguage(accountUid: string, fileUid: string): Promise<LanguageDetectionDto>;
+    getLanguageDetectionProgress(accountUid: string, fileUid: string, languageDetectionUid: string): Promise<LanguageDetectionStatusDto>;
+    static fixContentTypeHeaderCase(form: FormData): Record<string, unknown>;
+}