@elysiumjs/core 0.6.0 → 0.7.0

package/dist/cache.d.ts

@@ -1,113 +0,0 @@
-/**
- * Interface for a cache storage.
- * @author Axel Nana <axel.nana@workbud.com>
- */
-export interface CacheInterface {
-    /**
-     * Retrieves the cached data for a given key.
-     * @typeParam T The type of the cached data.
-     *
-     * @param key The key of the cached data.
-     */
-    get<T>(key: string): Promise<T | undefined>;
-    /**
-     * Retrieves the cached data for a given list of keys.
-     * @typeParam T The type of the cached data.
-     *
-     * @param keys The list of cached data keys.
-     */
-    mget<T>(keys: string[]): Promise<Array<T | undefined>>;
-    /**
-     * Gets the TTL of the cached data with the given key.
-     * @param key The key of the cached data.
-     * @returns The TTL of the cached data, or `undefined` if the data does not exist.
-     */
-    ttl(key: string): Promise<number | undefined>;
-    /**
-     * Caches data under the given key and an optional TTL.
-     * @typeParam T The type of the data to cache.
-     *
-     * @param key The key of the cached data.
-     * @param data The data to cache.
-     * @param ttl The optional TTL of the cached data. If not defined, the data is cached forever.
-     * @returns The cached data.
-     */
-    set<T>(key: string, data: T, ttl?: number): Promise<T>;
-    /**
-     * Caches data under the given list of keys and an optional TTL.
-     * @typeParam T The type of the data to cache.
-     *
-     * @param data The list of data to cache.
-     * @returns The list of cached data.
-     */
-    mset<T>(data: Array<{
-        key: string;
-        value: T;
-        ttl?: number;
-    }>): Promise<Array<{
-        key: string;
-        value: T;
-        ttl?: number;
-    }>>;
-    /**
-     * Deletes the cached data with the given key.
-     * @typeParam T The type of the data to cache.
-     *
-     * @param key The key of the cached data.
-     * @returns `true` if the data was deleted, `false` otherwise.
-     */
-    del(key: string): Promise<boolean>;
-    /**
-     * Deletes the cached data with the given list of keys.
-     * @typeParam T The type of the data to cache.
-     *
-     * @param keys The list of cached data keys.
-     * @returns `true` if the data was deleted, `false` otherwise.
-     */
-    mdel(keys: string[]): Promise<boolean>;
-    /**
-     * Deletes all cached data.
-     * @returns `true` if the data was deleted, `false` otherwise.
-     */
-    clear(): Promise<boolean>;
-    /**
-     * Creates a sub-cache with the given tags.
-     * @param tags The list of tags for the sub-cache.
-     */
-    tags(...tags: string[]): Omit<CacheInterface, 'tags'>;
-}
-export declare abstract class Cache {
-    #private;
-    /**
-     * A weak cache storage for simple non-intrusive caching of data.
-     * @author Axel Nana <axel.nana@workbud.com>
-     */
-    static readonly weak: {
-        /**
-         * INTERNAL USAGE ONLY.
-         * @private
-         */
-        map: WeakMap<object, unknown>;
-        /**
-         * Gets the cached data for a given context.
-         * @param ctx The cache context.
-         * @returns The cached data.
-         */
-        get<T extends object>(ctx: object): T;
-        /**
-         * Deletes the cached data for a given context.
-         * @param ctx The cache context.
-         */
-        del(ctx: object): void;
-    };
-    /**
-     * Redis-based cache storage.
-     * @author Axel Nana <axel.nana@workbud.com>
-     */
-    static get redis(): CacheInterface;
-    /**
-     * Memory-based cache storage.
-     * @author Axel Nana <axel.nana@workbud.com>
-     */
-    static get memory(): CacheInterface;
-}

package/dist/database.d.ts

@@ -1,112 +0,0 @@
-import type { DrizzleConfig } from 'drizzle-orm';
-import type { BunSQLDatabase } from 'drizzle-orm/bun-sql';
-import type { CacheConfig } from 'drizzle-orm/cache/core/types';
-import { Table } from 'drizzle-orm';
-import { Cache as DrizzleCache } from 'drizzle-orm/cache/core';
-/**
- * Properties used to create a new database connection.
- * @author Axel Nana <axel.nana@workbud.com>
- */
-export type DatabaseConnectionProps<TSchema extends Record<string, unknown> = Record<string, never>> = Omit<DrizzleConfig<TSchema>, 'cache'> & ({
-    connection: string | ({
-        url?: string;
-    } & Bun.SQLOptions);
-} | {
-    client: Bun.SQL;
-}) & {
-    /**
-     * Configures caching behavior for the database connection.
-     * Set it to `true` to enable caching with default configurations.
-     */
-    cache?: true | {
-        /**
-         * Whether to enable caching.
-         */
-        enabled?: boolean;
-        /**
-         * The default TTL for cached data, in seconds.
-         * @default 1
-         */
-        ttl?: number;
-        /**
-         * The caching strategy.
-         * Set it to `all` to cache all queries automatically.
-         * Set it to `explicit` to cache queries manually.
-         * @default 'explicit'
-         */
-        strategy?: 'explicit' | 'all';
-        /**
-         * The storage engine to use.
-         * @default 'redis'
-         */
-        storage?: 'redis' | 'memory';
-    };
-};
-/**
- * A database connection.
- * @author Axel Nana <axel.nana@workbud.com>
- */
-export type DatabaseConnection = BunSQLDatabase<Record<string, never>> & {
-    $client: Bun.SQL;
-};
-/**
- * Database cache implementation for Drizzle.
- * @author Axel Nana <axel.nana@workbud.com>
- */
-export declare class DatabaseCache extends DrizzleCache {
-    #private;
-    private readonly cacheStrategy;
-    private readonly globalTtl;
-    private usedTablesPerKey;
-    constructor(cacheStrategy?: 'explicit' | 'all', globalTtl?: number, storageEngine?: 'redis' | 'memory');
-    strategy(): 'explicit' | 'all';
-    get(key: string): Promise<any[] | undefined>;
-    put(key: string, response: any, tables: string[], _isTag: boolean, config?: CacheConfig): Promise<void>;
-    onMutate(params: {
-        tags: string | string[];
-        tables: string | string[] | Table<any> | Table<any>[];
-    }): Promise<void>;
-}
-export declare namespace Database {
-    /**
-     * Retrieves the connection with the given name.
-     * @author Axel Nana <axel.nana@workbud.com>
-     * @param name The connection name.
-     * @returns The connection with the given name.
-     */
-    const getConnection: (name: string) => DatabaseConnection;
-    /**
-     * Creates and registers a new connection.
-     * @author Axel Nana <axel.nana@workbud.com>
-     *
-     * This will make the registered connection available for dependency injection with
-     * the key `db.connection.{name}`, where `{name}` is replaced with the given name.
-     *
-     * @param name The connection name.
-     * @param config The connection properties.
-     * @returns The newly created and registered connection.
-     */
-    const registerConnection: (name: string, config: DatabaseConnectionProps) => BunSQLDatabase<Record<string, never>> & {
-        $client: Bun.SQL;
-    };
-    /**
-     * Checks if a 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 connection.
-     * @author Axel Nana <axel.nana@workbud.com>
-     * @returns The default connection.
-     */
-    const getDefaultConnection: () => DatabaseConnection;
-    /**
-     * Sets the default connection.
-     * @author Axel Nana <axel.nana@workbud.com>
-     * @param name The name of the connection to set as default.
-     * @returns The default connection.
-     */
-    const setDefaultConnection: (name: string) => DatabaseConnection;
-}