webpack-dev-service 0.13.2 → 0.14.0

package/README.md

@@ -15,28 +15,28 @@
 ```ts
 /**
  * @module webpack
- * @description Webpack config
+ * @description Webpack config.
  */
 
 import Koa from 'koa';
-import path from 'path';
 import memfs from 'memfs';
+import path from 'node:path';
 import webpack from 'webpack';
 import compress from 'koa-compress';
-import dev from 'webpack-dev-service';
 import HtmlWebpackPlugin from 'html-webpack-plugin';
+import { server as dev } from 'webpack-dev-service';
 import MiniCssExtractPlugin from 'mini-css-extract-plugin';
 
 const progress = {
   percentBy: 'entries'
 };
 
-const entryHTML = path.resolve('public/index.html');
+const entryHTML = path.resolve('wwwroot/index.html');
 
 const html = {
   xhtml: true,
   minify: false,
-  title: 'React',
+  title: 'Webpack',
   filename: entryHTML,
   templateParameters: { lang: 'en' },
   template: path.resolve('index.ejs'),
@@ -56,15 +56,15 @@ function httpError(error) {
 }
 
 const compiler = webpack({
-  name: 'react',
+  name: 'React',
   mode: 'development',
   context: path.resolve('src'),
   entry: path.resolve('src/index.tsx'),
   output: {
     publicPath: '/public/',
     filename: `js/[name].js`,
-    path: path.resolve('public'),
     chunkFilename: `js/[name].js`,
+    path: path.resolve('wwwroot/public'),
     assetModuleFilename: `[path][name][ext]`
   },
   devtool: 'eval-cheap-module-source-map',
@@ -136,8 +136,9 @@ const compiler = webpack({
                   esModule: true,
                   modules: {
                     auto: true,
+                    namedExport: false,
                     localIdentName: '[local]-[hash:8]',
-                    exportLocalsConvention: 'camelCaseOnly'
+                    exportLocalsConvention: 'camel-case-only'
                   }
                 }
               }

package/cjs/client/client.cjs

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.13.2
+ * @version 0.14.0
  * @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
@@ -9,9 +9,9 @@
 
 'use strict';
 
+const events = require('./events.cjs');
 const Overlay = require('./ui/Overlay.cjs');
 const Progress = require('./ui/Progress.cjs');
-const events = require('./events.cjs');
 const hot = require('./hot.cjs');
 
 /**
@@ -48,7 +48,7 @@ function createClient(options) {
     }
   };
   const onHash = ({ hash }) => {
-    hot.setHash(hash);
+    hot.updateHash(hash);
   };
   const setIssues = (type, issues) => {
     if (options.overlay) {
@@ -116,15 +116,30 @@ function createClient(options) {
         events.emit(action, payload, options);
       }
     };
-    ws.onclose = () => {
+    ws.onclose = event => {
       overlay.hide();
       progress.hide();
-      setTimeout(() => {
-        createWebSocket(url);
-      }, RETRY_INTERVAL);
+      switch (event.code) {
+        case 4000:
+        case 4001:
+          fallback();
+          break;
+        default:
+          if (!event.wasClean) {
+            setTimeout(() => {
+              createWebSocket(url);
+            }, RETRY_INTERVAL);
+          }
+          break;
+      }
     };
   };
-  createWebSocket(`${options.origin}${options.path}`);
+  const { uuid } = options;
+  const input = new URL(`${options.origin}${options.path}`);
+  if (uuid) {
+    input.searchParams.set('uuid', uuid);
+  }
+  createWebSocket(input.href);
 }
 
-module.exports = createClient;
+exports.createClient = createClient;

package/cjs/client/client.d.cts

@@ -0,0 +1,14 @@
+/**
+ * @module client
+ */
+export interface Options {
+  readonly hmr: boolean;
+  readonly name: string;
+  readonly path: string;
+  readonly origin: string;
+  readonly reload: boolean;
+  readonly overlay: boolean;
+  readonly progress: boolean;
+  readonly uuid: string | null;
+}
+export declare function createClient(options: Options): void;

package/cjs/client/events.cjs

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.13.2
+ * @version 0.14.0
  * @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/cjs/client/events.d.cts

@@ -0,0 +1,28 @@
+/**
+ * @module events
+ */
+import { Options } from './client.cjs';
+import { GetProp } from '../server/interface.cjs';
+import { Messages } from '../server/hot/Message.cjs';
+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
+ * @description Add an event listener callback.
+ * @param event Event name.
+ * @param callback Event listener callback.
+ */
+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?: GetProp<Events, E>): void;
+export declare function emit<E extends keyof Events>(event: E, message: GetProp<Messages, E>, options: Options): void;

package/cjs/client/hot.cjs

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.13.2
+ * @version 0.14.0
  * @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
@@ -28,24 +28,24 @@ function isUpdateAvailable() {
   return hash !== __webpack_hash__;
 }
 /**
- * @function setHash
- * @description Set webpack hash.
- * @param value The new hash value.
- */
-function setHash(value) {
-  hash = value;
-}
-/**
- * @function setStatus
- * @description Set hot status.
+ * @function updateStatus
+ * @description Update hot status.
  * @param value The new status of the hot update.
  */
-function setStatus(value) {
+function updateStatus(value) {
   status = value;
 }
 // Initialize status.
 if (module.hot) {
-  setStatus(module.hot.status());
+  updateStatus(module.hot.status());
+}
+/**
+ * @function updateHash
+ * @description Update webpack hash.
+ * @param value The new hash value.
+ */
+function updateHash(value) {
+  hash = value;
 }
 /**
  * @function applyUpdate
@@ -60,14 +60,14 @@ function applyUpdate(hmr, fallback) {
     if (hmr && module.hot) {
       switch (status) {
         case 'idle':
-          // Set status.
-          setStatus('check');
+          // Update status.
+          updateStatus('check');
           // Auto check and apply updates.
           module.hot
             .check(true)
             .then(updated => {
               // Update status.
-              setStatus(module.hot.status());
+              updateStatus(module.hot.status());
               // When updated modules is available,
               // it indicates server is ready to serve new bundle.
               if (updated) {
@@ -82,9 +82,9 @@ function applyUpdate(hmr, fallback) {
               switch (status) {
                 case 'fail':
                 case 'abort':
-                  setStatus(status);
+                  updateStatus(status);
                 default:
-                  setStatus('fail');
+                  updateStatus('fail');
               }
               // Cache error.
               error = exception;
@@ -106,6 +106,4 @@ function applyUpdate(hmr, fallback) {
 }
 
 exports.applyUpdate = applyUpdate;
-exports.isUpdateAvailable = isUpdateAvailable;
-exports.setHash = setHash;
-exports.setStatus = setStatus;
+exports.updateHash = updateHash;

package/cjs/client/hot.d.cts

@@ -0,0 +1,16 @@
+/**
+ * @module hot
+ */
+/**
+ * @function updateHash
+ * @description Update webpack hash.
+ * @param value The new hash value.
+ */
+export declare function updateHash(value: string): void;
+/**
+ * @function applyUpdate
+ * @description Apply update.
+ * @param hmr Whether to enable HMR.
+ * @param fallback Fallback function when HMR fail.
+ */
+export declare function applyUpdate(hmr: boolean, fallback: (error?: Error) => void): void;

package/cjs/client/index.cjs

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.13.2
+ * @version 0.14.0
  * @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/cjs/client/index.d.cts

@@ -0,0 +1,4 @@
+/**
+ * @module index
+ */
+export { off, on } from './events.cjs';

package/cjs/client/main.cjs

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.13.2
+ * @version 0.14.0
  * @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
@@ -47,13 +47,14 @@ const getOrigin = params => {
 const getOptions = () => {
   const params = new URLSearchParams(__resourceQuery);
   return {
+    uuid: params.get('uuid'),
     origin: getOrigin(params),
     hmr: params.get('hmr') !== 'false',
     path: params.get('path') || '/hot',
-    name: params.get('name') || 'webpack',
+    name: params.get('name') || 'rspack',
     reload: params.get('reload') !== 'false',
     overlay: params.get('overlay') !== 'false',
     progress: params.get('progress') !== 'false'
   };
 };
-client(getOptions());
+client.createClient(getOptions());

package/cjs/client/main.d.cts

@@ -0,0 +1,4 @@
+/**
+ * @module main
+ */
+export {};

package/cjs/client/ui/Overlay.cjs

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.13.2
+ * @version 0.14.0
  * @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/cjs/client/ui/Overlay.d.cts

@@ -0,0 +1,12 @@
+/**
+ * @module overlay
+ * @see https://github.com/shellscape/webpack-plugin-serve
+ */
+import webpack from 'webpack';
+export declare class Overlay {
+  #private;
+  constructor(name: string);
+  setIssues(type: 'errors' | 'warnings', issues: webpack.StatsError[]): void;
+  show(): void;
+  hide(): void;
+}

package/cjs/client/ui/Progress.cjs

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.13.2
+ * @version 0.14.0
  * @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/cjs/client/ui/Progress.d.cts

@@ -0,0 +1,12 @@
+/**
+ * @module progress
+ * @see https://github.com/shellscape/webpack-plugin-serve
+ * @see https://www.zhangxinxu.com/wordpress/2015/07/svg-circle-loading
+ */
+export declare class Progress {
+  #private;
+  constructor();
+  update(percentage: number): void;
+  show(): void;
+  hide(): void;
+}

package/cjs/client/ui/utils.cjs

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.13.2
+ * @version 0.14.0
  * @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/cjs/client/ui/utils.d.cts

@@ -0,0 +1,15 @@
+/**
+ * @module utils
+ */
+import { AnsiBlock } from '@nuintun/ansi';
+export declare function escapeHTML(text: string): string;
+export declare function blockToHTML({ style, value, url }: AnsiBlock): string;
+export declare function ansiToHTML(text: string): string;
+export type RootElement = HTMLElement | ShadowRoot;
+export declare function getRootElement(tagName: string): ShadowRoot;
+export declare function injectCSS(
+  css: string,
+  root?: HTMLElement | ShadowRoot,
+  styleElement?: HTMLStyleElement
+): HTMLStyleElement;
+export declare function appendHTML(html: string, root?: RootElement): ChildNode[];

package/cjs/server/compose.cjs

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.13.2
+ * @version 0.14.0
  * @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
@@ -14,11 +14,12 @@
  */
 /**
  * @function dispatch
- * @param middlewares 中间件数组
- * @param index 要执行的中间件索引
- * @param stack 调用栈信息
- * @param context 执行上下文
- * @param [next] 下一个中间件
+ * @description Dispatch middlewares.
+ * @param middlewares The middlewares list.
+ * @param index The current middleware index.
+ * @param stack The call stack.
+ * @param context The execution context.
+ * @param next The next middleware.
  */
 async function dispatch(middlewares, index, stack, context, next) {
   if (index <= stack.index) {
@@ -37,15 +38,15 @@ async function dispatch(middlewares, index, stack, context, next) {
 }
 /**
  * @function compose
- * @description 生成融合中间件
- * @param middlewares 中间件数组
+ * @description Compose middlewares.
+ * @param middlewares The middlewares list.
  */
 function compose(...middlewares) {
   /**
-   * @function middleware
-   * @description 融合中间件
-   * @param context 执行上下文
-   * @param [next] 下一个中间件
+   * @function compose
+   * @description Compose middlewares.
+   * @param context The execution context.
+   * @param next The next middleware.
    */
   return (context, next) => {
     const stack = { index: -1 };

package/cjs/server/compose.d.cts

@@ -0,0 +1,18 @@
+/**
+ * @module compose
+ */
+export interface Next {
+  (): Promise<void>;
+}
+export interface Composed<C> {
+  (context: C, next?: Next): Promise<void>;
+}
+export interface Middleware<C> {
+  (context: C, next: Next): Promise<void> | void;
+}
+/**
+ * @function compose
+ * @description Compose middlewares.
+ * @param middlewares The middlewares list.
+ */
+export declare function compose<C>(...middlewares: Middleware<C>[]): Composed<C>;

package/cjs/server/dev/ReadStream.cjs

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.13.2
+ * @version 0.14.0
  * @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/cjs/server/dev/ReadStream.d.cts

@@ -0,0 +1,43 @@
+/**
+ * @module ReadStream
+ */
+import { PathLike } from 'node:fs';
+import { Range } from './utils/http.cjs';
+import { FileSystem } from './utils/fs.cjs';
+import { Readable, ReadableOptions } from 'node:stream';
+export interface Options extends Pick<ReadableOptions, 'highWaterMark'> {
+  fs: FileSystem;
+}
+interface Callback {
+  (error?: Error | null): void;
+}
+export declare class ReadStream extends Readable {
+  #private;
+  /**
+   * @constructor
+   * @param path The file path.
+   * @param ranges The ranges to read.
+   * @param options The stream options.
+   */
+  constructor(path: PathLike, ranges: Range[], options: Options);
+  /**
+   * @override
+   * @method _construct
+   * @param callback The callback.
+   */
+  _construct(callback: Callback): void;
+  /**
+   * @override
+   * @method _read
+   * @param size The number of bytes to read.
+   */
+  _read(size: number): void;
+  /**
+   * @override
+   * @method _destroy
+   * @param error The error.
+   * @param callback The callback.
+   */
+  _destroy(error: Error | null, callback: Callback): void;
+}
+export {};

package/cjs/server/dev/Service.cjs

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.13.2
+ * @version 0.14.0
  * @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/cjs/server/dev/Service.d.cts

@@ -0,0 +1,48 @@
+/**
+ * @module Service
+ */
+import { Context } from 'koa';
+import { Stats } from 'node:fs';
+import { FileSystem } from './utils/fs.cjs';
+interface IgnoreFunction {
+  (path: string): boolean;
+}
+interface Headers {
+  [key: string]: string | string[];
+}
+type FileStats = Stats | null | undefined;
+interface HeadersFunction {
+  (path: string, stats: FileStats): Promise<Headers | void> | Headers | void;
+}
+export interface Options {
+  fs: FileSystem;
+  etag?: boolean;
+  acceptRanges?: boolean;
+  lastModified?: boolean;
+  highWaterMark?: number;
+  ignore?: IgnoreFunction;
+  headers?: Headers | HeadersFunction;
+}
+/**
+ * @class Service
+ */
+export declare class Service {
+  #private;
+  /**
+   * @constructor
+   * @description Create file service.
+   * @param root The file service root.
+   * @param options The file service options.
+   */
+  constructor(root: string, options: Options);
+  /**
+   * @public
+   * @method respond
+   * @description Respond file.
+   * @param pathname The pathname.
+   * @param context The koa context.
+   * @param publicPath The public path.
+   */
+  respond(pathname: string, context: Context, publicPath: string): Promise<boolean>;
+}
+export {};

package/cjs/server/dev/index.cjs

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.13.2
+ * @version 0.14.0
  * @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/cjs/server/dev/index.d.cts

@@ -0,0 +1,8 @@
+/**
+ * @module index
+ */
+import { Middleware } from 'koa';
+import { UnionCompiler } from '../interface.cjs';
+import { Expose, Options } from './interface.cjs';
+export { Expose, Options };
+export declare function dev(compiler: UnionCompiler, options: Options): Middleware & Expose;

package/cjs/server/dev/interface.d.cts

@@ -0,0 +1,38 @@
+/**
+ * @module interface
+ */
+import webpack from 'webpack';
+import { FileSystem } from './utils/fs.cjs';
+import { Options as ServiceOptions, Service } from './Service.cjs';
+import { Logger, Optional, StatsOptions, UnionCompiler, UnionStats, UnionWatching } from '../interface.cjs';
+export interface Callback {
+  (stats: UnionStats): void;
+}
+export interface ErrorCallback {
+  (error?: Error | null): void;
+}
+export interface Expose {
+  readonly logger: Logger;
+  readonly state: boolean;
+  readonly ready: (callback: Callback) => void;
+  readonly close: (callback: ErrorCallback) => void;
+  readonly invalidate: (callback: ErrorCallback) => void;
+}
+export type FileService = [publicPath: string, service: Service];
+export interface Options extends Optional<ServiceOptions, 'fs'> {
+  stats?: StatsOptions;
+  writeToDisk?: boolean | ((targetPath: string) => boolean);
+  onCompilationDone?: (stats: UnionStats, statsOptions: Readonly<webpack.StatsOptions>) => void;
+}
+export interface Context {
+  logger: Logger;
+  callbacks: Callback[];
+  compiler: UnionCompiler;
+  watching: UnionWatching;
+  services?: FileService[];
+  stats: UnionStats | null;
+  options: Options & {
+    fs: FileSystem;
+  };
+}
+export type InitialContext = Optional<Context, 'watching'>;

package/cjs/server/dev/middleware.cjs

@@ -1,7 +1,7 @@
 /**
  * @package webpack-dev-service
  * @license MIT
- * @version 0.13.2
+ * @version 0.14.0
  * @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/cjs/server/dev/middleware.d.cts

@@ -0,0 +1,6 @@
+/**
+ * @module middleware
+ */
+import { Middleware } from 'koa';
+import { Context } from './interface.cjs';
+export declare function middleware(context: Context): Middleware;