exp: Wildcard status codes

express-zod-api/src/api-response.ts

@@ -1,5 +1,7 @@
 import { z } from "zod";
 
+export type StatusCode = number | "1XX" | "2XX" | "3XX" | "4XX" | "5XX";
+
 export const defaultStatusCodes = {
   positive: 200,
   negative: 400,
@@ -21,7 +23,7 @@ export interface ApiResponse<S extends z.ZodType> {
    * @desc The status code(s) for this response.
    * @default 200 for a positive response, 400 for a negative one
    * */
-  statusCode?: number | [number, ...number[]];
+  statusCode?: StatusCode | [StatusCode, ...StatusCode[]];
   /**
    * @desc The MIME type(s) of the response.
    * @default "application/json"
@@ -36,6 +38,6 @@ export interface ApiResponse<S extends z.ZodType> {
  * */
 export interface NormalizedResponse {
   schema: z.ZodType;
-  statusCodes: [number, ...number[]];
+  statusCodes: [StatusCode, ...StatusCode[]];
   mimeTypes: [string, ...string[]] | null;
 }

express-zod-api/src/documentation-helpers.ts

@@ -16,7 +16,11 @@ import {
 } from "openapi3-ts/oas31";
 import * as R from "ramda";
 import { z } from "zod";
-import type { NormalizedResponse, ResponseVariant } from "./api-response";
+import type {
+  NormalizedResponse,
+  ResponseVariant,
+  StatusCode,
+} from "./api-response";
 import { ezBufferBrand } from "./buffer-schema";
 import {
   type FlatObject,
@@ -446,7 +450,7 @@ export const depictResponse = ({
   brandHandling?: BrandHandling;
   mimeTypes: NormalizedResponse["mimeTypes"];
   variant: ResponseVariant;
-  statusCode: number;
+  statusCode: StatusCode;
   hasMultipleStatusCodes: boolean;
 }): ResponseObject => {
   if (!shouldHaveContent(method, mimeTypes)) return { description };

express-zod-api/src/documentation.ts

@@ -8,7 +8,11 @@ import {
   OpenApiBuilder,
 } from "openapi3-ts/oas31";
 import * as R from "ramda";
-import { type ResponseVariant, responseVariants } from "./api-response";
+import {
+  type ResponseVariant,
+  type StatusCode,
+  responseVariants,
+} from "./api-response";
 import { contentTypes } from "./content-type";
 import { DocumentationError } from "./errors";
 import { getInputSources, makeCleanId } from "./common-helpers";
@@ -41,7 +45,7 @@ type Component =
 /** @desc user defined function that creates a component description from its properties */
 type Descriptor = (
   props: Record<"method" | "path" | "operationId", string> & {
-    statusCode?: number; // for response only
+    statusCode?: StatusCode; // for response only
   },
 ) => string;
 

express-zod-api/src/result-helpers.ts

@@ -49,7 +49,7 @@ export const normalize = <A extends unknown[]>(
     ({ schema, statusCode, mimeType }) => ({
       schema,
       statusCodes:
-        typeof statusCode === "number"
+        typeof statusCode === "number" || typeof statusCode === "string"
           ? [statusCode]
           : statusCode || fallback.statusCodes,
       mimeTypes: