types: update types for webpack-dev-middleware@5

gatsbyjs · Sep 24, 2024 · a956da4 · a956da4
1 parent 7a350ee
commit a956da4
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 12 deletions.
diff --git a/packages/gatsby/src/services/start-webpack-server.ts b/packages/gatsby/src/services/start-webpack-server.ts
@@ -12,7 +12,7 @@ import {
 import { showExperimentNotices } from "../utils/show-experiment-notice"
 import { printInstructions } from "../utils/print-instructions"
 import { prepareUrls } from "../utils/prepare-urls"
-import { startServer, IWebpackWatchingPauseResume } from "../utils/start-server"
+import { startServer, WebpackWatching } from "../utils/start-server"
 import { WebsocketManager } from "../utils/websocket-manager"
 import { IBuildContext } from "./"
 import {
@@ -29,7 +29,7 @@ export async function startWebpackServer({
 }: Partial<IBuildContext>): Promise<{
   compiler: Compiler
   websocketManager: WebsocketManager
-  webpackWatching: IWebpackWatchingPauseResume
+  webpackWatching: WebpackWatching
 }> {
   if (!program || !app || !store) {
     report.panic(`Missing required params`)

diff --git a/packages/gatsby/src/services/types.ts b/packages/gatsby/src/services/types.ts
@@ -10,7 +10,7 @@ import type { GatsbyWorkerPool } from "../utils/worker/pool"
 import { Actor, AnyEventObject } from "xstate"
 import { Compiler } from "webpack"
 import { WebsocketManager } from "../utils/websocket-manager"
-import { IWebpackWatchingPauseResume } from "../utils/start-server"
+import { type WebpackWatching } from "../utils/start-server"
 
 type Reporter = typeof reporter
 
@@ -46,7 +46,7 @@ export interface IBuildContext {
   nodeMutationBatch?: Array<IMutationAction>
   compiler?: Compiler
   websocketManager?: WebsocketManager
-  webpackWatching?: IWebpackWatchingPauseResume
+  webpackWatching?: WebpackWatching
   webpackListener?: Actor<unknown, AnyEventObject>
   queryFilesDirty?: boolean
   sourceFilesDirty?: boolean

diff --git a/packages/gatsby/src/utils/start-server.ts b/packages/gatsby/src/utils/start-server.ts
@@ -1,5 +1,5 @@
 import webpackHotMiddleware from "@gatsbyjs/webpack-hot-middleware"
-import webpackDevMiddleware from "webpack-dev-middleware"
+import webpackDevMiddleware, { type Watching } from "webpack-dev-middleware"
 import got, { Method } from "got"
 import webpack, { Compilation } from "webpack"
 import express from "express"
@@ -54,18 +54,15 @@ import { isFileInsideCompilations } from "./webpack/utils/is-file-inside-compila
 
 type ActivityTracker = any // TODO: Replace this with proper type once reporter is typed
 
+export type WebpackWatching = NonNullable<Watching>
+
 interface IServer {
   compiler: webpack.Compiler
   listener: http.Server | https.Server
   webpackActivity: ActivityTracker
   websocketManager: WebsocketManager
   workerPool: WorkerPool.GatsbyWorkerPool
-  webpackWatching: IWebpackWatchingPauseResume
-}
-
-export interface IWebpackWatchingPauseResume {
-  suspend: () => void
-  resume: () => void
+  webpackWatching: WebpackWatching
 }
 
 export async function startServer(
@@ -895,6 +892,7 @@ export async function startServer(
     webpackActivity,
     websocketManager,
     workerPool,
-    webpackWatching: webpackDevMiddlewareInstance.context.watching,
+    webpackWatching: webpackDevMiddlewareInstance.context
+      .watching as WebpackWatching,
   }
 }