alepha 0.6.7 → 0.6.8

package/redis.d.ts

@@ -1 +1,135 @@
-export * from '@alepha/redis';
+import * as _alepha_core from '@alepha/core';
+import { Static, Alepha } from '@alepha/core';
+import * as Redis from 'ioredis';
+import Redis__default from 'ioredis';
+
+/** 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;
+
+type StringFormatOption = 'date-time' | 'time' | 'date' | 'email' | 'idn-email' | 'hostname' | 'idn-hostname' | 'ipv4' | 'ipv6' | 'uri' | 'uri-reference' | 'iri' | 'uuid' | 'iri-reference' | 'uri-template' | 'json-pointer' | 'relative-json-pointer' | 'regex' | ({} & string);
+type StringContentEncodingOption = '7bit' | '8bit' | 'binary' | 'quoted-printable' | 'base64' | ({} & string);
+interface StringOptions extends SchemaOptions {
+    /** The maximum string length */
+    maxLength?: number;
+    /** The minimum string length */
+    minLength?: number;
+    /** A regular expression pattern this string should match */
+    pattern?: string;
+    /** A format this string should match */
+    format?: StringFormatOption;
+    /** The content encoding for this string */
+    contentEncoding?: StringContentEncodingOption;
+    /** The content media type for this string */
+    contentMediaType?: string;
+}
+interface TString extends TSchema, StringOptions {
+    [Kind]: 'String';
+    static: string;
+    type: 'string';
+}
+
+interface NumberOptions extends SchemaOptions {
+    exclusiveMaximum?: number;
+    exclusiveMinimum?: number;
+    maximum?: number;
+    minimum?: number;
+    multipleOf?: number;
+}
+interface TNumber extends TSchema, NumberOptions {
+    [Kind]: 'Number';
+    static: number;
+    type: 'number';
+}
+
+type TOptional<T extends TSchema> = T & {
+    [OptionalKind]: 'Optional';
+};
+
+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 const envSchema: _alepha_core.TObject<{
+    REDIS_PORT: TNumber;
+    REDIS_HOST: TString;
+    REDIS_PASSWORD: TOptional<TString>;
+}>;
+declare module "alepha" {
+    interface Env extends Partial<Static<typeof envSchema>> {
+    }
+}
+type RedisClient = Redis__default;
+declare class RedisProvider {
+    protected readonly log: _alepha_core.Logger;
+    protected readonly alepha: Alepha;
+    protected readonly env: {
+        REDIS_PASSWORD?: string | undefined;
+        REDIS_PORT: number;
+        REDIS_HOST: string;
+    };
+    protected readonly client: Redis__default;
+    get publisher(): RedisClient;
+    protected readonly start: _alepha_core.HookDescriptor<"start">;
+    protected readonly stop: _alepha_core.HookDescriptor<"stop">;
+    /**
+     * Connect to the Redis server.
+     */
+    connect(): Promise<void>;
+    /**
+     * Close the connection to the Redis server.
+     */
+    close(): Promise<void>;
+    /**
+     * Redis subscriber client factory method.
+     */
+    protected createClient(): RedisClient;
+}
+
+declare class RedisSubscriberProvider {
+    protected readonly log: _alepha_core.Logger;
+    protected readonly alepha: Alepha;
+    protected readonly redisProvider: RedisProvider;
+    protected readonly client: Redis.default;
+    get subscriber(): RedisClient;
+    protected readonly start: _alepha_core.HookDescriptor<"start">;
+    protected readonly stop: _alepha_core.HookDescriptor<"stop">;
+    connect(): Promise<void>;
+    close(): void;
+    /**
+     * Redis subscriber client factory method.
+     */
+    protected createClient(): RedisClient;
+}
+
+export { type RedisClient, RedisProvider, RedisSubscriberProvider };

package/scheduler.d.ts

