🤖 Merge PR #46845 [jest-environment-puppeteer] Allow jest 26 and exte…

…nd from jest-environment-node by @danez The source code of the jest-environment-puppeteer also extends jest-environment-node, so it makes sense that the types do the same
DefinitelyTyped · Sep 28, 2020 · f477068 · f477068
1 parent f9deaf3
commit f477068
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 37 deletions.
diff --git a/types/jest-environment-puppeteer/index.d.ts b/types/jest-environment-puppeteer/index.d.ts
@@ -1,16 +1,14 @@
-// Type definitions for jest-environment-puppeteer 4.3
+// Type definitions for jest-environment-puppeteer 4.4
 // Project: https://github.com/smooth-code/jest-puppeteer/tree/master/packages/jest-environment-puppeteer
 // Definitions by: Josh Goldberg <https://github.com/joshuakgoldberg>
 //                 Ifiok Jr. <https://github.com/ifiokjr>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
-// TypeScript Version: 3.4
+// TypeScript Version: 3.8
 
-import { JestEnvironment } from '@jest/environment';
-import { JestFakeTimers as FakeTimers } from '@jest/fake-timers';
-import { Circus, Global as GlobalType, Config } from '@jest/types';
-import { ModuleMocker } from 'jest-mock';
+import NodeEnvironment = require('jest-environment-node');
+import { Global as GlobalType } from '@jest/types';
 import { Browser, Page, BrowserContext } from 'puppeteer';
-import { Script, Context } from 'vm';
+import { Context } from 'vm';
 
 interface JestPuppeteer {
     /**
@@ -49,12 +47,6 @@ interface JestPuppeteer {
     debug(): Promise<void>;
 }
 
-interface Timer {
-    id: number;
-    ref: () => Timer;
-    unref: () => Timer;
-}
-
 interface Global extends GlobalType.Global {
     browser: Browser;
     context: Context;
@@ -63,26 +55,8 @@ interface Global extends GlobalType.Global {
 }
 
 /** Note: TestEnvironment is sandboxed. Each test suite will trigger setup/teardown in their own TestEnvironment. */
-declare class PuppeteerEnvironment implements JestEnvironment {
-  context: Context | null;
-  fakeTimers: FakeTimers<Timer> | null;
+declare class PuppeteerEnvironment extends NodeEnvironment {
   global: Global;
-  moduleMocker: ModuleMocker | null;
-  constructor(config: Config.ProjectConfig);
-
-  /**
-   * Setup runs when the environment is being spun up, generally before each test suite
-   * You should always call `await super.setup()` in here
-   */
-  setup(): Promise<void>;
-
-  /**
-   * Teardowns runs as the environment is being torn down, generally after each test suite.
-   * You should always call `await super.tearDown()` in here
-   */
-  teardown(): Promise<void>;
-  runScript(script: Script): any;
-  handleTestEvent?(event: Circus.Event, state: Circus.State): void;
 }
 
 declare global {

diff --git a/types/jest-environment-puppeteer/jest-environment-puppeteer-tests.ts b/types/jest-environment-puppeteer/jest-environment-puppeteer-tests.ts
@@ -26,7 +26,7 @@ class CustomJestEnvironment extends JestEnvironmentPuppeteer {
         await super.teardown();
     }
 
-    runScript(script: Script) {
+    runScript(script: Script): any {
         return super.runScript(script);
     }
 

diff --git a/types/jest-environment-puppeteer/package.json b/types/jest-environment-puppeteer/package.json
@@ -1,9 +1,7 @@
 {
     "private": true,
     "dependencies": {
-        "@jest/environment": "^24",
-        "@jest/fake-timers": "^24",
-        "@jest/types": "^24",
-        "jest-mock": "^24"
+        "@jest/types": ">=24 && <=26",
+        "jest-environment-node": ">=24 && <=26"
     }
 }