vite-plugin-mock-dev-server 1.0.6 → 1.1.0

package/README.md

@@ -37,7 +37,8 @@
 - ⚙️ Support Enabled/Disabled any one of api mock
 - 🔥 HMR
 - ⚖️ Use `server.proxy`
-- 🍕 Support `viteConfig.define` in mock file
+- 🍕 Support `viteConfig.define` in mock file.
+- ⚓️ Support `resolve.alias` in mock file.
 - 📤 Support `multipart` content-type，mock upload file.
 - 🌈 Support `vite preview` mode
 - 🗂 Support building small independent deployable mock services.
@@ -132,6 +133,7 @@ export default defineConfig({
 })
 ```
 
+
 #### options
 
 - `options.prefix`
@@ -227,6 +229,24 @@ export default defineMock({
 })
 ```
 
+### createDefineMock(transformer)
+
+Return a custom defineMock function to support preprocessing of mock config.
+
+```ts
+import path from 'path'
+import { createDefineMock } from 'vite-plugin-mock-dev-server'
+
+// Preprocessed mock url
+const defineAPIMock = createDefineMock((mock) => {
+  mock.url = path.join('/api', mock.url)
+})
+
+export default defineApiMock({
+  url: '/test' // Complete as '/api/test'
+})
+```
+
 ## Mock Configuration
 
 ```ts
@@ -313,6 +333,19 @@ export default defineMock({
     'Content-Type': 'application/json'
   },
 
+  /**
+   * response cookies
+   * @type Record<string, string | { value: string, option: CookieOption }>
+   * @see https://github.com/pillarjs/cookies#cookiessetname--values--options
+   */
+  cookies: {
+    'your-cookie': 'your cookie value',
+    'cookie&option': {
+      value: 'cookie value',
+      option: { path: '/', httpOnly: true }
+    }
+  },
+
   /**
    * Response Body
    * Support `string/number/array/object` 
@@ -320,7 +353,7 @@ export default defineMock({
    * 
    * @type string | number | array | object
    * 
-   * @type (request: { headers, query, body, params }) => any | Promise<any>
+   * @type (request: { headers, query, body, params, refererQuery, getCookie }) => any | Promise<any>
    */
   body: {},
 
@@ -338,6 +371,39 @@ export default defineMock({
 
 ```
 
+### Request/Response Enhance
+
+When defining methods using `headers`, `body`, and `response`, the plugin adds new content to the `request` and `response` parameters.
+
+**In Request:**
+
+The original type of `request` is [`Connect.IncomingMessage`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/connect/index.d.ts). The plugin adds data such as `query`, `params`, `body`, `refererQuery`, and the `getCookie(name)` method for obtaining cookie information on this basis.
+
+```ts
+type Request = Connect.IncomingMessage & {
+  query: object
+  params: object
+  body: any
+  refererQuery: object
+  getCookie: (name: string, option?: Cookies.GetOption) => string | undefined
+}
+```
+
+**In Response:**
+
+The original type of `response` is `http.ServerResponse<http.IncomingMessage>`. The plugin adds `setCookie(name, value)` method for configuration cookie on this basis.
+
+```ts
+type Response = http.ServerResponse<http.IncomingMessage> & {
+  setCookie: (
+    name: string,
+    value?: string | null,
+    option?: Cookies.SetOption,
+  ) => void
+}
+```
+
+
 > Tips：
 > 
 > If you write mock files using json/json5, 

package/README.zh-CN.md

@@ -39,6 +39,7 @@
 - 🔥 热更新
 - ⚖️ 使用 `server.proxy` 配置
 - 🍕 支持在 mock文件中使用 `viteConfig.define`配置字段
+- ⚓️ 支持 `resolve.alias`
 - 📤 支持 multipart 类型，模拟文件上传
 - 🌈 支持 `vite preview` 模式
 - 🗂 支持构建可独立部署的小型mock服务
@@ -225,6 +226,24 @@ export default defineMock({
 })
 ```
 
+### createDefineMock(transformer)
+
+返回一个自定义的 defineMock 函数，用于支持对 mock config 的预处理。
+
+```ts
+import path from 'path'
+import { createDefineMock } from 'vite-plugin-mock-dev-server'
+
+// 预处理 mock url
+const defineAPIMock = createDefineMock((mock) => {
+  mock.url = path.join('/api', mock.url)
+})
+
+export default defineApiMock({
+  url: '/test' // 补全为 '/api/test'
+})
+```
+
 ## Mock 配置
 
 ```ts
