vite-plugin-json-server 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Willyams Yujra
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,73 @@
+**vite-plugin-json-server**
+![vite-plugin-json-server](https://github.com/yracnet/vite-plugin-json-server)
+
+## Description
+
+vite-plugin-json-server is a plugin for Vite.js that integrates the json-server library, providing a simple way to serve a mock RESTful API during development. It enables you to quickly set up a server and define JSON data as endpoints, allowing you to simulate backend functionality without the need for a real server.
+This plugin is designed to seamlessly integrate with Vite.js, leveraging its fast and efficient development server. By combining the power of Vite.js and json-server, you can streamline your frontend development process and focus on building your application.
+
+## Motivation
+
+During frontend development, it is often necessary to work with an API before the actual backend is ready or available. This can cause delays and hinder the development process. With vite-plugin-json-server, you can overcome this hurdle by creating a mock API server with minimal effort. It allows you to define your data, endpoints, and even custom routes, providing a flexible and efficient solution for frontend development.
+
+## How to Use
+
+1. Install the plugin using npm or yarn:
+
+```bash
+npm install vite-plugin-json-server --save-dev
+```
+
+or
+
+```bash
+yarn add vite-plugin-json-server --dev
+```
+
+2. Import and use the plugin in your `vite.config.js` file:
+
+```javascript
+import jsonServer from "vite-plugin-json-server";
+export default {
+  plugins: [
+    jsonServer({
+      // Configuration options
+    }),
+  ],
+};
+```
+
+3. Start your Vite development server:
+
+```bash
+npm run dev
+```
+
+4. Your mock API server will be available at `http://localhost:5173` by default.
+
+## Configuration
+
+The plugin supports the following configuration options:
+
+- `apiPath`: The base path for publishing json-server services. Default value: '/api'.
+- `profile`: The profile name as directory name where other files are referenced. It can be used to customize data profile as needed. The default value is an empty string. You can use 'db-dev' or 'db1' as profile names.
+- `source`: The resource to load and pass as main parameters to json-server. It is used with `join(profile, source)` when compiling.
+- `static`: The name of the profile that contains static files. It is derived from `join(profile, source)`.
+- `unwatch`: An inverse flag for the `watch` option that monitors and reloads the server when changes are detected.
+- `readOnly`: A flag for json-server to enable read-only mode.
+- `bodyParser`: A flag for json-server to enable body parsing.
+- `noCors`: A flag for json-server to disable CORS (Cross-Origin Resource Sharing).
+- `noGzip`: A flag for json-server to disable Gzip compression.
+- `delay`: The delay value for json-server to simulate network latency.
+- `id`: The value for json-server's `id` option.
+- `foreignKeySuffix`: The value for json-server's `foreignKeySuffix` option.
+- `quiet`: The value for json-server's `quiet` option.
+  Please refer to the [json-server documentation](https://github.com/typicode/json-server) for more details on these configuration options.
+
+**Note:** The following options are not yet supported by the plugin and will be implemented in a future version: `routes`, `snapshots`, and `middlewares`.
+
+**Note:** The `host` and `port` options are excluded form the plugin.
+
+## License
+
+This plugin is licensed under the [MIT License](https://opensource.org/licenses/MIT).

package/dist/index.cjs

@@ -0,0 +1,142 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  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
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  default: () => src_default,
+  pluginJsonServer: () => pluginJsonServer
+});
+module.exports = __toCommonJS(src_exports);
+var import_json_server = __toESM(require("json-server"), 1);
+var import_path = require("path");
+var import_is = __toESM(require("json-server/lib/cli/utils/is"), 1);
+var import_load = __toESM(require("json-server/lib/cli/utils/load"), 1);
+var import_connect_pause = __toESM(require("connect-pause"), 1);
+var assertPluginOptions = (pluginOptions) => {
+  const {
+    apiPath = "/api",
+    profile = "",
+    source = "db.json",
+    static: staticDir = "public",
+    // routes = "routes.json",
+    // snapshots = "snapshots",
+    // middlewares = [],
+    unwatch = false,
+    readOnly = false,
+    bodyParser = true,
+    noCors = false,
+    noGzip = false,
+    delay = 10,
+    id = "_id",
+    foreignKeySuffix = "_id",
+    quiet = false
+  } = pluginOptions;
+  return {
+    apiPath,
+    profile,
+    source: import_is.default.URL(source) ? source : (0, import_path.join)(profile, source),
+    static: (0, import_path.join)(profile, staticDir),
+    // routes: join(profile, staticDir),
+    // snapshots: join(profile, snapshots),
+    // middlewares: join(profile, middlewares),
+    unwatch,
+    readOnly,
+    bodyParser,
+    noCors,
+    noGzip,
+    delay,
+    id,
+    foreignKeySuffix,
+    quiet
+  };
+};
+var pluginJsonServer = (userOptions = {}) => {
+  const opts = assertPluginOptions(userOptions);
+  const createServer = async (config) => {
+    const { root, logger } = config;
+    try {
+      const routeOpts = {
+        id: opts.id,
+        foreignKeySuffix: opts.foreignKeySuffix
+      };
+      const defaultsOpts = {
+        static: (0, import_path.join)(root, opts.static),
+        logger: !opts.quiet,
+        readOnly: opts.readOnly,
+        noCors: opts.noCors,
+        noGzip: opts.noGzip,
+        bodyParser: opts.bodyParser
+      };
+      logger.info("  Loading: " + opts.source);
+      const db = await (0, import_load.default)(opts.source);
+      const app = import_json_server.default.create();
+      const router = import_json_server.default.router(db, routeOpts);
+      const defaults = import_json_server.default.defaults(defaultsOpts);
+      app.use(defaults);
+      if (opts.delay) {
+        logger.info("  Delay: " + opts.delay);
+        app.use((0, import_connect_pause.default)(opts.delay));
+      }
+      app.use(router);
+      return app;
+    } catch (error) {
+      console.log("createServer Error:", error);
+      return void 0;
+    }
+  };
+  return {
+    name: "vite-plugin-json-server",
+    configureServer: async (devServer) => {
+      const { config, watcher } = devServer;
+      let app = await createServer(config);
+      if (!opts.unwatch) {
+        const files = [opts.source];
+        watcher.on("change", async (file) => {
+          const reload = files.find((it) => file.endsWith(it));
+          if (reload) {
+            console.error(`Change file '${file}'`);
+            app = await createServer(config);
+          }
+        });
+      }
+      devServer.middlewares.use(
+        opts.apiPath,
+        (req, res, next) => {
+          app && app(req, res, next);
+        }
+      );
+    }
+  };
+};
+var src_default = pluginJsonServer;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  pluginJsonServer
+});

