@tahminator/sapling 2.1.0-beta.6ea2cd3e → 2.1.0-beta.bcb66b15

package/dist/index.cjs

@@ -406,11 +406,6 @@ let HealthRegistrar = class HealthRegistrar {
 		this._checks = [];
 		this._ready = false;
 	}
-	/**
-	* Add a health check.
-	*
-	* Health checks will be used to determine whether service can service traffic or not (a.k.a `liveness`).
-	*/
 	add(healthCheck) {
 		this._checks.push(healthCheck);
 	}
@@ -432,10 +427,7 @@ HealthRegistrar = __decorate([Injectable()], HealthRegistrar);
 const _settings = {
 	serialize: JSON.stringify,
 	deserialize: JSON.parse,
-	health: {
-		ready: { path: "/up" },
-		live: { path: "/live" }
-	},
+	health: { path: "/up" },
 	doc: {
 		openApiPath: "/openapi.json",
 		swaggerPath: "/swagger.html",
@@ -567,59 +559,37 @@ var Sapling = class Sapling {
 	/**
 	* Modify extra settings
 	*/
-	static Extras = {
+	static Extras = { 
+	/**
+	* Modify default settings applied to OpenAPI & Swagger
+	*/
+swaggerAndOpenApi: {
 		/**
-		* Modify default settings applied to OpenAPI & Swagger
+		* Set base OpenAPI metadata values.
+		*
+		* @default { title: "API", version: "1.0.0" }
 		*/
-		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;
-			}
+		setMetadata(metadata) {
+			_settings.doc.metadata = metadata;
 		},
 		/**
-		* Modify default settings applied to health / readiness / liveness.
+		* change default endpoint that will serve OpenAPI spec.
+		* Swagger will also load this endpoint on load.
+		*
+		* @default `/openapi.json`
 		*/
-		health: {
-			/**
-			* change default endpoint that ready endpoint will be served on.
-			*
-			* @default `/up`
-			*/
-			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;
-			}
+		setOpenApiPath(path) {
+			_settings.doc.openApiPath = path;
+		},
+		/**
+		* change Swagger endpoint.
+		*
+		* @default `/swagger.html`
+		*/
+		setSwaggerPath(path) {
+			_settings.doc.swaggerPath = 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`
@@ -1212,17 +1182,12 @@ let DefaultHealthMiddleware = class DefaultHealthMiddleware {
 	constructor(healthRegistrar) {
 		this.healthRegistrar = healthRegistrar;
 	}
-	async readiness(_request, _response, _next) {
-		const up = await this.healthRegistrar.check();
-		return ResponseEntity.ok().body({ up });
-	}
-	async liveness(_request, _response, _next) {
+	async serve(_request, _response, _next) {
 		const up = await this.healthRegistrar.check();
 		return ResponseEntity.ok().body({ up });
 	}
 };
-__decorate([GET(_settings.health.ready.path)], DefaultHealthMiddleware.prototype, "readiness", null);
-__decorate([GET(_settings.health.live.path)], DefaultHealthMiddleware.prototype, "liveness", null);
+__decorate([GET(_settings.health.path)], DefaultHealthMiddleware.prototype, "serve", null);
 DefaultHealthMiddleware = __decorate([MiddlewareClass({ deps: [HealthRegistrar] })], DefaultHealthMiddleware);
 //#endregion
 exports.Controller = Controller;

package/dist/index.d.cts

@@ -795,12 +795,7 @@ type Settings = {
   serialize: (value: any) => string;
   deserialize: (value: string) => any;
   health: {
-    ready: {
-      path: string;
-    };
-    live: {
-      path: string;
-    };
+    path: string;
   };
   doc: {
     openApiPath: string;
@@ -910,23 +905,6 @@ 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 `/up`
-       */
-      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
@@ -1120,11 +1098,6 @@ declare class HealthRegistrar {
   private _checks;
   private _ready;
   constructor();
-  /**
-   * Add a health check.
-   *
-   * Health checks will be used to determine whether service can service traffic or not (a.k.a `liveness`).
-   */
   add(healthCheck: HealthCheck): void;
   /**
    * @internal used by Sapling library, used to determine once all
@@ -1135,19 +1108,10 @@ declare class HealthRegistrar {
 }
 //#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);
-  readiness(_request: Request, _response: Response, _next: NextFunction): Promise<ResponseEntity<{
-    up: boolean;
-  }>>;
-  liveness(_request: Request, _response: Response, _next: NextFunction): Promise<ResponseEntity<{
+  serve(_request: Request, _response: Response, _next: NextFunction): Promise<ResponseEntity<{
     up: boolean;
   }>>;
 }

package/dist/index.d.mts

@@ -795,12 +795,7 @@ type Settings = {
   serialize: (value: any) => string;
   deserialize: (value: string) => any;
   health: {
-    ready: {
-      path: string;
-    };
-    live: {
-      path: string;
-    };
+    path: string;
   };
   doc: {
     openApiPath: string;
@@ -910,23 +905,6 @@ 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 `/up`
-       */
-      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
@@ -1120,11 +1098,6 @@ declare class HealthRegistrar {
   private _checks;
   private _ready;
   constructor();
-  /**
-   * Add a health check.
-   *
-   * Health checks will be used to determine whether service can service traffic or not (a.k.a `liveness`).
-   */
   add(healthCheck: HealthCheck): void;
   /**
    * @internal used by Sapling library, used to determine once all
@@ -1135,19 +1108,10 @@ declare class HealthRegistrar {
 }
 //#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);
-  readiness(_request: Request, _response: Response, _next: NextFunction): Promise<ResponseEntity<{
-    up: boolean;
-  }>>;
-  liveness(_request: Request, _response: Response, _next: NextFunction): Promise<ResponseEntity<{
+  serve(_request: Request, _response: Response, _next: NextFunction): Promise<ResponseEntity<{
     up: boolean;
   }>>;
 }

package/dist/index.mjs

@@ -381,11 +381,6 @@ let HealthRegistrar = class HealthRegistrar {
 		this._checks = [];
 		this._ready = false;
 	}
-	/**
-	* Add a health check.
-	*
-	* Health checks will be used to determine whether service can service traffic or not (a.k.a `liveness`).
-	*/
 	add(healthCheck) {
 		this._checks.push(healthCheck);
 	}
@@ -407,10 +402,7 @@ HealthRegistrar = __decorate([Injectable()], HealthRegistrar);
 const _settings = {
 	serialize: JSON.stringify,
 	deserialize: JSON.parse,
-	health: {
-		ready: { path: "/up" },
-		live: { path: "/live" }
-	},
+	health: { path: "/up" },
 	doc: {
 		openApiPath: "/openapi.json",
 		swaggerPath: "/swagger.html",
@@ -542,59 +534,37 @@ var Sapling = class Sapling {
 	/**
 	* Modify extra settings
 	*/
-	static Extras = {
+	static Extras = { 
+	/**
+	* Modify default settings applied to OpenAPI & Swagger
+	*/
+swaggerAndOpenApi: {
 		/**
-		* Modify default settings applied to OpenAPI & Swagger
+		* Set base OpenAPI metadata values.
+		*
+		* @default { title: "API", version: "1.0.0" }
 		*/
-		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;
-			}
+		setMetadata(metadata) {
+			_settings.doc.metadata = metadata;
 		},
 		/**
-		* Modify default settings applied to health / readiness / liveness.
+		* change default endpoint that will serve OpenAPI spec.
+		* Swagger will also load this endpoint on load.
+		*
+		* @default `/openapi.json`
 		*/
-		health: {
-			/**
-			* change default endpoint that ready endpoint will be served on.
-			*
-			* @default `/up`
-			*/
-			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;
-			}
+		setOpenApiPath(path) {
+			_settings.doc.openApiPath = path;
+		},
+		/**
+		* change Swagger endpoint.
+		*
+		* @default `/swagger.html`
+		*/
+		setSwaggerPath(path) {
+			_settings.doc.swaggerPath = 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`
@@ -1187,17 +1157,12 @@ let DefaultHealthMiddleware = class DefaultHealthMiddleware {
 	constructor(healthRegistrar) {
 		this.healthRegistrar = healthRegistrar;
 	}
-	async readiness(_request, _response, _next) {
-		const up = await this.healthRegistrar.check();
-		return ResponseEntity.ok().body({ up });
-	}
-	async liveness(_request, _response, _next) {
+	async serve(_request, _response, _next) {
 		const up = await this.healthRegistrar.check();
 		return ResponseEntity.ok().body({ up });
 	}
 };
-__decorate([GET(_settings.health.ready.path)], DefaultHealthMiddleware.prototype, "readiness", null);
-__decorate([GET(_settings.health.live.path)], DefaultHealthMiddleware.prototype, "liveness", null);
+__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.1.0-beta.6ea2cd3e",
+  "version": "2.1.0-beta.bcb66b15",
   "author": "Tahmid Ahmed",
   "description": "A library to help you write cleaner Express.js code",
   "repository": {