@elysiumjs/core 0.6.1 → 0.8.0

package/dist/wamp.d.ts

@@ -1,4 +1,6 @@
-import type { Class, Primitive } from 'type-fest';
+import type { Class } from 'type-fest';
+import { Elysia } from 'elysia';
+import Wampy from 'wampy';
 /**
  * Options used to register a WAMP RPC for invocation.
  * @author Axel Nana <axel.nana@workbud.com>
@@ -69,11 +71,11 @@ export type WampClientProps = {
      * @param method The authentication method.
      * @param extra Authentication metadata.
      */
-    onChallenge?(method: string, extra: any): string | null;
+    onChallenge?(method: string, extra: Record<string, unknown>): string | Promise<string>;
     /**
-     * Callback for handling the WAMP connection open event.
+     * Called once the first connection is established; not on wampy reconnects.
      */
-    onOpen?(): void;
+    onOpen?(): void | Promise<void>;
     /**
      * Callback for handling the WAMP connection close event.
      */
@@ -81,7 +83,7 @@ export type WampClientProps = {
     /**
      * Callback for handling the WAMP connection error event.
      */
-    onError?(): void;
+    onError?(error: Error): void;
     /**
      * Callback for handling the WAMP connection reconnect event.
      */
@@ -89,77 +91,13 @@ export type WampClientProps = {
     /**
      * Callback for handling the WAMP connection reconnect success event.
      */
-    onReconnectSuccess?(): void;
-};
-export type WampClient = {
-    /**
-     * Disconnects from WAMP server. Clears all queues, subscriptions and calls.
-     * @author Axel Nana <axel.nana@workbud.com>
-     */
-    disconnect(): Promise<void>;
-    subscribe(topic: string, handler: WampSubscriptionHandler, options?: WampSubscriptionOptions): Promise<{
-        topic: string;
-        requestId: string;
-        subscriptionId: string;
-        subscriptionKey: string;
-    }>;
-    unsubscribe(subscriptionIdOrKey: string, handler?: WampSubscriptionHandler): Promise<{
-        topic: string;
-        requestId: string;
-    }>;
-    publish(topic: string, params?: Primitive | Array<any> | Record<string, Primitive | Array<any>> | {
-        argsList: Array<any>;
-        argsDict: Record<string, any>;
-    }, options?: {
-        exclude?: number | number[];
-        exclude_authid?: string | string[];
-        exclude_authrole?: string | string[];
-        eligible?: number | number[];
-        eligible_authid?: string | string[];
-        eligible_authrole?: string | string[];
-        exclude_me?: boolean;
-        disclose_me?: boolean;
-        ppt_scheme?: string;
-        ppt_serializer?: string;
-        ppt_cipher?: string;
-        ppt_keyid?: string;
-    }): Promise<{
-        topic: string;
-        requestId: string;
-        publicationId: string;
-    }>;
-    call(procedure: string, params?: Primitive | Array<any> | Record<string, Primitive | Array<any>> | {
-        argsList: Array<any>;
-        argsDict: Record<string, any>;
-    }, options?: {
-        disclose_me?: boolean;
-        progress_callback?(args: {
-            argsList: Array<any>;
-            argsDict: Record<string, any>;
-        }): void;
-        timeout?: number;
-        ppt_scheme?: string;
-        ppt_serializer?: string;
-        ppt_cipher?: string;
-        ppt_keyid?: string;
-    }): Promise<{
-        details: Record<string, any>;
-        argsList?: Array<any>;
-        argsDict?: Record<string, any>;
-    }>;
-    cancel(requestId: string, options?: {
-        mode?: 'kill' | 'killnowait' | 'skip';
-    }): true;
-    register(topic: string, handler: WampRegistrationHandler, options?: WampRegistrationOptions): Promise<{
-        topic: string;
-        requestId: string;
-        registrationId: string;
-    }>;
-    unregister(registrationId: string): Promise<{
-        topic: string;
-        requestId: string;
-    }>;
+    onReconnectSuccess?(details: Record<string, unknown>): void;
 };
+/**
+ * The WAMP client, as provided by Wampy.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export type WampClient = Wampy;
 /**
  * Data sent to a WAMP RPC.
  * @author Axel Nana <axel.nana@workbud.com>
@@ -210,25 +148,20 @@ export type WampRegistrationHandler = <T = any>(data: WampRegistrationHandlerArg
 export type WampSubscriptionHandler = <T = any>(data: WampSubscriptionHandlerArgs) => T;
 export declare namespace Wamp {
     /**
-     * Retrieves the client for a WAMP connection.
+     * Creates a service name for a WAMP connection.
      * @author Axel Nana <axel.nana@workbud.com>
      * @param name The name of the connection.
-     * @returns The Wampy client for the connection with the given name.
+     * @returns A service name for the connection.
      */
-    const getConnection: (name: string) => WampClient;
+    const getConnectionName: (name: string) => string;
     /**
-     * Creates and registers a new WAMP client.
-     *
-     * This will make the registered connection available for dependency injection with
-     * the key `wamp.connection.{name}`, where `{name}` is replaced with the given name.
-     *
+     * Retrieves the client for a WAMP connection declared by the {@link WampModule}.
      * @author Axel Nana <axel.nana@workbud.com>
-     *
      * @param name The name of the connection.
-     * @param config The configuration for the WAMP client.
-     * @returns The newly created and configured WAMP client for the given connection.
+     * @returns The Wampy client for the connection with the given name.
+     * @throws {ServiceNotFoundError} If no connection with that name is declared.
      */
-    const registerConnection: (name: string, config: WampClientProps) => WampClient;
+    const getConnection: (name?: string) => Wampy;
     /**
      * Checks if a WAMP connection with the given name exists.
      * @author Axel Nana <axel.nana@workbud.com>
@@ -241,14 +174,12 @@ export declare namespace Wamp {
      * @author Axel Nana <axel.nana@workbud.com>
      * @returns The default WAMP connection.
      */
-    const getDefaultConnection: () => WampClient;
+    const getDefaultConnection: () => Wampy;
     /**
-     * Sets the default WAMP connection.
+     * Creates a WAMP client and starts connecting it, retrying on failure.
      * @author Axel Nana <axel.nana@workbud.com>
-     * @param name The name of the connection to set as default.
-     * @returns The default WAMP connection.
      */
-    const setDefaultConnection: (name: string) => WampClient;
+    const createClient: (name: string, config: WampClientProps) => WampClient;
     /**
      * Marks a class as a WAMP controller.
      * @author Axel Nana <axel.nana@workbud.com>
@@ -270,3 +201,52 @@ export declare namespace Wamp {
      */
     const subscribe: (topic: string, options?: WampSubscriptionOptions) => MethodDecorator;
 }