package/dist/index.d.ts

@@ -0,0 +1,20 @@
+import { Plugin } from 'vite';
+
+type PluginOptions = {
+    source: string;
+    apiPath: string;
+    profile: string;
+    static: string;
+    unwatch: boolean;
+    readOnly: boolean;
+    bodyParser: boolean;
+    noCors: boolean;
+    noGzip: boolean;
+    delay: number;
+    id: string;
+    foreignKeySuffix: string;
+    quiet: boolean;
+};
+declare const pluginJsonServer: (userOptions?: Partial<PluginOptions>) => Plugin;
+
+export { pluginJsonServer as default, pluginJsonServer };

package/dist/index.js

@@ -0,0 +1,107 @@
+// src/index.ts
+import jsonServer from "json-server";
+import { join } from "path";
+import is from "json-server/lib/cli/utils/is";
+import load from "json-server/lib/cli/utils/load";
+import pause from "connect-pause";
+var assertPluginOptions = (pluginOptions) => {
+  const {
+    apiPath = "/api",
+    profile = "",
+    source = "db.json",
+    static: staticDir = "public",
+    // routes = "routes.json",
+    // snapshots = "snapshots",
+    // middlewares = [],
+    unwatch = false,
+    readOnly = false,
+    bodyParser = true,
+    noCors = false,
+    noGzip = false,
+    delay = 10,
+    id = "_id",
+    foreignKeySuffix = "_id",
+    quiet = false
+  } = pluginOptions;
+  return {
+    apiPath,
+    profile,
+    source: is.URL(source) ? source : join(profile, source),
+    static: join(profile, staticDir),
+    // routes: join(profile, staticDir),
+    // snapshots: join(profile, snapshots),
+    // middlewares: join(profile, middlewares),
+    unwatch,
+    readOnly,
+    bodyParser,
+    noCors,
+    noGzip,
+    delay,
+    id,
+    foreignKeySuffix,
+    quiet
+  };
+};
+var pluginJsonServer = (userOptions = {}) => {
+  const opts = assertPluginOptions(userOptions);
+  const createServer = async (config) => {
+    const { root, logger } = config;
+    try {
+      const routeOpts = {
+        id: opts.id,
+        foreignKeySuffix: opts.foreignKeySuffix
+      };
+      const defaultsOpts = {
+        static: join(root, opts.static),
+        logger: !opts.quiet,
+        readOnly: opts.readOnly,
+        noCors: opts.noCors,
+        noGzip: opts.noGzip,
+        bodyParser: opts.bodyParser
+      };
+      logger.info("  Loading: " + opts.source);
+      const db = await load(opts.source);
+      const app = jsonServer.create();
+      const router = jsonServer.router(db, routeOpts);
+      const defaults = jsonServer.defaults(defaultsOpts);
+      app.use(defaults);
+      if (opts.delay) {
+        logger.info("  Delay: " + opts.delay);
+        app.use(pause(opts.delay));
+      }
+      app.use(router);
+      return app;
+    } catch (error) {
+      console.log("createServer Error:", error);
+      return void 0;
+    }
+  };
+  return {
+    name: "vite-plugin-json-server",
+    configureServer: async (devServer) => {
+      const { config, watcher } = devServer;
+      let app = await createServer(config);
+      if (!opts.unwatch) {
+        const files = [opts.source];
+        watcher.on("change", async (file) => {
+          const reload = files.find((it) => file.endsWith(it));
+          if (reload) {
+            console.error(`Change file '${file}'`);
+            app = await createServer(config);
+          }
+        });
+      }
+      devServer.middlewares.use(
+        opts.apiPath,
+        (req, res, next) => {
+          app && app(req, res, next);
+        }
+      );
+    }
+  };
+};
+var src_default = pluginJsonServer;
+export {
+  src_default as default,
+  pluginJsonServer
+};

