webpack-dev-server - npm Package Compare versions

Comparing version 5.0.1 to 5.0.2

package.json

 {
   "name": "webpack-dev-server",
-  "version": "5.0.1",
+  "version": "5.0.2",
   "description": "Serves a webpack app. Updates the browser on changes.",
@@ -5,0 +5,0 @@ "bin": "bin/webpack-dev-server.js",

types/lib/Server.d.ts

@@ -52,3 +52,3 @@ /// <reference types="node" />
           | {
-              type: string;
+              type: string /** @typedef {import("express").ErrorRequestHandler} ExpressErrorRequestHandler */;
               description: string;
@@ -60,3 +60,3 @@ link: string;
         description: string;
-        link: string /** @typedef {import("connect-history-api-fallback").Options} ConnectHistoryApiFallbackOptions */;
+        link: string;
       };
@@ -83,2 +83,148 @@ Client: {
                 };
+                /** @typedef {import("net").Socket} Socket */
+                /** @typedef {import("http").IncomingMessage} IncomingMessage */
+                /** @typedef {import("http").ServerResponse} ServerResponse */
+                /** @typedef {import("open").Options} OpenOptions */
+                /** @typedef {import("https").ServerOptions & { spdy?: { plain?: boolean | undefined, ssl?: boolean | undefined, 'x-forwarded-for'?: string | undefined, protocol?: string | undefined, protocols?: string[] | undefined }}} ServerOptions */
+                /** @typedef {import("express").Request} Request */
+                /** @typedef {import("express").Response} Response */
+                /**
+                 * @template {Request} T
+                 * @template {Response} U
+                 * @typedef {import("webpack-dev-middleware").Options<T, U>} DevMiddlewareOptions
+                 */
+                /**
+                 * @template {Request} T
+                 * @template {Response} U
+                 * @typedef {import("webpack-dev-middleware").Context<T, U>} DevMiddlewareContext
+                 */
+                /**
+                 * @typedef {"local-ip" | "local-ipv4" | "local-ipv6" | string} Host
+                 */
+                /**
+                 * @typedef {number | string | "auto"} Port
+                 */
+                /**
+                 * @typedef {Object} WatchFiles
+                 * @property {string | string[]} paths
+                 * @property {WatchOptions & { aggregateTimeout?: number, ignored?: WatchOptions["ignored"], poll?: number | boolean }} [options]
+                 */
+                /**
+                 * @typedef {Object} Static
+                 * @property {string} [directory]
+                 * @property {string | string[]} [publicPath]
+                 * @property {boolean | ServeIndexOptions} [serveIndex]
+                 * @property {ServeStaticOptions} [staticOptions]
+                 * @property {boolean | WatchOptions & { aggregateTimeout?: number, ignored?: WatchOptions["ignored"], poll?: number | boolean }} [watch]
+                 */
+                /**
+                 * @typedef {Object} NormalizedStatic
+                 * @property {string} directory
+                 * @property {string[]} publicPath
+                 * @property {false | ServeIndexOptions} serveIndex
+                 * @property {ServeStaticOptions} staticOptions
+                 * @property {false | WatchOptions} watch
+                 */
+                /**
+                 * @typedef {Object} ServerConfiguration
+                 * @property {"http" | "https" | "spdy" | string} [type]
+                 * @property {ServerOptions} [options]
+                 */
+                /**
+                 * @typedef {Object} WebSocketServerConfiguration
+                 * @property {"sockjs" | "ws" | string | Function} [type]
+                 * @property {Record<string, any>} [options]
+                 */
+                /**
+                 * @typedef {(import("ws").WebSocket | import("sockjs").Connection & { send: import("ws").WebSocket["send"], terminate: import("ws").WebSocket["terminate"], ping: import("ws").WebSocket["ping"] }) & { isAlive?: boolean }} ClientConnection
+                 */
+                /**
+                 * @typedef {import("ws").WebSocketServer | import("sockjs").Server & { close: import("ws").WebSocketServer["close"] }} WebSocketServer
+                 */
+                /**
+                 * @typedef {{ implementation: WebSocketServer, clients: ClientConnection[] }} WebSocketServerImplementation
+                 */
+                /**
+                 * @callback ByPass
+                 * @param {Request} req
+                 * @param {Response} res
+                 * @param {ProxyConfigArrayItem} proxyConfig
+                 */
+                /**
+                 * @typedef {{ path?: HttpProxyMiddlewareOptionsFilter | undefined, context?: HttpProxyMiddlewareOptionsFilter | undefined } & { bypass?: ByPass } & HttpProxyMiddlewareOptions } ProxyConfigArrayItem
+                 */
+                /**
+                 * @typedef {(ProxyConfigArrayItem | ((req?: Request | undefined, res?: Response | undefined, next?: NextFunction | undefined) => ProxyConfigArrayItem))[]} ProxyConfigArray
+                 */
+                /**
+                 * @typedef {{ [url: string]: string | ProxyConfigArrayItem }} ProxyConfigMap
+                 */
+                /**
+                 * @typedef {Object} OpenApp
+                 * @property {string} [name]
+                 * @property {string[]} [arguments]
+                 */
+                /**
+                 * @typedef {Object} Open
+                 * @property {string | string[] | OpenApp} [app]
+                 * @property {string | string[]} [target]
+                 */
+                /**
+                 * @typedef {Object} NormalizedOpen
+                 * @property {string} target
+                 * @property {import("open").Options} options
+                 */
+                /**
+                 * @typedef {Object} WebSocketURL
+                 * @property {string} [hostname]
+                 * @property {string} [password]
+                 * @property {string} [pathname]
+                 * @property {number | string} [port]
+                 * @property {string} [protocol]
+                 * @property {string} [username]
+                 */
+                /**
+                 * @typedef {boolean | ((error: Error) => void)} OverlayMessageOptions
+                 */
+                /**
+                 * @typedef {Object} ClientConfiguration
+                 * @property {"log" | "info" | "warn" | "error" | "none" | "verbose"} [logging]
+                 * @property {boolean  | { warnings?: OverlayMessageOptions, errors?: OverlayMessageOptions, runtimeErrors?: OverlayMessageOptions }} [overlay]
+                 * @property {boolean} [progress]
+                 * @property {boolean | number} [reconnect]
+                 * @property {"ws" | "sockjs" | string} [webSocketTransport]
+                 * @property {string | WebSocketURL} [webSocketURL]
+                 */
+                /**
+                 * @typedef {Array<{ key: string; value: string }> | Record<string, string | string[]>} Headers
+                 */
+                /**
+                 * @typedef {{ name?: string, path?: string, middleware: ExpressRequestHandler | ExpressErrorRequestHandler } | ExpressRequestHandler | ExpressErrorRequestHandler} Middleware
+                 */
+                /**
+                 * @typedef {Object} Configuration
+                 * @property {boolean | string} [ipc]
+                 * @property {Host} [host]
+                 * @property {Port} [port]
+                 * @property {boolean | "only"} [hot]
+                 * @property {boolean} [liveReload]
+                 * @property {DevMiddlewareOptions<Request, Response>} [devMiddleware]
+                 * @property {boolean} [compress]
+                 * @property {"auto" | "all" | string | string[]} [allowedHosts]
+                 * @property {boolean | ConnectHistoryApiFallbackOptions} [historyApiFallback]
+                 * @property {boolean | Record<string, never> | BonjourOptions} [bonjour]
+                 * @property {string | string[] | WatchFiles | Array<string | WatchFiles>} [watchFiles]
+                 * @property {boolean | string | Static | Array<string | Static>} [static]
+                 * @property {boolean | ServerOptions} [https]
+                 * @property {boolean} [http2]
+                 * @property {"http" | "https" | "spdy" | string | ServerConfiguration} [server]
+                 * @property {boolean | "sockjs" | "ws" | string | WebSocketServerConfiguration} [webSocketServer]
+                 * @property {ProxyConfigMap | ProxyConfigArrayItem | ProxyConfigArray} [proxy]
+                 * @property {boolean | string | Open | Array<string | Open>} [open]
+                 * @property {boolean} [setupExitSignals]
+                 * @property {boolean | ClientConfiguration} [client]
+                 * @property {Headers | ((req: Request, res: Response, context: DevMiddlewareContext<Request, Response>) => Headers)} [headers]
+                 * @property {(devServer: Server) => void} [onListening]
+                 * @property {(middlewares: Middleware[], devServer: Server) => Middleware[]} [setupMiddlewares]
+                 */
                 overlay: {
@@ -110,135 +256,2 @@ $ref: string;
       };
-      /**
-       * @template Request, Response
-       * @typedef {import("webpack-dev-middleware").Context<IncomingMessage, ServerResponse>} DevMiddlewareContext
-       */
-      /**
-       * @typedef {"local-ip" | "local-ipv4" | "local-ipv6" | string} Host
-       */
-      /**
-       * @typedef {number | string | "auto"} Port
-       */
-      /**
-       * @typedef {Object} WatchFiles
-       * @property {string | string[]} paths
-       * @property {WatchOptions & { aggregateTimeout?: number, ignored?: WatchOptions["ignored"], poll?: number | boolean }} [options]
-       */
-      /**
-       * @typedef {Object} Static
-       * @property {string} [directory]
-       * @property {string | string[]} [publicPath]
-       * @property {boolean | ServeIndexOptions} [serveIndex]
-       * @property {ServeStaticOptions} [staticOptions]
-       * @property {boolean | WatchOptions & { aggregateTimeout?: number, ignored?: WatchOptions["ignored"], poll?: number | boolean }} [watch]
-       */
-      /**
-       * @typedef {Object} NormalizedStatic
-       * @property {string} directory
-       * @property {string[]} publicPath
-       * @property {false | ServeIndexOptions} serveIndex
-       * @property {ServeStaticOptions} staticOptions
-       * @property {false | WatchOptions} watch
-       */
-      /**
-       * @typedef {Object} ServerConfiguration
-       * @property {"http" | "https" | "spdy" | string} [type]
-       * @property {ServerOptions} [options]
-       */
-      /**
-       * @typedef {Object} WebSocketServerConfiguration
-       * @property {"sockjs" | "ws" | string | Function} [type]
-       * @property {Record<string, any>} [options]
-       */
-      /**
-       * @typedef {(import("ws").WebSocket | import("sockjs").Connection & { send: import("ws").WebSocket["send"], terminate: import("ws").WebSocket["terminate"], ping: import("ws").WebSocket["ping"] }) & { isAlive?: boolean }} ClientConnection
-       */
-      /**
-       * @typedef {import("ws").WebSocketServer | import("sockjs").Server & { close: import("ws").WebSocketServer["close"] }} WebSocketServer
-       */
-      /**
-       * @typedef {{ implementation: WebSocketServer, clients: ClientConnection[] }} WebSocketServerImplementation
-       */
-      /**
-       * @callback ByPass
-       * @param {Request} req
-       * @param {Response} res
-       * @param {ProxyConfigArrayItem} proxyConfig
-       */
-      /**
-       * @typedef {{ path?: HttpProxyMiddlewareOptionsFilter | undefined, context?: HttpProxyMiddlewareOptionsFilter | undefined } & { bypass?: ByPass } & HttpProxyMiddlewareOptions } ProxyConfigArrayItem
-       */
-      /**
-       * @typedef {(ProxyConfigArrayItem | ((req?: Request | undefined, res?: Response | undefined, next?: NextFunction | undefined) => ProxyConfigArrayItem))[]} ProxyConfigArray
-       */
-      /**
-       * @typedef {{ [url: string]: string | ProxyConfigArrayItem }} ProxyConfigMap
-       */
-      /**
-       * @typedef {Object} OpenApp
-       * @property {string} [name]
-       * @property {string[]} [arguments]
-       */
-      /**
-       * @typedef {Object} Open
-       * @property {string | string[] | OpenApp} [app]
-       * @property {string | string[]} [target]
-       */
-      /**
-       * @typedef {Object} NormalizedOpen
-       * @property {string} target
-       * @property {import("open").Options} options
-       */
-      /**
-       * @typedef {Object} WebSocketURL
-       * @property {string} [hostname]
-       * @property {string} [password]
-       * @property {string} [pathname]
-       * @property {number | string} [port]
-       * @property {string} [protocol]
-       * @property {string} [username]
-       */
-      /**
-       * @typedef {boolean | ((error: Error) => void)} OverlayMessageOptions
-       */
-      /**
-       * @typedef {Object} ClientConfiguration
-       * @property {"log" | "info" | "warn" | "error" | "none" | "verbose"} [logging]
-       * @property {boolean  | { warnings?: OverlayMessageOptions, errors?: OverlayMessageOptions, runtimeErrors?: OverlayMessageOptions }} [overlay]
-       * @property {boolean} [progress]
-       * @property {boolean | number} [reconnect]
-       * @property {"ws" | "sockjs" | string} [webSocketTransport]
-       * @property {string | WebSocketURL} [webSocketURL]
-       */
-      /**
-       * @typedef {Array<{ key: string; value: string }> | Record<string, string | string[]>} Headers
-       */
-      /**
-       * @typedef {{ name?: string, path?: string, middleware: ExpressRequestHandler | ExpressErrorRequestHandler } | ExpressRequestHandler | ExpressErrorRequestHandler} Middleware
-       */
-      /**
-       * @typedef {Object} Configuration
-       * @property {boolean | string} [ipc]
-       * @property {Host} [host]
-       * @property {Port} [port]
-       * @property {boolean | "only"} [hot]
-       * @property {boolean} [liveReload]
-       * @property {DevMiddlewareOptions<Request, Response>} [devMiddleware]
-       * @property {boolean} [compress]
-       * @property {"auto" | "all" | string | string[]} [allowedHosts]
-       * @property {boolean | ConnectHistoryApiFallbackOptions} [historyApiFallback]
-       * @property {boolean | Record<string, never> | BonjourOptions} [bonjour]
-       * @property {string | string[] | WatchFiles | Array<string | WatchFiles>} [watchFiles]
-       * @property {boolean | string | Static | Array<string | Static>} [static]
-       * @property {boolean | ServerOptions} [https]
-       * @property {boolean} [http2]
-       * @property {"http" | "https" | "spdy" | string | ServerConfiguration} [server]
-       * @property {boolean | "sockjs" | "ws" | string | WebSocketServerConfiguration} [webSocketServer]
-       * @property {ProxyConfigMap | ProxyConfigArrayItem | ProxyConfigArray} [proxy]
-       * @property {boolean | string | Open | Array<string | Open>} [open]
-       * @property {boolean} [setupExitSignals]
-       * @property {boolean | ClientConfiguration} [client]
-       * @property {Headers | ((req: Request, res: Response, context: DevMiddlewareContext<Request, Response>) => Headers)} [headers]
-       * @property {(devServer: Server) => void} [onListening]
-       * @property {(middlewares: Middleware[], devServer: Server) => Middleware[]} [setupMiddlewares]
-       */
       ClientOverlay: {
@@ -289,3 +302,5 @@ anyOf: (
                     | {
-                        instanceof: string;
+                        instanceof: string /**
+                         * @typedef {import("ws").WebSocketServer | import("sockjs").Server & { close: import("ws").WebSocketServer["close"] }} WebSocketServer
+                         */;
                         description: string;
@@ -316,2 +331,65 @@ type?: undefined;
                 trustedTypesPolicyName: {
+                  /**
+                   * @typedef {Object} Open
+                   * @property {string | string[] | OpenApp} [app]
+                   * @property {string | string[]} [target]
+                   */
+                  /**
+                   * @typedef {Object} NormalizedOpen
+                   * @property {string} target
+                   * @property {import("open").Options} options
+                   */
+                  /**
+                   * @typedef {Object} WebSocketURL
+                   * @property {string} [hostname]
+                   * @property {string} [password]
+                   * @property {string} [pathname]
+                   * @property {number | string} [port]
+                   * @property {string} [protocol]
+                   * @property {string} [username]
+                   */
+                  /**
+                   * @typedef {boolean | ((error: Error) => void)} OverlayMessageOptions
+                   */
+                  /**
+                   * @typedef {Object} ClientConfiguration
+                   * @property {"log" | "info" | "warn" | "error" | "none" | "verbose"} [logging]
+                   * @property {boolean  | { warnings?: OverlayMessageOptions, errors?: OverlayMessageOptions, runtimeErrors?: OverlayMessageOptions }} [overlay]
+                   * @property {boolean} [progress]
+                   * @property {boolean | number} [reconnect]
+                   * @property {"ws" | "sockjs" | string} [webSocketTransport]
+                   * @property {string | WebSocketURL} [webSocketURL]
+                   */
+                  /**
+                   * @typedef {Array<{ key: string; value: string }> | Record<string, string | string[]>} Headers
+                   */
+                  /**
+                   * @typedef {{ name?: string, path?: string, middleware: ExpressRequestHandler | ExpressErrorRequestHandler } | ExpressRequestHandler | ExpressErrorRequestHandler} Middleware
+                   */
+                  /**
+                   * @typedef {Object} Configuration
+                   * @property {boolean | string} [ipc]
+                   * @property {Host} [host]
+                   * @property {Port} [port]
+                   * @property {boolean | "only"} [hot]
+                   * @property {boolean} [liveReload]
+                   * @property {DevMiddlewareOptions<Request, Response>} [devMiddleware]
+                   * @property {boolean} [compress]
+                   * @property {"auto" | "all" | string | string[]} [allowedHosts]
+                   * @property {boolean | ConnectHistoryApiFallbackOptions} [historyApiFallback]
+                   * @property {boolean | Record<string, never> | BonjourOptions} [bonjour]
+                   * @property {string | string[] | WatchFiles | Array<string | WatchFiles>} [watchFiles]
+                   * @property {boolean | string | Static | Array<string | Static>} [static]
+                   * @property {boolean | ServerOptions} [https]
+                   * @property {boolean} [http2]
+                   * @property {"http" | "https" | "spdy" | string | ServerConfiguration} [server]
+                   * @property {boolean | "sockjs" | "ws" | string | WebSocketServerConfiguration} [webSocketServer]
+                   * @property {ProxyConfigMap | ProxyConfigArrayItem | ProxyConfigArray} [proxy]
+                   * @property {boolean | string | Open | Array<string | Open>} [open]
+                   * @property {boolean} [setupExitSignals]
+                   * @property {boolean | ClientConfiguration} [client]
+                   * @property {Headers | ((req: Request, res: Response, context: DevMiddlewareContext<Request, Response>) => Headers)} [headers]
+                   * @property {(devServer: Server) => void} [onListening]
+                   * @property {(middlewares: Middleware[], devServer: Server) => Middleware[]} [setupMiddlewares]
+                   */
                   description: string;
@@ -470,2 +548,5 @@ type: string;
               minItems: number;
+              /**
+               * @type {Socket[]}
+               */
               instanceof?: undefined;
@@ -570,2 +651,7 @@ }
         description: string;
+        /**
+         * @param {Port} port
+         * @param {string} host
+         * @returns {Promise<number | string>}
+         */
         link: string;
@@ -597,5 +683,3 @@ };
           negatedDescription: string;
-        } /**
-         * @type {string | undefined}
-         */;
+        };
       };
