webpack-dev-service 0.13.3 → 0.14.0

package/types/client/hot.d.ts

@@ -2,22 +2,11 @@
  * @module hot
  */
 /**
- * @function isUpdateAvailable
- * @description Is there a newer version of this code available.
- */
-export declare function isUpdateAvailable(): boolean;
-/**
- * @function setHash
- * @description Set webpack hash.
+ * @function updateHash
+ * @description Update webpack hash.
  * @param value The new hash value.
  */
-export declare function setHash(value: string): void;
-/**
- * @function setStatus
- * @description Set hot status.
- * @param value The new status of the hot update.
- */
-export declare function setStatus(value: HotUpdateStatus): void;
+export declare function updateHash(value: string): void;
 /**
  * @function applyUpdate
  * @description Apply update.

package/types/server/compose.d.ts

@@ -12,7 +12,7 @@ export interface Middleware<C> {
 }
 /**
  * @function compose
- * @description 生成融合中间件
- * @param middlewares 中间件数组
+ * @description Compose middlewares.
+ * @param middlewares The middlewares list.
  */
 export declare function compose<C>(...middlewares: Middleware<C>[]): Composed<C>;

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

@@ -2,7 +2,7 @@
  * @module index
  */
 import { Middleware } from 'koa';
-import { UnionCompiler } from '../../server/interface';
+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

@@ -4,7 +4,7 @@
 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';
+import { Logger, Optional, StatsOptions, UnionCompiler, UnionStats, UnionWatching } from '/server/interface';
 export interface Callback {
   (stats: UnionStats): void;
 }
@@ -18,12 +18,12 @@ export interface Expose {
   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 type FileService = [publicPath: string, service: Service];
 export interface Context {
   logger: Logger;
   callbacks: Callback[];

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

@@ -3,9 +3,8 @@
  */
 import webpack from 'webpack';
 import fs, { Stats } from 'node:fs';
-import { GetProp } from '../../../server/interface';
-type Compiler = webpack.Compiler;
-export interface FileSystem extends GetProp<Compiler, 'outputFileSystem'> {
+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;
@@ -23,4 +22,3 @@ export declare function createMemfs(): FileSystem;
  * @param path The file path.
  */
 export declare function stat(fs: FileSystem, path: string): Promise<Stats | null>;
-export {};

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

@@ -1,7 +1,7 @@
 /**
  * @module paths
  */
-import { UnionStats } from '../../../server/interface';
+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 +1,5 @@
 /**
  * @module ready
  */
-import { Callback, Context } from '../../../server/dev/interface';
+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 +1,5 @@
 /**
  * @module setupHooks
  */
-import { InitialContext } from '../../../server/dev/interface';
+import { InitialContext } from '/server/dev/interface';
 export declare function setupHooks(context: InitialContext): void;

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

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

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

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

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

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

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

@@ -0,0 +1,49 @@
+/**
+ * @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

@@ -2,13 +2,10 @@
  * @module Socket
  */
 import { Context } from 'koa';
-import WebSocket from 'ws';
+import { UnionCompiler } from '/server/interface';
 import { Options } from './interface';
-import { UnionCompiler } from '../../server/interface';
 export declare class Socket {
   #private;
   constructor(compiler: UnionCompiler, options?: Options);
-  clients(): Set<WebSocket>;
   upgrade(context: Context): boolean;
-  broadcast<T>(clients: Set<WebSocket> | WebSocket[], action: string, payload: T): void;
 }

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

@@ -2,7 +2,7 @@
  * @module index
  */
 import { Middleware } from 'koa';
-import { Expose, Options } from './interface';
-import { UnionCompiler } from '../../server/interface';
-export { Expose, Options };
-export declare function hot(compiler: UnionCompiler, options?: Options): Middleware & Expose;
+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

@@ -3,6 +3,7 @@
  */
 import WebSocket from 'ws';
 import webpack from 'webpack';
+import { RequiredKeys } from '/server/interface';
 export interface Options {
   hmr?: boolean;
   path?: string;
@@ -11,10 +12,11 @@ export interface Options {
   overlay?: boolean;
   progress?: boolean;
 }
-export interface PluginFactory {
-  (compiler: webpack.Compiler): webpack.WebpackPluginInstance;
-}
-export interface Expose {
-  readonly clients: () => Set<WebSocket>;
-  readonly broadcast: <T>(clients: Set<WebSocket> | WebSocket[], action: string, payload: T) => void;
+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

@@ -3,10 +3,10 @@
  */
 import webpack from 'webpack';
 import { Context } from 'koa';
-import { Options } from './interface';
-import { UnionCompiler } from '../../server/interface';
+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): Required<Options>;
+export declare function getOptions(options?: Options): NormalizedOptions;
 export declare function hasIssues<T>(issues: ArrayLike<T> | undefined): boolean;
-export declare function getStatsOptions(compiler: UnionCompiler): webpack.StatsOptions;
+export declare function getStatsOptions(compiler: webpack.Compiler): webpack.StatsOptions;
 export declare function getTimestamp({ builtAt, children }: webpack.StatsCompilation): number;

package/types/server/index.d.ts

@@ -3,35 +3,15 @@
  */
 import { Middleware } from 'koa';
 import { UnionCompiler } from './interface';
-import { Expose as HotExpose, Options as HotOptions } from './hot';
-import { Expose as DevExpose, Options as DevOptions } from './dev';
-type DisableHotOptions = DevOptions & {
-  hot: false;
+import { Options as HotOptions } from './hot';
+import { Expose, Options as DevOptions } from './dev';
+export type Options = DevOptions & {
+  hot?: HotOptions | false;
 };
-type EnableHotOptions = DevOptions & {
-  hot?: HotOptions;
-};
-export type DisableHotMiddleware = Middleware & DevExpose;
-export type Options = EnableHotOptions | DisableHotOptions;
-export type EnableHotMiddleware = DisableHotMiddleware & HotExpose;
-/**
- * @function server
- * @description Create koa dev server middleware.
- * @param compiler The webpack compiler instance.
- */
-export default function server(compiler: UnionCompiler): EnableHotMiddleware;
-/**
- * @function server
- * @description Create koa dev server middleware.
- * @param compiler The webpack compiler instance.
- * @param options Options.
- */
-export default function server(compiler: UnionCompiler, options: EnableHotOptions): EnableHotMiddleware;
 /**
  * @function server
  * @description Create koa dev server middleware.
- * @param compiler The webpack compiler instance.
+ * @param compiler The rspack compiler instance.
  * @param options Options.
  */
-export default function server(compiler: UnionCompiler, options: DisableHotOptions): DisableHotMiddleware;
-export {};
+export declare function server(compiler: UnionCompiler, options?: Options): Middleware & Expose;

package/types/server/interface.d.ts

@@ -6,6 +6,9 @@ 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/utils.d.ts

@@ -4,7 +4,6 @@
 import webpack from 'webpack';
 import { UnionCompiler } from './interface';
 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;