@elysiumjs/core 0.8.0 → 0.11.0

package/dist/http.d.ts

@@ -1,6 +1,9 @@
-import type { Context as ElysiaContext, Handler, HTTPMethod, TSchema } from 'elysia';
+import type { Context as ElysiaContext } from 'elysia';
 import type { Class, MergeDeep } from 'type-fest';
+import type { Static, TSchema } from 'typebox';
 import type { AppHttpContext } from '.';
+import type { FilterClass } from './filter';
+import type { InterceptorClass } from './interceptor';
 import type { Module } from './module';
 import { Elysia } from 'elysia';
 /**
@@ -8,6 +11,16 @@ import { Elysia } from 'elysia';
  * @author Axel Nana <axel.nana@workbud.com>
  */
 export type Route = `/${string}`;
+/**
+ * An HTTP method name.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export type HTTPMethod = string;
+/**
+ * A function computing a value from the request context, used by custom parameter decorators.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+type Handler = (c: Context) => unknown;
 /**
  * A class for validating data against a schema.
  * @author Axel Nana <axel.nana@workbud.com>
@@ -22,14 +35,14 @@ export type ValidatorClass<T extends TSchema = TSchema> = {
      * Whether the request should be authorized before validation. If the request is not authorized,
      * the validation will be skipped.
      */
-    authorize(ctx: Context<T['static']>): Promise<boolean>;
+    authorize(ctx: Context<Static<T>>): Promise<boolean>;
     /**
      * Processes custom validation logic. This method is called after the validation schema is checked
      * against the input data. So it's safe to assume that the schema is valid.
      * @param data The input data to validate.
      * @returns Whether the input data is valid.
      */
-    validate(ctx: Context<T['static']>): Promise<boolean>;
+    validate(ctx: Context<Static<T>>): Promise<boolean>;
 };
 /**
  * Metadata for the HTTP context.
@@ -47,7 +60,7 @@ export type Singleton<TController = unknown, TModule extends Module = Module> =
          */
         module: TModule;
     };
