vite-plugin-mock-dev-server 0.3.20 → 0.4.0

package/README.md

@@ -263,14 +263,14 @@ export default defineMock({
    * configurations and determines which mock configuration
    * is valid according to the validator.
    * 
-   * @type { headers?: object; body?: object; query?: object; params?: object  }
+   * @type { headers?: object; body?: object; query?: object; params?: object; refererQuery?: object  }
    * 
    * If the validator incoming is an object, 
    * then the validation method is the comparison of the 
    * strict request of interface, headers/body/query/params 
    * each `key-value` congruent, congruent check through
    * 
-   * @type ({ headers: object; body: object; query: object; params: object }) => boolean
+   * @type ({ headers: object; body: object; query: object; params: object; refererQuery: object }) => boolean
    * If the validator is passed a function, 
    * it takes the requested interface-related data as an input,
    * gives it to the consumer for custom validation, 
@@ -282,6 +282,12 @@ export default defineMock({
     body: {},
     query: {},
     params: {},
+    /**
+     * refererQuery validates the query in the url of the page from which the request originated, 
+     * which makes it possible to modify parameters directly in the browser address bar to get 
+     * different mock data
+     */
+    refererQuery: {}
   },
   /**
    * 

package/README.zh-CN.md

@@ -262,13 +262,13 @@ export default defineMock({
    * 验证器可以很好的解决这一类问题，将同个 url 分为多个 mock配置，
    * 根据 验证器来判断哪个mock配置生效。
    * 
-   * @type { headers?: object; body?: object; query?: object; params?: object  }
+   * @type { headers?: object; body?: object; query?: object; params?: object; refererQuery?: object  }
    * 
    * 如果 validator 传入的是一个对象，那么验证方式是严格比较 请求的接口
    * 中，headers/body/query/params 的各个`key`的`value`是否全等，
    * 全等则校验通过
    * 
-   * @type ({ headers: object; body: object; query: object; params: object }) => boolean
+   * @type ({ headers: object; body: object; query: object; params: object; refererQuery: object }) => boolean
    * 如果 validator 传入的是一个函数，那么会讲 请求的接口相关数据作为入参，提供给使用者进行自定义校验，并返回一个 boolean
    * 
    */
@@ -277,6 +277,12 @@ export default defineMock({
     body: {},
     query: {},
     params: {},
+    /**
+     * refererQuery validates the query in the url of the page from which the request originated, 
+     * which makes it possible to modify parameters directly in the browser address bar to get 
+     * different mock data
+     */
+    refererQuery: {}
   },
   /**
    * 

package/dist/index.cjs

@@ -18,6 +18,10 @@ var __copyProps = (to, from, except, desc) => {
   return to;
 };
 var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
   isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
   mod
 ));
@@ -33,6 +37,10 @@ __export(src_exports, {
 });
 module.exports = __toCommonJS(src_exports);
 
+// node_modules/.pnpm/tsup@6.6.3_typescript@4.9.5/node_modules/tsup/assets/cjs_shims.js
+var getImportMetaUrl = () => typeof document === "undefined" ? new URL("file:" + __filename).href : document.currentScript && document.currentScript.src || new URL("main.js", document.baseURI).href;
+var importMetaUrl = /* @__PURE__ */ getImportMetaUrl();
+
 // src/build.ts
 var import_node_fs2 = __toESM(require("fs"), 1);
 var import_promises2 = __toESM(require("fs/promises"), 1);
@@ -44,7 +52,7 @@ var import_vite = require("vite");
 
 // package.json
 var name = "vite-plugin-mock-dev-server";
-var version = "0.3.20";
+var version = "0.4.0";
 
 // src/esbuildPlugin.ts
 var import_promises = __toESM(require("fs/promises"), 1);
@@ -97,8 +105,8 @@ var isFunction = (val) => typeof val === "function";
 function sleep(timeout) {
   return new Promise((resolve) => setTimeout(resolve, timeout));
 }
-function getDirname(importMetaUrl) {
-  return import_node_path2.default.dirname((0, import_node_url.fileURLToPath)(importMetaUrl));
+function getDirname(importMetaUrl2) {
+  return import_node_path2.default.dirname((0, import_node_url.fileURLToPath)(importMetaUrl2));
 }
 var debug = (0, import_debug.default)("vite:plugin-mock-dev-server");
 var ensureArray = (thing) => {
@@ -123,6 +131,13 @@ function lookupFile(dir, formats, options) {
     return lookupFile(parentDir, formats, options);
   }
 }
+var ensureProxies = (serverProxy = {}) => {
+  const proxies = Object.keys(serverProxy).map((key) => {
+    const value = serverProxy[key];
+    return typeof value === "string" ? key : value.ws === true ? "" : key;
+  }).filter(Boolean);
+  return proxies;
+};
 
 // src/build.ts
 async function generateMockServer(ctx, config, options) {
@@ -135,7 +150,7 @@ async function generateMockServer(ctx, config, options) {
       define[key] = typeof val === "string" ? val : JSON.stringify(val);
     }
   }
-  const proxies = Object.keys(config.server.proxy || {});
+  const proxies = ensureProxies(config.server.proxy || {});
   const prefix = ensureArray(options.prefix);
   let pkg = {};
   try {
@@ -227,7 +242,7 @@ import mockData from './mock-data.js'
 const app = connect()
 app.use(baseMiddleware({ mockData }, {
   formidableOptions: { multiples: true },
-  proxies: ${JSON.stringify(proxies)} 
+  proxies: ${JSON.stringify(proxies)}
 }))
 app.listen(${port})
 console.log('listen: http://localhost:${port}')
@@ -302,6 +317,7 @@ async function buildMockEntry(inputFile, define) {
 
 // src/baseMiddleware.ts
 var import_node_url2 = require("url");
+var import_http_status = __toESM(require("http-status"), 1);
 var import_path_to_regexp = require("path-to-regexp");
 
 // src/parseReqBody.ts
@@ -345,7 +361,7 @@ async function parseMultipart(req, options) {
 
 // src/validator.ts
 function validate(request, validator) {
-  return equalObj(request.headers, validator.headers) && equalObj(request.body, validator.body) && equalObj(request.params, validator.params) && equalObj(request.query, validator.query);
+  return equalObj(request.headers, validator.headers) && equalObj(request.body, validator.body) && equalObj(request.params, validator.params) && equalObj(request.query, validator.query) && equalObj(request.refererQuery, validator.refererQuery);
 }
 function equalObj(left, right) {
   if (!right)
@@ -362,6 +378,7 @@ function baseMiddleware(mockLoader, { formidableOptions = {}, proxies }) {
   return async function(req, res, next) {
     const method = req.method.toUpperCase();
     const { query, pathname } = (0, import_node_url2.parse)(req.url, true);
+    const { query: refererQuery } = (0, import_node_url2.parse)(req.headers.referer || "", true);
     if (!pathname || proxies.length === 0 || !proxies.some((context) => doesProxyContextMatchUrl(context, req.url))) {
       return next();
     }
@@ -388,6 +405,7 @@ function baseMiddleware(mockLoader, { formidableOptions = {}, proxies }) {
         const params2 = urlMatch2.params || {};
         const request = {
           query,
+          refererQuery,
           params: params2,
           body: reqBody,
           headers: req.headers
@@ -407,19 +425,21 @@ function baseMiddleware(mockLoader, { formidableOptions = {}, proxies }) {
       await sleep(currentMock.delay);
     }
     res.statusCode = currentMock.status || 200;
-    res.statusMessage = currentMock.statusText || "OK";
+    res.statusMessage = currentMock.statusText || getHTTPStatusText(res.statusCode);
     const urlMatch = (0, import_path_to_regexp.match)(currentMock.url, { decode: decodeURIComponent })(
       pathname
     ) || { params: {} };
     const params = urlMatch.params || {};
     req.body = reqBody;
     req.query = query;
+    req.refererQuery = refererQuery;
     req.params = params;
     res.setHeader("Content-Type", "application/json");
     res.setHeader("X-Mock", "generate by vite:mock-dev-server");
     if (currentMock.headers) {
       const headers = isFunction(currentMock.headers) ? await currentMock.headers({
         query,
+        refererQuery,
         body: reqBody,
         params,
         headers: req.headers
@@ -433,6 +453,7 @@ function baseMiddleware(mockLoader, { formidableOptions = {}, proxies }) {
       if (isFunction(currentMock.body)) {
         body = await currentMock.body({
           query,
+          refererQuery,
           body: reqBody,
           params,
           headers: req.headers
@@ -457,6 +478,9 @@ function baseMiddleware(mockLoader, { formidableOptions = {}, proxies }) {
 function doesProxyContextMatchUrl(context, url) {
   return context.startsWith("^") && new RegExp(context).test(url) || url.startsWith(context);
 }
+function getHTTPStatusText(status) {
+  return import_http_status.default[status] || "Unknown";
+}
 
 // src/MockLoader.ts
 var import_node_events = __toESM(require("events"), 1);
@@ -469,8 +493,7 @@ var import_esbuild2 = require("esbuild");
 var import_fast_glob2 = __toESM(require("fast-glob"), 1);
 var import_json52 = __toESM(require("json5"), 1);
 var import_vite2 = require("vite");
-var import_meta = {};
-var _dirname = typeof __dirname !== "undefined" ? __dirname : getDirname(import_meta.url);
+var _dirname = getDirname(importMetaUrl);
 var _require = (0, import_node_module.createRequire)(_dirname);
 var _MockLoader = class extends import_node_events.default {
   constructor(options) {
@@ -539,6 +562,10 @@ var _MockLoader = class extends import_node_events.default {
     });
     this.mockWatcher = watcher;
   }
+  /**
+   * 监听 mock文件依赖的本地文件变动，
+   * mock依赖文件更新，mock文件也一并更新
+   */
   watchDeps() {
     const oldDeps = [];
     this.depsWatcher = import_chokidar.default.watch([], {
@@ -716,7 +743,7 @@ async function mockServerMiddleware(httpServer, config, options) {
   });
   await loader.load();
   httpServer == null ? void 0 : httpServer.on("close", () => loader.close());
-  const proxies = Object.keys(config.server.proxy || {});
+  const proxies = ensureProxies(config.server.proxy || {});
   const prefix = ensureArray(options.prefix);
   return baseMiddleware(loader, {
     formidableOptions: options.formidableOptions,

package/dist/index.d.ts

@@ -56,6 +56,10 @@ interface ResponseReq {
      * 请求地址中位于 `?` 后面的 queryString，已解析为 json
      */
     query: Record<string, any>;
+    /**
+     * 请求 referer 中位于 `?` 后面的 queryString，已解析为 json
+     */
+    refererQuery: Record<string, any>;
     /**
      * 请求体中 body 数据
      */

package/dist/index.js

@@ -9,7 +9,7 @@ import { createFilter } from "vite";
 
 // package.json
 var name = "vite-plugin-mock-dev-server";
-var version = "0.3.20";
+var version = "0.4.0";
 
 // src/esbuildPlugin.ts
 import fsp from "fs/promises";
@@ -88,6 +88,13 @@ function lookupFile(dir, formats, options) {
     return lookupFile(parentDir, formats, options);
   }
 }
+var ensureProxies = (serverProxy = {}) => {
+  const proxies = Object.keys(serverProxy).map((key) => {
+    const value = serverProxy[key];
+    return typeof value === "string" ? key : value.ws === true ? "" : key;
+  }).filter(Boolean);
+  return proxies;
+};
 
 // src/build.ts
 async function generateMockServer(ctx, config, options) {
@@ -100,7 +107,7 @@ async function generateMockServer(ctx, config, options) {
       define[key] = typeof val === "string" ? val : JSON.stringify(val);
     }
   }
-  const proxies = Object.keys(config.server.proxy || {});
+  const proxies = ensureProxies(config.server.proxy || {});
   const prefix = ensureArray(options.prefix);
   let pkg = {};
   try {
@@ -192,7 +199,7 @@ import mockData from './mock-data.js'
 const app = connect()
 app.use(baseMiddleware({ mockData }, {
   formidableOptions: { multiples: true },
-  proxies: ${JSON.stringify(proxies)} 
+  proxies: ${JSON.stringify(proxies)}
 }))
 app.listen(${port})
 console.log('listen: http://localhost:${port}')
@@ -267,6 +274,7 @@ async function buildMockEntry(inputFile, define) {
 
 // src/baseMiddleware.ts
 import { parse as urlParse } from "url";
+import HTTP_STATUS from "http-status";
 import { match, pathToRegexp } from "path-to-regexp";
 
 // src/parseReqBody.ts
@@ -310,7 +318,7 @@ async function parseMultipart(req, options) {
 
 // src/validator.ts
 function validate(request, validator) {
-  return equalObj(request.headers, validator.headers) && equalObj(request.body, validator.body) && equalObj(request.params, validator.params) && equalObj(request.query, validator.query);
+  return equalObj(request.headers, validator.headers) && equalObj(request.body, validator.body) && equalObj(request.params, validator.params) && equalObj(request.query, validator.query) && equalObj(request.refererQuery, validator.refererQuery);
 }
 function equalObj(left, right) {
   if (!right)
@@ -327,6 +335,7 @@ function baseMiddleware(mockLoader, { formidableOptions = {}, proxies }) {
   return async function(req, res, next) {
     const method = req.method.toUpperCase();
     const { query, pathname } = urlParse(req.url, true);
+    const { query: refererQuery } = urlParse(req.headers.referer || "", true);
     if (!pathname || proxies.length === 0 || !proxies.some((context) => doesProxyContextMatchUrl(context, req.url))) {
       return next();
     }
@@ -353,6 +362,7 @@ function baseMiddleware(mockLoader, { formidableOptions = {}, proxies }) {
         const params2 = urlMatch2.params || {};
         const request = {
           query,
+          refererQuery,
           params: params2,
           body: reqBody,
           headers: req.headers
@@ -372,19 +382,21 @@ function baseMiddleware(mockLoader, { formidableOptions = {}, proxies }) {
       await sleep(currentMock.delay);
     }
     res.statusCode = currentMock.status || 200;
-    res.statusMessage = currentMock.statusText || "OK";
+    res.statusMessage = currentMock.statusText || getHTTPStatusText(res.statusCode);
     const urlMatch = match(currentMock.url, { decode: decodeURIComponent })(
       pathname
     ) || { params: {} };
     const params = urlMatch.params || {};
     req.body = reqBody;
     req.query = query;
+    req.refererQuery = refererQuery;
     req.params = params;
     res.setHeader("Content-Type", "application/json");
     res.setHeader("X-Mock", "generate by vite:mock-dev-server");
     if (currentMock.headers) {
       const headers = isFunction(currentMock.headers) ? await currentMock.headers({
         query,
+        refererQuery,
         body: reqBody,
         params,
         headers: req.headers
@@ -398,6 +410,7 @@ function baseMiddleware(mockLoader, { formidableOptions = {}, proxies }) {
       if (isFunction(currentMock.body)) {
         body = await currentMock.body({
           query,
+          refererQuery,
           body: reqBody,
           params,
           headers: req.headers
@@ -422,6 +435,9 @@ function baseMiddleware(mockLoader, { formidableOptions = {}, proxies }) {
 function doesProxyContextMatchUrl(context, url) {
   return context.startsWith("^") && new RegExp(context).test(url) || url.startsWith(context);
 }
+function getHTTPStatusText(status) {
+  return HTTP_STATUS[status] || "Unknown";
+}
 
 // src/MockLoader.ts
 import EventEmitter from "events";
@@ -434,7 +450,7 @@ import { build as build2 } from "esbuild";
 import fastGlob from "fast-glob";
 import JSON52 from "json5";
 import { createFilter as createFilter2 } from "vite";
-var _dirname = typeof __dirname !== "undefined" ? __dirname : getDirname(import.meta.url);
+var _dirname = getDirname(import.meta.url);
 var _require = createRequire(_dirname);
 var _MockLoader = class extends EventEmitter {
   constructor(options) {
@@ -503,6 +519,10 @@ var _MockLoader = class extends EventEmitter {
     });
     this.mockWatcher = watcher;
   }
+  /**
+   * 监听 mock文件依赖的本地文件变动，
+   * mock依赖文件更新，mock文件也一并更新
+   */
   watchDeps() {
     const oldDeps = [];
     this.depsWatcher = chokidar.watch([], {
@@ -680,7 +700,7 @@ async function mockServerMiddleware(httpServer, config, options) {
   });
   await loader.load();
   httpServer == null ? void 0 : httpServer.on("close", () => loader.close());
-  const proxies = Object.keys(config.server.proxy || {});
+  const proxies = ensureProxies(config.server.proxy || {});
   const prefix = ensureArray(options.prefix);
   return baseMiddleware(loader, {
     formidableOptions: options.formidableOptions,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vite-plugin-mock-dev-server",
-  "version": "0.3.20",
+  "version": "0.4.0",
   "keywords": [
     "vite",
     "plugin",
@@ -36,6 +36,7 @@
     "esbuild": "^0.17.6",
     "fast-glob": "^3.2.12",
     "formidable": "^2.1.1",
+    "http-status": "^1.6.2",
     "is-core-module": "^2.11.0",
     "json5": "^2.2.3",
     "path-to-regexp": "^6.2.1"
@@ -53,7 +54,7 @@
     "eslint": "^8.33.0",
     "mockjs": "^1.1.0",
     "prettier": "^2.8.3",
-    "tsup": "^6.5.0",
+    "tsup": "^6.6.3",
     "typescript": "^4.9.5",
     "vite": "^4.1.1",
     "vitepress": "1.0.0-alpha.45",
@@ -70,6 +71,7 @@
     "entry": [
       "src/index.ts"
     ],
+    "shims": true,
     "sourcemap": false,
     "dts": true,
     "splitting": false,