smartling-api-sdk-nodejs 3.3.0 → 3.4.1

package/built/test/integration/translation-memory.spec.js

@@ -0,0 +1,138 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const dotenv_1 = __importDefault(require("dotenv"));
+const assert_1 = __importDefault(require("assert"));
+const index_1 = require("../../api/builder/index");
+const index_2 = require("../../api/translation-memory/index");
+const import_tmx_file_parameters_1 = require("../../api/translation-memory/params/import-tmx-file-parameters");
+const create_string_search_filter_parameters_1 = require("../../api/translation-memory/params/create-string-search-filter-parameters");
+const bulk_export_tm_strings_parameters_1 = require("../../api/translation-memory/params/bulk-export-tm-strings-parameters");
+const create_tm_parameters_1 = require("../../api/translation-memory/params/create-tm-parameters");
+const update_tm_parameters_1 = require("../../api/translation-memory/params/update-tm-parameters");
+const translation_quality_type_1 = require("../../api/translation-memory/params/translation-quality-type");
+dotenv_1.default.config();
+const baseSmartlingApiUrl = process.env.SMARTLING_API_BASE_URL || "https://api.smartling.com";
+const accountUid = process.env.SMARTLING_ACCOUNT_UID;
+const userId = process.env.SMARTLING_USER_ID;
+const userSecret = process.env.SMARTLING_USER_SECRET;
+const hasCredentials = Boolean(accountUid && userId && userSecret);
+const logResponsesEnabled = process.env.SMARTLING_LOG_RESPONSES === "true";
+function logResponse(label, response) {
+    if (!logResponsesEnabled) {
+        return;
+    }
+    console.log(`\n--- ${label} ---\n${JSON.stringify(response, null, 2)}`);
+}
+function delay(milliseconds) {
+    return new Promise((resolve) => {
+        setTimeout(resolve, milliseconds);
+    });
+}
+describe("SmartlingTranslationMemoryApi integration tests.", function integrationSuite() {
+    this.timeout(240000);
+    let api;
+    let tmUid;
+    before(function skipWithoutCredentials() {
+        if (!hasCredentials) {
+            console.log("Skipping Translation Memory integration tests: set SMARTLING_ACCOUNT_UID, SMARTLING_USER_ID, SMARTLING_USER_SECRET in .env");
+            this.skip();
+        }
+        api = new index_1.SmartlingApiClientBuilder()
+            .setBaseSmartlingApiUrl(baseSmartlingApiUrl)
+            .authWithUserIdAndUserSecret(userId, userSecret)
+            .build(index_2.SmartlingTranslationMemoryApi);
+    });
+    before(() => __awaiter(this, void 0, void 0, function* () {
+        const created = yield api.createTm(accountUid, new create_tm_parameters_1.CreateTmParameters()
+            .setName(`api-sdk-nodejs integration test TM ${Date.now()}`)
+            .setDescription("Created by the api-sdk-nodejs integration suite")
+            .setSourceLocaleId("en-US")
+            .setTranslationQuality(translation_quality_type_1.TranslationQualityType.TRANSLATION));
+        logResponse("createTm", created);
+        assert_1.default.ok(created, "createTm returned null");
+        ({ tmUid } = created);
+    }));
+    after(() => __awaiter(this, void 0, void 0, function* () {
+        if (tmUid) {
+            const deleted = yield api.deleteTm(accountUid, tmUid);
+            logResponse("deleteTm (cleanup)", deleted);
+        }
+    }));
+    it("Updates the TM", () => __awaiter(this, void 0, void 0, function* () {
+        const updatedName = `api-sdk-nodejs integration test TM (updated) ${Date.now()}`;
+        const updatedDescription = "Updated by the api-sdk-nodejs integration suite";
+        const updated = yield api.updateTm(accountUid, new update_tm_parameters_1.UpdateTmParameters()
+            .setTmUid(tmUid)
+            .setName(updatedName)
+            .setDescription(updatedDescription));
+        logResponse("updateTm", updated);
+        assert_1.default.ok(updated, "updateTm returned null");
+        assert_1.default.equal(updated.tmUid, tmUid);
+        assert_1.default.equal(updated.name, updatedName);
+        assert_1.default.equal(updated.description, updatedDescription);
+        assert_1.default.ok(updated.created instanceof Date);
+        assert_1.default.ok(updated.lastModified instanceof Date);
+    }));
+    it("Imports a TMX file", () => __awaiter(this, void 0, void 0, function* () {
+        const result = yield api.importTmxFile(accountUid, new import_tmx_file_parameters_1.ImportTmxFileParameters()
+            .setFileFromLocalFilePath("./test/data/sample.tmx")
+            .setFileUri(`integration-test-${Date.now()}.tmx`)
+            .setTmUid(tmUid)
+            .setDescription("api-sdk-nodejs integration test import"));
+        logResponse("importTmxFile", result);
+        assert_1.default.ok(result.jobUid);
+        assert_1.default.ok(result.tmxUid);
+        assert_1.default.equal(typeof result.stringCount, "number");
+        assert_1.default.equal(typeof result.wordCount, "number");
+    }));
+    it("Creates a string search, bulk-exports it, polls status, and downloads the TMX", () => __awaiter(this, void 0, void 0, function* () {
+        const searchFilter = new create_string_search_filter_parameters_1.CreateStringSearchFilterParameters().setTmUids([tmUid]);
+        let searchResult = yield api.createStringSearch(accountUid, searchFilter);
+        const searchDeadline = Date.now() + 30000;
+        while (!(searchResult === null || searchResult === void 0 ? void 0 : searchResult.stringCount) && Date.now() < searchDeadline) {
+            yield delay(2000);
+            searchResult = yield api.createStringSearch(accountUid, searchFilter);
+        }
+        logResponse("createStringSearch", searchResult);
+        assert_1.default.ok(searchResult, "createStringSearch returned null");
+        assert_1.default.ok(searchResult.searchUid);
+        assert_1.default.ok(searchResult.stringCount);
+        const exportResult = yield api.bulkExportTmStrings(accountUid, new bulk_export_tm_strings_parameters_1.BulkExportTmStringsParameters().setSearchUid(searchResult.searchUid));
+        logResponse("bulkExportTmStrings", exportResult);
+        assert_1.default.ok(exportResult, "bulkExportTmStrings returned null");
+        assert_1.default.ok(exportResult.actionUid);
+        const terminalStatuses = ["SUCCESS", "FAILURE", "CANCELED", "STOPPED"];
+        let status = yield api.getBulkExportTmStringsStatus(accountUid, exportResult.actionUid);
+        const deadline = Date.now() + 90000;
+        while (!((status === null || status === void 0 ? void 0 : status.executionComplete) || terminalStatuses.includes(status === null || status === void 0 ? void 0 : status.actionStatus))
+            && Date.now() < deadline) {
+            yield delay(2000);
+            status = yield api.getBulkExportTmStringsStatus(accountUid, exportResult.actionUid);
+        }
+        logResponse("getBulkExportTmStringsStatus", status);
+        assert_1.default.ok(status, "getBulkExportTmStringsStatus returned null");
+        assert_1.default.equal(status.actionStatus, "SUCCESS");
+        assert_1.default.equal(status.executionComplete, true);
+        assert_1.default.ok(status.tmxDownloadKey, "bulkExportTmStrings completed but returned no tmxDownloadKey - can't exercise downloadTmxFile");
+        const downloaded = yield api.downloadTmxFile(accountUid, status.tmxDownloadKey);
+        logResponse("downloadTmxFile", {
+            fileName: downloaded.fileName,
+            contentType: downloaded.contentType,
+            byteLength: downloaded.fileContent.byteLength
+        });
+        assert_1.default.ok(downloaded.fileContent.byteLength > 0);
+    }));
+});
+//# sourceMappingURL=translation-memory.spec.js.map

