@elysiumjs/core 0.4.3 → 0.5.0

package/dist/module.d.ts

@@ -0,0 +1,45 @@
+import type { Class } from 'type-fest';
+import type { Route } from './http';
+/**
+ * Properties required when declaring a module using the `@module()` decorator.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export type ModuleProps = {
+    /**
+     * The list of controllers provided by the module.
+     */
+    controllers?: Class<any>[];
+    /**
+     * The base path for all the controllers registered by this module.
+     * This value will be prefixed to each controllers path.
+     */
+    prefix?: Route;
+};
+/**
+ * Type for a module class.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export type ModuleClass = Class<Module>;
+/**
+ * Base class for all modules.
+ * @author Axel Nana <axel.nana@workbud.com>
+ *
+ * This class provides base features for modules, such as hooks and lifecycle methods.
+ */
+export declare abstract class Module {
+    /**
+     * Marks a class as a module.
+     * @author Axel Nana <axel.nana@workbud.com>
+     * @param options The decorator options.
+     */
+    static register(options?: ModuleProps): (target: ModuleClass) => void;
+    /**
+     * Hooks that are executed before the module is registered.
+     */
+    beforeRegister(): Promise<void>;
+    /**
+     * Hooks that are executed after the module is registered.
+     */
+    afterRegister(): Promise<void>;
+}
+//# sourceMappingURL=module.d.ts.map

package/dist/redis.d.ts

@@ -0,0 +1,134 @@
+import type { KeyvStoreAdapter } from 'cacheable';
+import type { KeyvEntry, StoredData } from 'keyv';
+import { EventEmitter } from 'node:events';
+/**
+ * Properties used to create a new redis connection.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export type RedisConnectionProps = Bun.RedisOptions & {
+    url: string;
+};
+/**
+ * Keyv adapter for redis. This adapter is based on the Bun's Redis client.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export declare class KeyvRedis extends EventEmitter implements KeyvStoreAdapter {
+    #private;
+    constructor(props: {
+        /**
+         * The Redis connection to use.
+         */
+        connection: string;
+        /**
+         * Namespace for the connection.
+         */
+        namespace?: string;
+        /**
+         * Separator to use between namespace and key.
+         */
+        keyPrefixSeparator?: string;
+        /**
+         * Number of keys to delete in a single batch.
+         */
+        clearBatchSize?: number;
+        /**
+         * Enable Unlink instead of using Del for clearing keys. This is more performant but may not be supported by all Redis versions.
+         */
+        useUnlink?: boolean;
+        /**
+         * Whether to allow clearing all keys when no namespace is set.
+         * If set to true and no namespace is set, iterate() will return all keys.
+         * Defaults to `false`.
+         */
+        noNamespaceAffectsAll?: boolean;
+    });
+    get client(): Bun.RedisClient;
+    /**
+     * Get the options for the adapter.
+     */
+    get opts(): {
+        namespace: string | undefined;
+        keyPrefixSeparator: string;
+        clearBatchSize: number;
+        noNamespaceAffectsAll: boolean;
+        dialect: string;
+        url: string;
+    };
+    /**
+     * Gets the namespace for the adapter. If undefined, it will not use a namespace including keyPrefixing.
+     * @default undefined
+     */
+    get namespace(): string | undefined;
+    /**
+     * Sets the namespace for the adapter. If undefined, it will not use a namespace including keyPrefixing.
+     */
+    set namespace(value: string | undefined);
+    get<Value>(key: string): Promise<StoredData<Value> | undefined>;
+    set(key: string, value: any, ttl?: number): Promise<void>;
+    setMany(values: Array<KeyvEntry>): Promise<void>;
+    delete(key: string): Promise<boolean>;
+    clear(): Promise<void>;
+    has(key: string): Promise<boolean>;
+    hasMany(keys: string[]): Promise<boolean[]>;
+    getMany<Value>(keys: string[]): Promise<Array<StoredData<Value | undefined>>>;
+    disconnect(): Promise<void>;
+    deleteMany(keys: string[]): Promise<boolean>;
+    iterator<Value>(namespace?: string): AsyncGenerator<Array<string | Awaited<Value> | undefined>, void>;
+    /**
+     * Helper function to create a key with a namespace.
+     * @param key The key to prefix.
+     * @param namespace The namespace to prefix the key with.
+     * @returns The key with the namespace such as 'namespace::key'.
+     */
+    createKeyPrefix(key: string, namespace?: string): string;
+    /**
+     * Helper function to remove the namespace from a key.
+     * @param key The key to remove the namespace from.
+     * @param namespace The namespace to remove from the key.
+     * @returns The key without the namespace.
+     */
+    getKeyWithoutPrefix(key: string, namespace?: string): string;
+}
+export declare namespace Redis {
+    /**
+     * Retrieves the client for a redis connection.
+     * @author Axel Nana <axel.nana@workbud.com>
+     * @param name The name of the connection.
+     * @returns The Bun.RedisClient for the connection with the given name.
+     */
+    const getConnection: (name: string) => Bun.RedisClient;
+    /**
+     * Creates and registers a new redis connection.
+     *
+     * This will make the registered connection available for dependency injection with
+     * the key `redis.connection.{name}`, where `{name}` is replaced with the given name.
+     *
+     * @author Axel Nana <axel.nana@workbud.com>
+     *
+     * @param name The name of the connection.
+     * @param config The configuration for the redis connection.
+     * @returns The newly created and registered redis connection.
+     */
+    const registerConnection: (name: string, config: RedisConnectionProps) => Bun.RedisClient;
+    /**
+     * Checks if a redis connection with the given name exists.
+     * @author Axel Nana <axel.nana@workbud.com>
+     * @param name The name of the connection to check.
+     * @returns `true` if the connection exists, `false` otherwise.
+     */
+    const connectionExists: (name: string) => boolean;
+    /**
+     * Retrieves the default redis connection.
+     * @author Axel Nana <axel.nana@workbud.com>
+     * @returns The default redis connection.
+     */
+    const getDefaultConnection: () => Bun.RedisClient;
+    /**
+     * Sets the default redis connection.
+     * @author Axel Nana <axel.nana@workbud.com>
+     * @param name The name of the connection to set as default.
+     * @returns The default redis connection.
+     */
+    const setDefaultConnection: (name: string) => Bun.RedisClient;
+}
+//# sourceMappingURL=redis.d.ts.map

