smartling-api-sdk-nodejs 2.6.0 → 2.7.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=AYyITSNeRe7rJHsZ61oT
-ceTaskUrl=https://sonar-next.connectors.stg.smartling.net/api/ce/task?id=AYyITSNeRe7rJHsZ61oT
+ceTaskId=AYzU_wxtRe7rJHsZ61o0
+ceTaskUrl=https://sonar-next.connectors.stg.smartling.net/api/ce/task?id=AYzU_wxtRe7rJHsZ61o0

package/api/published-files/dto/published-file-dto.ts

@@ -0,0 +1,7 @@
+interface PublishedFileDto {
+    fileUri: string;
+    localeId: string;
+    publishDate: Date;
+}
+
+export { PublishedFileDto };

package/api/published-files/index.ts

@@ -0,0 +1,25 @@
+import { SmartlingBaseApi } from "../base/index";
+import { SmartlingAuthApi } from "../auth/index";
+import { Logger } from "../logger";
+import { RecentlyPublishedFilesParameters } from "./params/recently-published-files-parameters";
+import { PublishedFileDto } from "./dto/published-file-dto";
+import { SmartlingListResponse } from "../http/smartling-list-response";
+
+export class SmartlingPublishedFilesApi extends SmartlingBaseApi {
+    constructor(smartlingApiBaseUrl: string, authApi: SmartlingAuthApi, logger: Logger) {
+        super(logger);
+
+        this.authApi = authApi;
+        this.entrypoint = `${smartlingApiBaseUrl}/published-files-api/v2`;
+    }
+
+    public async getRecentlyPublishedFiles(
+        projectUid: string, params: RecentlyPublishedFilesParameters
+    ): Promise<SmartlingListResponse<PublishedFileDto>> {
+        return await this.makeRequest(
+            "get",
+            `${this.entrypoint}/projects/${projectUid}/files/list/recently-published`,
+            params.export()
+        );
+    }
+}

package/api/published-files/params/recently-published-files-parameters.ts

@@ -0,0 +1,42 @@
+import { BaseParameters } from "../../parameters";
+import { SmartlingException } from "../../exception";
+
+export class RecentlyPublishedFilesParameters extends BaseParameters {
+    public setPublishedAfterDate(publishedAfterDate: Date): RecentlyPublishedFilesParameters {
+        this.set("publishedAfter", `${publishedAfterDate.toISOString().split(".")[0]}Z`);
+
+        return this;
+    }
+
+    setLimit(limit: number): RecentlyPublishedFilesParameters {
+        if (limit > 0) {
+            this.set("limit", limit);
+
+            return this;
+        }
+
+        throw new SmartlingException("Limit must be > 0");
+    }
+
+    setOffset(offset: number): RecentlyPublishedFilesParameters {
+        if (offset >= 0) {
+            this.set("offset", offset);
+
+            return this;
+        }
+
+        throw new SmartlingException("Offset must be >= 0");
+    }
+
+    setFileUris(fileUris: Array<string>): RecentlyPublishedFilesParameters {
+        this.set("fileUris[]", fileUris);
+
+        return this;
+    }
+
+    setLocaleIds(localeIds: Array<string>): RecentlyPublishedFilesParameters {
+        this.set("localeIds[]", localeIds);
+
+        return this;
+    }
+}

package/built/api/published-files/dto/published-file-dto.d.ts

@@ -0,0 +1,6 @@
+interface PublishedFileDto {
+    fileUri: string;
+    localeId: string;
+    publishDate: Date;
+}
+export { PublishedFileDto };

package/built/api/published-files/dto/published-file-dto.js

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

package/built/api/published-files/dto/published-file-dto.js.map

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

package/built/api/published-files/index.d.ts

@@ -0,0 +1,10 @@
+import { SmartlingBaseApi } from "../base/index";
+import { SmartlingAuthApi } from "../auth/index";
+import { Logger } from "../logger";
+import { RecentlyPublishedFilesParameters } from "./params/recently-published-files-parameters";
+import { PublishedFileDto } from "./dto/published-file-dto";
+import { SmartlingListResponse } from "../http/smartling-list-response";
+export declare class SmartlingPublishedFilesApi extends SmartlingBaseApi {
+    constructor(smartlingApiBaseUrl: string, authApi: SmartlingAuthApi, logger: Logger);
+    getRecentlyPublishedFiles(projectUid: string, params: RecentlyPublishedFilesParameters): Promise<SmartlingListResponse<PublishedFileDto>>;
+}