@@ -633,7 +717,3 @@ OpenObject: {
                               type: string;
-                              minLength: number /**
-                               * @private
-                               * @param {Compiler} compiler
-                               * @returns bool
-                               */;
+                              minLength: number;
                             };
@@ -714,7 +794,7 @@ minItems: number;
                 type: string;
-                instanceof?: undefined;
+                /** @type {WebSocketURL} */ instanceof?: undefined;
               }
             | {
                 instanceof: string;
-                type?: undefined;
+                /** @type {ClientConfiguration} */ type?: undefined;
               }
@@ -999,3 +1079,3 @@ )[];
             minLength: number;
-            /** @type {MultiCompiler} */ description: string;
+            description: string;
             link: string;
@@ -1125,3 +1205,3 @@ };
         type: string;
-        minLength: number;
+        /** @type {NormalizedStatic} */ minLength: number;
       };
@@ -1404,4 +1484,10 @@ WebSocketServer: {
     | import("webpack-dev-middleware").API<
-        import("http").IncomingMessage,
-        import("http").ServerResponse<import("http").IncomingMessage>
+        import("express").Request<
+          import("express-serve-static-core").ParamsDictionary,
+          any,
+          any,
+          qs.ParsedQs,
+          Record<string, any>
+        >,
+        import("express").Response<any, Record<string, any>>
       >
@@ -1546,4 +1632,2 @@ | null
     NetworkInterfaceInfo,
-    Request,
-    Response,
     NextFunction,
@@ -1569,2 +1653,4 @@ ExpressRequestHandler,
     ServerOptions,
+    Request,
+    Response,
     DevMiddlewareOptions,
@@ -1615,4 +1701,2 @@ DevMiddlewareContext,
 type NetworkInterfaceInfo = import("os").NetworkInterfaceInfo;
-type Request = import("express").Request;
-type Response = import("express").Response;
 type NextFunction = import("express").NextFunction;
@@ -1645,6 +1729,24 @@ type ExpressRequestHandler = import("express").RequestHandler;
 };