package/dist/repository.d.ts

@@ -0,0 +1,164 @@
+import type { PgColumnBuilderBase } from 'drizzle-orm/pg-core';
+import type { Class } from 'type-fest';
+import type { DatabaseConnection } from './database';
+import type { ModelClass } from './model';
+/**
+ * Database's primary column type.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export type IdType = number | string;
+/**
+ * Interface of a repository.
+ * @author Axel Nana <axel.nana@workbud.com>
+ * @template TModel The type of the model class wrapped by the repository.
+ * @template TId The primary column type.
+ * @template TColumnsMap The table columns config.
+ */
+export interface RepositoryInterface<TModel extends ModelClass<TTableName, TColumnsMap>, TId extends IdType = string, TTableName extends string = TModel extends ModelClass<infer TTableName, infer _> ? TTableName : string, TColumnsMap extends Record<string, PgColumnBuilderBase> = TModel extends ModelClass<TTableName, infer TColumnsMap> ? TColumnsMap : Record<string, PgColumnBuilderBase>> {
+    /**
+     * Retrieves all the records in the database.
+     * @returns All the records in the database.
+     */
+    all(): Promise<TModel['$inferSelect'][]>;
+    /**
+     * Retrieves a record by its id.
+     * @param id The id of the record to retrieve.
+     * @returns The record with the given id.
+     */
+    find(id: TId): Promise<TModel['$inferSelect'] | null>;
+    /**
+     * Inserts a new record in the database.
+     * @param data The data to insert.
+     * @returns The inserted record.
+     */
+    insert(data: TModel['$inferInsert']): Promise<TModel['$inferSelect']>;
+    /**
+     * Updates a record in the database.
+     * @param id The id of the record to update.
+     * @param data The data to update.
+     * @returns The updated record.
+     */
+    update(id: TId, data: TModel['$inferUpdate']): Promise<TModel['$inferSelect']>;
+    /**
+     * Updates all the records in the database.
+     * @param data The data to update.
+     * @returns The updated records.
+     */
+    updateAll(data: TModel['$inferUpdate']): Promise<TModel['$inferSelect'][]>;
+    /**
+     * Deletes a record from the database.
+     * @param id The ID of the record to delete.
+     * @returns The deleted record.
+     */
+    delete(id: TId): Promise<TModel['$inferSelect']>;
+    /**
+     * Deletes all the records from the database.
+     * @returns All the records in the database.
+     */
+    deleteAll(): Promise<TModel['$inferSelect'][]>;
+}
+/**
+ * Type of a repository class.
+ * @author Axel Nana <axel.nana@workbud.com>
+ * @template TModel The type of the model class wrapped by the repository.
+ * @template TId The primary column type.
+ * @template TColumnsMap The table columns config.
+ */
+export type RepositoryClass<TModel extends ModelClass<TTableName, TColumnsMap>, TId extends IdType = string, TTableName extends string = TModel extends ModelClass<infer TTableName, infer _> ? TTableName : string, TColumnsMap extends Record<string, PgColumnBuilderBase> = TModel extends ModelClass<TTableName, infer TColumnsMap> ? TColumnsMap : Record<string, PgColumnBuilderBase>> = Class<RepositoryInterface<TModel, TId, TTableName, TColumnsMap>> & {
+    /**
+     * The drizzle's table schema wrapped by the repository.
+     */
+    readonly Model: TModel;
+    /**
+     * The database connection name to use in the repository.
+     *
+     * Update this value to change the database connection used by this repository.
+     */
+    readonly connection: string;
+};
+/**
+ * Mixin used to create a new repository class over a model.
+ * @author Axel Nana <axel.nana@workbud.com>
+ * @template TModel The type of the model class wrapped by the repository.
+ * @template TId The primary column type.
+ * @template TColumnsMap The table columns config.
+ * @template model The model class wrapped by the repository.
+ */
+export declare const Repository: <TModel extends ModelClass<TTableName, TColumnsMap>, TId extends IdType = string, TTableName extends string = TModel extends ModelClass<infer TTableName_1, infer _> ? TTableName_1 : string, TColumnsMap extends Record<string, PgColumnBuilderBase> = TModel extends ModelClass<TTableName, infer TColumnsMap_1> ? TColumnsMap_1 : Record<string, PgColumnBuilderBase>>(model: TModel) => {
+    new (): {
+        /**
+         * The database connection used by this repository.
+         */
+        readonly db: DatabaseConnection;
+        /**
+         * Retrieves all the records in the database.
+         * @returns All the records in the database.
+         */
+        all(): Promise<TModel["$inferSelect"][]>;
+        /**
+         * Get a paginated subset of the records in the database.
+         * @param page The page number to retrieve.
+         * @param count The number of records to retrieve per page.
+         * @returns A paginated response containing the records and the total number of records.
+         */
+        paginate(count: number, page?: number): Promise<{
+            page: number;
+            data: TModel["$inferSelect"][];
+            total: number;
+        }>;
+        /**
+         * Retrieves a record by its id.
+         * @param id The id of the record to retrieve.
+         * @returns The record with the given id.
+         */
+        find(id: TId): Promise<TModel["$inferSelect"] | null>;
+        /**
+         * Finds the first record with a column matching the given value.
+         * @param column The column to filter by.
+         * @param value The value the column should match.
+         * @returns The first record with a column matching the given value.
+         */
+        findBy<TKey extends keyof TModel["$inferSelect"]>(column: TKey, value: TModel["$inferSelect"][TKey]): Promise<TModel["$inferSelect"] | null>;
+        /**
+         * Inserts a new record in the database.
+         * @param data The data to insert.
+         * @returns The inserted record.
+         */
+        insert(data: TModel["$inferInsert"]): Promise<TModel["$inferSelect"]>;
+        /**
+         * Updates a record in the database.
+         * @param id The id of the record to update.
+         * @param data The data to update.
+         * @returns The updated record.
+         */
+        update(id: TId, data: TModel["$inferUpdate"]): Promise<TModel["$inferSelect"]>;
+        /**
+         * Updates all the records in the database.
+         * @param data The data to update.
+         * @returns The updated records.
+         */
+        updateAll(data: TModel["$inferUpdate"]): Promise<TModel["$inferSelect"][]>;
+        /**
+         * Deletes a record from the database.
+         * @param id The ID of the record to delete.
+         * @returns The deleted record.
+         */
+        delete(id: TId): Promise<TModel["$inferSelect"]>;
+        /**
+         * Deletes all the records from the database.
+         * @returns All the records in the database.
+         */
+        deleteAll(): Promise<TModel["$inferSelect"][]>;
+    };
+    /**
+     * The drizzle's table schema wrapped by this repository.
+     */
+    readonly Model: TModel;
+    /**
+     * The database connection name to use.
+     *
+     * Update this value to change the database connection used by this repository.
+     */
+    readonly connection: string;
+};
+//# sourceMappingURL=repository.d.ts.map

