maxserver 0.1.6 → 0.1.7

package/package.json

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

package/src/index.js

@@ -6,12 +6,12 @@ import {
 	setupJwt,
 	setupMongo,
 	setupStatic,
-	setupDocs,
 	setupCookie,
 } from "./setup.js";
 
 
 import { getAddress } from "./getAddress.js";
+import { setupDocs } from "./setupDocs.js";
 import { setupRoutes } from "./setupRoutes.js";
 
 

package/src/setup.js

@@ -7,8 +7,7 @@ import cookie from "@fastify/cookie";
 import mongodb from "@fastify/mongodb";
 import fastifyStatic from "@fastify/static";
 import helmet from "@fastify/helmet";
-import swagger from "@fastify/swagger";
-import apiReference from "@scalar/fastify-api-reference";
+
 
 
 export async function setupHelmet(app) {
@@ -78,42 +77,6 @@ export async function setupJwt(app) {
 
 
 
-export async function setupDocs(app) {
-
-	const info = app.maxserver.openapiInfo || {
-		title: "API",
-		version: "1.0.0",
-	};
-
-	await app.register(swagger, {
-		openapi: {
-			info,
-			// OpenAPI 3.x: securitySchemes must be defined globally here not per route
-			// Routes only add `security: [...]` that references these scheme names
-			components: {
-				securitySchemes: {
-					bearerAuth: { type: "http", scheme: "bearer" },
-					cookieAuth: { type: "apiKey", in: "cookie", name: "token" },
-				},
-			},
-		},
-	});
-
-
-	app.get("/openapi.json", {}, () => app.swagger());
-
-	if (app.maxserver.docs !== false)
-		await app.register(apiReference, { routePrefix: "/docs", openapi: true });
-
-	app.addHook("onRoute", (route) => {
-		const auth = route.config?.auth;
-		if (!auth) return;
-		route.schema ||= {};
-		route.schema.security ||= [{ bearerAuth: [] }, { cookieAuth: [] }];
-	});
-}
-
-
 
 export async function setupStatic(app) {
 	const dir = app.maxserver.static;

package/src/setupDocs.js

@@ -0,0 +1,85 @@
+import swagger from "@fastify/swagger";
+import apiReference from "@scalar/fastify-api-reference";
+
+
+export async function setupDocs(app) {
+
+	const info = app.maxserver.openapiInfo || {
+		title: "API",
+		version: "1.0.0",
+	};
+
+	await app.register(swagger, {
+		openapi: {
+			info,
+			// OpenAPI 3.x: securitySchemes must be defined globally here not per route
+			// Routes only add `security: [...]` that references these scheme names
+			components: {
+				securitySchemes: {
+					bearerAuth: { type: "http", scheme: "bearer" },
+					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());
+
+	if (app.maxserver.docs !== false)
+		await app.register(apiReference, { routePrefix: "/docs", openapi: true });
+
+	app.addHook("onRoute", (route) => {
+		const auth = route.config?.auth;
+		if (!auth) return;
+		route.schema ||= {};
+		route.schema.security ||= [{ bearerAuth: [] }, { cookieAuth: [] }];
+	});
+}
+
+
+
+
+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/templates/src/Tests/hello.js

@@ -0,0 +1,14 @@
+// POST /hello
+
+export default async function handler(req, rep) {
+
+	console.log("POST /hello");
+
+	return {
+		message: `Hello ${req.body.name} again 🙋‍♂️`,
+	};
+}
+
+
+
+// Try POST with and without name, to see how the schema works

package/templates/src/Tests/hello.schema.js

@@ -0,0 +1,27 @@
+export default {
+	summary: "Test post hello",
+	description: "Receives a name in the body and returns a personalized hello message.",
+	tags: ["Tests"],
+	body: {
+		type: "object",
+		properties: {
+			name: {
+				type: "string",
+				example: "John Doe"
+			}
+		},
+		required: ["name"]
+	},
+	response: {
+		200: {
+			type: "object",
+			properties: {
+				message: {
+					type: "string",
+					example: "Hello John Doe again 🙋‍♂️"
+				}
+			},
+			required: ["message"]
+		}
+	}
+};

package/templates/src/{welcome.js → Tests/welcome.js}

@@ -4,7 +4,7 @@ export default async function handler(req, rep) {
 
 	console.log("GET /welcome");
 	return {
-		message: "Weclome to maxserver 😉",
+		message: "Weclome to maxserver 😉 - Updated",
 	};
 
 }

package/templates/src/Tests/welcome.schema.js

@@ -0,0 +1,17 @@
+export default {
+	summary: "Test get welcome",
+	description: "Returns a friendly welcome message to verify the server is operational.",
+	tags: ["Tests"],
+	response: {
+		200: {
+			type: "object",
+			properties: {
+				message: {
+					type: "string",
+					example: "Weclome to maxserver 😉 - Updated"
+				}
+			},
+			required: ["message"]
+		}
+	}
+};

package/templates/vscode/tasks.json

@@ -1,9 +1,6 @@
 // Comment task in to autostart server on dir open
-/*
-
-
 {
-	"version": "1.0.0",
+	"version": "2.0.0",
 	"tasks": [
 		{
 			"label": "devserver 📟",
@@ -16,8 +13,18 @@
 			"runOptions": {
 				"runOn": "folderOpen"
 			}
+		},
+		{
+			"label": "openBrowser",
+			"type": "shell",
+			"command": "sleep 1; open http://localhost:3000/docs",
+			"presentation": {
+				"reveal": "never",
+				"panel": "shared"
+			},
+			"runOptions": {
+				"runOn": "folderOpen"
+			}
 		}
 	]
-}
-
-*/
+}

package/templates/src/hello.js

@@ -1,14 +0,0 @@
-// POST /hello
-
-export default async function handler(req, rep) {
-
-	console.log("POST /hello");
-
-	return {
-		message: `Hello ${req.body.name} 🙋‍♂️`,
-	};
-}
-
-
-
-// Try POST with and without name, to see how the schema works

package/templates/src/hello.schema.js

@@ -1,36 +0,0 @@
-export default {
-
-	// These 3 fields are for the documentation
-	// Not must have, but your auto generated documentation will be great
-
-	tags: ["Test"],
-	summary: "Post hello",
-	description: "Accepts a name and returns a greeting.",
-
-	body: {
-		type: "object",
-		required: ["name"],
-		properties: {
-			name: {
-				type: "string",
-				example: "Max",
-			},
-		},
-	},
-
-	response: {
-		200: {
-			type: "object",
-			properties: {
-				message: {
-					type: "string",
-					example: "Hello Max",
-				},
-			},
-		},
-	},
-};
-
-// Hint - You don't need to write these ourself
-// Just ask chat gpt or gemini to generate them
-// In docs you will find little instruction for it