alepha 0.9.3 → 0.9.4

package/README.md

@@ -45,3 +45,49 @@ run(App);
 ```
 
 👉 For more information, please visit the [documentation](https://feunard.github.io/alepha/).
+
+## Modules
+
+Alepha is modular, with a LOT of modules.
+
+### Core & Application Layer
+
+*   **Core ([@alepha/core](https://feunard.github.io/alepha/docs/alepha-core)) 📦:** The heart of the framework, providing a powerful dependency injection container, application lifecycle management, and the core descriptor system.
+*   **Server ([@alepha/server](https://feunard.github.io/alepha/docs/alepha-server)) 🌐:** A high-performance, minimalist HTTP server for creating type-safe REST APIs using declarative `$action` descriptors.
+*   **Database ([@alepha/postgres](https://feunard.github.io/alepha/docs/alepha-postgres)) 🗄️:** A powerful and type-safe ORM built on Drizzle. Define your schema with `$entity` and get fully-typed repositories with `$repository`.
+*   **React ([@alepha/react](https://feunard.github.io/alepha/docs/alepha-react)) ⚛️:** Build full-stack, server-side rendered React applications with a file-based routing system (`$page`) that handles data fetching, hydration, and type-safe props.
+
+### Backend Infrastructure & Abstractions
+
+*   **Security ([@alepha/security](https://feunard.github.io/alepha/docs/alepha-security)) 🛡️:** A complete authentication and authorization system. Manage roles (`$role`), permissions (`$permission`), JWTs, and realms (`$realm`).
+*   **Queue ([@alepha/queue](https://feunard.github.io/alepha/docs/alepha-queue)) ⏳:** A simple and robust interface for background job processing. Define workers with the `$queue` descriptor and integrate with backends like Redis.
+*   **Cache ([@alepha/cache](https://feunard.github.io/alepha/docs/alepha-cache)) ⚡:** A flexible caching layer with support for TTL, automatic function caching (`$cache`), and multiple backends like in-memory or Redis.
+*   **Bucket ([@alepha/bucket](https://feunard.github.io/alepha/docs/alepha-bucket)) ☁️:** A unified API for file and object storage. Abstract away the details of local, in-memory, or cloud storage providers like Azure Blob Storage.
+*   **Scheduler ([@alepha/scheduler](https://feunard.github.io/alepha/docs/alepha-scheduler)) ⏰:** Schedule recurring tasks using cron expressions or fixed intervals with the `$scheduler` descriptor, with built-in support for distributed locking.
+*   **Topic ([@alepha/topic](https://feunard.github.io/alepha/docs/alepha-topic)) 📢:** A publish-subscribe (pub/sub) messaging interface for building event-driven architectures with `$topic` and `$subscriber`.
+*   **Lock ([@alepha/lock](https://feunard.github.io/alepha/docs/alepha-lock)) 🔒:** A distributed locking mechanism to ensure safe concurrent access to shared resources, using Redis or other backends.
+
+### Server Middleware & Plugins
+
+*   **Links ([@alepha/server-links](https://feunard.github.io/alepha/docs/alepha-server-links)) 🔗:** Enables end-to-end type-safe communication between your frontend and backend, or between microservices, with the `$client` descriptor.
+*   **Swagger ([@alepha/server-swagger](https://feunard.github.io/alepha/docs/alepha-server-swagger)) 📜:** Automatically generate OpenAPI 3.0 documentation and a beautiful Swagger UI for all your `$action` API endpoints.
+*   **Helmet ([@alepha/server-helmet](https://feunard.github.io/alepha/docs/alepha-server-helmet)) 🎩:** Enhance your application's security by automatically applying essential HTTP security headers like CSP and HSTS.
+*   **CORS ([@alepha/server-cors](https://feunard.github.io/alepha/docs/alepha-server-cors)) ↔️:** A configurable middleware to handle Cross-Origin Resource Sharing (CORS) for your server.
+*   **Multipart ([@alepha/server-multipart](https://feunard.github.io/alepha/docs/alepha-server-multipart)) 📎:** Seamlessly handle `multipart/form-data` requests for file uploads.
+*   **Compress ([@alepha/server-compress](https://feunard.github.io/alepha/docs/alepha-server-compress)) 📦💨:** Automatically compress server responses with Gzip or Brotli to improve performance.
+
+And more, like **Request Logging**, **Error Handling**, and **Response Caching**, cookie parsers, and more, to enhance your server's capabilities.
+
+### Full-Stack & React Ecosystem
+
+*   **Auth ([@alepha/react-auth](https://feunard.github.io/alepha/docs/alepha-react-auth)) 🔑:** Simplifies frontend authentication flows, providing the `useAuth` hook to manage user sessions and permissions in your React components.
+*   **Head ([@alepha/react-head](https://feunard.github.io/alepha/docs/alepha-react-head))  SEO:** Manage your document's `<head>` for SEO and metadata. Control titles, meta tags, and more, both on the server and client.
+*   **i18n ([@alepha/react-i18n](https://feunard.github.io/alepha/docs/alepha-react-i18n)) 🌍:** A complete internationalization solution for your React applications, with support for lazy-loaded translation files and the `useI18n` hook.
+*   **Form ([@alepha/react-form](https://feunard.github.io/alepha/docs/alepha-react-form)) 📝:** Create powerful, type-safe forms with automatic validation using the `useForm` hook, powered by your TypeBox schemas.
+
+### Tooling & Utilities
+
+*   **Vite ([@alepha/vite](https://feunard.github.io/alepha/docs/alepha-vite)) ✨:** A seamless Vite plugin that handles all the complex build and development server configurations for your full-stack Alepha applications.
+*   **Command ([@alepha/command](https://feunard.github.io/alepha/docs/alepha-command)) ⌨️:** Build powerful, type-safe command-line interfaces and scripts directly within your application using the `$command` descriptor.
+*   **Retry ([@alepha/retry](https://feunard.github.io/alepha/docs/alepha-retry)) 🔄:** A declarative and powerful decorator (`$retry`) for automatically retrying failed operations with exponential backoff.
+

package/batch.d.ts

@@ -1,7 +1,7 @@
 import * as _alepha_core1 from "alepha";
-import * as _alepha_core0 from "alepha";
 import { Descriptor, KIND, Static, TSchema } from "alepha";
 import { DateTimeProvider, DurationLike } from "alepha/datetime";
+import * as _alepha_logger0 from "alepha/logger";
 import * as _alepha_retry0 from "alepha/retry";
 import { RetryDescriptorOptions } from "alepha/retry";
 
@@ -52,7 +52,7 @@ interface BatchDescriptorOptions<TItem extends TSchema, TResponse = any> {
   retry?: Omit<RetryDescriptorOptions<() => Array<Static<TItem>>>, "handler">;
 }
 declare class BatchDescriptor<TItem extends TSchema, TResponse = any> extends Descriptor<BatchDescriptorOptions<TItem, TResponse>> {
-  protected readonly log: _alepha_core1.Logger;
+  protected readonly log: _alepha_logger0.Logger;
   protected readonly dateTime: DateTimeProvider;
   protected readonly partitions: Map<any, any>;
   protected activeHandlers: PromiseWithResolvers<void>[];
@@ -68,7 +68,6 @@ declare class BatchDescriptor<TItem extends TSchema, TResponse = any> extends De
   protected flushPartition(partitionKey: string): Promise<void>;
   protected readonly dispose: _alepha_core1.HookDescriptor<"stop">;
 }
-//# sourceMappingURL=$batch.d.ts.map
 //#endregion
 //#region src/index.d.ts
 /**
@@ -105,9 +104,7 @@ declare class BatchDescriptor<TItem extends TSchema, TResponse = any> extends De
  * @see {@link $batch}
  * @module alepha.batch
  */
-declare const AlephaBatch: _alepha_core0.Service<_alepha_core0.Module>;
-//# sourceMappingURL=index.d.ts.map
-
+declare const AlephaBatch: _alepha_core1.Service<_alepha_core1.Module>;
 //#endregion
 export { $batch, AlephaBatch, BatchDescriptor, BatchDescriptorOptions };
 //# sourceMappingURL=index.d.ts.map

package/bucket.d.ts

@@ -1,7 +1,7 @@
 import * as _alepha_core1 from "alepha";
-import * as _alepha_core0 from "alepha";
-import { Alepha, Descriptor, FileLike, KIND, Service } from "alepha";
+import { Alepha, AlephaError, Descriptor, FileLike, KIND, Service } from "alepha";
 import * as fs from "node:fs";
+import * as _alepha_logger0 from "alepha/logger";
 import * as _sinclair_typebox0 from "@sinclair/typebox";
 
 //#region src/providers/FileStorageProvider.d.ts
@@ -39,7 +39,6 @@ declare abstract class FileStorageProvider {
    */
   abstract delete(bucketName: string, fileId: string): Promise<void>;
 }
-//# sourceMappingURL=FileStorageProvider.d.ts.map
 //#endregion
 //#region src/providers/MemoryFileStorageProvider.d.ts
 declare class MemoryFileStorageProvider implements FileStorageProvider {
@@ -50,8 +49,6 @@ declare class MemoryFileStorageProvider implements FileStorageProvider {
   delete(bucketName: string, fileId: string): Promise<void>;
   protected createId(): string;
 }
-//# sourceMappingURL=MemoryFileStorageProvider.d.ts.map
-
 //#endregion
 //#region src/descriptors/$bucket.d.ts
 /**
@@ -85,7 +82,7 @@ interface BucketDescriptorOptions extends BucketFileOptions {
   name?: string;
 }
 declare class BucketDescriptor extends Descriptor<BucketDescriptorOptions> {
-  readonly provider: MemoryFileStorageProvider | FileStorageProvider;
+  readonly provider: FileStorageProvider | MemoryFileStorageProvider;
   get name(): string;
   /**
    * Uploads a file to the bucket.
@@ -103,7 +100,7 @@ declare class BucketDescriptor extends Descriptor<BucketDescriptorOptions> {
    * Downloads a file from the bucket.
    */
   download(fileId: string): Promise<FileLike>;
-  protected $provider(): MemoryFileStorageProvider | FileStorageProvider;
+  protected $provider(): FileStorageProvider | MemoryFileStorageProvider;
 }
 interface BucketFileOptions {
   /**
@@ -121,18 +118,17 @@ interface BucketFileOptions {
    */
   maxSize?: number;
 }
-//# sourceMappingURL=$bucket.d.ts.map
 //#endregion
 //#region src/errors/FileNotFoundError.d.ts
-declare class FileNotFoundError extends Error {
+declare class FileNotFoundError extends AlephaError {
   readonly status = 404;
 }
-//# sourceMappingURL=FileNotFoundError.d.ts.map
 //#endregion
 //#region src/providers/LocalFileStorageProvider.d.ts
 declare class LocalFileStorageProvider implements FileStorageProvider {
   static METADATA_HEADER_LENGTH: number;
   protected readonly alepha: Alepha;
+  protected readonly log: _alepha_logger0.Logger;
   options: {
     storagePath: string;
   };
@@ -151,7 +147,6 @@ declare const fileMetadataSchema: _sinclair_typebox0.TObject<{
   type: _sinclair_typebox0.TString;
   size: _sinclair_typebox0.TNumber;
 }>;
-//# sourceMappingURL=LocalFileStorageProvider.d.ts.map
 //#endregion
 //#region src/index.d.ts
 declare module "alepha" {
@@ -186,9 +181,7 @@ declare module "alepha" {
  * @see {@link FileStorageProvider}
  * @module alepha.bucket
  */
-declare const AlephaBucket: _alepha_core0.Service<_alepha_core0.Module>;
-//# sourceMappingURL=index.d.ts.map
-
+declare const AlephaBucket: _alepha_core1.Service<_alepha_core1.Module>;
 //#endregion
 export { $bucket, AlephaBucket, BucketDescriptor, BucketDescriptorOptions, BucketFileOptions, FileNotFoundError, FileStorageProvider, LocalFileStorageProvider, MemoryFileStorageProvider, fileMetadataSchema };
 //# sourceMappingURL=index.d.ts.map

package/cache/redis.d.ts

@@ -1,7 +1,7 @@
 import { CacheProvider } from "alepha/cache";
 import * as _alepha_core1 from "alepha";
-import * as _alepha_core0 from "alepha";
-import { Alepha, Logger, Static } from "alepha";
+import { Alepha, Static } from "alepha";
+import * as _alepha_logger0 from "alepha/logger";
 import { RedisProvider } from "alepha/redis";
 
 //#region src/providers/RedisCacheProvider.d.ts
@@ -12,9 +12,11 @@ declare module "alepha" {
   interface Env extends Partial<Static<typeof envSchema>> {}
 }
 declare class RedisCacheProvider implements CacheProvider {
-  protected readonly log: Logger;
+  protected readonly log: _alepha_logger0.Logger;
   protected readonly redisProvider: RedisProvider;
-  protected readonly env: Static<typeof envSchema>;
+  protected readonly env: {
+    REDIS_CACHE_PREFIX?: string | undefined;
+  };
   protected readonly alepha: Alepha;
   get(name: string, key: string): Promise<Uint8Array | undefined>;
   set(name: string, key: string, value: Uint8Array | string, ttl?: number): Promise<Uint8Array>;
@@ -31,9 +33,7 @@ declare class RedisCacheProvider implements CacheProvider {
  * @see {@link RedisCacheProvider}
  * @module alepha.cache.redis
  */
-declare const AlephaCacheRedis: _alepha_core0.Service<_alepha_core0.Module>;
-//# sourceMappingURL=index.d.ts.map
-
+declare const AlephaCacheRedis: _alepha_core1.Service<_alepha_core1.Module>;
 //#endregion
 export { AlephaCacheRedis, RedisCacheProvider };
 //# sourceMappingURL=index.d.ts.map

package/cache.d.ts

@@ -1,7 +1,7 @@
-import * as _alepha_core1 from "alepha";
 import * as _alepha_core0 from "alepha";
 import { Descriptor, InstantiableClass, KIND } from "alepha";
 import { DateTimeProvider, DurationLike, Timeout } from "alepha/datetime";
+import * as _alepha_logger0 from "alepha/logger";
 
 //#region src/providers/CacheProvider.d.ts
 /**
@@ -41,7 +41,6 @@ declare abstract class CacheProvider {
   abstract has(name: string, key: string): Promise<boolean>;
   abstract keys(name: string, filter?: string): Promise<string[]>;
 }
-//# sourceMappingURL=CacheProvider.d.ts.map
 //#endregion
 //#region src/descriptors/$cache.d.ts
 /**
@@ -116,7 +115,6 @@ interface CacheDescriptorFn<TReturn = any, TParameter extends any[] = any[]> ext
    */
   (...args: TParameter): Promise<TReturn>;
 }
-//# sourceMappingURL=$cache.d.ts.map
 //#endregion
 //#region src/providers/MemoryCacheProvider.d.ts
 type CacheName = string;
@@ -127,7 +125,7 @@ type CacheValue = {
 };
 declare class MemoryCacheProvider implements CacheProvider {
   protected readonly dateTimeProvider: DateTimeProvider;
-  protected readonly log: _alepha_core1.Logger;
+  protected readonly log: _alepha_logger0.Logger;
   protected store: Record<CacheName, Record<CacheKey, CacheValue>>;
   get(name: string, key: string): Promise<Uint8Array | undefined>;
   set(name: string, key: string, value: Uint8Array, ttl?: number): Promise<Uint8Array>;
@@ -149,8 +147,6 @@ declare class MemoryCacheProvider implements CacheProvider {
  * @module alepha.cache
  */
 declare const AlephaCache: _alepha_core0.Service<_alepha_core0.Module>;
-//# sourceMappingURL=index.d.ts.map
-
 //#endregion
 export { $cache, AlephaCache, CacheDescriptor, CacheDescriptorFn, CacheDescriptorOptions, CacheProvider, MemoryCacheProvider };
 //# sourceMappingURL=index.d.ts.map

package/command.d.ts

@@ -1,8 +1,8 @@
 import * as _alepha_core1 from "alepha";
-import * as _alepha_core0 from "alepha";
-import { Alepha, AlephaError, Async, Descriptor, KIND, Logger, Static, TObject, TSchema } from "alepha";
+import { Alepha, AlephaError, Async, Descriptor, KIND, Static, TObject, TSchema } from "alepha";
 import * as fs from "node:fs/promises";
 import { glob } from "node:fs/promises";
+import * as _alepha_logger0 from "alepha/logger";
 import * as _sinclair_typebox0 from "@sinclair/typebox";
 
 //#region src/helpers/Runner.d.ts
@@ -30,11 +30,11 @@ interface RunnerMethod {
   cp: (source: string, dest: string, options?: RunOptions) => Promise<string>;
 }
 declare class Runner {
-  protected readonly log: Logger;
+  protected readonly log: _alepha_logger0.Logger;
   protected readonly timers: Timer[];
   protected readonly startTime: number;
   readonly run: RunnerMethod;
-  constructor(log: Logger);
+  constructor();
   protected createRunMethod(): RunnerMethod;
   protected exec(cmd: string): Promise<string>;
   /**
@@ -101,13 +101,11 @@ interface CommandHandlerArgs<T extends TObject> {
   glob: typeof glob;
   fs: typeof fs;
 }
-//# sourceMappingURL=$command.d.ts.map
 //#endregion
 //#region src/errors/CommandError.d.ts
 declare class CommandError extends AlephaError {
   readonly name = "CommandError";
 }
-//# sourceMappingURL=CommandError.d.ts.map
 //#endregion
 //#region src/providers/CliProvider.d.ts
 declare const envSchema: TObject<{
@@ -118,9 +116,13 @@ declare module "alepha" {
   interface Env extends Partial<Static<typeof envSchema>> {}
 }
 declare class CliProvider {
-  protected readonly env: Static<typeof envSchema>;
+  protected readonly env: {
+    CLI_NAME: string;
+    CLI_DESCRIPTION: string;
+  };
   protected readonly alepha: Alepha;
-  protected readonly log: Logger;
+  protected readonly log: _alepha_logger0.Logger;
+  protected readonly runner: Runner;
   options: {
     name: string;
     description: string;
@@ -157,7 +159,7 @@ declare class CliProvider {
  * @see {@link $command}
  * @module alepha.command
  */
-declare const AlephaCommand: _alepha_core0.Service<_alepha_core0.Module>;
+declare const AlephaCommand: _alepha_core1.Service<_alepha_core1.Module>;
 declare module "@sinclair/typebox" {
   interface StringOptions {
     /**
@@ -168,8 +170,6 @@ declare module "@sinclair/typebox" {
     aliases?: string[];
   }
 }
-//# sourceMappingURL=index.d.ts.map
-
 //#endregion
 export { $command, AlephaCommand, CliProvider, CommandDescriptor, CommandDescriptorOptions, CommandError, CommandHandlerArgs, RunOptions, Runner, RunnerMethod, Task };
 //# sourceMappingURL=index.d.ts.map