+/**
+ * Configuration of the {@link WampModule}.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export type WampModuleConfig = {
+    /** The name of the connection that `default` resolves to. */
+    default: string;
+    /** The connections to declare, by name. */
+    connections: Record<string, WampClientProps>;
+};
+declare const WampModule_base: (abstract new () => {
+    get config(): WampModuleConfig;
+    onInit(): Promise<void> | void;
+    onDestroy(): Promise<void> | void;
+    onServe(_app: Elysia<any>): Promise<void> | void;
+}) & {
+    get config(): string;
+    with(config: Partial<WampModuleConfig> | (() => Partial<WampModuleConfig> | Promise<Partial<WampModuleConfig>>)): import("./module").ConfiguredModule<WampModuleConfig>;
+    resolveConfig(input?: Partial<WampModuleConfig>): WampModuleConfig;
+    register<TConfig = any>(props?: import("./module").ModuleProps<TConfig>): (target: import("./module").ModuleClass) => void;
+    configurable<TConfig extends object>(options?: {
+        defaults?: Partial<TConfig>;
+        required?: (keyof TConfig)[];
+    }): (abstract new () => {
+        get config(): TConfig;
+        onInit(): Promise<void> | void;
+        onDestroy(): Promise<void> | void;
+        onServe(_app: Elysia<any>): Promise<void> | void;
+    }) & {
+        get config(): string;
+        with(config: Partial<TConfig> | (() => Partial<TConfig> | Promise<Partial<TConfig>>)): import("./module").ConfiguredModule<TConfig>;
+        resolveConfig(input?: Partial<TConfig>): TConfig;
+        register<TConfig_1 = any>(props?: import("./module").ModuleProps<TConfig_1>): (target: import("./module").ModuleClass) => void;
+        configurable<TConfig extends object>(options?: {
+            defaults?: Partial<TConfig>;
+            required?: (keyof TConfig)[];
+        }): /*elided*/ any;
+    };
+};
+/**
+ * Declares WAMP connections as global services named `wamp.connection.{name}`, plus
+ * `wamp.connection.default` aliasing the configured default. Clients are created on first use.
+ * @author Axel Nana <axel.nana@workbud.com>
+ */
+export declare class WampModule extends WampModule_base {
+    /** Disconnects the clients that were created. */
+    onDestroy(): Promise<void>;
+}
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elysiumjs/core",
-  "version": "0.6.1",
+  "version": "0.8.0",
   "license": "Apache-2.0",
   "description": "A super-charged web framework for Bun, built on top of ElysiaJS.",
   "private": false,
