alepha 0.7.3 → 0.7.4

package/scheduler.d.ts

@@ -5,6 +5,14 @@ import * as _alepha_lock from '@alepha/lock';
 import { ScheduledTask } from 'node-cron';
 
 declare const KEY = "SCHEDULER";
+/**
+ * Scheduler descriptor.
+ */
+declare const $scheduler: {
+    (options: SchedulerDescriptorOptions): SchedulerDescriptor;
+    [KIND]: string;
+};
+declare const isScheduler: (value: any) => value is SchedulerDescriptor;
 type SchedulerDescriptorOptions = {
     /**
      * Function to run on schedule.
@@ -37,17 +45,6 @@ interface SchedulerDescriptor {
     [OPTIONS]: SchedulerDescriptorOptions;
     (): Promise<void>;
 }
-/**
- * Scheduler descriptor.
- *
- * @param options - The scheduler options.
- * @returns The descriptor value.
- */
-declare const $scheduler: {
-    (options: SchedulerDescriptorOptions): SchedulerDescriptor;
-    [KIND]: string;
-};
-declare const isScheduler: (value: any) => value is SchedulerDescriptor;
 
 /** Symbol key applied to readonly types */
 declare const ReadonlyKind: unique symbol;
@@ -157,9 +154,6 @@ declare class SchedulerDescriptorProvider {
     protected run(options: SchedulerDescriptorOptions): Promise<void>;
     /**
      * Prefix the scheduler key.
-     *
-     * @param key
-     * @protected
      */
     protected prefix(key: string): string;
     /**
@@ -177,9 +171,17 @@ interface Scheduler {
     interval?: Interval;
 }
 
-declare class SchedulerModule {
-    protected readonly alepha: Alepha;
-    constructor();
+/**
+ * Alepha Scheduler Module
+ *
+ * Generic interface for scheduling tasks.
+ *
+ * @see {@link $scheduler}
+ * @module alepha.scheduler
+ */
+declare class AlephaScheduler {
+    readonly name = "alepha.scheduler";
+    readonly $services: (alepha: Alepha) => Alepha;
 }
 
-export { $scheduler, type Scheduler, type SchedulerDescriptor, type SchedulerDescriptorOptions, SchedulerDescriptorProvider, SchedulerModule, isScheduler };
+export { $scheduler, AlephaScheduler, type Scheduler, type SchedulerDescriptor, type SchedulerDescriptorOptions, SchedulerDescriptorProvider, isScheduler };

package/security.d.ts

@@ -697,9 +697,9 @@ declare module "alepha/core" {
         };
     }
 }
