fix(screenshots): align API params and tag response type (#669)

Author: andrii-bodnar

src/screenshots/index.ts

@@ -37,6 +37,7 @@ export class Screenshots extends CrowdinApi {
             options = { limit: options, offset: deprecatedOffset };
         }
         let url = `${this.url}/projects/${projectId}/screenshots`;
+        url = this.addQueryParam(url, 'search', options.search);
         url = this.addQueryParam(url, 'stringIds', options.stringIds?.join(','));
         url = this.addQueryParam(url, 'stringId', options.stringId);
         url = this.addQueryParam(url, 'labelIds', options.labelIds);
@@ -220,14 +221,15 @@ export class Screenshots extends CrowdinApi {
         screenshotId: number,
         tagId: number,
         request: PatchRequest[],
-    ): Promise<ResponseObject<ScreenshotsModel.Screenshot>> {
+    ): Promise<ResponseObject<ScreenshotsModel.Tag>> {
         const url = `${this.url}/projects/${projectId}/screenshots/${screenshotId}/tags/${tagId}`;
         return this.patch(url, request, this.defaultConfig());
     }
 }
 
 export namespace ScreenshotsModel {
     export interface ListScreenshotParams extends PaginationOptions {
+        search?: string;
         stringIds?: number[];
         /**
          * @deprecated use stringIds instead
@@ -266,6 +268,7 @@ export namespace ScreenshotsModel {
     export interface UpdateScreenshotRequest {
         storageId: number;
         name: string;
+        usePreviousTags?: boolean;
     }
 
     export interface Tag {

tests/screenshots/api.test.ts

@@ -72,6 +72,7 @@ describe('Screenshots API', () => {
                 {
                     storageId: storageId,
                     name: screenshotName,
+                    usePreviousTags: true,
                 },
                 {
                     reqheaders: {
@@ -204,7 +205,7 @@ describe('Screenshots API', () => {
             )
             .reply(200, {
                 data: {
-                    id: screenshotId,
+                    id: tagId,
                 },
             });
     });
@@ -221,6 +222,36 @@ describe('Screenshots API', () => {
         expect(screenshots.pagination.limit).toBe(limit);
     });
 
+    it('List screenshots with search filter', async () => {
+        const listWithSearchScope = nock(api.url, {
+            reqheaders: {
+                Authorization: `Bearer ${api.token}`,
+            },
+        })
+            .get(`/projects/${projectId}/screenshots`)
+            .query({
+                search: screenshotName,
+            })
+            .reply(200, {
+                data: [
+                    {
+                        data: {
+                            id: screenshotId,
+                            name: screenshotName,
+                        },
+                    },
+                ],
+                pagination: {
+                    offset: 0,
+                    limit: limit,
+                },
+            });
+        const screenshots = await api.listScreenshots(projectId, { search: screenshotName });
+        expect(screenshots.data.length).toBe(1);
+        expect(screenshots.data[0].data.id).toBe(screenshotId);
+        listWithSearchScope.done();
+    });
+
     it('Add screenshot', async () => {
         const screenshot = await api.addScreenshot(projectId, {
             name: screenshotName,
@@ -240,6 +271,7 @@ describe('Screenshots API', () => {
         const screenshot = await api.updateScreenshot(projectId, screenshotId, {
             storageId: storageId,
             name: screenshotName,
+            usePreviousTags: true,
         });
         expect(screenshot.data.id).toBe(screenshotId);
         expect(screenshot.data.name).toBe(screenshotName);
@@ -309,6 +341,6 @@ describe('Screenshots API', () => {
                 value: stringId,
             },
         ]);
-        expect(tag.data.id).toBe(screenshotId);
+        expect(tag.data.id).toBe(tagId);
     });
 });