jgloo 1.9.4 → 2.0.0

package/README.md

@@ -1,242 +1,242 @@
-<p align="center"><img src="logo.png" alt="jgloo logo" height="120"></p>
-
-# jgloo
-
-![npm](https://img.shields.io/npm/v/jgloo?style=flat-square)
-![npm bundle size](https://img.shields.io/bundlephobia/min/jgloo?style=flat-square)
-![license](https://img.shields.io/npm/l/jgloo?style=flat-square)
-[![Issues](https://img.shields.io/github/issues/zosma180/jgloo.svg?style=flat-square)](https://github.com/zosma180/jgloo/issues)
-
----
-
-## Description
-
-**jgloo** is a local HTTP server useful to mock your backend API and speed up the client development.  
-This project is based on the Node framework Express. The highlights are:
-
-- Create a ReST API with two rows of code
-- Create custom API easily
-- Create custom middleware easily (e.g. auth check)
-- Store data in accessible JSON files
-- Reload the live changes of your mocks automatically (thanks to nodemon package)
-- Expose a dedicated folder for the static files (images, assets etc...)
-- Support to multipart/form-data requests
-
----
-
-## Installation
-
-```bash
-npm i -D jgloo
-```
-
-After the installation create a folder "mock" in your project root (you can use another path and folder name if you want).  
-The **only requirement** is to create a subfolder "api" in your chosen path (e.g. "mock/api").  
-Now you are ready to [create your first API](#create-a-simple-api).
-
----
-
-## Guide
-
-- [Create a simple API](#create-a-simple-api)
-- [Create a default ReST API](#create-a-default-rest-api)
-- [Create a custom ReST API](#create-a-custom-rest-api)
-- [Create a middleware](#create-a-middleware)
-- [Where data are stored](#where-data-are-stored)
-- [Expose the static files](#expose-the-static-files)
-- [Handle requests with file uploads](#handle-requests-with-file-uploads)
-- [Simulate network delay](#simulate-network-delay)
-- [Manage path conflicts](#manage-path-conflicts)
-- [Run the server](#run-the-server)
-
----
-
-### Create a simple API
-
-To setup your first API create a new file "hello.js" in the "api" folder. The name of the file does not matter. Then insert the following snippet:
-
-```javascript
-module.exports = {
-  path: '/hello',
-  method: 'get',
-  callback: (req, res) => {
-    res.json({ message: 'Hello World!' });
-  },
-};
-```
-
-This code define the GET route http://localhost:3000/hello that returns a JSON with data "{ message: 'Hello World!' }".  
-You are ready to [run the server](#run-the-server) now.
-
----
-
-### Create a default ReST API
-
-To setup a ReST API, you have to create a new file in the "api" folder with the name you prefer and the following snippet:
-
-```javascript
-module.exports = {
-  path: '/user',
-  method: 'resource',
-};
-```
-
-With these few rows of code will be created 6 routes:
-
-- GET /user : return the list of users;
-- GET /user/:id : return the specific user;
-- POST /user : allow to store the full request body as new user and return it as response;
-- PUT /user/:id : allow to replace an existent user with the full request body and return it as response;
-- PATCH /user/:id : allow to merge an existent user data with the request body values and return it as response;
-- DELETE /user/:id : allow to delete an existent user and return the deleted id.
-
-If you want to skip any of the previous routes, you can add the "not" property:
-
-```javascript
-module.exports = {
-  path: '/user',
-  method: 'resource',
-  not: ['LIST']
-};
-```
-The available values of the "not" property are ['LIST', 'READ', 'CREATE', 'UPDATE', 'PATCH', 'DELETE']
-
----
-
-### Create a custom ReST API
-
-If you need to control the logic of your resources, you can create a custom API that read and/or write the data in the JSON database.  
-To achieve it create a new file in the "api" folder with the name you prefer and the following snippet:
-
-```javascript
-const { getResource, setResource } = require('jgloo');
-
-module.exports = {
-  path: '/user',
-  method: 'post',
-  callback: (req, res) => {
-    // Get the existent resource list or instantiate it
-    const list = getResource('user') || [];
-
-    // Get the data of the request and add a new field
-    const user = req.body;
-    user.extraField = 'value';
-
-    // Push the new model to the list
-    list.push(user);
-
-    // Store the updated list in the "user.json" file
-    setResource('user', list);
-
-    // Return the model as JSON
-    res.json(user);
-  },
-};
-```
-
----
-
-### Create a middleware
-
-To add a middleware, you have to create a folder "middlewares" in your chosen root path (e.g. "mock/middlewares").  
-Then create a new file inside with the name you prefer and the following sample snippet:
-
-```javascript
-module.exports = (req, res, next) => {
-  const isAuthorized = req.get('Authorization') === 'my-token';
-  isAuthorized ? next() : res.sendStatus(401);
-};
-```
-
-This sample code check for all routes if the "Authorization" header is set and it has the value "my-token".
-
----
-
-### Where data are stored
-
-The resources are stored in JSON files placed in the subfolder "db" of your chosen root path (e.g. "mock/db").  
-The [default ReST API](#create-a-default-rest-api) store the JSON file with the name generated by resource path replacing the slashes with the minus sign (e.g. "/auth/user" will be stored as "auth-user.json").  
-If you want to specify the file name of the resources, you can set it as the "name" property of the API:
-
-```javascript
-module.exports = {
-  path: '/my/long/path',
-  method: 'resource',
-  name: 'user',
-};
-```
-
-With this code, the JSON file will be stored as "user.json".
-
----
-
-### Expose the static files
-
-To expose any static files you have to create the subfolder "static" in your chosen root path (e.g. "mock/static") and put all the resources inside it.  
-The static content is reachable by "http://localhost:3000/static/...". That's it.
-
----
-
-### Handle requests with file uploads
-
-The multipart/form-data requests are supported by default. The `req.body` will be filled with the right data.  
-The data of the uploaded files are placed in the `req.files` property and the files are saved in the `static` folder with a temporary name.  
-It's recommended to add the `static` folder in the `.gitignore` file.
-
----
-
-### Simulate network delay
-
-If you want to simulate a network delay, you can add the `delay` property to your API configuration:
-
-```javascript
-module.exports = {
-  ...
-  delay: 3 // Seconds
-};
-```
-
----
-
-### Manage path conflicts
-
-If you have a scenario where two or more paths have conflicting values, e.g.:
-- /my-path/:id
-- /my-path/my-sub-path
-
-you can add the `priority` property to your API configuration:
-
-```javascript
-module.exports = {
-  ...
-  priority: 2
-};
-```
-
-The default value is 0. The api with the higher value will be used.
-
----
-
-### Run the server
-
-To run the server execute the following command in your project root:
-
-```shell
-npx jgloo
-```
-
-The full optional parameters are:
-
-```shell
-npx jgloo -f [FOLDER] -p [PORT] -s [STATIC_URL]
-```
-
-For example:
-
-```shell
-npx jgloo -f 'mock' -p 3000 -s 'static'
-```
-
-- "**-f**" or "**--folder**": the folder where your mocks are placed. It's optional, by default it's the folder "mock".
-- "**-p**" or "**--port**": the port of running server. It's optional, by default it's "3000".
-- "**-s**" or "**--static**": the url prefix of the static resources. It's optional, by default it's "static".
+<p align="center"><img src="logo.png" alt="jgloo logo" height="120"></p>
+
+# jgloo
+
+![npm](https://img.shields.io/npm/v/jgloo?style=flat-square)
+![npm bundle size](https://img.shields.io/bundlephobia/min/jgloo?style=flat-square)
+![license](https://img.shields.io/npm/l/jgloo?style=flat-square)
+[![Issues](https://img.shields.io/github/issues/zosma180/jgloo.svg?style=flat-square)](https://github.com/zosma180/jgloo/issues)
+
+---
+
+## Description
+
+**jgloo** is a local HTTP server useful to mock your backend API and speed up the client development.  
+This project is based on the Node framework Express. The highlights are:
+
+- Create a ReST API with two rows of code
+- Create custom API easily
+- Create custom middleware easily (e.g. auth check)
+- Store data in accessible JSON files
+- Reload the live changes of your mocks automatically (thanks to nodemon package)
+- Expose a dedicated folder for the static files (images, assets etc...)
+- Support to multipart/form-data requests
+
+---
+
+## Installation
+
+```bash
+npm i -D jgloo
+```
+
+After the installation create a folder "mock" in your project root (you can use another path and folder name if you want).  
+The **only requirement** is to create a subfolder "api" in your chosen path (e.g. "mock/api").  
+Now you are ready to [create your first API](#create-a-simple-api).
+
+---
+
+## Guide
+
+- [Create a simple API](#create-a-simple-api)
+- [Create a default ReST API](#create-a-default-rest-api)
+- [Create a custom ReST API](#create-a-custom-rest-api)
+- [Create a middleware](#create-a-middleware)
+- [Where data are stored](#where-data-are-stored)
+- [Expose the static files](#expose-the-static-files)
+- [Handle requests with file uploads](#handle-requests-with-file-uploads)
+- [Simulate network delay](#simulate-network-delay)
+- [Manage path conflicts](#manage-path-conflicts)
+- [Run the server](#run-the-server)
+
+---
+
+### Create a simple API
+
+To setup your first API create a new file "hello.js" in the "api" folder. The name of the file does not matter. Then insert the following snippet:
+
+```javascript
+export default {
+  path: '/hello',
+  method: 'get',
+  callback: (req, res) => {
+    res.json({ message: 'Hello World!' });
+  },
+};
+```
+
+This code define the GET route http://localhost:3000/hello that returns a JSON with data "{ message: 'Hello World!' }".  
+You are ready to [run the server](#run-the-server) now.
+
+---
+
+### Create a default ReST API
+
+To setup a ReST API, you have to create a new file in the "api" folder with the name you prefer and the following snippet:
+
+```javascript
+export default {
+  path: '/user',
+  method: 'resource',
+};
+```
+
+With these few rows of code will be created 6 routes:
+
+- GET /user : return the list of users;
+- GET /user/:id : return the specific user;
+- POST /user : allow to store the full request body as new user and return it as response;
+- PUT /user/:id : allow to replace an existent user with the full request body and return it as response;
+- PATCH /user/:id : allow to merge an existent user data with the request body values and return it as response;
+- DELETE /user/:id : allow to delete an existent user and return the deleted id.
+
+If you want to skip any of the previous routes, you can add the "not" property:
+
+```javascript
+export default {
+  path: '/user',
+  method: 'resource',
+  not: ['LIST']
+};
+```
+The available values of the "not" property are ['LIST', 'READ', 'CREATE', 'UPDATE', 'PATCH', 'DELETE']
+
+---
+
+### Create a custom ReST API
+
+If you need to control the logic of your resources, you can create a custom API that read and/or write the data in the JSON database.  
+To achieve it create a new file in the "api" folder with the name you prefer and the following snippet:
+
+```javascript
+import { getResource, setResource } from 'jgloo';
+
+export default {
+  path: '/user',
+  method: 'post',
+  callback: (req, res) => {
+    // Get the existent resource list or instantiate it
+    const list = getResource('user') || [];
+
+    // Get the data of the request and add a new field
+    const user = req.body;
+    user.extraField = 'value';
+
+    // Push the new model to the list
+    list.push(user);
+
+    // Store the updated list in the "user.json" file
+    setResource('user', list);
+
+    // Return the model as JSON
+    res.json(user);
+  },
+};
+```
+
+---
+
+### Create a middleware
+
+To add a middleware, you have to create a folder "middlewares" in your chosen root path (e.g. "mock/middlewares").  
+Then create a new file inside with the name you prefer and the following sample snippet:
+
+```javascript
+export default function(req, res, next) {
+  const isAuthorized = req.get('Authorization') === 'my-token';
+  isAuthorized ? next() : res.sendStatus(401);
+};
+```
+
+This sample code check for all routes if the "Authorization" header is set and it has the value "my-token".
+
+---
+
+### Where data are stored
+
+The resources are stored in JSON files placed in the subfolder "db" of your chosen root path (e.g. "mock/db").  
+The [default ReST API](#create-a-default-rest-api) store the JSON file with the name generated by resource path replacing the slashes with the minus sign (e.g. "/auth/user" will be stored as "auth-user.json").  
+If you want to specify the file name of the resources, you can set it as the "name" property of the API:
+
+```javascript
+export default {
+  path: '/my/long/path',
+  method: 'resource',
+  name: 'user',
+};
+```
+
+With this code, the JSON file will be stored as "user.json".
+
+---
+
+### Expose the static files
+
+To expose any static files you have to create the subfolder "static" in your chosen root path (e.g. "mock/static") and put all the resources inside it.  
+The static content is reachable by "http://localhost:3000/static/...". That's it.
+
+---
+
+### Handle requests with file uploads
+
+The multipart/form-data requests are supported by default. The `req.body` will be filled with the right data.  
+The data of the uploaded files are placed in the `req.files` property and the files are saved in the `static` folder with a temporary name.  
+It's recommended to add the `static` folder in the `.gitignore` file.
+
+---
+
+### Simulate network delay
+
+If you want to simulate a network delay, you can add the `delay` property to your API configuration:
+
+```javascript
+export default {
+  ...
+  delay: 3 // Seconds
+};
+```
+
+---
+
+### Manage path conflicts
+
+If you have a scenario where two or more paths have conflicting values, e.g.:
+- /my-path/:id
+- /my-path/my-sub-path
+
+you can add the `priority` property to your API configuration:
+
+```javascript
+export default {
+  ...
+  priority: 2
+};
+```
+
+The default value is 0. The api with the higher value will be used.
+
+---
+
+### Run the server
+
+To run the server execute the following command in your project root:
+
+```shell
+npx jgloo
+```
+
+The full optional parameters are:
+
+```shell
+npx jgloo -f [FOLDER] -p [PORT] -s [STATIC_URL]
+```
+
+For example:
+
+```shell
+npx jgloo -f 'mock' -p 3000 -s 'static'
+```
+
+- "**-f**" or "**--folder**": the folder where your mocks are placed. It's optional, by default it's the folder "mock".
+- "**-p**" or "**--port**": the port of running server. It's optional, by default it's "3000".
+- "**-s**" or "**--static**": the url prefix of the static resources. It's optional, by default it's "static".

package/cli.mjs

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+
+'use strict';'use strict';
+import { execSync } from 'child_process';
+import minimist from 'minimist';
+import { dirname } from 'path';
+import { fileURLToPath } from 'url';
+
+const pkg = dirname(fileURLToPath(import.meta.url));
+const params = minimist(process.argv.slice(2));
+const folder = params.f || params.folder || 'mock';
+const port = params.p || params.port || 3000;
+const staticUrl = params.s || params.static || 'static';
+
+const nodemon = 'nodemon --ignore "db/*.json"';
+const target = `"${pkg}/server.mjs" "${folder}" "${port}" "${staticUrl}"`;
+execSync(`${nodemon} --watch "${folder}" ${target}`, { stdio: 'inherit' });

package/jgloo.d.ts

@@ -1,2 +1,2 @@
-export declare function getResource<T>(name: string): T;
+export declare function getResource<T>(name: string): T;
 export declare function setResource<T>(name: string, value: T): void;

package/jgloo.mjs

@@ -0,0 +1,28 @@
+import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'fs';
+
+const params = process.argv.slice(2);
+const db = `${params[0]}/db`;
+
+export const getResource = name => {
+  const path = `${db}/${name}.json`;
+  if (!existsSync(path)) { return null; }
+  const file = readFileSync(path);
+
+  try {
+    return JSON.parse(file);
+  } catch (error) {
+    throw new Error(`${file}.json is an invalid JSON.`);
+  }
+}
+
+export const setResource = (name, value) => {
+  if (!existsSync(db)) { mkdirSync(db); }
+  const path = `${db}/${name}.json`;
+  writeFileSync(path, JSON.stringify(value), 'utf8');
+};
+
+export const getDelayMiddleware = delay => {
+  return (_, __, next) => {
+    setTimeout(next, delay * 1000);
+  };
+}

package/package.json

@@ -1,19 +1,19 @@
 {
   "name": "jgloo",
-  "version": "1.9.4",
+  "version": "2.0.0",
   "description": "The coldest mock server.",
   "homepage": "https://github.com/zosma180/jgloo",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/zosma180/jgloo.git"
   },
-  "main": "jgloo.js",
+  "main": "jgloo.mjs",
   "scripts": {
-    "start": "./cli",
+    "start": "node cli.mjs",
     "deploy": "npm-deploy . ."
   },
   "bin": {
-    "jgloo": "cli"
+    "jgloo": "cli.mjs"
   },
   "keywords": [
     "jgloo",

package/rest.mjs

@@ -0,0 +1,93 @@
+import path from 'path';
+import { getResource, setResource } from './jgloo.mjs';
+
+export const configureResource = (app, config, middleware) => {
+  const fallback = config.path.split('/').filter(Boolean).join('-');
+  const resourceName = config.name || fallback;
+  const skips = config.not || [];
+
+  // List
+  if (skips.includes('LIST') === false) {
+    app.get(config.path, middleware, (req, res) => {
+      const resource = getResource(resourceName) || [];
+      res.json(resource);
+    });
+  }
+
+  // Read
+  if (skips.includes('READ') === false) {
+    app.get(`${config.path}/:id`, middleware, (req, res) => {
+      const id = Number(req.params.id);
+
+      const resource = getResource(resourceName) || [];
+      const model = resource.find(r => r.id === id);
+      if (!model) { return res.sendStatus(404); }
+
+      res.json(model);
+    });
+  }
+
+  // Create
+  if (skips.includes('CREATE') === false) {
+    app.post(config.path, middleware, (req, res) => {
+      const resource = getResource(resourceName) || [];
+      const model = req.body;
+
+      model.id = Date.now();
+      resource.push(model);
+      setResource(resourceName, resource);
+
+      res.json(model);
+    });
+  }
+
+  // Update
+  if (skips.includes('UPDATE') === false) {
+    app.put(`${config.path}/:id`, middleware, (req, res) => {
+      const id = Number(req.params.id);
+
+      const resource = getResource(resourceName) || [];
+      const index = resource.findIndex(r => r.id === id);
+      if (index === -1) { return res.sendStatus(404); }
+
+      resource[index] = req.body;
+      resource[index].id = id;
+      setResource(resourceName, resource);
+
+      res.json(resource[index]);
+    });
+  }
+
+  // Patch
+  if (skips.includes('PATCH') === false) {
+    app.patch(`${config.path}/:id`, middleware, (req, res) => {
+      const id = Number(req.params.id);
+
+      const resource = getResource(resourceName) || [];
+      const index = resource.findIndex(r => r.id === id);
+      if (index === -1) { return res.sendStatus(404); }
+
+      resource[index] = { ...resource[index], ...req.body };
+      resource[index].id = id;
+      setResource(resourceName, resource);
+
+      res.json(resource[index]);
+    });
+  }
+
+  // Delete
+  if (skips.includes('DELETE') === false) {
+    app.delete(`${config.path}/:id`, middleware, (req, res) => {
+      const id = Number(req.params.id);
+
+      let resource = getResource(resourceName) || [];
+      const index = resource.findIndex(r => r.id === id);
+      if (index === -1) { return res.sendStatus(404); }
+
+      resource = resource.filter(r => r.id !== id);
+      setResource(resourceName, resource);
+
+      res.json(id);
+    });
+  }
+}