better-call 0.2.13-beta.3 → 0.2.13-beta.4

package/dist/shared/{better-call.b80bf494.d.ts → better-call.7c5f7404.d.ts}

@@ -1,42 +1,9 @@
-import { ZodSchema, ZodError } from 'zod';
+import { ZodTypeAny, z, ZodSchema, ZodObject, ZodOptional, ZodError } from 'zod';
+import { ZodOpenApiFullMetadata, ZodOpenAPIMetadata } from '@asteasolutions/zod-to-openapi/dist/zod-extensions';
+import { ResponseConfig } from '@asteasolutions/zod-to-openapi';
+import * as _asteasolutions_zod_to_openapi_dist_openapi_registry from '@asteasolutions/zod-to-openapi/dist/openapi-registry';
 import { BufferSource } from 'stream/web';
 
-type Cookie = Record<string, string>;
-type SignedCookie = Record<string, string | false>;
-type PartitionCookieConstraint = {
-    partition: true;
-    secure: true;
-} | {
-    partition?: boolean;
-    secure?: boolean;
-};
-type SecureCookieConstraint = {
-    secure: true;
-};
-type HostCookieConstraint = {
-    secure: true;
-    path: "/";
-    domain?: undefined;
-};
-type CookieOptions = {
-    domain?: string;
-    expires?: Date;
-    httpOnly?: boolean;
-    maxAge?: number;
-    path?: string;
-    secure?: boolean;
-    signingSecret?: string;
-    sameSite?: "Strict" | "Lax" | "None" | "strict" | "lax" | "none";
-    partitioned?: boolean;
-    prefix?: CookiePrefixOptions;
-} & PartitionCookieConstraint;
-type CookiePrefixOptions = "host" | "secure";
-type CookieConstraint<Name> = Name extends `__Secure-${string}` ? CookieOptions & SecureCookieConstraint : Name extends `__Host-${string}` ? CookieOptions & HostCookieConstraint : CookieOptions;
-declare const parse: (cookie: string, name?: string) => Cookie;
-declare const parseSigned: (cookie: string, secret: string | BufferSource, name?: string) => Promise<SignedCookie>;
-declare const serialize: <Name extends string>(name: Name, value: string, opt?: CookieConstraint<Name>) => string;
-declare const serializeSigned: (name: string, value: string, secret: string | BufferSource, opt?: CookieOptions) => Promise<string>;
-
 /**
  * Improve this type if possible
  */
