webpack-dev-service 0.11.7 → 0.11.8

package/esm/server/dev/utils/hash.js

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.11.7
+ * @version 0.11.8
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for webpack development and hot reloading.
  * @see https://github.com/nuintun/webpack-dev-service#readme

package/esm/server/dev/utils/http.js

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.11.7
+ * @version 0.11.8
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for webpack development and hot reloading.
  * @see https://github.com/nuintun/webpack-dev-service#readme

package/esm/server/dev/utils/path.js

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.11.7
+ * @version 0.11.8
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for webpack development and hot reloading.
  * @see https://github.com/nuintun/webpack-dev-service#readme

package/esm/server/dev/utils/paths.js

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.11.7
+ * @version 0.11.8
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for webpack development and hot reloading.
  * @see https://github.com/nuintun/webpack-dev-service#readme
@@ -21,18 +21,12 @@ function normalize(path) {
   return `/${path}`;
 }
 function getStats(stats) {
-  if (isMultiStatsMode(stats)) {
+  if ('stats' in stats) {
     return stats.stats;
   }
   // Return the stats.
   return [stats];
 }
-function getOutputPath(compilation) {
-  // The `output.path` is always present and always absolute.
-  const { path } = compilation.outputOptions;
-  // Get the path.
-  return compilation.getPath(path ?? '');
-}
 function getPublicPath(compilation) {
   const { publicPath } = compilation.outputOptions;
   // @see https://webpack.js.org/guides/public-path/#automatic-publicpath
@@ -48,8 +42,11 @@ function getPublicPath(compilation) {
     return normalize(path);
   }
 }
-function isMultiStatsMode(stats) {
-  return 'stats' in stats;
+function getOutputPath(compilation) {
+  // The `output.path` is always present and always absolute.
+  const { path } = compilation.outputOptions;
+  // Get the path.
+  return compilation.getPath(path ?? '');
 }
 function getPaths(stats) {
   const paths = [];

package/esm/server/dev/utils/ready.js

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.11.7
+ * @version 0.11.8
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for webpack development and hot reloading.
  * @see https://github.com/nuintun/webpack-dev-service#readme

package/esm/server/dev/utils/setupHooks.js

@@ -1,14 +1,14 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.11.7
+ * @version 0.11.8
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for webpack development and hot reloading.
  * @see https://github.com/nuintun/webpack-dev-service#readme
  */
 
 import supportsColor from 'supports-color';
-import { PLUGIN_NAME, isMultiCompilerMode, isString, isBoolean } from '../../utils.js';
+import { PLUGIN_NAME, isMultiCompiler, isString, isBoolean } from '../../utils.js';
 
 /**
  * @module setupHooks
@@ -31,7 +31,7 @@ function getStatsOptions(context) {
   const { compiler } = context;
   const { stats } = context.options;
   if (stats) {
-    if (isMultiCompilerMode(compiler)) {
+    if (isMultiCompiler(compiler)) {
       return {
         children: compiler.compilers.map(() => {
           return normalizeStatsOptions(stats);
@@ -40,7 +40,7 @@ function getStatsOptions(context) {
     }
     return normalizeStatsOptions(stats);
   }
-  if (isMultiCompilerMode(compiler)) {
+  if (isMultiCompiler(compiler)) {
     return {
       children: compiler.compilers.map(({ options }) => {
         return normalizeStatsOptions(options.stats);

package/esm/server/dev/utils/setupOutputFileSystem.js

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.11.7
+ * @version 0.11.8
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for webpack development and hot reloading.
  * @see https://github.com/nuintun/webpack-dev-service#readme

package/esm/server/dev/utils/setupWatching.js

@@ -1,19 +1,19 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.11.7
+ * @version 0.11.8
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for webpack development and hot reloading.
  * @see https://github.com/nuintun/webpack-dev-service#readme
  */
 
-import { isMultiCompilerMode } from '../../utils.js';
+import { isMultiCompiler } from '../../utils.js';
 
 /**
  * @module setupWatching
  */
 function getWatching({ compiler, logger }) {
-  const isMulti = isMultiCompilerMode(compiler);
+  const isMulti = isMultiCompiler(compiler);
   if (!isMulti && compiler.watching) {
     return compiler.watching;
   }

package/esm/server/dev/utils/setupWriteToDisk.js

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.11.7
+ * @version 0.11.8
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for webpack development and hot reloading.
  * @see https://github.com/nuintun/webpack-dev-service#readme

package/esm/server/hot/Socket.js

@@ -1,16 +1,16 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.11.7
+ * @version 0.11.8
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for webpack development and hot reloading.
  * @see https://github.com/nuintun/webpack-dev-service#readme
  */
 
+import webpack from 'webpack';
 import { fileURLToPath } from 'url';
 import { resolve, dirname } from 'path';
 import WebSocket, { WebSocketServer } from 'ws';
-import webpack from 'webpack';
 import { PLUGIN_NAME, getCompilers } from '../utils.js';
 import { getOptions, getStatsOptions, getTimestamp, isUpgradable, hasIssues } from './utils.js';
 

package/esm/server/hot/index.js

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.11.7
+ * @version 0.11.8
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for webpack development and hot reloading.
  * @see https://github.com/nuintun/webpack-dev-service#readme

package/esm/server/hot/utils.js

@@ -1,13 +1,13 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.11.7
+ * @version 0.11.8
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for webpack development and hot reloading.
  * @see https://github.com/nuintun/webpack-dev-service#readme
  */
 
-import { isMultiCompilerMode, isObject } from '../utils.js';
+import { isMultiCompiler, isObject } from '../utils.js';
 
 /**
  * @module utils
@@ -67,7 +67,7 @@ function normalizeStatsOptions(statsOptions) {
   };
 }
 function getStatsOptions(compiler) {
-  if (isMultiCompilerMode(compiler)) {
+  if (isMultiCompiler(compiler)) {
     return {
       children: compiler.compilers.map(({ options }) => {
         return normalizeStatsOptions(options.stats);

package/esm/server/index.js

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.11.7
+ * @version 0.11.8
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for webpack development and hot reloading.
  * @see https://github.com/nuintun/webpack-dev-service#readme

package/esm/server/schema.js

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.11.7
+ * @version 0.11.8
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for webpack development and hot reloading.
  * @see https://github.com/nuintun/webpack-dev-service#readme

package/esm/server/utils.js

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.11.7
+ * @version 0.11.8
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for webpack development and hot reloading.
  * @see https://github.com/nuintun/webpack-dev-service#readme
@@ -25,13 +25,13 @@ function isFunction(value) {
   return typeof value === 'function';
 }
 function getCompilers(compiler) {
-  if (isMultiCompilerMode(compiler)) {
+  if (isMultiCompiler(compiler)) {
     return compiler.compilers;
   }
   return [compiler];
 }
-function isMultiCompilerMode(compiler) {
+function isMultiCompiler(compiler) {
   return 'compilers' in compiler;
 }
 
-export { PLUGIN_NAME, getCompilers, isBoolean, isFunction, isMultiCompilerMode, isObject, isString };
+export { PLUGIN_NAME, getCompilers, isBoolean, isFunction, isMultiCompiler, isObject, isString };

package/global.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @module global.d.ts
+ */
+
+/// <reference types="webpack/module" />
+
+declare const __HOT_CLIENT__: string;
+
+declare const __PLUGIN_NAME__: string;
+
+declare type HotUpdateStatus = `${webpack.HotUpdateStatus}`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "webpack-dev-service",
-  "version": "0.11.7",
+  "version": "0.11.8",
   "description": "A koa 2 middleware for webpack development and hot reloading.",
   "type": "module",
   "sideEffects": [
@@ -35,7 +35,8 @@
   "files": [
     "cjs",
     "esm",
-    "types"
+    "types",
+    "global.d.ts"
   ],
   "engines": {
     "node": ">=18.0.0"
@@ -73,46 +74,45 @@
     "build:types": "tsc --declaration --emitDeclarationOnly --declarationDir types && node tools/fix-types.js"
   },
   "dependencies": {
-    "@nuintun/ansi": "^0.0.6",
+    "@nuintun/ansi": "^0.0.8",
     "@types/koa": "^2.15.0",
-    "@types/ws": "^8.5.11",
+    "@types/ws": "^8.5.12",
     "destroy": "^1.2.0",
     "etag": "^1.8.1",
-    "memfs": "^4.9.3",
+    "memfs": "^4.11.1",
     "range-parser": "^1.2.1",
     "schema-utils": "^4.2.0",
     "supports-color": "^9.4.0",
-    "tslib": "^2.6.3",
+    "tslib": "^2.7.0",
     "ws": "^8.18.0"
   },
   "devDependencies": {
     "@rollup/plugin-replace": "^5.0.7",
     "@rollup/plugin-typescript": "^11.1.6",
-    "@swc/core": "^1.7.0",
+    "@swc/core": "^1.7.22",
     "@swc/helpers": "^0.5.12",
     "@types/destroy": "^1.0.3",
     "@types/etag": "^1.8.3",
     "@types/koa-compose": "^3.2.8",
-    "@types/node": "^20.14.11",
+    "@types/node": "^22.5.2",
     "@types/range-parser": "^1.2.7",
-    "@types/react": "^18.3.3",
+    "@types/react": "^18.3.5",
     "@types/react-dom": "^18.3.0",
     "css-loader": "^7.1.2",
     "html-webpack-plugin": "^5.6.0",
     "koa": "^2.15.3",
     "koa-compress": "^5.1.1",
-    "magic-string": "^0.30.10",
-    "memfs": "^4.9.3",
-    "mini-css-extract-plugin": "^2.9.0",
+    "magic-string": "^0.30.11",
+    "mini-css-extract-plugin": "^2.9.1",
     "prettier": "^3.3.3",
     "react": "^18.3.1",
     "react-dom": "^18.3.1",
     "rimraf": "^6.0.1",
-    "rollup": "^4.18.1",
+    "rollup": "^4.21.2",
     "swc-loader": "^0.2.6",
     "tsc-alias": "^1.8.10",
-    "typescript": "^5.5.3",
-    "webpack": "^5.93.0"
+    "typescript": "^5.5.4",
+    "webpack": "^5.94.0"
   },
   "peerDependencies": {
     "koa": ">=2.0.0",

package/types/client/{message.d.ts → Message.d.ts}

@@ -1,15 +1,15 @@
 /**
  * @module message
  */
-import { StatsError } from 'webpack';
-export interface Invalid {
+import webpack from 'webpack';
+export interface InvalidMessage {
   action: 'invalid';
   payload: {
     path: string;
     timestamp: number;
   };
 }
-export interface Progress {
+export interface ProgressMessage {
   action: 'progress';
   payload: {
     value: number;
@@ -17,24 +17,25 @@ export interface Progress {
     message: string;
   };
 }
-export interface Hash {
+export interface HashMessage {
   action: 'hash';
   payload: {
     hash: string;
     timestamp: number;
   };
 }
-export interface Issues {
+export interface IssuesMessage {
   action: 'issues';
   payload: {
     timestamp: number;
-    errors: StatsError[];
-    warnings: StatsError[];
+    errors: webpack.StatsError[];
+    warnings: webpack.StatsError[];
   };
 }
-export interface OK {
+export interface OkMessage {
   action: 'ok';
   payload: {
     timestamp: number;
   };
 }
+export type Message = InvalidMessage | ProgressMessage | HashMessage | IssuesMessage | OkMessage;

package/types/client/events.d.ts

@@ -2,20 +2,21 @@
  * @module events
  */
 import { Options } from './client';
-import * as Message from './message';
-interface Messages {
-  ok: Message.OK['payload'];
-  hash: Message.Hash['payload'];
-  issues: Message.Issues['payload'];
-  invalid: Message.Invalid['payload'];
-  progress: Message.Progress['payload'];
+import { GetProp } from '../server/interface';
+import { HashMessage, InvalidMessage, IssuesMessage, OkMessage, ProgressMessage } from './Message';
+export interface Messages {
+  ok: GetProp<OkMessage, 'payload'>;
+  hash: GetProp<HashMessage, 'payload'>;
+  issues: GetProp<IssuesMessage, 'payload'>;
+  invalid: GetProp<InvalidMessage, 'payload'>;
+  progress: GetProp<ProgressMessage, 'payload'>;
 }
-interface Events {
-  ok(message: Messages['ok'], options: Options): void;
-  hash(message: Messages['hash'], options: Options): void;
-  issues(message: Messages['issues'], options: Options): void;
-  invalid(message: Messages['invalid'], options: Options): void;
-  progress(message: Messages['progress'], options: Options): void;
+export interface Events {
+  ok(message: GetProp<Messages, 'ok'>, options: Options): void;
+  hash(message: GetProp<Messages, 'hash'>, options: Options): void;
+  issues(message: GetProp<Messages, 'issues'>, options: Options): void;
+  invalid(message: GetProp<Messages, 'invalid'>, options: Options): void;
+  progress(message: GetProp<Messages, 'progress'>, options: Options): void;
 }
 /**
  * @function on
@@ -23,13 +24,12 @@ interface Events {
  * @param event Event name.
  * @param callback Event listener callback.
  */
-export declare function on<E extends keyof Events>(event: E, callback: Events[E]): void;
+export declare function on<E extends keyof Events>(event: E, callback: GetProp<Events, E>): void;
 /**
  * @function off
  * @description Remove an event listener callback.
  * @param event Event name.
  * @param callback Event listener callback.
  */
-export declare function off<E extends keyof Events>(event: E, callback?: Events[E]): void;
-export declare function emit<E extends keyof Events>(event: E, message: Messages[E], options: Options): void;
-export {};
+export declare function off<E extends keyof Events>(event: E, callback?: GetProp<Events, E>): void;
+export declare function emit<E extends keyof Events>(event: E, message: GetProp<Messages, E>, options: Options): void;

package/types/client/hot.d.ts

@@ -9,7 +9,7 @@ export declare function isUpdateAvailable(): boolean;
 /**
  * @function setHash
  * @description Set webpack hash.
- * @param value - The new hash value.
+ * @param value The new hash value.
  */
 export declare function setHash(value: string): void;
 /**

package/types/client/ui/{overlay.d.ts → Overlay.d.ts}

@@ -2,8 +2,8 @@
  * @module overlay
  * @see https://github.com/shellscape/webpack-plugin-serve
  */
-import { StatsError } from 'webpack';
-export default class Overlay {
+import webpack from 'webpack';
+export declare class Overlay {
   private hidden;
   private readonly name;
   private readonly close;
@@ -13,7 +13,7 @@ export default class Overlay {
   private readonly warningsList;
   private readonly warningsTitle;
   constructor(name: string);
-  setIssues(type: 'errors' | 'warnings', issues: StatsError[]): void;
+  setIssues(type: 'errors' | 'warnings', issues: webpack.StatsError[]): void;
   show(): void;
   hide(): void;
 }

package/types/client/ui/{progress.d.ts → Progress.d.ts}

@@ -3,7 +3,7 @@
  * @see https://github.com/shellscape/webpack-plugin-serve
  * @see https://www.zhangxinxu.com/wordpress/2015/07/svg-circle-loading
  */
-export default class Progress {
+export declare class Progress {
   private timer?;
   private hidden;
   private readonly svg;

package/types/server/dev/interface.d.ts

@@ -1,10 +1,10 @@
 /**
  * @module interface
  */
-import { StatsOptions } from 'webpack';
+import webpack from 'webpack';
 import { FileSystem } from './utils/fs';
 import { Options as ServiceOptions, Service } from './Service';
-import { ICompiler, ILogger, IStats, IStatsOptions, IWatching } from '../../server/interface';
+import { ICompiler, ILogger, IStats, IStatsOptions, IWatching, Optional } from '../../server/interface';
 export interface Callback {
   (stats: IStats): void;
 }
@@ -22,7 +22,7 @@ export interface Options extends Omit<ServiceOptions, 'fs'> {
   fs?: FileSystem;
   stats?: IStatsOptions;
   writeToDisk?: boolean | ((targetPath: string) => boolean);
-  onCompilationDone?(stats: IStats, statsOptions: Readonly<StatsOptions>): void;
+  onCompilationDone?(stats: IStats, statsOptions: Readonly<webpack.StatsOptions>): void;
 }
 export type FileService = [publicPath: string, service: Service];
 export interface Context {

package/types/server/dev/utils/fs.d.ts

@@ -1,11 +1,12 @@
 /**
  * @module fs
  */
-import { Compiler } from 'webpack';
+import webpack from 'webpack';
 import { ReadStream, Stats } from 'fs';
+import { GetProp } from '../../../server/interface';
 type PathLike = string | Buffer | URL;
 type FileStats = Stats | null | undefined;
-type IFileSystem = NonNullable<Compiler['outputFileSystem']>;
+type OutputFileSystem = GetProp<webpack.Compiler, 'outputFileSystem'>;
 /**
  * @function stat
  * @description Get file stats.
@@ -13,7 +14,7 @@ type IFileSystem = NonNullable<Compiler['outputFileSystem']>;
  * @param path The file path.
  */
 export declare function stat(fs: FileSystem, path: string): Promise<FileStats>;
-export interface FileSystem extends IFileSystem {
+export interface FileSystem extends OutputFileSystem {
   createReadStream(
     path: PathLike,
     options?: {

package/types/server/hot/Socket.d.ts

@@ -1,9 +1,9 @@
 /**
  * @module Socket
  */
+import webpack from 'webpack';
 import { Context } from 'koa';
 import WebSocket from 'ws';
-import { StatsCompilation } from 'webpack';
 import { Options } from './interface';
 import { ICompiler } from '../../server/interface';
 export declare class Socket {
@@ -19,5 +19,5 @@ export declare class Socket {
   clients(): Set<WebSocket>;
   upgrade(context: Context): boolean;
   broadcast<T>(clients: Set<WebSocket> | WebSocket[], action: string, payload: T): void;
-  broadcastStats(clients: Set<WebSocket> | WebSocket[], stats: StatsCompilation): void;
+  broadcastStats(clients: Set<WebSocket> | WebSocket[], stats: webpack.StatsCompilation): void;
 }

package/types/server/hot/interface.d.ts

@@ -2,7 +2,7 @@
  * @module interface
  */
 import WebSocket from 'ws';
-import { Compiler, WebpackPluginInstance } from 'webpack';
+import webpack from 'webpack';
 export interface Options {
   hmr?: boolean;
   path?: string;
@@ -12,7 +12,7 @@ export interface Options {
   progress?: boolean;
 }
 export interface PluginFactory {
-  (compiler: Compiler): WebpackPluginInstance;
+  (compiler: webpack.Compiler): webpack.WebpackPluginInstance;
 }
 export interface Expose {
   readonly clients: () => Set<WebSocket>;

package/types/server/hot/utils.d.ts

@@ -1,12 +1,12 @@
 /**
  * @module utils
  */
+import webpack from 'webpack';
 import { Context } from 'koa';
 import { Options } from './interface';
-import { StatsCompilation, StatsOptions } from 'webpack';
 import { ICompiler } from '../../server/interface';
 export declare function isUpgradable(context: Context): boolean;
 export declare function getOptions(options?: Options): Required<Options>;
 export declare function hasIssues<T>(issues: ArrayLike<T> | undefined): boolean;
-export declare function getStatsOptions(compiler: ICompiler): StatsOptions;
-export declare function getTimestamp({ builtAt, children }: StatsCompilation): number;
+export declare function getStatsOptions(compiler: ICompiler): webpack.StatsOptions;
+export declare function getTimestamp({ builtAt, children }: webpack.StatsCompilation): number;

package/types/server/interface.d.ts

@@ -1,9 +1,11 @@
 /**
  * @module interface
  */
-import { Compiler, Configuration, MultiCompiler, MultiStats, Stats, Watching } from 'webpack';
-export type IStats = Stats | MultiStats;
-export type ICompiler = Compiler | MultiCompiler;
-export type IStatsOptions = NonNullable<Configuration['stats']>;
-export type ILogger = ReturnType<Compiler['getInfrastructureLogger']>;
-export type IWatching = Watching | ReturnType<MultiCompiler['watch']>;
+import webpack from 'webpack';
+export type IStats = webpack.Stats | webpack.MultiStats;
+export type GetProp<T, P extends keyof T> = NonNullable<T[P]>;
+export type ICompiler = webpack.Compiler | webpack.MultiCompiler;
+export type IStatsOptions = GetProp<webpack.Configuration, 'stats'>;
+export type ILogger = ReturnType<GetProp<webpack.Compiler, 'getInfrastructureLogger'>>;
+export type IWatching = webpack.Watching | ReturnType<GetProp<webpack.MultiCompiler, 'watch'>>;
+export type Optional<T extends object, K extends keyof T = keyof T> = Omit<T, K> & Partial<Pick<T, K>>;

package/types/server/utils.d.ts

@@ -1,12 +1,12 @@
 /**
  * @module utils
  */
+import webpack from 'webpack';
 import { ICompiler } from './interface';
-import { Compiler, MultiCompiler } from 'webpack';
-export declare const PLUGIN_NAME = 'webpack-dev-service';
+export declare const PLUGIN_NAME: string;
 export declare function isObject(value: unknown): value is object;
 export declare function isString(value: unknown): value is string;
 export declare function isBoolean(value: unknown): value is boolean;
 export declare function isFunction(value: unknown): value is Function;
-export declare function getCompilers(compiler: ICompiler): Compiler[];
-export declare function isMultiCompilerMode(compiler: ICompiler): compiler is MultiCompiler;
+export declare function getCompilers(compiler: ICompiler): webpack.Compiler[];
+export declare function isMultiCompiler(compiler: ICompiler): compiler is webpack.MultiCompiler;