ApiEndpointsSchema

Author: mpppk

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

@@ -17,7 +17,7 @@ import {
   ToOpenApiResponse,
 } from "./spec";
 import { StandardSchemaV1 } from "@standard-schema/spec";
-import { SSAnyApiResponse } from "../ss";
+import { ApiResponseSchema } from "../schema";
 import { toJsonSchemaApiEndpoints } from "../jsonschema";
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -26,7 +26,7 @@ export type SSOpenApiEndpoints = {
   [Path in string]: SSOpenApiEndpoint;
 };
 export type SSOpenApiEndpoint = DefineOpenApiEndpoint<SSOpenApiSpec>;
-export type SSAnyOpenApiResponse = ToOpenApiResponse<SSAnyApiResponse>;
+export type SSAnyOpenApiResponse = ToOpenApiResponse<ApiResponseSchema>;
 export type SSAnyOpenApiResponses =
   DefineOpenApiResponses<SSAnyOpenApiResponse>;
 

pkgs/typed-api-spec/src/core/ss.t-test.ts pkgs/typed-api-spec/src/core/schema.t-test.ts

@@ -8,7 +8,7 @@ import {
   ToValidators,
   Validators,
 } from ".";
-import { SSApiEndpoints } from "./ss";
+import { ApiEndpointsSchema } from "./schema";
 
 const SSResponse = z.object({ a: z.string() });
 const SSEndpoints = {
@@ -20,7 +20,7 @@ const SSEndpoints = {
       },
     },
   },
