@tahminator/sapling 1.5.28-beta.583b1882 → 1.5.28-beta.7e624925

package/dist/index.cjs

@@ -221,6 +221,22 @@ var ResponseEntityBuilder = class {
 	}
 };
 //#endregion
+//#region src/helper/error/responsestatus.ts
+/**
+* Ensure that you define a middleware that can handle this error.
+*
+* @see {@link Sapling.loadResponseStatusErrorMiddleware}
+*/
+var ResponseStatusError = class ResponseStatusError extends Error {
+	constructor(status, message) {
+		super(message ?? "Something went wrong.");
+		this.status = status;
+		Object.setPrototypeOf(this, new.target.prototype);
+		this.name = `HttpError(${HttpStatus[status]})`;
+		if (Error.captureStackTrace) Error.captureStackTrace(this, ResponseStatusError);
+	}
+};
+//#endregion
 //#region src/helper/sapling.ts
 const settings = {
 	serialize: JSON.stringify,
@@ -359,22 +375,6 @@ var Sapling = class Sapling {
 	}
 };
 //#endregion
-//#region src/helper/error.ts
-/**
-* Ensure that you define a middleware that can handle this error.
-*
-* @see {@link Sapling.loadResponseStatusErrorMiddleware}
-*/
-var ResponseStatusError = class ResponseStatusError extends Error {
-	constructor(status, message) {
-		super(message ?? "Something went wrong.");
-		this.status = status;
-		Object.setPrototypeOf(this, new.target.prototype);
-		this.name = `HttpError(${HttpStatus[status]})`;
-		if (Error.captureStackTrace) Error.captureStackTrace(this, ResponseStatusError);
-	}
-};
-//#endregion
 //#region src/types.ts
 const methodResolve = {
 	GET: "get",
@@ -507,14 +507,40 @@ function _resolve(ctor) {
 	return _InjectableRegistry.get(ctor);
 }
 //#endregion
+//#region src/helper/error/exception.ts
+/**
+* This error should be thrown when some data cannot be parsed by a given schema.
+*/
+var ParserError = class ParserError extends ResponseStatusError {
+	constructor(location, issues, vendor) {
+		super(400, ParserError.formatMessage(location, issues, vendor));
+		Object.setPrototypeOf(this, new.target.prototype);
+	}
+	static formatMessage(location, issues, vendor) {
+		const formatted = issues.map((i) => {
+			const path = Array.isArray(i.path) ? i.path.map((seg) => typeof seg === "object" && seg ? String(seg.key) : String(seg)).join(".") : "";
+			return path ? `${path}: ${i.message}` : i.message;
+		}).join("; ");
+		return `${vendor} failed to parse ${(() => {
+			switch (location) {
+				case "reqbody": return "request body";
+				case "reqparams": return "request params";
+				case "reqquery": return "request query";
+			}
+		})()}: ${formatted}`;
+	}
+};
+//#endregion
 //#region src/annotation/request.ts
 const _requestSchemaStore = /* @__PURE__ */ new WeakMap();
-function _getOrCreateDef(ctor, fnName) {
-	let byFn = _requestSchemaStore.get(ctor);
-	if (!byFn) {
-		byFn = /* @__PURE__ */ new Map();
-		_requestSchemaStore.set(ctor, byFn);
-	}
+function _getOrCreateRequestSchemaDefinition(ctor, fnName) {
+	const byFn = (() => {
+		const fn = _requestSchemaStore.get(ctor);
+		if (fn) return fn;
+		const newFn = /* @__PURE__ */ new Map();
+		_requestSchemaStore.set(ctor, newFn);
+		return newFn;
+	})();
 	const existing = byFn.get(fnName);
 	if (existing) return existing;
 	const created = {};
@@ -529,36 +555,30 @@ function RequestBody(schema) {
 	return (target, propertyKey) => {
 		const ctor = target.constructor;
 		const fnName = String(propertyKey);
-		_setOnce(_getOrCreateDef(ctor, fnName), "body", schema, fnName);
+		_setOnce(_getOrCreateRequestSchemaDefinition(ctor, fnName), "body", schema, fnName);
 	};
 }
 function RequestParam(schema) {
 	return (target, propertyKey) => {
 		const ctor = target.constructor;
 		const fnName = String(propertyKey);
-		_setOnce(_getOrCreateDef(ctor, fnName), "param", schema, fnName);
+		_setOnce(_getOrCreateRequestSchemaDefinition(ctor, fnName), "param", schema, fnName);
 	};
 }
 function RequestQuery(schema) {
 	return (target, propertyKey) => {
 		const ctor = target.constructor;
 		const fnName = String(propertyKey);
-		_setOnce(_getOrCreateDef(ctor, fnName), "query", schema, fnName);
+		_setOnce(_getOrCreateRequestSchemaDefinition(ctor, fnName), "query", schema, fnName);
 	};
 }
 function _getRequestSchemas(ctor, fnName) {
 	return _requestSchemaStore.get(ctor)?.get(fnName);
 }
-function _formatIssues(issues) {
-	return issues.map((i) => {
-		const path = Array.isArray(i.path) ? i.path.map((seg) => typeof seg === "object" && seg ? String(seg.key) : String(seg)).join(".") : "";
-		return path ? `${path}: ${i.message}` : i.message;
-	}).join("; ");
-}
 async function _parseOrThrow(schema, input, kind) {
 	const result = await schema["~standard"].validate(input);
-	if (!result.issues) return result.value;
-	throw new ResponseStatusError(400, `${kind === "body" ? "Invalid request body" : kind === "params" ? "Invalid request params" : "Invalid request query"}: ${_formatIssues(result.issues)}`);
+	if (result.issues) throw new ParserError(kind, result.issues, schema["~standard"].vendor);
+	return result.value;
 }
 //#endregion
 //#region src/annotation/route.ts
@@ -669,9 +689,9 @@ function Controller({ prefix = "", deps = [] } = {}) {
 			router[methodName](fp, async (request, response, next) => {
 				const schemas = _getRequestSchemas(target, fnName);
 				if (schemas) {
-					if (schemas.body) request.body = await _parseOrThrow(schemas.body, request.body, "body");
-					if (schemas.param) request.params = await _parseOrThrow(schemas.param, request.params, "params");
-					if (schemas.query) request.query = await _parseOrThrow(schemas.query, request.query, "query");
+					if (schemas.body) request.body = await _parseOrThrow(schemas.body, request.body, "reqbody");
+					if (schemas.param) request.params = await _parseOrThrow(schemas.param, request.params, "reqparams");
+					if (schemas.query) request.query = await _parseOrThrow(schemas.query, request.query, "reqquery");
 				}
 				const result = await fn.bind(controllerInstance)(request, response, next);
 				if (method === "USE") return;
@@ -715,6 +735,7 @@ exports.OPTIONS = OPTIONS;
 exports.PATCH = PATCH;
 exports.POST = POST;
 exports.PUT = PUT;
+exports.ParserError = ParserError;
 exports.RedirectView = RedirectView;
 exports.RequestBody = RequestBody;
 exports.RequestParam = RequestParam;

package/dist/index.d.cts

@@ -231,18 +231,6 @@ declare namespace StandardSchemaV1 {
 }
 /** The Standard JSON Schema interface. */
 //#endregion
-//#region src/annotation/request.d.ts
-type RequestSchemaDefinition = {
-  body?: StandardSchemaV1;
-  param?: StandardSchemaV1;
-  query?: StandardSchemaV1;
-};
-declare function RequestBody(schema: StandardSchemaV1): MethodDecorator;
-declare function RequestParam(schema: StandardSchemaV1): MethodDecorator;
-declare function RequestQuery(schema: StandardSchemaV1): MethodDecorator;
-declare function _getRequestSchemas(ctor: Function, fnName: string): RequestSchemaDefinition | undefined;
-declare function _parseOrThrow<TSchema extends StandardSchemaV1>(schema: TSchema, input: unknown, kind: "body" | "params" | "query"): Promise<StandardSchemaV1.InferOutput<TSchema>>;
-//#endregion
 //#region src/helper/redirect.d.ts
 /**
  * Generic HTTP redirect wrapped modeled after Spring's `RedirectView`.
@@ -398,7 +386,7 @@ declare enum HttpStatus {
   NETWORK_AUTHENTICATION_REQUIRED = 511
 }
 //#endregion
-//#region src/helper/error.d.ts
+//#region src/helper/error/responsestatus.d.ts
 /**
  * Ensure that you define a middleware that can handle this error.
  *
@@ -508,4 +496,26 @@ declare class Sapling {
   static setDeserializeFn(this: void, fn: (value: string) => any): void;
 }
 //#endregion
-export { Class, Controller, DELETE, ExpressMiddlewareFn, ExpressRouterMethodKey, ExpressRouterMethods, GET, HEAD, Html404ErrorPage, HttpHeaders, HttpStatus, Injectable, Middleware, MiddlewareClass, OPTIONS, PATCH, POST, PUT, RedirectView, RequestBody, RequestParam, RequestQuery, ResponseEntity, ResponseEntityBuilder, ResponseStatusError, RouteDefinition, Sapling, _ControllerRegistry, _InjectableDeps, _InjectableRegistry, _Route, _getRequestSchemas, _getRoutes, _parseOrThrow, _resolve, methodResolve };
+//#region src/helper/error/exception.d.ts
+type ParserErrorLocation = "reqbody" | "reqparams" | "reqquery";
+/**
+ * This error should be thrown when some data cannot be parsed by a given schema.
+ */
+declare class ParserError extends ResponseStatusError {
+  constructor(location: ParserErrorLocation, issues: readonly StandardSchemaV1.Issue[], vendor: string);
+  private static formatMessage;
+}
+//#endregion
+//#region src/annotation/request.d.ts
+type RequestSchemaDefinition = {
+  body?: StandardSchemaV1;
+  param?: StandardSchemaV1;
+  query?: StandardSchemaV1;
+};
+declare function RequestBody(schema: StandardSchemaV1): MethodDecorator;
+declare function RequestParam(schema: StandardSchemaV1): MethodDecorator;
+declare function RequestQuery(schema: StandardSchemaV1): MethodDecorator;
+declare function _getRequestSchemas(ctor: Function, fnName: string): RequestSchemaDefinition | undefined;
+declare function _parseOrThrow<TSchema extends StandardSchemaV1>(schema: TSchema, input: unknown, kind: ParserErrorLocation): Promise<StandardSchemaV1.InferOutput<TSchema>>;
+//#endregion
+export { Class, Controller, DELETE, ExpressMiddlewareFn, ExpressRouterMethodKey, ExpressRouterMethods, GET, HEAD, Html404ErrorPage, HttpHeaders, HttpStatus, Injectable, Middleware, MiddlewareClass, OPTIONS, PATCH, POST, PUT, ParserError, ParserErrorLocation, RedirectView, RequestBody, RequestParam, RequestQuery, ResponseEntity, ResponseEntityBuilder, ResponseStatusError, RouteDefinition, Sapling, _ControllerRegistry, _InjectableDeps, _InjectableRegistry, _Route, _getRequestSchemas, _getRoutes, _parseOrThrow, _resolve, methodResolve };

package/dist/index.d.mts

@@ -231,18 +231,6 @@ declare namespace StandardSchemaV1 {
 }
 /** The Standard JSON Schema interface. */
 //#endregion
-//#region src/annotation/request.d.ts
-type RequestSchemaDefinition = {
-  body?: StandardSchemaV1;
-  param?: StandardSchemaV1;
-  query?: StandardSchemaV1;
-};
-declare function RequestBody(schema: StandardSchemaV1): MethodDecorator;
-declare function RequestParam(schema: StandardSchemaV1): MethodDecorator;
-declare function RequestQuery(schema: StandardSchemaV1): MethodDecorator;
-declare function _getRequestSchemas(ctor: Function, fnName: string): RequestSchemaDefinition | undefined;
-declare function _parseOrThrow<TSchema extends StandardSchemaV1>(schema: TSchema, input: unknown, kind: "body" | "params" | "query"): Promise<StandardSchemaV1.InferOutput<TSchema>>;
-//#endregion
 //#region src/helper/redirect.d.ts
 /**
  * Generic HTTP redirect wrapped modeled after Spring's `RedirectView`.
@@ -398,7 +386,7 @@ declare enum HttpStatus {
   NETWORK_AUTHENTICATION_REQUIRED = 511
 }
 //#endregion
-//#region src/helper/error.d.ts
+//#region src/helper/error/responsestatus.d.ts
 /**
  * Ensure that you define a middleware that can handle this error.
  *
@@ -508,4 +496,26 @@ declare class Sapling {
   static setDeserializeFn(this: void, fn: (value: string) => any): void;
 }
 //#endregion
-export { Class, Controller, DELETE, ExpressMiddlewareFn, ExpressRouterMethodKey, ExpressRouterMethods, GET, HEAD, Html404ErrorPage, HttpHeaders, HttpStatus, Injectable, Middleware, MiddlewareClass, OPTIONS, PATCH, POST, PUT, RedirectView, RequestBody, RequestParam, RequestQuery, ResponseEntity, ResponseEntityBuilder, ResponseStatusError, RouteDefinition, Sapling, _ControllerRegistry, _InjectableDeps, _InjectableRegistry, _Route, _getRequestSchemas, _getRoutes, _parseOrThrow, _resolve, methodResolve };
+//#region src/helper/error/exception.d.ts
+type ParserErrorLocation = "reqbody" | "reqparams" | "reqquery";
+/**
+ * This error should be thrown when some data cannot be parsed by a given schema.
+ */
+declare class ParserError extends ResponseStatusError {
+  constructor(location: ParserErrorLocation, issues: readonly StandardSchemaV1.Issue[], vendor: string);
+  private static formatMessage;
+}
+//#endregion
+//#region src/annotation/request.d.ts
+type RequestSchemaDefinition = {
+  body?: StandardSchemaV1;
+  param?: StandardSchemaV1;
+  query?: StandardSchemaV1;
+};
+declare function RequestBody(schema: StandardSchemaV1): MethodDecorator;
+declare function RequestParam(schema: StandardSchemaV1): MethodDecorator;
+declare function RequestQuery(schema: StandardSchemaV1): MethodDecorator;
+declare function _getRequestSchemas(ctor: Function, fnName: string): RequestSchemaDefinition | undefined;
+declare function _parseOrThrow<TSchema extends StandardSchemaV1>(schema: TSchema, input: unknown, kind: ParserErrorLocation): Promise<StandardSchemaV1.InferOutput<TSchema>>;
+//#endregion
+export { Class, Controller, DELETE, ExpressMiddlewareFn, ExpressRouterMethodKey, ExpressRouterMethods, GET, HEAD, Html404ErrorPage, HttpHeaders, HttpStatus, Injectable, Middleware, MiddlewareClass, OPTIONS, PATCH, POST, PUT, ParserError, ParserErrorLocation, RedirectView, RequestBody, RequestParam, RequestQuery, ResponseEntity, ResponseEntityBuilder, ResponseStatusError, RouteDefinition, Sapling, _ControllerRegistry, _InjectableDeps, _InjectableRegistry, _Route, _getRequestSchemas, _getRoutes, _parseOrThrow, _resolve, methodResolve };

package/dist/index.mjs

@@ -197,6 +197,22 @@ var ResponseEntityBuilder = class {
 	}
 };
 //#endregion
+//#region src/helper/error/responsestatus.ts
+/**
+* Ensure that you define a middleware that can handle this error.
+*
+* @see {@link Sapling.loadResponseStatusErrorMiddleware}
+*/
+var ResponseStatusError = class ResponseStatusError extends Error {
+	constructor(status, message) {
+		super(message ?? "Something went wrong.");
+		this.status = status;
+		Object.setPrototypeOf(this, new.target.prototype);
+		this.name = `HttpError(${HttpStatus[status]})`;
+		if (Error.captureStackTrace) Error.captureStackTrace(this, ResponseStatusError);
+	}
+};
+//#endregion
 //#region src/helper/sapling.ts
 const settings = {
 	serialize: JSON.stringify,
@@ -335,22 +351,6 @@ var Sapling = class Sapling {
 	}
 };
 //#endregion
-//#region src/helper/error.ts
-/**
-* Ensure that you define a middleware that can handle this error.
-*
-* @see {@link Sapling.loadResponseStatusErrorMiddleware}
-*/
-var ResponseStatusError = class ResponseStatusError extends Error {
-	constructor(status, message) {
-		super(message ?? "Something went wrong.");
-		this.status = status;
-		Object.setPrototypeOf(this, new.target.prototype);
-		this.name = `HttpError(${HttpStatus[status]})`;
-		if (Error.captureStackTrace) Error.captureStackTrace(this, ResponseStatusError);
-	}
-};
-//#endregion
 //#region src/types.ts
 const methodResolve = {
 	GET: "get",
@@ -483,14 +483,40 @@ function _resolve(ctor) {
 	return _InjectableRegistry.get(ctor);
 }
 //#endregion
+//#region src/helper/error/exception.ts
+/**
+* This error should be thrown when some data cannot be parsed by a given schema.
+*/
+var ParserError = class ParserError extends ResponseStatusError {
+	constructor(location, issues, vendor) {
+		super(400, ParserError.formatMessage(location, issues, vendor));
+		Object.setPrototypeOf(this, new.target.prototype);
+	}
+	static formatMessage(location, issues, vendor) {
+		const formatted = issues.map((i) => {
+			const path = Array.isArray(i.path) ? i.path.map((seg) => typeof seg === "object" && seg ? String(seg.key) : String(seg)).join(".") : "";
+			return path ? `${path}: ${i.message}` : i.message;
+		}).join("; ");
+		return `${vendor} failed to parse ${(() => {
+			switch (location) {
+				case "reqbody": return "request body";
+				case "reqparams": return "request params";
+				case "reqquery": return "request query";
+			}
+		})()}: ${formatted}`;
+	}
+};
+//#endregion
 //#region src/annotation/request.ts
 const _requestSchemaStore = /* @__PURE__ */ new WeakMap();
-function _getOrCreateDef(ctor, fnName) {
-	let byFn = _requestSchemaStore.get(ctor);
-	if (!byFn) {
-		byFn = /* @__PURE__ */ new Map();
-		_requestSchemaStore.set(ctor, byFn);
-	}
+function _getOrCreateRequestSchemaDefinition(ctor, fnName) {
+	const byFn = (() => {
+		const fn = _requestSchemaStore.get(ctor);
+		if (fn) return fn;
+		const newFn = /* @__PURE__ */ new Map();
+		_requestSchemaStore.set(ctor, newFn);
+		return newFn;
+	})();
 	const existing = byFn.get(fnName);
 	if (existing) return existing;
 	const created = {};
@@ -505,36 +531,30 @@ function RequestBody(schema) {
 	return (target, propertyKey) => {
 		const ctor = target.constructor;
 		const fnName = String(propertyKey);
-		_setOnce(_getOrCreateDef(ctor, fnName), "body", schema, fnName);
+		_setOnce(_getOrCreateRequestSchemaDefinition(ctor, fnName), "body", schema, fnName);
 	};
 }
 function RequestParam(schema) {
 	return (target, propertyKey) => {
 		const ctor = target.constructor;
 		const fnName = String(propertyKey);
-		_setOnce(_getOrCreateDef(ctor, fnName), "param", schema, fnName);
+		_setOnce(_getOrCreateRequestSchemaDefinition(ctor, fnName), "param", schema, fnName);
 	};
 }
 function RequestQuery(schema) {
 	return (target, propertyKey) => {
 		const ctor = target.constructor;
 		const fnName = String(propertyKey);
-		_setOnce(_getOrCreateDef(ctor, fnName), "query", schema, fnName);
+		_setOnce(_getOrCreateRequestSchemaDefinition(ctor, fnName), "query", schema, fnName);
 	};
 }
 function _getRequestSchemas(ctor, fnName) {
 	return _requestSchemaStore.get(ctor)?.get(fnName);
 }
-function _formatIssues(issues) {
-	return issues.map((i) => {
-		const path = Array.isArray(i.path) ? i.path.map((seg) => typeof seg === "object" && seg ? String(seg.key) : String(seg)).join(".") : "";
-		return path ? `${path}: ${i.message}` : i.message;
-	}).join("; ");
-}
 async function _parseOrThrow(schema, input, kind) {
 	const result = await schema["~standard"].validate(input);
-	if (!result.issues) return result.value;
-	throw new ResponseStatusError(400, `${kind === "body" ? "Invalid request body" : kind === "params" ? "Invalid request params" : "Invalid request query"}: ${_formatIssues(result.issues)}`);
+	if (result.issues) throw new ParserError(kind, result.issues, schema["~standard"].vendor);
+	return result.value;
 }
 //#endregion
 //#region src/annotation/route.ts
@@ -645,9 +665,9 @@ function Controller({ prefix = "", deps = [] } = {}) {
 			router[methodName](fp, async (request, response, next) => {
 				const schemas = _getRequestSchemas(target, fnName);
 				if (schemas) {
-					if (schemas.body) request.body = await _parseOrThrow(schemas.body, request.body, "body");
-					if (schemas.param) request.params = await _parseOrThrow(schemas.param, request.params, "params");
-					if (schemas.query) request.query = await _parseOrThrow(schemas.query, request.query, "query");
+					if (schemas.body) request.body = await _parseOrThrow(schemas.body, request.body, "reqbody");
+					if (schemas.param) request.params = await _parseOrThrow(schemas.param, request.params, "reqparams");
+					if (schemas.query) request.query = await _parseOrThrow(schemas.query, request.query, "reqquery");
 				}
 				const result = await fn.bind(controllerInstance)(request, response, next);
 				if (method === "USE") return;
@@ -678,4 +698,4 @@ function MiddlewareClass(...args) {
 	return Controller(...args);
 }
 //#endregion
-export { Controller, DELETE, GET, HEAD, Html404ErrorPage, HttpStatus, Injectable, Middleware, MiddlewareClass, OPTIONS, PATCH, POST, PUT, RedirectView, RequestBody, RequestParam, RequestQuery, ResponseEntity, ResponseEntityBuilder, ResponseStatusError, Sapling, _ControllerRegistry, _InjectableDeps, _InjectableRegistry, _Route, _getRequestSchemas, _getRoutes, _parseOrThrow, _resolve, methodResolve };
+export { Controller, DELETE, GET, HEAD, Html404ErrorPage, HttpStatus, Injectable, Middleware, MiddlewareClass, OPTIONS, PATCH, POST, PUT, ParserError, RedirectView, RequestBody, RequestParam, RequestQuery, ResponseEntity, ResponseEntityBuilder, ResponseStatusError, Sapling, _ControllerRegistry, _InjectableDeps, _InjectableRegistry, _Route, _getRequestSchemas, _getRoutes, _parseOrThrow, _resolve, methodResolve };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tahminator/sapling",
-  "version": "1.5.28-beta.583b1882",
+  "version": "1.5.28-beta.7e624925",
   "author": "Tahmid Ahmed",
   "description": "A library to help you write cleaner Express.js code",
   "repository": {