Don't fail on non jsdom envs

Author: trurl-master

package.json

@@ -1,6 +1,6 @@
 {
   "name": "jsdom-testing-mocks",
-  "version": "1.9.0",
+  "version": "1.10.0-beta.0",
   "author": "Ivan Galiatin",
   "license": "MIT",
   "description": "A set of tools for emulating browser behavior in jsdom environment",

src/helper.ts

@@ -4,11 +4,23 @@ export class UndefinedHookError extends Error {
 
     // @ts-ignore
     if (typeof global?.['vi'] !== 'undefined') {
-      message = `Jsdom Testing Mocks: ${hook} is not defined. You can enable globals in your config or pass the hook manually to the configMocks function`;
+      message = `jsdom-testing-mocks: ${hook} is not defined. You can enable globals in your config or pass the hook manually to the configMocks function`;
     } else {
-      message = `Jsdom Testing Mocks: ${hook} is not defined. If you need to pass it manually, please use the configMocks function`;
+      message = `jsdom-testing-mocks: ${hook} is not defined. If you need to pass it manually, please use the configMocks function`;
     }
 
     super(message);
   }
 }
+
+export class WrongEnvironmentError extends Error {
+  constructor() {
+    super(
+      'jsdom-testing-mocks: window is not defined. Please use this library in a browser environment'
+    );
+  }
+}
+
+export const isJsdomEnv = () => {
+  return typeof window !== 'undefined';
+};

src/mocks/MediaQueryListEvent.ts

@@ -1,7 +1,6 @@
-export class MockedMediaQueryListEvent
-  extends Event
-  implements MediaQueryListEvent
-{
+import { isJsdomEnv, WrongEnvironmentError } from '../helper';
+
+class MockedMediaQueryListEvent extends Event implements MediaQueryListEvent {
   readonly matches: boolean;
   readonly media: string;
 
@@ -13,10 +12,18 @@ export class MockedMediaQueryListEvent
   }
 }
 