-declare class SecurityModule {
-    protected readonly alepha: Alepha;
-    constructor();
+declare class AlephaSecurity {
+    readonly name = "alepha.security";
+    readonly $services: (alepha: Alepha) => Alepha;
 }
 
-export { $permission, $realm, $role, $serviceAccount, type AccessTokenResponse, type ExtendedJWTPayload, InvalidPermissionError, type JwtParseResult, JwtProvider, type JwtServiceAccountDescriptorOptions, type JwtSignOptions, type KeyLoader, type KeyLoaderHolder, type Oauth2ServiceAccountDescriptorOptions, type Permission, type PermissionDescriptor, type PermissionDescriptorOptions, type Realm, type RealmConfig, type RealmDescriptor, type RealmDescriptorOptions, type Role, type RoleDescriptor, type RoleDescriptorOptions, type SecurityCheckResult, SecurityError, SecurityModule, SecurityProvider, type SecurityUserAccountProvider, type ServiceAccountDescriptor, type ServiceAccountDescriptorOptions, type ServiceAccountStore, type UserAccountInfo, type UserAccountToken, permissionSchema, roleSchema };
+export { $permission, $realm, $role, $serviceAccount, type AccessTokenResponse, AlephaSecurity, type ExtendedJWTPayload, InvalidPermissionError, type JwtParseResult, JwtProvider, type JwtServiceAccountDescriptorOptions, type JwtSignOptions, type KeyLoader, type KeyLoaderHolder, type Oauth2ServiceAccountDescriptorOptions, type Permission, type PermissionDescriptor, type PermissionDescriptorOptions, type Realm, type RealmConfig, type RealmDescriptor, type RealmDescriptorOptions, type Role, type RoleDescriptor, type RoleDescriptorOptions, type SecurityCheckResult, SecurityError, SecurityProvider, type SecurityUserAccountProvider, type ServiceAccountDescriptor, type ServiceAccountDescriptorOptions, type ServiceAccountStore, type UserAccountInfo, type UserAccountToken, permissionSchema, roleSchema };

package/server/cache.d.ts

@@ -1,5 +1,5 @@
 import * as _alepha_core from '@alepha/core';
-import { Alepha, OPTIONS } from '@alepha/core';
+import { Alepha, OPTIONS, Module } from '@alepha/core';
 import { CacheDescriptorOptions, CacheDescriptorProvider, Cache } from '@alepha/cache';
 import { DurationLike, DateTimeProvider } from '@alepha/datetime';
 import { ServerHandler, ServerRequestConfig } from '@alepha/server';
@@ -43,9 +43,9 @@ type RouteLike = {
     handler?: ServerHandler;
 };
 
-declare class ServerCacheModule {
-    protected readonly alepha: Alepha;
-    constructor();
+declare class AlephaServerCache implements Module {
+    readonly name = "alepha.server.cache";
+    readonly $services: (alepha: Alepha) => Alepha;
 }
 
-export { ServerCacheModule, ServerCacheProvider, type ServiceRouteCache };
+export { AlephaServerCache, ServerCacheProvider, type ServiceRouteCache };

package/server/swagger.d.ts

@@ -1,5 +1,5 @@
 import * as _alepha_core from '@alepha/core';
-import { KIND, OPTIONS, Alepha, TObject } from '@alepha/core';
+import { KIND, OPTIONS, Alepha, TObject, Module } from '@alepha/core';
 import { OpenAPIV3 } from 'openapi-types';
 import { ServerActionDescriptorProvider, ServerRouterProvider, ServerRouteAction } from '@alepha/server';
 import { ServerStaticProvider } from '@alepha/server-static';
@@ -100,4 +100,9 @@ declare class ServerSwaggerProvider {
     protected configureSwaggerUi(prefix: string, options: SwaggerDescriptorOptions): Promise<void>;
 }
 
-export { $swagger, ServerSwaggerProvider, type SwaggerDescriptor, type SwaggerDescriptorOptions, type SwaggerUiOptions };
+declare class AlephaServerSwagger implements Module {
+    readonly name = "alepha.server.swagger";
+    readonly $services: (alepha: Alepha) => Alepha;
+}
+
+export { $swagger, AlephaServerSwagger, ServerSwaggerProvider, type SwaggerDescriptor, type SwaggerDescriptorOptions, type SwaggerUiOptions };

package/server.d.ts

@@ -1,5 +1,5 @@
 import * as _alepha_core from '@alepha/core';
-import { Static as Static$1, TObject as TObject$1, TSchema as TSchema$2, Async, StreamLike, Alepha, FileLike, OPTIONS, KIND, Service } from '@alepha/core';
+import { Static as Static$1, TObject as TObject$1, TSchema as TSchema$2, Async, StreamLike, Alepha, FileLike, OPTIONS, KIND, Module } from '@alepha/core';
 export { KIND } from '@alepha/core';
 import { UserAccountToken, Permission, ServiceAccountDescriptor as ServiceAccountDescriptor$1, SecurityProvider, JwtProvider } from '@alepha/security';
 import { IncomingMessage, ServerResponse as ServerResponse$1 } from 'node:http';
@@ -1120,8 +1120,6 @@ type Ok = Static$1<typeof okSchema>;
 declare const envSchema: _alepha_core.TObject<{
     SERVER_LINKS_ENABLED: TBoolean;
     SERVER_HEALTH_ENABLED: TBoolean;
-    SERVER_NOT_READY_ENABLED: TBoolean;
-    SERVER_TIMING_ENABLED: TOptional<TBoolean>;
 }>;
 declare module "@alepha/core" {
     interface Hooks {
@@ -1168,16 +1166,13 @@ declare module "@alepha/core" {
     interface Env extends Partial<Static$1<typeof envSchema>> {
     }
 }
-declare class ServerModule {
-    static plugins: Array<Service>;
+declare class AlephaServer implements Module {
     protected readonly env: {
-        SERVER_TIMING_ENABLED?: boolean | undefined;
         SERVER_LINKS_ENABLED: boolean;
         SERVER_HEALTH_ENABLED: boolean;
-        SERVER_NOT_READY_ENABLED: boolean;
     };
-    protected readonly alepha: Alepha;
-    constructor();
+    readonly name = "alepha.server";
+    readonly $services: (alepha: Alepha) => void;
 }
 
-export { $action, $client, $proxy, $remote, $route, type ActionDescriptor, type ActionDescriptorOptions, type ApiLink, type ApiLinksResponse, BadRequestError, type ClientRequestEntry, type ClientRequestEntryContainer, type ClientRequestOptions, type ClientRequestResponse, type ClientScope, ConflictError, type FetchFactoryAdditionalOptions, type FetchLinkArgs, type FetchResponse, type FetchRunOptions, ForbiddenError, HttpClient, type HttpClientLink, type HttpClientPendingRequests, HttpError, type HttpErrorLike, type HttpVirtualClient, NodeHttpServerProvider, NotFoundError, type Ok, type ProxyDescriptor, type ProxyDescriptorOptions, ProxyDescriptorProvider, type RemoteDescriptor, type RemoteDescriptorOptions, RemoteDescriptorProvider, type RequestConfigSchema, type ResponseBodyType, type ResponseType, type RouteDescriptor, type RouteDescriptorOptions, type RouteMethod, ServerActionDescriptorProvider, type ServerHandler, ServerHealthProvider, ServerLinksProvider, ServerLoggerProvider, type ServerMiddlewareHandler, ServerModule, ServerMultipartProvider, ServerNotReadyProvider, ServerProvider, type ServerRawRequest, type ServerRemote, type ServerReply, type ServerRequest, type ServerRequestConfig, type ServerRequestConfigEntry, type ServerResponse, type ServerResponseBody, type ServerRoute, type ServerRouteAction, type ServerRouteSecure, type ServerRouteWithHandler, ServerRouterProvider, ServerSecurityProvider, ServerTimingProvider, UnauthorizedError, ValidationError, apiLinkSchema, apiLinksResponseSchema, errorNameByStatus, errorSchema, isHttpError, isServerAction, okSchema, routeMethods };
+export { $action, $client, $proxy, $remote, $route, type ActionDescriptor, type ActionDescriptorOptions, AlephaServer, type ApiLink, type ApiLinksResponse, BadRequestError, type ClientRequestEntry, type ClientRequestEntryContainer, type ClientRequestOptions, type ClientRequestResponse, type ClientScope, ConflictError, type FetchFactoryAdditionalOptions, type FetchLinkArgs, type FetchResponse, type FetchRunOptions, ForbiddenError, HttpClient, type HttpClientLink, type HttpClientPendingRequests, HttpError, type HttpErrorLike, type HttpVirtualClient, NodeHttpServerProvider, NotFoundError, type Ok, type ProxyDescriptor, type ProxyDescriptorOptions, ProxyDescriptorProvider, type RemoteDescriptor, type RemoteDescriptorOptions, RemoteDescriptorProvider, type RequestConfigSchema, type ResponseBodyType, type ResponseType, type RouteDescriptor, type RouteDescriptorOptions, type RouteMethod, ServerActionDescriptorProvider, type ServerHandler, ServerHealthProvider, ServerLinksProvider, ServerLoggerProvider, type ServerMiddlewareHandler, ServerMultipartProvider, ServerNotReadyProvider, ServerProvider, type ServerRawRequest, type ServerRemote, type ServerReply, type ServerRequest, type ServerRequestConfig, type ServerRequestConfigEntry, type ServerResponse, type ServerResponseBody, type ServerRoute, type ServerRouteAction, type ServerRouteSecure, type ServerRouteWithHandler, ServerRouterProvider, ServerSecurityProvider, ServerTimingProvider, UnauthorizedError, ValidationError, apiLinkSchema, apiLinksResponseSchema, errorNameByStatus, errorSchema, isHttpError, isServerAction, okSchema, routeMethods };

package/src/cache/redis.ts

@@ -0,0 +1 @@
+export * from "@alepha/cache-redis";

package/src/lock/redis.ts

@@ -0,0 +1 @@
+export * from "@alepha/lock-redis";

package/src/queue/redis.ts

@@ -0,0 +1 @@
+export * from "@alepha/queue-redis";

package/src/topic/redis.ts

@@ -0,0 +1 @@
+export * from "@alepha/topic-redis";

package/topic.d.ts

@@ -1,50 +1,6 @@
 import * as _alepha_core from '@alepha/core';
-import { TSchema as TSchema$1, KIND, OPTIONS, Static, Alepha } from '@alepha/core';
+import { TSchema, KIND, OPTIONS, Static, Alepha, Module } from '@alepha/core';
 import { DurationLike, DateTimeProvider } from '@alepha/datetime';
-import { RedisProvider, RedisSubscriberProvider } from '@alepha/redis';
-
-/** Symbol key applied to readonly types */
-declare const ReadonlyKind: unique symbol;
-/** Symbol key applied to optional types */
-declare const OptionalKind: unique symbol;
-/** Symbol key applied to types */
-declare const Hint: unique symbol;
-/** Symbol key applied to types */
-declare const Kind: unique symbol;
-
-interface TUnsafe<T> extends TSchema {
-    [Kind]: string;
-    static: T;
-}
-
-interface SchemaOptions {
-    $schema?: string;
-    /** Id for this schema */
-    $id?: string;
-    /** Title of this schema */
-    title?: string;
-    /** Description of this schema */
-    description?: string;
-    /** Default value for this schema */
-    default?: any;
-    /** Example values matching this schema */
-    examples?: any;
-    /** Optional annotation for readOnly */
-    readOnly?: boolean;
-    /** Optional annotation for writeOnly */
-    writeOnly?: boolean;
-    [prop: string]: any;
-}
-interface TKind {
-    [Kind]: string;
-}
-interface TSchema extends TKind, SchemaOptions {
-    [ReadonlyKind]?: string;
-    [OptionalKind]?: string;
-    [Hint]?: string;
-    params: unknown[];
-    static: unknown;
-}
 
 declare class TopicProvider {
     constructor();
@@ -74,8 +30,8 @@ type UnSubscribeFn = () => Promise<void>;
 
 declare const KEY$1 = "TOPIC";
 interface TopicMessageSchema {
-    headers?: TSchema$1;
-    payload: TSchema$1;
+    headers?: TSchema;
+    payload: TSchema;
 }
 interface TopicDescriptorOptions<T extends TopicMessageSchema = TopicMessageSchema> {
     name?: string;
@@ -178,29 +134,6 @@ declare class MemoryTopicProvider implements TopicProvider {
     unsubscribe(topic: string): Promise<void>;
 }
 
-declare class RedisTopicProvider implements TopicProvider {
-    protected readonly env: {
-        REDIS_TOPIC_PREFIX: string;
-    };
-    protected readonly redisProvider: RedisProvider;
-    protected readonly redisSubscriberProvider: RedisSubscriberProvider;
-    protected readonly log: _alepha_core.Logger;
-    protected readonly stop: _alepha_core.HookDescriptor<"stop">;
-    prefix(queue: string): string;
-    /**
-     * Publish a message to a topic.
-     */
-    publish(topic: string, message: string): Promise<void>;
-    /**
-     * Subscribe to a topic.
-     */
-    subscribe(name: string, callback: SubscribeCallback): Promise<UnSubscribeFn>;
-    /**
-     * Unsubscribe from a topic.
-     */
-    unsubscribe(name: string, callback?: SubscribeCallback): Promise<void>;
-}
-
 declare class TopicDescriptorProvider {
     protected readonly log: _alepha_core.Logger;
     protected readonly alepha: Alepha;
@@ -267,19 +200,20 @@ declare class TopicDescriptorProvider {
     };
 }
 
-declare const envSchema: _alepha_core.TObject<{
-    TOPIC_PROVIDER: TUnsafe<"memory" | "redis">;
-}>;
-declare module "alepha" {
-    interface Env extends Partial<Static<typeof envSchema>> {
-    }
-}
-declare class TopicModule {
-    protected readonly alepha: Alepha;
-    protected readonly env: {
-        TOPIC_PROVIDER: "memory" | "redis";
-    };
-    constructor();
+/**
+ * Alepha Topic Module
+ *
+ * Generic interface for pub/sub messaging.
+ * Gives you the ability to create topics and subscribers.
+ * This module provides only a memory implementation of the topic provider.
+ *
+ * @see {@link $topic}
+ * @see {@link $subscriber}
+ * @module alepha.topic
+ */
+declare class AlephaTopic implements Module {
+    readonly name = "alepha.topic";
+    readonly $services: (alepha: Alepha) => Alepha;
 }
 
-export { $subscriber, $topic, MemoryTopicProvider, RedisTopicProvider, type SubscribeCallback, type SubscriberDescriptor, type SubscriberDescriptorOptions, type TopicDescriptor, type TopicDescriptorOptions, TopicDescriptorProvider, type TopicMessage, type TopicMessageSchema, TopicModule, TopicProvider, TopicTimeoutError, type TopicWaitOptions, type UnSubscribeFn };
+export { $subscriber, $topic, AlephaTopic, MemoryTopicProvider, type SubscribeCallback, type SubscriberDescriptor, type SubscriberDescriptorOptions, type TopicDescriptor, type TopicDescriptorOptions, TopicDescriptorProvider, type TopicMessage, type TopicMessageSchema, TopicProvider, TopicTimeoutError, type TopicWaitOptions, type UnSubscribeFn };