@@ -1 +1,185 @@
-export * from '@alepha/scheduler';
+import * as _alepha_core from '@alepha/core';
+import { Async, KIND, OPTIONS, Static, Alepha } from '@alepha/core';
+import { DurationLike, DateTimeProvider, Interval } from '@alepha/datetime';
+import * as _alepha_lock from '@alepha/lock';
+import { CronJob } from 'cron';
+
+declare const KEY = "SCHEDULER";
+type SchedulerDescriptorOptions = {
+    /**
+     * Function to run on schedule.
+     */
+    handler: () => Async<void>;
+    /**
+     * Name of the scheduler. Defaults to the function name.
+     */
+    name?: string;
+    /**
+     * Optional description of the scheduler.
+     */
+    description?: string;
+    /**
+     * Cron expression or interval to run the scheduler.
+     */
+    cron?: string;
+    /**
+     * Cron expression or interval to run the scheduler.
+     */
+    interval?: DurationLike;
+    /**
+     * If true, the scheduler will be locked and only one instance will run at a time.
+     * Defaults to true.
+     */
+    lock?: boolean;
+};
+interface SchedulerDescriptor {
+    [KIND]: typeof KEY;
+    [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;
+/** 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;
+
+type StringFormatOption = 'date-time' | 'time' | 'date' | 'email' | 'idn-email' | 'hostname' | 'idn-hostname' | 'ipv4' | 'ipv6' | 'uri' | 'uri-reference' | 'iri' | 'uuid' | 'iri-reference' | 'uri-template' | 'json-pointer' | 'relative-json-pointer' | 'regex' | ({} & string);
+type StringContentEncodingOption = '7bit' | '8bit' | 'binary' | 'quoted-printable' | 'base64' | ({} & string);
+interface StringOptions extends SchemaOptions {
+    /** The maximum string length */
+    maxLength?: number;
+    /** The minimum string length */
+    minLength?: number;
+    /** A regular expression pattern this string should match */
+    pattern?: string;
+    /** A format this string should match */
+    format?: StringFormatOption;
+    /** The content encoding for this string */
+    contentEncoding?: StringContentEncodingOption;
+    /** The content media type for this string */
+    contentMediaType?: string;
+}
+interface TString extends TSchema, StringOptions {
+    [Kind]: 'String';
+    static: string;
+    type: 'string';
+}
+
+type TOptional<T extends TSchema> = T & {
+    [OptionalKind]: 'Optional';
+};
+
+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 const envSchema: _alepha_core.TObject<{
+    SCHEDULER_PREFIX: TOptional<TString>;
+}>;
+declare module "alepha" {
+    interface Env extends Partial<Static<typeof envSchema>> {
+    }
+}
+declare class SchedulerDescriptorProvider {
+    protected readonly log: _alepha_core.Logger;
+    protected readonly env: {
+        SCHEDULER_PREFIX?: string | undefined;
+    };
+    protected readonly alepha: Alepha;
+    protected readonly dateTimeProvider: DateTimeProvider;
+    protected readonly schedulers: Scheduler[];
+    protected readonly configure: _alepha_core.HookDescriptor<"configure">;
+    protected readonly start: _alepha_core.HookDescriptor<"start">;
+    protected readonly stop: _alepha_core.HookDescriptor<"stop">;
+    /**
+     * Get the schedulers.
+     */
+    getSchedulers(): Scheduler[];
+    /**
+     * Process scheduler descriptors.
+     *
+     * @protected
+     */
+    protected processSchedulerDescriptors(): void;
+    /**
+     * Create a scheduler.
+     *
+     * @param options - The scheduler options.
+     * @param instance - The instance of the scheduler.
+     * @param key - Property key name.
+     * @protected
+     */
+    protected createScheduler(options: SchedulerDescriptorOptions, instance: any, key: string): Scheduler;
+    trigger(name: string): Promise<void>;
+    protected runLock: _alepha_lock.LockDescriptor<(options: SchedulerDescriptorOptions & {
+        name: string;
+    }) => Promise<void>>;
+    protected run(options: SchedulerDescriptorOptions): Promise<void>;
+    /**
+     * Prefix the scheduler key.
+     *
+     * @param key
+     * @protected
+     */
+    protected prefix(key: string): string;
+    /**
+     *
+     * @param options
+     * @protected
+     */
+    protected getLockGracePeriod(options: SchedulerDescriptorOptions): number;
+}
+interface Scheduler {
+    name: string;
+    options: SchedulerDescriptorOptions;
+    trigger: () => Promise<void>;
+    cronJob?: CronJob;
+    interval?: Interval;
+}
+
+declare class SchedulerModule {
+    protected readonly alepha: Alepha;
+    constructor();
+}
+
+export { $scheduler, type Scheduler, type SchedulerDescriptor, type SchedulerDescriptorOptions, SchedulerDescriptorProvider, SchedulerModule, isScheduler };