[EDT-1765] SnapshotSettings introduced

packages/sdk/src/controllers/PageController.ts

@@ -1,6 +1,6 @@
 import { EditorAPI, EditorRawAPI, EditorResponse, Id } from '../types/CommonTypes';
 import { getEditorResponseData } from '../utils/EditorResponseData';
-import { Page } from '../types/PageTypes';
+import { Page, SnapshotSettings } from '../types/PageTypes';
 import { CallSender } from 'penpal';
 
 /**
@@ -101,13 +101,31 @@ export class PageController {
     };
 
     /**
+     * @deprecated Use 'getSnapshotWithSettings' instead
      * This method returns a UInt8Array containing a PNG encoded image of the page.
-     * @param pageId the id of a specific page
+     * @param pageId The id of a specific page.
+     * If not specified, selected page snapshot will be provided
+     * @returns UInt8Array snapshot of the given page
+     */
+    getSnapshot = async (pageId?: Id) => {
+        const res = await this.#blobAPI;
+        return res
+            .getPageSnapshotWithSettings(pageId, null)
+            .then((result) => (result as Uint8Array) ?? (result as EditorResponse<null>));
+    };
+
+    /**
+     * This method returns a UInt8Array containing a PNG encoded image of the page.
+     * @param pageId The id of a specific page.
+     * If not specified, selected page snapshot will be provided
+     * @param settings an object to specify desired snapshot properties, e.g., resolution
      * @returns UInt8Array snapshot of the given page
      */
-    getSnapshot = async (pageId: Id) => {
+    getSnapshotWithSettings = async (pageId?: Id, settings?: SnapshotSettings) => {
         const res = await this.#blobAPI;
-        return res.getPageSnapshot(pageId).then((result) => (result as Uint8Array) ?? (result as EditorResponse<null>));
+        return res
+            .getPageSnapshotWithSettings(pageId, JSON.stringify(settings))
+            .then((result) => (result as Uint8Array) ?? (result as EditorResponse<null>));
     };
 
     /**

packages/sdk/src/tests/controllers/PageController.test.ts

@@ -1,6 +1,7 @@
 import { EditorAPI } from '../../types/CommonTypes';
 import { PageController } from '../../controllers/PageController';
 import { castToEditorResponse, getEditorResponseData } from '../../utils/EditorResponseData';
+import { SnapshotSettings } from '../../types/PageTypes';
 
 let mockedPageController: PageController;
 
@@ -12,7 +13,8 @@ const mockEditorApi: EditorAPI = {
     addPage: async () => getEditorResponseData(castToEditorResponse('frameID')),
     removePage: async (id: unknown) => getEditorResponseData(castToEditorResponse(id)),
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
-    getPageSnapshot: async (id: unknown) => getEditorResponseData(castToEditorResponse([1])),
+    getPageSnapshot: async () => getEditorResponseData(castToEditorResponse([1])),
+    getPageSnapshotWithSettings: async () => getEditorResponseData(castToEditorResponse([1])),
     selectPage: async (id: unknown) => getEditorResponseData(castToEditorResponse(id)),
     duplicatePage: async (id: unknown) => getEditorResponseData(castToEditorResponse(id)),
     setPageIsVisible: async (id: unknown, isVisible: unknown) =>
@@ -29,6 +31,7 @@ beforeEach(() => {
     jest.spyOn(mockEditorApi, 'addPage');
     jest.spyOn(mockEditorApi, 'removePage');
     jest.spyOn(mockEditorApi, 'getPageSnapshot');
+    jest.spyOn(mockEditorApi, 'getPageSnapshotWithSettings');
     jest.spyOn(mockEditorApi, 'selectPage');
     jest.spyOn(mockEditorApi, 'setPageIsVisible');
     jest.spyOn(mockEditorApi, 'duplicatePage');
@@ -83,11 +86,20 @@ describe('PageController', () => {
         expect(mockEditorApi.setPageHeight).toHaveBeenCalledWith('id', '4');
     });
 
-    it('Should call the getSnapshot method', async () => {
+    it('Should call the getSnapshotWithSettings method', async () => {
+        const settings = { largestAxisSize: 5 } as SnapshotSettings;
+
+        await mockedPageController.getSnapshotWithSettings('1', settings);
+        expect(mockEditorApi.getPageSnapshotWithSettings).toHaveBeenCalledTimes(1);
+        expect(mockEditorApi.getPageSnapshotWithSettings).toHaveBeenCalledWith('1', JSON.stringify(settings));
+    });
+
+    it('getSnapshot should call the getSnapshotWithSettings method', async () => {
         await mockedPageController.getSnapshot('1');
-        expect(mockEditorApi.getPageSnapshot).toHaveBeenCalledTimes(1);
-        expect(mockEditorApi.getPageSnapshot).toHaveBeenCalledWith('1');
+        expect(mockEditorApi.getPageSnapshotWithSettings).toHaveBeenCalledTimes(2);
+        expect(mockEditorApi.getPageSnapshotWithSettings).toHaveBeenCalledWith('1', null);
     });
+
     it('Should accept calculations for the pageHeight and pageWidth methods', async () => {
         await mockedPageController.setHeight('id', '4+2');
         expect(mockEditorApi.setPageHeight).toHaveBeenCalledTimes(2);

packages/sdk/src/types/PageTypes.ts

@@ -13,3 +13,7 @@ export type PageSize = {
     width: number;
     height: number;
 };
+
+export interface SnapshotSettings {
+    largestAxisSize?: number | null;
+}