@elysiumjs/core 0.6.0 → 0.7.0

package/dist/repository.d.ts

@@ -1,175 +0,0 @@
-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'][]>;
-    /**
-     * Checks if a record exists in the database.
-     * @param id The ID of the record to check.
-     * @returns True if the record exists, false otherwise.
-     */
-    exists(id: TId): Promise<boolean>;
-}
-/**
- * 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.
-         */
-        get 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"][]>;
-        /**
-         * Checks if a record exists in the database.
-         * @param id The ID of the record to check.
-         * @returns True if the record exists, false otherwise.
-         */
-        exists(id: TId): Promise<boolean>;
-    };
-    /**
-     * 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;
-};

package/dist/tenancy.d.ts

@@ -1,244 +0,0 @@
-import type { PgColumnBuilderBase, PgSchema, PgTable, PgTransaction } from 'drizzle-orm/pg-core';
-import type { Context } from './http';
-import { Middleware } from './middleware';
-/**
- * The tenancy mode for the application.
- * - `schema`: Each tenant has their own Postgres schema.
- * - `rls`: Row-Level Security with a shared schema and a tenant column.
- * @author Axel Nana <axel.nana@workbud.com>
- */
-export type TenancyMode = 'schema' | 'rls';
-/**
- * Global tenancy configuration for the application.
- * @author Axel Nana <axel.nana@workbud.com>
- */
-export interface TenancyConfig {
-    /**
-     * The tenancy mode to use.
-     */
-    mode: TenancyMode;
-    /**
-     * Configuration specific to RLS mode.
-     */
-    rls?: {
-        /**
-         * The PostgreSQL session variable used to store the current tenant.
-         * @default 'app.current_tenant'
-         */
-        sessionVariable?: string;
-        /**
-         * The default column name used for tenant isolation in RLS policies.
-         * @default 'tenant_id'
-         */
-        defaultColumn?: string;
-    };
-    /**
-     * Configuration specific to schema-based tenancy.
-     */
-    schema?: {
-        /**
-         * Whether to automatically create tenant schemas on first use.
-         */
-        autoCreate?: boolean;
-    };
-}
-/**
- * Per-model tenancy configuration, used to control how a specific model
- * interacts with the tenancy system.
- * @author Axel Nana <axel.nana@workbud.com>
- */
-export interface ModelTenancyConfig {
-    /**
-     * Whether tenancy is enabled for this model.
-     */
-    enabled: boolean;
-    /**
-     * Override the global tenancy mode for this model.
-     */
-    mode?: TenancyMode;
-    /**
-     * The column name used for RLS tenant isolation in this model.
-     */
-    column?: string;
-    /**
-     * Custom RLS policy name for this model.
-     */
-    policyName?: string;
-}
-/**
- * Sets the global tenancy configuration.
- * @author Axel Nana <axel.nana@workbud.com>
- * @param config The tenancy configuration to apply.
- */
-export declare const configure: (config: TenancyConfig) => void;
-/**
- * Gets the current global tenancy configuration.
- * @author Axel Nana <axel.nana@workbud.com>
- * @returns The current tenancy configuration.
- */
-export declare const getConfig: () => TenancyConfig;
-/**
- * Gets the current tenant from the async context.
- * @author Axel Nana <axel.nana@workbud.com>
- * @returns The current tenant identifier, or `null` if not set.
- */
-export declare const getCurrentTenant: () => string | null;
-/**
- * Runs a callback within the context of a specific tenant.
- * @author Axel Nana <axel.nana@workbud.com>
- * @param tenant The tenant identifier to set.
- * @param callback The function to execute within the tenant context.
- * @returns The return value of the callback.
- */
-export declare const withTenant: <T>(tenant: string, callback: () => T) => T;
-/**
- * Gets the Drizzle `PgSchema` for the given tenant.
- * Creates and registers the schema if it doesn't exist yet.
- * @author Axel Nana <axel.nana@workbud.com>
- * @param tenant The name of the tenant.
- * @returns The Postgres schema for the tenant.
- */
-export declare const getTenantSchema: (tenant: string) => PgSchema;
-/**
- * Registers a new Postgres schema for a tenant.
- * If the schema is already registered, returns the existing one.
- * @author Axel Nana <axel.nana@workbud.com>
- * @param tenant The name of the tenant.
- * @returns The newly created or existing tenant schema.
- */
-export declare const registerTenantSchema: (tenant: string) => PgSchema;
-/**
- * Wraps a table definition within a tenant's Postgres schema.
- * For the `public` tenant, returns a standard `pgTable`.
- * Results are cached for performance.
- * @author Axel Nana <axel.nana@workbud.com>
- * @param tenant The tenant identifier.
- * @param tableName The name of the table.
- * @param columns The table columns definition.
- * @returns A `PgTable` scoped to the tenant's schema.
- */
-export declare const wrapTenantSchema: <TTableName extends string, TColumnsMap extends Record<string, PgColumnBuilderBase>>(tenant: string, tableName: TTableName, columns: TColumnsMap) => PgTable;
-/**
- * Execute a callback within a transaction that has the tenant context set
- * via PostgreSQL session variable.
- *
- * Uses `set_config(varName, value, true)` which:
- * - Sets the variable value as a proper GUC parameter (not an identifier)
- * - The `true` flag makes it transaction-local (reverts on commit/rollback)
- *
- * The transaction handle (`tx`) is passed to the callback so all
- * queries execute within the same transaction where `set_config` was called.
- *
- * @author Axel Nana <axel.nana@workbud.com>
- * @param tenant The tenant identifier, or `null` for the public tenant.
- * @param callback A function receiving the transaction handle.
- * @param connectionName The database connection to use.
- * @returns The return value of the callback.
- */
-export declare const withRLS: <T>(tenant: string | null, callback: (tx: PgTransaction<any, any, any>) => Promise<T>, connectionName?: string) => Promise<T>;
-/**
- * Sets the tenant for the current database connection (session-level, not transaction-local).
- * Useful for long-lived connections or connection pools.
- * @author Axel Nana <axel.nana@workbud.com>
- * @param tenant The tenant identifier, or `null` for the public tenant.
- * @param connectionName The database connection to use.
- */
-export declare const setConnectionTenant: (tenant: string | null, connectionName?: string) => Promise<void>;
-/**
- * Reads the current tenant from the PostgreSQL session variable.
- * @author Axel Nana <axel.nana@workbud.com>
- * @param connectionName The database connection to use.
- * @returns The current tenant identifier, or `null` if not set.
- */
-export declare const getSessionTenant: (connectionName?: string) => Promise<string | null>;
-/**
- * Create an RLS policy for tenant isolation.
- *
- * Always specifies `for` and `to` for deterministic behavior:
- * - `for: 'all'` — policy applies to SELECT, INSERT, UPDATE, DELETE
- * - `to: 'public'` — policy applies to all roles
- *
- * @author Axel Nana <axel.nana@workbud.com>
- * @param tableName The name of the table to create the policy for.
- * @param columnName The column that holds the tenant identifier. Defaults to the global config.
- * @param policyName Custom name for the policy. Defaults to `{tableName}_tenant_isolation`.
- * @returns A Drizzle `pgPolicy` definition.
- */
-export declare const createRLSPolicy: (tableName: string, columnName?: string, policyName?: string) => import("drizzle-orm/pg-core").PgPolicy;
-/**
- * Base class for tenant-aware middleware.
- *
- * The middleware extracts the tenant identifier from an HTTP header and
- * sets `ctx.tenant`. For RLS mode, route handlers should use `withRLS()`
- * to wrap their queries in a tenant-scoped transaction.
- *
- * @example
- * ```typescript
- * class OrganizationMiddleware extends TenantMiddleware {
- *   protected header = 'x-organization-id';
- *   protected allowPublic = false;
- *
- *   protected async validateTenant(orgId: string): Promise<boolean> {
- *     return Organization.exists(orgId);
- *   }
- * }
- * ```
- *
- * @author Axel Nana <axel.nana@workbud.com>
- */
-export declare abstract class TenantMiddleware extends Middleware {
-    /**
-     * The HTTP header name from which the tenant ID is read.
-     */
-    protected header: string;
-    /**
-     * Whether requests without a tenant ID are allowed (defaulting to 'public').
-     */
-    protected allowPublic: boolean;
-    /**
-     * The database connection name used for tenant operations.
-     */
-    protected connectionName: string;
-    /**
-     * Validates that a tenant identifier is legitimate.
-     * Override this to check against your data store.
-     * @author Axel Nana <axel.nana@workbud.com>
-     * @param _tenant The tenant identifier to validate.
-     * @returns `true` if the tenant is valid, `false` otherwise.
-     */
-    protected validateTenant(_tenant: string): Promise<boolean>;
-    /**
-     * Hook called after a tenant has been successfully resolved.
-     * @author Axel Nana <axel.nana@workbud.com>
-     * @param _tenant The resolved tenant identifier.
-     * @param _ctx The request context.
-     */
-    protected onTenantResolved(_tenant: string, _ctx: Context): Promise<void>;
-    /**
-     * Called when the tenant cannot be determined or is invalid.
-     * Throws an appropriate error by default.
-     * @author Axel Nana <axel.nana@workbud.com>
-     * @param reason Whether the tenant is 'missing' or 'invalid'.
-     * @param _ctx The request context.
-     */
-    protected onTenantError(reason: 'missing' | 'invalid', _ctx: Context): never;
-    /**
-     * Extracts and validates the tenant from the incoming request.
-     * @author Axel Nana <axel.nana@workbud.com>
-     * @param ctx The request context.
-     */
-    onRequest(ctx: Context): Promise<any>;
-}
-/**
- * A simple tenant middleware that allows public access by default.
- * @author Axel Nana <axel.nana@workbud.com>
- */
-export declare class SimpleTenantMiddleware extends TenantMiddleware {
-}
-/**
- * A strict tenant middleware that rejects requests without a tenant ID.
- * @author Axel Nana <axel.nana@workbud.com>
- */
-export declare class StrictTenantMiddleware extends TenantMiddleware {
-    protected allowPublic: boolean;
-}