@@ -13,7 +13,7 @@
   "scripts": {
     "format": "prettier --write \"./src/**/*.ts\"",
     "clean": "rimraf dist",
-    "build:js": "bun build ./src/index.ts --outdir ./dist --target bun --packages external --root ./src --minify",
+    "build:js": "bun build ./src/index.ts --outdir ./dist --target bun --packages external --root ./src --minify-syntax --minify-whitespace",
     "build:ts": "tsc",
     "build": "bun run clean && bun run build:js && bun run build:ts",
     "typecheck": "tsc --noEmit",
@@ -33,14 +33,10 @@
     "./src/index.ts"
   ],
   "dependencies": {
-    "@elysiajs/swagger": "^1.3.1",
-    "cache-manager": "^7.2.3",
-    "cacheable": "^2.0.3",
-    "drizzle-orm": "^0.44.6",
-    "elysia": "^1.4.9",
+    "@elysiajs/openapi": "^1.4.16",
+    "elysia": "^1.4.30",
     "radash": "^12.1.1",
-    "reflect-metadata": "^0.2.2",
-    "wampy": "^7.2.0"
+    "wampy": "^8.0.2"
   },
   "trustedDependencies": [
     "es5-ext"

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;
-}

package/dist/job.d.ts

@@ -1,105 +0,0 @@
-import 'reflect-metadata';
-import type { Class } from 'type-fest';
-import { InteractsWithConsole } from './console';
-/**
- * Properties required when declaring a job using the `@job()` decorator.
- * @author Axel Nana <axel.nana@workbud.com>
- */
-export type JobProps = {
-    /**
-     * The name of the job.
-     */
-    name?: string;
-    /**
-     * The queue on which the job should be processed.
-     */
-    queue?: string;
-};
-/**
- * Base class for background jobs.
- *
- * Jobs are classes that can be executed in the background. They provide
- * an abstract execute method that serves as the entry point for the job.
- *
- * @author Axel Nana <axel.nana@workbud.com>
- */
-export declare abstract class Job extends InteractsWithConsole {
-    #private;
-    /**
-     * Marks a class as a job.
-     * @author Axel Nana <axel.nana@workbud.com>
-     * @param options The decorator options.
-     */
-    static register(options?: JobProps): (target: Class<Job>) => void;
-    /**
-     * Unique identifier for the job.
-     */
-    readonly id: string;
-    /**
-     * The timestamp when the job was created.
-     */
-    readonly createdAt: Date;
-    /**
-     * The timestamp when the job started execution.
-     */
-    get startedAt(): Date | undefined;
-    /**
-     * The timestamp when the job completed execution.
-     */
-    get completedAt(): Date | undefined;
-    /**
-     * The current status of the job.
-     */
-    get status(): JobStatus;
-    /**
-     * Creates a new job instance.
-     *
-     * @param id Optional job ID. If not provided, a random ID will be generated.
-     */
-    constructor(id?: string);
-    /**
-     * Run the job.
-     * This method handles the job lifecycle and calls the execute method.
-     */
-    run(): Promise<void>;
-    /**
-     * Cancels the job.
-     */
-    cancel(): void;
-    /**
-     * The main execution method for the job.
-     * This must be implemented by all job classes.
-     */
-    protected abstract execute(): Promise<void>;
-    /**
-     * Generate a random job ID.
-     * @returns A random job ID.
-     */
-    private generateJobId;
-}
-/**
- * Possible statuses for a job.
- * @author Axel Nana <axel.nana@workbud.com>
- */
-export declare enum JobStatus {
-    /**
-     * The job is in pending state, meaning it has been added to the queue but has not yet been processed.
-     */
-    PENDING = "pending",
-    /**
-     * The job is in running state, meaning it is currently being processed.
-     */
-    RUNNING = "running",
-    /**
-     * The job has completed successfully.
-     */
-    COMPLETED = "completed",
-    /**
-     * The job has failed to complete successfully. If there are enough retries left, the job will be restarted.
-     */
-    FAILED = "failed",
-    /**
-     * The job has been cancelled by the user or another job.
-     */
-    CANCELLED = "cancelled"
-}