@@ -307,6 +326,19 @@ export default defineMock({
     'Content-Type': 'application/json'
   },
 
+  /**
+   * 响应体 cookies
+   * @type Record<string, string | { value: string, option: CookieOption }>
+   * @see https://github.com/pillarjs/cookies#cookiessetname--values--options
+   */
+  cookies: {
+    'your-cookie': 'your cookie value',
+    'cookie&option': {
+      value: 'cookie value',
+      option: { path: '/', httpOnly: true }
+    }
+  },
+
   /**
    * 响应体数据
    * 定义返回的响应体数据内容。
@@ -339,6 +371,39 @@ export default defineMock({
 
 ```
 
+### Request/Response 增强
+
+当你配置 `headers`, `body`, and `response` 的函数形式时, 插件在参数 `request` 和 `response` 添加了新的内容用于帮助获取必要的数据.
+
+**Request:**
+
+`request`的原始数据类型是[`Connect.IncomingMessage`](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/connect/index.d.ts). 插件在此基础上，增加了 `query`, `params`, `body`, `refererQuery`，以及 `getCookie(name)` 方法用于获取cookie信息。
+
+```ts
+type Request = Connect.IncomingMessage & {
+  query: object
+  params: object
+  body: any
+  refererQuery: object
+  getCookie: (name: string, option?: Cookies.GetOption) => string | undefined
+}
+```
+
+**Response:**
+
+`response` 的原始数据类型是`http.ServerResponse<http.IncomingMessage>`. 插件在此基础上增加了 `setCookie(name, value)` 方法用于设置cookie
+
+```ts
+type Response = http.ServerResponse<http.IncomingMessage> & {
+  setCookie: (
+    name: string,
+    value?: string | null,
+    option?: Cookies.SetOption,
+  ) => void
+}
+```
+
+
 > 注意：
 > 
 > 如果使用 json/json5 编写 mock文件，则不支持使用 `response` 方法，以及不支持使用其他字段的函数形式。

package/dist/index.cjs

@@ -31,6 +31,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var src_exports = {};
 __export(src_exports, {
   baseMiddleware: () => baseMiddleware,
+  createDefineMock: () => createDefineMock,
   default: () => src_default,
   defineMock: () => defineMock,
   mockDevServerPlugin: () => mockDevServerPlugin,
@@ -38,7 +39,7 @@ __export(src_exports, {
 });
 module.exports = __toCommonJS(src_exports);
 
-// node_modules/.pnpm/tsup@6.7.0_typescript@5.0.2/node_modules/tsup/assets/cjs_shims.js
+// node_modules/.pnpm/tsup@6.7.0_typescript@5.0.4/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();
 
@@ -53,7 +54,7 @@ var import_vite = require("vite");
 
 // package.json
 var name = "vite-plugin-mock-dev-server";
-var version = "1.0.6";
+var version = "1.1.0";
 
 // src/esbuildPlugin.ts
 var import_promises = __toESM(require("fs/promises"), 1);
@@ -95,12 +96,48 @@ var jsonLoader = {
     });
   }
 };
+var aliasPlugin = (alias) => {
+  return {
+    name: "alias-plugin",
+    setup(build3) {
+      build3.onResolve({ filter: /.*/ }, async ({ path: id }) => {
+        const matchedEntry = alias.find(({ find: find2 }) => matches(find2, id));
+        if (!matchedEntry) {
+          return null;
+        }
+        const { find, replacement } = matchedEntry;
+        const result = await build3.resolve(id.replace(find, replacement), {
+          kind: "import-statement",
+          resolveDir: replacement,
+          namespace: "file"
+        });
+        return {
+          path: result.path,
+          external: false
+        };
+      });
+    }
+  };
+};
+function matches(pattern, importee) {
+  if (pattern instanceof RegExp) {
+    return pattern.test(importee);
+  }
+  if (importee.length < pattern.length) {
+    return false;
+  }
+  if (importee === pattern) {
+    return true;
+  }
+  return importee.startsWith(`${pattern}/`);
+}
 
 // src/utils.ts
 var import_node_fs = __toESM(require("fs"), 1);
 var import_node_path2 = __toESM(require("path"), 1);
 var import_node_url = require("url");
 var import_debug = __toESM(require("debug"), 1);
+var import_path_to_regexp = require("path-to-regexp");
 var import_picocolors = __toESM(require("picocolors"), 1);
 var isArray = (val) => Array.isArray(val);
 var isFunction = (val) => typeof val === "function";
@@ -148,6 +185,12 @@ var ensureProxies = (serverProxy = {}) => {
   }).filter(Boolean);
   return proxies;
 };