-type DevMiddlewareOptions<Request_1, Response_1> =
-  import("webpack-dev-middleware").Options<IncomingMessage, ServerResponse>;
-type DevMiddlewareContext<Request_1, Response_1> =
-  import("webpack-dev-middleware").Context<IncomingMessage, ServerResponse>;
+type Request = import("express").Request;
+type Response = import("express").Response;
+type DevMiddlewareOptions<
+  T extends import("express").Request<
+    import("express-serve-static-core").ParamsDictionary,
+    any,
+    any,
+    qs.ParsedQs,
+    Record<string, any>
+  >,
+  U extends import("express").Response<any, Record<string, any>>,
+> = import("webpack-dev-middleware").Options<T, U>;
+type DevMiddlewareContext<
+  T extends import("express").Request<
+    import("express-serve-static-core").ParamsDictionary,
+    any,
+    any,
+    qs.ParsedQs,
+    Record<string, any>
+  >,
+  U extends import("express").Response<any, Record<string, any>>,
+> = import("webpack-dev-middleware").Context<T, U>;
 type Host = "local-ip" | "local-ipv4" | "local-ipv6" | string;
@@ -1788,3 +1890,14 @@ type Port = number | string | "auto";
   liveReload?: boolean | undefined;
-  devMiddleware?: DevMiddlewareOptions<Request_1, Response_1> | undefined;
+  devMiddleware?:
+    | DevMiddlewareOptions<
+        import("express").Request<
+          import("express-serve-static-core").ParamsDictionary,
+          any,
+          any,
+          qs.ParsedQs,
+          Record<string, any>
+        >,
+        import("express").Response<any, Record<string, any>>
+      >
+    | undefined;
   compress?: boolean | undefined;
@@ -1791,0 +1904,0 @@ allowedHosts?: string | string[] | undefined;

No alert changes

Improved metrics

Total package byte prevSize

532424

increased by1.26%

Lines of code

15197

increased by0.6%

No dependency changes