kaelum 1.4.1 → 1.4.3

package/README.md

@@ -74,7 +74,7 @@ my-web-app/
 ├── views/           # HTML templates
 │   └── index.html
 ├── controllers/     # Controller logic (MVC)
-│   └── .gitkeep
+│   └── pagesController.js
 ├── middlewares/     # Custom middlewares
 │   └── logger.js
 ├── routes.js        # Route definitions (example uses Kaelum helpers)
@@ -99,12 +99,17 @@ my-api-app/
 
 ## 🧩 Core API
 
-> Kaelum exposes a factory — use `require('kaelum')` and call it to get an app instance:
-
-```js
-const kaelum = require("kaelum");
-const app = kaelum();
-```
+> Kaelum exposes a factory — use `require` (CommonJS) or `import` (ESM) to get an app instance:
+ 
+ ```js
+ // CommonJS
+ const kaelum = require("kaelum");
+ const app = kaelum();
+ 
+ // ESM
+ import kaelum from "kaelum";
+ const app = kaelum();
+ ```
 
 ### `app.setConfig(options)`
 
@@ -147,7 +152,7 @@ app.addRoute("/home", {
   post: (req, res) => res.send("Posted!"),
 });
 
-// apiRoute builds RESTy resources with nested subpaths:
+// apiRoute builds RESTy resources with recursive nested subpaths:
 app.apiRoute("users", {
   get: listUsers,
   post: createUser,
@@ -155,6 +160,9 @@ app.apiRoute("users", {
     get: getUserById,
     put: updateUser,
     delete: deleteUser,
+    "/posts": {
+      get: getUserPosts // GET /users/:id/posts
+    }
   },
 });
 ```

package/cli/templates/api/app.js

@@ -1,14 +1,13 @@
-// app.js - example API project generated by Kaelum (API template)
 const kaelum = require("kaelum");
 
 const app = kaelum();
 
 // enable basic safety + logs via setConfig
 app.setConfig({
-  cors: true,
-  helmet: true,
-  logs: true, // uses morgan internally
-  bodyParser: true,
+  cors: true,       // Enable CORS for cross-origin requests
+  helmet: true,     // Add security headers
+  logs: true,       // Log requests to console (using morgan)
+  bodyParser: true, // Parse JSON and URL-encoded bodies (default true)
 });
 
 // mount routes

package/cli/templates/api/controllers/usersController.js

@@ -1,58 +1,27 @@
 // controllers/usersController.js
-// Simple in-memory users controller for demonstration.
+// Simple in-memory controller for Kaelum API demonstration
 
-let _id = 1;
 const users = [
-  { id: _id++, name: "Alice", email: "alice@example.com" },
-  { id: _id++, name: "Bob", email: "bob@example.com" },
+  { id: 1, name: "Maria", role: "admin" },
+  { id: 2, name: "Joao", role: "user" },
 ];
 
-function getUsers(req, res) {
-  res.json({ data: users });
-}
+exports.list = (req, res) => res.json(users);
 
-function createUser(req, res) {
-  const body = req.body || {};
-  if (!body.name || !body.email) {
-    return res
-      .status(400)
-      .json({ error: { message: "name and email required" } });
-  }
-  const user = { id: _id++, name: body.name, email: body.email };
-  users.push(user);
-  res.status(201).json({ data: user });
-}
-
-function getUserById(req, res) {
-  const id = Number(req.params.id);
-  const u = users.find((x) => x.id === id);
-  if (!u) return res.status(404).json({ error: { message: "User not found" } });
-  res.json({ data: u });
-}
-
-function updateUser(req, res) {
-  const id = Number(req.params.id);
-  const u = users.find((x) => x.id === id);
-  if (!u) return res.status(404).json({ error: { message: "User not found" } });
-  const body = req.body || {};
-  if (body.name) u.name = body.name;
-  if (body.email) u.email = body.email;
-  res.json({ data: u });
-}
+exports.create = (req, res) => {
+  const newUser = { id: users.length + 1, ...req.body };
+  users.push(newUser);
+  res.status(201).json({ success: true, user: newUser });
+};
 
-function deleteUser(req, res) {
-  const id = Number(req.params.id);
-  const idx = users.findIndex((x) => x.id === id);
-  if (idx === -1)
-    return res.status(404).json({ error: { message: "User not found" } });
-  const removed = users.splice(idx, 1)[0];
-  res.json({ data: removed });
-}
+exports.get = (req, res) => {
+  const user = users.find((u) => u.id == req.params.id);
+  return user ? res.json(user) : res.status(404).json({ error: "User not found" });
+};
 
-module.exports = {
-  getUsers,
-  createUser,
-  getUserById,
-  updateUser,
-  deleteUser,
+exports.posts = (req, res) => {
+  res.json([
+    { id: 101, title: "Kaelum Rocks", userId: req.params.id },
+    { id: 102, title: "Recursive Routing", userId: req.params.id },
+  ]);
 };

package/cli/templates/api/package.json

@@ -13,7 +13,7 @@
   "author": "",
   "license": "MIT",
   "dependencies": {
-    "kaelum": "^1.4.0",
+    "kaelum": "^1.4.2",
     "cors": "^2.8.5",
     "helmet": "^6.0.0",
     "morgan": "^1.10.0"

package/cli/templates/api/routes.js

@@ -1,34 +1,33 @@
-// routes.js - registers API endpoints using app.apiRoute
-const {
-  getUsers,
-  createUser,
-  getUserById,
-  updateUser,
-  deleteUser,
-} = require("./controllers/usersController");
-
+// routes.js
+const users = require("./controllers/usersController");
 const auth = require("./middlewares/authMock");
 
-module.exports = function (app) {
-  // Global example: apply auth middleware on /users POST (create)
-  // also demonstrate per-path middleware usage via setMiddleware(path, middleware)
+module.exports = (app) => {
+  // Global middleware for /users path
   app.setMiddleware("/users", (req, res, next) => {
-    // a small wrapper to demonstrate both setMiddleware signature and route-level control
-    // allow GET without auth, require auth for POST/PUT/DELETE by checking method
-    if (["POST", "PUT", "DELETE"].includes(req.method)) {
-      return require("./middlewares/authMock")(req, res, next);
-    }
+    // Simple method check
+    if (req.method === "POST") return auth(req, res, next);
     next();
   });
 
-  // Resource routes using apiRoute
+  // Recursive Nested Routing Example
   app.apiRoute("users", {
-    get: getUsers,
-    post: createUser,
+    get: users.list,   // GET /users
+    post: users.create, // POST /users (protected by middleware above)
+
+    // Nested parameter: /users/:id
     "/:id": {
-      get: getUserById,
-      put: updateUser,
-      delete: deleteUser,
+      get: users.get, // GET /users/:id
+
+      // Nested resource: /users/:id/posts
+      "/posts": {
+        get: users.posts, // GET /users/:id/posts
+      },
     },
   });
+
+  // Metadata endpoint
+  app.addRoute("/meta", {
+    get: (req, res) => res.json({ version: "1.4.2", framework: "Kaelum" }),
+  });
 };

package/cli/templates/web/app.js

@@ -1,4 +1,3 @@
-// app.js - example project generated by Kaelum (Web template)
 const kaelum = require("kaelum");
 
 const app = kaelum();
@@ -9,6 +8,7 @@ app.setConfig({
   helmet: true,
   static: "public", // will serve ./public
   bodyParser: true, // default enabled — explicit for clarity
+  // views: { engine: 'ejs', path: './views' },
 });
 
 // Register routes (routes.js uses Kaelum helpers)

package/cli/templates/web/controllers/pagesController.js

@@ -0,0 +1,24 @@
+// controllers/pagesController.js
+const path = require("path");
+
+const view = (file) => path.join(process.cwd(), "views", file);
+
+exports.home = (req, res) => {
+  res.sendFile(view("index.html"));
+};
+
+exports.about = (req, res) => {
+  res.send("<h1>About Kaelum</h1><p>A minimalist framework.</p>");
+};
+
+exports.team = (req, res) => {
+  res.send("<h1>Our Team</h1><p>Built by open source contributors.</p>");
+};
+
+exports.dashboard = (req, res) => {
+  res.send("<h1>Dashboard</h1><p>Welcome, " + (req.user || "User") + "</p>");
+};
+
+exports.settings = (req, res) => {
+  res.send("<h1>Settings</h1><p>Adjust your preferences here.</p>");
+};

package/cli/templates/web/package.json

@@ -13,7 +13,7 @@
   "author": "",
   "license": "MIT",
   "dependencies": {
-    "kaelum": "^1.4.0",
+    "kaelum": "^1.4.2",
     "cors": "^2.8.5",
     "helmet": "^6.0.0"
   },

package/cli/templates/web/routes.js

@@ -1,32 +1,34 @@
-// routes.js - example route declarations using Kaelum API
-const path = require("path");
+// routes.js
+const pages = require("./controllers/pagesController");
+const logger = require("./middlewares/logger");
 
-module.exports = function (app) {
-  // Home: serve the index.html from /views
-  app.addRoute("/", {
-    get: (req, res) => {
-      // send the static HTML file from the views folder
-      res.sendFile(path.join(process.cwd(), "views", "index.html"));
-    },
-  });
+// Mock auth middleware
+const auth = (req, res, next) => {
+  // Simulate auth check
+  req.user = "Admin"; 
+  next();
+};
+
+module.exports = (app) => {
+  // Home
+  app.addRoute("/", pages.home);
 
-  // About page - simple text
+  // Nested Route Example: /about and /about/team
   app.addRoute("/about", {
-    get: (req, res) => {
-      res.send("About Kaelum — a minimal framework scaffolded by the CLI.");
+    get: pages.about,
+    "/team": {
+      get: pages.team,
     },
   });
 
-  // Example route using per-path middleware (logger)
-  // The middleware is mounted on '/protected' and the route uses it.
-  const logger = require("./middlewares/logger");
-  app.setMiddleware("/protected", logger);
+  // Middleware Chain Example
+  const secureSection = [logger, auth];
 
-  app.addRoute("/protected", {
-    get: (req, res) => {
-      res.send(
-        "This route is protected by a simple request logger middleware."
-      );
+  // Dashboard with nested settings, protected by middleware chain
+  app.addRoute("/dashboard", {
+    get: [...secureSection, pages.dashboard],
+    "/settings": {
+      get: [...secureSection, pages.settings],
     },
   });
 };

package/cli/templates/web/views/index.html

@@ -26,8 +26,8 @@
           <div class="card">
             <h3>Rotas</h3>
             <p>
-              Veja as rotas: <code>/</code>, <code>/about</code>,
-              <code>/protected</code>, <code>/health</code>.
+              Veja as rotas: <code>/</code>, <code>/about</code>, <code>/about/team</code>,
+              <code>/dashboard</code>, <code>/dashboard/settings</code>.
             </p>
           </div>
           <div class="card">
@@ -37,7 +37,7 @@
         </div>
 
         <p class="small">
-          Gerado pela Kaelum CLI • Versão do template para Kaelum ^1.3.0
+          Gerado pela Kaelum CLI • Versão do template para Kaelum v1.4.2
         </p>
       </section>
     </main>

package/core/addRoute.js

@@ -114,26 +114,9 @@ function addRoute(app, basePath, handlers = {}) {
         continue;
       }
 
-      // If nested value is object -> iterate methods
+      // If nested value is object -> RECURSE
       if (isPlainObject(value)) {
-        for (const method of Object.keys(value)) {
-          const handlerFn = value[method];
-          const m = method.toLowerCase();
-          if (!supportedMethods.includes(m)) {
-            throw new Error(
-              `Unsupported HTTP method "${method}" for route "${subPath}"`
-            );
-          }
-          // allow single function or array for handlerFn
-          if (typeof handlerFn !== "function" && !Array.isArray(handlerFn)) {
-            throw new Error(
-              `Handler for ${method} ${subPath} must be a function or array of functions`
-            );
-          }
-          const fns = normalizeHandlersToArray(handlerFn);
-          const wrapped = fns.map(wrapHandler);
-          app[m](subPath, ...wrapped);
-        }
+        addRoute(app, subPath, value);
         continue;
       }
 

package/index.js

@@ -1,3 +1,2 @@
 const createApp = require("./createApp");
-
-module.exports = createApp;
+module.exports = createApp;

package/index.mjs

@@ -0,0 +1,2 @@
+import createApp from './index.js';
+export default createApp;

package/package.json

@@ -1,16 +1,19 @@
 {
   "name": "kaelum",
-  "version": "1.4.1",
+  "version": "1.4.3",
   "description": "A minimalist Node.js framework for building web pages and APIs with simplicity and speed.",
   "main": "index.js",
   "exports": {
-    ".": "./index.js"
+    ".": {
+      "import": "./index.mjs",
+      "require": "./index.js"
+    }
   },
   "bin": {
     "kaelum": "cli/index.js"
   },
   "scripts": {
-    "test": "jest --verbose"
+    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js --verbose"
   },
   "keywords": [
     "framework",