webpack-dev-service 0.13.2 → 0.14.0

package/esm/server/dev/ReadStream.d.ts

@@ -0,0 +1,43 @@
+/**
+ * @module ReadStream
+ */
+import { PathLike } from 'node:fs';
+import { Range } from './utils/http.js';
+import { FileSystem } from './utils/fs.js';
+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/esm/server/dev/ReadStream.js

@@ -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/esm/server/dev/Service.d.ts

@@ -0,0 +1,48 @@
+/**
+ * @module Service
+ */
+import { Context } from 'koa';
+import { Stats } from 'node:fs';
+import { FileSystem } from './utils/fs.js';
+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/esm/server/dev/Service.js

@@ -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/esm/server/dev/index.d.ts

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

package/esm/server/dev/index.js

@@ -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/esm/server/dev/interface.d.ts

@@ -0,0 +1,38 @@
+/**
+ * @module interface
+ */
+import webpack from 'webpack';
+import { FileSystem } from './utils/fs.js';
+import { Options as ServiceOptions, Service } from './Service.js';
+import { Logger, Optional, StatsOptions, UnionCompiler, UnionStats, UnionWatching } from '../interface.js';
+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/esm/server/dev/middleware.d.ts

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

package/esm/server/dev/middleware.js

@@ -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/esm/server/dev/utils/fs.d.ts

@@ -0,0 +1,24 @@
+/**
+ * @module fs
+ */
+import webpack from 'webpack';
+import fs, { Stats } from 'node:fs';
+import { GetProp } from '../../interface.js';
+export interface FileSystem extends GetProp<webpack.Compiler, 'outputFileSystem'> {
+  stat: typeof fs.stat;
+  open: typeof fs.open;
+  read: typeof fs.read;
+  close: typeof fs.close;
+}
+/**
+ * @function createMemfs
+ * @description Create memfs instance.
+ */
+export declare function createMemfs(): FileSystem;
+/**
+ * @function stat
+ * @description Get file stats.
+ * @param fs The file system to used.
+ * @param path The file path.
+ */
+export declare function stat(fs: FileSystem, path: string): Promise<Stats | null>;

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

@@ -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/esm/server/dev/utils/hash.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @module hash
+ */
+/**
+ * @function generate
+ * @description Generate a hash.
+ * @param length The length of hash.
+ */
+export declare function generate(length: number): string;

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

@@ -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/esm/server/dev/utils/http.d.ts

@@ -0,0 +1,37 @@
+/**
+ * @module http
+ */
+import { Context } from 'koa';
+import { Stats } from 'node:fs';
+import { Buffer } from 'node:buffer';
+export interface Range {
+  offset: number;
+  length: number;
+  prefix?: Buffer;
+  suffix?: Buffer;
+}
+/**
+ * @function decodeURI
+ * @description Decode URI component.
+ * @param URI The URI to decode.
+ */
+export declare function decodeURI(URI: string): string | -1;
+/**
+ * @function isConditionalGET
+ * @description Check if request is conditional GET.
+ * @param context The koa context.
+ */
+export declare function isConditionalGET({ request }: Context): boolean;
+/**
+ * @function isPreconditionFailed
+ * @description Check if request precondition failed.
+ * @param context The koa context.
+ */
+export declare function isPreconditionFailed({ request, response }: Context): boolean;
+/**
+ * @function parseRanges
+ * @description Parse ranges.
+ * @param context The koa context.
+ * @param stats The file stats.
+ */
+export declare function parseRanges(context: Context, stats: Stats): Range[] | -1 | -2;

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

@@ -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/esm/server/dev/utils/path.d.ts

@@ -0,0 +1,22 @@
+/**
+ * @module path
+ */
+/**
+ * @function unixify
+ * @description Convert path to unix style.
+ * @param path The path to convert.
+ */
+export declare function unixify(path: string): string;
+/**
+ * @function hasTrailingSlash
+ * @description Check if path has trailing slash.
+ * @param path The path to check.
+ */
+export declare function hasTrailingSlash(path: string): boolean;
+/**
+ * @function isOutRoot
+ * @description Check if path is out of root.
+ * @param path The path to check.
+ * @param root The root path.
+ */
+export declare function isOutRoot(path: string, root: string): boolean;

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

