Fix validation

Author: mpppk

pkgs/typed-api-spec/.eslintrc.js

@@ -1,4 +1,4 @@
-const dRef = ["src/index.ts", "misc/**/*"];
+const dRef = ["src/index.ts", "misc/**/*", "**/*.test.ts"];
 const depRules = [
   {
     module: "src/express",

pkgs/typed-api-spec/src/core/spec.ts

@@ -2,6 +2,7 @@ import { ParseUrlParams } from "./url";
 import { ClientResponse, StatusCode } from "./hono-types";
 import { C } from "../compile-error-utils";
 import { JSONSchema7 } from "json-schema";
+import { StandardSchemaV1 } from "@standard-schema/spec";
 
 /**
  * { // ApiEndpoints
@@ -29,13 +30,15 @@ export type CaseInsensitive<S extends string> = S | Uppercase<S> | Lowercase<S>;
 export type CaseInsensitiveMethod = Method | Uppercase<Method>;
 export const isMethod = (x: unknown): x is Method =>
   Method.includes(x as Method);
-export interface MethodInvalidError {
+export interface MethodInvalidError extends StandardSchemaV1.Issue {
   error: "MethodInvalid";
   actual: string;
+  message: string;
 }
 export const newMethodInvalidError = (method: string): MethodInvalidError => ({
   error: "MethodInvalid",
   actual: method,
+  message: `MethodInvalid: ${method}`,
 });
 
 export type ApiEndpoint = Partial<Record<Method, ApiSpec>>;

pkgs/typed-api-spec/src/core/validator/request.ts

@@ -56,13 +56,27 @@ export type SpecValidatorGeneratorInput<
   headers: Record<string, string | string[] | undefined>;
 };
 
-export const runSpecValidator = (validators: AnySpecValidator | undefined) => {
-  const newD = () =>
-    ({ value: undefined }) as StandardSchemaV1.SuccessResult<undefined>;
-  return {
-    params: validators?.params?.() ?? newD(),
-    query: validators?.query?.() ?? newD(),
-    body: validators?.body?.() ?? newD(),
-    headers: validators?.headers?.() ?? newD(),
-  };
+export const runSpecValidator = async (
+  validators: AnySpecValidator,
+  errorHandler: (
+    reason: keyof AnySpecValidator | "preCheck",
+    errors: Readonly<StandardSchemaV1.Issue[]>,
+  ) => void,
+) => {
+  const params = await validators?.params?.();
+  if (params?.issues) {
+    errorHandler("params", params.issues);
+  }
+  const query = await validators?.query?.();
+  if (query?.issues) {
+    errorHandler("query", query.issues);
+  }
+  const body = await validators?.body?.();
+  if (body?.issues) {
+    errorHandler("body", body.issues);
+  }
+  const headers = await validators?.headers?.();
+  if (headers?.issues) {
+    errorHandler("headers", headers.issues);
+  }
 };

pkgs/typed-api-spec/src/core/validator/response.ts

@@ -1,12 +1,5 @@
-import {
-  AnyResponse,
-  ApiSpecResponseKey,
-  apiSpecResponseKeys,
-  Method,
-} from "../spec";
-import { StatusCode } from "../hono-types";
-import { Result } from "../../utils";
-import { AnyValidator, ValidatorInputError } from "./validate";
+import { AnyResponse, ApiSpecResponseKey, apiSpecResponseKeys } from "../spec";
+import { AnyValidator } from "./validate";
 import { StandardSchemaV1 } from "@standard-schema/spec";
 
 export const listDefinedResponseApiSpecKeys = <Response extends AnyResponse>(
@@ -27,20 +20,24 @@ export type ResponseSpecValidator<
 export type AnyResponseSpecValidator = Partial<
   ResponseSpecValidator<AnyValidator, AnyValidator>
 >;
-export const runResponseSpecValidator = (
-  r: Result<AnyResponseSpecValidator, ValidatorInputError>,
+export const runResponseSpecValidator = async (
+  validators: AnyResponseSpecValidator,
+  errorHandler: (
+    reason: keyof AnyResponseSpecValidator | "preCheck",
+    errors: Readonly<StandardSchemaV1.Issue[]>,
+  ) => void,
 ) => {
-  const newD = () =>
-    ({ value: undefined }) as StandardSchemaV1.SuccessResult<undefined>;
-  return {
-    // TODO: スキーマが間違っていても、bodyのvalidatorがなぜか定義されていない
-    preCheck: r.error,
-    body: r.data?.body?.() ?? newD(),
-    headers: r.data?.headers?.() ?? newD(),
-  };
+  const body = await validators?.body?.();
+  if (body?.issues) {
+    errorHandler("body", body.issues);
+  }
+  const headers = await validators?.headers?.();
+  if (headers?.issues) {
+    errorHandler("headers", headers.issues);
+  }
 };
 
-export type ResponseSpecValidatorGeneratorRawInput<
+export type ResponseSpecValidatorGeneratorInput<
   Path extends string,
   M extends string,
   SC extends number,
@@ -51,14 +48,3 @@ export type ResponseSpecValidatorGeneratorRawInput<
   body?: unknown;
   headers: Record<string, string | string[] | undefined>;
 };
-export type ResponseSpecValidatorGeneratorInput<
-  Path extends string,
-  M extends Method,
-  SC extends StatusCode,
-> = {
-  path: Path;
-  method: M;
-  statusCode: SC;
-  body?: unknown;
-  headers: Record<string, string | string[] | undefined>;
-};

pkgs/typed-api-spec/src/core/validator/validate.ts

@@ -24,11 +24,14 @@ import {
   SpecValidatorGeneratorInput,
   SpecValidatorGeneratorRawInput,
 } from "./request";
-import type { StandardSchemaV1 as SS } from "@standard-schema/spec";
+import type {
+  StandardSchemaV1 as SS,
+  StandardSchemaV1,
+} from "@standard-schema/spec";
 import {
   listDefinedResponseApiSpecKeys,
   ResponseSpecValidator,
-  ResponseSpecValidatorGeneratorRawInput,
+  ResponseSpecValidatorGeneratorInput,
 } from "./response";
 import { StatusCode } from "../hono-types";
 export type SSResult<Data> = SS.Result<Data> | Promise<SS.Result<Data>>;
@@ -137,19 +140,21 @@ export type ValidatorInputError =
   | ValidatorInputMethodNotFoundError
   | ValidatorInputPathNotFoundError;
 
-export const newValidatorMethodNotFoundError = (method: string) => ({
-  target: "method" as const,
-  actual: method,
-  message: `method does not exist in endpoint` as const,
-});
+export const newValidatorMethodNotFoundError = (method: string) =>
+  ({
+    target: "method" as const,
+    actual: method,
+    message: `method does not exist in endpoint` as const,
+  }) satisfies StandardSchemaV1.Issue & Record<string, unknown>;
 type ValidatorInputMethodNotFoundError = ReturnType<
   typeof newValidatorMethodNotFoundError
 >;
-export const newValidatorPathNotFoundError = (path: string) => ({
-  target: "path" as const,
-  actual: path,
-  message: `path does not exist in endpoints` as const,
-});
+export const newValidatorPathNotFoundError = (path: string) =>
+  ({
+    target: "path" as const,
+    actual: path,
+    message: `path does not exist in endpoints` as const,
+  }) satisfies StandardSchemaV1.Issue & Record<string, unknown>;
 type ValidatorInputPathNotFoundError = ReturnType<
   typeof newValidatorPathNotFoundError
 >;
@@ -179,7 +184,7 @@ export const newValidator = <E extends ApiEndpointsSchema>(endpoints: E) => {
     return Result.data(validators as ToValidators<E, Path, M>);
   };
   const res = <Path extends string, M extends string, SC extends number>(
-    input: ResponseSpecValidatorGeneratorRawInput<Path, M, SC>,
+    input: ResponseSpecValidatorGeneratorInput<Path, M, SC>,
   ): Result<
     ToSSResponseValidators<ApiResponses<E, Path, M>, SC>,
     ValidatorInputError

pkgs/typed-api-spec/src/express/index.ts

@@ -110,19 +110,19 @@ export const validatorMiddleware = <const E extends ApiEndpointsSchema>(
         return {
           query: () =>
             ({
-              issues: [{ message: "", ...error }],
+              issues: [error],
             }) satisfies StandardSchemaV1.FailureResult,
           params: () =>
             ({
-              issues: [{ message: "", ...error }],
+              issues: [error],
             }) satisfies StandardSchemaV1.FailureResult,
           body: () =>
             ({
-              issues: [{ message: "", ...error }],
+              issues: [error],
             }) satisfies StandardSchemaV1.FailureResult,
           headers: () =>
             ({
-              issues: [{ message: "", ...error }],
+              issues: [error],
             }) satisfies StandardSchemaV1.FailureResult,
         };
       }

pkgs/typed-api-spec/src/fetch/index.ts

@@ -170,3 +170,4 @@ type FetchT<UrlPrefix extends UrlPrefixPattern, E extends ApiEndpoints> = <
 export default FetchT;
 
 export * from "./validation";
+export * from "./new-fetch";