vite-plugin-mock-dev-server 1.1.4 → 1.1.6

package/dist/index.d.ts

@@ -3,21 +3,35 @@ import http from 'node:http';
 import { Readable } from 'node:stream';
 import Cookies from 'cookies';
 import formidable from 'formidable';
+import { WebSocketServer } from 'ws';
 import EventEmitter from 'node:events';
 import chokidar from 'chokidar';
 
 interface MockServerPluginOptions {
     /**
-     * To configure the path matching rules for mock services,
+     * To configure the path matching rules for http mock services,
      * any request path starting with prefix will be intercepted and proxied.
      * If the prefix starts with `^`, it will be recognized as a `RegExp`.
      *
-     * 为 mock 服务配置 路径匹配规则，任何请求路径以 prefix 开头的都将被拦截代理。
+     * 为 http mock 服务配置 路径匹配规则，任何请求路径以 prefix 开头的都将被拦截代理。
      * 如果 prefix 以 `^` 开头，将被识别为 `RegExp`。
      * @default []
      * @example ['^/api']
      */
     prefix?: string | string[];
+    /**
+     * Configure path matching rules for WebSocket mock service.
+     * Any ws/wss requests with a request path starting with wsPrefix
+     * will be intercepted by the proxy.
+     * If wsPrefix starts with `^`, it will be recognized as a `RegExp`.
+     *
+     * 为 websocket mock 服务配置 路径匹配规则， 任何请求路径以 wsPrefix 开头的 ws/wss请求，
+     * 都将被代理拦截。
+     * 如果 wsPrefix 以 `^` 开头，将被识别为 `RegExp`。
+     * @default []
+     * @example ['/socket.io']
+     */
+    wsPrefix?: string | string[];
     /**
      * glob string matching mock includes files
      *
@@ -128,7 +142,7 @@ type ResponseHeaderFn = (request: MockRequest) => Headers | Promise<Headers>;
 type CookieValue = string | [string, Cookies.SetOption];
 type ResponseCookies = Record<string, CookieValue>;
 type ResponseCookiesFn = (request: MockRequest) => ResponseCookies | Promise<ResponseCookies>;
-interface MockOptionsItem {
+interface MockBaseItem {
     /**
      * The interface address that needs to be mocked,
      * supported by `path-to-regexp` for path matching.
@@ -144,23 +158,33 @@ interface MockOptionsItem {
      */
     url: string;
     /**
-     * The interface allows request methods, and by default allows both GET and POST.
+     * Enable WebSocket interface simulation
      *
-     * 该接口允许的 请求方法，默认同时支持 GET 和 POST
-     * @default ['POST','GET']
+     * 开启 websocket 接口模拟
+     *
+     * @default false
      */
-    method?: Method | Method[];
+    ws?: boolean;
     /**
      * Whether to enable mock for this interface.
      * In most scenarios, we only need to mock some interfaces instead of all requests that
      * have been configured with mock.
      * Therefore, it is important to be able to configure whether to enable it or not.
      *
-     * 是否启动对该接口的mock，在多数场景下，我们进需要对部分接口进行 mock，
+     * 是否启动对该接口的mock，在多数场景下，我们仅需要对部分接口进行 mock，
      * 而不是对所有配置了mock的请求进行全量mock，所以是否能够配置是否启用很重要
      * @default true
      */
     enabled?: boolean;
+}
+interface MockHttpItem extends MockBaseItem {
+    /**
+     * The interface allows request methods, and by default allows both GET and POST.
+     *
+     * 该接口允许的 请求方法，默认同时支持 GET 和 POST
+     * @default ['POST','GET']
+     */
+    method?: Method | Method[];
     /**
      * Configure the response body headers
      *
@@ -330,11 +354,35 @@ interface MockOptionsItem {
      * ```
      */
     validator?: Partial<Omit<ExtraRequest, 'getCookie'>> | ((request: ExtraRequest) => boolean);
+    ws?: false;
+}
+type MockWebsocketServerDestroy = (() => void) | void;
+interface MockWebsocketItem extends MockBaseItem {
+    ws: true;
+    /**
+     * Configure Websocket Server
+     *
+     * 配置 Websocket Server
+     * @example
+     * ```ts
+     * export default {
+     *   ws: true
+     *   setup: (wss) => {
+     *     wss.on('connection', (ws,req) => {
+     *       ws.on('message', (raw) => console.log(raw))
+     *       ws.send(JSON.stringify({ type: 'connected' }))
+     *     })
+     *     wss.on('error', (error) => console.error(error))
+     *   }
+     * }
+     * ```
+     */
+    setup: (wss: WebSocketServer) => MockWebsocketServerDestroy;
 }
