smartling-api-sdk-nodejs 2.27.0 → 2.28.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=AZnkDu2E5pumWNxcJ_G-
-ceTaskUrl=https://sonar-next.connectors.stg.smartling.net/api/ce/task?id=AZnkDu2E5pumWNxcJ_G-
+ceTaskId=AZnyEx5RJWZPnO2QZLpi
+ceTaskUrl=https://sonar-next.connectors.stg.smartling.net/api/ce/task?id=AZnyEx5RJWZPnO2QZLpi

package/api/base/base-api.ts

@@ -0,0 +1,205 @@
+import merge from "merge-deep";
+import ua from "default-user-agent";
+import FormData from "form-data";
+import fetch from "cross-fetch";
+import { ParsedUrlQueryInput, stringify } from "querystring";
+import { Logger } from "../logger";
+import { SmartlingException } from "../exception/index";
+import { AccessTokenProvider } from "../auth/access-token-provider";
+import { ResponseBodyType } from "./enum/response-body-type";
+
+/* eslint-disable-next-line @typescript-eslint/no-var-requires */
+const packageJson = require("../../package.json");
+
+export class SmartlingBaseApi {
+    protected authApi: AccessTokenProvider = undefined;
+    protected entrypoint: string;
+    protected defaultClientLibId: string;
+    protected defaultClientVersion: string;
+    protected clientLibId: string;
+    protected clientLibVersion: string;
+    protected logger: Logger;
+    protected options: Record<string, unknown>;
+
+    constructor(logger: Logger) {
+        this.defaultClientLibId = packageJson.name;
+        this.defaultClientVersion = packageJson.version;
+        this.clientLibId = this.defaultClientLibId;
+        this.clientLibVersion = this.defaultClientVersion;
+        this.logger = logger;
+        this.options = {};
+    }
+
+    setOptions(options: Record<string, unknown>): void {
+        this.options = options;
+    }
+
+    public getClientLibId(): string {
+        return this.clientLibId;
+    }
+
+    public setClientLibId(clientLibId: string): void {
+        this.clientLibId = clientLibId;
+    }
+
+    public getClientLibVersion(): string {
+        return this.clientLibVersion;
+    }
+
+    public setClientLibVersion(clientLibVersion: string): void {
+        this.clientLibVersion = clientLibVersion;
+    }
+
+    /* eslint-disable-next-line class-methods-use-this */
+    async fetch(uri: string, options: Record<string, unknown>): Promise<Response> {
+        return await fetch(uri, options);
+    }
+
+    /* eslint-disable-next-line class-methods-use-this */
+    ua(clientId: string, clientVersion: string): string {
+        return ua(clientId, clientVersion);
+    }
+
+    /* eslint-disable-next-line class-methods-use-this */
+    alterRequestData(uri: string, opts: Record<string, unknown>): Record<string, unknown> {
+        return opts;
+    }
+
+    async getDefaultHeaders(
+        headers: Record<string, unknown> = {}
+    ): Promise<Record<string, unknown>> {
+        let defaultHeaders = {};
+
+        /* eslint-disable-next-line no-prototype-builtins */
+        if (this.hasOwnProperty("authApi") && undefined !== this.authApi) {
+            const accessToken = await this.authApi.getAccessToken();
+            const tokenType = await this.authApi.getTokenType();
+
+            defaultHeaders = {
+                Authorization: `${tokenType} ${accessToken}`
+            };
+        }
+
+        defaultHeaders["Content-Type"] = "application/json";
+        defaultHeaders["User-Agent"] = this.ua(this.clientLibId, this.clientLibVersion);
+
+        return merge(defaultHeaders, headers);
+    }
+
+    async makeRequest(
+        verb: string,
+        uri: string,
+        payload: Record<string, unknown> | string | FormData = null,
+        returnRawResponseBody: ResponseBodyType | boolean = false,
+        headers: Record<string, unknown> = {}
+    /* eslint-disable-next-line @typescript-eslint/no-explicit-any */
+    ): Promise<any> {
+        const opts = merge({
+            method: verb,
+            headers: await this.getDefaultHeaders(headers)
+        }, this.options);
+
+        if (verb.toLowerCase() !== "get" && payload) {
+            opts.body = payload;
+        } else if (payload) {
+            // Package node-fetch doesn't support query parameters.
+            // Let's add them manually.
+            uri = `${uri}?${stringify(payload as unknown as ParsedUrlQueryInput)}`;
+        }
+
+        let response = await this.fetch(uri, this.alterRequestData(uri, opts));
+
+        if (response.status === 401) {
+            this.logger.warn("Got unexpected 401 response code, trying to re-auth carefully...");
+
+            /* eslint-disable-next-line no-prototype-builtins */
+            if (this.hasOwnProperty("authApi") && this.authApi !== undefined) {
+                this.authApi.resetToken();
+            }
+
+            // Do not override http client headers set by SmartlingBaseApi.setOptions().
+            const defaultHeaders = await this.getDefaultHeaders(headers);
+            opts.headers.Authorization = defaultHeaders.Authorization;
+
+            response = await this.fetch(uri, this.alterRequestData(uri, opts));
+        }
+
+        if (response.status >= 400) {
+            const responseText = await response.text();
+
+            throw new SmartlingException(`Request for ${uri} failed`, {
+                statusCode: response.status,
+                errorResponse: responseText,
+                requestId: response.headers.get("x-sl-requestid")
+            });
+        }
+
+        // Special case for file download - return raw response text.
+        if (returnRawResponseBody === true || returnRawResponseBody === ResponseBodyType.TEXT) {
+            return response.text();
+        }
+
+        // Special case for zip file download - return raw response array buffer.
+        if (returnRawResponseBody === ResponseBodyType.ARRAY_BUFFER) {
+            return response.arrayBuffer();
+        }
+
+        // Special case for download file with metadata - return raw response.
+        if (returnRawResponseBody === ResponseBodyType.RAW_RESPONSE) {
+            return response;
+        }
+
+        let textResponse: string;
+        try {
+            textResponse = await response.text();
+            const jsonResponse = JSON.parse(textResponse, (key, value) => {
+                const dateProperties = [
+                    "created",
+                    "modified",
+                    "updated",
+                    "createdDate",
+                    "modifiedDate",
+                    "updatedDate",
+                    "dueDate",
+                    "actionTime",
+                    "publishDate",
+                    "lastModified",
+                    "attemptDate"
+                ];
+
+                if (dateProperties.includes(key) && value) {
+                    return new Date(value);
+                }
+
+                return value;
+            });
+
+            this.logger.debug(`Received code ${response.status}; content: ${JSON.stringify(jsonResponse, SmartlingBaseApi.sensitiveReplacer)}`);
+
+            return jsonResponse?.response?.data ? jsonResponse?.response?.data : true;
+        } catch (e) {
+            this.logger.error(`Couldn't parse response json: ${e.toString()}`);
+
+            throw new SmartlingException("Couldn't parse response json", {
+                statusCode: response.status,
+                errorResponse: textResponse,
+                requestId: response.headers.get("x-sl-requestid")
+            });
+        }
+    }
+
+    public static sensitiveReplacer(key: string, value: any): any {
+        const sensitiveProperties = [
+            "userIdentifier",
+            "userSecret",
+            "accessToken",
+            "refreshToken"
+        ];
+
+        if (sensitiveProperties.includes(key) && value && typeof value === "string") {
+            return `${value.substring(0, 10)}xxxxx`;
+        }
+
+        return value;
+    }
+}