-    resolve: {
+    derive: {
         /**
          * The tenant ID.
          */
@@ -61,7 +74,13 @@ export type Singleton<TController = unknown, TModule extends Module = Module> =
 export type Context<TBody = unknown, TController = unknown, TModule extends Module = Module> = ElysiaContext<{
     body: TBody;
 }, Singleton<TController, TModule>>;
-export type ElysiaApp = Elysia<Route, Singleton>;
+export type ElysiaApp = Elysia<Route, 'local', Singleton>;
+/**
+ * Name of the global service running a callback in a database transaction, used by
+ * `@transactional` handlers. Provided by database modules such as `DrizzleModule`.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export declare const DATABASE_TRANSACTION_SERVICE = "db.transaction";
 /**
  * The scope of an HTTP controller.
  * @author Axel Nana <axel.nana@workbud.com>
@@ -77,14 +96,10 @@ export declare enum HttpControllerScope {
     REQUEST = 1
 }
 /**
- * Properties required when declaring an HTTP controller using the `@http()` decorator.
+ * Options of `@Http.controller()`.
  * @author Axel Nana <axel.nana@workbud.com>
  */
-export type HttpControllerProps = {
-    /**
-     * The path of the HTTP route.
-     */
-    path: Route;
+export type HttpControllerOptions = {
     /**
      * The scope of the HTTP controller.
      * @default HttpControllerScope.SERVER
@@ -100,20 +115,30 @@ export type HttpControllerProps = {
      * for all the request handlers in this controller.
      */
     transactional?: boolean;
-};
-/**
- * Properties required when declaring an HTTP request handler.
- * @author Axel Nana <axel.nana@workbud.com>
- */
-export type RequestHandlerDecoratorProps = {
     /**
-     * The HTTP method of the handler.
+     * Exception filters for every route of the controller. They run after the filters of the route,
+     * and before those of the module and the app.
      */
-    method?: HTTPMethod;
+    filters?: FilterClass[];
     /**
-     * The path of the HTTP route.
+     * Interceptors around every handler of the controller, inside those of the module and the app,
+     * and outside those of the route.
      */
-    path?: Route;
+    interceptors?: InterceptorClass[];
+};
+/**
+ * What an HTTP controller records: its path and its options.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export type HttpControllerProps = HttpControllerOptions & {
+    /** The path of the controller. */
+    path: Route;
+};
+/**
+ * Options of the route decorators, such as `@Http.get()`.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export type HttpRouteOptions = {
     /**
      * The schema of the response body.
      */
@@ -133,76 +158,158 @@ export type RequestHandlerDecoratorProps = {
      * for this request handler.
      */
     transactional?: boolean;
+    /**
+     * Whether to serialize the handler result through the `response` schema: undeclared and hidden
+     * fields are stripped, dates become ISO strings, and `?fields=` selects fields. Defaults to
+     * `true` when the route has a `response` schema.
+     */
+    serialize?: boolean;
+    /** Exception filters for this route. They run before those of the controller. */
+    filters?: FilterClass[];
+    /** Interceptors around this handler, inside those of the controller. */
+    interceptors?: InterceptorClass[];
+};
+/**
+ * What a route decorator records: its method, its path and its options.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export type RequestHandlerDecoratorProps = HttpRouteOptions & {
+    /** The HTTP method of the handler. */
+    method?: HTTPMethod;
+    /** The path of the route, relative to the controller path. */
+    path?: Route;
+};
+/**
+ * A route of an HTTP controller, as `Http.describe()` reports it.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export type HttpRouteDescription = {
+    /** The name of the controller method handling the route. */
+    name: string;
+    /** The HTTP method, in upper case. Server-sent events routes use `GET`. */
+    method: string;
+    /** The path of the route, relative to the controller path. */
+    path: Route;
+    /** Whether the route streams server-sent events. */
+    sse: boolean;
+    /** The index of the method parameter receiving the request body. */
+    body?: number;
+    /** The index of the method parameter receiving the query. */
+    query?: number;
+    /** The method parameters receiving URL parameters. */
+    params: Array<{
+        slug: string;
+        index: number;
+    }>;
+};
+/**
+ * An HTTP controller, as `Http.describe()` reports it.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export type HttpControllerDescription = {
+    /** The path of the controller. */
+    path: Route;
+    /** The routes of the controller. */
+    routes: HttpRouteDescription[];
 };
 export declare namespace Http {
+    /**
+     * Describes the routes of an HTTP controller, for tools such as the route type generator.
+     * Route decorators register their routes on the next tick, so call it after importing the
+     * controller and awaiting a tick.
+     * @author Axel Nana <axel.nana@workbud.com>
+     * @param controller The controller class.
+     * @returns The description, or `undefined` when the class is not an HTTP controller.
+     */
+    const describe: (controller: Class<any>) => HttpControllerDescription | undefined;
     /**
      * Marks a class as an HTTP controller.
      * @author Axel Nana <axel.nana@workbud.com>
-     * @param props The decorator options.
+     * @param path The path of the controller. Defaults to `/`.
+     * @param options The options of the controller.
+     * @example
+     * ```ts
+     * @Http.controller('/wallets', { tags: ['wallets'] })
+     * class WalletController {}
+     * ```
      */
-    const controller: (props?: HttpControllerProps) => (target: Class<any>) => void;
+    const controller: (path?: Route, options?: HttpControllerOptions) => (target: Class<any>) => void;
     /**
      * Marks a method as an HTTP "server-sent events" request handler.
      * @author Axel Nana <axel.nana@workbud.com>
-     * @param props The request handler properties.
+     * @param path The path of the route, relative to the controller path. Defaults to `/`.
+     * @param options The options of the route.
      */
-    const sse: (props?: RequestHandlerDecoratorProps) => MethodDecorator;
+    const sse: (path?: Route, options?: HttpRouteOptions) => MethodDecorator;
     /**
      * Marks a method as an HTTP "get" request handler.
      * @author Axel Nana <axel.nana@workbud.com>
-     * @param props The request handler properties.
+     * @param path The path of the route, relative to the controller path. Defaults to `/`.
+     * @param options The options of the route.
+     * @example
+     * ```ts
+     * @Http.get('/:id', { response: WalletSchema })
+     * public show(@Http.param('id') id: string) {}
+     * ```
      */
-    const get: (props?: RequestHandlerDecoratorProps) => MethodDecorator;
+    const get: (path?: Route, options?: HttpRouteOptions) => MethodDecorator;
     /**
      * Marks a method as an HTTP "post" request handler.
      * @author Axel Nana <axel.nana@workbud.com>
-     * @param props The request handler properties.
+     * @param path The path of the route, relative to the controller path. Defaults to `/`.
+     * @param options The options of the route.
      */
-    const post: (props?: RequestHandlerDecoratorProps) => MethodDecorator;
+    const post: (path?: Route, options?: HttpRouteOptions) => MethodDecorator;
     /**
      * Marks a method as an HTTP "put" request handler.
      * @author Axel Nana <axel.nana@workbud.com>
-     * @param props The request handler properties.
+     * @param path The path of the route, relative to the controller path. Defaults to `/`.
+     * @param options The options of the route.
      */
-    const put: (props?: RequestHandlerDecoratorProps) => MethodDecorator;
+    const put: (path?: Route, options?: HttpRouteOptions) => MethodDecorator;
     /**
      * Marks a method as an HTTP "delete" request handler.
      * @author Axel Nana <axel.nana@workbud.com>
-     * @param props The request handler properties.
+     * @param path The path of the route, relative to the controller path. Defaults to `/`.
+     * @param options The options of the route.
      */
-    const del: (props?: RequestHandlerDecoratorProps) => MethodDecorator;
+    const del: (path?: Route, options?: HttpRouteOptions) => MethodDecorator;
     /**
      * Marks a method as an HTTP "patch" request handler.
      * @author Axel Nana <axel.nana@workbud.com>
-     * @param props The request handler properties.
+     * @param path The path of the route, relative to the controller path. Defaults to `/`.
+     * @param options The options of the route.
      */
-    const patch: (props?: RequestHandlerDecoratorProps) => MethodDecorator;
+    const patch: (path?: Route, options?: HttpRouteOptions) => MethodDecorator;
     /**
      * Marks a method as an HTTP "head" request handler.
      * @author Axel Nana <axel.nana@workbud.com>
-     * @param props The request handler properties.
+     * @param path The path of the route, relative to the controller path. Defaults to `/`.
+     * @param options The options of the route.
      */
-    const head: (props?: RequestHandlerDecoratorProps) => MethodDecorator;
+    const head: (path?: Route, options?: HttpRouteOptions) => MethodDecorator;
     /**
      * Marks a method as an HTTP "options" request handler.
      * @author Axel Nana <axel.nana@workbud.com>
-     * @param props The request handler properties.
+     * @param path The path of the route, relative to the controller path. Defaults to `/`.
+     * @param options The options of the route.
      */
-    const options: (props?: RequestHandlerDecoratorProps) => MethodDecorator;
+    const options: (path?: Route, options?: HttpRouteOptions) => MethodDecorator;
     /**
      * Marks a method as an HTTP "trace" request handler.
      * @author Axel Nana <axel.nana@workbud.com>
-     * @param props The request handler properties.
+     * @param path The path of the route, relative to the controller path. Defaults to `/`.
+     * @param options The options of the route.
      */
-    const trace: (props?: RequestHandlerDecoratorProps) => MethodDecorator;
+    const trace: (path?: Route, options?: HttpRouteOptions) => MethodDecorator;
     /**
      * Marks a method as an HTTP request handler with a custom method.
      * @author Axel Nana <axel.nana@workbud.com>
-     * @param props The request handler properties.
+     * @param method The HTTP method.
+     * @param path The path of the route, relative to the controller path. Defaults to `/`.
+     * @param options The options of the route.
      */
-    const custom: ({ path, ...rest }: RequestHandlerDecoratorProps & {
-        method: HTTPMethod;
-    }) => MethodDecorator;
+    const custom: (method: HTTPMethod, path?: Route, options?: HttpRouteOptions) => MethodDecorator;
     /**
      * Marks a method as the callback for the request handler.
      * @author Axel Nana <axel.nana@workbud.com>
@@ -239,3 +346,4 @@ export declare namespace Http {
      */
     const decorate: (handler: Handler) => (() => ParameterDecorator);
 }