-type MockOptions = MockOptionsItem[];
+type MockOptions = (MockHttpItem | MockWebsocketItem)[];
 type FormidableFile = formidable.File | formidable.File[];
 
-declare function mockDevServerPlugin({ prefix, include, exclude, reload, formidableOptions, build, cookiesOptions, }?: MockServerPluginOptions): Plugin[];
+declare function mockDevServerPlugin({ prefix, wsPrefix, include, exclude, reload, formidableOptions, build, cookiesOptions, }?: MockServerPluginOptions): Plugin[];
 
 /**
  * mock config helper
@@ -351,8 +399,9 @@ declare function mockDevServerPlugin({ prefix, include, exclude, reload, formida
  * })
  * ```
  */
-declare function defineMock(config: MockOptionsItem): MockOptionsItem;
+declare function defineMock(config: MockHttpItem): MockHttpItem;
 declare function defineMock(config: MockOptions): MockOptions;
+declare function defineMock(config: MockWebsocketItem): MockWebsocketItem;
 /**
  * 返回一个自定义的 defineMock 函数，用于支持对 mock config 的预处理。
  *
@@ -360,7 +409,7 @@ declare function defineMock(config: MockOptions): MockOptions;
  *
  * @param transformer preprocessing function
  */
-declare function createDefineMock(transformer: (mock: MockOptionsItem) => MockOptionsItem | void): typeof defineMock;
+declare function createDefineMock(transformer: (mock: MockHttpItem | MockWebsocketItem) => MockHttpItem | MockWebsocketItem | void): typeof defineMock;
 
 interface MockLoaderOptions {
     cwd?: string;
@@ -374,8 +423,7 @@ interface MockLoaderOptions {
  */
 declare class MockLoader extends EventEmitter {
     options: MockLoaderOptions;
-    static EXT_JSON: RegExp;
-    moduleCache: Map<string, MockOptions | MockOptionsItem>;
+    moduleCache: Map<string, MockOptions | MockHttpItem | MockWebsocketItem>;
     moduleDeps: Map<string, Set<string>>;
     cwd: string;
     mockWatcher: chokidar.FSWatcher;
@@ -395,8 +443,6 @@ declare class MockLoader extends EventEmitter {
     private updateMockList;
     private updateModuleDeps;
     private loadMock;
-    private loadJson;
-    private loadModule;
     private loadFromCode;
     private transformWithEsbuild;
 }
@@ -408,6 +454,8 @@ interface BaseMiddlewareOptions {
 }
 declare function baseMiddleware(mockLoader: MockLoader, { formidableOptions, proxies, cookiesOptions }: BaseMiddlewareOptions): Connect.NextHandleFunction;
 
-declare function transformMockData(mockList: Map<string, MockOptionsItem | MockOptions> | (MockOptionsItem | MockOptions)[]): Record<string, MockOptions>;
+declare function mockWebSocket(loader: MockLoader, httpServer: http.Server | null, proxies: string[], cookiesOptions: MockServerPluginOptions['cookiesOptions']): void;
+
+declare function transformMockData(mockList: Map<string, MockHttpItem | MockWebsocketItem | MockOptions> | (MockHttpItem | MockWebsocketItem | MockOptions)[]): Record<string, MockOptions>;
 
-export { BaseMiddlewareOptions, FormidableFile, MockOptions, MockOptionsItem, MockServerPluginOptions, baseMiddleware, createDefineMock, mockDevServerPlugin as default, defineMock, mockDevServerPlugin, transformMockData };
+export { BaseMiddlewareOptions, FormidableFile, MockHttpItem, MockOptions, MockRequest, MockServerPluginOptions, MockWebsocketItem, baseMiddleware, createDefineMock, mockDevServerPlugin as default, defineMock, mockDevServerPlugin, mockWebSocket, transformMockData };