package/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "vite-plugin-json-server",
+  "version": "0.1.0",
+  "type": "module",
+  "description": "A plugin that integrates json-server with Vite.js, providing a simple way to mock REST APIs during development.",
+  "keywords": [
+    "vite",
+    "json",
+    "json-server",
+    "server",
+    "mock",
+    "mockAPI"
+  ],
+  "files": [
+    "dist",
+    "LICENSE"
+  ],
+  "license": "MIT",
+  "author": "Willyams Yujra <yracnet@gmail.com>",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/yracnet/vite-plugin-json-server"
+  },
+  "main": "dist/index.js",
+  "module": "dist/index.cjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "require": "./dist/index.js",
+      "import": "./dist/index.cjs",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "homepage": "https://github.com/yracnet/vite-plugin-json-server",
+  "bugs": "https://github.com/yracnet/vite-plugin-json-server/issues",
+  "scripts": {
+    "build": "tsup"
+  },
+  "dependencies": {},
+  "peerDependencies": {
+    "vite": "^4.0.0",
+    "json-server": "^0.17.3"
+  },
+  "devDependencies": {
+    "@types/connect": "^3.4.35",
+    "@types/json-server": "^0.14.4",
+    "@types/node": "^18.11.15",
+    "json-server": "^0.17.3",
+    "tsup": "^6.5.0",
+    "typescript": "^4.9.3",
+    "vite": "^4.0.0"
+  }
+}