@elysiumjs/mnemosyne 0.1.0 → 0.1.2

package/dist/tenancy.d.ts

@@ -1,180 +0,0 @@
-import type { Context } from '@elysiumjs/core';
-import type { TenancyStrategy } from './interfaces';
-import { Middleware } from '@elysiumjs/core';
-/**
- * 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;
-}
-/**
- * Gets the current global tenancy configuration.
- *
- * Reads from the 'elysium:mnemosyne' app config key. Returns a default
- * configuration if the app is not yet initialized or no tenancy config is set.
- *
- * @author Axel Nana <axel.nana@workbud.com>
- * @returns The current tenancy configuration.
- */
-export declare const getConfig: () => TenancyConfig;
-/**
- * Registers the tenancy strategy to use for table resolution and isolation.
- * @author Axel Nana <axel.nana@workbud.com>
- * @param strategy The tenancy strategy to register.
- */
-export declare const registerTenancyStrategy: (strategy: TenancyStrategy<unknown, unknown>) => void;
-/**
- * Gets the currently registered tenancy strategy.
- * @author Axel Nana <axel.nana@workbud.com>
- * @returns The current tenancy strategy, or `null` if none is registered.
- */
-export declare const getTenancyStrategy: () => TenancyStrategy<unknown, unknown> | null;
-/**
- * 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;
-/**
- * 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 the driver's
- * isolation mechanism 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;
-}