-if (typeof MediaQueryListEvent === 'undefined') {
-  Object.defineProperty(window, 'MediaQueryListEvent', {
-    writable: true,
-    configurable: true,
-    value: MockedMediaQueryListEvent,
-  });
+function mockMediaQueryListEvent() {
+  if (!isJsdomEnv()) {
+    throw new WrongEnvironmentError();
+  }
+
+  if (typeof MediaQueryListEvent === 'undefined') {
+    Object.defineProperty(window, 'MediaQueryListEvent', {
+      writable: true,
+      configurable: true,
+      value: MockedMediaQueryListEvent,
+    });
+  }
 }
+
+export { MockedMediaQueryListEvent, mockMediaQueryListEvent };

src/mocks/intersection-observer.env.test.ts

@@ -0,0 +1,14 @@
+/**
+ * @jest-environment node
+ */
+
+import { WrongEnvironmentError } from '../helper';
+import { mockIntersectionObserver } from './intersection-observer';
+
+describe('mockIntersectionObserver', () => {
+  it('throws an error when used in a non jsdom environment', () => {
+    expect(() => {
+      mockIntersectionObserver();
+    }).toThrowError(WrongEnvironmentError);
+  });
+});

src/mocks/intersection-observer.ts

@@ -1,6 +1,7 @@
 import { Writable, PartialDeep } from 'type-fest';
-import './size/DOMRect';
+import { mockDOMRect } from './size/DOMRect';
 import { getConfig } from '../tools';
+import { isJsdomEnv, WrongEnvironmentError } from '../helper';
 
 const config = getConfig();
 
@@ -192,6 +193,12 @@ export class MockedIntersectionObserver implements IntersectionObserver {
 }
 
 function mockIntersectionObserver() {
+  if (!isJsdomEnv()) {
+    throw new WrongEnvironmentError();
+  }
+
+  mockDOMRect();
+
   const savedImplementation = window.IntersectionObserver;
 
   Object.defineProperty(window, 'IntersectionObserver', {

src/mocks/resize-observer.env.test.ts

@@ -0,0 +1,14 @@
+/**
+ * @jest-environment node
+ */
+
+import { WrongEnvironmentError } from '../helper';
+import { mockResizeObserver } from './resize-observer';
+
+describe('mockResizeObserver', () => {
+  it('throws an error when used in a non jsdom environment', () => {
+    expect(() => {
+      mockResizeObserver();
+    }).toThrowError(WrongEnvironmentError);
+  });
+});

src/mocks/resize-observer.ts

@@ -1,4 +1,6 @@
 import { RequireAtLeastOne } from 'type-fest';
+import { mockDOMRect } from './size/DOMRect';
+import { isJsdomEnv, WrongEnvironmentError } from '../helper';
 import { getConfig } from '../tools';
 
 const config = getConfig();
@@ -142,6 +144,12 @@ function elementToEntry(element: HTMLElement): ResizeObserverEntry | null {
 }
 
 function mockResizeObserver() {
+  if (!isJsdomEnv()) {
+    throw new WrongEnvironmentError();
+  }
+
+  mockDOMRect();
+
   const savedImplementation = window.ResizeObserver;
 
   Object.defineProperty(window, 'ResizeObserver', {
@@ -290,10 +298,4 @@ function mockResizeObserver() {
   };
 }
 
-const { mockElementSize } = mockResizeObserver();
-
-mockElementSize(document.body, {
-  contentBoxSize: [{ blockSize: 100, inlineSize: 100 }],
-});
-
 export { mockResizeObserver };

src/mocks/size/DOMRect.env.test.ts

@@ -0,0 +1,14 @@
+/**
+ * @jest-environment node
+ */
+
+import { WrongEnvironmentError } from '../../helper';
+import { mockDOMRect } from './DOMRect';
+
+describe('mockDOMRect', () => {
+  it('throws an error when used in a non jsdom environment', () => {
+    expect(() => {
+      mockDOMRect();
+    }).toThrowError(WrongEnvironmentError);
+  });
+});

src/mocks/size/DOMRect.test.ts

@@ -1,5 +1,7 @@
 /* eslint-disable @typescript-eslint/ban-ts-comment */
-import './DOMRect';
+import { mockDOMRect } from './DOMRect';
+
+mockDOMRect();
 
 describe('DOMRectReadOnly', () => {
   test('constructor and props', () => {

src/mocks/size/DOMRect.ts

@@ -1,3 +1,5 @@
+import { isJsdomEnv, WrongEnvironmentError } from '../../helper';
+
 const protectedProps = ['_x', '_y', '_width', '_height'];
 
 class MockedDOMRectReadOnly implements DOMRectReadOnly {
@@ -107,7 +109,7 @@ class MockedDOMRectReadOnly implements DOMRectReadOnly {
   }
 }
 
-export class MockedDOMRect extends MockedDOMRectReadOnly implements DOMRect {
+class MockedDOMRect extends MockedDOMRectReadOnly implements DOMRect {
   constructor(x = 0, y = 0, width = 0, height = 0) {
     super(x, y, width, height);
   }
@@ -149,18 +151,26 @@ export class MockedDOMRect extends MockedDOMRectReadOnly implements DOMRect {
   }
 }
 
-if (typeof DOMRectReadOnly === 'undefined') {
-  Object.defineProperty(window, 'DOMRectReadOnly', {
-    writable: true,
-    configurable: true,
-    value: MockedDOMRectReadOnly,
-  });
-}
+function mockDOMRect() {
+  if (!isJsdomEnv()) {
+    throw new WrongEnvironmentError();
+  }
 
-if (typeof DOMRect === 'undefined') {
-  Object.defineProperty(window, 'DOMRect', {
-    writable: true,
-    configurable: true,
-    value: MockedDOMRect,
-  });
+  if (typeof DOMRectReadOnly === 'undefined') {
+    Object.defineProperty(window, 'DOMRectReadOnly', {
+      writable: true,
+      configurable: true,
+      value: MockedDOMRectReadOnly,
+    });
+  }
+
+  if (typeof DOMRect === 'undefined') {
+    Object.defineProperty(window, 'DOMRect', {
+      writable: true,
+      configurable: true,
+      value: MockedDOMRect,
+    });
+  }
 }
+
+export { MockedDOMRectReadOnly, MockedDOMRect, mockDOMRect };