package/built/api/published-files/index.js

@@ -0,0 +1,27 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SmartlingPublishedFilesApi = void 0;
+const index_1 = require("../base/index");
+class SmartlingPublishedFilesApi extends index_1.SmartlingBaseApi {
+    constructor(smartlingApiBaseUrl, authApi, logger) {
+        super(logger);
+        this.authApi = authApi;
+        this.entrypoint = `${smartlingApiBaseUrl}/published-files-api/v2`;
+    }
+    getRecentlyPublishedFiles(projectUid, params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.makeRequest("get", `${this.entrypoint}/projects/${projectUid}/files/list/recently-published`, params.export());
+        });
+    }
+}
+exports.SmartlingPublishedFilesApi = SmartlingPublishedFilesApi;
+//# sourceMappingURL=index.js.map

package/built/api/published-files/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../api/published-files/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yCAAiD;AAOjD,MAAa,0BAA2B,SAAQ,wBAAgB;IAC5D,YAAY,mBAA2B,EAAE,OAAyB,EAAE,MAAc;QAC9E,KAAK,CAAC,MAAM,CAAC,CAAC;QAEd,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,UAAU,GAAG,GAAG,mBAAmB,yBAAyB,CAAC;IACtE,CAAC;IAEY,yBAAyB,CAClC,UAAkB,EAAE,MAAwC;;YAE5D,OAAO,MAAM,IAAI,CAAC,WAAW,CACzB,KAAK,EACL,GAAG,IAAI,CAAC,UAAU,aAAa,UAAU,gCAAgC,EACzE,MAAM,CAAC,MAAM,EAAE,CAClB,CAAC;QACN,CAAC;KAAA;CACJ;AAjBD,gEAiBC"}

package/built/api/published-files/params/recently-published-files-parameters.d.ts

@@ -0,0 +1,8 @@
+import { BaseParameters } from "../../parameters";
+export declare class RecentlyPublishedFilesParameters extends BaseParameters {
+    setPublishedAfterDate(publishedAfterDate: Date): RecentlyPublishedFilesParameters;
+    setLimit(limit: number): RecentlyPublishedFilesParameters;
+    setOffset(offset: number): RecentlyPublishedFilesParameters;
+    setFileUris(fileUris: Array<string>): RecentlyPublishedFilesParameters;
+    setLocaleIds(localeIds: Array<string>): RecentlyPublishedFilesParameters;
+}

package/built/api/published-files/params/recently-published-files-parameters.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RecentlyPublishedFilesParameters = void 0;
+const parameters_1 = require("../../parameters");
+const exception_1 = require("../../exception");
+class RecentlyPublishedFilesParameters extends parameters_1.BaseParameters {
+    setPublishedAfterDate(publishedAfterDate) {
+        this.set("publishedAfter", `${publishedAfterDate.toISOString().split(".")[0]}Z`);
+        return this;
+    }
+    setLimit(limit) {
+        if (limit > 0) {
+            this.set("limit", limit);
+            return this;
+        }
+        throw new exception_1.SmartlingException("Limit must be > 0");
+    }
+    setOffset(offset) {
+        if (offset >= 0) {
+            this.set("offset", offset);
+            return this;
+        }
+        throw new exception_1.SmartlingException("Offset must be >= 0");
+    }
+    setFileUris(fileUris) {
+        this.set("fileUris[]", fileUris);
+        return this;
+    }
+    setLocaleIds(localeIds) {
+        this.set("localeIds[]", localeIds);
+        return this;
+    }
+}
+exports.RecentlyPublishedFilesParameters = RecentlyPublishedFilesParameters;
+//# sourceMappingURL=recently-published-files-parameters.js.map

package/built/api/published-files/params/recently-published-files-parameters.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"recently-published-files-parameters.js","sourceRoot":"","sources":["../../../../api/published-files/params/recently-published-files-parameters.ts"],"names":[],"mappings":";;;AAAA,iDAAkD;AAClD,+CAAqD;AAErD,MAAa,gCAAiC,SAAQ,2BAAc;IACzD,qBAAqB,CAAC,kBAAwB;QACjD,IAAI,CAAC,GAAG,CAAC,gBAAgB,EAAE,GAAG,kBAAkB,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QAEjF,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,QAAQ,CAAC,KAAa;QAClB,IAAI,KAAK,GAAG,CAAC,EAAE;YACX,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YAEzB,OAAO,IAAI,CAAC;SACf;QAED,MAAM,IAAI,8BAAkB,CAAC,mBAAmB,CAAC,CAAC;IACtD,CAAC;IAED,SAAS,CAAC,MAAc;QACpB,IAAI,MAAM,IAAI,CAAC,EAAE;YACb,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YAE3B,OAAO,IAAI,CAAC;SACf;QAED,MAAM,IAAI,8BAAkB,CAAC,qBAAqB,CAAC,CAAC;IACxD,CAAC;IAED,WAAW,CAAC,QAAuB;QAC/B,IAAI,CAAC,GAAG,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;QAEjC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,YAAY,CAAC,SAAwB;QACjC,IAAI,CAAC,GAAG,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;QAEnC,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AAtCD,4EAsCC"}

package/built/index.d.ts

@@ -83,6 +83,9 @@ export * from "./api/parameters/order";
 export * from "./api/projects/index";
 export * from "./api/projects/dto/project-dto";
 export * from "./api/projects/dto/locale-dto";
+export * from "./api/published-files/index";
+export * from "./api/published-files/dto/published-file-dto";
+export * from "./api/published-files/params/recently-published-files-parameters";
 export * from "./api/strings/index";
 export * from "./api/strings/dto/source-string-dto";
 export * from "./api/strings/dto/source-string-key-dto";

package/built/index.js

@@ -99,6 +99,9 @@ __exportStar(require("./api/parameters/order"), exports);
 __exportStar(require("./api/projects/index"), exports);
 __exportStar(require("./api/projects/dto/project-dto"), exports);
 __exportStar(require("./api/projects/dto/locale-dto"), exports);
+__exportStar(require("./api/published-files/index"), exports);
+__exportStar(require("./api/published-files/dto/published-file-dto"), exports);
+__exportStar(require("./api/published-files/params/recently-published-files-parameters"), exports);
 __exportStar(require("./api/strings/index"), exports);
 __exportStar(require("./api/strings/dto/source-string-dto"), exports);
 __exportStar(require("./api/strings/dto/source-string-key-dto"), exports);

