update to latest src

Author: kb-kerem

Diff for: visual-js/visual/src/selective-region.ts

@@ -0,0 +1,55 @@
+import {
+  DiffingOption,
+  DiffingOptionsIn,
+  RegionIn,
+} from './graphql/__generated__/graphql';
+
+export type SelectiveRegionOptions =
+  | { enableOnly: Array<keyof DiffingOptionsIn>; disableOnly?: never }
+  | { enableOnly?: never; disableOnly: Array<keyof DiffingOptionsIn> };
+
+export type SelectiveRegion = Omit<RegionIn, 'diffingOptions'> &
+  SelectiveRegionOptions;
+
+export function selectiveRegionOptionsToDiffingOptions(
+  opt: SelectiveRegionOptions,
+): DiffingOptionsIn {
+  if ('enableOnly' in opt && opt.enableOnly) {
+    const diffingOptions: DiffingOptionsIn = {
+      content: false,
+      dimensions: false,
+      position: false,
+      structure: false,
+      style: false,
+      visual: false,
+    };
+    for (const key of opt.enableOnly) diffingOptions[key] = true;
+    return diffingOptions;
+  } else {
+    const diffingOptions: DiffingOptionsIn = {
+      content: true,
+      dimensions: true,
+      position: true,
+      structure: true,
+      style: true,
+      visual: true,
+    };
+    for (const key of opt.disableOnly) diffingOptions[key] = false;
+    return diffingOptions;
+  }
+}
+
+export function selectiveRegionToRegionIn(
+  input: SelectiveRegion[],
+): Array<RegionIn> {
+  return input.map((opt) => {
+    const { x, y, width, height } = opt;
+    return {
+      x,
+      y,
+      width,
+      height,
+      diffingOptions: selectiveRegionOptionsToDiffingOptions(opt),
+    };
+  });
+}

Diff for: visual-js/visual/src/types.ts

@@ -0,0 +1,33 @@
+export type FullPageScreenshotOptions =
+  | boolean
+  | {
+      /**
+       * Adjust address bar padding on iOS and Android for viewport cutout.
+       */
+      addressBarShadowPadding?: number;
+      /**
+       * Delay in ms after scrolling and before taking screenshots.
+       * A slight delay can be helpful if the page is using lazy loading when scrolling
+       */
+      delayAfterScrollMs?: number;
+      /**
+       * Disable CSS animations and the input caret in the app.
+       */
+      disableCSSAnimation?: boolean;
+      /**
+       * Hide elements on the page after first scroll by css selectors.
+       */
+      hideAfterFirstScroll?: string[];
+      /**
+       * Hide all scrollbars in the app.
+       */
+      hideScrollBars?: boolean;
+      /**
+       * Adjust toolbar padding on iOS and Android for viewport cutout.
+       */
+      toolBarShadowPadding?: number;
+      /**
+       * Limit the number of screenshots taken for scrolling and stitching.
+       */
+      scrollLimit?: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10;
+    };

Diff for: visual-js/visual/src/utils.spec.ts

@@ -0,0 +1,79 @@
+import { describe, expect, test } from '@jest/globals';
+import { getFullPageConfig } from './utils';
+import { FullPageConfigIn } from './graphql/__generated__/graphql';
+
+const configDelay: FullPageConfigIn = {
+  delayAfterScrollMs: 1500,
+};
+
+const configDelayBig: FullPageConfigIn = {
+  delayAfterScrollMs: 5000,
+};
+
+describe('utils', () => {
+  describe('getFullPageConfig', () => {
+    describe('returns undefined', () => {
+      test('when main is true and local is false', () => {
+        expect(getFullPageConfig(true, false)).toBeUndefined();
+      });
+      test('when main is false and local is false', () => {
+        expect(getFullPageConfig(false, false)).toBeUndefined();
+      });
+      test('when main is false and local is false', () => {
+        expect(getFullPageConfig(false, false)).toBeUndefined();
+      });
+      test('when main is object and local is false', () => {
+        expect(getFullPageConfig(configDelay, false)).toBeUndefined();
+      });
+      test('when main is undefined and local is false', () => {
+        expect(getFullPageConfig(undefined, false)).toBeUndefined();
+      });
+      test('when main is undefined and local is undefined', () => {
+        expect(getFullPageConfig(undefined, undefined)).toBeUndefined();
+      });
+      test('when main is false and local is undefined', () => {
+        expect(getFullPageConfig(false, undefined)).toBeUndefined();
+      });
+    });
+    describe('returns empty config', () => {
+      test('when main is true and local is true', () => {
+        expect(getFullPageConfig(true, undefined)).toEqual({});
+      });
+      test('when main is false and local is true', () => {
+        expect(getFullPageConfig(true, undefined)).toEqual({});
+      });
+      test('when main is undefined and local is true', () => {
+        expect(getFullPageConfig(true, undefined)).toEqual({});
+      });
+      test('when main is true and local is undefined', () => {
+        expect(getFullPageConfig(true, undefined)).toEqual({});
+      });
+    });
+    describe('returns config', () => {
+      test('when main is config and local is true', () => {
+        expect(getFullPageConfig(configDelay, true)).toEqual(configDelay);
+      });
+      test('when main is true and local is config', () => {
+        expect(getFullPageConfig(true, configDelay)).toEqual(configDelay);
+      });
+      test('when main is false and local is config', () => {
+        expect(getFullPageConfig(true, configDelay)).toEqual(configDelay);
+      });
+      test('when main is config and local is config', () => {
+        expect(getFullPageConfig(configDelay, configDelay)).toEqual(
+          configDelay,
+        );
+      });
+      test('and local overwrites main config', () => {
+        expect(getFullPageConfig(configDelay, configDelayBig)).toEqual(
+          configDelayBig,
+        );
+      });
+      test('with merged local and main config', () => {
+        const main = { delayAfterScrollMs: 500 };
+        const local = { disableCSSAnimation: false };
+        expect(getFullPageConfig(main, local)).toEqual({ ...main, ...local });
+      });
+    });
+  });
+});