maxserver 0.1.4 → 0.1.6

package/README.md

@@ -10,7 +10,6 @@
 ‼️ **ATTENTION** ‼️ - Not download yet, check out few days later 😉  
 I am simplifying and improving things, that it will work for everyone plugn play.
 
-
 Ready node server setup based on **Fastify** to speed up backend development.  
 maxserver stands for **maximized simplicity** and **minimum boilerplate**.
 
@@ -19,22 +18,9 @@ maxserver stands for **maximized simplicity** and **minimum boilerplate**.
 - **Preconfigures essentials**: jwt auth, cors, helmet
 - **Auto Connect MongoDB** (optional)
 
-
-Apologize builtin devserver watcher atm only for macos.  
-I should add chokidar for windows, but i hate Windows and extra packages 😃
-
-
 <br><br>
 
-
 ## Install
-
-### Setup ready project
-```js
-npx maxserver [appname]
-```
-
-### Or install as packge
 ```js
 npm install maxserver
 ```
@@ -99,13 +85,15 @@ To auto-register routes, simple add a comment of the form:
 ...
 
 ```js
-// GET /example/:id
+// GET /hello
 
-export default async function (req, res) {
+export default async function handler(req, rep) {
+
+	console.log("GET /hello");
+	return {
+		message: "Hello world",
+	};
 
-	const id = req.params.id;
-	console.log("Example id": id);
-	return team;
 }
 ```
 <br>
