// Generated by dts-bundle-generator v9.5.1 import { Static, TObject, TSchema } from '@sinclair/typebox'; import { Cookie, DocumentDecoration } from 'elysia'; import { Merge, Promisable, Simplify } from 'type-fest'; /** * Base context available in all procedures. */ export type Context = { /** The received HTTP request */ request: Request; cookie: Record>; }; /** * API documentation details for an action or procedure. */ export type Decorations = DocumentDecoration & Config; /** * Tracing configuration for an action or procedure. */ export type Config = { tracing?: { name?: string; attributes?: Record; }; }; /** * A utlity type that ensures a TObject (Next) does not have any overlapping properties with an opional reference TObject (Prev). */ export type SafeTObject = Prev extends TObject ? (Extract extends never ? Next : never) : Next; /** * A utility type that checks the properties of a TypeBox object schema. */ export type CheckProperties = T extends TObject ? T["properties"] : unknown; /** * A utility type that merges the properties of two TypeBox object schemas. * The second schema is optional and can be undefined. */ export type MergedProperties = Merge>; /** * A utility type that merges two TypeBox objects into one. * The next schema's properties will override the previous schema's properties. */ export type MergedObject = Next extends TObject ? TObject>> : Prev; /** * A utility type that merges the context of a procedure with an optional next context. * The next context can be an object or void. */ export type MergedContext = Simplify>; /** * Configuration arguments for creating a procedure. */ export type ProcedureArgs = { /** TypeBox schema for route parameters */ params: Params; /** TypeBox schema for query parameters */ query: Query; /** TypeBox schema for request body */ body: Body; /** Chain of middleware to execute before the main action handler */ middlewares: AnyMiddleware[]; /** Name of the procedure for identification */ name: string; /** Additional configuration for the procedure */ config: Config; }; /** * Arguments passed to procedure handler functions. */ export type ProcedureFnArgs = { /** Context object with request data and middleware results */ ctx: Simplify; /** Parsed and validated route parameters */ params: Params extends TObject ? Static : undefined; /** Parsed and validated query parameters */ query: Query extends TObject ? Static : undefined; /** Parsed and validated request body */ body: Body extends TObject ? Static : undefined; }; /** * Function type for procedure middleware functions. */ export type ProcedureFn = (input: ProcedureFnArgs) => Promisable; /** * Type alias for any middleware type. */ export type AnyMiddleware = Middleware; /** * Middleware class representing a function to run during request processing. * A middleware processes requests before they reach the main action handler. */ export declare class Middleware { private _id; private _handler; private _keys?; /** Name of the middleware for identification */ name: string; /** Additional configuration for the middleware */ config: Config; constructor(handler: ProcedureFn, name: string, config: Config, keys?: ProcedureFn); /** * Executes this middleware with the provided input * @param input - The current procedure arguments * @returns - The additional context created by the middleware to be merged into the procedure */ execute: (input: ProcedureFnArgs) => Promise; } /** * Builder class for creating procedures with a type-safe API. * Enables chaining methods to require parameters, query, body, and handlers. */ export declare class ProcedureBuilder { private _state; constructor(base: ProcedureArgs); /** * Creates a new builder with applied changes. * @param changes - Partial procedure configuration to apply * @returns A new ProcedureBuilder with updated configuration * @private */ private _apply; /** * Adds or merges route parameter definitions to the procedure. * @param params - The TypeBox schema defining the route parameters */ params: (params: SafeTObject) => ProcedureBuilder, Params>, Query, Body>; /** * Adds or merges query parameter definitions to the procedure. * @param query - The TypeBox schema defining the query parameters */ query: (query: SafeTObject) => ProcedureBuilder, Query>, Body>; /** * Adds or merges request body definitions to the procedure. * @param body - The TypeBox schema defining the request body */ body: (body: SafeTObject) => ProcedureBuilder, Body>>; /** * Adds cache keys to the procedure. * @param keys - The function to compute the cache keys */ cache: (keys: ProcedureFn) => ProcedureBuilder; /** * Builds this procedure with the given handler function. * @param handler - The function to execute when this procedure is called * @returns A built procedure with the given handler */ build: (handler?: ProcedureFn) => Procedure, Params, Query, Body>; } /** * A procedure acts as a base for creating actions. * It predefines and handles parameters, query, body, and middlewares. * The procedure can be extended to create more specific procedures * or used to create actions directly. */ export declare class Procedure { /** TypeBox schema for route parameters */ params: Params; /** TypeBox schema for query parameters */ query: Query; /** TypeBox schema for request body */ body: Body; /** Chain of middleware to execute before the main action handler */ middlewares: AnyMiddleware[]; constructor(base: ProcedureArgs); /** * Creates a new action from this procedure. * @param name - Name of the action for identification * @param details - API documentation details for the action * @returns A new ActionBuilder instance */ createAction: (name: string, details?: Decorations) => ActionBuilder; } /** * Creates a new procedure builder with typed params, query, and body. * * @param name - Descriptive name for the procedure (used in logs and debugging) * @param base - Optional base procedure to inherit from * @param role - Optional role for authorization purposes * * @example * ```ts * const userProcedure = createProcedure('User Authentication') * .params(Type.Object({ * id: Type.String() * })) * .handler(({ params }) => ({ * user: { * id: params.id, * name: "John Doe" * } * })) * ``` */ export declare const createProcedure: (name: string, base?: Procedure, config?: Config) => ProcedureBuilder; /** * Configuration arguments for creating an action builder. */ export type ActionBuilderArgs = { /** TypeBox schema for route parameters */ params: Params; /** TypeBox schema for query parameters */ query: Query; /** TypeBox schema for request body */ body: Body; /** TypeBox schema for response output */ output: Output; /** Chain of middleware to execute before the action's main handler function */ middlewares: AnyMiddleware[]; /** Name of the action for identification */ name: string; /** API documentation details for the action */ details?: Decorations; }; /** * Configuration arguments for creating an action. */ export type ActionArgs = ActionBuilderArgs & { /** The main handler function of the action */ handler: ActionFn; }; /** * Function type for action's main handler functions. */ export type ActionFn : any> = (input: ProcedureFnArgs) => Promisable; declare class ActionBuilder { private _state; constructor(base: ActionBuilderArgs); /** * Creates a new builder with applied changes. * @param changes - Partial action configuration to apply * @returns A new ActionBuilder with updated configuration * @private */ private _apply; /** * Adds or merges route parameter definitions to the action. * @param params - The TypeBox schema defining the route parameters */ params: (params: SafeTObject) => ActionBuilder, Params>, Query, Body, Output>; /** * Adds or merges query parameter definitions to the action. * @param query - The TypeBox schema defining the query parameters */ query: (query: SafeTObject) => ActionBuilder, Query>, Body, Output>; /** * Adds or merges request body definitions to the action. * @param body - The TypeBox schema defining the request body */ body: (body: SafeTObject) => ActionBuilder, Body>, Output>; /** * Adds response output definitions to the action. * @param output - The TypeBox schema defining the reponse output */ output: (output: T) => ActionBuilder; /** * Builds this action with the given handler function. * @param handler - The function to execute when this action is called * @returns A built action with the given handler */ build: (handler: ActionFn : Out>) => Action; } declare class Action { private _handler; private _middlewares; /** Name of the action for identification */ name: string; /** API documentation details for the action */ details?: Decorations; /** TypeBox schema for route parameters */ params: Params; /** TypeBox schema for query parameters */ query: Query; /** TypeBox schema for request body */ body: Body; /** TypeBox schema for response output */ output: Output; constructor(input: ActionArgs); /** * The API documentation for the action in Elysia route handler format. */ get docs(): { params: any; query: Query; body: Body; response: Output; detail: { hide?: boolean; tags?: string[]; summary: string; description?: string; externalDocs?: import("openapi-types").OpenAPIV3.ExternalDocumentationObject; operationId: string; parameters?: (import("openapi-types").OpenAPIV3.ReferenceObject | import("openapi-types").OpenAPIV3.ParameterObject)[]; requestBody?: import("openapi-types").OpenAPIV3.ReferenceObject | import("openapi-types").OpenAPIV3.RequestBodyObject; responses?: import("openapi-types").OpenAPIV3.ResponsesObject | undefined; callbacks?: { [callback: string]: import("openapi-types").OpenAPIV3.ReferenceObject | import("openapi-types").OpenAPIV3.CallbackObject; }; deprecated?: boolean; security?: import("openapi-types").OpenAPIV3.SecurityRequirementObject[]; servers?: import("openapi-types").OpenAPIV3.ServerObject[]; tracing?: { name?: string; attributes?: Record; }; }; }; /** * Elysia handler for the action * * This method does not validate the inputs, as Elysia REST's handlers will do it for us with nicer errors. * Do not use this method outside of Elysia's REST handlers. * @param context The Elysia context * @returns */ handle: (context: Context & { params: Params extends TObject ? Static : any; query: Query extends TObject ? Static : any; body: Body extends TObject ? Static : any; }) => Promise; /** * General handler for the action * @param request The HTTP request * @param input The inputs for the action * @returns */ run: (ctx: Context, input: { params: Params extends TObject ? Static : any; query: Query extends TObject ? Static : any; body: Body extends TObject ? Static : any; }) => Promise; private _execute; } export {};