vite-plugin-mock-dev-server 1.3.4 → 1.4.1

package/dist/index.d.cts

@@ -1,6 +1,6 @@
 import { Connect, Plugin, ResolvedConfig } from 'vite';
 import { Buffer } from 'node:buffer';
-import http from 'node:http';
+import http, { Server } from 'node:http';
 import { Readable } from 'node:stream';
 import Cookies from 'cookies';
 import { CorsOptions } from 'cors';
@@ -8,6 +8,7 @@ import formidable from 'formidable';
 import { WebSocketServer } from 'ws';
 import EventEmitter from 'node:events';
 import chokidar from 'chokidar';
+import { Http2SecureServer } from 'node:http2';
 
 /**
  * Configure plugin
@@ -133,7 +134,7 @@ interface MockMatchPriority {
      * as it will prevent subsequent rules from taking effect.
      * Unless you are clear about the priority of the rules,
      * most of the time you do not need to configure this option.
-  
+     *
      * 匹配规则优先级, 全局生效。
      * 声明在该选项中的规则将优先于默认规则生效。
      * 规则在数组越靠前的位置，优先级越高。
@@ -150,6 +151,23 @@ interface MockMatchPriority {
      *
      * 对于一些特殊情况，需要调整部分规则的优先级，可以使用此选项。
      * 比如一个请求同时命中了规则 A 和 B，且 A 比 B 优先级高， 但期望规则 B 生效时。
+     *
+     * @example
+     * ```ts
+     * {
+     *   special: {
+     *     // /api/a/:b/c 优先级将提升到 /api/a/b/:c 前面
+     *     // The /api/a/:b/c priority is promoted to /api/a/b/:c
+     *     '/api/a/:b/c': ['/api/a/b/:c'],
+     *     // 仅在请求满足 /api/a/b/c 时生效
+     *     // Only when the request satisfies /api/a/b/c
+     *     '/api/:a/b/c': {
+     *        rules: ['/api/a/:b/c'],
+     *        when: ['/api/a/b/c']
+     *      }
+     *   }
+     * }
+     * ```
      */
     special?: MockMatchSpecialPriority;
 }
