webpack-dev-service 0.14.0 → 0.14.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "webpack-dev-service",
-  "version": "0.14.0",
+  "version": "0.14.1",
   "description": "A koa 2 middleware for webpack development and hot reloading.",
   "type": "module",
   "sideEffects": [
@@ -9,33 +9,19 @@
   ],
   "main": "cjs/server/index.cjs",
   "module": "esm/server/index.js",
-  "types": "types/server/index.d.ts",
   "exports": {
     ".": {
       "import": "./esm/server/index.js",
-      "require": "./cjs/server/index.cjs",
-      "types": "./types/server/index.d.ts"
+      "require": "./cjs/server/index.cjs"
     },
     "./client": {
       "import": "./esm/client/index.js",
-      "require": "./cjs/client/index.cjs",
-      "types": "./types/client/index.d.ts"
-    }
-  },
-  "typesVersions": {
-    "*": {
-      ".": [
-        "./types/server/index.d.ts"
-      ],
-      "client": [
-        "./types/client/index.d.ts"
-      ]
+      "require": "./cjs/client/index.cjs"
     }
   },
   "files": [
     "cjs",
     "esm",
-    "types",
     "global.d.ts"
   ],
   "engines": {
@@ -68,10 +54,10 @@
     "test": "cd tests && node webpack.js",
     "build:cjs": "rollup -c tools/rollup.cjs.js",
     "build:esm": "rollup -c tools/rollup.esm.js",
+    "build:fix-types": "node tools/fix-types.js",
     "format": "prettier --write . --ignore-path .prettierignore",
     "build": "npm run clean && npm run build:main && npm run format",
-    "build:main": "npm run build:cjs && npm run build:esm && npm run build:types",
-    "build:types": "tsc --declaration --emitDeclarationOnly --declarationDir types && node tools/fix-types.js"
+    "build:main": "npm run build:cjs && npm run build:esm && npm run build:fix-types"
   },
   "dependencies": {
     "@nuintun/ansi": "^0.1.1",

package/types/client/client.d.ts

@@ -1,14 +0,0 @@
-/**
- * @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/types/client/events.d.ts

@@ -1,28 +0,0 @@
-/**
- * @module events
- */
-import { Options } from './client';
-import { GetProp } from '/server/interface';
-import { Messages } from '/server/hot/Message';
-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/types/client/hot.d.ts

@@ -1,16 +0,0 @@
-/**
- * @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/types/client/index.d.ts

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

package/types/client/main.d.ts

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

package/types/client/ui/Overlay.d.ts

@@ -1,12 +0,0 @@
-/**
- * @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/types/client/ui/Progress.d.ts

@@ -1,12 +0,0 @@
-/**
- * @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/types/client/ui/utils.d.ts

@@ -1,15 +0,0 @@
-/**
- * @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/types/server/compose.d.ts

@@ -1,18 +0,0 @@
-/**
- * @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/types/server/dev/ReadStream.d.ts

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

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

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

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

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

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

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

@@ -1,24 +0,0 @@
-/**
- * @module fs
- */
-import webpack from 'webpack';
-import fs, { Stats } from 'node:fs';
-import { GetProp } from '/server/interface';
-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/types/server/dev/utils/hash.d.ts

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

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

@@ -1,37 +0,0 @@
-/**
- * @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/types/server/dev/utils/path.d.ts

@@ -1,22 +0,0 @@
-/**
- * @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/types/server/dev/utils/paths.d.ts

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

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

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

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

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

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

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

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

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

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

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

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

@@ -1,49 +0,0 @@
-/**
- * @module message
- */
-import webpack from 'webpack';
-import { GetProp } from '/server/interface';
-export interface Invalid {
-  action: 'invalid';
-  payload: {
-    timestamp: number;
-    path: string | null;
-  };
-}
-export interface Progress {
-  action: 'progress';
-  payload: {
-    status: string;
-    messages: string[];
-    percentage: number;
-  };
-}
-export interface Hash {
-  action: 'hash';
-  payload: {
-    hash: string;
-    timestamp: number;
-  };
-}
-export interface Issues {
-  action: 'issues';
-  payload: {
-    timestamp: number;
-    errors: webpack.StatsError[];
-    warnings: webpack.StatsError[];
-  };
-}
-export interface Ok {
-  action: 'ok';
-  payload: {
-    timestamp: number;
-  };
-}
-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/types/server/hot/Socket.d.ts

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

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

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

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

@@ -1,22 +0,0 @@
-/**
- * @module interface
- */
-import WebSocket from 'ws';
-import webpack from 'webpack';
-import { RequiredKeys } from '/server/interface';
-export interface Options {
-  hmr?: boolean;
-  path?: string;
-  wss?: boolean;
-  reload?: boolean;
-  overlay?: boolean;
-  progress?: boolean;
-}
-export type Clients = Set<WebSocket>;
-export interface CompilerContext {
-  percentage: number;
-  readonly uuid: string;
-  readonly clients: Clients;
-  stats: Required<webpack.StatsCompilation> | null;
-}
-export type NormalizedOptions = RequiredKeys<Options, 'hmr' | 'path' | 'reload' | 'overlay' | 'progress'>;

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

@@ -1,12 +0,0 @@
-/**
- * @module utils
- */
-import webpack from 'webpack';
-import { Context } from 'koa';
-import { NormalizedOptions, Options } from './interface';
-export declare const BASE_URL = 'wss://127.0.0.1';
-export declare function isUpgradable({ request }: Context): boolean;
-export declare function getOptions(options?: Options): NormalizedOptions;
-export declare function hasIssues<T>(issues: ArrayLike<T> | undefined): boolean;
-export declare function getStatsOptions(compiler: webpack.Compiler): webpack.StatsOptions;
-export declare function getTimestamp({ builtAt, children }: webpack.StatsCompilation): number;

package/types/server/index.d.ts

@@ -1,17 +0,0 @@
-/**
- * @module index
- */
-import { Middleware } from 'koa';
-import { UnionCompiler } from './interface';
-import { Options as HotOptions } from './hot';
-import { Expose, Options as DevOptions } from './dev';
-export type Options = DevOptions & {
-  hot?: HotOptions | false;
-};
-/**
- * @function server
- * @description Create koa dev server middleware.
- * @param compiler The rspack compiler instance.
- * @param options Options.
- */
-export declare function server(compiler: UnionCompiler, options?: Options): Middleware & Expose;

package/types/server/interface.d.ts

@@ -1,14 +0,0 @@
-/**
- * @module interface
- */
-import webpack from 'webpack';
-export type UnionStats = webpack.Stats | webpack.MultiStats;
-export type GetProp<T, P extends keyof T> = NonNullable<T[P]>;
-export type StatsOptions = GetProp<webpack.Configuration, 'stats'>;
-export type UnionCompiler = webpack.Compiler | webpack.MultiCompiler;
-export type RequiredKeys<T, K extends keyof T> = T & {
-  [P in K]-?: T[P];
-};
-export type Logger = ReturnType<GetProp<webpack.Compiler, 'getInfrastructureLogger'>>;
-export type UnionWatching = 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/schema.d.ts

@@ -1,7 +0,0 @@
-/**
- * @module schema
- */
-import { validate } from 'schema-utils';
-type Schema = Parameters<typeof validate>[0];
-export declare const schema: Schema;
-export {};

package/types/server/utils.d.ts

@@ -1,11 +0,0 @@
-/**
- * @module utils
- */
-import webpack from 'webpack';
-import { UnionCompiler } from './interface';
-export declare const PLUGIN_NAME: string;
-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: UnionCompiler): webpack.Compiler[];
-export declare function isMultiCompiler(compiler: UnionCompiler): compiler is webpack.MultiCompiler;