+export {};

package/dist/index.d.ts

@@ -1,23 +1,26 @@
-import type { SingletonBase } from 'elysia';
-export { type Elysia, type TSchema, type Static, t } from 'elysia';
-export { type AppContext, type ElysiumPlugin, Application } from './app';
+export { type Elysia, t } from 'elysia';
+export { type Static, type TObject, type TSchema } from 'typebox';
+export { type AppContext, type ElysiumPlugin, type ServerError, Application } from './app';
 export { type CommandArgumentProps, type CommandClass, Command, CommandArgumentType } from './command';
-export { ConsoleFormat, InteractsWithConsole } from './console';
+export { ConsoleFormat, type ConsoleTag, type ConsoleTagStyle, InteractsWithConsole } from './console';
 export { Env } from './env';
-export { type EventData, type EventHandler, Event } from './event';
-export { type LoggerInterface, ConsoleLogger } from './logger';
-export { type Context, type Route, HttpControllerScope, Http } from './http';
+export { type LifecycleEvent, type LifecycleHandler, Lifecycle } from './lifecycle';
+export { type LoggerInterface, ConsoleLogger, getLogger, LOGGER_SERVICE } from './logger';
+export { type Context, type HttpControllerDescription, type HttpControllerOptions, type HttpControllerProps, type HttpRouteDescription, type HttpRouteOptions, type RequestHandlerDecoratorProps, type Route, DATABASE_TRANSACTION_SERVICE, HttpControllerScope, Http } from './http';
 export { Metadata } from './metadata';
