alepha 0.6.9 → 0.6.10

package/cache.d.ts

@@ -92,6 +92,7 @@ interface TSchema extends TKind, SchemaOptions {
 }
 
 declare class CacheProvider {
+    constructor();
     /**
      * Get the value of a key.
      *

package/core.d.ts

@@ -17,6 +17,13 @@ import { Readable } from 'node:stream';
  */
 declare const KIND: unique symbol;
 
+/**
+ * Used for identifying descriptors.
+ *
+ * @internal
+ */
+declare const OPTIONS: unique symbol;
+
 /**
  * Represents a value that can be either a value or a promise.
  */
@@ -84,42 +91,7 @@ interface ClassProvider<T extends object = any> {
     parents: Array<Class | null>;
 }
 
-/**
- * Used for identifying descriptors.
- *
- * @internal
- */
-declare const OPTIONS: unique symbol;
-
 declare const KEY = "HOOK";
-interface Hooks {
-    /**
-     * Triggered during the configuration phase. Before the start phase.
-     *
-     * - Configuration should technically be called many times without any side effects.
-     * - Spamming Alepha#configure() should not cause any issues.
-     */
-    configure: Alepha;
-    /**
-     * Triggered during the start phase. When `Alepha#start()` is called.
-     *
-     * - Start is called only once. It should not be called multiple times.
-     */
-    start: Alepha;
-    /**
-     * Triggered during the ready phase. After the start phase.
-     *
-     * - Ready is called only once. It should not be called multiple times.
-     */
-    ready: Alepha;
-    /**
-     * Triggered during the stop phase.
-     *
-     * - Stop is called only once. It should not be called multiple times.
-     * - Stop should be called after a SIGINT or SIGTERM signal in order to gracefully shutdown the application.
-     */
-    stop: Alepha;
-}
 interface HookOptions<T extends keyof Hooks> {
     /**
      * The name of the hook. "configure", "start", "ready", "stop", ...
@@ -442,6 +414,35 @@ interface State {
     afterEach?: (run: any) => any;
     onTestFinished?: (run: any) => any;
 }
+interface Hooks {
+    echo: any;
+    /**
+     * Triggered during the configuration phase. Before the start phase.
+     *
+     * - Configuration should technically be called many times without any side effects.
+     * - Spamming Alepha#configure() should not cause any issues.
+     */
+    configure: Alepha;
+    /**
+     * Triggered during the start phase. When `Alepha#start()` is called.
+     *
+     * - Start is called only once. It should not be called multiple times.
+     */
+    start: Alepha;
+    /**
+     * Triggered during the ready phase. After the start phase.
+     *
+     * - Ready is called only once. It should not be called multiple times.
+     */
+    ready: Alepha;
+    /**
+     * Triggered during the stop phase.
+     *
+     * - Stop is called only once. It should not be called multiple times.
+     * - Stop should be called after a SIGINT or SIGTERM signal in order to gracefully shutdown the application.
+     */
+    stop: Alepha;
+}
 /**
  *
  *
@@ -623,10 +624,11 @@ declare class Alepha {
         skipRegistration?: boolean;
         args?: any[];
     }): T;
-    on<T extends keyof Hooks>(event: T, hook: Hook<T>): () => void;
+    on<T extends keyof Hooks>(event: T, hookOrFunc: Hook<T> | ((payload: Hooks[T]) => Async<void>)): () => void;
     emit<T extends keyof Hooks>(func: keyof Hooks, payload: Hooks[T], options?: {
         reverse?: boolean;
         log?: boolean;
+        catch?: boolean;
     }): Promise<void>;
     /**
      * Casts the given value to the specified schema.
@@ -734,11 +736,15 @@ declare const $logger: (name?: string) => Logger;
  */
 interface RetryDescriptorOptions<T extends (...args: any[]) => any> {
     /**
+     * Maximum number of attempts.
      *
+     * @default 3
      */
     max?: number;
     /**
+     * Delay in milliseconds.
      *
+     * @default 0
      */
     delay?: number;
     /**
@@ -779,26 +785,6 @@ declare class TypeBoxError extends Error {
     constructor(value: ValueError);
 }
 
-interface EventEmitterItem<T extends object> {
-    name: keyof T;
-    handler: (arg: any) => Async<void>;
-}
-declare class EventEmitter<T extends object> {
-    protected events: EventEmitterItem<T>[];
-    /**
-     *
-     * @param name
-     * @param handler
-     */
-    on<Key extends keyof T>(name: Key, handler: (arg: T[Key]) => void): () => void;
-    /**
-     *
-     * @param name
-     * @param data
-     */
-    emit<Key extends keyof T>(name: Key, data: T[Key]): Promise<void>;
-}
-
 declare class TypeProvider {
     static DEFAULT_STRING_MAX_LENGTH: number;
     static DEFAULT_LONG_STRING_MAX_LENGTH: number;
@@ -995,4 +981,4 @@ declare const run: (arg: Alepha | Class | ((env?: Env) => Alepha), opts?: {
     ready?: (alepha: Alepha) => Async<void>;
 }) => Alepha;
 
-export { $cursor, $hook, $inject, $logger, $retry, Alepha, type AlephaStringOptions, AppNotStartedError, type Async, type AsyncFn, type AsyncLocalStorageData, AsyncLocalStorageProvider, COLORS, CircularDependencyError, type Class, type ClassEntry, type ClassProvider, type ClassSwap, ContainerLockedError, type CursorDescriptor, type Descriptor, type DescriptorIdentifier, type DescriptorItem, type Env, EventEmitter, type EventEmitterItem, EventEmitterLike, type FileLike, type Hook, type HookDescriptor, type HookOptions, type Hooks, KIND, LEVEL_COLORS, type LogLevel, Logger, type LoggerEnv, type LoggerOptions, MockLogger, type MockLoggerStore, NotImplementedError, OPTIONS, PROVIDER, type PromiseFn, type RetryDescriptorOptions, type State, type StreamLike, type TFile, type TStream, type TextLength, TypeBoxError, TypeProvider, __alephaRef, __bind, __descriptor, descriptorEvents, isDescriptorValue, isFileLike, isTypeFile, isTypeStream, isUUID, run, t };
+export { $cursor, $hook, $inject, $logger, $retry, Alepha, type AlephaStringOptions, AppNotStartedError, type Async, type AsyncFn, type AsyncLocalStorageData, AsyncLocalStorageProvider, COLORS, CircularDependencyError, type Class, type ClassEntry, type ClassProvider, type ClassSwap, ContainerLockedError, type CursorDescriptor, type Descriptor, type DescriptorIdentifier, type DescriptorItem, type Env, EventEmitterLike, type FileLike, type Hook, type HookDescriptor, type HookOptions, type Hooks, KIND, LEVEL_COLORS, type LogLevel, Logger, type LoggerEnv, type LoggerOptions, MockLogger, type MockLoggerStore, NotImplementedError, OPTIONS, PROVIDER, type PromiseFn, type RetryDescriptorOptions, type State, type StreamLike, type TFile, type TStream, type TextLength, TypeBoxError, TypeProvider, __alephaRef, __bind, __descriptor, descriptorEvents, isDescriptorValue, isFileLike, isTypeFile, isTypeStream, isUUID, run, t };

package/lock.d.ts

@@ -123,6 +123,7 @@ declare const $lock: {
  * Store Provider Interface
  */
 declare class LockProvider {
+    constructor();
     /**
      * Set the string value of a key.
      *
@@ -238,7 +239,7 @@ declare class MemoryLockProvider implements LockProvider {
 /**
  * A store provider that uses Redis.
  */
-declare class RedisLockProvider extends LockProvider {
+declare class RedisLockProvider implements LockProvider {
     protected readonly log: _alepha_core.Logger;
     protected readonly redisProvider: RedisProvider;
     /**

package/package.json

@@ -1,31 +1,37 @@
 {
 	"name": "alepha",
-	"version": "0.6.9",
+	"version": "0.6.10",
 	"type": "module",
 	"license": "MIT",
+	"description": "TypeScript framework for building full-stack apps with strict conventions, custom schemas, and React-based SPA or SSR without filesystem-based routing.",
+	"homepage": "https://github.com/feunard/alepha",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/feunard/alepha.git"
+	},
 	"main": "./core.js",
 	"types": "./core.d.ts",
 	"dependencies": {
-		"@alepha/cache": "0.6.9",
-		"@alepha/core": "0.6.9",
-		"@alepha/datetime": "0.6.9",
-		"@alepha/lock": "0.6.9",
-		"@alepha/postgres": "0.6.9",
-		"@alepha/queue": "0.6.9",
-		"@alepha/react": "0.6.9",
-		"@alepha/react-auth": "0.6.9",
-		"@alepha/redis": "0.6.9",
-		"@alepha/scheduler": "0.6.9",
-		"@alepha/security": "0.6.9",
-		"@alepha/server": "0.6.9",
-		"@alepha/server-cookies": "0.6.9",
-		"@alepha/server-metrics": "0.6.9",
-		"@alepha/server-proxy": "0.6.9",
-		"@alepha/server-static": "0.6.9",
-		"@alepha/server-swagger": "0.6.9",
-		"@alepha/testing": "0.6.9",
-		"@alepha/topic": "0.6.9",
-		"@alepha/vite": "0.6.9"
+		"@alepha/cache": "0.6.10",
+		"@alepha/core": "0.6.10",
+		"@alepha/datetime": "0.6.10",
+		"@alepha/lock": "0.6.10",
+		"@alepha/postgres": "0.6.10",
+		"@alepha/queue": "0.6.10",
+		"@alepha/react": "0.6.10",
+		"@alepha/react-auth": "0.6.10",
+		"@alepha/redis": "0.6.10",
+		"@alepha/scheduler": "0.6.10",
+		"@alepha/security": "0.6.10",
+		"@alepha/server": "0.6.10",
+		"@alepha/server-cookies": "0.6.10",
+		"@alepha/server-metrics": "0.6.10",
+		"@alepha/server-proxy": "0.6.10",
+		"@alepha/server-static": "0.6.10",
+		"@alepha/server-swagger": "0.6.10",
+		"@alepha/testing": "0.6.10",
+		"@alepha/topic": "0.6.10",
+		"@alepha/vite": "0.6.10"
 	},
 	"peerDependencies": {
 		"@types/react": "^19",

package/postgres.d.ts

@@ -114,6 +114,7 @@ type PgTableWithColumnsAndSchema<T extends TableConfig, R extends TObject$1> = P
 
 type SQLLike = SQLWrapper | string;
 declare class PostgresProvider {
+    constructor();
     /**
      * Get the database instance
      */

package/queue.d.ts

@@ -60,6 +60,7 @@ interface TSchema extends TKind, SchemaOptions {
 }
 
 declare class QueueProvider {
+    constructor();
     /**
      * Push a message to the queue.
      *

package/redis.d.ts

@@ -1,7 +1,7 @@
 import * as _alepha_core from '@alepha/core';
 import { Static, Alepha } from '@alepha/core';
 import * as Redis from 'ioredis';
-import Redis__default from 'ioredis';
+import Redis__default, { RedisOptions } from 'ioredis';
 
 /** Symbol key applied to readonly types */
 declare const ReadonlyKind: unique symbol;
@@ -110,6 +110,7 @@ declare class RedisProvider {
      * Close the connection to the Redis server.
      */
     close(): Promise<void>;
+    duplicate(options?: Partial<RedisOptions>): RedisClient;
     /**
      * Redis subscriber client factory method.
      */

package/server/proxy.d.ts

@@ -5,9 +5,10 @@ import { ServerRequest, ServerRouterProvider } from '@alepha/server';
 type ProxyDescriptorOptions = {
     path: string;
     target: string;
+    disabled?: boolean;
     beforeRequest?: (request: ServerRequest, proxyRequest: RequestInit) => Async<void>;
     afterResponse?: (request: ServerRequest, proxyResponse: Response) => Async<void>;
-    disabled?: boolean;
+    rewrite?: (url: URL) => void;
 };
 interface ProxyDescriptor {
     [KIND]: "PROXY";

package/server.d.ts

@@ -499,9 +499,14 @@ declare class HttpClient {
      * @protected
      */
     protected response(response: Response, options: FetchRunOptions): Promise<Response | any>;
+    protected isMaybeFile(response: Response): boolean;
     protected getFileLike(response: Response, defaultFileName?: string): FileLike;
     protected pathVariables(url: string, action: HttpClientLink, args?: ServerRequestConfigEntry): string;
-    protected queryParams(url: string, action: HttpClientLink, args?: ServerRequestConfigEntry): string;
+    queryParams(url: string, action: {
+        schema?: {
+            query?: TObject$1;
+        };
+    }, args?: ServerRequestConfigEntry): string;
     of<T extends object>(options?: {
         group?: string;
         host?: string | (() => string);
@@ -535,6 +540,8 @@ interface HttpClientLink {
     protected?: boolean;
     schema?: RequestConfigSchema;
     handler?: ServerHandler;
+    host?: string;
+    proxy?: boolean;
 }
 type HttpVirtualClient<T> = {
     [K in keyof T as T[K] extends RouteDescriptor ? K : never]: T[K] & {
@@ -548,11 +555,23 @@ interface RemoteDescriptorOptions {
      * The URL of the remote service.
      */
     url: string | (() => string);
+    /**
+     * @default "/api/_links"
+     */
+    linkPath?: string;
+    /**
+     * If true, all methods of the remote service will be exposed as actions.
+     */
+    proxy?: boolean | {
+        beforeRequest?: (request: ServerRequest, proxyRequest: RequestInit) => Async<void>;
+        afterResponse?: (request: ServerRequest, proxyResponse: Response) => Async<void>;
+        rewrite?: (url: URL) => void;
+    };
     /**
      * One or many instance of classes to be registered as remote services.
      * Services must contain some $action() descriptors.
      */
-    services: object | Array<object>;
+    services?: object | Array<object>;
     /**
      * The name of the remote service.
      *
@@ -570,6 +589,7 @@ declare const $remote: {
 };
 
 declare class ServerProvider {
+    constructor();
     get hostname(): string;
 }
 
@@ -596,7 +616,14 @@ declare class ServerActionDescriptorProvider {
     protected readonly actions: ServerRouteAction[];
     getActions(): ServerRouteAction<RequestConfigSchema>[];
     readonly configure: _alepha_core.HookDescriptor<"configure">;
-    registerRemote(value: RemoteDescriptor, key: string): void;
+    registerRemote(value: RemoteDescriptor, key: string): Promise<void>;
+    loadRemoteLinks: (options: RemoteDescriptorOptions) => Promise<Promise<void>>;
+    proxy(url: string, link: HttpClientLink, options: {
+        beforeRequest?: (request: ServerRequest, proxyRequest: RequestInit) => Async<void>;
+        afterResponse?: (request: ServerRequest, proxyResponse: Response) => Async<void>;
+        rewrite?: (url: URL) => void;
+    }): Promise<void>;
+    private getRawRequestBody;
     registerAction(value: RouteDescriptor, key: string, instance: any, prefix?: string): Promise<void>;
     /**
      * When your action has no handler, it's considered as an 'API'.
@@ -654,6 +681,7 @@ interface ServerRemote {
     url: string;
     services: object[];
     name: string;
+    proxy: boolean;
 }
 interface ServerRouteAction<TConfig extends RequestConfigSchema = RequestConfigSchema> extends ServerRoute<TConfig> {
     method: RouteMethod;
@@ -720,7 +748,7 @@ declare class ServerMultipartProvider {
     protected readonly helper: RouteDescriptorHelper;
     protected readonly alepha: Alepha;
     readonly onRequest: _alepha_core.HookDescriptor<"server:onRequest">;
-    readonly onSend: _alepha_core.HookDescriptor<"server:onSend">;
+    readonly onSend: _alepha_core.HookDescriptor<"server:onResponse">;
     handleMultipartBodyFromNode(route: ServerRoute, stream: IncomingMessage): Promise<{
         body: Record<string, any>;
         cleanup: () => Promise<void>;

package/topic.d.ts

@@ -47,6 +47,7 @@ interface TSchema extends TKind, SchemaOptions {
 }
 
 declare class TopicProvider {
+    constructor();
     /**
      * Publish a message to a topic.
      *