maxserver 0.0.17 → 0.1.1

package/README.md

@@ -64,7 +64,10 @@ Any fastify options can be passed to maxserver() too.
 | `mongodb` | *-* | MongoDB URI, if set auto-connects db |
 | `public` | `false` | Set `true` to expose the server publicly (binds to `0.0.0.0`) |
 | `static` | *-* | If set, serves this directory statically |
-<br><br>
+| `routesDir` | *src* | Directory to auto collect routes |
+---
+
+<br>
 
 ## 🗂️ Project Structure 
 Our golden rule: **1 route = 1 handler file + 1 schema file**
@@ -82,21 +85,16 @@ src/
 ```
 <br>
 
-## 🛣️ Handlers
-
-#### 1) Define method + path
-Start each route file with a comment to define the path.  
-That comment is what the route loader uses to auto-register the route.
-
-```js
-// GET /teams/:id
-```
-
-#### 2) Export default handler
+## 🤖 Auto Routing
 
+To auto-register routes, simple add a comment of the form:  
+**// METHOD /path**  
+**// GET /user**  
+**// POST /feedback/something**  
+...
 
 ```js
-// GET /teams/:id
+// GET /example/:id
 
 export default async function (req, res) {
 
@@ -105,8 +103,11 @@ export default async function (req, res) {
 	return team;
 }
 ```
-
+<br>
+  
+And remember to use default export for your handler.
 If you don't want to autoregister some routes, then simply don't add that magic comment 😃
+That's it.
 
 
 <br>
@@ -114,11 +115,11 @@ If you don't want to autoregister some routes, then simply don't add that magic
 
 
 ## 🧾 Schemas
-Create a sibling file ending with **`.schema.js`**, so it will be auto registered.  
-For example: **hello.js** and **hello.schema.js**  
+Create a sibling file ending with **`.schema.js`**, so it will be auto registered. For example: **hello.js** and **hello.schema.js** 
+
+Besides the basic validation fields we can set fields like summary and description, which will appear in the docs. Mostly you don't need to write schemas yourself, chat gpt and gemini do it excelently.
+
 
-Besides the basic validation fields we can set fields like summary and description,
-which will appear in the docs. Mostly you don't need to write schemas yourself, chat gpt and gemini do it excelently.
 
 
 ```js
@@ -142,7 +143,8 @@ export default {
 };
 ```
 
-**`‼️ Important use export default`**
+**‼️ Important use export default
+**
 
 <br>
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "maxserver",
-	"version": "0.0.17",
+	"version": "0.1.1",
 	"description": "Node server setup based fastify",
 	"author": "Max Matinpalo",
 	"type": "module",

package/src/getAddress.js

@@ -1,5 +1,13 @@
 import os from "node:os";
 
+
+/**
+ * When listening on all interfaces (0.0.0.0), Node returns "0.0.0.0".
+ * This is a setting, not a valid URL for other devices.
+ * So we try hunt down the actual LAN IP to print the real address on which server can be accessed
+ */
+
+
 function getLanIp() {
 	const nets = os.networkInterfaces();
 

package/src/index.js

@@ -6,13 +6,13 @@ import {
 	setupJwt,
 	setupMongo,
 	setupStatic,
-	setupRoutes,
 	setupDocs,
 	setupCookie,
-	getHttpsOptions,
 } from "./setup.js";
 
+
 import { getAddress } from "./getAddress.js";
+import { setupRoutes } from "./setupRoutes.js";
 
 
 export default async function maxserver(config = {}) {
@@ -26,6 +26,7 @@ export default async function maxserver(config = {}) {
 		docs = process.env.DOCS !== "false",
 		cors = process.env.CORS || "*",
 		env = process.env.NODE_ENV || "development",
+		routesDir = process.env.ROUTESDIR || "src",
 		openapiInfo,
 		static: isStatic = process.env.STATIC,
 		public: isPublic = process.env.PUBLIC === "true",
@@ -36,18 +37,19 @@ export default async function maxserver(config = {}) {
 	} = config;
 
 	const maxserverConfig = {
-		port, secret, mongodb, docs, cors,
+		port, secret, mongodb, docs, cors, env, openapiInfo, src,
 		static: isStatic,
 		public: isPublic
 	};
 
+	if (!secret)
+		throw new Error("secret is must have");
+
 
 	let app;
 	try {
 		app = Fastify({
-			https: getHttpsOptions() || undefined,
 			trustProxy: true,
-
 			// Required to allow adding doc fields on schema
 			ajv: { customOptions: { strictSchema: false } },
 			...fastifyOpts

package/src/setup.js

@@ -10,12 +10,6 @@ import helmet from "@fastify/helmet";
 import swagger from "@fastify/swagger";
 import apiReference from "@scalar/fastify-api-reference";
 
-import { loadRoutes } from "./routeLoader.js";
-
-export async function setupRoutes(app) {
-	await loadRoutes(app);
-}
-
 
 export async function setupHelmet(app) {
 	await app.register(helmet, {
@@ -27,50 +21,41 @@ export async function setupHelmet(app) {
 }
 
 
-
-
 export async function setupCors(app) {
-	const isProd = process.env.NODE_ENV === "production";
+	const isProd = app.maxserver.env === "production";
 	const origin = app.maxserver.cors ?? "*";
-
 	if (isProd && origin === "*") {
 		app.log.warn("CORS: allowing all origins (*) in production");
 	}
-
 	await app.register(cors, { origin });
 }
 
 
-
-export function getHttpsOptions() {
-	const { TLS_KEY, TLS_CERT } = process.env;
-	if (!TLS_KEY || !TLS_CERT) return null;
-
-	try {
-		return {
-			key: fs.readFileSync(TLS_KEY),
-			cert: fs.readFileSync(TLS_CERT),
-		};
-	} catch (err) {
-		throw new Error(`TLS read failed: ${err.message || err}`);
-	}
+export async function setupCookie(app) {
+	await app.register(cookie, {
+		secret: app.maxserver.secret,
+		hook: "onRequest"
+	});
 }
 
 
 
 
-export async function setupCookie(app) {
-	await app.register(cookie, {
-		secret: app.maxserver.secret || "supersecret",
-		hook: "onRequest"
-	});
+export async function setupMongo(app) {
+	const url = app.maxserver.mongodb;
+	if (!url) return;
+	await app.register(mongodb, { url });
+
+	const { ObjectId, db } = app.mongo;
+	global.oid = id => new ObjectId(id);
+	global.db = db;
 }
 
 
-export async function setupJwt(app) {
 
+export async function setupJwt(app) {
 	await app.register(jwt, {
-		secret: app.maxserver.secret || "supersecret",
+		secret: app.maxserver.secret,
 		cookie: { cookieName: "token" }
 	});
 
@@ -79,9 +64,7 @@ export async function setupJwt(app) {
 		// Let preflight requests pass
 		if (req.method === "OPTIONS") return;
 
-		const auth =
-			req.routeOptions?.config?.auth ??
-			req.routeOptions?.schema?.auth;
+		const auth = req.routeOptions?.config?.auth;
 
 		if (!auth) return;
 
@@ -93,15 +76,6 @@ export async function setupJwt(app) {
 }
 
 
-export async function setupMongo(app) {
-	const url = app.maxserver.mongodb;
-	if (!url) return;
-	await app.register(mongodb, { url });
-
-	const { ObjectId, db } = app.mongo;
-	global.oid = id => new ObjectId(id ? String(id) : undefined);
-	global.db = db;
-}
 
 
 export async function setupDocs(app) {
@@ -128,11 +102,11 @@ export async function setupDocs(app) {
 
 	app.get("/openapi.json", {}, () => app.swagger());
 
-	if (app.maxserver.docs != false)
+	if (app.maxserver.docs !== false)
 		await app.register(apiReference, { routePrefix: "/docs", openapi: true });
 
 	app.addHook("onRoute", (route) => {
-		const auth = route.config?.auth ?? route.schema?.auth;
+		const auth = route.config?.auth;
 		if (!auth) return;
 		route.schema ||= {};
 		route.schema.security ||= [{ bearerAuth: [] }, { cookieAuth: [] }];
@@ -145,9 +119,19 @@ export async function setupStatic(app) {
 	const dir = app.maxserver.static;
 	if (!dir) return;
 
-	await app.register(fastifyStatic, {
-		root: path.resolve(dir),
-		prefix: "/static/",
-	});
+	if (typeof dir !== "string") {
+		console.error("❌ maxserver.static must be a string path");
+		return;
+	}
+
+	const abs = path.resolve(dir);
+	if (!fs.existsSync(abs)) {
+		console.error(`❌ maxserver.static not found: ${abs}`);
+		return;
+	}
+
+	await app.register(fastifyStatic, { root: abs });
 }
 
+
+

package/src/{routeLoader.js → setupRoutes.js}

@@ -74,9 +74,9 @@ async function importDefault(file) {
 }
 
 
-export async function loadRoutes(fastify) {
+export async function setupRoutes(app) {
 	const seen = new Map();
-	const root = path.join(process.cwd(), "src");
+	const root = path.resolve(app.maxserver.routesDir || "src");
 
 	for (const file of walk(root)) {
 		// Skip schema files; they are loaded alongside their route file
@@ -125,6 +125,6 @@ export async function loadRoutes(fastify) {
 			};
 		}
 
-		fastify[info.method](info.url, { ...routeOptions, schema }, handler);
+		app[info.method](info.url, { ...routeOptions, schema }, handler);
 	}
 }