jgloo 1.9.4 → 2.0.1

package/CHANGELOG.md

@@ -1,3 +1,25 @@
+<a name="2.0.1"></a>
+
+## [2.0.1](https://github.com/zosma180/jgloo/compare/2.0.0...2.0.1) (2025-05-09)
+
+### Fixes
+
+- Fixed the internal module imports on Windows.
+
+---
+
+<a name="2.0.0"></a>
+
+## [2.0.0](https://github.com/zosma180/jgloo/compare/1.9.4...2.0.0) (2024-12-11)
+
+### Features
+
+- Converted the codebase to ES module style.
+
+**WARNING**: starting from this version, the CommonJS api are nomore supported.
+
+---
+
 <a name="1.9.4"></a>
 
 ## [1.9.4](https://github.com/zosma180/jgloo/compare/1.9.3...1.9.4) (2024-03-30)

package/README.md

@@ -56,7 +56,7 @@ Now you are ready to [create your first API](#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 = {
+export default {
   path: '/hello',
   method: 'get',
   callback: (req, res) => {
@@ -75,7 +75,7 @@ You are ready to [run the server](#run-the-server) now.
 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 = {
+export default {
   path: '/user',
   method: 'resource',
 };
@@ -93,7 +93,7 @@ With these few rows of code will be created 6 routes:
 If you want to skip any of the previous routes, you can add the "not" property:
 
 ```javascript
-module.exports = {
+export default {
   path: '/user',
   method: 'resource',
   not: ['LIST']
@@ -109,9 +109,9 @@ If you need to control the logic of your resources, you can create a custom API
 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');
+import { getResource, setResource } from 'jgloo';
 
-module.exports = {
+export default {
   path: '/user',
   method: 'post',
   callback: (req, res) => {
@@ -142,7 +142,7 @@ To add a middleware, you have to create a folder "middlewares" in your chosen ro
 Then create a new file inside with the name you prefer and the following sample snippet:
 
 ```javascript
-module.exports = (req, res, next) => {
+export default function(req, res, next) {
   const isAuthorized = req.get('Authorization') === 'my-token';
   isAuthorized ? next() : res.sendStatus(401);
 };
@@ -159,7 +159,7 @@ The [default ReST API](#create-a-default-rest-api) store the JSON file with the
 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 = {
+export default {
   path: '/my/long/path',
   method: 'resource',
   name: 'user',
@@ -190,7 +190,7 @@ It's recommended to add the `static` folder in the `.gitignore` file.
 If you want to simulate a network delay, you can add the `delay` property to your API configuration:
 
 ```javascript
-module.exports = {
+export default {
   ...
   delay: 3 // Seconds
 };
@@ -207,7 +207,7 @@ If you have a scenario where two or more paths have conflicting values, e.g.:
 you can add the `priority` property to your API configuration:
 
 ```javascript
-module.exports = {
+export default {
   ...
   priority: 2
 };

package/cli.mjs

@@ -0,0 +1,19 @@
+#!/usr/bin/env node
+
+'use strict';'use strict';
+import { execSync } from 'child_process';
+import minimist from 'minimist';
+import { dirname, join } 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 db = join('db', '*.json');
+const nodemon = `npx nodemon --ignore "${db}"`;
+const entrypoint = join(pkg, 'server.mjs')
+const target = `"${entrypoint}" "${folder}" "${port}" "${staticUrl}"`;
+execSync(`${nodemon} --watch "${folder}" ${target}`, { stdio: 'inherit' });

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/mock/api/example.mjs

@@ -0,0 +1,7 @@
+export default {
+  path: '/hello',
+  method: 'get',
+  callback: (req, res) => {
+    res.json({ message: 'Hello World!' });
+  },
+};

package/package.json

@@ -1,19 +1,19 @@
 {
   "name": "jgloo",
-  "version": "1.9.4",
+  "version": "2.0.1",
   "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",
-    "deploy": "npm-deploy . ."
+    "start": "node cli.mjs",
+    "deploy": "npm-deploy.mjs . ."
   },
   "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);
+    });
+  }
+}

package/{server.js → server.mjs}

@@ -1,21 +1,21 @@
-const { join } = require('path');
-const { existsSync, readdirSync, lstatSync } = require('fs');
-const express = require('express');
-const cors = require('cors');
-const bodyParser = require('body-parser');
-const multer = require('multer');
-
-const { configureResource } = require(join(__dirname, 'rest'));
-const { getDelayMiddleware } = require(join(__dirname, 'jgloo'));
+import { join } from 'path';
+import { existsSync, readdirSync, lstatSync } from 'fs';
+import express from 'express';
+import cors from 'cors';
+import bodyParser from 'body-parser';
+import multer from 'multer';
+import { configureResource } from './rest.mjs';
+import { getDelayMiddleware } from './jgloo.mjs';
+
 const app = express();
 const params = process.argv.slice(2);
 const root = join(process.cwd(), params[0]);
 const port = params[1];
 const staticUrl = params[2];
 
-const apiPath = `${root}/api`;
-const middlewarePath = `${root}/middlewares`;
-const staticPath = `${root}/static`;
+const apiPath = join(root, 'api');
+const middlewarePath = join(root, 'middlewares');
+const staticPath = join(root, 'static');
 
 if (!existsSync(root)) {
   console.error(`The root folder "${root}" doesn't exist.`);
@@ -50,12 +50,12 @@ app.use(multer({ dest: staticPath }).any());
 
 // Add middlewares
 if (existsSync(middlewarePath)) {
-  walk(middlewarePath)
+  const middlewareQueue = walk(middlewarePath)
     .filter(file => file.endsWith('js'))
-    .forEach(file => {
-      const middleware = require(file);
-      app.use(middleware);
-    });
+    .map(file => import(`file://${file}`));
+
+  const middlewareFiles = await Promise.all(middlewareQueue);
+  middlewareFiles.forEach(m => app.use(m.default));
 }
 
 // Add the static folder
@@ -69,10 +69,12 @@ if (!existsSync(apiPath)) {
   process.exit(2);
 }
 
-const api = walk(apiPath)
+const apiQueue = walk(apiPath)
   .filter(file => file.endsWith('js'))
-  .map(file => require(file))
-  .sort((a, b) => (b.priority || 0) - (a.priority || 0));
+  .map(file => import(`file://${file}`));
+
+  const apiFiles = await Promise.all(apiQueue);
+const api = apiFiles.map(f => f.default).sort((a, b) => (b.priority || 0) - (a.priority || 0));
 
 if (!api.length) {
   console.error(`No API file defined. Create one.`);
@@ -87,7 +89,7 @@ api.forEach(config => {
 
   if (config.method === 'resource') {
     // ReST resource
-    configureResource(app, config);
+    configureResource(app, config, middleware);
   } else {
     // Custom endpoint
     app[config.method](config.path, middleware, config.callback);

package/cli

@@ -1,19 +0,0 @@
-#!/usr/bin/env node
-
-'use strict';
-const { exec } = require('child_process');
-const minimist = require('minimist');
-
-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 server = `${__dirname}/server.js`;
-
-const child = exec(
-  `nodemon --watch "${folder}" --ignore "db/*.json" "${server}" "${folder}" "${port}" "${staticUrl}"`
-);
-
-child.stdout.on('data', (data) => console.log(String(data)));
-child.stderr.on('data', (data) => console.error(String(data)));
-child.on('close', (code) => process.exit(code));

package/jgloo.js

@@ -1,30 +0,0 @@
-const { existsSync, mkdirSync, readFileSync, writeFileSync } = require('fs');
-
-const params = process.argv.slice(2);
-const db = `${params[0]}/db`;
-
-module.exports = {
-  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.`);
-    }
-  },
-
-  setResource: (name, value) => {
-    if (!existsSync(db)) { mkdirSync(db); }
-    const path = `${db}/${name}.json`;
-    writeFileSync(path, JSON.stringify(value), 'utf8');
-  },
-
-  getDelayMiddleware: (delay) => {
-    return (_, __, next) => {
-      setTimeout(next, delay * 1000);
-    };
-  },
-}

package/rest.js

@@ -1,95 +0,0 @@
-const path = require('path');
-const { getResource, setResource } = require(path.join(__dirname, 'jgloo'));
-
-module.exports = {
-  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);
-      });
-    }
-  }
-}