package/built/test/integration/translation-memory.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"translation-memory.spec.js","sourceRoot":"","sources":["../../../test/integration/translation-memory.spec.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,oDAA4B;AAC5B,oDAA4B;AAC5B,mDAAoE;AACpE,8DAAmF;AACnF,+GAAyG;AACzG,uIAAgI;AAChI,6HAAsH;AACtH,mGAA8F;AAC9F,mGAA8F;AAC9F,2GAAsG;AAEtG,gBAAM,CAAC,MAAM,EAAE,CAAC;AAEhB,MAAM,mBAAmB,GAAG,OAAO,CAAC,GAAG,CAAC,sBAAsB,IAAI,2BAA2B,CAAC;AAC9F,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,qBAA+B,CAAC;AAC/D,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,iBAA2B,CAAC;AACvD,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,qBAA+B,CAAC;AAC/D,MAAM,cAAc,GAAG,OAAO,CAAC,UAAU,IAAI,MAAM,IAAI,UAAU,CAAC,CAAC;AACnE,MAAM,mBAAmB,GAAG,OAAO,CAAC,GAAG,CAAC,uBAAuB,KAAK,MAAM,CAAC;AAE3E,SAAS,WAAW,CAAC,KAAa,EAAE,QAAiB;IACjD,IAAI,CAAC,mBAAmB,EAAE;QACtB,OAAO;KACV;IAGD,OAAO,CAAC,GAAG,CAAC,SAAS,KAAK,SAAS,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;AAC5E,CAAC;AAED,SAAS,KAAK,CAAC,YAAoB;IAC/B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC3B,UAAU,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;AACP,CAAC;AAED,QAAQ,CAAC,kDAAkD,EAAE,SAAS,gBAAgB;IAIlF,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAErB,IAAI,GAAkC,CAAC;IACvC,IAAI,KAAa,CAAC;IAElB,MAAM,CAAC,SAAS,sBAAsB;QAClC,IAAI,CAAC,cAAc,EAAE;YAEjB,OAAO,CAAC,GAAG,CAAC,4HAA4H,CAAC,CAAC;YAC1I,IAAI,CAAC,IAAI,EAAE,CAAC;SACf;QAED,GAAG,GAAG,IAAI,iCAAyB,EAAE;aAChC,sBAAsB,CAAC,mBAAmB,CAAC;aAC3C,2BAA2B,CAAC,MAAM,EAAE,UAAU,CAAC;aAC/C,KAAK,CAAC,qCAA6B,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IAEH,MAAM,CAAC,GAAS,EAAE;QACd,MAAM,OAAO,GAAG,MAAM,GAAG,CAAC,QAAQ,CAC9B,UAAU,EACV,IAAI,yCAAkB,EAAE;aACnB,OAAO,CAAC,sCAAsC,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;aAC3D,cAAc,CAAC,iDAAiD,CAAC;aACjE,iBAAiB,CAAC,OAAO,CAAC;aAC1B,qBAAqB,CAAC,iDAAsB,CAAC,WAAW,CAAC,CACjE,CAAC;QAEF,WAAW,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QACjC,gBAAM,CAAC,EAAE,CAAC,OAAO,EAAE,wBAAwB,CAAC,CAAC;QAC7C,CAAC,EAAE,KAAK,EAAE,GAAG,OAAO,CAAC,CAAC;IAC1B,CAAC,CAAA,CAAC,CAAC;IAEH,KAAK,CAAC,GAAS,EAAE;QACb,IAAI,KAAK,EAAE;YACP,MAAM,OAAO,GAAG,MAAM,GAAG,CAAC,QAAQ,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;YAEtD,WAAW,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC;SAC9C;IACL,CAAC,CAAA,CAAC,CAAC;IAEH,EAAE,CAAC,gBAAgB,EAAE,GAAS,EAAE;QAC5B,MAAM,WAAW,GAAG,gDAAgD,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC;QACjF,MAAM,kBAAkB,GAAG,iDAAiD,CAAC;QAE7E,MAAM,OAAO,GAAG,MAAM,GAAG,CAAC,QAAQ,CAC9B,UAAU,EACV,IAAI,yCAAkB,EAAE;aACnB,QAAQ,CAAC,KAAK,CAAC;aACf,OAAO,CAAC,WAAW,CAAC;aACpB,cAAc,CAAC,kBAAkB,CAAC,CAC1C,CAAC;QAEF,WAAW,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;QAEjC,gBAAM,CAAC,EAAE,CAAC,OAAO,EAAE,wBAAwB,CAAC,CAAC;QAC7C,gBAAM,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QACnC,gBAAM,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QACxC,gBAAM,CAAC,KAAK,CAAC,OAAO,CAAC,WAAW,EAAE,kBAAkB,CAAC,CAAC;QACtD,gBAAM,CAAC,EAAE,CAAC,OAAO,CAAC,OAAO,YAAY,IAAI,CAAC,CAAC;QAC3C,gBAAM,CAAC,EAAE,CAAC,OAAO,CAAC,YAAY,YAAY,IAAI,CAAC,CAAC;IACpD,CAAC,CAAA,CAAC,CAAC;IAEH,EAAE,CAAC,oBAAoB,EAAE,GAAS,EAAE;QAChC,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,aAAa,CAClC,UAAU,EACV,IAAI,oDAAuB,EAAE;aACxB,wBAAwB,CAAC,wBAAwB,CAAC;aAClD,UAAU,CAAC,oBAAoB,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC;aAChD,QAAQ,CAAC,KAAK,CAAC;aACf,cAAc,CAAC,wCAAwC,CAAC,CAChE,CAAC;QAEF,WAAW,CAAC,eAAe,EAAE,MAAM,CAAC,CAAC;QAErC,gBAAM,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACzB,gBAAM,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QACzB,gBAAM,CAAC,KAAK,CAAC,OAAO,MAAM,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;QAClD,gBAAM,CAAC,KAAK,CAAC,OAAO,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IACpD,CAAC,CAAA,CAAC,CAAC;IAEH,EAAE,CAAC,+EAA+E,EAAE,GAAS,EAAE;QAG3F,MAAM,YAAY,GAAG,IAAI,2EAAkC,EAAE,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;QACjF,IAAI,YAAY,GAAG,MAAM,GAAG,CAAC,kBAAkB,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;QAC1E,MAAM,cAAc,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC;QAE1C,OAAO,CAAC,CAAA,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,WAAW,CAAA,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,cAAc,EAAE;YAE9D,MAAM,KAAK,CAAC,IAAI,CAAC,CAAC;YAElB,YAAY,GAAG,MAAM,GAAG,CAAC,kBAAkB,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;SACzE;QAED,WAAW,CAAC,oBAAoB,EAAE,YAAY,CAAC,CAAC;QAChD,gBAAM,CAAC,EAAE,CAAC,YAAY,EAAE,kCAAkC,CAAC,CAAC;QAC5D,gBAAM,CAAC,EAAE,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;QAClC,gBAAM,CAAC,EAAE,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;QAEpC,MAAM,YAAY,GAAG,MAAM,GAAG,CAAC,mBAAmB,CAC9C,UAAU,EACV,IAAI,iEAA6B,EAAE,CAAC,YAAY,CAAC,YAAY,CAAC,SAAS,CAAC,CAC3E,CAAC;QAEF,WAAW,CAAC,qBAAqB,EAAE,YAAY,CAAC,CAAC;QACjD,gBAAM,CAAC,EAAE,CAAC,YAAY,EAAE,mCAAmC,CAAC,CAAC;QAC7D,gBAAM,CAAC,EAAE,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;QAKlC,MAAM,gBAAgB,GAAG,CAAC,SAAS,EAAE,SAAS,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC;QACvE,IAAI,MAAM,GAAG,MAAM,GAAG,CAAC,4BAA4B,CAAC,UAAU,EAAE,YAAY,CAAC,SAAS,CAAC,CAAC;QACxF,MAAM,QAAQ,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC;QAEpC,OACI,CAAC,CAAC,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,iBAAiB,KAAI,gBAAgB,CAAC,QAAQ,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,YAAY,CAAC,CAAC;eAC5E,IAAI,CAAC,GAAG,EAAE,GAAG,QAAQ,EAC1B;YAEE,MAAM,KAAK,CAAC,IAAI,CAAC,CAAC;YAElB,MAAM,GAAG,MAAM,GAAG,CAAC,4BAA4B,CAAC,UAAU,EAAE,YAAY,CAAC,SAAS,CAAC,CAAC;SACvF;QAED,WAAW,CAAC,8BAA8B,EAAE,MAAM,CAAC,CAAC;QACpD,gBAAM,CAAC,EAAE,CAAC,MAAM,EAAE,4CAA4C,CAAC,CAAC;QAChE,gBAAM,CAAC,KAAK,CAAC,MAAM,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;QAC7C,gBAAM,CAAC,KAAK,CAAC,MAAM,CAAC,iBAAiB,EAAE,IAAI,CAAC,CAAC;QAC7C,gBAAM,CAAC,EAAE,CAAC,MAAM,CAAC,cAAc,EAAE,+FAA+F,CAAC,CAAC;QAElI,MAAM,UAAU,GAAG,MAAM,GAAG,CAAC,eAAe,CAAC,UAAU,EAAE,MAAM,CAAC,cAAc,CAAC,CAAC;QAEhF,WAAW,CAAC,iBAAiB,EAAE;YAC3B,QAAQ,EAAE,UAAU,CAAC,QAAQ;YAC7B,WAAW,EAAE,UAAU,CAAC,WAAW;YACnC,UAAU,EAAE,UAAU,CAAC,WAAW,CAAC,UAAU;SAChD,CAAC,CAAC;QAEH,gBAAM,CAAC,EAAE,CAAC,UAAU,CAAC,WAAW,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC;IACrD,CAAC,CAAA,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/built/test/translation-memory.spec.d.ts

@@ -0,0 +1 @@
+export {};