@@ -159,7 +177,7 @@ interface MockMatchSpecialPriority {
      * insert A into the top position.The `when` option is used to further constrain
      * the priority adjustment to be effective only for certain requests.
      *
-     * 当 A 与 B或 C 同时满足匹配，且 B或 C在排序首位时，将A插入到首位。
+     * 当 A 与 B或 C 同时满足匹配，`B` 或 `C` 在排序首位时，将A插入到首位。
      * when 选项用于进一步约束该优先级调整仅针对哪些请求有效。
      *
      * @example
@@ -262,6 +280,7 @@ interface MockBaseItem {
      * /api/login
      * /api/post/:id
      * /api/post/:id
+     * /api/anything/(.*)
      * ```
      */
     url: string;
@@ -523,13 +542,17 @@ type FormidableFile = formidable.File | formidable.File[];
 type LogType = 'info' | 'warn' | 'error' | 'debug';
 type LogLevel = LogType | 'silent';
 
+/** @deprecated The CJS build of Vite's Node API is deprecated. See https://vitejs.dev/guide/troubleshooting.html#vite-cjs-node-api-deprecated for more details. */
 declare function mockDevServerPlugin({ prefix, wsPrefix, include, exclude, reload, log, cors, formidableOptions, build, cookiesOptions, priority, }?: MockServerPluginOptions): Plugin[];
 
 /**
  * mock config Type helper
  *
  * mock配置 类型帮助函数
- * @param config
+ * @param config see config docs:
+ * {@link https://vite-plugin-mock-dev-server.netlify.app/en/guide/mock-config en-US DOC} |
+ * {@link https://vite-plugin-mock-dev-server.netlify.app/guide/mock-config zh-CN DOC}
+ *
  * @example
  * Mock Http Request
  * ```ts
@@ -539,6 +562,13 @@ declare function mockDevServerPlugin({ prefix, wsPrefix, include, exclude, reloa
  *   body: { a: 1 },
  * })
  * ```
+ * ```ts
+ * export default defineMock({
+ *   url: '/api/example',
+ *   method: 'GET',
+ *   body: ({ query }) => ({ a: 1, b: query.b }),
+ * })
+ * ```
  * @example
  * Mock WebSocket
  * ```ts
@@ -585,9 +615,6 @@ type MockData<T = any> = readonly [
      */
     (val: T | ((val: T) => T | void)) => void
 ] & {
-    /**
-     * @property getter/setter
-     */
     value: T;
 };
 declare function defineMockData<T = any>(key: string, initialData: T): MockData<T>;
@@ -598,6 +625,8 @@ interface Logger {
     warn(msg: string, level?: boolean | LogLevel): void;
     error(msg: string, level?: boolean | LogLevel): void;
 }
+declare const logLevels: Record<LogLevel, number>;
+declare function createLogger(prefix: string, defaultLevel?: LogLevel): Logger;
 
 interface MockLoaderOptions {
     cwd?: string;
@@ -656,7 +685,7 @@ declare function baseMiddleware(mockLoader: MockLoader, { formidableOptions, pro
 
 interface MockSocketOptions {
     loader: MockLoader;
-    httpServer: http.Server | null;
+    httpServer: Server | Http2SecureServer | null;
     proxies: string[];
     cookiesOptions: MockServerPluginOptions['cookiesOptions'];
     logger: Logger;
@@ -666,4 +695,4 @@ declare function mockWebSocket({ loader, httpServer, proxies, cookiesOptions, lo
 declare function transformMockData(mockList: Map<string, MockHttpItem | MockWebsocketItem | MockOptions> | (MockHttpItem | MockWebsocketItem | MockOptions)[]): Record<string, MockOptions>;
 declare function sortByValidator(mocks: MockOptions): (MockHttpItem | MockWebsocketItem)[];
 
-export { BaseMiddlewareOptions, FormidableFile, MockData, MockHttpItem, MockOptions, MockRequest, MockServerPluginOptions, MockSocketOptions, MockWebsocketItem, baseMiddleware, createDefineMock, mockDevServerPlugin as default, defineMock, defineMockData, mockDevServerPlugin, mockWebSocket, sortByValidator, transformMockData };
+export { type BaseMiddlewareOptions, type FormidableFile, type Logger, type MockData, type MockHttpItem, type MockOptions, type MockRequest, type MockServerPluginOptions, type MockSocketOptions, type MockWebsocketItem, baseMiddleware, createDefineMock, createLogger, mockDevServerPlugin as default, defineMock, defineMockData, logLevels, mockDevServerPlugin, mockWebSocket, sortByValidator, transformMockData };

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { Connect, Plugin, ResolvedConfig } from 'vite';
 import { Buffer } from 'node:buffer';
-import http from 'node:http';
+import http, { Server } from 'node:http';
 import { Readable } from 'node:stream';
 import Cookies from 'cookies';
 import { CorsOptions } from 'cors';
@@ -8,6 +8,7 @@ import formidable from 'formidable';
 import { WebSocketServer } from 'ws';
 import EventEmitter from 'node:events';
 import chokidar from 'chokidar';
+import { Http2SecureServer } from 'node:http2';
 
 /**
  * Configure plugin
@@ -133,7 +134,7 @@ interface MockMatchPriority {
      * as it will prevent subsequent rules from taking effect.
      * Unless you are clear about the priority of the rules,
      * most of the time you do not need to configure this option.
-  
+     *
      * 匹配规则优先级, 全局生效。
      * 声明在该选项中的规则将优先于默认规则生效。
      * 规则在数组越靠前的位置，优先级越高。
@@ -150,6 +151,23 @@ interface MockMatchPriority {
      *
      * 对于一些特殊情况，需要调整部分规则的优先级，可以使用此选项。
      * 比如一个请求同时命中了规则 A 和 B，且 A 比 B 优先级高， 但期望规则 B 生效时。
+     *
+     * @example
+     * ```ts
+     * {
+     *   special: {
+     *     // /api/a/:b/c 优先级将提升到 /api/a/b/:c 前面
+     *     // The /api/a/:b/c priority is promoted to /api/a/b/:c
+     *     '/api/a/:b/c': ['/api/a/b/:c'],
+     *     // 仅在请求满足 /api/a/b/c 时生效
+     *     // Only when the request satisfies /api/a/b/c
+     *     '/api/:a/b/c': {
+     *        rules: ['/api/a/:b/c'],
+     *        when: ['/api/a/b/c']
+     *      }
+     *   }
+     * }
+     * ```
      */
     special?: MockMatchSpecialPriority;
 }
@@ -159,7 +177,7 @@ interface MockMatchSpecialPriority {
      * insert A into the top position.The `when` option is used to further constrain
      * the priority adjustment to be effective only for certain requests.
      *
-     * 当 A 与 B或 C 同时满足匹配，且 B或 C在排序首位时，将A插入到首位。
+     * 当 A 与 B或 C 同时满足匹配，`B` 或 `C` 在排序首位时，将A插入到首位。
      * when 选项用于进一步约束该优先级调整仅针对哪些请求有效。
      *
      * @example
@@ -262,6 +280,7 @@ interface MockBaseItem {
      * /api/login
      * /api/post/:id
      * /api/post/:id
+     * /api/anything/(.*)
      * ```
      */
     url: string;
@@ -529,7 +548,10 @@ declare function mockDevServerPlugin({ prefix, wsPrefix, include, exclude, reloa
  * mock config Type helper
  *
  * mock配置 类型帮助函数
- * @param config
+ * @param config see config docs:
+ * {@link https://vite-plugin-mock-dev-server.netlify.app/en/guide/mock-config en-US DOC} |
+ * {@link https://vite-plugin-mock-dev-server.netlify.app/guide/mock-config zh-CN DOC}
+ *
  * @example
  * Mock Http Request
  * ```ts
@@ -539,6 +561,13 @@ declare function mockDevServerPlugin({ prefix, wsPrefix, include, exclude, reloa
  *   body: { a: 1 },
  * })
  * ```
+ * ```ts
+ * export default defineMock({
+ *   url: '/api/example',
+ *   method: 'GET',
+ *   body: ({ query }) => ({ a: 1, b: query.b }),
+ * })
+ * ```
  * @example
  * Mock WebSocket
  * ```ts
@@ -585,9 +614,6 @@ type MockData<T = any> = readonly [
      */
     (val: T | ((val: T) => T | void)) => void
 ] & {
-    /**
-     * @property getter/setter
-     */
     value: T;
 };
 declare function defineMockData<T = any>(key: string, initialData: T): MockData<T>;
@@ -598,6 +624,8 @@ interface Logger {
     warn(msg: string, level?: boolean | LogLevel): void;
     error(msg: string, level?: boolean | LogLevel): void;
 }
+declare const logLevels: Record<LogLevel, number>;
+declare function createLogger(prefix: string, defaultLevel?: LogLevel): Logger;
 
 interface MockLoaderOptions {
     cwd?: string;
@@ -656,7 +684,7 @@ declare function baseMiddleware(mockLoader: MockLoader, { formidableOptions, pro
 
 interface MockSocketOptions {
     loader: MockLoader;
-    httpServer: http.Server | null;
+    httpServer: Server | Http2SecureServer | null;
     proxies: string[];
     cookiesOptions: MockServerPluginOptions['cookiesOptions'];
     logger: Logger;
@@ -666,4 +694,4 @@ declare function mockWebSocket({ loader, httpServer, proxies, cookiesOptions, lo
 declare function transformMockData(mockList: Map<string, MockHttpItem | MockWebsocketItem | MockOptions> | (MockHttpItem | MockWebsocketItem | MockOptions)[]): Record<string, MockOptions>;
 declare function sortByValidator(mocks: MockOptions): (MockHttpItem | MockWebsocketItem)[];
 
-export { BaseMiddlewareOptions, FormidableFile, MockData, MockHttpItem, MockOptions, MockRequest, MockServerPluginOptions, MockSocketOptions, MockWebsocketItem, baseMiddleware, createDefineMock, mockDevServerPlugin as default, defineMock, defineMockData, mockDevServerPlugin, mockWebSocket, sortByValidator, transformMockData };
+export { type BaseMiddlewareOptions, type FormidableFile, type Logger, type MockData, type MockHttpItem, type MockOptions, type MockRequest, type MockServerPluginOptions, type MockSocketOptions, type MockWebsocketItem, baseMiddleware, createDefineMock, createLogger, mockDevServerPlugin as default, defineMock, defineMockData, logLevels, mockDevServerPlugin, mockWebSocket, sortByValidator, transformMockData };