Fix type declaration (#248)

* Fix type declaration

* Fixes

* Move types to global

* Fix tsconfig files

* Fix tests

Author: mmarkelov

src/PlaywrightEnvironment.ts

@@ -10,9 +10,9 @@ import type {
   JestPlaywrightConfig,
   GenericBrowser,
   BrowserType,
-  JestPlaywrightJestConfig,
+  JestPlaywrightProjectConfig,
   ConnectOptions,
-} from './types'
+} from '../types/global'
 import {
   CHROMIUM,
   IMPORT_KIND_PLAYWRIGHT,
@@ -82,10 +82,10 @@ export const getPlaywrightEnv = (basicEnv = 'node'): unknown => {
     : 'jest-environment-jsdom')
 
   return class PlaywrightEnvironment extends RootEnv {
-    readonly _config: JestPlaywrightJestConfig
+    readonly _config: JestPlaywrightProjectConfig
     _jestPlaywrightConfig!: JestPlaywrightConfig
 
-    constructor(config: JestPlaywrightJestConfig) {
+    constructor(config: JestPlaywrightProjectConfig) {
       super(config)
       this._config = config
     }

src/PlaywrightRunner.ts

@@ -16,7 +16,7 @@ import type {
   WsEndpointType,
   JestPlaywrightTest,
   JestPlaywrightConfig,
-} from './types'
+} from '../types/global'
 import {
   checkBrowserEnv,
   checkDeviceEnv,

src/constants.ts

@@ -1,4 +1,4 @@
-import type { JestPlaywrightConfig, ConnectOptions } from './types'
+import type { JestPlaywrightConfig, ConnectOptions } from '../types/global'
 
 export const IMPORT_KIND_PLAYWRIGHT = 'playwright'
 

src/types.d.ts

@@ -2,7 +2,7 @@ import fs from 'fs'
 import path from 'path'
 import * as Utils from './utils'
 import { DEFAULT_CONFIG, CHROMIUM, FIREFOX } from './constants'
-import type { BrowserType } from './types'
+import type { BrowserType } from '../types/global'
 
 const {
   readConfig,

src/utils.test.ts

@@ -8,7 +8,7 @@ import type {
   PlaywrightRequireType,
   SkipOption,
   Options,
-} from './types'
+} from '../types/global'
 import {
   CHROMIUM,
   DEFAULT_CONFIG,

src/utils.ts

@@ -1,24 +1,42 @@
 import {
-  Page,
   Browser,
   BrowserContext,
+  Page,
+  BrowserContextOptions,
+  LaunchOptions,
   BrowserType as PlaywrightBrowserType,
   ChromiumBrowser,
   FirefoxBrowser,
   WebKitBrowser,
+  devices,
 } from 'playwright-core'
+import { Config as JestConfig } from '@jest/types'
+import { Context } from 'jest-runner/build/types'
+import { Test } from 'jest-runner'
+import { JestProcessManagerOptions } from 'jest-process-manager'
 
-type BrowserType = 'chromium' | 'firefox' | 'webkit'
+// TODO Find out flexable ways to reuse constants
+declare const IMPORT_KIND_PLAYWRIGHT = 'playwright'
 
-type GenericBrowser = PlaywrightBrowserType<
-  WebKitBrowser | ChromiumBrowser | FirefoxBrowser
->
+declare const CHROMIUM = 'chromium'
+declare const FIREFOX = 'firefox'
+declare const WEBKIT = 'webkit'
 
-type SkipOption = {
+declare const LAUNCH = 'LAUNCH'
+declare const PERSISTENT = 'PERSISTENT'
+declare const SERVER = 'SERVER'
+
+export type BrowserType = typeof CHROMIUM | typeof FIREFOX | typeof WEBKIT
+
+export type SkipOption = {
   browsers: BrowserType[]
   devices?: string[] | RegExp
 }
 
+export type GenericBrowser = PlaywrightBrowserType<
+  WebKitBrowser | ChromiumBrowser | FirefoxBrowser
+>
+
 type ContextOptions = Parameters<GenericBrowser['connect']>[0]
 
 interface JestPlaywright {
@@ -83,16 +101,15 @@ interface JestParams<T> {
   (options: T, name: string, fn?: jest.ProvidesCallback, timeout?: number): void
 }
 
-// TODO Replace any
-interface JestPlaywrightDebug extends JestParams<any> {
+interface JestPlaywrightTestDebug extends JestParams<JestPlaywrightConfig> {
   (name: string, fn?: jest.ProvidesCallback, timeout?: number): void
-  skip: JestParams<any> | JestPlaywrightDebug
-  only: JestParams<any> | JestPlaywrightDebug
+  skip: JestParams<JestPlaywrightConfig> | JestPlaywrightTestDebug
+  only: JestParams<JestPlaywrightConfig> | JestPlaywrightTestDebug
 }
 
-interface JestPlaywrightConfig extends JestParams<any> {
-  skip: JestParams<any> | JestPlaywrightConfig
-  only: JestParams<any> | JestPlaywrightConfig
+interface JestPlaywrightTestConfig extends JestParams<JestPlaywrightConfig> {
+  skip: JestParams<JestPlaywrightConfig> | JestPlaywrightTestConfig
+  only: JestParams<JestPlaywrightConfig> | JestPlaywrightTestConfig
 }
 
 declare global {
@@ -105,8 +122,63 @@ declare global {
   namespace jest {
     interface It {
       jestPlaywrightSkip: JestParams<SkipOption>
-      jestPlaywrightDebug: JestPlaywrightDebug
-      jestPlaywrightConfig: JestPlaywrightConfig
+      jestPlaywrightDebug: JestPlaywrightTestDebug
+      jestPlaywrightConfig: JestPlaywrightTestConfig
     }
   }
 }
+
+export type CustomDeviceType = BrowserContextOptions & {
+  name: string
+}
+
+export type DeviceType = CustomDeviceType | string | null
+
+export type WsEndpointType = string | null
+
+export type SelectorType = {
+  script: string | Function | { path?: string; content?: string }
+  name: string
+}
+
+export type PlaywrightRequireType = BrowserType | typeof IMPORT_KIND_PLAYWRIGHT
+
+export interface Playwright {
+  name: PlaywrightRequireType
+  instance: GenericBrowser
+  devices: typeof devices
+}
+
+type LaunchType = typeof LAUNCH | typeof SERVER | typeof PERSISTENT
+
+type Options<T> = T & Partial<Record<BrowserType, T>>
+
+export type ConnectOptions = Parameters<GenericBrowser['connect']>[0]
+
+export interface JestPlaywrightConfig {
+  launchType?: LaunchType
+  launchOptions?: Options<LaunchOptions>
+  connectOptions?: Options<ConnectOptions>
+  contextOptions?: Options<BrowserContextOptions>
+  userDataDir?: string
+  exitOnPageError: boolean
+  browsers: BrowserType[]
+  devices?: (string | CustomDeviceType)[] | RegExp
+  serverOptions?: JestProcessManagerOptions
+  selectors?: SelectorType[]
+  collectCoverage: boolean
+}
+
+export interface JestPlaywrightProjectConfig extends JestConfig.ProjectConfig {
+  browserName: BrowserType
+  wsEndpoint: WsEndpointType
+  device: DeviceType
+}
+
+interface JestPlaywrightContext extends Context {
+  config: JestPlaywrightProjectConfig
+}
+
+export interface JestPlaywrightTest extends Test {
+  context: JestPlaywrightContext
+}