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

package/README.md

@@ -30,18 +30,19 @@
 - 🧲 Not injection-based, non-intrusive to client code.
 - 💡 ESModule/commonjs.
 - 🦾 Typescript.
+- 🔥 HMR
 - 🏷 Support `json` / `json5`.
 - 📦 Auto import mock file.
 - 🎨 Support any lib，like `mockjs`，or not use it.
 - 📥 Path rule matching, request parameter matching.
 - ⚙️ Support Enabled/Disabled any one of api mock
-- 🔥 HMR
+- 📀 Supports response body content type such as `text/json/buffer/stream`.
 - ⚖️ Use `server.proxy`
 - 🍕 Support `viteConfig.define` in mock file.
-- ⚓️ Support `resolve.alias` in mock file.
+- ⚓️ Support `viteConfig.resolve.alias` in mock file.
+- 🌈 Support `vite preview` mode.
 - 📤 Support `multipart` content-type，mock upload file.
-- 🍪 Support cookies
-- 🌈 Support `vite preview` mode
+- 📥 Support mock download file.
 - 🗂 Support building small independent deployable mock services.
 
 
@@ -513,7 +514,7 @@ export default defineMock({
 ```ts
 export default defineMock({
   url: '/api/test',
-  status: 504,
+  status: 502,
   statusText: 'Bad Gateway'
 })
 ```
@@ -561,7 +562,7 @@ export default defineMock({
   url: '/api/download',
   // When you are unsure of the type, you can pass in the file name for internal parsing by the plugin.
   type: 'my-app.dmg',
-  body: createReadStream('./my-app.dmg')
+  body: () => createReadStream('./my-app.dmg')
 })
 ```
 ```html

package/README.zh-CN.md

@@ -31,18 +31,19 @@
 - 🧲 非注入式，对客户端代码无侵入
 - 💡 ESModule/commonjs
 - 🦾 Typescript
+- 🔥 热更新
 - 🏷 支持 `json` / `json5` 编写 mock 数据
 - 📦 自动加载 mock 文件
 - 🎨 可选择你喜欢的任意用于生成mock数据库，如 `mockjs`，或者不使用其他库
 - 📥 路径规则匹配，请求参数匹配
 - ⚙️ 随意开启或关闭对某个接口的 mock配置
-- 🔥 热更新
+- - 📀 支持多种响应体数据类型，包括 `text/json/buffer/stream`.
 - ⚖️ 使用 `server.proxy` 配置
 - 🍕 支持在 mock文件中使用 `viteConfig.define`配置字段
-- ⚓️ 支持 `resolve.alias`
-- 📤 支持 multipart 类型，模拟文件上传
-- 🍪 支持 cookies
+- ⚓️ 支持在 mock文件中使用 `viteConfig.resolve.alias` 路径别名
 - 🌈 支持 `vite preview` 模式
+- 📤 支持 multipart 类型，模拟文件上传
+- 📥 支持模拟文件下载
 - 🗂 支持构建可独立部署的小型mock服务
 
 
@@ -557,7 +558,7 @@ export default defineMock({
   url: '/api/download',
   // 当你不确定类型，可传入文件名由插件内部进行解析
   type: 'my-app.dmg',
-  body: createReadStream('./my-app.dmg')
+  body: () => createReadStream('./my-app.dmg')
 })
 ```
 ```html

package/dist/index.cjs

@@ -54,7 +54,7 @@ var import_vite = require("vite");
 
 // package.json
 var name = "vite-plugin-mock-dev-server";
-var version = "1.1.3";
+var version = "1.1.4";
 
 // src/esbuildPlugin.ts
 var import_promises = __toESM(require("fs/promises"), 1);
@@ -444,24 +444,30 @@ function baseMiddleware(mockLoader, { formidableOptions = {}, proxies, cookiesOp
       return next();
     const { query: refererQuery } = (0, import_node_url2.parse)(req.headers.referer || "", true);
     const reqBody = await parseReqBody(req, formidableOptions);
+    const cookies = new import_cookies.default(req, res, cookiesOptions);
+    const getCookie = cookies.get.bind(cookies);
     const method = req.method.toUpperCase();
-    const mock = fineMock(mockData[mockUrl], pathname, method, {
-      query,
-      refererQuery,
-      body: reqBody,
-      headers: req.headers
+    const mock = fineMock(mockData[mockUrl], {
+      pathname,
+      method,
+      request: {
+        query,
+        refererQuery,
+        body: reqBody,
+        headers: req.headers,
+        getCookie
+      }
     });
     if (!mock)
       return next();
     debug("middleware: ", method, pathname);
-    const cookies = new import_cookies.default(req, res, cookiesOptions);
     const request = req;
     const response = res;
     request.body = reqBody;
     request.query = query;
     request.refererQuery = refererQuery;
     request.params = parseParams(mock.url, pathname);
-    request.getCookie = cookies.get.bind(cookies);
+    request.getCookie = getCookie;
     response.setCookie = cookies.set.bind(cookies);
     const {
       body,
@@ -502,7 +508,11 @@ function baseMiddleware(mockLoader, { formidableOptions = {}, proxies, cookiesOp
     res.end("");
   };
 }
-function fineMock(mockList, pathname, method, request) {
+function fineMock(mockList, {
+  pathname,
+  method,
+  request
+}) {
   return mockList.find((mock) => {
     if (!pathname || !mock || !mock.url)
       return false;
@@ -512,11 +522,10 @@ function fineMock(mockList, pathname, method, request) {
     const hasMock = (0, import_path_to_regexp2.pathToRegexp)(mock.url).test(pathname);
     if (hasMock && mock.validator) {
       const params = parseParams(mock.url, pathname);
-      const extraRequest = { params, ...request };
       if (isFunction(mock.validator)) {
-        return mock.validator(extraRequest);
+        return mock.validator({ params, ...request });
       } else {
-        return validate(extraRequest, mock.validator);
+        return validate({ params, ...request }, mock.validator);
       }
     }
     return hasMock;

package/dist/index.d.ts

@@ -111,13 +111,12 @@ interface ExtraRequest {
      * 请求体中 headers
      */
     headers: Headers;
-}
-type MockRequest = Connect.IncomingMessage & ExtraRequest & {
     /**
      * @see [cookies](https://github.com/pillarjs/cookies#cookiesgetname--options)
      */
     getCookie: (name: string, option?: Cookies.GetOption) => string | undefined;
-};
+}
+type MockRequest = Connect.IncomingMessage & ExtraRequest;
 type MockResponse = http.ServerResponse<http.IncomingMessage> & {
     /**
      * @see [cookies](https://github.com/pillarjs/cookies#cookiessetname--values--options)
@@ -330,7 +329,7 @@ interface MockOptionsItem {
      * }
      * ```
      */
-    validator?: Partial<ExtraRequest> | ((request: ExtraRequest) => boolean);
+    validator?: Partial<Omit<ExtraRequest, 'getCookie'>> | ((request: ExtraRequest) => boolean);
 }
 type MockOptions = MockOptionsItem[];
 type FormidableFile = formidable.File | formidable.File[];

package/dist/index.js

@@ -9,7 +9,7 @@ import { createFilter, normalizePath } from "vite";
 
 // package.json
 var name = "vite-plugin-mock-dev-server";
-var version = "1.1.3";
+var version = "1.1.4";
 
 // src/esbuildPlugin.ts
 import fsp from "fs/promises";
@@ -399,24 +399,30 @@ function baseMiddleware(mockLoader, { formidableOptions = {}, proxies, cookiesOp
       return next();
     const { query: refererQuery } = urlParse(req.headers.referer || "", true);
     const reqBody = await parseReqBody(req, formidableOptions);
+    const cookies = new Cookies(req, res, cookiesOptions);
+    const getCookie = cookies.get.bind(cookies);
     const method = req.method.toUpperCase();
-    const mock = fineMock(mockData[mockUrl], pathname, method, {
-      query,
-      refererQuery,
-      body: reqBody,
-      headers: req.headers
+    const mock = fineMock(mockData[mockUrl], {
+      pathname,
+      method,
+      request: {
+        query,
+        refererQuery,
+        body: reqBody,
+        headers: req.headers,
+        getCookie
+      }
     });
     if (!mock)
       return next();
     debug("middleware: ", method, pathname);
-    const cookies = new Cookies(req, res, cookiesOptions);
     const request = req;
     const response = res;
     request.body = reqBody;
     request.query = query;
     request.refererQuery = refererQuery;
     request.params = parseParams(mock.url, pathname);
-    request.getCookie = cookies.get.bind(cookies);
+    request.getCookie = getCookie;
     response.setCookie = cookies.set.bind(cookies);
     const {
       body,
@@ -457,7 +463,11 @@ function baseMiddleware(mockLoader, { formidableOptions = {}, proxies, cookiesOp
     res.end("");
   };
 }
-function fineMock(mockList, pathname, method, request) {
+function fineMock(mockList, {
+  pathname,
+  method,
+  request
+}) {
   return mockList.find((mock) => {
     if (!pathname || !mock || !mock.url)
       return false;
@@ -467,11 +477,10 @@ function fineMock(mockList, pathname, method, request) {
     const hasMock = pathToRegexp(mock.url).test(pathname);
     if (hasMock && mock.validator) {
       const params = parseParams(mock.url, pathname);
-      const extraRequest = { params, ...request };
       if (isFunction(mock.validator)) {
-        return mock.validator(extraRequest);
+        return mock.validator({ params, ...request });
       } else {
-        return validate(extraRequest, mock.validator);
+        return validate({ params, ...request }, mock.validator);
       }
     }
     return hasMock;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vite-plugin-mock-dev-server",
-  "version": "1.1.3",
+  "version": "1.1.4",
   "keywords": [
     "vite",
     "plugin",
@@ -34,7 +34,7 @@
     "co-body": "^6.1.0",
     "cookies": "^0.8.0",
     "debug": "^4.3.4",
-    "esbuild": "^0.17.17",
+    "esbuild": "^0.17.18",
     "fast-glob": "^3.2.12",
     "formidable": "^2.1.1",
     "http-status": "^1.6.2",
@@ -53,17 +53,15 @@
     "@types/formidable": "^2.0.5",
     "@types/is-core-module": "^2.2.0",
     "@types/mime-types": "^2.1.1",
-    "@types/node": "^18.15.13",
+    "@types/node": "^18.16.0",
     "bumpp": "^9.1.0",
     "conventional-changelog-cli": "^2.2.2",
     "eslint": "^8.39.0",
     "mockjs": "^1.1.0",
-    "prettier": "^2.8.7",
+    "prettier": "^2.8.8",
     "tsup": "^6.7.0",
     "typescript": "^5.0.4",
-    "vite": "^4.3.1",
-    "vitepress": "1.0.0-alpha.73",
-    "vue": "^3.2.47"
+    "vitepress": "1.0.0-alpha.74"
   },
   "peerDependencies": {
     "vite": ">=3.0.0"