@@ -55,6 +22,15 @@ type Prettify<T> = {
 type IsEmptyObject<T> = keyof T extends never ? true : false;
 type UnionToIntersection<Union> = (Union extends unknown ? (distributedUnion: Union) => void : never) extends (mergedIntersection: infer Intersection) => void ? Intersection & Union : never;
 
+declare module "zod" {
+    interface ZodTypeDef {
+        openapi?: ZodOpenApiFullMetadata;
+    }
+    interface ZodType<Output = any, Def extends ZodTypeDef = ZodTypeDef, Input = Output> {
+        openapi<T extends ZodTypeAny>(this: T, metadata: Partial<ZodOpenAPIMetadata<z.input<T>>>): T;
+        openapi<T extends ZodTypeAny>(this: T, refId: string, metadata?: Partial<ZodOpenAPIMetadata<z.input<T>>>): T;
+    }
+}
 type Method = "GET" | "POST" | "PUT" | "DELETE" | "*";
 interface EndpointOptions {
     /**
@@ -68,7 +44,7 @@ interface EndpointOptions {
     /**
      * Query Schema
      */
-    query?: ZodSchema;
+    query?: ZodObject<any> | ZodOptional<ZodObject<any>>;
     /**
      * If true headers will be required to be passed in the context
      */
@@ -85,6 +61,14 @@ interface EndpointOptions {
      * Middleware to use
      */
     use?: Endpoint[];
+    /**
+     * OpenAPI metadata
+     */
+    openAPI?: {
+        responses: {
+            [statusCode: string]: ResponseConfig;
+        };
+    };
 }
 type InferBody<Options extends EndpointOptions> = Options["body"] extends ZodSchema<infer T> ? T : never;
 type InferQuery<Options extends EndpointOptions> = Options["query"] extends ZodSchema<infer T> ? T : never;
@@ -104,6 +88,42 @@ type InferHeaders<Option extends EndpointOptions> = Option["requireHeaders"] ext
 type InferUse<Opts extends EndpointOptions["use"]> = Opts extends Endpoint[] ? UnionToIntersection<Awaited<ReturnType<Opts[number]>>> : never;
 type InferMethod<Options extends EndpointOptions> = Options["method"] extends Array<Method> ? Options["method"][number] : Options["method"];
 
+type Cookie = Record<string, string>;
+type SignedCookie = Record<string, string | false>;
+type PartitionCookieConstraint = {
+    partition: true;
+    secure: true;
+} | {
+    partition?: boolean;
+    secure?: boolean;
+};
+type SecureCookieConstraint = {
+    secure: true;
+};
+type HostCookieConstraint = {
+    secure: true;
+    path: "/";
+    domain?: undefined;
+};
+type CookieOptions = {
+    domain?: string;
+    expires?: Date;
+    httpOnly?: boolean;
+    maxAge?: number;
+    path?: string;
+    secure?: boolean;
+    signingSecret?: string;
+    sameSite?: "Strict" | "Lax" | "None" | "strict" | "lax" | "none";
+    partitioned?: boolean;
+    prefix?: CookiePrefixOptions;
+} & PartitionCookieConstraint;
+type CookiePrefixOptions = "host" | "secure";
+type CookieConstraint<Name> = Name extends `__Secure-${string}` ? CookieOptions & SecureCookieConstraint : Name extends `__Host-${string}` ? CookieOptions & HostCookieConstraint : CookieOptions;
+declare const parse: (cookie: string, name?: string) => Cookie;
+declare const parseSigned: (cookie: string, secret: string | BufferSource, name?: string) => Promise<SignedCookie>;
+declare const serialize: <Name extends string>(name: Name, value: string, opt?: CookieConstraint<Name>) => string;
+declare const serializeSigned: (name: string, value: string, secret: string | BufferSource, opt?: CookieOptions) => Promise<string>;
+
 declare class APIError extends Error {
     message: string;
     status: number;
@@ -257,21 +277,6 @@ type EndpointResponse = JSONResponse | Response | void | Record<string, any>;
 type InferResponse<Ctx, R> = Ctx extends {
     asResponse: true;
 } ? Response : R extends JSONResponse<infer T> ? T : R;
-declare function createJSON({ asResponse }: {
-    asResponse?: boolean;
-}): <R extends Record<string, any>>(json: R, routerResponse?: {
-    status?: number;
-    headers?: Record<string, string>;
-    response?: Response;
-}) => Promise<R | {
-    body: R;
-    routerResponse: {
-        status?: number;
-        headers?: Record<string, string>;
-        response?: Response;
-    } | undefined;
-    _flag: string;
-}>;
 type ValidationResponse = {
     data: {
         body: any;
@@ -289,10 +294,282 @@ declare function fromError(error: ZodError): {
     message: string;
 };
 
-declare const createEndpoint: <Path extends string, Options extends EndpointOptions, R extends EndpointResponse>(path: Path, options: Options, handler: (context: EndpointContext<Path, Options>) => Promise<R>) => {
-    <Ctx extends Context<Path, Options>>(...inputCtx: HasRequiredKeys<Ctx> extends true ? [Ctx] : [Ctx?]): Promise<Ctx["asResponse"] extends true ? Response : R>;
+declare const createEndpoint: {
+    <Path extends string, Options extends EndpointOptions, R extends EndpointResponse>(path: Path, options: Options, handler: (context: EndpointContext<Path, Options>) => Promise<R>): {
+        <Ctx extends Context<Path, Options>>(...inputCtx: HasRequiredKeys<Ctx> extends true ? [Ctx] : [Ctx?]): Promise<Ctx["asResponse"] extends true ? Response : R>;
+        path: Path;
+        options: Options;
+        openAPI: {
+            definitions: _asteasolutions_zod_to_openapi_dist_openapi_registry.OpenAPIDefinitions[];
+        };
+    };
+    creator: typeof createEndpointCreator;
+};
+declare function createEndpointCreator<E extends {
+    use: Endpoint[];
+}>(opts: E): <Path extends string, Opts extends EndpointOptions, R extends EndpointResponse>(path: Path, options: Opts, handler: <InferE extends EndpointContext<Path, Opts>>(ctx: Omit<InferE, "context"> & {
+    context: InferUse<E["use"]> & (InferE["context"] extends never ? {} : InferE["context"]);
+}) => Promise<R>) => {
+    <Ctx extends ({
+        body: InferBody<Opts & {
+            use: Endpoint[];
+        }>;
+        method?: InferMethod<Opts & {
+            use: Endpoint[];
+        }> | undefined;
+        query: InferQuery<Opts & {
+            use: Endpoint[];
+        }>;
+        params: InferParam<Path>;
+        request: InferRequest<Opts & {
+            use: Endpoint[];
+        }>;
+        headers: InferHeaders<Opts & {
+            use: Endpoint[];
+        }>;
+        asResponse?: boolean;
+    } extends infer T_1 ? { [K_1 in keyof T_1 as {
+        body: InferBody<Opts & {
+            use: Endpoint[];
+        }>;
+        method?: InferMethod<Opts & {
+            use: Endpoint[];
+        }> | undefined;
+        query: InferQuery<Opts & {
+            use: Endpoint[];
+        }>;
+        params: InferParam<Path>;
+        request: InferRequest<Opts & {
+            use: Endpoint[];
+        }>;
+        headers: InferHeaders<Opts & {
+            use: Endpoint[];
+        }>;
+        asResponse?: boolean;
+    }[K_1] extends never ? never : undefined extends {
+        body: InferBody<Opts & {
+            use: Endpoint[];
+        }>;
+        method?: InferMethod<Opts & {
+            use: Endpoint[];
+        }> | undefined;
+        query: InferQuery<Opts & {
+            use: Endpoint[];
+        }>;
+        params: InferParam<Path>;
+        request: InferRequest<Opts & {
+            use: Endpoint[];
+        }>;
+        headers: InferHeaders<Opts & {
+            use: Endpoint[];
+        }>;
+        asResponse?: boolean;
+    }[K_1] ? never : K_1]: {
+        body: InferBody<Opts & {
+            use: Endpoint[];
+        }>;
+        method?: InferMethod<Opts & {
+            use: Endpoint[];
+        }> | undefined;
+        query: InferQuery<Opts & {
+            use: Endpoint[];
+        }>;
+        params: InferParam<Path>;
+        request: InferRequest<Opts & {
+            use: Endpoint[];
+        }>;
+        headers: InferHeaders<Opts & {
+            use: Endpoint[];
+        }>;
+        asResponse?: boolean;
+    }[K_1]; } : never) & ({
+        body: InferBody<Opts & {
+            use: Endpoint[];
+        }>;
+        method?: InferMethod<Opts & {
+            use: Endpoint[];
+        }> | undefined;
+        query: InferQuery<Opts & {
+            use: Endpoint[];
+        }>;
+        params: InferParam<Path>;
+        request: InferRequest<Opts & {
+            use: Endpoint[];
+        }>;
+        headers: InferHeaders<Opts & {
+            use: Endpoint[];
+        }>;
+        asResponse?: boolean;
+    } extends infer T_2 ? { [K_2 in keyof T_2 as undefined extends {
+        body: InferBody<Opts & {
+            use: Endpoint[];
+        }>;
+        method?: InferMethod<Opts & {
+            use: Endpoint[];
+        }> | undefined;
+        query: InferQuery<Opts & {
+            use: Endpoint[];
+        }>;
+        params: InferParam<Path>;
+        request: InferRequest<Opts & {
+            use: Endpoint[];
+        }>;
+        headers: InferHeaders<Opts & {
+            use: Endpoint[];
+        }>;
+        asResponse?: boolean;
+    }[K_2] ? K_2 : never]?: {
+        body: InferBody<Opts & {
+            use: Endpoint[];
+        }>;
+        method?: InferMethod<Opts & {
+            use: Endpoint[];
+        }> | undefined;
+        query: InferQuery<Opts & {
+            use: Endpoint[];
+        }>;
+        params: InferParam<Path>;
+        request: InferRequest<Opts & {
+            use: Endpoint[];
+        }>;
+        headers: InferHeaders<Opts & {
+            use: Endpoint[];
+        }>;
+        asResponse?: boolean;
+    }[K_2] | undefined; } : never) extends infer T ? { [K in keyof T]: (({
+        body: InferBody<Opts & {
+            use: Endpoint[];
+        }>;
+        method?: InferMethod<Opts & {
+            use: Endpoint[];
+        }> | undefined;
+        query: InferQuery<Opts & {
+            use: Endpoint[];
+        }>;
+        params: InferParam<Path>;
+        request: InferRequest<Opts & {
+            use: Endpoint[];
+        }>;
+        headers: InferHeaders<Opts & {
+            use: Endpoint[];
+        }>;
+        asResponse?: boolean;
+    } extends infer T_1 ? { [K_1 in keyof T_1 as {
+        body: InferBody<Opts & {
+            use: Endpoint[];
+        }>;
+        method?: InferMethod<Opts & {
+            use: Endpoint[];
+        }> | undefined;
+        query: InferQuery<Opts & {
+            use: Endpoint[];
+        }>;
+        params: InferParam<Path>;
+        request: InferRequest<Opts & {
+            use: Endpoint[];
+        }>;
+        headers: InferHeaders<Opts & {
+            use: Endpoint[];
+        }>;
+        asResponse?: boolean;
+    }[K_1] extends never ? never : undefined extends {
+        body: InferBody<Opts & {
+            use: Endpoint[];
+        }>;
+        method?: InferMethod<Opts & {
+            use: Endpoint[];
+        }> | undefined;
+        query: InferQuery<Opts & {
+            use: Endpoint[];
+        }>;
+        params: InferParam<Path>;
+        request: InferRequest<Opts & {
+            use: Endpoint[];
+        }>;
+        headers: InferHeaders<Opts & {
+            use: Endpoint[];
+        }>;
+        asResponse?: boolean;
+    }[K_1] ? never : K_1]: {
+        body: InferBody<Opts & {
+            use: Endpoint[];
+        }>;
+        method?: InferMethod<Opts & {
+            use: Endpoint[];
+        }> | undefined;
+        query: InferQuery<Opts & {
+            use: Endpoint[];
+        }>;
+        params: InferParam<Path>;
+        request: InferRequest<Opts & {
+            use: Endpoint[];
+        }>;
+        headers: InferHeaders<Opts & {
+            use: Endpoint[];
+        }>;
+        asResponse?: boolean;
+    }[K_1]; } : never) & ({
+        body: InferBody<Opts & {
+            use: Endpoint[];
+        }>;
+        method?: InferMethod<Opts & {
+            use: Endpoint[];
+        }> | undefined;
+        query: InferQuery<Opts & {
+            use: Endpoint[];
+        }>;
+        params: InferParam<Path>;
+        request: InferRequest<Opts & {
+            use: Endpoint[];
+        }>;
+        headers: InferHeaders<Opts & {
+            use: Endpoint[];
+        }>;
+        asResponse?: boolean;
+    } extends infer T_2 ? { [K_2 in keyof T_2 as undefined extends {
+        body: InferBody<Opts & {
+            use: Endpoint[];
+        }>;
+        method?: InferMethod<Opts & {
+            use: Endpoint[];
+        }> | undefined;
+        query: InferQuery<Opts & {
+            use: Endpoint[];
+        }>;
+        params: InferParam<Path>;
+        request: InferRequest<Opts & {
+            use: Endpoint[];
+        }>;
+        headers: InferHeaders<Opts & {
+            use: Endpoint[];
+        }>;
+        asResponse?: boolean;
+    }[K_2] ? K_2 : never]?: {
+        body: InferBody<Opts & {
+            use: Endpoint[];
+        }>;
+        method?: InferMethod<Opts & {
+            use: Endpoint[];
+        }> | undefined;
+        query: InferQuery<Opts & {
+            use: Endpoint[];
+        }>;
+        params: InferParam<Path>;
+        request: InferRequest<Opts & {
+            use: Endpoint[];
+        }>;
+        headers: InferHeaders<Opts & {
+            use: Endpoint[];
+        }>;
+        asResponse?: boolean;
+    }[K_2] | undefined; } : never))[K]; } : never>(...inputCtx: HasRequiredKeys<Ctx> extends true ? [Ctx] : [(Ctx | undefined)?]): Promise<Ctx["asResponse"] extends true ? Response : R>;
     path: Path;
-    options: Options;
+    options: Opts & {
+        use: Endpoint[];
+    };
+    openAPI: {
+        definitions: _asteasolutions_zod_to_openapi_dist_openapi_registry.OpenAPIDefinitions[];
+    };
 };
 type Endpoint<Handler extends (ctx: any) => Promise<any> = (ctx: any) => Promise<any>, Options extends EndpointOptions = EndpointOptions> = {
     path: string;
@@ -338,4 +615,4 @@ declare const createRouter: <E extends Record<string, Endpoint>, Config extends
 };
 type Router = ReturnType<typeof createRouter>;
 
-export { type CookiePrefixOptions as C, type EndpointOptions as E, type HasRequiredKeys as H, type Input as I, type JSONResponse as J, type Prettify as P, type Router as R, type SignedCookie as S, type UnionToIntersection as U, type EndpointResponse as a, type Endpoint as b, type EndpointContext as c, type CookieOptions as d, createEndpoint as e, createRouter as f, type RequiredKeysOf as g, type IsEmptyObject as h, type Context as i, createSetHeader as j, createGetHeader as k, type InferResponse as l, createJSON as m, fromError as n, type Cookie as o, type CookieConstraint as p, parse as q, runValidation as r, parseSigned as s, serialize as t, serializeSigned as u };
+export { type CookiePrefixOptions as C, type EndpointOptions as E, type HasRequiredKeys as H, type InferUse as I, type JSONResponse as J, type Prettify as P, type Router as R, type SignedCookie as S, type UnionToIntersection as U, type EndpointResponse as a, type Endpoint as b, type EndpointContext as c, type CookieOptions as d, createEndpoint as e, createRouter as f, type Input as g, type RequiredKeysOf as h, type IsEmptyObject as i, type Context as j, createSetHeader as k, createGetHeader as l, type InferResponse as m, fromError as n, type Cookie as o, type CookieConstraint as p, parse as q, runValidation as r, parseSigned as s, serialize as t, serializeSigned as u };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "better-call",
-  "version": "0.2.13-beta.3",
+  "version": "0.2.13-beta.4",
   "description": "",
   "main": "./dist/index.cjs",
   "types": "./dist/index.d.ts",
@@ -29,6 +29,7 @@
     "zod": "^3.23.8"
   },
   "dependencies": {
+    "@asteasolutions/zod-to-openapi": "^7.2.0",
     "rou3": "^0.5.1",
     "uncrypto": "^0.1.3"
   },