rspack-dev-middleware 0.4.0 → 0.4.2

package/cjs/server/dev/utils/http.d.cts

@@ -16,12 +16,37 @@ export interface Range {
  * @param URI The URI to decode.
  */
 export declare function decodeURI(URI: string): string | -1;
+/**
+ * @function generateBoundary
+ * @description Generate a boundary string.
+ */
+export declare function generateBoundary(): string;
 /**
  * @function isConditionalGET
  * @description Check if request is conditional GET.
  * @param context The koa context.
  */
 export declare function isConditionalGET({ request }: Context): boolean;
+/**
+ * @function createETag
+ * @description Generate a weak entity tag from file stats.
+ * @param stats The file stats.
+ */
+export declare function createETag(stats: Stats): string;
+/**
+ * @function isETagMatch
+ * @see https://httpwg.org/specs/rfc9110.html
+ * @param match The match value.
+ * @param etag The etag value.
+ * @param isIfMatch The flag of if-match.
+ */
+export declare function isETagMatch(match: string, etag: string, isIfMatch?: boolean): boolean;
+/**
+ * @function isRangeFresh
+ * @description Check if request range fresh.
+ * @param context Koa context.
+ */
+export declare function isRangeFresh({ request, response }: Context): boolean;
 /**
  * @function isPreconditionFailed
  * @description Check if request precondition failed.
@@ -34,4 +59,4 @@ export declare function isPreconditionFailed({ request, response }: Context): bo
  * @param context The koa context.
  * @param stats The file stats.
  */
-export declare function parseRanges(context: Context, stats: Stats): -1 | -2 | Range[];
+export declare function parseRanges(context: Context, stats: Stats): -1 | Range[];

package/cjs/server/dev/utils/path.cjs

@@ -2,7 +2,7 @@
  * @module rspack-dev-middleware
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.4.0
+ * @version 0.4.2
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for rspack development and hot reloading.
  * @see https://github.com/nuintun/rspack-dev-middleware#readme

package/cjs/server/dev/utils/paths.cjs

@@ -2,7 +2,7 @@
  * @module rspack-dev-middleware
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.4.0
+ * @version 0.4.2
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for rspack development and hot reloading.
  * @see https://github.com/nuintun/rspack-dev-middleware#readme

package/cjs/server/dev/utils/setupHooks.cjs

@@ -2,7 +2,7 @@
  * @module rspack-dev-middleware
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.4.0
+ * @version 0.4.2
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for rspack development and hot reloading.
  * @see https://github.com/nuintun/rspack-dev-middleware#readme
@@ -23,13 +23,7 @@ const supportsColor__default = /*#__PURE__*/ _interopDefault(supportsColor);
  * @module setupHooks
  */
 function normalizeStatsOptions(statsOptions) {
-  if (statsOptions == null) {
-    return { preset: 'normal' };
-  } else if (utils.isString(statsOptions)) {
-    return { preset: statsOptions };
-  } else if (utils.isBoolean(statsOptions)) {
-    return statsOptions ? { preset: 'normal' } : { preset: 'none' };
-  }
+  statsOptions = utils.toStatsPreset(statsOptions);
   if (statsOptions.colors == null) {
     const { stdout, stderr } = supportsColor__default.default;
     statsOptions.colors = stdout !== false && stderr !== false;
@@ -83,7 +77,7 @@ function setupHooks(context) {
     process.nextTick(() => {
       const { stats } = context;
       // Check if still in valid state.
-      if (stats) {
+      if (stats != null) {
         // Call onCompilationDone.
         onCompilationDone(stats, statsOptions);
         // Callbacks.

package/cjs/server/dev/utils/setupOutputFileSystem.cjs

@@ -2,7 +2,7 @@
  * @module rspack-dev-middleware
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.4.0
+ * @version 0.4.2
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for rspack development and hot reloading.
  * @see https://github.com/nuintun/rspack-dev-middleware#readme

package/cjs/server/dev/utils/setupWatching.cjs

@@ -2,7 +2,7 @@
  * @module rspack-dev-middleware
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.4.0
+ * @version 0.4.2
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for rspack development and hot reloading.
  * @see https://github.com/nuintun/rspack-dev-middleware#readme
@@ -15,11 +15,8 @@ const utils = require('../../utils.cjs');
 /**
  * @module setupWatching
  */
-function getWatching({ compiler, logger }) {
-  const isMulti = utils.isMultiCompiler(compiler);
-  if (!isMulti && compiler.watching) {
-    return compiler.watching;
-  }
+function setupWatching(context) {
+  const { compiler, logger } = context;
   const errorHandler = error => {
     if (error != null) {
       // For example - `writeToDisk` can throw an error and right now it is ends watching.
@@ -28,17 +25,15 @@ function getWatching({ compiler, logger }) {
       logger.error(error);
     }
   };
-  if (!isMulti) {
-    const { watchOptions } = compiler.options;
-    return compiler.watch(watchOptions, errorHandler);
+  if (utils.isMultiCompiler(compiler)) {
+    const watchOptions = compiler.compilers.map(({ options }) => {
+      return options.watchOptions;
+    });
+    context.watching = compiler.watch(watchOptions, errorHandler);
+  } else {
+    // Reuse existing watching if present, otherwise start watching.
+    context.watching = compiler.watching ?? compiler.watch(compiler.options.watchOptions, errorHandler);
   }
-  const watchOptions = compiler.compilers.map(({ options }) => {
-    return options.watchOptions;
-  });
-  return compiler.watch(watchOptions, errorHandler);
-}
-function setupWatching(context) {
-  context.watching = getWatching(context);
 }
 
 exports.setupWatching = setupWatching;

package/cjs/server/dev/utils/setupWriteToDisk.cjs

@@ -2,7 +2,7 @@
  * @module rspack-dev-middleware
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.4.0
+ * @version 0.4.2
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for rspack development and hot reloading.
  * @see https://github.com/nuintun/rspack-dev-middleware#readme

package/cjs/server/hot/Message.d.cts

@@ -2,17 +2,19 @@
  * @module message
  */
 import * as rspack from '@rspack/core';
-import { GetProp } from '../interface.cjs';
-export interface Invalid {
-  action: 'invalid';
-  payload: {
+export interface Messages {
+  ok: {
+    timestamp: number;
+  };
+  hash: {
+    hash: string;
+    timestamp: number;
+  };
+  invalid: {
     timestamp: number;
     path: string | null;
   };
-}
-export interface Progress {
-  action: 'progress';
-  payload: {
+  progress: {
     stage: string;
     percent: number;
     details: {
@@ -20,33 +22,15 @@ export interface Progress {
       moduleIdentifier?: string;
     };
   };
-}
-export interface Hash {
-  action: 'hash';
-  payload: {
-    hash: string;
-    timestamp: number;
-  };
-}
-export interface Issues {
-  action: 'issues';
-  payload: {
+  issues: {
     timestamp: number;
     errors: rspack.StatsError[];
     warnings: rspack.StatsError[];
   };
 }
-export interface Ok {
-  action: 'ok';
-  payload: {
-    timestamp: number;
+export type Message = {
+  [A in keyof Messages]: {
+    action: A;
+    payload: Messages[A];
   };
-}
-export interface Messages {
-  ok: GetProp<Ok, 'payload'>;
-  hash: GetProp<Hash, 'payload'>;
-  issues: GetProp<Issues, 'payload'>;
-  invalid: GetProp<Invalid, 'payload'>;
-  progress: GetProp<Progress, 'payload'>;
-}
-export type Message = Invalid | Progress | Hash | Issues | Ok;
+}[keyof Messages];

package/cjs/server/hot/Socket.cjs

@@ -2,7 +2,7 @@
  * @module rspack-dev-middleware
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.4.0
+ * @version 0.4.2
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for rspack development and hot reloading.
  * @see https://github.com/nuintun/rspack-dev-middleware#readme
@@ -10,10 +10,10 @@
 
 'use strict';
 
-const uuid = require('uuid');
 const node_buffer = require('node:buffer');
 const rspack = require('@rspack/core');
 require('node:url');
+const node_crypto = require('node:crypto');
 const node_path = require('node:path');
 const WebSocket = require('ws');
 const utils$1 = require('../utils.cjs');
@@ -72,15 +72,15 @@ class Socket {
     const compilers = utils$1.getCompilers(compiler);
     const contexts = new Map();
     for (const compiler of compilers) {
-      const uuid$1 = uuid.v7();
+      const uuid = node_crypto.randomUUID();
       const context = {
-        uuid: uuid$1,
+        uuid,
         stats: null,
         percent: -1,
         clients: new Set()
       };
-      contexts.set(uuid$1, context);
-      this.#setupOutput(compiler, uuid$1);
+      contexts.set(uuid, context);
+      this.#setupOutput(compiler, uuid);
       this.#setupHooks(compiler, context);
       this.#setupPlugins(compiler, context);
     }
@@ -116,7 +116,7 @@ class Socket {
       process.nextTick(() => {
         const { stats } = context;
         // Broadcast stats.
-        if (stats) {
+        if (stats != null && context.clients.size > 0) {
           this.#broadcastStats(context.clients, stats);
         }
       });
@@ -167,7 +167,7 @@ class Socket {
       const uuid = url.searchParams.get('uuid');
       if (uuid) {
         const context = contexts.get(uuid);
-        if (context) {
+        if (context != null) {
           const { stats } = context;
           context.clients.add(client);
           logger.log('client connected');
@@ -175,9 +175,8 @@ class Socket {
             context.clients.delete(client);
             logger.log('client disconnected');
           });
-          if (stats) {
-            const clients = new Set([client]);
-            this.#broadcastStats(clients, stats);
+          if (stats != null) {
+            this.#broadcastStats([client], stats);
           }
         } else {
           client.close(4001, 'compiler not found');
@@ -191,21 +190,21 @@ class Socket {
     });
   }
   #broadcast(clients, action, payload) {
+    // Serialize once, send to all.
+    const message = JSON.stringify({ action, payload });
     for (const client of clients) {
       if (client.readyState === WebSocket__default.default.OPEN) {
-        client.send(JSON.stringify({ action, payload }));
+        client.send(message);
       }
     }
   }
   #broadcastStats(clients, stats) {
-    if (clients.size > 0) {
-      const { hash, errors, warnings, builtAt: timestamp } = stats;
-      this.#broadcast(clients, 'hash', { hash, timestamp });
-      if (utils.hasIssues(errors) || utils.hasIssues(warnings)) {
-        this.#broadcast(clients, 'issues', { errors, warnings, timestamp });
-      } else {
-        this.#broadcast(clients, 'ok', { timestamp });
-      }
+    const { hash, errors, warnings, builtAt: timestamp } = stats;
+    this.#broadcast(clients, 'hash', { hash, timestamp });
+    if (utils.hasIssues(errors) || utils.hasIssues(warnings)) {
+      this.#broadcast(clients, 'issues', { errors, warnings, timestamp });
+    } else {
+      this.#broadcast(clients, 'ok', { timestamp });
     }
   }
   upgrade(context) {

package/cjs/server/hot/index.cjs

@@ -2,7 +2,7 @@
  * @module rspack-dev-middleware
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.4.0
+ * @version 0.4.2
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for rspack development and hot reloading.
  * @see https://github.com/nuintun/rspack-dev-middleware#readme

package/cjs/server/hot/utils.cjs

@@ -2,7 +2,7 @@
  * @module rspack-dev-middleware
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.4.0
+ * @version 0.4.2
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for rspack development and hot reloading.
  * @see https://github.com/nuintun/rspack-dev-middleware#readme
@@ -36,14 +36,8 @@ function hasIssues(issues) {
   return Array.isArray(issues) && issues.length > 0;
 }
 function getStatsOptions(compiler) {
-  let statsOptions = compiler.options.stats;
-  if (utils.isString(statsOptions)) {
-    statsOptions = { preset: statsOptions };
-  } else if (utils.isBoolean(statsOptions)) {
-    statsOptions = statsOptions ? { preset: 'normal' } : { preset: 'none' };
-  }
   return {
-    ...statsOptions,
+    ...utils.toStatsPreset(compiler.options.stats),
     all: false,
     hash: true,
     colors: true,

package/cjs/server/index.cjs

@@ -2,7 +2,7 @@
  * @module rspack-dev-middleware
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.4.0
+ * @version 0.4.2
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for rspack development and hot reloading.
  * @see https://github.com/nuintun/rspack-dev-middleware#readme

package/cjs/server/schema.cjs

@@ -2,7 +2,7 @@
  * @module rspack-dev-middleware
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.4.0
+ * @version 0.4.2
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for rspack development and hot reloading.
  * @see https://github.com/nuintun/rspack-dev-middleware#readme
@@ -17,7 +17,7 @@ const schema = {
   type: 'object',
   properties: {
     hot: {
-      description: 'Enable or disable HMR server.',
+      description: 'Configure the HMR server, or set to false to disable.',
       anyOf: [
         {
           type: 'boolean',
@@ -40,7 +40,7 @@ const schema = {
             },
             reload: {
               type: 'boolean',
-              description: 'Control whether the full page should be reloaded when HMR failure.'
+              description: 'Control whether the full page should be reloaded when HMR fails.'
             },
             overlay: {
               type: 'boolean',
@@ -101,9 +101,30 @@ const schema = {
       type: 'object',
       description: 'The output file system used by the dev server.'
     },
+    highWaterMark: {
+      description: 'The size of the read stream buffer.',
+      anyOf: [
+        {
+          type: 'number'
+        },
+        {
+          instanceof: 'Function'
+        }
+      ]
+    },
     stats: {
-      type: 'object',
-      description: 'Options for the statistics output.'
+      description: 'Options for the statistics output.',
+      anyOf: [
+        {
+          type: 'boolean'
+        },
+        {
+          type: 'string'
+        },
+        {
+          type: 'object'
+        }
+      ]
     },
     writeToDisk: {
       anyOf: [
@@ -119,7 +140,7 @@ const schema = {
     },
     onCompilationDone: {
       instanceof: 'Function',
-      description: 'Callback function when the compilation is done, providing statistics and options.'
+      description: 'Callback function when the compilation is done, providing stats and stats options.'
     }
   },
   additionalProperties: false

package/cjs/server/utils.cjs

@@ -2,7 +2,7 @@
  * @module rspack-dev-middleware
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.4.0
+ * @version 0.4.2
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for rspack development and hot reloading.
  * @see https://github.com/nuintun/rspack-dev-middleware#readme
@@ -38,6 +38,16 @@ function getCompilers(compiler) {
   }
   return [compiler];
 }
+function toStatsPreset(stats) {
+  if (stats == null) {
+    return { preset: 'normal' };
+  } else if (isString(stats)) {
+    return { preset: stats };
+  } else if (isBoolean(stats)) {
+    return stats ? { preset: 'normal' } : { preset: 'none' };
+  }
+  return stats;
+}
 function isMultiCompiler(compiler) {
   return 'compilers' in compiler;
 }
@@ -49,3 +59,4 @@ exports.isBoolean = isBoolean;
 exports.isFunction = isFunction;
 exports.isMultiCompiler = isMultiCompiler;
 exports.isString = isString;
+exports.toStatsPreset = toStatsPreset;

package/cjs/server/utils.d.cts

@@ -9,4 +9,5 @@ export declare function isBoolean(value: unknown): value is boolean;
 export declare function isFunction(value: unknown): value is Function;
 export declare function assertPublicPath(compiler: UnionCompiler): never | void;
 export declare function getCompilers(compiler: UnionCompiler): rspack.Compiler[];
+export declare function toStatsPreset(stats?: rspack.StatsValue): rspack.StatsOptions;
 export declare function isMultiCompiler(compiler: UnionCompiler): compiler is rspack.MultiCompiler;

package/esm/client/HotUpdate.js

@@ -2,7 +2,7 @@
  * @module rspack-dev-middleware
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.4.0
+ * @version 0.4.2
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for rspack development and hot reloading.
  * @see https://github.com/nuintun/rspack-dev-middleware#readme

package/esm/client/client.js

@@ -2,7 +2,7 @@
  * @module rspack-dev-middleware
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.4.0
+ * @version 0.4.2
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for rspack development and hot reloading.
  * @see https://github.com/nuintun/rspack-dev-middleware#readme
@@ -91,7 +91,7 @@ function createClient(options) {
     const ws = new WebSocket(url);
     ws.onmessage = message => {
       const parsed = parseMessage(message);
-      if (parsed) {
+      if (parsed != null) {
         const { action, payload } = parsed;
         switch (action) {
           case 'invalid':

package/esm/client/events.d.ts

@@ -4,13 +4,9 @@
 import { Options } from './client.js';
 import { GetProp } from '../server/interface.js';
 import { Messages } from '../server/hot/Message.js';
-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;
-}
+export type Events = {
+  [E in keyof Messages]: (message: Messages[E], options: Options) => void;
+};
 /**
  * @function on
  * @description Add an event listener callback.

package/esm/client/events.js

@@ -2,7 +2,7 @@
  * @module rspack-dev-middleware
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.4.0
+ * @version 0.4.2
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for rspack development and hot reloading.
  * @see https://github.com/nuintun/rspack-dev-middleware#readme
@@ -26,7 +26,7 @@ const events = {
  */
 function on(event, callback) {
   const callbacks = events[event];
-  if (callbacks) {
+  if (callbacks != null) {
     callbacks.push(callback);
   }
 }
@@ -38,8 +38,8 @@ function on(event, callback) {
  */
 function off(event, callback) {
   const callbacks = events[event];
-  if (callbacks) {
-    if (callback) {
+  if (callbacks != null) {
+    if (callback != null) {
       const index = callbacks.indexOf(callback);
       if (index >= 0) {
         callbacks.splice(index, 1);
@@ -51,7 +51,7 @@ function off(event, callback) {
 }
 function emit(event, message, options) {
   const callbacks = events[event];
-  if (callbacks && callbacks.length > 0) {
+  if (callbacks != null && callbacks.length > 0) {
     for (const callback of callbacks) {
       callback(message, options);
     }

package/esm/client/index.js

@@ -2,7 +2,7 @@
  * @module rspack-dev-middleware
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.4.0
+ * @version 0.4.2
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for rspack development and hot reloading.
  * @see https://github.com/nuintun/rspack-dev-middleware#readme

package/esm/client/main.js

@@ -2,7 +2,7 @@
  * @module rspack-dev-middleware
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.4.0
+ * @version 0.4.2
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for rspack development and hot reloading.
  * @see https://github.com/nuintun/rspack-dev-middleware#readme
@@ -18,7 +18,7 @@ const isTLS = protocol => {
 };
 const getCurrentScript = () => {
   const { currentScript } = document;
-  if (currentScript) {
+  if (currentScript != null) {
     return currentScript;
   }
 };
@@ -35,7 +35,7 @@ const getProtocol = (params, protocol) => {
 const getOrigin = params => {
   const { location } = self;
   const script = getCurrentScript();
-  if (script) {
+  if (script != null) {
     const url = new URL(script.src, location.href);
     const protocol = getProtocol(params, url.protocol);
     return `${protocol}//${url.host}`;

package/esm/client/ui/Overlay.js

@@ -2,13 +2,13 @@
  * @module rspack-dev-middleware
  * @package rspack-dev-middleware
  * @license MIT
- * @version 0.4.0
+ * @version 0.4.2
  * @author nuintun <nuintun@qq.com>
  * @description A koa 2 middleware for rspack development and hot reloading.
  * @see https://github.com/nuintun/rspack-dev-middleware#readme
  */
 
-import { getRootElement, insertCSSString, appendDOMString, ansiToHTML } from './utils.js';
+import { getRootElement, appendStyleSheet, appendMarkup, ansiToHTML, escapeHTML } from './utils.js';
 
 /**
  * @module Overlay
@@ -184,8 +184,8 @@ class Overlay {
   #warningsTitle;
   constructor(name) {
     const root = getRootElement(OVERLAY);
-    insertCSSString(CSS, root);
-    const [dialog] = appendDOMString('text/html', HTML, root);
+    appendStyleSheet(CSS, root);
+    const dialog = appendMarkup('text/html', HTML, root);
     this.#dialog = dialog;
     this.#name = dialog.querySelector(`.${OVERLAY}-name`);
     this.#close = dialog.querySelector(`.${OVERLAY}-close`);
@@ -211,7 +211,7 @@ class Overlay {
       problemTitle.innerText = `${count} ${name}(s)`;
       for (const { moduleName, chunkName, message } of issues) {
         const details = ansiToHTML(message);
-        const filename = moduleName || chunkName || 'unknown';
+        const filename = escapeHTML(moduleName || chunkName || 'unknown');
         html += `<section><em>${name}</em> in ${filename}<pre>${details}</pre></section>`;
       }
       problemList.innerHTML = html;