vite-plugin-mock-data 1.0.0 → 4.0.1

package/README.md

@@ -2,7 +2,7 @@
 
 [![npm package](https://nodei.co/npm/vite-plugin-mock-data.png?downloads=true&downloadRank=true&stars=true)](https://www.npmjs.com/package/vite-plugin-mock-data)
 
-> Provides a simple way to mock data.
+> Provides a simple way to mock data. Vite >= 3.1
 
 [![NPM version](https://img.shields.io/npm/v/vite-plugin-mock-data.svg?style=flat)](https://npmjs.org/package/vite-plugin-mock-data)
 [![NPM Downloads](https://img.shields.io/npm/dm/vite-plugin-mock-data.svg?style=flat)](https://npmjs.org/package/vite-plugin-mock-data)
@@ -15,9 +15,10 @@ npm install vite-plugin-mock-data --save-dev
 
 ## Options
 
-* `isAfter` - If `true`, these mock routes is matched before internal middlewares are installed.
+* `cwd` - Default: `process.cwd()`.
+* `isAfter` - If `true`, these mock routes is matched after internal middlewares are installed.
 * `mockAssetsDir` - Specify the directory to define mock assets.
-* `mockRouterOptions` - [Initial options of `find-my-way`'](https://github.com/delvedor/find-my-way#findmywayoptions)
+* `mockRouterOptions` - [Initial options of `find-my-way`](https://github.com/delvedor/find-my-way#findmywayoptions)
 * `mockRoutes` - Initial list of mock routes that should be added to the dev server.
 * `mockRoutesDir` - Specify the directory to define mock routes that should be added to the dev server.
 
@@ -80,10 +81,10 @@ export default defineConfig({
         },
         '/json': {
           handler: { hello: 1 }
-        }
+        },
         '/package.json': {
           file: './package.json'
-        },
+        }
       }
     })
   ]
@@ -135,10 +136,10 @@ module.exports = {
   },
   '/json': {
     handler: { hello: 1 }
-  }
+  },
   '/package.json': {
     file: './package.json'
-  },
+  }
 };
 ```
 
@@ -152,4 +153,6 @@ fetch('/package.json')
 
 ## Examples
 
-**[See demo](examples/demo-mock-data)**
+* [See vite3 demo](../../examples/vite3-mock-data) 
+* [See vite4 demo](../../examples/vite4-mock-data)
+* [See vite5 demo](../../examples/vite5-mock-data)

package/dist/index.d.ts

@@ -0,0 +1,37 @@
+import { Config as SirvConfig, HTTPVersion, RouteOptions, Handler } from 'find-my-way';
+import { Plugin } from 'vite';
+export interface HandleRoute {
+    file?: string;
+    handler?: any | Handler<HTTPVersion.V1>;
+    options?: RouteOptions;
+    store?: any;
+}
+export interface RouteConfig {
+    [route: string]: string | Handler<HTTPVersion.V1> | HandleRoute;
+}
+export interface Options {
+    /**
+     * The directory to serve files from.
+     * @default `process.cwd()`
+     */
+    cwd?: string;
+    /**
+     * If `true`, these mock routes is matched after internal middlewares are installed.
+     * @default `false`
+     */
+    isAfter?: boolean;
+    /** Specify the directory to define mock assets. */
+    mockAssetsDir?: string;
+    /** Initial options of `find-my-way`. see more at https://github.com/delvedor/find-my-way#findmywayoptions */
+    mockRouterOptions?: SirvConfig<HTTPVersion.V1> | SirvConfig<HTTPVersion.V2>;
+    /** Initial list of mock routes that should be added to the dev server. */
+    mockRoutes?: RouteConfig | RouteConfig[];
+    /** Specify the directory to define mock routes that should be added to the dev server. */
+    mockRoutesDir?: string;
+}
+/**
+ * Provides a simple way to mock data.
+ * @param opts Options
+ * @returns a vite plugin
+ */
+export default function createPlugin(opts: Options): Plugin;

package/dist/index.js

@@ -0,0 +1,129 @@
+"use strict";
+const node_path = require("node:path");
+const node_module = require("node:module");
+const node_fs = require("node:fs");
+const globby = require("globby");
+const getRouter = require("find-my-way");
+const sirv = require("sirv");
+const vite = require("vite");
+var _documentCurrentScript = typeof document !== "undefined" ? document.currentScript : null;
+function isObject(val) {
+  return val && typeof val === "object";
+}
+function toAbsolute(pth, cwd) {
+  return node_path.isAbsolute(pth) ? pth : node_path.posix.join(cwd || process.cwd(), pth);
+}
+function sirvOptions(headers) {
+  return {
+    dev: true,
+    etag: true,
+    extensions: [],
+    setHeaders(res, pathname) {
+      res.setHeader("Access-Control-Allow-Origin", "*");
+      if (/\.[tj]sx?$/.test(pathname)) {
+        res.setHeader("Content-Type", "application/javascript");
+      }
+      if (headers) {
+        Object.entries(headers).forEach(([key, val]) => {
+          if (val) {
+            res.setHeader(key, val);
+          }
+        });
+      }
+    }
+  };
+}
+function configureServer(server, routerOpts, routes, serve, cwd) {
+  const router = getRouter(routerOpts);
+  if (Array.isArray(routes)) {
+    routes.forEach((route) => {
+      Object.keys(route).forEach((xpath) => {
+        let [methods, pathname] = xpath.split(" ");
+        if (!pathname) {
+          pathname = methods;
+          methods = "GET";
+        }
+        let routeConfig = route[xpath];
+        if (!isObject(routeConfig)) {
+          routeConfig = { handler: routeConfig };
+        }
+        let handler;
+        if (typeof routeConfig.file === "string") {
+          handler = (req, res) => {
+            const parsedPath = node_path.parse(toAbsolute(routeConfig.file, cwd));
+            const serve2 = sirv(parsedPath.dir, sirvOptions(server.config.server.headers));
+            req.url = `/${parsedPath.base}`;
+            serve2(req, res);
+          };
+        } else if (typeof routeConfig.handler !== "function") {
+          const ret = routeConfig.handler;
+          const retType = typeof ret;
+          handler = (req, res) => {
+            vite.send(req, res, retType !== "string" ? JSON.stringify(ret) : ret, isObject(ret) ? "json" : "html", {
+              headers: server.config.server.headers
+            });
+          };
+        } else {
+          handler = routeConfig.handler;
+        }
+        if (handler) {
+          router.on(methods.split("/"), pathname, {}, handler, routeConfig.store);
+        }
+      });
+    });
+  }
+  if (serve) {
+    server.middlewares.use(serve);
+  }
+  server.middlewares.use((req, res, next) => {
+    router.defaultRoute = () => next();
+    router.lookup(req, res);
+  });
+}
+function createPlugin(opts) {
+  const { isAfter, mockRouterOptions, mockAssetsDir } = opts;
+  let { cwd, mockRoutesDir } = opts;
+  let mockRoutes = opts.mockRoutes || [];
+  if (!cwd) {
+    cwd = process.cwd();
+  }
+  if (isObject(mockRoutes) && !Array.isArray(mockRoutes)) {
+    mockRoutes = [mockRoutes];
+  }
+  return {
+    name: "vite:mock-data",
+    async configureServer(server) {
+      if (mockRoutesDir) {
+        mockRoutesDir = toAbsolute(mockRoutesDir, cwd);
+        const paths = await globby.globby(`${mockRoutesDir}/**/*.{js,mjs,json}`);
+        await Promise.all(paths.map((file) => {
+          return (async () => {
+            let config;
+            switch (node_path.extname(file)) {
+              case ".js":
+                config = node_module.createRequire(typeof document === "undefined" ? require("url").pathToFileURL(__filename).href : _documentCurrentScript && _documentCurrentScript.src || new URL("index.js", document.baseURI).href)(file);
+                break;
+              case ".mjs":
+                config = (await import(file)).default;
+                break;
+              case ".json":
+                config = JSON.parse(node_fs.readFileSync(file, "utf-8"));
+                break;
+            }
+            if (config) {
+              mockRoutes.push(config);
+            }
+          })();
+        }));
+      }
+      let serve = null;
+      if (mockAssetsDir) {
+        serve = sirv(toAbsolute(mockAssetsDir, cwd), sirvOptions(server.config.server.headers));
+      }
+      if (mockRoutes && mockRoutes.length > 0) {
+        return isAfter ? () => configureServer(server, mockRouterOptions, mockRoutes, serve, cwd) : configureServer(server, mockRouterOptions, mockRoutes, serve, cwd);
+      }
+    }
+  };
+}
+module.exports = createPlugin;

package/dist/index.mjs

@@ -0,0 +1,129 @@
+import { extname, isAbsolute, posix, parse } from "node:path";
+import { createRequire } from "node:module";
+import { readFileSync } from "node:fs";
+import { globby } from "globby";
+import getRouter from "find-my-way";
+import sirv from "sirv";
+import { send } from "vite";
+function isObject(val) {
+  return val && typeof val === "object";
+}
+function toAbsolute(pth, cwd) {
+  return isAbsolute(pth) ? pth : posix.join(cwd || process.cwd(), pth);
+}
+function sirvOptions(headers) {
+  return {
+    dev: true,
+    etag: true,
+    extensions: [],
+    setHeaders(res, pathname) {
+      res.setHeader("Access-Control-Allow-Origin", "*");
+      if (/\.[tj]sx?$/.test(pathname)) {
+        res.setHeader("Content-Type", "application/javascript");
+      }
+      if (headers) {
+        Object.entries(headers).forEach(([key, val]) => {
+          if (val) {
+            res.setHeader(key, val);
+          }
+        });
+      }
+    }
+  };
+}
+function configureServer(server, routerOpts, routes, serve, cwd) {
+  const router = getRouter(routerOpts);
+  if (Array.isArray(routes)) {
+    routes.forEach((route) => {
+      Object.keys(route).forEach((xpath) => {
+        let [methods, pathname] = xpath.split(" ");
+        if (!pathname) {
+          pathname = methods;
+          methods = "GET";
+        }
+        let routeConfig = route[xpath];
+        if (!isObject(routeConfig)) {
+          routeConfig = { handler: routeConfig };
+        }
+        let handler;
+        if (typeof routeConfig.file === "string") {
+          handler = (req, res) => {
+            const parsedPath = parse(toAbsolute(routeConfig.file, cwd));
+            const serve2 = sirv(parsedPath.dir, sirvOptions(server.config.server.headers));
+            req.url = `/${parsedPath.base}`;
+            serve2(req, res);
+          };
+        } else if (typeof routeConfig.handler !== "function") {
+          const ret = routeConfig.handler;
+          const retType = typeof ret;
+          handler = (req, res) => {
+            send(req, res, retType !== "string" ? JSON.stringify(ret) : ret, isObject(ret) ? "json" : "html", {
+              headers: server.config.server.headers
+            });
+          };
+        } else {
+          handler = routeConfig.handler;
+        }
+        if (handler) {
+          router.on(methods.split("/"), pathname, {}, handler, routeConfig.store);
+        }
+      });
+    });
+  }
+  if (serve) {
+    server.middlewares.use(serve);
+  }
+  server.middlewares.use((req, res, next) => {
+    router.defaultRoute = () => next();
+    router.lookup(req, res);
+  });
+}
+function createPlugin(opts) {
+  const { isAfter, mockRouterOptions, mockAssetsDir } = opts;
+  let { cwd, mockRoutesDir } = opts;
+  let mockRoutes = opts.mockRoutes || [];
+  if (!cwd) {
+    cwd = process.cwd();
+  }
+  if (isObject(mockRoutes) && !Array.isArray(mockRoutes)) {
+    mockRoutes = [mockRoutes];
+  }
+  return {
+    name: "vite:mock-data",
+    async configureServer(server) {
+      if (mockRoutesDir) {
+        mockRoutesDir = toAbsolute(mockRoutesDir, cwd);
+        const paths = await globby(`${mockRoutesDir}/**/*.{js,mjs,json}`);
+        await Promise.all(paths.map((file) => {
+          return (async () => {
+            let config;
+            switch (extname(file)) {
+              case ".js":
+                config = createRequire(import.meta.url)(file);
+                break;
+              case ".mjs":
+                config = (await import(file)).default;
+                break;
+              case ".json":
+                config = JSON.parse(readFileSync(file, "utf-8"));
+                break;
+            }
+            if (config) {
+              mockRoutes.push(config);
+            }
+          })();
+        }));
+      }
+      let serve = null;
+      if (mockAssetsDir) {
+        serve = sirv(toAbsolute(mockAssetsDir, cwd), sirvOptions(server.config.server.headers));
+      }
+      if (mockRoutes && mockRoutes.length > 0) {
+        return isAfter ? () => configureServer(server, mockRouterOptions, mockRoutes, serve, cwd) : configureServer(server, mockRouterOptions, mockRoutes, serve, cwd);
+      }
+    }
+  };
+}
+export {
+  createPlugin as default
+};

package/package.json

@@ -1,10 +1,21 @@
 {
   "name": "vite-plugin-mock-data",
-  "version": "1.0.0",
+  "version": "4.0.1",
   "description": "Provides a simple way to mock data.",
-  "main": "index.js",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
   "scripts": {
-    "release": "npm publish"
+    "release": "npm publish",
+    "build": "vite build",
+    "watch": "vite build --watch"
   },
   "repository": {
     "type": "git",
@@ -16,14 +27,16 @@
     "vite-plugin-mock-data"
   ],
   "author": "Jesse Feng <fxm0016@126.com>",
-  "license": "MIT",
   "bugs": {
     "url": "https://github.com/fengxinming/vite-plugins/issues"
   },
   "homepage": "https://github.com/fengxinming/vite-plugins#readme",
   "dependencies": {
-    "find-my-way": "^7.0.0",
-    "globby": "^11.1.0",
+    "find-my-way": "^7.6.2",
+    "globby": "^13.2.2",
     "sirv": "^2.0.2"
-  }
-}
+  },
+  "files": [
+    "dist"
+  ]
+}

package/index.d.ts

@@ -1,22 +0,0 @@
-import { Plugin } from 'vite';
-import { IncomingMessage, ServerResponse } from 'http';
-import Router from 'find-my-way';
-
-export function Handler (req: IncomingMessage, res: ServerResponse): void;
-
-export interface HandleRoute {
-  file?: string;
-  handler?: string | Handler;
-}
-
-export type RouteConfig = string | HandleRoute;
-
-export interface Options {
-  isAfter?: boolean;
-  mockAssetsDir: string;
-  mockRouterOptions?: Router.Config;
-  mockRoutes?: RouteConfig | RouteConfig[]
-  mockRoutesDir?: string;
-}
-
-export default function createPlugin(options?: Options): Plugin;

package/index.js

@@ -1,134 +0,0 @@
-'use strict';
-
-const globby = require('globby');
-const { isAbsolute, join, parse } = require('path');
-const Router = require('find-my-way');
-const { send } = require('vite');
-const sirv = require('sirv');
-
-function isObject(val) {
-  return val && typeof val === 'object';
-}
-
-function sirvOptions(headers) {
-  return {
-    dev: true,
-    etag: true,
-    extensions: [],
-    setHeaders(res, pathname) {
-      res.setHeader('Access-Control-Allow-Origin', '*');
-      if (/\.[tj]sx?$/.test(pathname)) {
-        res.setHeader('Content-Type', 'application/javascript');
-      }
-      if (headers) {
-        // eslint-disable-next-line guard-for-in
-        for (const name in headers) {
-          res.setHeader(name, headers[name]);
-        }
-      }
-    }
-  };
-}
-
-function configureServer(server, routerOpts, routes, serve) {
-  const router = new Router(routerOpts);
-  if (Array.isArray(routes)) {
-    routes.forEach((route) => {
-      Object.keys(route).forEach((xpath) => {
-        let [methods, pathname] = xpath.split(' ');
-        if (!pathname) {
-          pathname = methods;
-          methods = 'GET';
-        }
-        let handler = route[xpath];
-        let file;
-        if (!isObject(handler)) {
-          handler = { handler };
-        }
-        else if ((file = handler.file)) {
-          handler.handler = (req, res) => {
-            file = isAbsolute(file) ? file : join(process.cwd(), file);
-            const parsedPath = parse(file);
-            const serve = sirv(parsedPath.dir, sirvOptions(server.config.server.headers));
-            req.url = `/${parsedPath.base}`;
-            serve(req, res);
-          };
-        }
-        if (typeof handler.handler !== 'function') {
-          const ret = handler.handler;
-          const retType =  typeof ret;
-          handler.handler = (req, res) => {
-            send(
-              req,
-              res,
-              retType !== 'string' ? JSON.stringify(ret) : ret,
-              isObject(ret) ? 'json' : 'html',
-              {
-                headers: server.config.server.headers
-              }
-            );
-          };
-        }
-
-        router.on(
-          methods.split('/'),
-          pathname,
-          handler.opts || {},
-          handler.handler,
-          handler.store
-        );
-      });
-    });
-  }
-
-  if (serve) {
-    server.middlewares.use(serve);
-  }
-
-  server.middlewares.use((req, res, next) => {
-    router.defaultRoute = () => next();
-    router.lookup(req, res);
-  });
-}
-
-module.exports = function (opts = {}) {
-  const {
-    isAfter,
-    mockRouterOptions,
-    mockAssetsDir
-  } = opts;
-  let {
-    mockRoutesDir,
-    mockRoutes = []
-  } = opts;
-
-  if (isObject(mockRoutes) && !Array.isArray(mockRoutes)) {
-    mockRoutes = [mockRoutes];
-  }
-
-  return {
-    name: 'vite:mock-data',
-
-    configureServer(server) {
-      if (mockRoutesDir) {
-        mockRoutesDir = isAbsolute(mockRoutesDir) ? mockRoutesDir : join(process.cwd(), mockRoutesDir);
-        globby.sync(`${mockRoutesDir}/**/*.js`).forEach((file) => {
-          delete require.cache[file];
-          mockRoutes.push(require(file));
-        });
-      }
-
-      let serve;
-      if (mockAssetsDir) {
-        serve = sirv(
-          isAbsolute(mockAssetsDir) ? mockAssetsDir : join(process.cwd(), mockAssetsDir),
-          sirvOptions(server.config.server.headers)
-        );
-      }
-
-      return isAfter
-        ? () => configureServer(server, mockRouterOptions, mockRoutes, serve)
-        : configureServer(server, mockRouterOptions, mockRoutes, serve);
-    }
-  };
-};