@grace-js/grace/dist/cjs/routes/response.d.ts

An opinionated API framework

import { z, ZodSchema } from "zod";
export type ResponseSchema<Continue extends ZodSchema, SwitchingProtocols extends ZodSchema, Processing extends ZodSchema, OK extends ZodSchema, Created extends ZodSchema, Accepted extends ZodSchema, NonAuthoritativeInfo extends ZodSchema, NoContent extends ZodSchema, ResetContent extends ZodSchema, PartialContent extends ZodSchema, MultiStatus extends ZodSchema, AlreadyReported extends ZodSchema, IMUsed extends ZodSchema, MultipleChoices extends ZodSchema, MovedPermanently extends ZodSchema, Found extends ZodSchema, SeeOther extends ZodSchema, NotModified extends ZodSchema, UseProxy extends ZodSchema, Unused extends ZodSchema, TemporaryRedirect extends ZodSchema, PermanentRedirect extends ZodSchema, BadRequest extends ZodSchema, Unauthorized extends ZodSchema, PaymentRequired extends ZodSchema, Forbidden extends ZodSchema, NotFound extends ZodSchema, MethodNotAllowed extends ZodSchema, NotAcceptable extends ZodSchema, ProxyAuthRequired extends ZodSchema, RequestTimeout extends ZodSchema, Conflict extends ZodSchema, Gone extends ZodSchema, LengthRequired extends ZodSchema, PreconditionFailed extends ZodSchema, PayloadTooLarge extends ZodSchema, URITooLong extends ZodSchema, UnsupportedMediaType extends ZodSchema, RequestedRangeNotSatisfiable extends ZodSchema, ExpectationFailed extends ZodSchema, IMATeapot extends ZodSchema, UnprocessableEntity extends ZodSchema, Locked extends ZodSchema, FailedDependency extends ZodSchema, UpgradeRequired extends ZodSchema, PreconditionRequired extends ZodSchema, TooManyRequests extends ZodSchema, RequestHeaderFieldsTooLarge extends ZodSchema, UnavailableForLegalReasons extends ZodSchema, InternalServerError extends ZodSchema, NotImplemented extends ZodSchema, BadGateway extends ZodSchema, ServiceUnavailable extends ZodSchema, GatewayTimeout extends ZodSchema, HTTPVersionNotSupported extends ZodSchema, VariantAlsoNegotiates extends ZodSchema, InsufficientStorage extends ZodSchema, LoopDetected extends ZodSchema, NotExtended extends ZodSchema, NetworkAuthenticationRequired extends ZodSchema> = {
    100?: Continue;
    101?: SwitchingProtocols;
    102?: Processing;
    200?: OK;
    201?: Created;
    202?: Accepted;
    203?: NonAuthoritativeInfo;
    204?: NoContent;
    205?: ResetContent;
    206?: PartialContent;
    207?: MultiStatus;
    208?: AlreadyReported;
    226?: IMUsed;
    300?: MultipleChoices;
    301?: MovedPermanently;
    302?: Found;
    303?: SeeOther;
    304?: NotModified;
    305?: UseProxy;
    306?: Unused;
    307?: TemporaryRedirect;
    308?: PermanentRedirect;
    400?: BadRequest;
    401?: Unauthorized;
    402?: PaymentRequired;
    403?: Forbidden;
    404?: NotFound;
    405?: MethodNotAllowed;
    406?: NotAcceptable;
    407?: ProxyAuthRequired;
    408?: RequestTimeout;
    409?: Conflict;
    410?: Gone;
    411?: LengthRequired;
    412?: PreconditionFailed;
    413?: PayloadTooLarge;
    414?: URITooLong;
    415?: UnsupportedMediaType;
    416?: RequestedRangeNotSatisfiable;
    417?: ExpectationFailed;
    418?: IMATeapot;
    422?: UnprocessableEntity;
    423?: Locked;
    424?: FailedDependency;
    426?: UpgradeRequired;
    428?: PreconditionRequired;
    429?: TooManyRequests;
    431?: RequestHeaderFieldsTooLarge;
    451?: UnavailableForLegalReasons;
    500?: InternalServerError;
    501?: NotImplemented;
    502?: BadGateway;
    503?: ServiceUnavailable;
    504?: GatewayTimeout;
    505?: HTTPVersionNotSupported;
    506?: VariantAlsoNegotiates;
    507?: InsufficientStorage;
    508?: LoopDetected;
    510?: NotExtended;
    511?: NetworkAuthenticationRequired;
};
export type AnyResponseSchema = ResponseSchema<ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema, ZodSchema>;
export type PossibleResponses<Response extends AnyResponseSchema> = {
    code: 100 | 'CONTINUE';
    body: Response[100] extends ZodSchema ? z.infer<Response[100]> : never;
    headers?: Record<string, string>;
} | {
    code: 101 | 'SWITCHING_PROTOCOLS';
    body: Response[101] extends ZodSchema ? z.infer<Response[101]> : never;
    headers?: Record<string, string>;
} | {
    code: 102 | 'PROCESSING';
    body: Response[102] extends ZodSchema ? z.infer<Response[102]> : never;
    headers?: Record<string, string>;
} | {
    code: 200 | 'OK';
    body: Response[200] extends ZodSchema ? z.infer<Response[200]> : never;
    headers?: Record<string, string>;
} | {
    code: 201 | 'CREATED';
    body: Response[201] extends ZodSchema ? z.infer<Response[201]> : never;
    headers?: Record<string, string>;
} | {
    code: 202 | 'ACCEPTED';
    body: Response[202] extends ZodSchema ? z.infer<Response[202]> : never;
    headers?: Record<string, string>;
} | {
    code: 203 | 'NON_AUTHORITATIVE_INFO';
    body: Response[203] extends ZodSchema ? z.infer<Response[203]> : never;
    headers?: Record<string, string>;
} | {
    code: 204 | 'NO_CONTENT';
    body: Response[204] extends ZodSchema ? z.infer<Response[204]> : never;
    headers?: Record<string, string>;
} | {
    code: 205 | 'RESET_CONTENT';
    body: Response[205] extends ZodSchema ? z.infer<Response[205]> : never;
    headers?: Record<string, string>;
} | {
    code: 206 | 'PARTIAL_CONTENT';
    body: Response[206] extends ZodSchema ? z.infer<Response[206]> : never;
    headers?: Record<string, string>;
} | {
    code: 207 | 'MULTI_STATUS';
    body: Response[207] extends ZodSchema ? z.infer<Response[207]> : never;
    headers?: Record<string, string>;
} | {
    code: 208 | 'ALREADY_REPORTED';
    body: Response[208] extends ZodSchema ? z.infer<Response[208]> : never;
    headers?: Record<string, string>;
} | {
    code: 226 | 'IM_USED';
    body: Response[226] extends ZodSchema ? z.infer<Response[226]> : never;
    headers?: Record<string, string>;
} | {
    code: 300 | 'MULTIPLE_CHOICES';
    body: Response[300] extends ZodSchema ? z.infer<Response[300]> : never;
    headers?: Record<string, string>;
} | {
    code: 301 | 'MOVED_PERMANENTLY';
    body: Response[301] extends ZodSchema ? z.infer<Response[301]> : never;
    headers?: Record<string, string>;
    redirect: string;
} | {
    code: 302 | 'FOUND';
    body: Response[302] extends ZodSchema ? z.infer<Response[302]> : never;
    headers?: Record<string, string>;
    redirect: string;
} | {
    code: 303 | 'SEE_OTHER';
    body: Response[303] extends ZodSchema ? z.infer<Response[303]> : never;
    headers?: Record<string, string>;
} | {
    code: 304 | 'NOT_MODIFIED';
    body: Response[304] extends ZodSchema ? z.infer<Response[304]> : never;
    headers?: Record<string, string>;
} | {
    code: 305 | 'USE_PROXY';
    body: Response[305] extends ZodSchema ? z.infer<Response[305]> : never;
    headers?: Record<string, string>;
} | {
    code: 306 | 'UNUSED';
    body: Response[306] extends ZodSchema ? z.infer<Response[306]> : never;
    headers?: Record<string, string>;
} | {
    code: 307 | 'TEMPORARY_REDIRECT';
    body: Response[307] extends ZodSchema ? z.infer<Response[307]> : never;
    headers?: Record<string, string>;
    redirect: string;
} | {
    code: 308 | 'PERMANENT_REDIRECT';
    body: Response[308] extends ZodSchema ? z.infer<Response[308]> : never;
    headers?: Record<string, string>;
    redirect: string;
} | {
    code: 400 | 'BAD_REQUEST';
    body: Response[400] extends ZodSchema ? z.infer<Response[400]> : never;
    headers?: Record<string, string>;
} | {
    code: 401 | 'UNAUTHORIZED';
    body: Response[401] extends ZodSchema ? z.infer<Response[401]> : never;
    headers?: Record<string, string>;
} | {
    code: 402 | 'PAYMENT_REQUIRED';
    body: Response[402] extends ZodSchema ? z.infer<Response[402]> : never;
    headers?: Record<string, string>;
} | {
    code: 403 | 'FORBIDDEN';
    body: Response[403] extends ZodSchema ? z.infer<Response[403]> : never;
    headers?: Record<string, string>;
} | {
    code: 404 | 'NOT_FOUND';
    body: Response[404] extends ZodSchema ? z.infer<Response[404]> : never;
    headers?: Record<string, string>;
} | {
    code: 405 | 'METHOD_NOT_ALLOWED';
    body: Response[405] extends ZodSchema ? z.infer<Response[405]> : never;
    headers?: Record<string, string>;
} | {
    code: 406 | 'NOT_ACCEPTABLE';
    body: Response[406] extends ZodSchema ? z.infer<Response[406]> : never;
    headers?: Record<string, string>;
} | {
    code: 407 | 'PROXY_AUTH_REQUIRED';
    body: Response[407] extends ZodSchema ? z.infer<Response[407]> : never;
    headers?: Record<string, string>;
} | {
    code: 408 | 'REQUEST_TIMEOUT';
    body: Response[408] extends ZodSchema ? z.infer<Response[408]> : never;
    headers?: Record<string, string>;
} | {
    code: 409 | 'CONFLICT';
    body: Response[409] extends ZodSchema ? z.infer<Response[409]> : never;
    headers?: Record<string, string>;
} | {
    code: 410 | 'GONE';
    body: Response[410] extends ZodSchema ? z.infer<Response[410]> : never;
    headers?: Record<string, string>;
} | {
    code: 411 | 'LENGTH_REQUIRED';
    body: Response[411] extends ZodSchema ? z.infer<Response[411]> : never;
    headers?: Record<string, string>;
} | {
    code: 412 | 'PRECONDITION_FAILED';
    body: Response[412] extends ZodSchema ? z.infer<Response[412]> : never;
    headers?: Record<string, string>;
} | {
    code: 413 | 'PAYLOAD_TOO_LARGE';
    body: Response[413] extends ZodSchema ? z.infer<Response[413]> : never;
    headers?: Record<string, string>;
} | {
    code: 414 | 'URI_TOO_LONG';
    body: Response[414] extends ZodSchema ? z.infer<Response[414]> : never;
    headers?: Record<string, string>;
} | {
    code: 415 | 'UNSUPPORTED_MEDIA_TYPE';
    body: Response[415] extends ZodSchema ? z.infer<Response[415]> : never;
    headers?: Record<string, string>;
} | {
    code: 416 | 'REQUESTED_RANGE_NOT_SATISFIABLE';
    body: Response[416] extends ZodSchema ? z.infer<Response[416]> : never;
    headers?: Record<string, string>;
} | {
    code: 417 | 'EXPECTATION_FAILED';
    body: Response[417] extends ZodSchema ? z.infer<Response[417]> : never;
    headers?: Record<string, string>;
} | {
    code: 418 | 'IMA_TEAPOT';
    body: Response[418] extends ZodSchema ? z.infer<Response[418]> : never;
    headers?: Record<string, string>;
} | {
    code: 422 | 'UNPROCESSABLE_ENTITY';
    body: Response[422] extends ZodSchema ? z.infer<Response[422]> : never;
    headers?: Record<string, string>;
} | {
    code: 423 | 'LOCKED';
    body: Response[423] extends ZodSchema ? z.infer<Response[423]> : never;
    headers?: Record<string, string>;
} | {
    code: 424 | 'FAILED_DEPENDENCY';
    body: Response[424] extends ZodSchema ? z.infer<Response[424]> : never;
    headers?: Record<string, string>;
} | {
    code: 426 | 'UPGRADE_REQUIRED';
    body: Response[426] extends ZodSchema ? z.infer<Response[426]> : never;
    headers?: Record<string, string>;
} | {
    code: 428 | 'PRECONDITION_REQUIRED';
    body: Response[428] extends ZodSchema ? z.infer<Response[428]> : never;
    headers?: Record<string, string>;
} | {
    code: 429 | 'TOO_MANY_REQUESTS';
    body: Response[429] extends ZodSchema ? z.infer<Response[429]> : never;
    headers?: Record<string, string>;
} | {
    code: 431 | 'REQUEST_HEADER_FIELDS_TOO_LARGE';
    body: Response[431] extends ZodSchema ? z.infer<Response[431]> : never;
    headers?: Record<string, string>;
} | {
    code: 451 | 'UNAVAILABLE_FOR_LEGAL_REASONS';
    body: Response[451] extends ZodSchema ? z.infer<Response[451]> : never;
    headers?: Record<string, string>;
} | {
    code: 500 | 'INTERNAL_SERVER_ERROR';
    body: Response[500] extends ZodSchema ? z.infer<Response[500]> : never;
    headers?: Record<string, string>;
} | {
    code: 501 | 'NOT_IMPLEMENTED';
    body: Response[501] extends ZodSchema ? z.infer<Response[501]> : never;
    headers?: Record<string, string>;
} | {
    code: 502 | 'BAD_GATEWAY';
    body: Response[502] extends ZodSchema ? z.infer<Response[502]> : never;
    headers?: Record<string, string>;
} | {
    code: 503 | 'SERVICE_UNAVAILABLE';
    body: Response[503] extends ZodSchema ? z.infer<Response[503]> : never;
    headers?: Record<string, string>;
} | {
    code: 504 | 'GATEWAY_TIMEOUT';
    body: Response[504] extends ZodSchema ? z.infer<Response[504]> : never;
    headers?: Record<string, string>;
} | {
    code: 505 | 'HTTP_VERSION_NOT_SUPPORTED';
    body: Response[505] extends ZodSchema ? z.infer<Response[505]> : never;
    headers?: Record<string, string>;
} | {
    code: 506 | 'VARIANT_ALSO_NEGOTIATES';
    body: Response[506] extends ZodSchema ? z.infer<Response[506]> : never;
    headers?: Record<string, string>;
} | {
    code: 507 | 'INSUFFICIENT_STORAGE';
    body: Response[507] extends ZodSchema ? z.infer<Response[507]> : never;
    headers?: Record<string, string>;
} | {
    code: 508 | 'LOOP_DETECTED';
    body: Response[508] extends ZodSchema ? z.infer<Response[508]> : never;
    headers?: Record<string, string>;
} | {
    code: 510 | 'NOT_EXTENDED';
    body: Response[510] extends ZodSchema ? z.infer<Response[510]> : never;
    headers?: Record<string, string>;
} | {
    code: 511 | 'NETWORK_AUTHENTICATION_REQUIRED';
    body: Response[511] extends ZodSchema ? z.infer<Response[511]> : never;
    headers?: Record<string, string>;
};
export declare function convertStatusCode(code: string | number): number;
//# sourceMappingURL=response.d.ts.map