package/built/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAiC;AACjC,kEAAgD;AAChD,mDAAiC;AACjC,sDAAoC;AACpC,sDAAoC;AACpC,wEAAsD;AACtD,6EAA2D;AAC3D,gEAA8C;AAC9C,4EAA0D;AAC1D,uEAAqD;AACrD,0FAAwE;AACxE,oEAAkD;AAClD,iFAA+D;AAC/D,kFAAgE;AAChE,uEAAqD;AACrD,sEAAoD;AACpD,wDAAsC;AACtC,gEAA8C;AAC9C,4FAA0E;AAC1E,2FAAyE;AACzE,oEAAkD;AAClD,oFAAkE;AAClE,qFAAmE;AACnE,uFAAqE;AACrE,4FAA0E;AAC1E,2EAAyD;AACzD,uEAAqD;AACrD,8EAA4D;AAC5D,4FAA0E;AAC1E,qFAAmE;AACnE,oDAAkC;AAClC,8EAA4D;AAC5D,oEAAkD;AAClD,+DAA6C;AAC7C,4EAA0D;AAC1D,kFAAgE;AAChE,kFAAgE;AAChE,+EAA6D;AAC7D,oEAAkD;AAClD,qEAAmD;AACnD,0DAAwC;AACxC,kEAAgD;AAChD,uEAAqD;AACrD,yEAAuD;AACvD,yEAAuD;AACvD,4EAA0D;AAC1D,mFAAiE;AACjE,wFAAsE;AACtE,2FAAyE;AACzE,wFAAsE;AACtE,0FAAwE;AACxE,wEAAsD;AACtD,wEAAsD;AACtD,mFAAiE;AACjE,6EAA2D;AAC3D,mDAAiC;AACjC,8DAA4C;AAC5C,kFAAgE;AAChE,kEAAgD;AAChD,mEAAiD;AACjD,sEAAoD;AACpD,iEAA+C;AAC/C,yDAAuC;AACvC,iEAA+C;AAC/C,mFAAiE;AACjE,uFAAqE;AACrE,kEAAgD;AAChD,mEAAiD;AACjD,yEAAuD;AACvD,kEAAgD;AAChD,0EAAwD;AACxD,6EAA2D;AAC3D,4EAA0D;AAC1D,+DAA6C;AAC7C,8EAA4D;AAC5D,yEAAuD;AACvD,2EAAyD;AACzD,0EAAwD;AACxD,yEAAuD;AACvD,2EAAyD;AACzD,yDAAuC;AACvC,yDAAuC;AACvC,uDAAqC;AACrC,iEAA+C;AAC/C,gEAA8C;AAC9C,sDAAoC;AACpC,sEAAoD;AACpD,0EAAwD;AACxD,uFAAqE;AACrE,+CAA6B;AAC7B,wEAAsD;AACtD,+FAA6E;AAC7E,6EAA2D"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAiC;AACjC,kEAAgD;AAChD,mDAAiC;AACjC,sDAAoC;AACpC,sDAAoC;AACpC,wEAAsD;AACtD,6EAA2D;AAC3D,gEAA8C;AAC9C,4EAA0D;AAC1D,uEAAqD;AACrD,0FAAwE;AACxE,oEAAkD;AAClD,iFAA+D;AAC/D,kFAAgE;AAChE,uEAAqD;AACrD,sEAAoD;AACpD,wDAAsC;AACtC,gEAA8C;AAC9C,4FAA0E;AAC1E,2FAAyE;AACzE,oEAAkD;AAClD,oFAAkE;AAClE,qFAAmE;AACnE,uFAAqE;AACrE,4FAA0E;AAC1E,2EAAyD;AACzD,uEAAqD;AACrD,8EAA4D;AAC5D,4FAA0E;AAC1E,qFAAmE;AACnE,oDAAkC;AAClC,8EAA4D;AAC5D,oEAAkD;AAClD,+DAA6C;AAC7C,4EAA0D;AAC1D,kFAAgE;AAChE,kFAAgE;AAChE,+EAA6D;AAC7D,oEAAkD;AAClD,qEAAmD;AACnD,0DAAwC;AACxC,kEAAgD;AAChD,uEAAqD;AACrD,yEAAuD;AACvD,yEAAuD;AACvD,4EAA0D;AAC1D,mFAAiE;AACjE,wFAAsE;AACtE,2FAAyE;AACzE,wFAAsE;AACtE,0FAAwE;AACxE,wEAAsD;AACtD,wEAAsD;AACtD,mFAAiE;AACjE,6EAA2D;AAC3D,mDAAiC;AACjC,8DAA4C;AAC5C,kFAAgE;AAChE,kEAAgD;AAChD,mEAAiD;AACjD,sEAAoD;AACpD,iEAA+C;AAC/C,yDAAuC;AACvC,iEAA+C;AAC/C,mFAAiE;AACjE,uFAAqE;AACrE,kEAAgD;AAChD,mEAAiD;AACjD,yEAAuD;AACvD,kEAAgD;AAChD,0EAAwD;AACxD,6EAA2D;AAC3D,4EAA0D;AAC1D,+DAA6C;AAC7C,8EAA4D;AAC5D,yEAAuD;AACvD,2EAAyD;AACzD,0EAAwD;AACxD,yEAAuD;AACvD,2EAAyD;AACzD,yDAAuC;AACvC,yDAAuC;AACvC,uDAAqC;AACrC,iEAA+C;AAC/C,gEAA8C;AAC9C,8DAA4C;AAC5C,+EAA6D;AAC7D,mGAAiF;AACjF,sDAAoC;AACpC,sEAAoD;AACpD,0EAAwD;AACxD,uFAAqE;AACrE,+CAA6B;AAC7B,wEAAsD;AACtD,+FAA6E;AAC7E,6EAA2D"}

