@ryoppippi/hono-unknownutil-validator@0.1.5

Built and signed on GitHub Actions

Built and signed on GitHub Actions

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111
import type {
  Context,
  Env,
  MiddlewareHandler,
  TypedResponse,
  ValidationTargets,
} from "jsr:@hono/hono@^4.4.6";
import { validator } from "jsr:/@hono/hono@^4.4.6/validator";

import * as U from "jsr:@core/unknownutil@^4.0.1";

// deno-lint-ignore ban-types
type Hook<T, E extends Env, P extends string, O = {}> = (
  result: Result<T>,
  c: Context<E, P>,
) =>
  | Response
  | Promise<Response>
  | void
  | Promise<Response | void>
  | TypedResponse<O>;

type Result<T = unknown> =
  | { data: T; success: true }
  | { data: T; success: false; error: Omit<U.AssertError, "cause"> };

// deno-lint-ignore no-explicit-any
type Schema<T = any> = U.Predicate<T>;
type OutputType<T> = T extends U.Predicate<infer O>
  ? undefined extends O ? never : O
  : never;

/**
 * Create a validator middleware with [unknownutil](https://github.com/jsr-core/unknownutil) schema.
 *
 * @example
 * ```ts
 * import { is } from '@core/unknownutil'
 * import { Hono } from '@hono/hono'
 * import { uValidator } from '@ryoppippi/hono-unknownutil-validator'
 *
 * const isAuthor = is.ObjectOf({
 *  name: is.String,
 *  age: is.Number,
 * })
 *
 * type Author = U.PredicateType<typeof isAuthor>
 *
 * app.post('/author', uValidator('json', schema), (c) => {
 *  const data = c.req.valid('json')
 *  return c.json({
 *    success: true,
 *    message: `${data.name} is ${data.age}`,
 *  })
 * })
 * ```
 */
export const uValidator = <
  S extends Schema,
  O extends OutputType<S>,
  Target extends keyof ValidationTargets,
  E extends Env,
  P extends string,
  V extends {
    in: { [K in Target]: O };
    out: { [K in Target]: O };
  } = {
    in: { [K in Target]: O };
    out: { [K in Target]: O };
  },
>(
  target: Target,
  schema: S,
  hook?: Hook<O, E, P>,
): MiddlewareHandler<E, P, V> =>
  validator(target, (value, c) => {
    let result: Result<U.PredicateType<S>>;

    try {
      result = { data: U.ensure(value, schema), success: true };
    } catch (_error: unknown) {
      const error = _error as unknown as U.AssertError;
      result = {
        data: value,
        success: false,
        error: {
          message: error.message,
          name: error.name,
          stack: error.stack,
        },
      };
    }

    if (hook) {
      const hookResult = hook(result, c);
      if (hookResult) {
        if (hookResult instanceof Response || hookResult instanceof Promise) {
          return hookResult;
        }
        if ("response" in hookResult) {
          return hookResult.response;
        }
      }
    }

    if (!result.success) {
      return c.json(result, 400);
    }

    return result.data;
  });