@@ -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/esm/server/dev/utils/paths.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @module paths
+ */
+import { UnionStats } from '../../interface.js';
+type PathsItem = [outputPath: string, publicPath: string];
+export declare function getPaths(stats: UnionStats): PathsItem[];
+export {};

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

@@ -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/esm/server/dev/utils/ready.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @module ready
+ */
+import { Callback, Context } from '../interface.js';
+export declare function ready({ stats, callbacks }: Context, callback: Callback): void;

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

@@ -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/esm/server/dev/utils/setupHooks.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @module setupHooks
+ */
+import { InitialContext } from '../interface.js';
+export declare function setupHooks(context: InitialContext): void;

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

@@ -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
@@ -30,7 +30,7 @@ function normalizeStatsOptions(statsOptions) {
 function getStatsOptions(context) {
   const { compiler } = context;
   const { stats } = context.options;
-  if (stats) {
+  if (stats != null) {
     if (isMultiCompiler(compiler)) {
       return {
         children: compiler.compilers.map(() => {
@@ -55,8 +55,6 @@ function setupHooks(context) {
   const invalid = () => {
     // We are now in invalid state.
     context.stats = null;
-  };
-  const watchRun = () => {
     // Log compilation starting.
     context.logger.log('compilation starting...');
   };
@@ -94,7 +92,6 @@ function setupHooks(context) {
   };
   hooks.done.tap(PLUGIN_NAME, done);
   hooks.invalid.tap(PLUGIN_NAME, invalid);
-  hooks.watchRun.tap(PLUGIN_NAME, watchRun);
 }
 
 export { setupHooks };

package/esm/server/dev/utils/setupOutputFileSystem.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @module setupOutputFileSystem
+ */
+import { InitialContext } from '../interface.js';
+export declare function setupOutputFileSystem(context: InitialContext): void;

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

@@ -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/esm/server/dev/utils/setupWatching.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @module setupWatching
+ */
+import { InitialContext } from '../interface.js';
+export declare function setupWatching(context: InitialContext): void;

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

@@ -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/esm/server/dev/utils/setupWriteToDisk.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @module setupWriteToDisk
+ */
+import { InitialContext } from '../interface.js';
+export declare function setupWriteToDisk(context: InitialContext): void;

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

@@ -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
@@ -15,7 +15,7 @@ import { getCompilers, PLUGIN_NAME, isFunction } from '../../utils.js';
  * @module setupWriteToDisk
  */
 function getCompilerName({ options: { name } }) {
-  return name ? `compiler "${name}": ` : '';
+  return `compiler ${name ? `${name}: ` : ''}`;
 }
 function isAllowWrite(targetPath, filter) {
   return isFunction(filter) ? filter(targetPath) : filter === true;

package/{types/client → esm/server/hot}/Message.d.ts

@@ -2,14 +2,15 @@
  * @module message
  */
 import webpack from 'webpack';
-export interface InvalidMessage {
+import { GetProp } from '../interface.js';
+export interface Invalid {
   action: 'invalid';
   payload: {
-    path: string;
     timestamp: number;
+    path: string | null;
   };
 }
-export interface ProgressMessage {
+export interface Progress {
   action: 'progress';
   payload: {
     status: string;
@@ -17,14 +18,14 @@ export interface ProgressMessage {
     percentage: number;
   };
 }
-export interface HashMessage {
+export interface Hash {
   action: 'hash';
   payload: {
     hash: string;
     timestamp: number;
   };
 }
-export interface IssuesMessage {
+export interface Issues {
   action: 'issues';
   payload: {
     timestamp: number;
@@ -32,10 +33,17 @@ export interface IssuesMessage {
     warnings: webpack.StatsError[];
   };
 }
-export interface OkMessage {
+export interface Ok {
   action: 'ok';
   payload: {
     timestamp: number;
   };
 }
-export type Message = InvalidMessage | ProgressMessage | HashMessage | IssuesMessage | OkMessage;
+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;

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

@@ -0,0 +1,11 @@
+/**
+ * @module Socket
+ */
+import { Context } from 'koa';
+import { UnionCompiler } from '../interface.js';
+import { Options } from './interface.js';
+export declare class Socket {
+  #private;
+  constructor(compiler: UnionCompiler, options?: Options);
+  upgrade(context: Context): boolean;
+}