package/built/package.json

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

package/index.ts

@@ -83,6 +83,9 @@ export * from "./api/parameters/order";
 export * from "./api/projects/index";
 export * from "./api/projects/dto/project-dto";
 export * from "./api/projects/dto/locale-dto";
+export * from "./api/published-files/index";
+export * from "./api/published-files/dto/published-file-dto";
+export * from "./api/published-files/params/recently-published-files-parameters";
 export * from "./api/strings/index";
 export * from "./api/strings/dto/source-string-dto";
 export * from "./api/strings/dto/source-string-key-dto";

package/package.json

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

package/test/published-files.spec.ts

@@ -0,0 +1,74 @@
+import sinon from "sinon";
+import assert from "assert";
+import { SmartlingPublishedFilesApi } from "../api/published-files";
+import { RecentlyPublishedFilesParameters } from "../api/published-files/params/recently-published-files-parameters";
+import { SmartlingAuthApi } from "../api/auth/index";
+import { loggerMock, authMock, responseMock } from "./mock";
+
+describe("SmartlingPublishedFilesApi class tests.", () => {
+    let publishedFilesApi;
+    let publishedFilesApiFetchStub;
+    let publishedFilesApiUaStub;
+    let responseMockTextStub;
+
+    beforeEach(() => {
+        publishedFilesApi = new SmartlingPublishedFilesApi("https://test.com", authMock as unknown as SmartlingAuthApi, loggerMock);
+
+        publishedFilesApiFetchStub = sinon.stub(publishedFilesApi, "fetch");
+        publishedFilesApiUaStub = sinon.stub(publishedFilesApi, "ua");
+        responseMockTextStub = sinon.stub(responseMock, "text");
+
+        publishedFilesApiUaStub.returns("test_user_agent");
+        publishedFilesApiFetchStub.returns(responseMock);
+        responseMockTextStub.returns("{\"response\": {}}");
+    });
+
+    afterEach(() => {
+        publishedFilesApiFetchStub.restore();
+        responseMockTextStub.restore();
+        publishedFilesApiUaStub.restore();
+    });
+
+    it("Get recently published files", async () => {
+        const params: RecentlyPublishedFilesParameters = new RecentlyPublishedFilesParameters();
+
+        params.setPublishedAfterDate(new Date("2020-09-24T00:00:00Z"));
+        params.setFileUris(["test:_1.xml", "test/file&_2.xml"]);
+        params.setLocaleIds(["fr", "de"]);
+        params.setOffset(0);
+        params.setLimit(100);
+
+        await publishedFilesApi.getRecentlyPublishedFiles("test_project", params);
+
+        sinon.assert.calledOnce(publishedFilesApiFetchStub);
+        sinon.assert.calledWithExactly(
+            publishedFilesApiFetchStub,
+            "https://test.com/published-files-api/v2/projects/test_project/files/list/recently-published?publishedAfter=2020-09-24T00%3A00%3A00Z&fileUris%5B%5D=test%3A_1.xml&fileUris%5B%5D=test%2Ffile%26_2.xml&localeIds%5B%5D=fr&localeIds%5B%5D=de&offset=0&limit=100", {
+                headers: {
+                    Authorization: "test_token_type test_access_token",
+                    "Content-Type": "application/json",
+                    "User-Agent": "test_user_agent"
+                },
+                method: "get"
+            }
+        );
+    });
+
+    it("Invalid offset", async () => {
+        try {
+            new RecentlyPublishedFilesParameters().setOffset(-1);
+        } catch (e) {
+            assert.equal(e.constructor.name, "SmartlingException");
+            assert.equal(e.message, "Offset must be >= 0");
+        }
+    });
+
+    it("Invalid limit", async () => {
+        try {
+            new RecentlyPublishedFilesParameters().setLimit(0);
+        } catch (e) {
+            assert.equal(e.constructor.name, "SmartlingException");
+            assert.equal(e.message, "Limit must be > 0");
+        }
+    });
+});