smartling-api-sdk-nodejs 2.9.1 → 2.10.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=AY3rmpPVRe7rJHsZ61td
-ceTaskUrl=https://sonar-next.connectors.stg.smartling.net/api/ce/task?id=AY3rmpPVRe7rJHsZ61td
+ceTaskId=AY9TuQLS7SpYu_MF-cEQ
+ceTaskUrl=https://sonar-next.connectors.stg.smartling.net/api/ce/task?id=AY9TuQLS7SpYu_MF-cEQ

package/api/files/index.ts

@@ -10,6 +10,7 @@ import { LastModifiedForLocale } from "./dto/last-modified-for-locale-dto";
 import { UploadedFileDto } from "./dto/uploaded-file-dto";
 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";
 
 export class SmartlingFilesApi extends SmartlingBaseApi {
     constructor(smartlingApiBaseUrl: string, authApi: SmartlingAuthApi, logger: Logger) {
@@ -95,11 +96,13 @@ export class SmartlingFilesApi extends SmartlingBaseApi {
     }
 
     async getRecentlyUploadedFiles(
-        projectId: string
+        projectId: string,
+        params: RecentlyUploadedFilesParameters
     ): Promise<SmartlingListResponse<FileStatusForProjectDto>> {
         return await this.makeRequest(
             "get",
-            `${this.entrypoint}/${projectId}/files/list`
+            `${this.entrypoint}/${projectId}/files/list`,
+            params.export()
         );
     }
 

package/api/files/params/recently-uploaded-files.ts

@@ -0,0 +1,30 @@
+import { SmartlingException } from "../../exception";
+import { BaseParameters } from "../../parameters/index";
+
+export class RecentlyUploadedFilesParameters extends BaseParameters {
+    setUriMask(uriMask: string): RecentlyUploadedFilesParameters {
+        this.set("uriMask", uriMask);
+
+        return this;
+    }
+
+    setLimit(limit: number): RecentlyUploadedFilesParameters {
+        if (limit > 0) {
+            this.set("limit", limit);
+
+            return this;
+        }
+
+        throw new SmartlingException("Limit must be > 0");
+    }
+
+    setOffset(offset: number): RecentlyUploadedFilesParameters {
+        if (offset >= 0) {
+            this.set("offset", offset);
+
+            return this;
+        }
+
+        throw new SmartlingException("Offset must be >= 0");
+    }
+}

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

@@ -10,6 +10,7 @@ import { LastModifiedForLocale } from "./dto/last-modified-for-locale-dto";
 import { UploadedFileDto } from "./dto/uploaded-file-dto";
 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";
 export declare class SmartlingFilesApi extends SmartlingBaseApi {
     constructor(smartlingApiBaseUrl: string, authApi: SmartlingAuthApi, logger: Logger);
     getStatusForAllLocales(projectId: string, fileUri: string): Promise<FileStatusForAllLocalesDto>;
@@ -18,6 +19,6 @@ export declare class SmartlingFilesApi extends SmartlingBaseApi {
     downloadFileAllTranslations(projectId: string, fileUri: string, params: DownloadFileAllTranslationsParameters): Promise<string>;
     deleteFile(projectId: string, fileUri: string): Promise<boolean>;
     uploadFile(projectId: string, parameters: UploadFileParameters): Promise<UploadedFileDto>;
-    getRecentlyUploadedFiles(projectId: string): Promise<SmartlingListResponse<FileStatusForProjectDto>>;
+    getRecentlyUploadedFiles(projectId: string, params: RecentlyUploadedFilesParameters): Promise<SmartlingListResponse<FileStatusForProjectDto>>;
     static fixContentTypeHeaderCase(form: FormData): Record<string, unknown>;
 }

package/built/api/files/index.js

@@ -58,9 +58,9 @@ class SmartlingFilesApi extends index_1.SmartlingBaseApi {
             return yield this.makeRequest("post", `${this.entrypoint}/${projectId}/file`, formData, false, SmartlingFilesApi.fixContentTypeHeaderCase(formData));
         });
     }
-    getRecentlyUploadedFiles(projectId) {
+    getRecentlyUploadedFiles(projectId, params) {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield this.makeRequest("get", `${this.entrypoint}/${projectId}/files/list`);
+            return yield this.makeRequest("get", `${this.entrypoint}/${projectId}/files/list`, params.export());
         });
     }
     static fixContentTypeHeaderCase(form) {

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../api/files/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,0DAAiC;AACjC,yCAAiD;AAYjD,MAAa,iBAAkB,SAAQ,wBAAgB;IACnD,YAAY,mBAA2B,EAAE,OAAyB,EAAE,MAAc;QAC9E,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,UAAU,GAAG,GAAG,mBAAmB,wBAAwB,CAAC;IACrE,CAAC;IAEK,sBAAsB,CACxB,SAAiB,EAAE,OAAe;;YAElC,OAAO,MAAM,IAAI,CAAC,WAAW,CACzB,KAAK,EACL,GAAG,IAAI,CAAC,UAAU,IAAI,SAAS,cAAc,EAC7C,EAAE,OAAO,EAAE,CACd,CAAC;QACN,CAAC;KAAA;IAEK,eAAe,CACjB,SAAiB,EAAE,OAAe;;YAElC,OAAO,MAAM,IAAI,CAAC,WAAW,CACzB,KAAK,EACL,GAAG,IAAI,CAAC,UAAU,IAAI,SAAS,qBAAqB,EACpD,EAAE,OAAO,EAAE,CACd,CAAC;QACN,CAAC;KAAA;IAEK,YAAY,CACd,SAAiB,EAAE,OAAe,EAAE,MAAc,EAAE,MAA8B;;YAElF,OAAO,MAAM,IAAI,CAAC,WAAW,CACzB,KAAK,EACL,GAAG,IAAI,CAAC,UAAU,IAAI,SAAS,YAAY,MAAM,OAAO,EACxD,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,EAC3C,IAAI,CACP,CAAC;QACN,CAAC;KAAA;IAEK,2BAA2B,CAC7B,SAAiB,EACjB,OAAe,EACf,MAA6C;;YAE7C,OAAO,MAAM,IAAI,CAAC,WAAW,CACzB,KAAK,EACL,GAAG,IAAI,CAAC,UAAU,IAAI,SAAS,uBAAuB,EACtD,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,EAC3C,IAAI,CACP,CAAC;QACN,CAAC;KAAA;IAEK,UAAU,CAAC,SAAiB,EAAE,OAAe;;YAC/C,MAAM,IAAI,GAAG,IAAI,mBAAQ,EAAE,CAAC;YAE5B,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;YAEhC,OAAO,MAAM,IAAI,CAAC,WAAW,CACzB,MAAM,EACN,GAAG,IAAI,CAAC,UAAU,IAAI,SAAS,cAAc,EAC7C,IAAI,EACJ,KAAK,EACL,iBAAiB,CAAC,wBAAwB,CAAC,IAAI,CAAC,CACnD,CAAC;QACN,CAAC;KAAA;IAEK,UAAU,CACZ,SAAiB,EAAE,UAAgC;;YAEnD,MAAM,QAAQ,GAAG,IAAI,mBAAQ,EAAE,CAAC;YAChC,MAAM,QAAQ,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC;YACrC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;gBAClC,QAAQ,CAAC,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;YACxC,CAAC,CAAC,CAAC;YAEH,OAAO,MAAM,IAAI,CAAC,WAAW,CACzB,MAAM,EACN,GAAG,IAAI,CAAC,UAAU,IAAI,SAAS,OAAO,EACtC,QAAQ,EACR,KAAK,EACL,iBAAiB,CAAC,wBAAwB,CAAC,QAAQ,CAAC,CACvD,CAAC;QACN,CAAC;KAAA;IAEK,wBAAwB,CAC1B,SAAiB;;YAEjB,OAAO,MAAM,IAAI,CAAC,WAAW,CACzB,KAAK,EACL,GAAG,IAAI,CAAC,UAAU,IAAI,SAAS,aAAa,CAC/C,CAAC;QACN,CAAC;KAAA;IAED,MAAM,CAAC,wBAAwB,CAAC,IAAc;QAC1C,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAElC,OAAO,CAAC,cAAc,CAAC,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;QAElD,OAAO,OAAO,CAAC,cAAc,CAAC,CAAC;QAC/B,OAAO,OAAO,CAAC;IACnB,CAAC;CACJ;AApGD,8CAoGC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../api/files/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,0DAAiC;AACjC,yCAAiD;AAajD,MAAa,iBAAkB,SAAQ,wBAAgB;IACnD,YAAY,mBAA2B,EAAE,OAAyB,EAAE,MAAc;QAC9E,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACvB,IAAI,CAAC,UAAU,GAAG,GAAG,mBAAmB,wBAAwB,CAAC;IACrE,CAAC;IAEK,sBAAsB,CACxB,SAAiB,EAAE,OAAe;;YAElC,OAAO,MAAM,IAAI,CAAC,WAAW,CACzB,KAAK,EACL,GAAG,IAAI,CAAC,UAAU,IAAI,SAAS,cAAc,EAC7C,EAAE,OAAO,EAAE,CACd,CAAC;QACN,CAAC;KAAA;IAEK,eAAe,CACjB,SAAiB,EAAE,OAAe;;YAElC,OAAO,MAAM,IAAI,CAAC,WAAW,CACzB,KAAK,EACL,GAAG,IAAI,CAAC,UAAU,IAAI,SAAS,qBAAqB,EACpD,EAAE,OAAO,EAAE,CACd,CAAC;QACN,CAAC;KAAA;IAEK,YAAY,CACd,SAAiB,EAAE,OAAe,EAAE,MAAc,EAAE,MAA8B;;YAElF,OAAO,MAAM,IAAI,CAAC,WAAW,CACzB,KAAK,EACL,GAAG,IAAI,CAAC,UAAU,IAAI,SAAS,YAAY,MAAM,OAAO,EACxD,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,EAC3C,IAAI,CACP,CAAC;QACN,CAAC;KAAA;IAEK,2BAA2B,CAC7B,SAAiB,EACjB,OAAe,EACf,MAA6C;;YAE7C,OAAO,MAAM,IAAI,CAAC,WAAW,CACzB,KAAK,EACL,GAAG,IAAI,CAAC,UAAU,IAAI,SAAS,uBAAuB,EACtD,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,EAAE,OAAO,EAAE,CAAC,EAC3C,IAAI,CACP,CAAC;QACN,CAAC;KAAA;IAEK,UAAU,CAAC,SAAiB,EAAE,OAAe;;YAC/C,MAAM,IAAI,GAAG,IAAI,mBAAQ,EAAE,CAAC;YAE5B,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;YAEhC,OAAO,MAAM,IAAI,CAAC,WAAW,CACzB,MAAM,EACN,GAAG,IAAI,CAAC,UAAU,IAAI,SAAS,cAAc,EAC7C,IAAI,EACJ,KAAK,EACL,iBAAiB,CAAC,wBAAwB,CAAC,IAAI,CAAC,CACnD,CAAC;QACN,CAAC;KAAA;IAEK,UAAU,CACZ,SAAiB,EAAE,UAAgC;;YAEnD,MAAM,QAAQ,GAAG,IAAI,mBAAQ,EAAE,CAAC;YAChC,MAAM,QAAQ,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC;YACrC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;gBAClC,QAAQ,CAAC,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;YACxC,CAAC,CAAC,CAAC;YAEH,OAAO,MAAM,IAAI,CAAC,WAAW,CACzB,MAAM,EACN,GAAG,IAAI,CAAC,UAAU,IAAI,SAAS,OAAO,EACtC,QAAQ,EACR,KAAK,EACL,iBAAiB,CAAC,wBAAwB,CAAC,QAAQ,CAAC,CACvD,CAAC;QACN,CAAC;KAAA;IAEK,wBAAwB,CAC1B,SAAiB,EACjB,MAAuC;;YAEvC,OAAO,MAAM,IAAI,CAAC,WAAW,CACzB,KAAK,EACL,GAAG,IAAI,CAAC,UAAU,IAAI,SAAS,aAAa,EAC5C,MAAM,CAAC,MAAM,EAAE,CAClB,CAAC;QACN,CAAC;KAAA;IAED,MAAM,CAAC,wBAAwB,CAAC,IAAc;QAC1C,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QAElC,OAAO,CAAC,cAAc,CAAC,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;QAElD,OAAO,OAAO,CAAC,cAAc,CAAC,CAAC;QAC/B,OAAO,OAAO,CAAC;IACnB,CAAC;CACJ;AAtGD,8CAsGC"}

package/built/api/files/params/recently-uploaded-files.d.ts

@@ -0,0 +1,6 @@
+import { BaseParameters } from "../../parameters/index";
+export declare class RecentlyUploadedFilesParameters extends BaseParameters {
+    setUriMask(uriMask: string): RecentlyUploadedFilesParameters;
+    setLimit(limit: number): RecentlyUploadedFilesParameters;
+    setOffset(offset: number): RecentlyUploadedFilesParameters;
+}

package/built/api/files/params/recently-uploaded-files.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RecentlyUploadedFilesParameters = void 0;
+const exception_1 = require("../../exception");
+const index_1 = require("../../parameters/index");
+class RecentlyUploadedFilesParameters extends index_1.BaseParameters {
+    setUriMask(uriMask) {
+        this.set("uriMask", uriMask);
+        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");
+    }
+}
+exports.RecentlyUploadedFilesParameters = RecentlyUploadedFilesParameters;
+//# sourceMappingURL=recently-uploaded-files.js.map

package/built/api/files/params/recently-uploaded-files.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"recently-uploaded-files.js","sourceRoot":"","sources":["../../../../api/files/params/recently-uploaded-files.ts"],"names":[],"mappings":";;;AAAA,+CAAqD;AACrD,kDAAwD;AAExD,MAAa,+BAAgC,SAAQ,sBAAc;IAC/D,UAAU,CAAC,OAAe;QACtB,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;QAE7B,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;CACJ;AA1BD,0EA0BC"}

