@tahminator/sapling 2.0.5-beta.e0403942 → 2.1.0-beta.0e8a97e8

package/dist/index.cjs

@@ -270,10 +270,160 @@ var ParserError = class ParserError extends ResponseStatusError {
 	}
 };
 //#endregion
+//#region lib/weakmap.ts
+/**
+* WeakMap that is iterable.
+*/
+var IterableWeakMap = class IterableWeakMap {
+	#weakMap = /* @__PURE__ */ new WeakMap();
+	#refSet = /* @__PURE__ */ new Set();
+	#finalizationGroup = new FinalizationRegistry(IterableWeakMap.#cleanup);
+	static #cleanup(heldValue) {
+		heldValue.set.delete(heldValue.ref);
+	}
+	constructor(iterable) {
+		if (iterable) for (const [key, value] of iterable) this.set(key, value);
+	}
+	set(key, value) {
+		const ref = new WeakRef(key);
+		this.#weakMap.set(key, {
+			value,
+			ref
+		});
+		this.#refSet.add(ref);
+		this.#finalizationGroup.register(key, {
+			set: this.#refSet,
+			ref
+		}, ref);
+		return this;
+	}
+	get(key) {
+		return this.#weakMap.get(key)?.value;
+	}
+	delete(key) {
+		const entry = this.#weakMap.get(key);
+		if (!entry) return false;
+		this.#weakMap.delete(key);
+		this.#refSet.delete(entry.ref);
+		this.#finalizationGroup.unregister(entry.ref);
+		return true;
+	}
+	*[Symbol.iterator]() {
+		for (const ref of this.#refSet) {
+			const key = ref.deref();
+			if (!key) continue;
+			const entry = this.#weakMap.get(key);
+			if (entry) yield [key, entry.value];
+		}
+	}
+	entries() {
+		return this[Symbol.iterator]();
+	}
+	*keys() {
+		for (const [key] of this) yield key;
+	}
+	*values() {
+		for (const [, value] of this) yield value;
+	}
+	forEach(callback, thisArg) {
+		for (const [key, value] of this) callback.call(thisArg, value, key, this);
+	}
+};
+//#endregion
+//#region src/annotation/injectable.ts
+const _InjectableRegistry = /* @__PURE__ */ new WeakMap();
+const _InjectableDeps = new IterableWeakMap();
+/**
+* Mark the class as an injectable to be handled by Sapling. The class can now be
+* be injected into other classes, as well as allow the class to inject other `@Injectable` classes.
+*
+* @argument deps - An optional array to define any dependencies that this class may require.
+*/
+function Injectable(deps = []) {
+	return function(target) {
+		_InjectableRegistry.set(target, null);
+		_InjectableDeps.set(target, deps);
+	};
+}
+/**
+* Resolves and instantiates a class along with all of it's transitive dependencies.
+*
+* Uses topological sort (Kahn's algorithm) to ensure that the dependency graph is created
+* in a correct order.
+*
+* When `resolve` is first called (usually during controller registration),
+* it will compute the dependency graph of all `@Injectable` classes and instantiates
+* them in the correct order.
+*
+* Subsequent calls to dependencies that have already been resolved are cached, so they will
+* re-use the created singletons instead of re-instantiation.
+*/
+function _resolve(ctor) {
+	const inDegree = /* @__PURE__ */ new Map();
+	const graph = /* @__PURE__ */ new Map();
+	_InjectableDeps.forEach((deps, node) => {
+		inDegree.set(node, inDegree.get(node) || 0);
+		deps.forEach((dep) => {
+			if (dep === void 0) throw new Error(`There is an @Injectable (${node.name}) which has a dependency that cannot be found. This is likely caused by a circular dependency.`);
+			inDegree.set(dep, inDegree.get(dep) || 0);
+			inDegree.set(node, inDegree.get(node) + 1);
+			if (!graph.has(dep)) graph.set(dep, []);
+			graph.get(dep).push(node);
+		});
+	});
+	const queue = [];
+	inDegree.forEach((deg, node) => {
+		if (deg === 0) queue.push(node);
+	});
+	while (queue.length) {
+		const current = queue.shift();
+		if (!_InjectableRegistry.get(current)) {
+			const instance = new current(...(_InjectableDeps.get(current) || []).map((dep) => _InjectableRegistry.get(dep)));
+			_InjectableRegistry.set(current, instance);
+		}
+		(graph.get(current) || []).forEach((neighbor) => {
+			inDegree.set(neighbor, (inDegree.get(neighbor) ?? 0) - 1);
+			if (inDegree.get(neighbor) === 0) queue.push(neighbor);
+		});
+	}
+	if (!_InjectableRegistry.get(ctor)) throw new Error("Circular dependency detected or injectable not registered");
+	return _InjectableRegistry.get(ctor);
+}
+//#endregion
+//#region \0@oxc-project+runtime@0.127.0/helpers/decorate.js
+function __decorate(decorators, target, key, desc) {
+	var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+	if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+	else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+	return c > 3 && r && Object.defineProperty(target, key, r), r;
+}
+//#endregion
+//#region src/middleware/health/registrar.ts
+let HealthRegistrar = class HealthRegistrar {
+	_checks;
+	_sealed;
+	constructor() {
+		this._checks = [];
+		this._sealed = false;
+	}
+	add(healthCheck) {
+		this._checks.push(healthCheck);
+	}
+	seal() {
+		this._sealed = true;
+	}
+	async check() {
+		if (!this._sealed) return false;
+		return (await Promise.all(this._checks.map((c) => c()))).every((c) => c === true);
+	}
+};
+HealthRegistrar = __decorate([Injectable()], HealthRegistrar);
+//#endregion
 //#region src/helper/sapling.ts
 const _settings = {
 	serialize: JSON.stringify,
 	deserialize: JSON.parse,
+	health: { path: "/up" },
 	doc: {
 		openApiPath: "/openapi.json",
 		swaggerPath: "/swagger.html",
@@ -349,6 +499,7 @@ var Sapling = class Sapling {
 	static registerApp(app) {
 		app.use(express.default.text({ type: "application/json" }));
 		app.use(Sapling.json());
+		_InjectableRegistry.get(HealthRegistrar)?.seal();
 	}
 	/**
 	* Serialize a value into a JSON string.
@@ -629,6 +780,7 @@ function _getValidatorSchema(ctor, fnName) {
 //#endregion
 //#region src/helper/openapi.ts
 var OpenAPIGenerator = class {
+	OPENAPI_VERSION = "3.0.0";
 	controllers = /* @__PURE__ */ new Set();
 	registerController(controllerClass, prefix) {
 		this.controllers.add({
@@ -636,6 +788,12 @@ var OpenAPIGenerator = class {
 			prefix
 		});
 	}
+	/**
+	* visible for testing
+	*/
+	_clearControllers() {
+		this.controllers.clear();
+	}
 	get metadata() {
 		return _settings.doc.metadata;
 	}
@@ -724,7 +882,7 @@ var OpenAPIGenerator = class {
 			}
 		}
 		return {
-			openapi: "3.0.0",
+			openapi: this.OPENAPI_VERSION,
 			info: {
 				title: metadata.title,
 				version: metadata.version,
@@ -751,6 +909,9 @@ function _registerController(controllerClass, prefix) {
 function generateOpenApiSpec() {
 	return openApiGenerator.generateSpec();
 }
+function _clearOpenApiRegistry() {
+	openApiGenerator._clearControllers();
+}
 //#endregion
 //#region src/types.ts
 const methodResolve = {
@@ -764,126 +925,6 @@ const methodResolve = {
 	USE: "use"
 };
 //#endregion
-//#region lib/weakmap.ts
-/**
-* WeakMap that is iterable.
-*/
-var IterableWeakMap = class IterableWeakMap {
-	#weakMap = /* @__PURE__ */ new WeakMap();
-	#refSet = /* @__PURE__ */ new Set();
-	#finalizationGroup = new FinalizationRegistry(IterableWeakMap.#cleanup);
-	static #cleanup(heldValue) {
-		heldValue.set.delete(heldValue.ref);
-	}
-	constructor(iterable) {
-		if (iterable) for (const [key, value] of iterable) this.set(key, value);
-	}
-	set(key, value) {
-		const ref = new WeakRef(key);
-		this.#weakMap.set(key, {
-			value,
-			ref
-		});
-		this.#refSet.add(ref);
-		this.#finalizationGroup.register(key, {
-			set: this.#refSet,
-			ref
-		}, ref);
-		return this;
-	}
-	get(key) {
-		return this.#weakMap.get(key)?.value;
-	}
-	delete(key) {
-		const entry = this.#weakMap.get(key);
-		if (!entry) return false;
-		this.#weakMap.delete(key);
-		this.#refSet.delete(entry.ref);
-		this.#finalizationGroup.unregister(entry.ref);
-		return true;
-	}
-	*[Symbol.iterator]() {
-		for (const ref of this.#refSet) {
-			const key = ref.deref();
-			if (!key) continue;
-			const entry = this.#weakMap.get(key);
-			if (entry) yield [key, entry.value];
-		}
-	}
-	entries() {
-		return this[Symbol.iterator]();
-	}
-	*keys() {
-		for (const [key] of this) yield key;
-	}
-	*values() {
-		for (const [, value] of this) yield value;
-	}
-	forEach(callback, thisArg) {
-		for (const [key, value] of this) callback.call(thisArg, value, key, this);
-	}
-};
-//#endregion
-//#region src/annotation/injectable.ts
-const _InjectableRegistry = /* @__PURE__ */ new WeakMap();
-const _InjectableDeps = new IterableWeakMap();
-/**
-* Mark the class as an injectable to be handled by Sapling. The class can now be
-* be injected into other classes, as well as allow the class to inject other `@Injectable` classes.
-*
-* @argument deps - An optional array to define any dependencies that this class may require.
-*/
-function Injectable(deps = []) {
-	return function(target) {
-		_InjectableRegistry.set(target, null);
-		_InjectableDeps.set(target, deps);
-	};
-}
-/**
-* Resolves and instantiates a class along with all of it's transitive dependencies.
-*
-* Uses topological sort (Kahn's algorithm) to ensure that the dependency graph is created
-* in a correct order.
-*
-* When `resolve` is first called (usually during controller registration),
-* it will compute the dependency graph of all `@Injectable` classes and instantiates
-* them in the correct order.
-*
-* Subsequent calls to dependencies that have already been resolved are cached, so they will
-* re-use the created singletons instead of re-instantiation.
-*/
-function _resolve(ctor) {
-	const inDegree = /* @__PURE__ */ new Map();
-	const graph = /* @__PURE__ */ new Map();
-	_InjectableDeps.forEach((deps, node) => {
-		inDegree.set(node, inDegree.get(node) || 0);
-		deps.forEach((dep) => {
-			if (dep === void 0) throw new Error(`There is an @Injectable (${node.name}) which has a dependency that cannot be found. This is likely caused by a circular dependency.`);
-			inDegree.set(dep, inDegree.get(dep) || 0);
-			inDegree.set(node, inDegree.get(node) + 1);
-			if (!graph.has(dep)) graph.set(dep, []);
-			graph.get(dep).push(node);
-		});
-	});
-	const queue = [];
-	inDegree.forEach((deg, node) => {
-		if (deg === 0) queue.push(node);
-	});
-	while (queue.length) {
-		const current = queue.shift();
-		if (!_InjectableRegistry.get(current)) {
-			const instance = new current(...(_InjectableDeps.get(current) || []).map((dep) => _InjectableRegistry.get(dep)));
-			_InjectableRegistry.set(current, instance);
-		}
-		(graph.get(current) || []).forEach((neighbor) => {
-			inDegree.set(neighbor, (inDegree.get(neighbor) ?? 0) - 1);
-			if (inDegree.get(neighbor) === 0) queue.push(neighbor);
-		});
-	}
-	if (!_InjectableRegistry.get(ctor)) throw new Error("Circular dependency detected or injectable not registered");
-	return _InjectableRegistry.get(ctor);
-}
-//#endregion
 //#region src/annotation/controller.ts
 const _ControllerRegistry = /* @__PURE__ */ new WeakMap();
 /**
@@ -1002,14 +1043,6 @@ function MiddlewareClass(...args) {
 	return Controller(...args);
 }
 //#endregion
-//#region \0@oxc-project+runtime@0.127.0/helpers/decorate.js
-function __decorate(decorators, target, key, desc) {
-	var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-	if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-	else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-	return c > 3 && r && Object.defineProperty(target, key, r), r;
-}
-//#endregion
 //#region src/middleware/default/error/base.ts
 let DefaultBaseErrorMiddleware = class DefaultBaseErrorMiddleware {
 	handle(err, _request, _response, _next) {
@@ -1125,6 +1158,19 @@ const DefaultSwaggerMiddleware = {
 	Setup
 };
 //#endregion
+//#region src/middleware/default/health/index.ts
+let DefaultHealthMiddleware = class DefaultHealthMiddleware {
+	constructor(healthRegistrar) {
+		this.healthRegistrar = healthRegistrar;
+	}
+	async serve(_request, _response, _next) {
+		const up = await this.healthRegistrar.check();
+		return ResponseEntity.ok().body({ up });
+	}
+};
+__decorate([GET(_settings.health.path)], DefaultHealthMiddleware.prototype, "serve", null);
+DefaultHealthMiddleware = __decorate([MiddlewareClass({ deps: [HealthRegistrar] })], DefaultHealthMiddleware);
+//#endregion
 exports.Controller = Controller;
 exports.ControllerSchema = ControllerSchema;
 exports.DELETE = DELETE;
@@ -1134,6 +1180,12 @@ Object.defineProperty(exports, "DefaultBaseErrorMiddleware", {
 		return DefaultBaseErrorMiddleware;
 	}
 });
+Object.defineProperty(exports, "DefaultHealthMiddleware", {
+	enumerable: true,
+	get: function() {
+		return DefaultHealthMiddleware;
+	}
+});
 Object.defineProperty(exports, "DefaultOpenApiMiddleware", {
 	enumerable: true,
 	get: function() {
@@ -1155,6 +1207,12 @@ Object.defineProperty(exports, "DefaultResponseStatusErrorMiddleware", {
 exports.DefaultSwaggerMiddleware = DefaultSwaggerMiddleware;
 exports.GET = GET;
 exports.HEAD = HEAD;
+Object.defineProperty(exports, "HealthRegistrar", {
+	enumerable: true,
+	get: function() {
+		return HealthRegistrar;
+	}
+});
 exports.Html404ErrorPage = Html404ErrorPage;
 exports.HttpStatus = HttpStatus;
 exports.Injectable = Injectable;
@@ -1179,6 +1237,7 @@ exports._ControllerRegistry = _ControllerRegistry;
 exports._InjectableDeps = _InjectableDeps;
 exports._InjectableRegistry = _InjectableRegistry;
 exports._Route = _Route;
+exports._clearOpenApiRegistry = _clearOpenApiRegistry;
 exports._getControllerSchema = _getControllerSchema;
 exports._getOrCreateSchemaDefinition = _getOrCreateSchemaDefinition;
 exports._getRouteSchema = _getRouteSchema;

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import e, { ErrorRequestHandler, NextFunction, Request, RequestHandler, Response as Response$1, Router } from "express";
+import e, { ErrorRequestHandler, NextFunction, Request as Request$1, RequestHandler, Response as Response$1, Router } from "express";
 
 //#region src/html/404.d.ts
 /**
@@ -26,7 +26,7 @@ type RouteDefinition = {
 };
 type Class<T> = new (...args: any[]) => T;
 type HttpHeaders = Record<string, string>;
-type ExpressMiddlewareFn = ($1: Request, $2: Response$1, $3: NextFunction) => void;
+type ExpressMiddlewareFn = ($1: Request$1, $2: Response$1, $3: NextFunction) => void;
 //#endregion
 //#region src/annotation/controller.d.ts
 declare const _ControllerRegistry: WeakMap<Function, Router | ErrorRequestHandler>;
@@ -774,8 +774,13 @@ type OpenAPIMetadata = {
   description?: string;
 };
 declare class OpenAPIGenerator {
+  private OPENAPI_VERSION;
   private controllers;
   registerController(controllerClass: Function, prefix: string): void;
+  /**
+   * visible for testing
+   */
+  _clearControllers(): void;
   private get metadata();
   generateSpec(): OpenAPIV3.Document;
   private toJsonSchema;
@@ -783,11 +788,15 @@ declare class OpenAPIGenerator {
 declare const openApiGenerator: OpenAPIGenerator;
 declare function _registerController(controllerClass: Function, prefix: string): void;
 declare function generateOpenApiSpec(): OpenAPIV3.Document;
+declare function _clearOpenApiRegistry(): void;
 //#endregion
 //#region src/helper/sapling.d.ts
 type Settings = {
   serialize: (value: any) => string;
   deserialize: (value: string) => any;
+  health: {
+    path: string;
+  };
   doc: {
     openApiPath: string;
     swaggerPath: string;
@@ -916,7 +925,7 @@ declare class Sapling {
    *  }
    * ```
    */
-  static chainHandlers(this: void, handlers: RequestHandler[], request: Request, response: Response$1, next: NextFunction, index?: number): void;
+  static chainHandlers(this: void, handlers: RequestHandler[], request: Request$1, response: Response$1, next: NextFunction, index?: number): void;
 }
 //#endregion
 //#region src/annotation/validator.d.ts
@@ -972,7 +981,7 @@ declare function _getControllerSchema(ctor: Function): ControllerSchemaDefinitio
  * If the default is not suitable, you may also easily write your own.
  */
 declare class DefaultBaseErrorMiddleware {
-  handle(err: unknown, _request: Request, _response: Response$1, _next: NextFunction): ResponseEntity<{
+  handle(err: unknown, _request: Request$1, _response: Response$1, _next: NextFunction): ResponseEntity<{
     message: string;
   }>;
 }
@@ -983,7 +992,7 @@ declare class DefaultBaseErrorMiddleware {
  * If the default is not suitable, you may also easily write your own.
  */
 declare class DefaultParserErrorMiddleware {
-  handle(err: unknown, _request: Request, _response: Response$1, next: NextFunction): ResponseEntity<{
+  handle(err: unknown, _request: Request$1, _response: Response$1, next: NextFunction): ResponseEntity<{
     message: string;
   }> | undefined;
 }
@@ -994,7 +1003,7 @@ declare class DefaultParserErrorMiddleware {
  * If the default is not suitable, you may also easily write your own.
  */
 declare class DefaultResponseStatusErrorMiddleware {
-  handle(err: unknown, _request: Request, _response: Response$1, next: NextFunction): ResponseEntity<{
+  handle(err: unknown, _request: Request$1, _response: Response$1, next: NextFunction): ResponseEntity<{
     message: string;
   }> | undefined;
 }
@@ -1017,7 +1026,7 @@ declare class DefaultResponseStatusErrorMiddleware {
  * ```
  */
 declare class DefaultOpenApiMiddleware {
-  handle(_request: Request, _response: Response$1, _next: NextFunction): ResponseEntity<OpenAPIV3.Document<{}>>;
+  handle(_request: Request$1, _response: Response$1, _next: NextFunction): ResponseEntity<OpenAPIV3.Document<{}>>;
 }
 //#endregion
 //#region src/middleware/default/swagger/index.d.ts
@@ -1039,7 +1048,7 @@ declare class DefaultOpenApiMiddleware {
  */
 declare class Serve {
   private readonly handlers;
-  handle(request: Request, response: Response$1, next: NextFunction): void;
+  handle(request: Request$1, response: Response$1, next: NextFunction): void;
 }
 /**
  * Enable the serving of the Swagger endpoint used to serve the OpenAPI spec generated by Sapling.
@@ -1060,7 +1069,7 @@ declare class Serve {
 declare class Setup {
   private readonly handler;
   constructor();
-  handle(request: Request, response: Response$1, next: NextFunction): unknown;
+  handle(request: Request$1, response: Response$1, next: NextFunction): unknown;
 }
 /**
  * Enable the serving of the Swagger endpoint used to serve the OpenAPI spec generated by Sapling.
@@ -1083,4 +1092,24 @@ declare const DefaultSwaggerMiddleware: {
   Setup: typeof Setup;
 };
 //#endregion
-export { Class, Controller, ControllerSchema, ControllerSchemaDefinition, DELETE, DefaultBaseErrorMiddleware, DefaultOpenApiMiddleware, DefaultParserErrorMiddleware, DefaultResponseStatusErrorMiddleware, DefaultSwaggerMiddleware, ExpressMiddlewareFn, ExpressRouterMethodKey, ExpressRouterMethods, GET, HEAD, Html404ErrorPage, HttpHeaders, HttpStatus, Injectable, Middleware, MiddlewareClass, OPTIONS, OpenAPIMetadata, PATCH, POST, PUT, ParserError, ParserErrorLocation, RedirectView, RequestBody, RequestParam, RequestQuery, ResponseBody, ResponseEntity, ResponseEntityBuilder, ResponseSchema, ResponseStatusError, RouteDefinition, RouteSchema, RouteSchemaDefinition, Sapling, ValidatorSchema, _ControllerRegistry, _InjectableDeps, _InjectableRegistry, _Route, _getControllerSchema, _getOrCreateSchemaDefinition, _getRouteSchema, _getRoutes, _getValidatorSchema, _parseOrThrow, _registerController, _resolve, _saveValidatorSchema, _setControllerSchema, _setRouteSchema, _settings, generateOpenApiSpec, methodResolve, openApiGenerator };
+//#region src/middleware/health/registrar.d.ts
+type HealthCheck = () => boolean | Promise<boolean>;
+declare class HealthRegistrar {
+  private _checks;
+  private _sealed;
+  constructor();
+  add(healthCheck: HealthCheck): void;
+  seal(): void;
+  check(): Promise<boolean>;
+}
+//#endregion
+//#region src/middleware/default/health/index.d.ts
+declare class DefaultHealthMiddleware {
+  private readonly healthRegistrar;
+  constructor(healthRegistrar: HealthRegistrar);
+  serve(_request: Request, _response: Response, _next: NextFunction): Promise<ResponseEntity<{
+    up: boolean;
+  }>>;
+}
+//#endregion
+export { Class, Controller, ControllerSchema, ControllerSchemaDefinition, DELETE, DefaultBaseErrorMiddleware, DefaultHealthMiddleware, DefaultOpenApiMiddleware, DefaultParserErrorMiddleware, DefaultResponseStatusErrorMiddleware, DefaultSwaggerMiddleware, ExpressMiddlewareFn, ExpressRouterMethodKey, ExpressRouterMethods, GET, HEAD, HealthCheck, HealthRegistrar, Html404ErrorPage, HttpHeaders, HttpStatus, Injectable, Middleware, MiddlewareClass, OPTIONS, OpenAPIMetadata, PATCH, POST, PUT, ParserError, ParserErrorLocation, RedirectView, RequestBody, RequestParam, RequestQuery, ResponseBody, ResponseEntity, ResponseEntityBuilder, ResponseSchema, ResponseStatusError, RouteDefinition, RouteSchema, RouteSchemaDefinition, Sapling, ValidatorSchema, _ControllerRegistry, _InjectableDeps, _InjectableRegistry, _Route, _clearOpenApiRegistry, _getControllerSchema, _getOrCreateSchemaDefinition, _getRouteSchema, _getRoutes, _getValidatorSchema, _parseOrThrow, _registerController, _resolve, _saveValidatorSchema, _setControllerSchema, _setRouteSchema, _settings, generateOpenApiSpec, methodResolve, openApiGenerator };

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import e, { ErrorRequestHandler, NextFunction, Request, RequestHandler, Response as Response$1, Router } from "express";
+import e, { ErrorRequestHandler, NextFunction, Request as Request$1, RequestHandler, Response as Response$1, Router } from "express";
 
 //#region src/html/404.d.ts
 /**
@@ -26,7 +26,7 @@ type RouteDefinition = {
 };
 type Class<T> = new (...args: any[]) => T;
 type HttpHeaders = Record<string, string>;
-type ExpressMiddlewareFn = ($1: Request, $2: Response$1, $3: NextFunction) => void;
+type ExpressMiddlewareFn = ($1: Request$1, $2: Response$1, $3: NextFunction) => void;
 //#endregion
 //#region src/annotation/controller.d.ts
 declare const _ControllerRegistry: WeakMap<Function, Router | ErrorRequestHandler>;
@@ -774,8 +774,13 @@ type OpenAPIMetadata = {
   description?: string;
 };
 declare class OpenAPIGenerator {
+  private OPENAPI_VERSION;
   private controllers;
   registerController(controllerClass: Function, prefix: string): void;
+  /**
+   * visible for testing
+   */
+  _clearControllers(): void;
   private get metadata();
   generateSpec(): OpenAPIV3.Document;
   private toJsonSchema;
@@ -783,11 +788,15 @@ declare class OpenAPIGenerator {
 declare const openApiGenerator: OpenAPIGenerator;
 declare function _registerController(controllerClass: Function, prefix: string): void;
 declare function generateOpenApiSpec(): OpenAPIV3.Document;
+declare function _clearOpenApiRegistry(): void;
 //#endregion
 //#region src/helper/sapling.d.ts
 type Settings = {
   serialize: (value: any) => string;
   deserialize: (value: string) => any;
+  health: {
+    path: string;
+  };
   doc: {
     openApiPath: string;
     swaggerPath: string;
@@ -916,7 +925,7 @@ declare class Sapling {
    *  }
    * ```
    */
-  static chainHandlers(this: void, handlers: RequestHandler[], request: Request, response: Response$1, next: NextFunction, index?: number): void;
+  static chainHandlers(this: void, handlers: RequestHandler[], request: Request$1, response: Response$1, next: NextFunction, index?: number): void;
 }
 //#endregion
 //#region src/annotation/validator.d.ts
@@ -972,7 +981,7 @@ declare function _getControllerSchema(ctor: Function): ControllerSchemaDefinitio
  * If the default is not suitable, you may also easily write your own.
  */
 declare class DefaultBaseErrorMiddleware {
-  handle(err: unknown, _request: Request, _response: Response$1, _next: NextFunction): ResponseEntity<{
+  handle(err: unknown, _request: Request$1, _response: Response$1, _next: NextFunction): ResponseEntity<{
     message: string;
   }>;
 }
@@ -983,7 +992,7 @@ declare class DefaultBaseErrorMiddleware {
  * If the default is not suitable, you may also easily write your own.
  */
 declare class DefaultParserErrorMiddleware {
-  handle(err: unknown, _request: Request, _response: Response$1, next: NextFunction): ResponseEntity<{
+  handle(err: unknown, _request: Request$1, _response: Response$1, next: NextFunction): ResponseEntity<{
     message: string;
   }> | undefined;
 }
@@ -994,7 +1003,7 @@ declare class DefaultParserErrorMiddleware {
  * If the default is not suitable, you may also easily write your own.
  */
 declare class DefaultResponseStatusErrorMiddleware {
-  handle(err: unknown, _request: Request, _response: Response$1, next: NextFunction): ResponseEntity<{
+  handle(err: unknown, _request: Request$1, _response: Response$1, next: NextFunction): ResponseEntity<{
     message: string;
   }> | undefined;
 }
@@ -1017,7 +1026,7 @@ declare class DefaultResponseStatusErrorMiddleware {
  * ```
  */
 declare class DefaultOpenApiMiddleware {
-  handle(_request: Request, _response: Response$1, _next: NextFunction): ResponseEntity<OpenAPIV3.Document<{}>>;
+  handle(_request: Request$1, _response: Response$1, _next: NextFunction): ResponseEntity<OpenAPIV3.Document<{}>>;
 }
 //#endregion
 //#region src/middleware/default/swagger/index.d.ts
@@ -1039,7 +1048,7 @@ declare class DefaultOpenApiMiddleware {
  */
 declare class Serve {
   private readonly handlers;
-  handle(request: Request, response: Response$1, next: NextFunction): void;
+  handle(request: Request$1, response: Response$1, next: NextFunction): void;
 }
 /**
  * Enable the serving of the Swagger endpoint used to serve the OpenAPI spec generated by Sapling.
@@ -1060,7 +1069,7 @@ declare class Serve {
 declare class Setup {
   private readonly handler;
   constructor();
-  handle(request: Request, response: Response$1, next: NextFunction): unknown;
+  handle(request: Request$1, response: Response$1, next: NextFunction): unknown;
 }
 /**
  * Enable the serving of the Swagger endpoint used to serve the OpenAPI spec generated by Sapling.
@@ -1083,4 +1092,24 @@ declare const DefaultSwaggerMiddleware: {
   Setup: typeof Setup;
 };
 //#endregion
-export { Class, Controller, ControllerSchema, ControllerSchemaDefinition, DELETE, DefaultBaseErrorMiddleware, DefaultOpenApiMiddleware, DefaultParserErrorMiddleware, DefaultResponseStatusErrorMiddleware, DefaultSwaggerMiddleware, ExpressMiddlewareFn, ExpressRouterMethodKey, ExpressRouterMethods, GET, HEAD, Html404ErrorPage, HttpHeaders, HttpStatus, Injectable, Middleware, MiddlewareClass, OPTIONS, OpenAPIMetadata, PATCH, POST, PUT, ParserError, ParserErrorLocation, RedirectView, RequestBody, RequestParam, RequestQuery, ResponseBody, ResponseEntity, ResponseEntityBuilder, ResponseSchema, ResponseStatusError, RouteDefinition, RouteSchema, RouteSchemaDefinition, Sapling, ValidatorSchema, _ControllerRegistry, _InjectableDeps, _InjectableRegistry, _Route, _getControllerSchema, _getOrCreateSchemaDefinition, _getRouteSchema, _getRoutes, _getValidatorSchema, _parseOrThrow, _registerController, _resolve, _saveValidatorSchema, _setControllerSchema, _setRouteSchema, _settings, generateOpenApiSpec, methodResolve, openApiGenerator };
+//#region src/middleware/health/registrar.d.ts
+type HealthCheck = () => boolean | Promise<boolean>;
+declare class HealthRegistrar {
+  private _checks;
+  private _sealed;
+  constructor();
+  add(healthCheck: HealthCheck): void;
+  seal(): void;
+  check(): Promise<boolean>;
+}
+//#endregion
+//#region src/middleware/default/health/index.d.ts
+declare class DefaultHealthMiddleware {
+  private readonly healthRegistrar;
+  constructor(healthRegistrar: HealthRegistrar);
+  serve(_request: Request, _response: Response, _next: NextFunction): Promise<ResponseEntity<{
+    up: boolean;
+  }>>;
+}
+//#endregion
+export { Class, Controller, ControllerSchema, ControllerSchemaDefinition, DELETE, DefaultBaseErrorMiddleware, DefaultHealthMiddleware, DefaultOpenApiMiddleware, DefaultParserErrorMiddleware, DefaultResponseStatusErrorMiddleware, DefaultSwaggerMiddleware, ExpressMiddlewareFn, ExpressRouterMethodKey, ExpressRouterMethods, GET, HEAD, HealthCheck, HealthRegistrar, Html404ErrorPage, HttpHeaders, HttpStatus, Injectable, Middleware, MiddlewareClass, OPTIONS, OpenAPIMetadata, PATCH, POST, PUT, ParserError, ParserErrorLocation, RedirectView, RequestBody, RequestParam, RequestQuery, ResponseBody, ResponseEntity, ResponseEntityBuilder, ResponseSchema, ResponseStatusError, RouteDefinition, RouteSchema, RouteSchemaDefinition, Sapling, ValidatorSchema, _ControllerRegistry, _InjectableDeps, _InjectableRegistry, _Route, _clearOpenApiRegistry, _getControllerSchema, _getOrCreateSchemaDefinition, _getRouteSchema, _getRoutes, _getValidatorSchema, _parseOrThrow, _registerController, _resolve, _saveValidatorSchema, _setControllerSchema, _setRouteSchema, _settings, generateOpenApiSpec, methodResolve, openApiGenerator };

package/dist/index.mjs

@@ -245,10 +245,160 @@ var ParserError = class ParserError extends ResponseStatusError {
 	}
 };
 //#endregion
+//#region lib/weakmap.ts
+/**
+* WeakMap that is iterable.
+*/
+var IterableWeakMap = class IterableWeakMap {
+	#weakMap = /* @__PURE__ */ new WeakMap();
+	#refSet = /* @__PURE__ */ new Set();
+	#finalizationGroup = new FinalizationRegistry(IterableWeakMap.#cleanup);
+	static #cleanup(heldValue) {
+		heldValue.set.delete(heldValue.ref);
+	}
+	constructor(iterable) {
+		if (iterable) for (const [key, value] of iterable) this.set(key, value);
+	}
+	set(key, value) {
+		const ref = new WeakRef(key);
+		this.#weakMap.set(key, {
+			value,
+			ref
+		});
+		this.#refSet.add(ref);
+		this.#finalizationGroup.register(key, {
+			set: this.#refSet,
+			ref
+		}, ref);
+		return this;
+	}
+	get(key) {
+		return this.#weakMap.get(key)?.value;
+	}
+	delete(key) {
+		const entry = this.#weakMap.get(key);
+		if (!entry) return false;
+		this.#weakMap.delete(key);
+		this.#refSet.delete(entry.ref);
+		this.#finalizationGroup.unregister(entry.ref);
+		return true;
+	}
+	*[Symbol.iterator]() {
+		for (const ref of this.#refSet) {
+			const key = ref.deref();
+			if (!key) continue;
+			const entry = this.#weakMap.get(key);
+			if (entry) yield [key, entry.value];
+		}
+	}
+	entries() {
+		return this[Symbol.iterator]();
+	}
+	*keys() {
+		for (const [key] of this) yield key;
+	}
+	*values() {
+		for (const [, value] of this) yield value;
+	}
+	forEach(callback, thisArg) {
+		for (const [key, value] of this) callback.call(thisArg, value, key, this);
+	}
+};
+//#endregion
+//#region src/annotation/injectable.ts
+const _InjectableRegistry = /* @__PURE__ */ new WeakMap();
+const _InjectableDeps = new IterableWeakMap();
+/**
+* Mark the class as an injectable to be handled by Sapling. The class can now be
+* be injected into other classes, as well as allow the class to inject other `@Injectable` classes.
+*
+* @argument deps - An optional array to define any dependencies that this class may require.
+*/
+function Injectable(deps = []) {
+	return function(target) {
+		_InjectableRegistry.set(target, null);
+		_InjectableDeps.set(target, deps);
+	};
+}
+/**
+* Resolves and instantiates a class along with all of it's transitive dependencies.
+*
+* Uses topological sort (Kahn's algorithm) to ensure that the dependency graph is created
+* in a correct order.
+*
+* When `resolve` is first called (usually during controller registration),
+* it will compute the dependency graph of all `@Injectable` classes and instantiates
+* them in the correct order.
+*
+* Subsequent calls to dependencies that have already been resolved are cached, so they will
+* re-use the created singletons instead of re-instantiation.
+*/
+function _resolve(ctor) {
+	const inDegree = /* @__PURE__ */ new Map();
+	const graph = /* @__PURE__ */ new Map();
+	_InjectableDeps.forEach((deps, node) => {
+		inDegree.set(node, inDegree.get(node) || 0);
+		deps.forEach((dep) => {
+			if (dep === void 0) throw new Error(`There is an @Injectable (${node.name}) which has a dependency that cannot be found. This is likely caused by a circular dependency.`);
+			inDegree.set(dep, inDegree.get(dep) || 0);
+			inDegree.set(node, inDegree.get(node) + 1);
+			if (!graph.has(dep)) graph.set(dep, []);
+			graph.get(dep).push(node);
+		});
+	});
+	const queue = [];
+	inDegree.forEach((deg, node) => {
+		if (deg === 0) queue.push(node);
+	});
+	while (queue.length) {
+		const current = queue.shift();
+		if (!_InjectableRegistry.get(current)) {
+			const instance = new current(...(_InjectableDeps.get(current) || []).map((dep) => _InjectableRegistry.get(dep)));
+			_InjectableRegistry.set(current, instance);
+		}
+		(graph.get(current) || []).forEach((neighbor) => {
+			inDegree.set(neighbor, (inDegree.get(neighbor) ?? 0) - 1);
+			if (inDegree.get(neighbor) === 0) queue.push(neighbor);
+		});
+	}
+	if (!_InjectableRegistry.get(ctor)) throw new Error("Circular dependency detected or injectable not registered");
+	return _InjectableRegistry.get(ctor);
+}
+//#endregion
+//#region \0@oxc-project+runtime@0.127.0/helpers/decorate.js
+function __decorate(decorators, target, key, desc) {
+	var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+	if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+	else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+	return c > 3 && r && Object.defineProperty(target, key, r), r;
+}
+//#endregion
+//#region src/middleware/health/registrar.ts
+let HealthRegistrar = class HealthRegistrar {
+	_checks;
+	_sealed;
+	constructor() {
+		this._checks = [];
+		this._sealed = false;
+	}
+	add(healthCheck) {
+		this._checks.push(healthCheck);
+	}
+	seal() {
+		this._sealed = true;
+	}
+	async check() {
+		if (!this._sealed) return false;
+		return (await Promise.all(this._checks.map((c) => c()))).every((c) => c === true);
+	}
+};
+HealthRegistrar = __decorate([Injectable()], HealthRegistrar);
+//#endregion
 //#region src/helper/sapling.ts
 const _settings = {
 	serialize: JSON.stringify,
 	deserialize: JSON.parse,
+	health: { path: "/up" },
 	doc: {
 		openApiPath: "/openapi.json",
 		swaggerPath: "/swagger.html",
@@ -324,6 +474,7 @@ var Sapling = class Sapling {
 	static registerApp(app) {
 		app.use(e.text({ type: "application/json" }));
 		app.use(Sapling.json());
+		_InjectableRegistry.get(HealthRegistrar)?.seal();
 	}
 	/**
 	* Serialize a value into a JSON string.
@@ -604,6 +755,7 @@ function _getValidatorSchema(ctor, fnName) {
 //#endregion
 //#region src/helper/openapi.ts
 var OpenAPIGenerator = class {
+	OPENAPI_VERSION = "3.0.0";
 	controllers = /* @__PURE__ */ new Set();
 	registerController(controllerClass, prefix) {
 		this.controllers.add({
@@ -611,6 +763,12 @@ var OpenAPIGenerator = class {
 			prefix
 		});
 	}
+	/**
+	* visible for testing
+	*/
+	_clearControllers() {
+		this.controllers.clear();
+	}
 	get metadata() {
 		return _settings.doc.metadata;
 	}
@@ -699,7 +857,7 @@ var OpenAPIGenerator = class {
 			}
 		}
 		return {
-			openapi: "3.0.0",
+			openapi: this.OPENAPI_VERSION,
 			info: {
 				title: metadata.title,
 				version: metadata.version,
@@ -726,6 +884,9 @@ function _registerController(controllerClass, prefix) {
 function generateOpenApiSpec() {
 	return openApiGenerator.generateSpec();
 }
+function _clearOpenApiRegistry() {
+	openApiGenerator._clearControllers();
+}
 //#endregion
 //#region src/types.ts
 const methodResolve = {
@@ -739,126 +900,6 @@ const methodResolve = {
 	USE: "use"
 };
 //#endregion
-//#region lib/weakmap.ts
-/**
-* WeakMap that is iterable.
-*/
-var IterableWeakMap = class IterableWeakMap {
-	#weakMap = /* @__PURE__ */ new WeakMap();
-	#refSet = /* @__PURE__ */ new Set();
-	#finalizationGroup = new FinalizationRegistry(IterableWeakMap.#cleanup);
-	static #cleanup(heldValue) {
-		heldValue.set.delete(heldValue.ref);
-	}
-	constructor(iterable) {
-		if (iterable) for (const [key, value] of iterable) this.set(key, value);
-	}
-	set(key, value) {
-		const ref = new WeakRef(key);
-		this.#weakMap.set(key, {
-			value,
-			ref
-		});
-		this.#refSet.add(ref);
-		this.#finalizationGroup.register(key, {
-			set: this.#refSet,
-			ref
-		}, ref);
-		return this;
-	}
-	get(key) {
-		return this.#weakMap.get(key)?.value;
-	}
-	delete(key) {
-		const entry = this.#weakMap.get(key);
-		if (!entry) return false;
-		this.#weakMap.delete(key);
-		this.#refSet.delete(entry.ref);
-		this.#finalizationGroup.unregister(entry.ref);
-		return true;
-	}
-	*[Symbol.iterator]() {
-		for (const ref of this.#refSet) {
-			const key = ref.deref();
-			if (!key) continue;
-			const entry = this.#weakMap.get(key);
-			if (entry) yield [key, entry.value];
-		}
-	}
-	entries() {
-		return this[Symbol.iterator]();
-	}
-	*keys() {
-		for (const [key] of this) yield key;
-	}
-	*values() {
-		for (const [, value] of this) yield value;
-	}
-	forEach(callback, thisArg) {
-		for (const [key, value] of this) callback.call(thisArg, value, key, this);
-	}
-};
-//#endregion
-//#region src/annotation/injectable.ts
-const _InjectableRegistry = /* @__PURE__ */ new WeakMap();
-const _InjectableDeps = new IterableWeakMap();
-/**
-* Mark the class as an injectable to be handled by Sapling. The class can now be
-* be injected into other classes, as well as allow the class to inject other `@Injectable` classes.
-*
-* @argument deps - An optional array to define any dependencies that this class may require.
-*/
-function Injectable(deps = []) {
-	return function(target) {
-		_InjectableRegistry.set(target, null);
-		_InjectableDeps.set(target, deps);
-	};
-}
-/**
-* Resolves and instantiates a class along with all of it's transitive dependencies.
-*
-* Uses topological sort (Kahn's algorithm) to ensure that the dependency graph is created
-* in a correct order.
-*
-* When `resolve` is first called (usually during controller registration),
-* it will compute the dependency graph of all `@Injectable` classes and instantiates
-* them in the correct order.
-*
-* Subsequent calls to dependencies that have already been resolved are cached, so they will
-* re-use the created singletons instead of re-instantiation.
-*/
-function _resolve(ctor) {
-	const inDegree = /* @__PURE__ */ new Map();
-	const graph = /* @__PURE__ */ new Map();
-	_InjectableDeps.forEach((deps, node) => {
-		inDegree.set(node, inDegree.get(node) || 0);
-		deps.forEach((dep) => {
-			if (dep === void 0) throw new Error(`There is an @Injectable (${node.name}) which has a dependency that cannot be found. This is likely caused by a circular dependency.`);
-			inDegree.set(dep, inDegree.get(dep) || 0);
-			inDegree.set(node, inDegree.get(node) + 1);
-			if (!graph.has(dep)) graph.set(dep, []);
-			graph.get(dep).push(node);
-		});
-	});
-	const queue = [];
-	inDegree.forEach((deg, node) => {
-		if (deg === 0) queue.push(node);
-	});
-	while (queue.length) {
-		const current = queue.shift();
-		if (!_InjectableRegistry.get(current)) {
-			const instance = new current(...(_InjectableDeps.get(current) || []).map((dep) => _InjectableRegistry.get(dep)));
-			_InjectableRegistry.set(current, instance);
-		}
-		(graph.get(current) || []).forEach((neighbor) => {
-			inDegree.set(neighbor, (inDegree.get(neighbor) ?? 0) - 1);
-			if (inDegree.get(neighbor) === 0) queue.push(neighbor);
-		});
-	}
-	if (!_InjectableRegistry.get(ctor)) throw new Error("Circular dependency detected or injectable not registered");
-	return _InjectableRegistry.get(ctor);
-}
-//#endregion
 //#region src/annotation/controller.ts
 const _ControllerRegistry = /* @__PURE__ */ new WeakMap();
 /**
@@ -977,14 +1018,6 @@ function MiddlewareClass(...args) {
 	return Controller(...args);
 }
 //#endregion
-//#region \0@oxc-project+runtime@0.127.0/helpers/decorate.js
-function __decorate(decorators, target, key, desc) {
-	var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-	if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-	else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-	return c > 3 && r && Object.defineProperty(target, key, r), r;
-}
-//#endregion
 //#region src/middleware/default/error/base.ts
 let DefaultBaseErrorMiddleware = class DefaultBaseErrorMiddleware {
 	handle(err, _request, _response, _next) {
@@ -1100,4 +1133,17 @@ const DefaultSwaggerMiddleware = {
 	Setup
 };
 //#endregion
-export { Controller, ControllerSchema, DELETE, DefaultBaseErrorMiddleware, DefaultOpenApiMiddleware, DefaultParserErrorMiddleware, DefaultResponseStatusErrorMiddleware, DefaultSwaggerMiddleware, GET, HEAD, Html404ErrorPage, HttpStatus, Injectable, Middleware, MiddlewareClass, OPTIONS, PATCH, POST, PUT, ParserError, RedirectView, RequestBody, RequestParam, RequestQuery, ResponseBody, ResponseEntity, ResponseEntityBuilder, ResponseStatusError, RouteSchema, Sapling, _ControllerRegistry, _InjectableDeps, _InjectableRegistry, _Route, _getControllerSchema, _getOrCreateSchemaDefinition, _getRouteSchema, _getRoutes, _getValidatorSchema, _parseOrThrow, _registerController, _resolve, _saveValidatorSchema, _setControllerSchema, _setRouteSchema, _settings, generateOpenApiSpec, methodResolve, openApiGenerator };
+//#region src/middleware/default/health/index.ts
+let DefaultHealthMiddleware = class DefaultHealthMiddleware {
+	constructor(healthRegistrar) {
+		this.healthRegistrar = healthRegistrar;
+	}
+	async serve(_request, _response, _next) {
+		const up = await this.healthRegistrar.check();
+		return ResponseEntity.ok().body({ up });
+	}
+};
+__decorate([GET(_settings.health.path)], DefaultHealthMiddleware.prototype, "serve", null);
+DefaultHealthMiddleware = __decorate([MiddlewareClass({ deps: [HealthRegistrar] })], DefaultHealthMiddleware);
+//#endregion
+export { Controller, ControllerSchema, DELETE, DefaultBaseErrorMiddleware, DefaultHealthMiddleware, DefaultOpenApiMiddleware, DefaultParserErrorMiddleware, DefaultResponseStatusErrorMiddleware, DefaultSwaggerMiddleware, GET, HEAD, HealthRegistrar, Html404ErrorPage, HttpStatus, Injectable, Middleware, MiddlewareClass, OPTIONS, PATCH, POST, PUT, ParserError, RedirectView, RequestBody, RequestParam, RequestQuery, ResponseBody, ResponseEntity, ResponseEntityBuilder, ResponseStatusError, RouteSchema, Sapling, _ControllerRegistry, _InjectableDeps, _InjectableRegistry, _Route, _clearOpenApiRegistry, _getControllerSchema, _getOrCreateSchemaDefinition, _getRouteSchema, _getRoutes, _getValidatorSchema, _parseOrThrow, _registerController, _resolve, _saveValidatorSchema, _setControllerSchema, _setRouteSchema, _settings, generateOpenApiSpec, methodResolve, openApiGenerator };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tahminator/sapling",
-  "version": "2.0.5-beta.e0403942",
+  "version": "2.1.0-beta.0e8a97e8",
   "author": "Tahmid Ahmed",
   "description": "A library to help you write cleaner Express.js code",
   "repository": {