webpack-dev-server 4.8.1 → 4.9.2

package/types/lib/Server.d.ts

@@ -393,6 +393,17 @@ declare class Server {
         simpleType: string;
         multiple: boolean;
       };
+      "client-overlay-trusted-types-policy-name": {
+        configs: {
+          description: string;
+          multiple: boolean;
+          path: string;
+          type: string;
+        }[];
+        description: string;
+        multiple: boolean;
+        simpleType: string;
+      };
       "client-overlay-warnings": {
         configs: {
           type: string;
@@ -417,6 +428,60 @@ declare class Server {
         simpleType: string;
         multiple: boolean;
       };
+      /**
+       * @typedef {Object} WebSocketURL
+       * @property {string} [hostname]
+       * @property {string} [password]
+       * @property {string} [pathname]
+       * @property {number | string} [port]
+       * @property {string} [protocol]
+       * @property {string} [username]
+       */
+      /**
+       * @typedef {Object} ClientConfiguration
+       * @property {"log" | "info" | "warn" | "error" | "none" | "verbose"} [logging]
+       * @property {boolean  | { warnings?: boolean, errors?: boolean }} [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 {boolean} [magicHtml]
+       * @property {"auto" | "all" | string | string[]} [allowedHosts]
+       * @property {boolean | ConnectHistoryApiFallbackOptions} [historyApiFallback]
+       * @property {boolean} [setupExitSignals]
+       * @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} [onAfterSetupMiddleware]
+       * @property {(devServer: Server) => void} [onBeforeSetupMiddleware]
+       * @property {(devServer: Server) => void} [onListening]
+       * @property {(middlewares: Middleware[], devServer: Server) => Middleware[]} [setupMiddlewares]
+       */
       "client-reconnect": {
         configs: (
           | {
@@ -453,36 +518,6 @@ declare class Server {
               path: string;
             }
         )[];
-        /**
-         * @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 {boolean} [magicHtml]
-         * @property {"auto" | "all" | string | string[]} [allowedHosts]
-         * @property {boolean | ConnectHistoryApiFallbackOptions} [historyApiFallback]
-         * @property {boolean} [setupExitSignals]
-         * @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} [onAfterSetupMiddleware]
-         * @property {(devServer: Server) => void} [onBeforeSetupMiddleware]
-         * @property {(devServer: Server) => void} [onListening]
-         * @property {(middlewares: Middleware[], devServer: Server) => Middleware[]} [setupMiddlewares]
-         */
         description: string;
         simpleType: string;
         multiple: boolean;
@@ -539,6 +574,9 @@ declare class Server {
           path: string;
         }[];
         description: string;
+        /**
+         * @type {FSWatcher[]}
+         */
         simpleType: string;
         multiple: boolean;
       };
@@ -558,20 +596,12 @@ declare class Server {
               type: string;
             }
         )[];
-        /**
-         * @private
-         * @type {{ name: string | symbol, listener: (...args: any[]) => void}[] }}
-         */
         description: string;
         multiple: boolean;
         simpleType: string;
       };
       "client-web-socket-url-username": {
         configs: {
-          /**
-           * @private
-           * @type {RequestHandler[]}
-           */
           type: string;
           multiple: boolean;
           description: string;
@@ -581,6 +611,10 @@ declare class Server {
         simpleType: string;
         multiple: boolean;
       };
+      /**
+       * @param {string} URL
+       * @returns {boolean}
+       */
       compress: {
         configs: {
           type: string;
@@ -591,6 +625,10 @@ declare class Server {
         }[];
         description: string;
         simpleType: string;
+        /**
+         * @param {string} gateway
+         * @returns {string | undefined}
+         */
         multiple: boolean;
       };
       "history-api-fallback": {
@@ -623,6 +661,10 @@ declare class Server {
         )[];
         description: string;
         simpleType: string;
+        /**
+         * @param {Host} hostname
+         * @returns {Promise<string>}
+         */
         multiple: boolean;
       };
       hot: {
@@ -632,10 +674,6 @@ declare class Server {
               multiple: boolean;
               description: string;
               negatedDescription: string;
-              /**
-               * @param {"v4" | "v6"} family
-               * @returns {string | undefined}
-               */
               path: string;
             }
           | {
@@ -662,10 +700,6 @@ declare class Server {
         simpleType: string;
         multiple: boolean;
       };
-      /**
-       * @param {Port} port
-       * @returns {Promise<number | string>}
-       */
       https: {
         configs: {
           type: string;
@@ -685,9 +719,6 @@ declare class Server {
           description: string;
           path: string;
         }[];
-        /**
-         * @type {string | undefined}
-         */
         description: string;
         simpleType: string;
         multiple: boolean;
@@ -695,6 +726,9 @@ declare class Server {
       "https-ca-reset": {
         configs: {
           description: string;
+          /**
+           * @type {string[]}
+           */
           multiple: boolean;
           path: string;
           type: string;
@@ -719,7 +753,7 @@ declare class Server {
           description: string;
           multiple: boolean;
           path: string;
-          /** @type {WebSocketURL} */ type: string;
+          type: string;
         }[];
         description: string;
         multiple: boolean;
@@ -829,7 +863,7 @@ declare class Server {
           type: string;
           multiple: boolean;
           description: string;
-          negatedDescription: string;
+          /** @type {Object<string,string>} */ negatedDescription: string;
           path: string;
         }[];
         description: string;
@@ -841,12 +875,13 @@ declare class Server {
           | {
               type: string;
               multiple: boolean;
+              /** @type {any} */
               description: string;
               path: string;
             }
           | {
               type: string;
-              /** @type {Object<string,string>} */ values: boolean[];
+              /** @type {any} */ values: boolean[];
               multiple: boolean;
               description: string;
               path: string;
@@ -896,7 +931,7 @@ declare class Server {
               path: string;
             }
         )[];
-        description: string;
+        /** @type {Compiler} */ description: string;
         simpleType: string;
         multiple: boolean;
       };
@@ -952,7 +987,7 @@ declare class Server {
           path: string;
         }[];
         description: string;
-        simpleType: string;
+        /** @type {NormalizedStatic} */ simpleType: string;
         multiple: boolean;
       };
       "open-target-reset": {
@@ -1127,8 +1162,9 @@ declare class Server {
         }[];
         description: string;
         multiple: boolean;
-        simpleType: string;
+        simpleType: string /** @type {ServerOptions} */;
       };
+      /** @type {ServerOptions} */
       "server-options-request-cert": {
         configs: {
           description: string;
@@ -1164,6 +1200,10 @@ declare class Server {
           | {
               type: string;
               multiple: boolean;
+              /**
+               * @param {string | Buffer | undefined} item
+               * @returns {string | Buffer | undefined}
+               */
               description: string;
               negatedDescription: string;
               path: string;
@@ -1180,7 +1220,7 @@ declare class Server {
           description: string;
           path: string;
         }[];
-        description: string;
+        /** @type {any} */ description: string;
         simpleType: string;
         multiple: boolean;
       };
@@ -1287,7 +1327,9 @@ declare class Server {
               type: string;
             }
         )[];
+        /** @type {ServerOptions & { cacert?: ServerOptions["ca"] }} */
         description: string;
+        /** @type {ServerOptions} */
         simpleType: string;
         multiple: boolean;
       };
@@ -1603,6 +1645,10 @@ declare class Server {
                     negatedDescription: string;
                   };
                 };
+                trustedTypesPolicyName: {
+                  description: string;
+                  type: string;
+                };
               };
               description?: undefined;
               link?: undefined;
@@ -1621,21 +1667,103 @@ declare class Server {
       ClientReconnect: {
         description: string;
         link: string;
-        /**
-         * @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
-         */
+        anyOf: (
+          | {
+              /**
+               * @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 {Object} ClientConfiguration
+               * @property {"log" | "info" | "warn" | "error" | "none" | "verbose"} [logging]
+               * @property {boolean  | { warnings?: boolean, errors?: boolean }} [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 {boolean} [magicHtml]
+               * @property {"auto" | "all" | string | string[]} [allowedHosts]
+               * @property {boolean | ConnectHistoryApiFallbackOptions} [historyApiFallback]
+               * @property {boolean} [setupExitSignals]
+               * @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} [onAfterSetupMiddleware]
+               * @property {(devServer: Server) => void} [onBeforeSetupMiddleware]
+               * @property {(devServer: Server) => void} [onListening]
+               * @property {(middlewares: Middleware[], devServer: Server) => Middleware[]} [setupMiddlewares]
+               */
+              type: string;
+              cli: {
+                negatedDescription: string;
+              };
+              minimum?: undefined;
+            }
+          | {
+              type: string;
+              minimum: number;
+              cli?: undefined /** @typedef {import("express").Request} Request */;
+            }
+        )[];
+      };
+      ClientWebSocketTransport: {
+        anyOf: {
+          $ref: string;
+        }[];
         /**
          * @typedef {Object} OpenApp
          * @property {string} [name]
@@ -1705,25 +1833,6 @@ declare class Server {
          * @property {(devServer: Server) => void} [onListening]
          * @property {(middlewares: Middleware[], devServer: Server) => Middleware[]} [setupMiddlewares]
          */
-        anyOf: (
-          | {
-              type: string;
-              cli: {
-                negatedDescription: string;
-              };
-              minimum?: undefined;
-            }
-          | {
-              type: string;
-              minimum: number;
-              cli?: undefined /** @typedef {import("express").Request} Request */;
-            }
-        )[];
-      };
-      ClientWebSocketTransport: {
-        anyOf: {
-          $ref: string;
-        }[];
         description: string;
         link: string;
       };
@@ -1733,6 +1842,15 @@ declare class Server {
       ClientWebSocketTransportString: {
         type: string;
         minLength: number;
+        /**
+         * @typedef {Object} WebSocketURL
+         * @property {string} [hostname]
+         * @property {string} [password]
+         * @property {string} [pathname]
+         * @property {number | string} [port]
+         * @property {string} [protocol]
+         * @property {string} [username]
+         */
       };
       ClientWebSocketURL: {
         description: string;
@@ -1757,9 +1875,6 @@ declare class Server {
                   description: string;
                   type: string;
                 };
-                /**
-                 * @typedef {Array<{ key: string; value: string }> | Record<string, string | string[]>} Headers
-                 */
                 password: {
                   description: string;
                   type: string;
@@ -1873,10 +1988,6 @@ declare class Server {
                       }
                     | {
                         instanceof: string;
-                        /**
-                         * @private
-                         * @type {RequestHandler[]}
-                         */
                         type?: undefined;
                         items?: undefined;
                       }
@@ -1946,6 +2057,10 @@ declare class Server {
                   description: string;
                 };
                 crl: {
+                  /**
+                   * @param {"v4" | "v6"} family
+                   * @returns {Promise<string | undefined>}
+                   */
                   anyOf: (
                     | {
                         type: string;
@@ -2100,7 +2215,7 @@ declare class Server {
             }
         )[];
         description: string;
-        link: string;
+        link: string /** @type {WebSocketURL} */;
       };
       HistoryApiFallback: {
         anyOf: (
@@ -2116,11 +2231,12 @@ declare class Server {
               type: string;
               description: string;
               link: string;
+              /** @type {string} */
               cli?: undefined /** @typedef {import("express").Request} Request */;
             }
         )[];
         description: string;
-        /** @type {string} */ link: string;
+        link: string;
       };
       Host: {
         description: string;
@@ -2258,6 +2374,12 @@ declare class Server {
                       anyOf: (
                         | {
                             type: string;
+                            /**
+                             * prependEntry Method for webpack 4
+                             * @param {any} originalEntry
+                             * @param {any} newAdditionalEntries
+                             * @returns {any}
+                             */
                             items: {
                               type: string;
                               minLength: number;
@@ -2299,6 +2421,7 @@ declare class Server {
           };
         };
       };
+      /** @type {any} */
       OpenString: {
         type: string;
         minLength: number;
@@ -2346,7 +2469,7 @@ declare class Server {
                     }
                   | {
                       instanceof: string;
-                      /** @type {string} */ type?: undefined;
+                      type?: undefined;
                     }
                 )[];
               };
@@ -2508,6 +2631,7 @@ declare class Server {
                     anyOf: (
                       | {
                           type: string;
+                          /** @type {NormalizedStatic} */
                           instanceof?: undefined;
                         }
                       | {
@@ -2812,7 +2936,7 @@ declare class Server {
             }
         )[];
         cli: {
-          description: string;
+          description: string /** @type {any} */;
         };
       };
       WebSocketServerFunction: {
@@ -2850,7 +2974,6 @@ declare class Server {
         $ref: string;
       };
       client: {
-        /** @type {any} */
         $ref: string;
       };
       compress: {
@@ -2951,9 +3074,10 @@ declare class Server {
   static getHostname(hostname: Host): Promise<string>;
   /**
    * @param {Port} port
+   * @param {string} host
    * @returns {Promise<number | string>}
    */
-  static getFreePort(port: Port): Promise<number | string>;
+  static getFreePort(port: Port, host: string): Promise<number | string>;
   /**
    * @returns {string}
    */
@@ -3202,9 +3326,7 @@ declare class Server {
   /**
    * @param {(err?: Error) => void} [callback]
    */
-  startCallback(
-    callback?: ((err?: Error | undefined) => void) | undefined
-  ): void;
+  startCallback(callback?: ((err?: Error) => void) | undefined): void;
   /**
    * @returns {Promise<void>}
    */
@@ -3212,25 +3334,19 @@ declare class Server {
   /**
    * @param {(err?: Error) => void} [callback]
    */
-  stopCallback(
-    callback?: ((err?: Error | undefined) => void) | undefined
-  ): void;
+  stopCallback(callback?: ((err?: Error) => void) | undefined): void;
   /**
    * @param {Port} port
    * @param {Host} hostname
    * @param {(err?: Error) => void} fn
    * @returns {void}
    */
-  listen(
-    port: Port,
-    hostname: Host,
-    fn: (err?: Error | undefined) => void
-  ): void;
+  listen(port: Port, hostname: Host, fn: (err?: Error) => void): void;
   /**
    * @param {(err?: Error) => void} [callback]
    * @returns {void}
    */
-  close(callback?: ((err?: Error | undefined) => void) | undefined): void;
+  close(callback?: ((err?: Error) => void) | undefined): void;
 }
 declare namespace Server {
   export {

package/types/lib/getPort.d.ts

@@ -0,0 +1,10 @@
+export = getPorts;
+/**
+ * @param {number} basePort
+ * @param {string=} host
+ * @return {Promise<number>}
+ */
+declare function getPorts(
+  basePort: number,
+  host?: string | undefined
+): Promise<number>;