@tahminator/sapling 2.1.0-beta.a2de2fb9 → 2.1.0-beta.d7a333d9

package/dist/index.cjs

@@ -401,22 +401,28 @@ function __decorate(decorators, target, key, desc) {
 //#region src/middleware/health/registrar.ts
 let HealthRegistrar = class HealthRegistrar {
 	_checks;
-	_sealed;
+	_ready;
 	constructor() {
 		this._checks = [];
-		this._sealed = false;
+		this._ready = false;
 	}
+	/**
+	* Add a health check.
+	*
+	* Health checks will be used to determine whether service can serve traffic or not (a.k.a `liveness`).
+	*/
 	add(healthCheck) {
 		this._checks.push(healthCheck);
 	}
 	/**
-	* @internal used by Sapling library
+	* @internal used by Sapling library, used to determine once all
+	* checks have been registered and server is, at the very least, alive.
 	*/
-	_seal() {
-		this._sealed = true;
+	_markReady() {
+		this._ready = true;
 	}
 	async check() {
-		if (!this._sealed) return false;
+		if (!this._ready) return false;
 		return (await Promise.all(this._checks.map((c) => c()))).every((c) => c === true);
 	}
 };
@@ -426,7 +432,10 @@ HealthRegistrar = __decorate([Injectable()], HealthRegistrar);
 const _settings = {
 	serialize: JSON.stringify,
 	deserialize: JSON.parse,
-	health: { path: "/up" },
+	health: {
+		ready: { path: "/ready" },
+		live: { path: "/live" }
+	},
 	doc: {
 		openApiPath: "/openapi.json",
 		swaggerPath: "/swagger.html",
@@ -494,9 +503,8 @@ var Sapling = class Sapling {
 	* import { Sapling } from "@tahminator/sapling";
 	* import express from "express";
 	*
-	* const app = express();
-	*
-	* app.registerApp(app);
+	* // returns the exact same `express.App` type back to you!
+	* const app = Sapling.registerApp(express());
 	* ```
 	*/
 	static registerApp(app) {
@@ -508,7 +516,7 @@ var Sapling = class Sapling {
 				return function(...args) {
 					const server = originalListen.apply(target, args);
 					server.once("listening", () => {
-						Sapling.onStartup();
+						Sapling.onPostStartup();
 						console.log("Sapling successfully initialized post-startup hooks on server start");
 					});
 					return server;
@@ -517,8 +525,8 @@ var Sapling = class Sapling {
 			return Reflect.get(target, prop, receiver);
 		} });
 	}
-	static onStartup() {
-		_InjectableRegistry.get(HealthRegistrar)?.seal();
+	static onPostStartup() {
+		_InjectableRegistry.get(HealthRegistrar)?._markReady();
 	}
 	/**
 	* Serialize a value into a JSON string.
@@ -559,37 +567,59 @@ var Sapling = class Sapling {
 	/**
 	* Modify extra settings
 	*/
-	static Extras = { 
-	/**
-	* Modify default settings applied to OpenAPI & Swagger
-	*/
-swaggerAndOpenApi: {
-		/**
-		* Set base OpenAPI metadata values.
-		*
-		* @default { title: "API", version: "1.0.0" }
-		*/
-		setMetadata(metadata) {
-			_settings.doc.metadata = metadata;
-		},
+	static Extras = {
 		/**
-		* change default endpoint that will serve OpenAPI spec.
-		* Swagger will also load this endpoint on load.
-		*
-		* @default `/openapi.json`
+		* Modify default settings applied to OpenAPI & Swagger
 		*/
-		setOpenApiPath(path) {
-			_settings.doc.openApiPath = path;
+		swaggerAndOpenApi: {
+			/**
+			* Set base OpenAPI metadata values.
+			*
+			* @default { title: "API", version: "1.0.0" }
+			*/
+			setMetadata(metadata) {
+				_settings.doc.metadata = metadata;
+			},
+			/**
+			* change default endpoint that will serve OpenAPI spec.
+			* Swagger will also load this endpoint on load.
+			*
+			* @default `/openapi.json`
+			*/
+			setOpenApiPath(path) {
+				_settings.doc.openApiPath = path;
+			},
+			/**
+			* change Swagger endpoint.
+			*
+			* @default `/swagger.html`
+			*/
+			setSwaggerPath(path) {
+				_settings.doc.swaggerPath = path;
+			}
 		},
 		/**
-		* change Swagger endpoint.
-		*
-		* @default `/swagger.html`
+		* Modify default settings applied to health / readiness / liveness.
 		*/
-		setSwaggerPath(path) {
-			_settings.doc.swaggerPath = path;
+		health: {
+			/**
+			* change default endpoint that ready endpoint will be served on.
+			*
+			* @default `/ready`
+			*/
+			setReadyPath(path) {
+				_settings.health.ready.path = path;
+			},
+			/**
+			* change default endpoint that live endpoint will be served on.
+			*
+			* @default `/live`
+			*/
+			setLivePath(path) {
+				_settings.health.live.path = path;
+			}
 		}
-	} };
+	};
 	/**
 	* This method can be used in a `@MiddlewareClass` to register any libraries
 	* that expect you to register multiple registers at once. An example is `swagger-ui-express`
@@ -1182,12 +1212,17 @@ let DefaultHealthMiddleware = class DefaultHealthMiddleware {
 	constructor(healthRegistrar) {
 		this.healthRegistrar = healthRegistrar;
 	}
-	async serve(_request, _response, _next) {
+	async readiness(_request, _response, _next) {
+		const up = await this.healthRegistrar.check();
+		return ResponseEntity.ok().body({ up });
+	}
+	async liveness(_request, _response, _next) {
 		const up = await this.healthRegistrar.check();
 		return ResponseEntity.ok().body({ up });
 	}
 };
-__decorate([GET(_settings.health.path)], DefaultHealthMiddleware.prototype, "serve", null);
+__decorate([GET(_settings.health.ready.path)], DefaultHealthMiddleware.prototype, "readiness", null);
+__decorate([GET(_settings.health.live.path)], DefaultHealthMiddleware.prototype, "liveness", null);
 DefaultHealthMiddleware = __decorate([MiddlewareClass({ deps: [HealthRegistrar] })], DefaultHealthMiddleware);
 //#endregion
 exports.Controller = Controller;

package/dist/index.d.cts

@@ -795,7 +795,12 @@ type Settings = {
   serialize: (value: any) => string;
   deserialize: (value: string) => any;
   health: {
-    path: string;
+    ready: {
+      path: string;
+    };
+    live: {
+      path: string;
+    };
   };
   doc: {
     openApiPath: string;
@@ -843,13 +848,12 @@ declare class Sapling {
    * import { Sapling } from "@tahminator/sapling";
    * import express from "express";
    *
-   * const app = express();
-   *
-   * app.registerApp(app);
+   * // returns the exact same `express.App` type back to you!
+   * const app = Sapling.registerApp(express());
    * ```
    */
   static registerApp(app: e.Express): e.Express;
-  static onStartup(): void;
+  static onPostStartup(): void;
   /**
    * Serialize a value into a JSON string.
    *
@@ -906,6 +910,23 @@ declare class Sapling {
        */
       setSwaggerPath(this: void, path: string): void;
     };
+    /**
+     * Modify default settings applied to health / readiness / liveness.
+     */
+    health: {
+      /**
+       * change default endpoint that ready endpoint will be served on.
+       *
+       * @default `/ready`
+       */
+      setReadyPath(this: void, path: string): void;
+      /**
+       * change default endpoint that live endpoint will be served on.
+       *
+       * @default `/live`
+       */
+      setLivePath(this: void, path: string): void;
+    };
   };
   /**
    * This method can be used in a `@MiddlewareClass` to register any libraries
@@ -1097,21 +1118,36 @@ declare const DefaultSwaggerMiddleware: {
 type HealthCheck = () => boolean | Promise<boolean>;
 declare class HealthRegistrar {
   private _checks;
-  private _sealed;
+  private _ready;
   constructor();
+  /**
+   * Add a health check.
+   *
+   * Health checks will be used to determine whether service can serve traffic or not (a.k.a `liveness`).
+   */
   add(healthCheck: HealthCheck): void;
   /**
-   * @internal used by Sapling library
+   * @internal used by Sapling library, used to determine once all
+   * checks have been registered and server is, at the very least, alive.
    */
-  _seal(): void;
+  _markReady(): void;
   check(): Promise<boolean>;
 }
 //#endregion
 //#region src/middleware/default/health/index.d.ts
+/**
+ * Enable the serving of `ready` and `live` endpoints.
+ *
+ * Configure any middleware-specific settings with `Sapling.Extras.health`
+ * ```
+ */
 declare class DefaultHealthMiddleware {
   private readonly healthRegistrar;
   constructor(healthRegistrar: HealthRegistrar);
-  serve(_request: Request, _response: Response, _next: NextFunction): Promise<ResponseEntity<{
+  readiness(_request: Request, _response: Response, _next: NextFunction): Promise<ResponseEntity<{
+    up: boolean;
+  }>>;
+  liveness(_request: Request, _response: Response, _next: NextFunction): Promise<ResponseEntity<{
     up: boolean;
   }>>;
 }

package/dist/index.d.mts

@@ -795,7 +795,12 @@ type Settings = {
   serialize: (value: any) => string;
   deserialize: (value: string) => any;
   health: {
-    path: string;
+    ready: {
+      path: string;
+    };
+    live: {
+      path: string;
+    };
   };
   doc: {
     openApiPath: string;
@@ -843,13 +848,12 @@ declare class Sapling {
    * import { Sapling } from "@tahminator/sapling";
    * import express from "express";
    *
-   * const app = express();
-   *
-   * app.registerApp(app);
+   * // returns the exact same `express.App` type back to you!
+   * const app = Sapling.registerApp(express());
    * ```
    */
   static registerApp(app: e.Express): e.Express;
-  static onStartup(): void;
+  static onPostStartup(): void;
   /**
    * Serialize a value into a JSON string.
    *
@@ -906,6 +910,23 @@ declare class Sapling {
        */
       setSwaggerPath(this: void, path: string): void;
     };
+    /**
+     * Modify default settings applied to health / readiness / liveness.
+     */
+    health: {
+      /**
+       * change default endpoint that ready endpoint will be served on.
+       *
+       * @default `/ready`
+       */
+      setReadyPath(this: void, path: string): void;
+      /**
+       * change default endpoint that live endpoint will be served on.
+       *
+       * @default `/live`
+       */
+      setLivePath(this: void, path: string): void;
+    };
   };
   /**
    * This method can be used in a `@MiddlewareClass` to register any libraries
@@ -1097,21 +1118,36 @@ declare const DefaultSwaggerMiddleware: {
 type HealthCheck = () => boolean | Promise<boolean>;
 declare class HealthRegistrar {
   private _checks;
-  private _sealed;
+  private _ready;
   constructor();
+  /**
+   * Add a health check.
+   *
+   * Health checks will be used to determine whether service can serve traffic or not (a.k.a `liveness`).
+   */
   add(healthCheck: HealthCheck): void;
   /**
-   * @internal used by Sapling library
+   * @internal used by Sapling library, used to determine once all
+   * checks have been registered and server is, at the very least, alive.
    */
-  _seal(): void;
+  _markReady(): void;
   check(): Promise<boolean>;
 }
 //#endregion
 //#region src/middleware/default/health/index.d.ts
+/**
+ * Enable the serving of `ready` and `live` endpoints.
+ *
+ * Configure any middleware-specific settings with `Sapling.Extras.health`
+ * ```
+ */
 declare class DefaultHealthMiddleware {
   private readonly healthRegistrar;
   constructor(healthRegistrar: HealthRegistrar);
-  serve(_request: Request, _response: Response, _next: NextFunction): Promise<ResponseEntity<{
+  readiness(_request: Request, _response: Response, _next: NextFunction): Promise<ResponseEntity<{
+    up: boolean;
+  }>>;
+  liveness(_request: Request, _response: Response, _next: NextFunction): Promise<ResponseEntity<{
     up: boolean;
   }>>;
 }

package/dist/index.mjs

@@ -376,22 +376,28 @@ function __decorate(decorators, target, key, desc) {
 //#region src/middleware/health/registrar.ts
 let HealthRegistrar = class HealthRegistrar {
 	_checks;
-	_sealed;
+	_ready;
 	constructor() {
 		this._checks = [];
-		this._sealed = false;
+		this._ready = false;
 	}
+	/**
+	* Add a health check.
+	*
+	* Health checks will be used to determine whether service can serve traffic or not (a.k.a `liveness`).
+	*/
 	add(healthCheck) {
 		this._checks.push(healthCheck);
 	}
 	/**
-	* @internal used by Sapling library
+	* @internal used by Sapling library, used to determine once all
+	* checks have been registered and server is, at the very least, alive.
 	*/
-	_seal() {
-		this._sealed = true;
+	_markReady() {
+		this._ready = true;
 	}
 	async check() {
-		if (!this._sealed) return false;
+		if (!this._ready) return false;
 		return (await Promise.all(this._checks.map((c) => c()))).every((c) => c === true);
 	}
 };
@@ -401,7 +407,10 @@ HealthRegistrar = __decorate([Injectable()], HealthRegistrar);
 const _settings = {
 	serialize: JSON.stringify,
 	deserialize: JSON.parse,
-	health: { path: "/up" },
+	health: {
+		ready: { path: "/ready" },
+		live: { path: "/live" }
+	},
 	doc: {
 		openApiPath: "/openapi.json",
 		swaggerPath: "/swagger.html",
@@ -469,9 +478,8 @@ var Sapling = class Sapling {
 	* import { Sapling } from "@tahminator/sapling";
 	* import express from "express";
 	*
-	* const app = express();
-	*
-	* app.registerApp(app);
+	* // returns the exact same `express.App` type back to you!
+	* const app = Sapling.registerApp(express());
 	* ```
 	*/
 	static registerApp(app) {
@@ -483,7 +491,7 @@ var Sapling = class Sapling {
 				return function(...args) {
 					const server = originalListen.apply(target, args);
 					server.once("listening", () => {
-						Sapling.onStartup();
+						Sapling.onPostStartup();
 						console.log("Sapling successfully initialized post-startup hooks on server start");
 					});
 					return server;
@@ -492,8 +500,8 @@ var Sapling = class Sapling {
 			return Reflect.get(target, prop, receiver);
 		} });
 	}
-	static onStartup() {
-		_InjectableRegistry.get(HealthRegistrar)?.seal();
+	static onPostStartup() {
+		_InjectableRegistry.get(HealthRegistrar)?._markReady();
 	}
 	/**
 	* Serialize a value into a JSON string.
@@ -534,37 +542,59 @@ var Sapling = class Sapling {
 	/**
 	* Modify extra settings
 	*/
-	static Extras = { 
-	/**
-	* Modify default settings applied to OpenAPI & Swagger
-	*/
-swaggerAndOpenApi: {
-		/**
-		* Set base OpenAPI metadata values.
-		*
-		* @default { title: "API", version: "1.0.0" }
-		*/
-		setMetadata(metadata) {
-			_settings.doc.metadata = metadata;
-		},
+	static Extras = {
 		/**
-		* change default endpoint that will serve OpenAPI spec.
-		* Swagger will also load this endpoint on load.
-		*
-		* @default `/openapi.json`
+		* Modify default settings applied to OpenAPI & Swagger
 		*/
-		setOpenApiPath(path) {
-			_settings.doc.openApiPath = path;
+		swaggerAndOpenApi: {
+			/**
+			* Set base OpenAPI metadata values.
+			*
+			* @default { title: "API", version: "1.0.0" }
+			*/
+			setMetadata(metadata) {
+				_settings.doc.metadata = metadata;
+			},
+			/**
+			* change default endpoint that will serve OpenAPI spec.
+			* Swagger will also load this endpoint on load.
+			*
+			* @default `/openapi.json`
+			*/
+			setOpenApiPath(path) {
+				_settings.doc.openApiPath = path;
+			},
+			/**
+			* change Swagger endpoint.
+			*
+			* @default `/swagger.html`
+			*/
+			setSwaggerPath(path) {
+				_settings.doc.swaggerPath = path;
+			}
 		},
 		/**
-		* change Swagger endpoint.
-		*
-		* @default `/swagger.html`
+		* Modify default settings applied to health / readiness / liveness.
 		*/
-		setSwaggerPath(path) {
-			_settings.doc.swaggerPath = path;
+		health: {
+			/**
+			* change default endpoint that ready endpoint will be served on.
+			*
+			* @default `/ready`
+			*/
+			setReadyPath(path) {
+				_settings.health.ready.path = path;
+			},
+			/**
+			* change default endpoint that live endpoint will be served on.
+			*
+			* @default `/live`
+			*/
+			setLivePath(path) {
+				_settings.health.live.path = path;
+			}
 		}
-	} };
+	};
 	/**
 	* This method can be used in a `@MiddlewareClass` to register any libraries
 	* that expect you to register multiple registers at once. An example is `swagger-ui-express`
@@ -1157,12 +1187,17 @@ let DefaultHealthMiddleware = class DefaultHealthMiddleware {
 	constructor(healthRegistrar) {
 		this.healthRegistrar = healthRegistrar;
 	}
-	async serve(_request, _response, _next) {
+	async readiness(_request, _response, _next) {
+		const up = await this.healthRegistrar.check();
+		return ResponseEntity.ok().body({ up });
+	}
+	async liveness(_request, _response, _next) {
 		const up = await this.healthRegistrar.check();
 		return ResponseEntity.ok().body({ up });
 	}
 };
-__decorate([GET(_settings.health.path)], DefaultHealthMiddleware.prototype, "serve", null);
+__decorate([GET(_settings.health.ready.path)], DefaultHealthMiddleware.prototype, "readiness", null);
+__decorate([GET(_settings.health.live.path)], DefaultHealthMiddleware.prototype, "liveness", 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.1.0-beta.a2de2fb9",
+  "version": "2.1.0-beta.d7a333d9",
   "author": "Tahmid Ahmed",
   "description": "A library to help you write cleaner Express.js code",
   "repository": {