mirror of
https://github.com/shishantbiswas/bknd.git
synced 2026-03-16 12:37:20 +00:00
moved main pkg back to deps to reduce tarball size + removed zod + cleanup old code + fixed tests
This commit is contained in:
dswbx
@@ -1,5 +1,5 @@
|
||||
export { Endpoint, type RequestResponse, type Middleware } from "./server/Endpoint";
|
||||
export { zValidator } from "./server/lib/zValidator";
|
||||
import type { Hono, MiddlewareHandler } from "hono";
|
||||
|
||||
export { tbValidator } from "./server/lib/tbValidator";
|
||||
export { Exception, BkndError } from "./errors";
|
||||
export { isDebug } from "./env";
|
||||
@@ -11,7 +11,6 @@ export {
|
||||
type TemplateTypes,
|
||||
type SimpleRendererOptions
|
||||
} from "./template/SimpleRenderer";
|
||||
export { Controller, type ClassController } from "./server/Controller";
|
||||
export { SchemaObject } from "./object/SchemaObject";
|
||||
export { DebugLogger } from "./utils/DebugLogger";
|
||||
export { Permission } from "./security/Permission";
|
||||
@@ -26,3 +25,10 @@ export {
|
||||
isBooleanLike
|
||||
} from "./object/query/query";
|
||||
export { Registry, type Constructor } from "./registry/Registry";
|
||||
|
||||
// compatibility
|
||||
export type Middleware = MiddlewareHandler<any, any, any>;
|
||||
export interface ClassController {
|
||||
getController: () => Hono<any, any, any>;
|
||||
getMiddleware?: MiddlewareHandler<any, any, any>;
|
||||
}
|
||||
|
||||
@@ -1,155 +0,0 @@
|
||||
import { Hono, type MiddlewareHandler, type ValidationTargets } from "hono";
|
||||
import type { H } from "hono/types";
|
||||
import { safelyParseObjectValues } from "../utils";
|
||||
import type { Endpoint, Middleware } from "./Endpoint";
|
||||
import { zValidator } from "./lib/zValidator";
|
||||
|
||||
type RouteProxy<Endpoints> = {
|
||||
[K in keyof Endpoints]: Endpoints[K];
|
||||
};
|
||||
|
||||
export interface ClassController {
|
||||
getController: () => Hono<any, any, any>;
|
||||
getMiddleware?: MiddlewareHandler<any, any, any>;
|
||||
}
|
||||
|
||||
/**
|
||||
* @deprecated
|
||||
*/
|
||||
export class Controller<
|
||||
Endpoints extends Record<string, Endpoint> = Record<string, Endpoint>,
|
||||
Middlewares extends Record<string, Middleware> = Record<string, Middleware>
|
||||
> {
|
||||
protected endpoints: Endpoints = {} as Endpoints;
|
||||
protected middlewares: Middlewares = {} as Middlewares;
|
||||
|
||||
public prefix: string = "/";
|
||||
public routes: RouteProxy<Endpoints>;
|
||||
|
||||
constructor(
|
||||
prefix: string = "/",
|
||||
endpoints: Endpoints = {} as Endpoints,
|
||||
middlewares: Middlewares = {} as Middlewares
|
||||
) {
|
||||
this.prefix = prefix;
|
||||
this.endpoints = endpoints;
|
||||
this.middlewares = middlewares;
|
||||
|
||||
this.routes = new Proxy(
|
||||
{},
|
||||
{
|
||||
get: (_, name: string) => {
|
||||
return this.endpoints[name];
|
||||
}
|
||||
}
|
||||
) as RouteProxy<Endpoints>;
|
||||
}
|
||||
|
||||
add<Name extends string, E extends Endpoint>(
|
||||
this: Controller<Endpoints>,
|
||||
name: Name,
|
||||
endpoint: E
|
||||
): Controller<Endpoints & Record<Name, E>> {
|
||||
const newEndpoints = {
|
||||
...this.endpoints,
|
||||
[name]: endpoint
|
||||
} as Endpoints & Record<Name, E>;
|
||||
const newController: Controller<Endpoints & Record<Name, E>> = new Controller<
|
||||
Endpoints & Record<Name, E>
|
||||
>();
|
||||
newController.endpoints = newEndpoints;
|
||||
newController.middlewares = this.middlewares;
|
||||
return newController;
|
||||
}
|
||||
|
||||
get<Name extends keyof Endpoints>(name: Name): Endpoints[Name] {
|
||||
return this.endpoints[name];
|
||||
}
|
||||
|
||||
honoify(_hono: Hono = new Hono()) {
|
||||
const hono = _hono.basePath(this.prefix);
|
||||
|
||||
// apply middlewares
|
||||
for (const m_name in this.middlewares) {
|
||||
const middleware = this.middlewares[m_name];
|
||||
|
||||
if (typeof middleware === "function") {
|
||||
//if (isDebug()) console.log("+++ appyling middleware", m_name, middleware);
|
||||
hono.use(middleware);
|
||||
}
|
||||
}
|
||||
|
||||
// apply endpoints
|
||||
for (const name in this.endpoints) {
|
||||
const endpoint = this.endpoints[name];
|
||||
if (!endpoint) continue;
|
||||
|
||||
const handlers: H[] = [];
|
||||
|
||||
const supportedValidations: Array<keyof ValidationTargets> = ["param", "query", "json"];
|
||||
|
||||
// if validations are present, add them to the handlers
|
||||
for (const validation of supportedValidations) {
|
||||
if (endpoint.validation[validation]) {
|
||||
handlers.push(async (c, next) => {
|
||||
// @todo: potentially add "strict" to all schemas?
|
||||
const res = await zValidator(
|
||||
validation,
|
||||
endpoint.validation[validation] as any,
|
||||
(target, value, c) => {
|
||||
if (["query", "param"].includes(target)) {
|
||||
return safelyParseObjectValues(value);
|
||||
}
|
||||
//console.log("preprocess", target, value, c.req.raw.url);
|
||||
return value;
|
||||
}
|
||||
)(c, next);
|
||||
|
||||
if (res instanceof Response && res.status === 400) {
|
||||
const error = await res.json();
|
||||
return c.json(
|
||||
{
|
||||
error: "Validation error",
|
||||
target: validation,
|
||||
message: error
|
||||
},
|
||||
400
|
||||
);
|
||||
}
|
||||
|
||||
return res;
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
// add actual handler
|
||||
handlers.push(endpoint.toHandler());
|
||||
|
||||
const method = endpoint.method.toLowerCase() as
|
||||
| "get"
|
||||
| "post"
|
||||
| "put"
|
||||
| "delete"
|
||||
| "patch";
|
||||
|
||||
//if (isDebug()) console.log("--- adding", method, endpoint.path);
|
||||
hono[method](endpoint.path, ...handlers);
|
||||
}
|
||||
|
||||
return hono;
|
||||
}
|
||||
|
||||
toJSON() {
|
||||
const endpoints: any = {};
|
||||
for (const name in this.endpoints) {
|
||||
const endpoint = this.endpoints[name];
|
||||
if (!endpoint) continue;
|
||||
|
||||
endpoints[name] = {
|
||||
method: endpoint.method,
|
||||
path: (this.prefix + endpoint.path).replace("//", "/")
|
||||
};
|
||||
}
|
||||
return endpoints;
|
||||
}
|
||||
}
|
||||
@@ -1,147 +0,0 @@
|
||||
import type { Context, MiddlewareHandler, Next, ValidationTargets } from "hono";
|
||||
import type { Handler } from "hono/types";
|
||||
import { encodeSearch, replaceUrlParam } from "../utils";
|
||||
import type { Prettify } from "../utils";
|
||||
|
||||
type ZodSchema = { [key: string]: any };
|
||||
|
||||
type Method = "GET" | "POST" | "PUT" | "DELETE" | "PATCH";
|
||||
type Validation<P, Q, B> = {
|
||||
[K in keyof ValidationTargets]?: any;
|
||||
} & {
|
||||
param?: P extends ZodSchema ? P : undefined;
|
||||
query?: Q extends ZodSchema ? Q : undefined;
|
||||
json?: B extends ZodSchema ? B : undefined;
|
||||
};
|
||||
|
||||
type ValidationInput<P, Q, B> = {
|
||||
param?: P extends ZodSchema ? P["_input"] : undefined;
|
||||
query?: Q extends ZodSchema ? Q["_input"] : undefined;
|
||||
json?: B extends ZodSchema ? B["_input"] : undefined;
|
||||
};
|
||||
|
||||
type HonoEnv = any;
|
||||
|
||||
export type Middleware = MiddlewareHandler<any, any, any>;
|
||||
|
||||
type HandlerFunction<P extends string, R> = (c: Context<HonoEnv, P, any>, next: Next) => R;
|
||||
export type RequestResponse<R> = {
|
||||
status: number;
|
||||
ok: boolean;
|
||||
response: Awaited<R>;
|
||||
};
|
||||
|
||||
/**
|
||||
* @deprecated
|
||||
*/
|
||||
export class Endpoint<
|
||||
Path extends string = any,
|
||||
P extends ZodSchema = any,
|
||||
Q extends ZodSchema = any,
|
||||
B extends ZodSchema = any,
|
||||
R = any
|
||||
> {
|
||||
constructor(
|
||||
readonly method: Method,
|
||||
readonly path: Path,
|
||||
readonly handler: HandlerFunction<Path, R>,
|
||||
readonly validation: Validation<P, Q, B> = {}
|
||||
) {}
|
||||
|
||||
// @todo: typing is not ideal
|
||||
async $request(
|
||||
args?: ValidationInput<P, Q, B>,
|
||||
baseUrl: string = "http://localhost:28623"
|
||||
): Promise<Prettify<RequestResponse<R>>> {
|
||||
let path = this.path as string;
|
||||
if (args?.param) {
|
||||
path = replaceUrlParam(path, args.param);
|
||||
}
|
||||
|
||||
if (args?.query) {
|
||||
path += "?" + encodeSearch(args.query);
|
||||
}
|
||||
|
||||
const url = [baseUrl, path].join("").replace(/\/$/, "");
|
||||
const options: RequestInit = {
|
||||
method: this.method,
|
||||
headers: {} as any
|
||||
};
|
||||
|
||||
if (!["GET", "HEAD"].includes(this.method)) {
|
||||
if (args?.json) {
|
||||
options.body = JSON.stringify(args.json);
|
||||
options.headers!["Content-Type"] = "application/json";
|
||||
}
|
||||
}
|
||||
|
||||
const res = await fetch(url, options);
|
||||
return {
|
||||
status: res.status,
|
||||
ok: res.ok,
|
||||
response: (await res.json()) as any
|
||||
};
|
||||
}
|
||||
|
||||
toHandler(): Handler {
|
||||
return async (c, next) => {
|
||||
const res = await this.handler(c, next);
|
||||
//console.log("toHandler:isResponse", res instanceof Response);
|
||||
//return res;
|
||||
if (res instanceof Response) {
|
||||
return res;
|
||||
}
|
||||
return c.json(res as any) as unknown as Handler;
|
||||
};
|
||||
}
|
||||
|
||||
static get<
|
||||
Path extends string = any,
|
||||
P extends ZodSchema = any,
|
||||
Q extends ZodSchema = any,
|
||||
B extends ZodSchema = any,
|
||||
R = any
|
||||
>(path: Path, handler: HandlerFunction<Path, R>, validation?: Validation<P, Q, B>) {
|
||||
return new Endpoint<Path, P, Q, B, R>("GET", path, handler, validation);
|
||||
}
|
||||
|
||||
static post<
|
||||
Path extends string = any,
|
||||
P extends ZodSchema = any,
|
||||
Q extends ZodSchema = any,
|
||||
B extends ZodSchema = any,
|
||||
R = any
|
||||
>(path: Path, handler: HandlerFunction<Path, R>, validation?: Validation<P, Q, B>) {
|
||||
return new Endpoint<Path, P, Q, B, R>("POST", path, handler, validation);
|
||||
}
|
||||
|
||||
static patch<
|
||||
Path extends string = any,
|
||||
P extends ZodSchema = any,
|
||||
Q extends ZodSchema = any,
|
||||
B extends ZodSchema = any,
|
||||
R = any
|
||||
>(path: Path, handler: HandlerFunction<Path, R>, validation?: Validation<P, Q, B>) {
|
||||
return new Endpoint<Path, P, Q, B, R>("PATCH", path, handler, validation);
|
||||
}
|
||||
|
||||
static put<
|
||||
Path extends string = any,
|
||||
P extends ZodSchema = any,
|
||||
Q extends ZodSchema = any,
|
||||
B extends ZodSchema = any,
|
||||
R = any
|
||||
>(path: Path, handler: HandlerFunction<Path, R>, validation?: Validation<P, Q, B>) {
|
||||
return new Endpoint<Path, P, Q, B, R>("PUT", path, handler, validation);
|
||||
}
|
||||
|
||||
static delete<
|
||||
Path extends string = any,
|
||||
P extends ZodSchema = any,
|
||||
Q extends ZodSchema = any,
|
||||
B extends ZodSchema = any,
|
||||
R = any
|
||||
>(path: Path, handler: HandlerFunction<Path, R>, validation?: Validation<P, Q, B>) {
|
||||
return new Endpoint<Path, P, Q, B, R>("DELETE", path, handler, validation);
|
||||
}
|
||||
}
|
||||
@@ -1,75 +0,0 @@
|
||||
import type {
|
||||
Context,
|
||||
Env,
|
||||
Input,
|
||||
MiddlewareHandler,
|
||||
TypedResponse,
|
||||
ValidationTargets,
|
||||
} from "hono";
|
||||
import { validator } from "hono/validator";
|
||||
import type { ZodError, ZodSchema, z } from "zod";
|
||||
|
||||
export type Hook<T, E extends Env, P extends string, O = {}> = (
|
||||
result: { success: true; data: T } | { success: false; error: ZodError; data: T },
|
||||
c: Context<E, P>,
|
||||
) => Response | void | TypedResponse<O> | Promise<Response | void | TypedResponse<O>>;
|
||||
|
||||
type HasUndefined<T> = undefined extends T ? true : false;
|
||||
|
||||
export const zValidator = <
|
||||
T extends ZodSchema,
|
||||
Target extends keyof ValidationTargets,
|
||||
E extends Env,
|
||||
P extends string,
|
||||
In = z.input<T>,
|
||||
Out = z.output<T>,
|
||||
I extends Input = {
|
||||
in: HasUndefined<In> extends true
|
||||
? {
|
||||
[K in Target]?: K extends "json"
|
||||
? In
|
||||
: HasUndefined<keyof ValidationTargets[K]> extends true
|
||||
? { [K2 in keyof In]?: ValidationTargets[K][K2] }
|
||||
: { [K2 in keyof In]: ValidationTargets[K][K2] };
|
||||
}
|
||||
: {
|
||||
[K in Target]: K extends "json"
|
||||
? In
|
||||
: HasUndefined<keyof ValidationTargets[K]> extends true
|
||||
? { [K2 in keyof In]?: ValidationTargets[K][K2] }
|
||||
: { [K2 in keyof In]: ValidationTargets[K][K2] };
|
||||
};
|
||||
out: { [K in Target]: Out };
|
||||
},
|
||||
V extends I = I,
|
||||
>(
|
||||
target: Target,
|
||||
schema: T,
|
||||
preprocess?: (target: string, value: In, c: Context<E, P>) => V, // <-- added
|
||||
hook?: Hook<z.infer<T>, E, P>,
|
||||
): MiddlewareHandler<E, P, V> =>
|
||||
// @ts-expect-error not typed well
|
||||
validator(target, async (value, c) => {
|
||||
// added: preprocess value first if given
|
||||
const _value = preprocess ? preprocess(target, value, c) : (value as any);
|
||||
const result = await schema.safeParseAsync(_value);
|
||||
|
||||
if (hook) {
|
||||
const hookResult = await hook({ data: value, ...result }, c);
|
||||
if (hookResult) {
|
||||
if (hookResult instanceof Response) {
|
||||
return hookResult;
|
||||
}
|
||||
|
||||
if ("response" in hookResult) {
|
||||
return hookResult.response;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (!result.success) {
|
||||
return c.json(result, 400);
|
||||
}
|
||||
|
||||
return result.data as z.infer<T>;
|
||||
});
|
||||
Reference in New Issue
Block a user