package/api/base/base-file-api.ts

@@ -0,0 +1,23 @@
+import { SmartlingBaseApi } from "./base-api";
+import { TranslatedFileDto } from "../dto/translated-file-dto";
+
+export class SmartlingBaseFileApi extends SmartlingBaseApi {
+    static async downloadResponseToTranslatedFileDto(
+        response: Response
+    ): Promise<TranslatedFileDto> {
+        const contentType = response.headers.get("content-type") ?? undefined;
+        const contentDisposition = response.headers.get("content-disposition");
+        let fileName;
+        if (contentDisposition) {
+            const fileNameMatch = contentDisposition.match(/filename="((?:[^"\\]|\\.)*)"/);
+            if (fileNameMatch) {
+                fileName = fileNameMatch[1].replace(/\\"/g, "\"");
+            }
+        }
+        return {
+            fileContent: await response.arrayBuffer(),
+            fileName,
+            contentType
+        };
+    }
+}

package/api/base/index.ts

@@ -1,205 +1,2 @@
-import merge from "merge-deep";
-import ua from "default-user-agent";
-import FormData from "form-data";
-import fetch from "cross-fetch";
-import { ParsedUrlQueryInput, stringify } from "querystring";
-import { Logger } from "../logger";
-import { SmartlingException } from "../exception/index";
-import { AccessTokenProvider } from "../auth/access-token-provider";
-import { ResponseBodyType } from "./enum/response-body-type";
-
-/* eslint-disable-next-line @typescript-eslint/no-var-requires */
-const packageJson = require("../../package.json");
-
-export class SmartlingBaseApi {
-    protected authApi: AccessTokenProvider = undefined;
-    protected entrypoint: string;
-    protected defaultClientLibId: string;
-    protected defaultClientVersion: string;
-    protected clientLibId: string;
-    protected clientLibVersion: string;
-    protected logger: Logger;
-    protected options: Record<string, unknown>;
-
-    constructor(logger: Logger) {
-        this.defaultClientLibId = packageJson.name;
-        this.defaultClientVersion = packageJson.version;
-        this.clientLibId = this.defaultClientLibId;
-        this.clientLibVersion = this.defaultClientVersion;
-        this.logger = logger;
-        this.options = {};
-    }
-
-    setOptions(options: Record<string, unknown>): void {
-        this.options = options;
-    }
-
-    public getClientLibId(): string {
-        return this.clientLibId;
-    }
-
-    public setClientLibId(clientLibId: string): void {
-        this.clientLibId = clientLibId;
-    }
-
-    public getClientLibVersion(): string {
-        return this.clientLibVersion;
-    }
-
-    public setClientLibVersion(clientLibVersion: string): void {
-        this.clientLibVersion = clientLibVersion;
-    }
-
-    /* eslint-disable-next-line class-methods-use-this */
-    async fetch(uri: string, options: Record<string, unknown>): Promise<Response> {
-        return await fetch(uri, options);
-    }
-
-    /* eslint-disable-next-line class-methods-use-this */
-    ua(clientId: string, clientVersion: string): string {
-        return ua(clientId, clientVersion);
-    }
-
-    /* eslint-disable-next-line class-methods-use-this */
-    alterRequestData(uri: string, opts: Record<string, unknown>): Record<string, unknown> {
-        return opts;
-    }
-
-    async getDefaultHeaders(
-        headers: Record<string, unknown> = {}
-    ): Promise<Record<string, unknown>> {
-        let defaultHeaders = {};
-
-        /* eslint-disable-next-line no-prototype-builtins */
-        if (this.hasOwnProperty("authApi") && undefined !== this.authApi) {
-            const accessToken = await this.authApi.getAccessToken();
-            const tokenType = await this.authApi.getTokenType();
-
-            defaultHeaders = {
-                Authorization: `${tokenType} ${accessToken}`
-            };
-        }
-
-        defaultHeaders["Content-Type"] = "application/json";
-        defaultHeaders["User-Agent"] = this.ua(this.clientLibId, this.clientLibVersion);
-
-        return merge(defaultHeaders, headers);
-    }
-
-    async makeRequest(
-        verb: string,
-        uri: string,
-        payload: Record<string, unknown> | string | FormData = null,
-        returnRawResponseBody: ResponseBodyType | boolean = false,
-        headers: Record<string, unknown> = {}
-    /* eslint-disable-next-line @typescript-eslint/no-explicit-any */
-    ): Promise<any> {
-        const opts = merge({
-            method: verb,
-            headers: await this.getDefaultHeaders(headers)
-        }, this.options);
-
-        if (verb.toLowerCase() !== "get" && payload) {
-            opts.body = payload;
-        } else if (payload) {
-            // Package node-fetch doesn't support query parameters.
-            // Let's add them manually.
-            uri = `${uri}?${stringify(payload as unknown as ParsedUrlQueryInput)}`;
-        }
-
-        let response = await this.fetch(uri, this.alterRequestData(uri, opts));
-
-        if (response.status === 401) {
-            this.logger.warn("Got unexpected 401 response code, trying to re-auth carefully...");
-
-            /* eslint-disable-next-line no-prototype-builtins */
-            if (this.hasOwnProperty("authApi") && this.authApi !== undefined) {
-                this.authApi.resetToken();
-            }
-
-            // Do not override http client headers set by SmartlingBaseApi.setOptions().
-            const defaultHeaders = await this.getDefaultHeaders(headers);
-            opts.headers.Authorization = defaultHeaders.Authorization;
-
-            response = await this.fetch(uri, this.alterRequestData(uri, opts));
-        }
-
-        if (response.status >= 400) {
-            const responseText = await response.text();
-
-            throw new SmartlingException(`Request for ${uri} failed`, {
-                statusCode: response.status,
-                errorResponse: responseText,
-                requestId: response.headers.get("x-sl-requestid")
-            });
-        }
-
-        // Special case for file download - return raw response text.
-        if (returnRawResponseBody === true || returnRawResponseBody === ResponseBodyType.TEXT) {
-            return response.text();
-        }
-
-        // Special case for zip file download - return raw response array buffer.
-        if (returnRawResponseBody === ResponseBodyType.ARRAY_BUFFER) {
-            return response.arrayBuffer();
-        }
-
-        // Special case for download file with metadata - return raw response.
-        if (returnRawResponseBody === ResponseBodyType.RAW_RESPONSE) {
-            return response;
-        }
-
-        let textResponse: string;
-        try {
-            textResponse = await response.text();
-            const jsonResponse = JSON.parse(textResponse, (key, value) => {
-                const dateProperties = [
-                    "created",
-                    "modified",
-                    "updated",
-                    "createdDate",
-                    "modifiedDate",
-                    "updatedDate",
-                    "dueDate",
-                    "actionTime",
-                    "publishDate",
-                    "lastModified",
-                    "attemptDate"
-                ];
-
-                if (dateProperties.includes(key) && value) {
-                    return new Date(value);
-                }
-
-                return value;
-            });
-
-            this.logger.debug(`Received code ${response.status}; content: ${JSON.stringify(jsonResponse, SmartlingBaseApi.sensitiveReplacer)}`);
-
-            return jsonResponse?.response?.data ? jsonResponse?.response?.data : true;
-        } catch (e) {
-            this.logger.error(`Couldn't parse response json: ${e.toString()}`);
-
-            throw new SmartlingException("Couldn't parse response json", {
-                statusCode: response.status,
-                errorResponse: textResponse,
-                requestId: response.headers.get("x-sl-requestid")
-            });
-        }
-    }
-
-    public static sensitiveReplacer(key: string, value: any): any {
-        const sensitiveProperties = [
-            "userIdentifier",
-            "userSecret",
-            "accessToken",
-            "refreshToken"
-        ];
-
-        if (sensitiveProperties.includes(key) && value && typeof value === "string") {
-            return `${value.substring(0, 10)}xxxxx`;
-        }
-
-        return value;
-    }
-}
+export { SmartlingBaseApi } from "./base-api";
+export { SmartlingBaseFileApi } from "./base-file-api";