-} satisfies SSApiEndpoints;
+} satisfies ApiEndpointsSchema;
 
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 type ToSSValidatorsTestCases = [

pkgs/typed-api-spec/src/core/ss.test.ts pkgs/typed-api-spec/src/core/schema.test.ts

@@ -1,5 +1,5 @@
 import { describe, it, expect, assert } from "vitest";
-import { SSApiEndpoints } from "./ss";
+import { ApiEndpointsSchema } from "./schema";
 import * as v from "valibot";
 import {
   newValidator,
@@ -26,7 +26,7 @@ describe("newSSValidator", () => {
         },
       },
     },
-  } satisfies SSApiEndpoints;
+  } satisfies ApiEndpointsSchema;
 
   const validReqInput = {
     path: "/",

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

@@ -14,38 +14,41 @@ export type InferOrUndefined<T> = T extends StandardSchemaV1
   : undefined;
 
 // -- spec --
-export type SSApiEndpoints = { [Path in string]: SSApiEndpoint };
-export type SSApiEndpoint = Partial<Record<Method, SSApiSpec>>;
-export type SSApiSpec<
+export type ApiEndpointsSchema = { [Path in string]: ApiEndpointSchema };
+export type ApiEndpointSchema = Partial<Record<Method, ApiSpecSchema>>;
+export type ApiSpecSchema<
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   ParamKeys extends string = string,
   Params extends AnyStandardSchemaV1 = AnyStandardSchemaV1,
   Query extends AnyStandardSchemaV1 = AnyStandardSchemaV1,
   Body extends AnyStandardSchemaV1 = AnyStandardSchemaV1,
   RequestHeaders extends AnyStandardSchemaV1 = AnyStandardSchemaV1,
-  Responses extends SSAnyApiResponses = SSAnyApiResponses,
+  Responses extends ApiResponsesSchema = ApiResponsesSchema,
 > = BaseApiSpec<Params, Query, Body, RequestHeaders, Responses>;
-export type SSAnyApiResponse = DefineResponse<
+export type ApiResponseSchema = DefineResponse<
   StandardSchemaV1,
   StandardSchemaV1
 >;
-export type SSAnyApiResponses = DefineApiResponses<SSAnyApiResponse>;
+export type ApiResponsesSchema = DefineApiResponses<ApiResponseSchema>;
 
 // -- converter --
-export type ToApiEndpoints<E extends SSApiEndpoints> = {
+export type ToApiEndpoints<E extends ApiEndpointsSchema> = {
   [Path in keyof E & string]: ToApiEndpoint<E, Path>;
 };
-export type ToApiEndpoint<E extends SSApiEndpoints, Path extends keyof E> = {
+export type ToApiEndpoint<
+  E extends ApiEndpointsSchema,
+  Path extends keyof E,
+> = {
   [M in keyof E[Path] & Method]: ToApiSpec<NonNullable<E[Path][M]>>;
 };
-export type ToApiSpec<ZAS extends SSApiSpec> = {
+export type ToApiSpec<ZAS extends ApiSpecSchema> = {
   query: InferOrUndefined<ZAS["query"]>;
   params: InferOrUndefined<ZAS["params"]>;
   body: InferOrUndefined<ZAS["body"]>;
   headers: InferOrUndefined<ZAS["headers"]>;
   responses: ToApiResponses<ZAS["responses"]>;
 };
-export type ToApiResponses<AR extends SSAnyApiResponses> = {
+export type ToApiResponses<AR extends ApiResponsesSchema> = {
   [SC in keyof AR & StatusCode]: {
     body: InferOrUndefined<NonNullable<AR[SC]>["body"]>;
     headers: InferOrUndefined<NonNullable<AR[SC]>["headers"]>;

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

@@ -11,8 +11,8 @@ import {
   MethodInvalidError,
   newMethodInvalidError,
 } from "../spec";
-import { SSAnyApiResponses, SSApiSpec } from "../ss";
-import { SSApiEndpoints } from "../ss";
+import { ApiResponsesSchema, ApiSpecSchema } from "../schema";
+import { ApiEndpointsSchema } from "../schema";
 import {
   AnySpecValidator,
   listDefinedRequestApiSpecKeys,
@@ -39,7 +39,7 @@ export type Validator<V extends AnyStandardSchemaV1 | undefined> =
     : undefined;
 
 export type Validators<
-  AS extends SSApiSpec,
+  AS extends ApiSpecSchema,
   // FIXME
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   ParamKeys extends string,
@@ -58,15 +58,15 @@ export type ResponseValidators<
   Headers extends SS | undefined,
 > = ResponseSpecValidator<Validator<Body>, Validator<Headers>>;
 export type ToSSResponseValidators<
-  Responses extends SSAnyApiResponses | undefined,
+  Responses extends ApiResponsesSchema | undefined,
   SC extends number,
 > = ResponseValidators<
-  Responses extends SSAnyApiResponses
+  Responses extends ApiResponsesSchema
     ? SC extends keyof Responses
       ? ApiResBody<Responses, SC>
       : undefined
     : undefined,
-  Responses extends SSAnyApiResponses
+  Responses extends ApiResponsesSchema
     ? SC extends keyof Responses
       ? ApiResHeaders<Responses, SC> extends SS
         ? ApiResHeaders<Responses, SC>
@@ -76,12 +76,12 @@ export type ToSSResponseValidators<
 >;
 
 export type ToValidators<
-  E extends SSApiEndpoints,
+  E extends ApiEndpointsSchema,
   Path extends string,
   M extends string,
 > = Path extends keyof E
   ? M extends keyof E[Path] & Method
-    ? E[Path][M] extends SSApiSpec
+    ? E[Path][M] extends ApiSpecSchema
       ? Validators<E[Path][M], string>
       : Record<string, never>
     : Record<string, never>
@@ -159,7 +159,7 @@ type ValidatorInputPathNotFoundError = ReturnType<
  *
  * @param endpoints API endpoints
  */
-export const newValidator = <E extends SSApiEndpoints>(endpoints: E) => {
+export const newValidator = <E extends ApiEndpointsSchema>(endpoints: E) => {
   const req = <Path extends string, M extends string>(
     input: SpecValidatorGeneratorRawInput<Path, M>,
   ): Result<ToValidators<E, Path, M>, ValidatorInputError> => {

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

@@ -16,7 +16,7 @@ import { newValidator, StatusCode, ToValidators } from "../core";
 import { ParsedQs } from "qs";
 import { AnySpecValidator } from "../core/validator/request";
 import { StandardSchemaV1 } from "@standard-schema/spec";
-import { SSApiEndpoints, ToApiEndpoints } from "../core/ss";
+import { ApiEndpointsSchema, ToApiEndpoints } from "../core/schema";
 
 /**
  * Express Request Handler, but with more strict type information.
@@ -36,7 +36,7 @@ export type Handler<
 ) => void;
 
 export type ToHandler<
-  E extends SSApiEndpoints,
+  E extends ApiEndpointsSchema,
   Path extends keyof E & string,
   M extends Method,
 > = Handler<
@@ -48,7 +48,7 @@ export type ToHandler<
   >
 >;
 
-export type ToHandlers<E extends SSApiEndpoints> = {
+export type ToHandlers<E extends ApiEndpointsSchema> = {
   [Path in keyof E & string]: {
     [M in Method]: ToHandler<E, Path, M>;
   };
@@ -93,7 +93,7 @@ export type RouterT<
 };
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-export const validatorMiddleware = <const E extends SSApiEndpoints>(
+export const validatorMiddleware = <const E extends ApiEndpointsSchema>(
   pathMap: E,
 ) => {
   return (_req: Request, res: Response, next: NextFunction) => {
@@ -229,7 +229,7 @@ export const asAsync = <Router extends IRouter | RouterT<any, any>>(
  * })
  * ```
  */
-export const typed = <const Endpoints extends SSApiEndpoints>(
+export const typed = <const Endpoints extends ApiEndpointsSchema>(
   pathMap: Endpoints,
   router: Router,
 ): RouterT<Endpoints> => {

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

@@ -16,10 +16,10 @@ import {
   newValidatorPathNotFoundError,
   Validators,
 } from "../core/validator/validate";
-import { SSApiEndpoints, SSApiSpec } from "../core/ss";
+import { ApiEndpointsSchema, ApiSpecSchema } from "../core/schema";
 
 type SSValidateLocals<
-  AS extends SSApiSpec,
+  AS extends ApiSpecSchema,
   ParamKeys extends string,
 > = ValidateLocals<Validators<AS, ParamKeys>>;
 
@@ -62,7 +62,7 @@ describe("valibot", () => {
           },
         },
       },
-    } satisfies SSApiEndpoints;
+    } satisfies ApiEndpointsSchema;
     // const { req: reqValidator } = newSSValidator(pathMap);
     // const middleware = validatorMiddleware(reqValidator);
     const middleware = validatorMiddleware(pathMap);
@@ -339,7 +339,7 @@ describe("valibot", () => {
           },
         },
       },
-    } satisfies SSApiEndpoints;
+    } satisfies ApiEndpointsSchema;
 
     it("ok", async () => {
       const app = newApp();
@@ -467,7 +467,7 @@ describe("valibot", () => {
             },
           },
         },
-      } satisfies SSApiEndpoints;
+      } satisfies ApiEndpointsSchema;
 
       // eslint-disable-next-line @typescript-eslint/no-unused-vars
       const getHandler: ToHandlers<typeof pathMap>["/users"]["get"] = async (

pkgs/typed-api-spec/src/express/valibot.test.ts

@@ -16,10 +16,10 @@ import {
   newValidatorPathNotFoundError,
   Validators,
 } from "../core/validator/validate";
-import { SSApiEndpoints, SSApiSpec } from "../core/ss";
+import { ApiEndpointsSchema, ApiSpecSchema } from "../core/schema";
 
 type SSValidateLocals<
-  AS extends SSApiSpec,
+  AS extends ApiSpecSchema,
   ParamKeys extends string,
 > = ValidateLocals<Validators<AS, ParamKeys>>;
 
@@ -55,7 +55,7 @@ describe("validatorMiddleware", () => {
         },
       },
     },
-  } satisfies SSApiEndpoints;
+  } satisfies ApiEndpointsSchema;
 
   const middleware = validatorMiddleware(pathMap);
   const next = vi.fn();
@@ -199,7 +199,7 @@ describe("validatorMiddleware", () => {
       expect(next).toHaveBeenCalled();
       expect(res.locals.validate).toEqual(expect.any(Function));
       const locals = res.locals as SSValidateLocals<
-        SSApiSpec,
+        ApiSpecSchema,
         ParseUrlParams<"">
       >;
       const validate = locals.validate(req as Request);
@@ -281,7 +281,7 @@ describe("typed", () => {
         },
       },
     },
-  } satisfies SSApiEndpoints;
+  } satisfies ApiEndpointsSchema;
 
   it("ok", async () => {
     const app = newApp();
@@ -427,7 +427,7 @@ describe("Handler", () => {
           },
         },
       },
-    } satisfies SSApiEndpoints;
+    } satisfies ApiEndpointsSchema;
 
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     const getHandler: ToHandlers<typeof pathMap>["/users"]["get"] = async (