maxserver 0.2.1 → 0.2.3

package/.github/README.md

@@ -97,8 +97,9 @@ If you don't want to autoregister some files, then simply don't add that magic c
 Files ending with **`.schema.js`** will be auto registered.  
 For example: **hello.js** and **hello.schema.js**  
 
+Schemas are optional.
 Besides the basic validation fields we can set fields like `tags`, `summary` and description,  
-which will appear in the docs.
+which will appear in the docs. Only if a schema exists the route will be added to the documentation.
 
 
 ```js
@@ -217,6 +218,10 @@ Rule of thumb: make the message something you would want to see at 03:00 in logs
 
 
 
+## Note
+On loading routes - possible side effects execute.
+Means you can eg declare globals.
+
 ## About
 - Dependencies: original fastify packages + scalar/fastify-api-reference
 - The source is simple. Everyone can read, understand and modify if needed.

package/index.d.ts

@@ -5,8 +5,22 @@ declare function maxserver(...args: any[]): any;
 export default maxserver;
 
 declare global {
+
+	var global: typeof globalThis;
+
+	/** Casts a string ID to a MongoDB ObjectId using the global helper [cite: 2026-02-15]. */
 	var oid: (id: string) => import("mongodb").ObjectId;
+
+	/** Access to the global MongoDB database instance [cite: 2026-02-15]. */
 	var db: import("mongodb").Db;
+
+	/**
+	 * Creates an Error object with an attached HTTP status code [cite: 2026-02-15].
+	 * Fastify catches this to return a structured JSON response.
+	 * * @param code The HTTP status code (e.g., 400, 401, 403, 404).
+	 * @param message The specific failure reason returned in the JSON body.
+	 */
+	var createError: (code: number, message: string) => Error;
 }
 
 declare module "fastify" {

package/package.json

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

package/src/index.js

@@ -17,7 +17,6 @@ import { setupDevSounds } from "./devSounds.js";
 
 export default async function maxserver(config = {}) {
 
-	console.log("local one running 3");
 
 	const {
 

package/src/setupDocs.js

@@ -52,6 +52,12 @@ export async function setupDocs(app) {
 				},
 			},
 		},
+		// Only consider for documentation routes which have a schema
+		transform: ({ schema, url }) => {
+			const isDefined = schema && (schema.summary || schema.response || schema.body);
+			if (!isDefined) return { schema: { hide: true }, url };
+			return { schema, url };
+		}
 	});
 
 	// not needed, the scalar extension provides it by default on /docs/openapi.json

package/templates/jsconfig.json

@@ -0,0 +1,31 @@
+{
+	"compilerOptions": {
+		"checkJs": true,
+		"module": "ES2020",
+		"target": "ES2020",
+		"moduleResolution": "bundler",
+		"jsx": "react-jsx",
+		"strict": false,
+		"noUnusedParameters": false,
+		"noUnusedLocals": false,
+		"noImplicitAny": false,
+		// new attempt to reduce noise
+		"skipLibCheck": true,
+		//"baseUrl": ".",
+		"paths": {
+			"*": [
+				"./src/*"
+			],
+		},
+		"types": [
+			"node",
+			"maxserver"
+		]
+	},
+	"include": [
+		"src"
+	],
+	"exclude": [
+		"node_modules",
+	],
+}