+function parseParams(pattern, url) {
+  const urlMatch = (0, import_path_to_regexp.match)(pattern, { decode: decodeURIComponent })(url) || {
+    params: {}
+  };
+  return urlMatch.params || {};
+}
 
 // src/build.ts
 async function generateMockServer(ctx, config, options) {
@@ -174,7 +217,11 @@ async function generateMockServer(ctx, config, options) {
   const content = await generateMockEntryCode(process.cwd(), include, exclude);
   const mockEntry = import_node_path3.default.join(config.root, `mock-data-${Date.now()}.js`);
   await import_promises2.default.writeFile(mockEntry, content, "utf-8");
-  const { code, deps } = await buildMockEntry(mockEntry, define);
+  const { code, deps } = await buildMockEntry(
+    mockEntry,
+    define,
+    config.resolve.alias
+  );
   const mockDeps = getMockDependencies(deps);
   await import_promises2.default.unlink(mockEntry);
   const outputList = [
@@ -186,6 +233,7 @@ async function generateMockServer(ctx, config, options) {
       filename: import_node_path3.default.join(outputDir, "index.js"),
       source: generatorServerEntryCode(
         [...prefix, ...proxies],
+        options.cookiesOptions,
         options.build.serverPort
       )
     },
@@ -247,7 +295,7 @@ function generatePackageJson(pkg, mockDeps) {
   });
   return JSON.stringify(mockPkg, null, 2);
 }
-function generatorServerEntryCode(proxies, port = 8080) {
+function generatorServerEntryCode(proxies, cookiesOptions = {}, port = 8080) {
   return `import connect from 'connect';
 import corsMiddleware from 'cors';
 import { baseMiddleware } from 'vite-plugin-mock-dev-server';
@@ -258,6 +306,7 @@ app.use(corsMiddleware());
 app.use(baseMiddleware({ mockData }, {
   formidableOptions: { multiples: true },
   proxies: ${JSON.stringify(proxies)}
+  cookiesOptions: ${JSON.stringify(cookiesOptions)}
 }));
 app.listen(${port});
 
@@ -288,7 +337,7 @@ const mockList = exporters.map((raw) => raw && raw.default
 export default transformMockData(mockList);
 `;
 }
-async function buildMockEntry(inputFile, define) {
+async function buildMockEntry(inputFile, define, alias) {
   var _a;
   try {
     const result = await (0, import_esbuild.build)({
@@ -301,7 +350,7 @@ async function buildMockEntry(inputFile, define) {
       metafile: true,
       format: "esm",
       define,
-      plugins: [externalizeDeps, json5Loader, jsonLoader]
+      plugins: [aliasPlugin(alias), externalizeDeps, json5Loader, jsonLoader]
     });
     return {
       code: result.outputFiles[0].text,
@@ -315,8 +364,9 @@ async function buildMockEntry(inputFile, define) {
 
 // src/baseMiddleware.ts
 var import_node_url2 = require("url");
+var import_cookies = __toESM(require("cookies"), 1);
 var import_http_status = __toESM(require("http-status"), 1);
-var import_path_to_regexp = require("path-to-regexp");
+var import_path_to_regexp2 = require("path-to-regexp");
 var import_picocolors2 = __toESM(require("picocolors"), 1);
 
 // src/parseReqBody.ts
@@ -374,9 +424,9 @@ function equalObj(left, right) {
 }
 
 // src/baseMiddleware.ts
-function baseMiddleware(mockLoader, { formidableOptions = {}, proxies }) {
+function baseMiddleware(mockLoader, { formidableOptions = {}, proxies, cookiesOptions }) {
   return async function(req, res, next) {
-    const method = req.method.toUpperCase();
+    const startTime = Date.now();
     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))) {
@@ -384,71 +434,35 @@ function baseMiddleware(mockLoader, { formidableOptions = {}, proxies }) {
     }
     const mockData = mockLoader.mockData;
     const mockUrl = Object.keys(mockData).find((key) => {
-      return (0, import_path_to_regexp.pathToRegexp)(key).test(pathname);
+      return (0, import_path_to_regexp2.pathToRegexp)(key).test(pathname);
     });
     if (!mockUrl) {
       return next();
     }
-    const mockList = mockData[mockUrl];
     const reqBody = await parseReqBody(req, formidableOptions);
-    const currentMock = mockList.find((mock) => {
-      if (!pathname || !mock || !mock.url)
-        return false;
-      const methods = mock.method ? isArray(mock.method) ? mock.method : [mock.method] : ["GET", "POST"];
-      if (!methods.includes(req.method.toUpperCase()))
-        return false;
-      const hasMock = (0, import_path_to_regexp.pathToRegexp)(mock.url).test(pathname);
-      if (hasMock && mock.validator) {
-        const urlMatch2 = (0, import_path_to_regexp.match)(mock.url, { decode: decodeURIComponent })(
-          pathname
-        ) || { params: {} };
-        const params2 = urlMatch2.params || {};
-        const request2 = {
-          query,
-          refererQuery,
-          params: params2,
-          body: reqBody,
-          headers: req.headers
-        };
-        if (isFunction(mock.validator)) {
-          return mock.validator(request2);
-        } else {
-          return validate(request2, mock.validator);
-        }
-      }
-      return hasMock;
+    const cookies = new import_cookies.default(req, res, cookiesOptions);
+    const method = req.method.toUpperCase();
+    const currentMock = fineMock(mockData[mockUrl], pathname, method, {
+      query,
+      refererQuery,
+      body: reqBody,
+      headers: req.headers
     });
     if (!currentMock)
       return next();
     debug("middleware: ", method, pathname);
-    if (currentMock.delay && currentMock.delay > 0) {
-      await sleep(currentMock.delay);
-    }
-    res.statusCode = currentMock.status || 200;
-    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 || {};
     const request = req;
+    const response = res;
     request.body = reqBody;
     request.query = query;
     request.refererQuery = refererQuery;
-    request.params = params;
-    res.setHeader("Content-Type", "application/json");
-    res.setHeader("Cache-Control", "no-cache,max-age=0");
-    res.setHeader("X-Mock", "generate by vite:plugin-mock-dev-server");
-    if (currentMock.headers) {
-      try {
-        const headers = isFunction(currentMock.headers) ? await currentMock.headers(request) : currentMock.headers;
-        Object.keys(headers).forEach((key) => {
-          res.setHeader(key, headers[key]);
-        });
-      } catch (e) {
-        log.error(`${import_picocolors2.default.red("[headers error]")} ${req.url} 
-`, e);
-      }
-    }
+    request.params = parseParams(currentMock.url, pathname);
+    request.getCookie = cookies.get.bind(cookies);
+    response.setCookie = cookies.set.bind(cookies);
+    await provideHeaders(request, response, currentMock.headers);
+    await provideCookies(request, response, currentMock.cookies);
+    res.statusCode = currentMock.status || 200;
+    res.statusMessage = currentMock.statusText || getHTTPStatusText(res.statusCode);
     if (currentMock.body) {
       try {
         let body;
@@ -457,6 +471,7 @@ function baseMiddleware(mockLoader, { formidableOptions = {}, proxies }) {
         } else {
           body = currentMock.body;
         }
+        await realDelay(startTime, currentMock.delay);
         res.end(JSON.stringify(body));
       } catch (e) {
         log.error(`${import_picocolors2.default.red("[body error]")} ${req.url} 
@@ -469,7 +484,12 @@ function baseMiddleware(mockLoader, { formidableOptions = {}, proxies }) {
     }
     if (currentMock.response) {
       try {
-        await currentMock.response(request, res, next);
+        const end = response.end.bind(response);
+        response.end = (...args) => {
+          realDelay(startTime, currentMock.delay).then(() => end(...args));
+          return response;
+        };
+        await currentMock.response(request, response, next);
       } catch (e) {
         log.error(`${import_picocolors2.default.red("[response error]")} ${req.url} 
 `, e);
@@ -482,6 +502,69 @@ function baseMiddleware(mockLoader, { formidableOptions = {}, proxies }) {
     res.end("");
   };
 }
+function fineMock(mockList, pathname, method, request) {
+  return mockList.find((mock) => {
+    if (!pathname || !mock || !mock.url)
+      return false;
+    const methods = mock.method ? isArray(mock.method) ? mock.method : [mock.method] : ["GET", "POST"];
+    if (!methods.includes(method))
+      return false;
+    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);
+      } else {
+        return validate(extraRequest, mock.validator);
+      }
+    }
+    return hasMock;
+  });
+}
+async function provideHeaders(req, res, headersOption) {
+  res.setHeader("Content-Type", "application/json");
+  res.setHeader("Cache-Control", "no-cache,max-age=0");
+  res.setHeader("X-Mock", "generate by vite:plugin-mock-dev-server");
+  if (!headersOption)
+    return;
+  try {
+    const headers = isFunction(headersOption) ? await headersOption(req) : headersOption;
+    Object.keys(headers).forEach((key) => {
+      res.setHeader(key, headers[key]);
+    });
+  } catch (e) {
+    log.error(`${import_picocolors2.default.red("[headers error]")} ${req.url} 
+`, e);
+  }
+}
+async function provideCookies(req, res, cookiesOption) {
+  if (!cookiesOption)
+    return;
+  try {
+    const cookies = isFunction(cookiesOption) ? await cookiesOption(req) : cookiesOption;
+    Object.keys(cookies).forEach((key) => {
+      const optional = cookies[key];
+      if (typeof optional === "string") {
+        res.setCookie(key, optional);
+      } else {
+        const { value, options } = optional;
+        res.setCookie(key, value, options);
+      }
+    });
+  } catch (e) {
+    log.error(`${import_picocolors2.default.red("[cookies error]")} ${req.url} 
+`, e);
+  }
+}
+async function realDelay(startTime, delay) {
+  if (!delay || delay <= 0)
+    return;
+  const diff = Date.now() - startTime;
+  const realDelay2 = delay - diff;
+  if (realDelay2 > 0)
+    await sleep(realDelay2);
+}
 function doesProxyContextMatchUrl(context, url) {
   return context.startsWith("^") && new RegExp(context).test(url) || url.startsWith(context);
 }
@@ -740,7 +823,7 @@ var _MockLoader = class extends import_node_events.default {
         metafile: true,
         format: isESM ? "esm" : "cjs",
         define: this.options.define,
-        plugins: [externalizeDeps]
+        plugins: [aliasPlugin(this.options.alias), externalizeDeps]
       });
       return {
         code: result.outputFiles[0].text,
@@ -771,7 +854,8 @@ async function mockServerMiddleware(config, options, httpServer, ws) {
   const loader = new MockLoader({
     include,
     exclude,
-    define
+    define,
+    alias: config.resolve.alias
   });
   await loader.load();
   httpServer == null ? void 0 : httpServer.on("close", () => loader.close());
@@ -784,7 +868,8 @@ async function mockServerMiddleware(config, options, httpServer, ws) {
   const prefix = ensureArray(options.prefix);
   return baseMiddleware(loader, {
     formidableOptions: options.formidableOptions,
-    proxies: [...prefix, ...proxies]
+    proxies: [...prefix, ...proxies],
+    cookiesOptions: options.cookiesOptions
   });
 }
 
@@ -792,20 +877,18 @@ async function mockServerMiddleware(config, options, httpServer, ws) {
 function mockDevServerPlugin({
   prefix = [],
   include = ["mock/**/*.mock.{js,ts,cjs,mjs,json,json5}"],
-  exclude = [
-    "**/node_modules/**",
-    "**/.vscode/**",
-    "**/.git/**"
-  ],
+  exclude = ["**/node_modules/**", "**/.vscode/**", "**/.git/**"],
   reload = false,
   formidableOptions = {},
-  build: build3 = false
+  build: build3 = false,
+  cookiesOptions = {}
 } = {}) {
   const pluginOptions = {
     prefix,
     include,
     exclude,
     reload,
+    cookiesOptions,
     formidableOptions: {
       multiples: true,
       ...formidableOptions
@@ -877,12 +960,24 @@ function serverPlugin(pluginOptions) {
 function defineMock(config) {
   return config;
 }
+function createDefineMock(transformer) {
+  const define = (config) => {
+    if (isArray(config)) {
+      config = config.map((item) => transformer(item) || item);
+    } else {
+      config = transformer(config) || config;
+    }
+    return config;
+  };
+  return define;
+}
 
 // src/index.ts
 var src_default = mockDevServerPlugin;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   baseMiddleware,
+  createDefineMock,
   defineMock,
   mockDevServerPlugin,
   transformMockData

package/dist/index.d.ts

@@ -1,5 +1,6 @@
-import { Connect, Plugin } from 'vite';
+import { Connect, Plugin, ResolvedConfig } from 'vite';
 import http from 'node:http';
+import Cookies from 'cookies';
 import formidable from 'formidable';
 import EventEmitter from 'node:events';
 import chokidar from 'chokidar';
@@ -35,6 +36,11 @@ interface MockServerPluginOptions {
      * @see https://github.com/node-formidable/formidable#options
      */
     formidableOptions?: formidable.Options;
+    /**
+     * cookies options
+     * @see https://github.com/pillarjs/cookies#new-cookiesrequest-response--options
+     */
+    cookiesOptions?: Cookies.Option;
     /**
      * 当需要构建一个小型mock服务时，可配置此项
      *
@@ -81,9 +87,20 @@ interface ExtraRequest {
      */
     headers: Headers;
 }
-type MockRequest = ExtraRequest & http.IncomingMessage;
+type MockRequest = Connect.IncomingMessage & ExtraRequest & {
+    getCookie: (name: string, option?: Cookies.GetOption) => string | undefined;
+};
+type MockResponse = http.ServerResponse<http.IncomingMessage> & {
+    setCookie: (name: string, value?: string | null, option?: Cookies.SetOption) => void;
+};
 type ResponseBodyFn = (request: MockRequest) => ResponseBody | Promise<ResponseBody>;
 type ResponseHeaderFn = (request: MockRequest) => Headers | Promise<Headers>;
+type CookieValue = string | {
+    value: string;
+    options?: Cookies.SetOption;
+};
+type ResponseCookies = Record<string, CookieValue>;
+type ResponseCookiesFn = (request: MockRequest) => ResponseCookies | Promise<ResponseCookies>;
 interface MockOptionsItem {
     /**
      * 需要做mock的接口地址，
@@ -127,6 +144,10 @@ interface MockOptionsItem {
      * @default 0
      */
     delay?: number;
+    /**
+     * 设置响应体 cookies
+     */
+    cookies?: ResponseCookies | ResponseCookiesFn;
     /**
      * 配置响应体数据内容
      *
@@ -140,7 +161,7 @@ interface MockOptionsItem {
      *
      * 在 req 中，还可以拿到 query、params、body等已解析的请求信息
      */
-    response?: (req: MockRequest, res: http.ServerResponse<http.IncomingMessage>, next: Connect.NextFunction) => void | Promise<void>;
+    response?: (req: MockRequest, res: MockResponse, next: Connect.NextFunction) => void | Promise<void>;
     /**
      * 请求验证器
      *
@@ -153,7 +174,7 @@ interface MockOptionsItem {
 type MockOptions = MockOptionsItem[];
 type FormidableFile = formidable.File | formidable.File[];
 
-declare function mockDevServerPlugin({ prefix, include, exclude, reload, formidableOptions, build, }?: MockServerPluginOptions): Plugin[];
+declare function mockDevServerPlugin({ prefix, include, exclude, reload, formidableOptions, build, cookiesOptions, }?: MockServerPluginOptions): Plugin[];
 
 /**
  * mock config helper
@@ -172,12 +193,21 @@ declare function mockDevServerPlugin({ prefix, include, exclude, reload, formida
  */
 declare function defineMock(config: MockOptionsItem): MockOptionsItem;
 declare function defineMock(config: MockOptions): MockOptions;
+/**
+ * 返回一个自定义的 defineMock 函数，用于支持对 mock config 的预处理。
+ *
+ * Return a custom defineMock function to support preprocessing of mock config.
+ *
+ * @param transformer preprocessing function
+ */
+declare function createDefineMock(transformer: (mock: MockOptionsItem) => MockOptionsItem | void): typeof defineMock;
 
 interface MockLoaderOptions {
     cwd?: string;
     include: string[];
     exclude: string[];
     define: Record<string, any>;
+    alias: ResolvedConfig['resolve']['alias'];
 }
 /**
  * mock配置加载器
@@ -213,10 +243,11 @@ declare class MockLoader extends EventEmitter {
 
 interface BaseMiddlewareOptions {
     formidableOptions: MockServerPluginOptions['formidableOptions'];
+    cookiesOptions: MockServerPluginOptions['cookiesOptions'];
     proxies: string[];
 }
-declare function baseMiddleware(mockLoader: MockLoader, { formidableOptions, proxies }: BaseMiddlewareOptions): Connect.NextHandleFunction;
+declare function baseMiddleware(mockLoader: MockLoader, { formidableOptions, proxies, cookiesOptions }: BaseMiddlewareOptions): Connect.NextHandleFunction;
 
 declare function transformMockData(mockList: Map<string, MockOptionsItem | MockOptions> | (MockOptionsItem | MockOptions)[]): Record<string, MockOptions>;
 
-export { BaseMiddlewareOptions, FormidableFile, MockOptions, MockOptionsItem, MockServerPluginOptions, baseMiddleware, mockDevServerPlugin as default, defineMock, mockDevServerPlugin, transformMockData };
+export { BaseMiddlewareOptions, FormidableFile, MockOptions, MockOptionsItem, MockServerPluginOptions, baseMiddleware, createDefineMock, mockDevServerPlugin as default, defineMock, mockDevServerPlugin, transformMockData };

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.0.6";
+var version = "1.1.0";
 
 // src/esbuildPlugin.ts
 import fsp from "fs/promises";
@@ -51,12 +51,48 @@ var jsonLoader = {
     });
   }
 };
+var aliasPlugin = (alias) => {
+  return {
+    name: "alias-plugin",
+    setup(build3) {
+      build3.onResolve({ filter: /.*/ }, async ({ path: id }) => {
+        const matchedEntry = alias.find(({ find: find2 }) => matches(find2, id));
+        if (!matchedEntry) {
+          return null;
+        }
+        const { find, replacement } = matchedEntry;
+        const result = await build3.resolve(id.replace(find, replacement), {
+          kind: "import-statement",
+          resolveDir: replacement,
+          namespace: "file"
+        });
+        return {
+          path: result.path,
+          external: false
+        };
+      });
+    }
+  };
+};
+function matches(pattern, importee) {
+  if (pattern instanceof RegExp) {
+    return pattern.test(importee);
+  }
+  if (importee.length < pattern.length) {
+    return false;
+  }
+  if (importee === pattern) {
+    return true;
+  }
+  return importee.startsWith(`${pattern}/`);
+}
 
 // src/utils.ts
 import fs from "fs";
 import path2 from "path";
 import { fileURLToPath } from "url";
 import Debug from "debug";
+import { match } from "path-to-regexp";
 import colors from "picocolors";
 var isArray = (val) => Array.isArray(val);
 var isFunction = (val) => typeof val === "function";
@@ -104,6 +140,12 @@ var ensureProxies = (serverProxy = {}) => {
   }).filter(Boolean);
   return proxies;
 };
+function parseParams(pattern, url) {
+  const urlMatch = match(pattern, { decode: decodeURIComponent })(url) || {
+    params: {}
+  };
+  return urlMatch.params || {};
+}
 
 // src/build.ts
 async function generateMockServer(ctx, config, options) {
@@ -130,7 +172,11 @@ async function generateMockServer(ctx, config, options) {
   const content = await generateMockEntryCode(process.cwd(), include, exclude);
   const mockEntry = path3.join(config.root, `mock-data-${Date.now()}.js`);
   await fsp2.writeFile(mockEntry, content, "utf-8");
-  const { code, deps } = await buildMockEntry(mockEntry, define);
+  const { code, deps } = await buildMockEntry(
+    mockEntry,
+    define,
+    config.resolve.alias
+  );
   const mockDeps = getMockDependencies(deps);
   await fsp2.unlink(mockEntry);
   const outputList = [
@@ -142,6 +188,7 @@ async function generateMockServer(ctx, config, options) {
       filename: path3.join(outputDir, "index.js"),
       source: generatorServerEntryCode(
         [...prefix, ...proxies],
+        options.cookiesOptions,
         options.build.serverPort
       )
     },
@@ -203,7 +250,7 @@ function generatePackageJson(pkg, mockDeps) {
   });
   return JSON.stringify(mockPkg, null, 2);
 }
-function generatorServerEntryCode(proxies, port = 8080) {
+function generatorServerEntryCode(proxies, cookiesOptions = {}, port = 8080) {
   return `import connect from 'connect';
 import corsMiddleware from 'cors';
 import { baseMiddleware } from 'vite-plugin-mock-dev-server';
@@ -214,6 +261,7 @@ app.use(corsMiddleware());
 app.use(baseMiddleware({ mockData }, {
   formidableOptions: { multiples: true },
   proxies: ${JSON.stringify(proxies)}
+  cookiesOptions: ${JSON.stringify(cookiesOptions)}
 }));
 app.listen(${port});
 
@@ -244,7 +292,7 @@ const mockList = exporters.map((raw) => raw && raw.default
 export default transformMockData(mockList);
 `;
 }
-async function buildMockEntry(inputFile, define) {
+async function buildMockEntry(inputFile, define, alias) {
   var _a;
   try {
     const result = await build({
@@ -257,7 +305,7 @@ async function buildMockEntry(inputFile, define) {
       metafile: true,
       format: "esm",
       define,
-      plugins: [externalizeDeps, json5Loader, jsonLoader]
+      plugins: [aliasPlugin(alias), externalizeDeps, json5Loader, jsonLoader]
     });
     return {
       code: result.outputFiles[0].text,
@@ -271,8 +319,9 @@ async function buildMockEntry(inputFile, define) {
 
 // src/baseMiddleware.ts
 import { parse as urlParse } from "url";
+import Cookies from "cookies";
 import HTTP_STATUS from "http-status";
-import { match, pathToRegexp } from "path-to-regexp";
+import { pathToRegexp } from "path-to-regexp";
 import colors2 from "picocolors";
 
 // src/parseReqBody.ts
@@ -330,9 +379,9 @@ function equalObj(left, right) {
 }
 
 // src/baseMiddleware.ts
-function baseMiddleware(mockLoader, { formidableOptions = {}, proxies }) {
+function baseMiddleware(mockLoader, { formidableOptions = {}, proxies, cookiesOptions }) {
   return async function(req, res, next) {
-    const method = req.method.toUpperCase();
+    const startTime = Date.now();
     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))) {
@@ -345,66 +394,30 @@ function baseMiddleware(mockLoader, { formidableOptions = {}, proxies }) {
     if (!mockUrl) {
       return next();
     }
-    const mockList = mockData[mockUrl];
     const reqBody = await parseReqBody(req, formidableOptions);
-    const currentMock = mockList.find((mock) => {
-      if (!pathname || !mock || !mock.url)
-        return false;
-      const methods = mock.method ? isArray(mock.method) ? mock.method : [mock.method] : ["GET", "POST"];
-      if (!methods.includes(req.method.toUpperCase()))
-        return false;
-      const hasMock = pathToRegexp(mock.url).test(pathname);
-      if (hasMock && mock.validator) {
-        const urlMatch2 = match(mock.url, { decode: decodeURIComponent })(
-          pathname
-        ) || { params: {} };
-        const params2 = urlMatch2.params || {};
-        const request2 = {
-          query,
-          refererQuery,
-          params: params2,
-          body: reqBody,
-          headers: req.headers
-        };
-        if (isFunction(mock.validator)) {
-          return mock.validator(request2);
-        } else {
-          return validate(request2, mock.validator);
-        }
-      }
-      return hasMock;
+    const cookies = new Cookies(req, res, cookiesOptions);
+    const method = req.method.toUpperCase();
+    const currentMock = fineMock(mockData[mockUrl], pathname, method, {
+      query,
+      refererQuery,
+      body: reqBody,
+      headers: req.headers
     });
     if (!currentMock)
       return next();
     debug("middleware: ", method, pathname);
-    if (currentMock.delay && currentMock.delay > 0) {
-      await sleep(currentMock.delay);
-    }
-    res.statusCode = currentMock.status || 200;
-    res.statusMessage = currentMock.statusText || getHTTPStatusText(res.statusCode);
-    const urlMatch = match(currentMock.url, { decode: decodeURIComponent })(
-      pathname
-    ) || { params: {} };
-    const params = urlMatch.params || {};
     const request = req;
+    const response = res;
     request.body = reqBody;
     request.query = query;
     request.refererQuery = refererQuery;
-    request.params = params;
-    res.setHeader("Content-Type", "application/json");
-    res.setHeader("Cache-Control", "no-cache,max-age=0");
-    res.setHeader("X-Mock", "generate by vite:plugin-mock-dev-server");
-    if (currentMock.headers) {
-      try {
-        const headers = isFunction(currentMock.headers) ? await currentMock.headers(request) : currentMock.headers;
-        Object.keys(headers).forEach((key) => {
-          res.setHeader(key, headers[key]);
-        });
-      } catch (e) {
-        log.error(`${colors2.red("[headers error]")} ${req.url} 
-`, e);
-      }
-    }
+    request.params = parseParams(currentMock.url, pathname);
+    request.getCookie = cookies.get.bind(cookies);
+    response.setCookie = cookies.set.bind(cookies);
+    await provideHeaders(request, response, currentMock.headers);
+    await provideCookies(request, response, currentMock.cookies);
+    res.statusCode = currentMock.status || 200;
+    res.statusMessage = currentMock.statusText || getHTTPStatusText(res.statusCode);
     if (currentMock.body) {
       try {
         let body;
@@ -413,6 +426,7 @@ function baseMiddleware(mockLoader, { formidableOptions = {}, proxies }) {
         } else {
           body = currentMock.body;
         }
+        await realDelay(startTime, currentMock.delay);
         res.end(JSON.stringify(body));
       } catch (e) {
         log.error(`${colors2.red("[body error]")} ${req.url} 
@@ -425,7 +439,12 @@ function baseMiddleware(mockLoader, { formidableOptions = {}, proxies }) {
     }
     if (currentMock.response) {
       try {
-        await currentMock.response(request, res, next);
+        const end = response.end.bind(response);
+        response.end = (...args) => {
+          realDelay(startTime, currentMock.delay).then(() => end(...args));
+          return response;
+        };
+        await currentMock.response(request, response, next);
       } catch (e) {
         log.error(`${colors2.red("[response error]")} ${req.url} 
 `, e);
@@ -438,6 +457,69 @@ function baseMiddleware(mockLoader, { formidableOptions = {}, proxies }) {
     res.end("");
   };
 }
+function fineMock(mockList, pathname, method, request) {
+  return mockList.find((mock) => {
+    if (!pathname || !mock || !mock.url)
+      return false;
+    const methods = mock.method ? isArray(mock.method) ? mock.method : [mock.method] : ["GET", "POST"];
+    if (!methods.includes(method))
+      return false;
+    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);
+      } else {
+        return validate(extraRequest, mock.validator);
+      }
+    }
+    return hasMock;
+  });
+}
+async function provideHeaders(req, res, headersOption) {
+  res.setHeader("Content-Type", "application/json");
+  res.setHeader("Cache-Control", "no-cache,max-age=0");
+  res.setHeader("X-Mock", "generate by vite:plugin-mock-dev-server");
+  if (!headersOption)
+    return;
+  try {
+    const headers = isFunction(headersOption) ? await headersOption(req) : headersOption;
+    Object.keys(headers).forEach((key) => {
+      res.setHeader(key, headers[key]);
+    });
+  } catch (e) {
+    log.error(`${colors2.red("[headers error]")} ${req.url} 
+`, e);
+  }
+}
+async function provideCookies(req, res, cookiesOption) {
+  if (!cookiesOption)
+    return;
+  try {
+    const cookies = isFunction(cookiesOption) ? await cookiesOption(req) : cookiesOption;
+    Object.keys(cookies).forEach((key) => {
+      const optional = cookies[key];
+      if (typeof optional === "string") {
+        res.setCookie(key, optional);
+      } else {
+        const { value, options } = optional;
+        res.setCookie(key, value, options);
+      }
+    });
+  } catch (e) {
+    log.error(`${colors2.red("[cookies error]")} ${req.url} 
+`, e);
+  }
+}
+async function realDelay(startTime, delay) {
+  if (!delay || delay <= 0)
+    return;
+  const diff = Date.now() - startTime;
+  const realDelay2 = delay - diff;
+  if (realDelay2 > 0)
+    await sleep(realDelay2);
+}
 function doesProxyContextMatchUrl(context, url) {
   return context.startsWith("^") && new RegExp(context).test(url) || url.startsWith(context);
 }
@@ -696,7 +778,7 @@ var _MockLoader = class extends EventEmitter {
         metafile: true,
         format: isESM ? "esm" : "cjs",
         define: this.options.define,
-        plugins: [externalizeDeps]
+        plugins: [aliasPlugin(this.options.alias), externalizeDeps]
       });
       return {
         code: result.outputFiles[0].text,
@@ -727,7 +809,8 @@ async function mockServerMiddleware(config, options, httpServer, ws) {
   const loader = new MockLoader({
     include,
     exclude,
-    define
+    define,
+    alias: config.resolve.alias
   });
   await loader.load();
   httpServer == null ? void 0 : httpServer.on("close", () => loader.close());
@@ -740,7 +823,8 @@ async function mockServerMiddleware(config, options, httpServer, ws) {
   const prefix = ensureArray(options.prefix);
   return baseMiddleware(loader, {
     formidableOptions: options.formidableOptions,
-    proxies: [...prefix, ...proxies]
+    proxies: [...prefix, ...proxies],
+    cookiesOptions: options.cookiesOptions
   });
 }
 
@@ -748,20 +832,18 @@ async function mockServerMiddleware(config, options, httpServer, ws) {
 function mockDevServerPlugin({
   prefix = [],
   include = ["mock/**/*.mock.{js,ts,cjs,mjs,json,json5}"],
-  exclude = [
-    "**/node_modules/**",
-    "**/.vscode/**",
-    "**/.git/**"
-  ],
+  exclude = ["**/node_modules/**", "**/.vscode/**", "**/.git/**"],
   reload = false,
   formidableOptions = {},
-  build: build3 = false
+  build: build3 = false,
+  cookiesOptions = {}
 } = {}) {
   const pluginOptions = {
     prefix,
     include,
     exclude,
     reload,
+    cookiesOptions,
     formidableOptions: {
       multiples: true,
       ...formidableOptions
@@ -833,11 +915,23 @@ function serverPlugin(pluginOptions) {
 function defineMock(config) {
   return config;
 }
+function createDefineMock(transformer) {
+  const define = (config) => {
+    if (isArray(config)) {
+      config = config.map((item) => transformer(item) || item);
+    } else {
+      config = transformer(config) || config;
+    }
+    return config;
+  };
+  return define;
+}
 
 // src/index.ts
 var src_default = mockDevServerPlugin;
 export {
   baseMiddleware,
+  createDefineMock,
   src_default as default,
   defineMock,
   mockDevServerPlugin,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vite-plugin-mock-dev-server",
-  "version": "1.0.6",
+  "version": "1.1.0",
   "keywords": [
     "vite",
     "plugin",
@@ -32,33 +32,35 @@
   "dependencies": {
     "chokidar": "^3.5.3",
     "co-body": "^6.1.0",
+    "cookies": "^0.8.0",
     "debug": "^4.3.4",
-    "esbuild": "^0.17.12",
+    "esbuild": "^0.17.17",
     "fast-glob": "^3.2.12",
     "formidable": "^2.1.1",
     "http-status": "^1.6.2",
-    "is-core-module": "^2.11.0",
+    "is-core-module": "^2.12.0",
     "json5": "^2.2.3",
     "path-to-regexp": "^6.2.1",
     "picocolors": "^1.0.0"
   },
   "devDependencies": {
-    "@pengzhanbo/eslint-config-ts": "^0.3.2",
-    "@pengzhanbo/prettier-config": "^0.3.2",
+    "@pengzhanbo/eslint-config-ts": "^0.3.4",
+    "@pengzhanbo/prettier-config": "^0.3.4",
     "@types/co-body": "^6.1.0",
+    "@types/cookies": "^0.7.7",
     "@types/debug": "^4.1.7",
     "@types/formidable": "^2.0.5",
     "@types/is-core-module": "^2.2.0",
-    "@types/node": "^18.15.5",
-    "bumpp": "^9.0.0",
+    "@types/node": "^18.15.12",
+    "bumpp": "^9.1.0",
     "conventional-changelog-cli": "^2.2.2",
-    "eslint": "^8.36.0",
+    "eslint": "^8.38.0",
     "mockjs": "^1.1.0",
-    "prettier": "^2.8.6",
+    "prettier": "^2.8.7",
     "tsup": "^6.7.0",
-    "typescript": "^5.0.2",
-    "vite": "^4.2.1",
-    "vitepress": "1.0.0-alpha.61",
+    "typescript": "^5.0.4",
+    "vite": "^4.3.0",
+    "vitepress": "1.0.0-alpha.73",
     "vue": "^3.2.47"
   },
   "peerDependencies": {