+export { currentUserId, userIdOf } from './user';
+export { currentEnvironment } from './utils';
 export { Middleware } from './middleware';
 export { RequestLoggerMiddleware } from './middlewares/request-logger.middleware';
-export { CircularDependencyError, ConflictingModuleConfigError, DuplicateCommandError, DuplicateGlobalServiceError, DuplicateModuleNameError, ElysiumError, EnvironmentSkippedModuleError, EventListenerNotSupportedError, InvalidModuleError, InvalidModuleConfigError, MissingModuleConfigError, ModuleCycleError, ServiceNotFoundError, ServiceNotReadyError, ServiceNotVisibleError } from './errors';
+export { CircularDependencyError, ConflictingModuleConfigError, DuplicateCommandError, DuplicateGlobalServiceError, DuplicateModuleNameError, ElysiumError, EnvironmentSkippedModuleError, LifecycleListenerNotSupportedError, InvalidModuleError, InvalidModuleConfigError, MissingModuleConfigError, ModuleCycleError, OutsideRequestScopeError, ScopeMismatchError, InterceptorNextCalledTwiceError, ServiceNotFoundError, ServiceNotReadyError, ServiceNotVisibleError } from './errors';
 export { needsDefaultAlias, runAll } from './connections';
 export { Kernel, KERNEL_SERVICE } from './kernel';
 export { type ConfiguredModule, type ModuleClass, type ModuleProps, Module } from './module';
 export { ModuleContext } from './module-context';
 export { type ModuleGraph, type ModuleNode } from './module-graph';
-export { type TestingApp, type TestingOptions } from './testing';
-export { type RedisConnectionProps, type RedisModuleConfig, Redis, RedisModule } from './redis';
+export { type TestingApp, type TestingAppOptions, type TestingHttpApp, type TestingOptions, resetContainer } from './testing';
+export { type HttpTestClient, type RequestHandler, type TestResponse, createHttpClient, TestRequest, UnexpectedStatusError } from './http-client';
+export { type OutputLevel, type ServeHandle, type ShutdownSignal, Runtime, RuntimeNotConfiguredError, RuntimeNotSupportedError } from './runtime';
 export { type ServiceDefinition, type ServiceFactoryDefinition, ServiceScope, Service } from './service';
 export { type WampRegistrationOptions, type WampSubscriptionOptions, type WampProps, type WampRegistrationHandlerArgs, type WampSubscriptionHandlerArgs, type WampRegistrationHandler, type WampSubscriptionHandler, type WampClientProps, type WampModuleConfig, Wamp, WampModule } from './wamp';
 export { type WS, type WSError, Websocket } from './websocket';
@@ -25,7 +28,10 @@ export { type WS, type WSError, Websocket } from './websocket';
  * The type for the context of the application.
  * @author Axel Nana <axel.nana@workbud.com>
  */
-export interface AppHttpContext extends SingletonBase {
+export interface AppHttpContext {
+    decorator: Record<string, unknown>;
+    store: Record<string, unknown>;
+    derive: Record<string, unknown>;
 }
 /**
  * The type for all registered environment variables.
@@ -34,3 +40,10 @@ export interface AppHttpContext extends SingletonBase {
 export interface AppEnv {
     [key: string]: string;
 }
+export { type DomainErrorOptions, type ElysiumProblemCode, type ProblemCatalogue, type ProblemCode, type ProblemContext, type ProblemDetails, type ProblemOptions, type ProblemValidationError, BadRequestError, ConflictError, DomainError, ELYSIUM_PROBLEM_CODES, ForbiddenError, isDomainError, isProblemDetails, NotFoundError, PROBLEM_CONTENT_TYPE, ProblemDetailsSchema, problemResponse, problemType, requestIdOf, statusTitle, toProblem, UnauthenticatedError, ValidationFailedError, validationErrors } from './problem';
+export { type ExceptionFilter, type FilterClass, type FilterContext, Catch } from './filter';
+export { type ResponseSchemas, Resource } from './resource';
+export { type AppRateLimitOptions, type RateLimitHit, type RateLimitKeyContext, type RateLimitOptions, type RateLimitStore, MemoryRateLimitStore, RateLimit, TooManyRequestsError } from './rate-limit';
+export { type Interceptor, type InterceptorClass, type InterceptorContext, TimingInterceptor, TransformInterceptor } from './interceptor';
+export { type EnvironmentIssue, ConflictingEnvironmentSchemaError, InvalidEnvironmentError, mergeEnvironmentSchemas, Secret, validateEnvironment } from './config';
+export { type CorsOptions, type HttpOptions, type SecurityHeadersOptions, clientAddress, DEFAULT_BODY_LIMIT, InvalidCorsOptionsError, PayloadTooLargeError } from './security';