@@ -148,8 +136,8 @@ export default {
 };
 ```
 
-**‼️ Important use export default
-**
+You will find comlete examples in template folder.  
+**‼️ Important use export default**
 
 <br>
 
@@ -204,7 +192,7 @@ Set option **`MONGODB`** your mongodbURI and it will auto-connect at server star
 | Global | What it is | Why it exists |
 | :--- | :--- | :--- |
 | `db` | MongoDB database handle | Use it directly in handlers |
-| `oid(id)` | string → `ObjectId` | Avoid importing `ObjectId` everywhere |
+| `oid(id)` | string → `ObjectId` | Saves you from importing everywhere `ObjectId` |
 
 ### Example
 
@@ -256,3 +244,5 @@ In `.vscode/tasks.json`, enable the task with:
 ### 🤖 AI Assistants
 Copy **`RULES.md`** into your AI tool as system context,  
 then ask it to generate routes + schemas.
+
+

package/TODO.md

@@ -0,0 +1,4 @@
+- get rules.md file for ai (lost atm)
+- add example for db usage
+- unity tests for each config option
+

package/archive/setupRoutesOld.js

@@ -0,0 +1,132 @@
+
+/**
+ * 🚀 AUTO-LOADER
+ * Scans src/ for files with "// METHOD /url" comments.
+ * Automatically registers them as Fastify routes.
+ */
+
+
+import fs from "fs";
+import path from "path";
+import { pathToFileURL } from "url";
+
+
+// Matches lines like: // GET /api/v1/users
+const ROUTE_REGEX = /^\/\/\s*(GET|POST|PUT|PATCH|DELETE)\s+(.+)$/gm;
+
+
+/**
+ * Recursively finds all .js files in a directory.
+ * Skips node_modules and dotfiles.
+ */
+function walk(dir, out = []) {
+	if (!fs.existsSync(dir)) return out;
+
+	for (const e of fs.readdirSync(dir, { withFileTypes: true })) {
+		if (e.name === "node_modules") continue;
+		if (e.name.startsWith(".")) continue;
+
+		const full = path.join(dir, e.name);
+		if (e.isDirectory()) {
+			walk(full, out);
+			continue;
+		}
+
+		if (!e.name.endsWith(".js")) continue;
+		out.push(full);
+	}
+
+	return out;
+}
+
+
+/**
+ * Extracts method and URL from the file's "magic comment".
+ * Enforces strict "One Route Per File" policy.
+ */
+function getRoute(file) {
+	const text = fs.readFileSync(file, "utf8");
+	const matches = [...text.matchAll(ROUTE_REGEX)];
+
+	if (matches.length === 0) return null;
+
+	// Warn if user accidentally defines multiple routes in one file
+	if (matches.length > 1) {
+		console.warn(
+			`⚠️ Ignored "${file}": Found ${matches.length} route comments. ` +
+			`Only 1 allowed per file.`
+		);
+		return null;
+	}
+
+	const m = matches[0];
+	const method = m[1].toLowerCase();
+	// Normalize URL: Remove all leading slashes, then add exactly one
+	const url = "/" + m[2].trim().replace(/^\/+/, "");
+
+	return { method, url };
+}
+
+
+/**
+ * Safe dynamic import that handles Windows paths correctly.
+ */
+async function importDefault(file) {
+	return (await import(pathToFileURL(file).href)).default;
+}
+
+
+export async function setupRoutes(app) {
+	const seen = new Map();
+	const root = path.resolve(app.maxserver.routesDir || "src");
+
+	for (const file of walk(root)) {
+		// Skip schema files; they are loaded alongside their route file
+		if (file.endsWith(".schema.js")) continue;
+
+		const info = getRoute(file);
+		if (!info) continue;
+
+		// 🛡️ Collision Detection: Ensure no two files claim the same route
+		const key = info.method + " " + info.url;
+		if (seen.has(key)) {
+			throw new Error(
+				`Duplicate route "${key}" detected:\n` +
+				`1. ${seen.get(key)}\n` +
+				`2. ${file}`
+			);
+		}
+		seen.set(key, file);
+
+		// Import the route handler
+		const handler = await importDefault(file);
+		if (typeof handler !== "function") {
+			throw new Error(
+				`Route "${key}" in "${file}" must export a default function.`
+			);
+		}
+
+		// 🤝 Schema Loading: Look for sibling .schema.js file
+		const schemaFile = file.replace(/\.js$/, ".schema.js");
+		let raw = {};
+
+		if (fs.existsSync(schemaFile)) {
+			const loaded = await importDefault(schemaFile);
+			// 🛡️ Guard: Ensure export is a valid object before using it
+			if (loaded && typeof loaded === "object") raw = loaded;
+		}
+
+		// ✨ Magic: Extract 'auth' and 'routeOptions' specifically
+		let { auth, routeOptions = {}, ...schema } = raw;
+
+		// Inject 'auth' into config if present (Syntactic Sugar)
+		if (auth !== undefined) {
+			routeOptions = {
+				...routeOptions,
+				config: { ...(routeOptions.config || {}), auth: !!auth },
+			};
+		}
+
+		app[info.method](info.url, { ...routeOptions, schema }, handler);
+	}
+}

package/bin/init.js

@@ -45,11 +45,31 @@ function resolveArgs() {
 }
 
 
+/**
+ * Renames template files to dotfiles and clones vscode settings.
+ */
 function fixDotfiles(dir) {
-	for (const f of ["env", "gitignore", "vscode"]) {
+	// 1. Standard dotfile renames
+	for (const f of ["env", "gitignore"]) {
 		const src = path.join(dir, f);
 		if (fs.existsSync(src)) fs.renameSync(src, path.join(dir, "." + f));
 	}
+
+	// 2. Specialized vscode handling (Root and src)
+	const vscodeSrc = path.join(dir, "vscode");
+
+	if (fs.existsSync(vscodeSrc)) {
+		const srcDir = path.join(dir, "src");
+
+		// Ensure src/ exists before cloning settings into it
+		if (!fs.existsSync(srcDir)) fs.mkdirSync(srcDir);
+
+		// Copy to src/.vscode
+		fs.cpSync(vscodeSrc, path.join(srcDir, ".vscode"), { recursive: true });
+
+		// Rename root vscode to .vscode
+		fs.renameSync(vscodeSrc, path.join(dir, ".vscode"));
+	}
 }
 
 

package/package.json

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

package/src/setupRoutes.js

@@ -2,27 +2,24 @@
  * 🚀 AUTO-LOADER
  * Scans src/ for files with "// METHOD /url" comments.
  * Automatically registers them as Fastify routes.
+ * Also registers lonely .schema.js files as global shared schemas.
  */
 
 import fs from "fs";
 import path from "path";
 import { pathToFileURL } from "url";
 
-
 // Matches lines like: // GET /api/v1/users
 const ROUTE_REGEX = /^\/\/\s*(GET|POST|PUT|PATCH|DELETE)\s+(.+)$/gm;
 
-
 /**
  * Recursively finds all .js files in a directory.
- * Skips node_modules and dotfiles.
  */
 function walk(dir, out = []) {
 	if (!fs.existsSync(dir)) return out;
 
 	for (const e of fs.readdirSync(dir, { withFileTypes: true })) {
-		if (e.name === "node_modules") continue;
-		if (e.name.startsWith(".")) continue;
+		if (e.name === "node_modules" || e.name.startsWith(".")) continue;
 
 		const full = path.join(dir, e.name);
 		if (e.isDirectory()) {
@@ -30,17 +27,14 @@ function walk(dir, out = []) {
 			continue;
 		}
 
-		if (!e.name.endsWith(".js")) continue;
-		out.push(full);
+		if (e.name.endsWith(".js")) out.push(full);
 	}
 
 	return out;
 }
 
-
 /**
  * Extracts method and URL from the file's "magic comment".
- * Enforces strict "One Route Per File" policy.
  */
 function getRoute(file) {
 	const text = fs.readFileSync(file, "utf8");
@@ -48,76 +42,69 @@ function getRoute(file) {
 
 	if (matches.length === 0) return null;
 
-	// Warn if user accidentally defines multiple routes in one file
 	if (matches.length > 1) {
-		console.warn(
-			`⚠️ Ignored "${file}": Found ${matches.length} route comments. ` +
-			`Only 1 allowed per file.`
-		);
+		console.warn(`⚠️ Ignored "${file}": Only 1 route allowed per file.`);
 		return null;
 	}
 
 	const m = matches[0];
-	const method = m[1].toLowerCase();
-	// Normalize URL: Remove all leading slashes, then add exactly one
-	const url = "/" + m[2].trim().replace(/^\/+/, "");
-
-	return { method, url };
+	return {
+		method: m[1].toLowerCase(),
+		url: "/" + m[2].trim().replace(/^\/+/, "")
+	};
 }
 
-
 /**
- * Safe dynamic import that handles Windows paths correctly.
+ * Safe dynamic import for ESM.
  */
 async function importDefault(file) {
 	return (await import(pathToFileURL(file).href)).default;
 }
 
-
 export async function setupRoutes(app) {
-	const seen = new Map();
 	const root = path.resolve(app.maxserver.routesDir || "src");
+	const files = walk(root);
 
-	for (const file of walk(root)) {
-		// Skip schema files; they are loaded alongside their route file
+	// 1. Pass One: Register Global Schemas (Lonely .schema.js files)
+	for (const file of files) {
+		if (file.endsWith(".schema.js")) {
+			const hasHandler = fs.existsSync(file.replace(".schema.js", ".js"));
+
+			if (!hasHandler) {
+				const schema = await importDefault(file);
+				if (schema?.$id) app.addSchema(schema);
+			}
+		}
+	}
+
+	// 2. Pass Two: Register Routes
+	const seen = new Map();
+	for (const file of files) {
 		if (file.endsWith(".schema.js")) continue;
 
 		const info = getRoute(file);
 		if (!info) continue;
 
-		// 🛡️ Collision Detection: Ensure no two files claim the same route
-		const key = info.method + " " + info.url;
-		if (seen.has(key)) {
-			throw new Error(
-				`Duplicate route "${key}" detected:\n` +
-				`1. ${seen.get(key)}\n` +
-				`2. ${file}`
-			);
-		}
+		const key = `${info.method} ${info.url}`;
+		if (seen.has(key)) throw new Error(`Duplicate route "${key}" detected.`);
 		seen.set(key, file);
 
-		// Import the route handler
 		const handler = await importDefault(file);
 		if (typeof handler !== "function") {
-			throw new Error(
-				`Route "${key}" in "${file}" must export a default function.`
-			);
+			throw new Error(`Route "${key}" in "${file}" must export a default function.`);
 		}
 
-		// 🤝 Schema Loading: Look for sibling .schema.js file
 		const schemaFile = file.replace(/\.js$/, ".schema.js");
 		let raw = {};
 
 		if (fs.existsSync(schemaFile)) {
 			const loaded = await importDefault(schemaFile);
-			// 🛡️ Guard: Ensure export is a valid object before using it
 			if (loaded && typeof loaded === "object") raw = loaded;
 		}
 
-		// ✨ Magic: Extract 'auth' and 'routeOptions' specifically
 		let { auth, routeOptions = {}, ...schema } = raw;
 
-		// Inject 'auth' into config if present (Syntactic Sugar)
+		// Inject 'auth' config for the global authentication hook
 		if (auth !== undefined) {
 			routeOptions = {
 				...routeOptions,

package/templates/package.json

@@ -8,5 +8,6 @@
 		"dev": "maxserver-watcher"
 	},
 	"type": "module",
+	"private": "true",
 	"dependencies": {}
 }