package/dist/service.d.ts

@@ -0,0 +1,132 @@
+import type { Class } from 'type-fest';
+/**
+ * The scope of a service.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export declare enum ServiceScope {
+    /**
+     * A single instance of the service is created and shared everywhere it is injected or retrieved.
+     */
+    SINGLETON = 0,
+    /**
+     * A new instance of the service is created every time it is injected or retrieved.
+     */
+    FACTORY = 1
+}
+/**
+ * A generic service class.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+type ServiceClass = Class<any>;
+/**
+ * A typed service class.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+type TypedServiceClass<T> = Class<T>;
+/**
+ * Type for a factory function.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+type FactoryFn<T> = () => T extends void ? never : T;
+/**
+ * Properties required when declaring a service using the `@service()` decorator.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export type ServiceProps = Partial<{
+    /**
+     * The name of the service. If not set, it will default to the service class name.
+     */
+    name: string;
+    /**
+     * The service's scope.
+     *
+     * Set it to `Scope.SINGLETON` to ensure that only one instance of this service is
+     * used everywhere it is injected or retrieved.
+     *
+     * Set it to `Scope.FACTORY` to ensure that every time you inject or retrieve this
+     * service, you have a new instance created.
+     *
+     * @see ServiceScope
+     */
+    scope: ServiceScope;
+}>;
+export declare namespace Service {
+    /**
+     * Marks a class as a service
+     * @author Axel Nana <axel.nana@workbud.com>
+     * @param options The decorator options.
+     */
+    const register: (options?: ServiceProps) => (target: ServiceClass) => void;
+    /**
+     * Resolves a registered service and set it as a parameter value.
+     * @author Axel Nana <axel.nana@workbud.com>
+     * @param service An optional name for the service. If not set, the name of the parameter's type is used instead.
+     */
+    const inject: (service?: string | ServiceClass) => ParameterDecorator;
+    /**
+     * Retrieves a registered service's instance from the container.
+     * @author Axel Nana <axel.nana@workbud.com>
+     * @param service The name of the service, or its class.
+     * @returns An instance of the registered service, or `null` if no service with that name/type was registered.
+     */
+    const get: <T>(service: string | TypedServiceClass<T>) => T | null;
+    /**
+     * Instantiates a service with its dependencies.
+     *
+     * This function always create a new instance of the service, even if the service's scope is `ServiceScope.SINGLETON`
+     * and it has already been registered in the container.
+     *
+     * @author Axel Nana <axel.nana@workbud.com>
+     *
+     * @param service The service class to instantiate.
+     */
+    const make: <T>(service: TypedServiceClass<T>) => T;
+    /**
+     * Binds a service to the container and sets it as a singleton.
+     * @author Axel Nana <axel.nana@workbud.com>
+     * @param service The service class to bind.
+     * @param name An optional name for the service. If not set, the name of the service class is used instead.
+     */
+    const bind: <T>(service: TypedServiceClass<T>, name?: string) => T;
+    /**
+     * Binds a service to the container and sets it as a factory.
+     * @author Axel Nana <axel.nana@workbud.com>
+     * @param name A name for the service.
+     * @param factory The factory function used to instantiate the service.
+     */
+    function factory<T>(name: string, factory: FactoryFn<T>): T;
+    /**
+     * Binds a service to the container and sets it as a factory.
+     * @author Axel Nana <axel.nana@workbud.com>
+     * @param service The service class to bind.
+     * @param name An optional name for the service. If not set, the name of the service class is used instead.
+     */
+    function factory<T>(service: TypedServiceClass<T>, name?: string): T;
+    /**
+     * Binds a service's instance to the container.
+     * @author Axel Nana <axel.nana@workbud.com>
+     * @param service The service class or name to bind.
+     * @param instance The instance to bind.
+     */
+    const instance: <T>(service: string | TypedServiceClass<T>, instance: T) => T;
+    /**
+     * Removes a service from the container.
+     * @author Axel Nana <axel.nana@workbud.com>
+     * @param service The service class or name to remove.
+     */
+    const remove: (service: string | TypedServiceClass<any>) => void;
+    /**
+     * Checks if a service exists in the container.
+     * @author Axel Nana <axel.nana@workbud.com>
+     * @param service The service class or name to check.
+     * @returns `true` if the service exists, `false` otherwise.
+     */
+    const exists: (service: string | TypedServiceClass<any>) => boolean;
+    /**
+     * Clears the container.
+     * @author Axel Nana <axel.nana@workbud.com>
+     */
+    const clear: () => void;
+}
+export {};
+//# sourceMappingURL=service.d.ts.map

package/dist/utils.d.ts

@@ -0,0 +1,26 @@
+import type { Elysia } from 'elysia';
+export declare namespace Symbols {
+    const app: unique symbol;
+    const controller: unique symbol;
+    const middlewares: unique symbol;
+    const services: unique symbol;
+    const websocket: unique symbol;
+    const wamp: unique symbol;
+    const http: unique symbol;
+    const job: unique symbol;
+    const arg: unique symbol;
+    const elysiaPlugin: unique symbol;
+    const middlewareGuards: unique symbol;
+}
+export declare const nextTick: () => Promise<unknown>;
+export type ElysiaPlugin = () => Promise<Elysia>;
+/**
+ * Deeply merges objects from right to left
+ * Arrays are also merged if they are found in child objects
+ *
+ * @param target The target object to merge into
+ * @param sources One or more source objects to merge from
+ * @returns The merged object (same reference as target)
+ */
+export declare function deepMerge<T extends Record<string, any | any[]>>(target: T, ...sources: T[]): T;
+//# sourceMappingURL=utils.d.ts.map