better-call 1.3.3 → 2.0.0-beta.2

package/dist/context.d.cts

@@ -1,341 +1,147 @@
-import { InferParamPath, InferParamWildCard, IsEmptyObject, Prettify, UnionToIntersection } from "./helper.cjs";
-import { StandardSchemaV1 } from "./standard-schema.cjs";
-import { Status, statusCodes } from "./error.cjs";
 import { CookieOptions, CookiePrefixOptions } from "./cookies.cjs";
-import { Middleware, MiddlewareOptions } from "./middleware.cjs";
-import { EndpointOptions } from "./endpoint.cjs";
+import { APIError, Status, statusCodes } from "./error.cjs";
+import { Prettify } from "./helper.cjs";
+import { InferParam, InferUse, ResolveBody, ResolveMethod, ResolveQuery } from "./types.cjs";
+import { Middleware } from "./middleware.cjs";
 
 //#region src/context.d.ts
-type HTTPMethod = "GET" | "POST" | "PUT" | "DELETE" | "PATCH";
-type Method = HTTPMethod | "*";
-type InferBodyInput<Options extends EndpointOptions | MiddlewareOptions, Body = (Options["metadata"] extends {
-  $Infer: {
-    body: infer B;
-  };
-} ? B : Options["body"] extends StandardSchemaV1 ? StandardSchemaV1.InferInput<Options["body"]> : undefined)> = undefined extends Body ? {
-  body?: Body;
-} : {
-  body: Body;
-};
-type InferBody<Options extends EndpointOptions | MiddlewareOptions> = Options["metadata"] extends {
-  $Infer: {
-    body: infer Body;
-  };
-} ? Body : Options["body"] extends StandardSchemaV1 ? StandardSchemaV1.InferOutput<Options["body"]> : any;
-type InferQueryInput<Options extends EndpointOptions | MiddlewareOptions, Query = (Options["metadata"] extends {
-  $Infer: {
-    query: infer Query;
-  };
-} ? Query : Options["query"] extends StandardSchemaV1 ? StandardSchemaV1.InferInput<Options["query"]> : Record<string, any> | undefined)> = undefined extends Query ? {
-  query?: Query;
-} : {
-  query: Query;
-};
-type InferQuery<Options extends EndpointOptions | MiddlewareOptions> = Options["metadata"] extends {
-  $Infer: {
-    query: infer Query;
-  };
-} ? Query : Options["query"] extends StandardSchemaV1 ? StandardSchemaV1.InferOutput<Options["query"]> : Record<string, any> | undefined;
-type InferMethod<Options extends EndpointOptions> = Options["method"] extends Array<Method> ? Options["method"][number] : Options["method"] extends "*" ? HTTPMethod : Options["method"];
-type InferInputMethod<Options extends EndpointOptions, Method = (Options["method"] extends Array<any> ? Options["method"][number] | undefined : Options["method"] extends "*" ? HTTPMethod : Options["method"] | undefined)> = undefined extends Method ? {
-  method?: Method;
-} : {
-  method: Method;
-};
-type InferParam<Path extends string> = [Path] extends [never] ? Record<string, any> | undefined : IsEmptyObject<InferParamPath<Path> & InferParamWildCard<Path>> extends true ? Record<string, any> | undefined : Prettify<InferParamPath<Path> & InferParamWildCard<Path>>;
-type InferParamInput<Path extends string> = [Path] extends [never] ? {
-  params?: Record<string, any>;
-} : IsEmptyObject<InferParamPath<Path> & InferParamWildCard<Path>> extends true ? {
-  params?: Record<string, any>;
-} : {
-  params: Prettify<InferParamPath<Path> & InferParamWildCard<Path>>;
-};
-type InferRequest<Option extends EndpointOptions | MiddlewareOptions> = Option["requireRequest"] extends true ? Request : Request | undefined;
-type InferRequestInput<Option extends EndpointOptions | MiddlewareOptions> = Option["requireRequest"] extends true ? {
-  request: Request;
-} : {
-  request?: Request;
-};
-type InferHeaders<Option extends EndpointOptions | MiddlewareOptions> = Option["requireHeaders"] extends true ? Headers : Headers | undefined;
-type InferHeadersInput<Option extends EndpointOptions | MiddlewareOptions> = Option["requireHeaders"] extends true ? {
-  headers: HeadersInit;
-} : {
-  headers?: HeadersInit;
-};
-type InferUse<Opts extends EndpointOptions["use"]> = Opts extends Middleware[] ? UnionToIntersection<Awaited<ReturnType<Opts[number]>>> : {};
-type InferMiddlewareBody<Options extends MiddlewareOptions> = Options["body"] extends StandardSchemaV1<infer T> ? T : any;
-type InferMiddlewareQuery<Options extends MiddlewareOptions> = Options["query"] extends StandardSchemaV1<infer T> ? T : Record<string, any> | undefined;
-type InputContext<Path extends string, Options extends EndpointOptions> = InferBodyInput<Options> & InferInputMethod<Options> & InferQueryInput<Options> & InferParamInput<Path> & InferRequestInput<Options> & InferHeadersInput<Options> & {
-  asResponse?: boolean;
-  returnHeaders?: boolean;
-  returnStatus?: boolean;
-  use?: Middleware[];
-  path?: string;
-  context?: Record<string, any>;
-};
-declare const createInternalContext: (context: InputContext<any, any>, {
-  options,
-  path
-}: {
-  options: EndpointOptions;
-  path?: string;
-}) => Promise<{
-  body: any;
-  query: any;
-  path: string;
-  context: Record<string, any>;
-  returned: any;
-  headers: HeadersInit | undefined;
-  request: Request | undefined;
-  params: Record<string, any> | undefined;
-  method: any;
+type EndpointContext<Path extends string, M, BodySchema extends object | undefined, QuerySchema extends object | undefined, Use extends Middleware[], ReqHeaders extends boolean, ReqRequest extends boolean, Context = {}, Meta = undefined> = {
+  /**
+   * Method
+   *
+   * The request method
+   */
+  method: ResolveMethod<M>;
+  /**
+   * Path
+   *
+   * The path of the endpoint
+   */
+  path: Path;
+  /**
+   * Body
+   *
+   * The body object will be the parsed JSON from the request and validated
+   * against the body schema if it exists.
+   */
+  body: ResolveBody<BodySchema, Meta>;
+  /**
+   * Query
+   *
+   * The query object will be the parsed query string from the request
+   * and validated against the query schema if it exists
+   */
+  query: ResolveQuery<QuerySchema, Meta>;
+  /**
+   * Params
+   *
+   * If the path is `/user/:id` and the request is `/user/1` then the params will
+   * be `{ id: "1" }` and if the path includes a wildcard like `/user/*` then the
+   * params will be `{ _: "1" }` where `_` is the wildcard key. If the wildcard
+   * is named like `/user/**:name` then the params will be `{ name: string }`
+   */
+  params: InferParam<Path>;
+  /**
+   * Request object
+   *
+   * If `requireRequest` is set to true in the endpoint options this will be
+   * required
+   */
+  request: ReqRequest extends true ? Request : Request | undefined;
+  /**
+   * Headers
+   *
+   * If `requireHeaders` is set to true in the endpoint options this will be
+   * required
+   */
+  headers: ReqHeaders extends true ? Headers : Headers | undefined;
+  /**
+   * Set header
+   *
+   * If it's called outside of a request it will just be ignored.
+   */
   setHeader: (key: string, value: string) => void;
-  getHeader: (key: string) => string | null;
-  getCookie: (key: string, prefix?: CookiePrefixOptions) => string | null;
-  getSignedCookie: (key: string, secret: string, prefix?: CookiePrefixOptions) => Promise<string | false | null>;
-  setCookie: (key: string, value: string, options?: CookieOptions) => string;
-  setSignedCookie: (key: string, value: string, secret: string, options?: CookieOptions) => Promise<string>;
-  redirect: (url: string) => {
-    status: keyof typeof statusCodes | Status;
-    body: ({
-      message?: string;
-      code?: string;
-      cause?: unknown;
-    } & Record<string, any>) | undefined;
-    headers: HeadersInit;
-    statusCode: number;
-    name: string;
-    message: string;
-    stack?: string;
-    cause?: unknown;
-  } & {
-    errorStack: string | undefined;
-  };
-  error: (status: keyof typeof statusCodes | Status, body?: {
-    message?: string;
-    code?: string;
-  } | undefined, headers?: HeadersInit) => {
-    status: keyof typeof statusCodes | Status;
-    body: ({
-      message?: string;
-      code?: string;
-      cause?: unknown;
-    } & Record<string, any>) | undefined;
-    headers: HeadersInit;
-    statusCode: number;
-    name: string;
-    message: string;
-    stack?: string;
-    cause?: unknown;
-  } & {
-    errorStack: string | undefined;
-  };
+  /**
+   * Set the response status code
+   */
   setStatus: (status: Status) => void;
-  json: (json: Record<string, any>, routerResponse?: {
-    status?: number;
-    headers?: Record<string, string>;
-    response?: Response;
-    body?: Record<string, any>;
-  } | Response) => Record<string, any>;
-  responseHeaders: Headers;
-  responseStatus: Status | undefined;
-  asResponse?: boolean;
-  returnHeaders?: boolean;
-  returnStatus?: boolean;
-  use?: Middleware[];
-} | {
-  body: any;
-  query: any;
-  path: string;
-  context: Record<string, any>;
-  returned: any;
-  headers: HeadersInit | undefined;
-  request: Request | undefined;
-  params: Record<string, any> | undefined;
-  method: any;
-  setHeader: (key: string, value: string) => void;
+  /**
+   * Get header
+   *
+   * If it's called outside of a request it will just return null
+   *
+   * @param key - The key of the header
+   */
   getHeader: (key: string) => string | null;
+  /**
+   * Get a cookie value from the request
+   *
+   * @param key - The key of the cookie
+   * @param prefix - The prefix of the cookie between `__Secure-` and `__Host-`
+   * @returns The value of the cookie
+   */
   getCookie: (key: string, prefix?: CookiePrefixOptions) => string | null;
-  getSignedCookie: (key: string, secret: string, prefix?: CookiePrefixOptions) => Promise<string | false | null>;
+  /**
+   * Get a signed cookie value from the request
+   *
+   * @param key - The key of the cookie
+   * @param secret - The secret of the signed cookie
+   * @param prefix - The prefix of the cookie between `__Secure-` and `__Host-`
+   * @returns The value of the cookie or null if the cookie is not found or false if the signature is invalid
+   */
+  getSignedCookie: (key: string, secret: string, prefix?: CookiePrefixOptions) => Promise<string | null | false>;
+  /**
+   * Set a cookie value in the response
+   *
+   * @param key - The key of the cookie
+   * @param value - The value to set
+   * @param options - The options of the cookie
+   * @returns The cookie string
+   */
   setCookie: (key: string, value: string, options?: CookieOptions) => string;
+  /**
+   * Set signed cookie
+   *
+   * @param key - The key of the cookie
+   * @param value - The value to set
+   * @param secret - The secret to sign the cookie with
+   * @param options - The options of the cookie
+   * @returns The cookie string
+   */
   setSignedCookie: (key: string, value: string, secret: string, options?: CookieOptions) => Promise<string>;
-  redirect: (url: string) => {
-    status: keyof typeof statusCodes | Status;
-    body: ({
-      message?: string;
-      code?: string;
-      cause?: unknown;
-    } & Record<string, any>) | undefined;
-    headers: HeadersInit;
-    statusCode: number;
-    name: string;
-    message: string;
-    stack?: string;
-    cause?: unknown;
-  } & {
-    errorStack: string | undefined;
-  };
-  error: (status: keyof typeof statusCodes | Status, body?: {
-    message?: string;
-    code?: string;
-  } | undefined, headers?: HeadersInit) => {
-    status: keyof typeof statusCodes | Status;
-    body: ({
-      message?: string;
-      code?: string;
-      cause?: unknown;
-    } & Record<string, any>) | undefined;
-    headers: HeadersInit;
-    statusCode: number;
-    name: string;
-    message: string;
-    stack?: string;
-    cause?: unknown;
-  } & {
-    errorStack: string | undefined;
-  };
-  setStatus: (status: Status) => void;
-  json: (json: Record<string, any>, routerResponse?: {
+  /**
+   * JSON
+   *
+   * A helper function to create a JSON response with the correct headers
+   * and status code. If `asResponse` is set to true in the context then
+   * it will return a Response object instead of the JSON object.
+   *
+   * @param json - The JSON object to return
+   * @param routerResponse - The response object to return if `asResponse` is
+   * true in the context this will take precedence
+   */
+  json: <R extends Record<string, any> | null>(json: R, routerResponse?: {
     status?: number;
     headers?: Record<string, string>;
     response?: Response;
     body?: Record<string, any>;
-  } | Response) => Record<string, any>;
-  responseHeaders: Headers;
-  responseStatus: Status | undefined;
-  asResponse?: boolean;
-  returnHeaders?: boolean;
-  returnStatus?: boolean;
-  use?: Middleware[];
-} | {
-  body: any;
-  query: any;
-  path: string;
-  context: Record<string, any>;
-  returned: any;
-  headers: HeadersInit | undefined;
-  request: Request | undefined;
-  params: Record<string, any> | undefined;
-  method: any;
-  setHeader: (key: string, value: string) => void;
-  getHeader: (key: string) => string | null;
-  getCookie: (key: string, prefix?: CookiePrefixOptions) => string | null;
-  getSignedCookie: (key: string, secret: string, prefix?: CookiePrefixOptions) => Promise<string | false | null>;
-  setCookie: (key: string, value: string, options?: CookieOptions) => string;
-  setSignedCookie: (key: string, value: string, secret: string, options?: CookieOptions) => Promise<string>;
-  redirect: (url: string) => {
-    status: keyof typeof statusCodes | Status;
-    body: ({
-      message?: string;
-      code?: string;
-      cause?: unknown;
-    } & Record<string, any>) | undefined;
-    headers: HeadersInit;
-    statusCode: number;
-    name: string;
-    message: string;
-    stack?: string;
-    cause?: unknown;
-  } & {
-    errorStack: string | undefined;
-  };
+  } | Response) => R;
+  /**
+   * Middleware context
+   */
+  context: 0 extends 1 & Use ? Prettify<Context> : Prettify<Context & InferUse<Use>>;
+  /**
+   * Redirect to a new URL
+   */
+  redirect: (url: string) => APIError;
+  /**
+   * Return error
+   */
   error: (status: keyof typeof statusCodes | Status, body?: {
     message?: string;
     code?: string;
-  } | undefined, headers?: HeadersInit) => {
-    status: keyof typeof statusCodes | Status;
-    body: ({
-      message?: string;
-      code?: string;
-      cause?: unknown;
-    } & Record<string, any>) | undefined;
-    headers: HeadersInit;
-    statusCode: number;
-    name: string;
-    message: string;
-    stack?: string;
-    cause?: unknown;
-  } & {
-    errorStack: string | undefined;
-  };
-  setStatus: (status: Status) => void;
-  json: (json: Record<string, any>, routerResponse?: {
-    status?: number;
-    headers?: Record<string, string>;
-    response?: Response;
-    body?: Record<string, any>;
-  } | Response) => Record<string, any>;
-  responseHeaders: Headers;
-  responseStatus: Status | undefined;
-  asResponse?: boolean;
-  returnHeaders?: boolean;
-  returnStatus?: boolean;
-  use?: Middleware[];
-} | {
-  body: any;
-  query: any;
-  path: string;
-  context: Record<string, any>;
-  returned: any;
-  headers: HeadersInit | undefined;
-  request: Request | undefined;
-  params: Record<string, any> | undefined;
-  method: any;
-  setHeader: (key: string, value: string) => void;
-  getHeader: (key: string) => string | null;
-  getCookie: (key: string, prefix?: CookiePrefixOptions) => string | null;
-  getSignedCookie: (key: string, secret: string, prefix?: CookiePrefixOptions) => Promise<string | false | null>;
-  setCookie: (key: string, value: string, options?: CookieOptions) => string;
-  setSignedCookie: (key: string, value: string, secret: string, options?: CookieOptions) => Promise<string>;
-  redirect: (url: string) => {
-    status: keyof typeof statusCodes | Status;
-    body: ({
-      message?: string;
-      code?: string;
-      cause?: unknown;
-    } & Record<string, any>) | undefined;
-    headers: HeadersInit;
-    statusCode: number;
-    name: string;
-    message: string;
-    stack?: string;
-    cause?: unknown;
-  } & {
-    errorStack: string | undefined;
-  };
-  error: (status: keyof typeof statusCodes | Status, body?: {
-    message?: string;
-    code?: string;
-  } | undefined, headers?: HeadersInit) => {
-    status: keyof typeof statusCodes | Status;
-    body: ({
-      message?: string;
-      code?: string;
-      cause?: unknown;
-    } & Record<string, any>) | undefined;
-    headers: HeadersInit;
-    statusCode: number;
-    name: string;
-    message: string;
-    stack?: string;
-    cause?: unknown;
-  } & {
-    errorStack: string | undefined;
-  };
-  setStatus: (status: Status) => void;
-  json: (json: Record<string, any>, routerResponse?: {
-    status?: number;
-    headers?: Record<string, string>;
-    response?: Response;
-    body?: Record<string, any>;
-  } | Response) => Record<string, any>;
-  responseHeaders: Headers;
-  responseStatus: Status | undefined;
-  asResponse?: boolean;
-  returnHeaders?: boolean;
-  returnStatus?: boolean;
-  use?: Middleware[];
-}>;
+  } & Record<string, any>, headers?: HeadersInit) => APIError;
+};
 //#endregion
-export { HTTPMethod, InferBody, InferBodyInput, InferHeaders, InferHeadersInput, InferInputMethod, InferMethod, InferMiddlewareBody, InferMiddlewareQuery, InferParam, InferParamInput, InferQuery, InferQueryInput, InferRequest, InferRequestInput, InferUse, InputContext, Method, createInternalContext };
+export { EndpointContext };
 //# sourceMappingURL=context.d.cts.map