maxserver 0.1.7 → 0.1.9

package/README.md

@@ -229,11 +229,8 @@ Rule of thumb: make the message something you would want to see at 03:00 in logs
 ## 🛠️ Tips & Tools
 
 ### 🔌 Scalar API Client (Live Testing)
-- Download the great new api client
-- It autosyncs well with the server
-- Add Item → Import from OpenAPI
-- Paste: `http://localhost:3000/openapi.json`
-- Enable watch mode for live updates
+- Open: `http://localhost:3000/docs`
+
 
 ### ⚡ VS Code Auto-Start
 In `.vscode/tasks.json`, enable the task with:

package/package.json

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

package/src/setupDocs.js

@@ -2,6 +2,36 @@ import swagger from "@fastify/swagger";
 import apiReference from "@scalar/fastify-api-reference";
 
 
+
+const schema = {
+	summary: "OpenAPI Specification",
+	description: "Returns the full OpenAPI 3.0 specification.",
+	tags: ["Docs"],
+	response: {
+		200: {
+			type: "object",
+			additionalProperties: true,
+			required: ["openapi", "info", "paths"],
+			properties: {
+				openapi: { type: "string", example: "3.0.3" },
+				info: {
+					type: "object",
+					required: ["title", "version"],
+					properties: {
+						title: { type: "string", example: "API" },
+						version: { type: "string", example: "1.0.0" }
+					}
+				},
+				paths: { type: "object", example: {} }
+			}
+		}
+	}
+};
+
+
+
+
+
 export async function setupDocs(app) {
 
 	const info = app.maxserver.openapiInfo || {
@@ -20,18 +50,44 @@ export async function setupDocs(app) {
 					cookieAuth: { type: "apiKey", in: "cookie", name: "token" },
 				},
 			},
-
-			// This replaces your manual app.get line
-			exposeRoute: true,
-			routePrefix: "/openapi.json"
 		},
 	});
 
 
-	//app.get("/openapi.json", {}, () => app.swagger());
+	app.get("/openapi.json", { schema }, () => app.swagger());
 
 	if (app.maxserver.docs !== false)
-		await app.register(apiReference, { routePrefix: "/docs", openapi: true });
+		await app.register(apiReference, {
+			"routePrefix": "/docs",
+			"openapi": true,
+			"layout": "modern",
+			"hideClientButton": true,
+			"hideSearch": true,
+			"defaultOpenAllTags": true,
+			"showSidebar": true,
+			"showDeveloperTools": false,
+			"showToolbar": false,
+			"operationTitleSource": "summary",
+			"theme": "default",
+			"persistAuth": false,
+			"telemetry": false,
+			"isEditable": false,
+			"isLoading": false,
+			"hideModels": false,
+			"documentDownloadType": "both",
+			"hideTestRequestButton": false,
+			"showOperationId": false,
+			"hideDarkModeToggle": false,
+			"withDefaultFonts": true,
+			"expandAllModelSections": false,
+			"expandAllResponses": false,
+			"orderSchemaPropertiesBy": "alpha",
+			"orderRequiredPropertiesFirst": true,
+			"_integration": "fastify",
+			"default": false,
+			"slug": "api-1",
+			"title": "API #1"
+		});
 
 	app.addHook("onRoute", (route) => {
 		const auth = route.config?.auth;
@@ -44,42 +100,3 @@ export async function setupDocs(app) {
 
 
 
-export default {
-	summary: "OpenAPI Documentation",
-	description: "Returns the OpenAPI 3.0.0 specification for the entire API.",
-	tags: ["Documentation"],
-	response: {
-		200: {
-			type: "object",
-			properties: {
-				openapi: {
-					type: "string",
-					example: "3.0.0"
-				},
-				info: {
-					type: "object",
-					properties: {
-						title: {
-							type: "string",
-							example: "maxserver API"
-						},
-						version: {
-							type: "string",
-							example: "1.0.0"
-						}
-					},
-					required: ["title", "version"]
-				},
-				paths: {
-					type: "object",
-					example: {}
-				},
-				components: {
-					type: "object",
-					example: {}
-				}
-			},
-			required: ["openapi", "info", "paths"]
-		}
-	}
-};

package/archive/setupRoutesOld.js

@@ -1,132 +0,0 @@
-
-/**
- * 🚀 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);
-	}
-}