Explicit interface NormalizedResponse.

RobinTail · Nov 19, 2024 · 1df5786 · 1df5786
1 parent 035f0e5
commit 1df5786
Showing 1 changed file with 10 additions and 4 deletions.
diff --git a/src/api-response.ts b/src/api-response.ts
@@ -7,6 +7,7 @@ export const defaultStatusCodes = {
 
 export type ResponseVariant = keyof typeof defaultStatusCodes;
 
+/** @public this is the user facing configuration */
 export interface ApiResponse<S extends z.ZodTypeAny> {
   schema: S;
   /** @default 200 for a positive and 400 for a negative response */
@@ -19,7 +20,12 @@ export interface ApiResponse<S extends z.ZodTypeAny> {
   mimeTypes?: never;
 }
 
-export type NormalizedResponse = Pick<ApiResponse<z.ZodTypeAny>, "schema"> & {
-  statusCodes: Extract<ApiResponse<z.ZodTypeAny>["statusCode"], Array<unknown>>;
-  mimeTypes: Extract<ApiResponse<z.ZodTypeAny>["mimeType"], Array<unknown>>;
-};
+/**
+ * @private This is what the framework entities operate
+ * @see normalize
+ * */
+export interface NormalizedResponse {
+  schema: z.ZodTypeAny;
+  statusCodes: [number, ...number[]];
+  mimeTypes: [string, ...string[]];
+}