package/built/package.json

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

package/package.json

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

package/test/files.spec.ts

@@ -10,6 +10,7 @@ import { SmartlingAuthApi } from "../api/auth/index";
 import { FileType } from "../api/files/params/file-type";
 import { streamToString } from "./stream-to-string";
 import { DownloadFileAllTranslationsParameters } from "../api/files/params/download-file-all-translations-parameters";
+import { RecentlyUploadedFilesParameters } from "../api/files/params/recently-uploaded-files";
 
 describe("SmartlingFilesApi class tests.", () => {
     const projectId = "testProjectId";
@@ -58,12 +59,17 @@ describe("SmartlingFilesApi class tests.", () => {
         });
 
         it("Get recently uploaded files for project", async () => {
-            await filesApi.getRecentlyUploadedFiles(projectId);
+            const params = new RecentlyUploadedFilesParameters()
+                .setOffset(0)
+                .setLimit(99)
+                .setUriMask("TEST");
+
+            await filesApi.getRecentlyUploadedFiles(projectId, params);
 
             sinon.assert.calledOnce(filesApiFetchStub);
             sinon.assert.calledWithExactly(
                 filesApiFetchStub,
-                `https://test.com/files-api/v2/projects/${projectId}/files/list`,
+                `https://test.com/files-api/v2/projects/${projectId}/files/list?offset=0&limit=99&uriMask=TEST`,
                 {
                     headers: {
                         Authorization: "test_token_type test_access_token",