alepha 0.6.7 → 0.6.8

package/cache.d.ts

@@ -1 +1,353 @@
-export * from '@alepha/cache';
+import * as _alepha_core from '@alepha/core';
+import { KIND, OPTIONS, Static, Alepha } from '@alepha/core';
+import { DurationLike, DateTimeProvider, Timeout } from '@alepha/datetime';
+import { RedisProvider, RedisClient } 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;
+}
+
+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 TBoolean extends TSchema {
+    [Kind]: 'Boolean';
+    static: boolean;
+    type: 'boolean';
+}
+
+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 class CacheProvider {
+    /**
+     * Get the value of a key.
+     *
+     * @param group The group of the value to get.
+     * @param key The key of the value to get.
+     */
+    get(group: string, key: string): Promise<string | undefined>;
+    /**
+     * Set the string value of a key.
+     *
+     * @param group The group of the value to get.
+     * @param key The key of the value to set.
+     * @param value The value to set.
+     * @param ttl The time-to-live of the key, in milliseconds.
+     */
+    set(group: string, key: string, value: string, ttl?: number): Promise<string>;
+    /**
+     * Remove the specified keys.
+     *
+     * @param group The group of the value to get.
+     * @param keys The keys to delete.
+     */
+    del(group: string, ...keys: string[]): Promise<void>;
+}
+
+declare const KEY = "CACHE";
+interface CacheDescriptorOptions<TReturn, TParameter extends any[] = any[]> {
+    /**
+     * Function which returns cached data.
+     * @param args Arguments for handler.
+     */
+    handler?: (...args: TParameter) => TReturn;
+    /**
+     * The key generator for the cache.
+     * If not provided, the arguments will be json.stringify().
+     */
+    key?: (...args: TParameter) => string;
+    /**
+     * The store provider for the cache.
+     * If not provided, the default store provider will be used.
+     */
+    provider?: (() => CacheProvider) | "memory";
+    /**
+     * The cache group. This is useful for invalidating multiple caches at once.
+     * Key is used as the group if not provided.
+     *
+     * Store key as `cache:$group:$key`.
+     *
+     * @default ClassName:methodName
+     */
+    group?: string;
+    /**
+     * The time-to-live for the cache in seconds.
+     * Set 0 to skip expiration.
+     *
+     * @default 300 (5 minutes).
+     */
+    ttl?: DurationLike;
+    /**
+     * If the cache is disabled.
+     */
+    disabled?: boolean;
+}
+interface CacheDescriptor<TReturn = any, TParameter extends any[] = any[]> {
+    [KIND]: typeof KEY;
+    [OPTIONS]: CacheDescriptorOptions<TReturn, TParameter>;
+    /**
+     * Cache handler.
+     */
+    (...args: TParameter): Promise<TReturn>;
+    /**
+     * Cache key generator.
+     */
+    key: (...args: TParameter) => string;
+    /**
+     * Invalidate cache by keys.
+     */
+    invalidate: (...keys: string[]) => Promise<void>;
+    /**
+     * Set cache with key, value and ttl.
+     *
+     * @param key
+     * @param value
+     * @param ttl
+     */
+    set: (key: string, value: TReturn, ttl?: DurationLike) => Promise<void>;
+    /**
+     * Get cache by key.
+     *
+     * @param key
+     */
+    get: (key: string) => Promise<TReturn | undefined>;
+}
+/**
+ * Cache Descriptor
+ *
+ * @param options
+ */
+declare const $cache: {
+    <TReturn = string, TParameter extends any[] = any[]>(options?: CacheDescriptorOptions<TReturn, TParameter>): CacheDescriptor<TReturn, TParameter>;
+    [KIND]: string;
+};
+
+/**
+ * A simple in-memory store provider.
+ */
+declare class MemoryCacheProvider implements CacheProvider {
+    protected readonly dateTimeProvider: DateTimeProvider;
+    protected readonly log: _alepha_core.Logger;
+    /**
+     * The in-memory store.
+     */
+    protected store: Record<string, Record<string, string>>;
+    /**
+     * Timeouts used to expire keys.
+     */
+    protected storeTimeout: Record<string, Record<string, Timeout>>;
+    /**
+     * Get the value of a key.
+     *
+     * @param group The group of the value to get.
+     * @param key The key of the value to get.
+     */
+    get(group: string, key: string): Promise<string | undefined>;
+    /**
+     * Set the string value of a key.
+     *
+     * @param group The group of the value to get.
+     * @param key The key of the value to set.
+     * @param value The value to set.
+     * @param ttl The time-to-live of the key, in milliseconds.
+     */
+    set(group: string, key: string, value: string, ttl?: number): Promise<string>;
+    /**
+     * Remove the specified keys.
+     *
+     * @param group The group of the value to get.
+     * @param keys The keys to delete.
+     */
+    del(group: string, ...keys: string[]): Promise<void>;
+    private ttl;
+}
+
+declare const envSchema$2: _alepha_core.TObject<{
+    CACHE_DEFAULT_TTL: TNumber;
+    CACHE_PREFIX: TOptional<TString>;
+    CACHE_ENABLED: TBoolean;
+}>;
+declare module "alepha" {
+    interface Env extends Partial<Static<typeof envSchema$2>> {
+    }
+}
+declare class CacheDescriptorProvider {
+    protected readonly alepha: Alepha;
+    protected readonly cacheProvider: CacheProvider;
+    protected readonly memoryCacheProvider: MemoryCacheProvider;
+    protected readonly dateTimeProvider: DateTimeProvider;
+    protected readonly env: {
+        CACHE_PREFIX?: string | undefined;
+        CACHE_DEFAULT_TTL: number;
+        CACHE_ENABLED: boolean;
+    };
+    protected readonly caches: Cache[];
+    protected readonly configure: _alepha_core.HookDescriptor<"configure">;
+    processDescriptors(): void;
+    /**
+     * Clear all cache entries.
+     */
+    clear(): Promise<void>;
+    /**
+     * Get the store provider for the given cache options.
+     *
+     * @param options
+     */
+    provider(options: Pick<CacheDescriptorOptions<any[], any>, "provider">): CacheProvider;
+    /**
+     * Get the cache key for the given state and arguments.
+     */
+    key(cache: Cache, ...args: any[]): string;
+    /**
+     * Invalidate the cache for the given state and arguments.
+     *
+     * @param cache
+     * @param keys
+     */
+    invalidate(cache: Cache, ...keys: string[]): Promise<void>;
+    /**
+     *
+     */
+    protected run<TReturn, TParameter extends any[]>(cache: Cache<TReturn, TParameter>, ...args: TParameter): Promise<TReturn>;
+    get<TReturn>(cache: Cache<TReturn>, key: string): Promise<TReturn | undefined>;
+    set<TReturn>(cache: Cache<TReturn>, key: string, value: TReturn, ttl?: DurationLike): Promise<void>;
+}
+interface Cache<TReturn = any, TParameter extends any[] = any[]> {
+    options: CacheDescriptorOptions<TReturn, TParameter>;
+    group: string;
+}
+
+declare const envSchema$1: _alepha_core.TObject<{
+    REDIS_CACHE_PREFIX: TOptional<TString>;
+}>;
+declare module "alepha/core" {
+    interface Env extends Partial<Static<typeof envSchema$1>> {
+    }
+}
+declare class RedisCacheProvider implements CacheProvider {
+    protected readonly log: _alepha_core.Logger;
+    protected readonly redisProvider: RedisProvider;
+    protected readonly env: {
+        REDIS_CACHE_PREFIX?: string | undefined;
+    };
+    get publisher(): RedisClient;
+    /**
+     * Get the value of a key.
+     *
+     * @param group - The group of the value to get.
+     * @param key - The key of the value to get.
+     */
+    get(group: string, key: string): Promise<string | undefined>;
+    /**
+     * Set the string value of a key.
+     *
+     * @param group - The group of the value to get.
+     * @param key - The key of the value to set.
+     * @param value - The value to set.
+     * @param ttl - The time-to-live of the key, in milliseconds.
+     */
+    set(group: string, key: string, value: string, ttl?: number): Promise<string>;
+    /**
+     * Remove the specified keys.
+     *
+     * @param group - The group of the value to get.
+     * @param keys - The keys to delete.
+     */
+    del(group: string, ...keys: string[]): Promise<void>;
+    /**
+     * Prefix the cache key.
+     *
+     * @param path - The path to prefix.
+     */
+    protected prefix(...path: string[]): string;
+}
+
+declare const envSchema: _alepha_core.TObject<{
+    CACHE_PROVIDER: TUnsafe<"memory" | "redis" | "sqlite">;
+}>;
+declare module "@alepha/core" {
+    interface Env extends Partial<Static<typeof envSchema>> {
+    }
+}
+declare class CacheModule {
+    protected readonly alepha: Alepha;
+    protected readonly env: {
+        CACHE_PROVIDER: "memory" | "redis" | "sqlite";
+    };
+    constructor();
+}
+
+export { $cache, type Cache, type CacheDescriptor, type CacheDescriptorOptions, CacheDescriptorProvider, CacheModule, CacheProvider, MemoryCacheProvider, RedisCacheProvider };