package/api/file-translations/index.ts

@@ -1,5 +1,5 @@
 import FormData from "form-data";
-import { SmartlingBaseApi } from "../base";
+import { SmartlingBaseFileApi } from "../base";
 import { AccessTokenProvider } from "../auth/access-token-provider";
 import { Logger } from "../logger";
 import { FtsUploadedFileDto } from "./dto/fts-uploaded-file-dto";
@@ -9,11 +9,11 @@ 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";
-import { TranslatedFileDto } from "./dto/translated-file-dto";
+import { TranslatedFileDto } from "../dto/translated-file-dto";
 import { ResponseBodyType } from "../base/enum/response-body-type";
 import { LanguageDetectionParameters } from "./params/language-detection-parameters";
 
-export class SmartlingFileTranslationsApi extends SmartlingBaseApi {
+export class SmartlingFileTranslationsApi extends SmartlingBaseFileApi {
     constructor(smartlingApiBaseUrl: string, authApi: AccessTokenProvider, logger: Logger) {
         super(logger);
         this.authApi = authApi;
@@ -81,7 +81,7 @@ export class SmartlingFileTranslationsApi extends SmartlingBaseApi {
     async downloadTranslatedFileWithMetadata(
         accountUid: string, fileUid: string, mtUid: string, localeId: string
     ): Promise<TranslatedFileDto> {
-        return await SmartlingFileTranslationsApi.downloadResponseToTranslatedFileDto(
+        return await SmartlingBaseFileApi.downloadResponseToTranslatedFileDto(
             await this.makeRequest(
                 "get",
                 `${this.entrypoint}/${accountUid}/files/${fileUid}/mt/${mtUid}/locales/${localeId}/file`,
@@ -105,7 +105,7 @@ export class SmartlingFileTranslationsApi extends SmartlingBaseApi {
     async downloadTranslatedFilesWithMetadata(
         accountUid: string, fileUid: string, mtUid: string
     ): Promise<TranslatedFileDto> {
-        return await SmartlingFileTranslationsApi.downloadResponseToTranslatedFileDto(
+        return await SmartlingBaseFileApi.downloadResponseToTranslatedFileDto(
             await this.makeRequest(
                 "get",
                 `${this.entrypoint}/${accountUid}/files/${fileUid}/mt/${mtUid}/locales/all/file/zip`,
@@ -151,23 +151,4 @@ export class SmartlingFileTranslationsApi extends SmartlingBaseApi {
         delete headers["content-type"];
         return headers;
     }
-
-    private static async downloadResponseToTranslatedFileDto(
-        response: Response
-    ): Promise<TranslatedFileDto> {
-        const contentType = response.headers.get("content-type") ?? undefined;
-        const contentDisposition = response.headers.get("content-disposition");
-        let fileName;
-        if (contentDisposition) {
-            const fileNameMatch = contentDisposition.match(/filename="((?:[^"\\]|\\.)*)"/);
-            if (fileNameMatch) {
-                fileName = fileNameMatch[1].replace(/\\"/g, "\"");
-            }
-        }
-        return {
-            fileContent: await response.arrayBuffer(),
-            fileName,
-            contentType
-        };
-    }
 }

package/api/files/index.ts

@@ -1,8 +1,9 @@
 import FormData from "form-data";
-import { SmartlingBaseApi } from "../base/index";
+import { SmartlingBaseFileApi } from "../base";
 import { AccessTokenProvider } from "../auth/access-token-provider";
 import { Logger } from "../logger";
 import { DownloadFileParameters } from "./params/download-file-parameters";
+import { DownloadFileWithMetadataParameters } from "./params/download-file-with-metadata-parameters";
 import { UploadFileParameters } from "./params/upload-file-parameters";
 import { FileStatusForAllLocalesDto } from "./dto/file-status-for-all-locales-dto";
 import { SmartlingListResponse } from "../http/smartling-list-response";
@@ -12,8 +13,9 @@ import { FileStatusForProjectDto } from "./dto/file-status-for-project-dto";
 import { DownloadFileAllTranslationsParameters } from "./params/download-file-all-translations-parameters";
 import { RecentlyUploadedFilesParameters } from "./params/recently-uploaded-files";
 import { ResponseBodyType } from "../base/enum/response-body-type";
+import { TranslatedFileDto } from "../dto/translated-file-dto";
 
-export class SmartlingFilesApi extends SmartlingBaseApi {
+export class SmartlingFilesApi extends SmartlingBaseFileApi {
     constructor(smartlingApiBaseUrl: string, authApi: AccessTokenProvider, logger: Logger) {
         super(logger);
         this.authApi = authApi;
@@ -55,6 +57,22 @@ export class SmartlingFilesApi extends SmartlingBaseApi {
         );
     }
 
+    async downloadFileWithMetadata(
+        projectId: string,
+        fileUri: string,
+        locale: string,
+        params: DownloadFileWithMetadataParameters
+    ): Promise<TranslatedFileDto> {
+        return await SmartlingBaseFileApi.downloadResponseToTranslatedFileDto(
+            await this.makeRequest(
+                "get",
+                `${this.entrypoint}/${projectId}/locales/${locale}/file`,
+                Object.assign(params.export(), { fileUri }),
+                ResponseBodyType.RAW_RESPONSE
+            )
+        );
+    }
+
     async downloadFileAllTranslations(
         projectId: string,
         fileUri: string,

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

@@ -0,0 +1,12 @@
+import { DownloadFileParameters } from "./download-file-parameters";
+import { FileNameMode } from "./filename-mode";
+
+export class DownloadFileWithMetadataParameters extends DownloadFileParameters {
+    setFileNameMode(fileNameMode: FileNameMode): DownloadFileParameters {
+        if (fileNameMode === FileNameMode.TRANSFORMED) {
+            this.set("changeFileName", true);
+        }
+
+        return this;
+    }
+}

package/api/files/params/filename-mode.ts

@@ -0,0 +1,4 @@
+export enum FileNameMode {
+    ORIGINAL = "original",
+    TRANSFORMED = "transformed"
+}

package/built/api/base/base-api.d.ts

@@ -0,0 +1,26 @@
+import FormData from "form-data";
+import { Logger } from "../logger";
+import { AccessTokenProvider } from "../auth/access-token-provider";
+import { ResponseBodyType } from "./enum/response-body-type";
+export declare class SmartlingBaseApi {
+    protected authApi: AccessTokenProvider;
+    protected entrypoint: string;
+    protected defaultClientLibId: string;
+    protected defaultClientVersion: string;
+    protected clientLibId: string;
+    protected clientLibVersion: string;
+    protected logger: Logger;
+    protected options: Record<string, unknown>;
+    constructor(logger: Logger);
+    setOptions(options: Record<string, unknown>): void;
+    getClientLibId(): string;
+    setClientLibId(clientLibId: string): void;
+    getClientLibVersion(): string;
+    setClientLibVersion(clientLibVersion: string): void;
+    fetch(uri: string, options: Record<string, unknown>): Promise<Response>;
+    ua(clientId: string, clientVersion: string): string;
+    alterRequestData(uri: string, opts: Record<string, unknown>): Record<string, unknown>;
+    getDefaultHeaders(headers?: Record<string, unknown>): Promise<Record<string, unknown>>;
+    makeRequest(verb: string, uri: string, payload?: Record<string, unknown> | string | FormData, returnRawResponseBody?: ResponseBodyType | boolean, headers?: Record<string, unknown>): Promise<any>;
+    static sensitiveReplacer(key: string, value: any): any;
+}