alepha 0.7.4 → 0.7.6

package/cache.d.ts

@@ -1,286 +1,216 @@
-import * as _alepha_core from '@alepha/core';
-import { KIND, OPTIONS, Static, Alepha, Module } from '@alepha/core';
-import { DurationLike, DateTimeProvider, Timeout } from '@alepha/datetime';
+import * as _alepha_core0 from "@alepha/core";
+import * as _alepha_core5 from "@alepha/core";
+import { Alepha, KIND, Module, OPTIONS, Static } from "@alepha/core";
+import { DateTimeProvider, DurationLike, Timeout } from "@alepha/datetime";
+import * as _sinclair_typebox1 from "@sinclair/typebox";
 
+//#region src/providers/CacheProvider.d.ts
 /**
  * Cache provider interface.
  *
  * All methods are asynchronous and return promises.
- * Values are stored as Buffer.
+ * Values are stored as Uint8Array.
  */
 declare abstract class CacheProvider {
-    /**
-     * Get the value of a key.
-     *
-     * @param name Cache name, used to group keys. Should be Redis-like "some:group:name" format.
-     * @param key The key of the value to get.
-     *
-     * @return The value of the key, or undefined if the key does not exist.
-     */
-    abstract get(name: string, key: string): Promise<Buffer | undefined>;
-    /**
-     * Set the string value of a key.
-     *
-     * @param name Cache name, used to group keys. Should be Redis-like "some:group:name" format.
-     * @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.
-     *
-     * @return The value of the key.
-     */
-    abstract set(name: string, key: string, value: Buffer, ttl?: number): Promise<Buffer>;
-    /**
-     * Remove the specified keys.
-     *
-     * @param name Cache name, used to group keys. Should be Redis-like "some:group:name" format.
-     * @param keys The keys to delete.
-     */
-    abstract del(name: string, ...keys: string[]): Promise<void>;
-    abstract has(name: string, key: string): Promise<boolean>;
-    abstract keys(name: string): Promise<string[]>;
-}
-
+  /**
+   * Get the value of a key.
+   *
+   * @param name Cache name, used to group keys. Should be Redis-like "some:group:name" format.
+   * @param key The key of the value to get.
+   *
+   * @return The value of the key, or undefined if the key does not exist.
+   */
+  abstract get(name: string, key: string): Promise<Uint8Array | undefined>;
+  /**
+   * Set the string value of a key.
+   *
+   * @param name Cache name, used to group keys. Should be Redis-like "some:group:name" format.
+   * @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.
+   *
+   * @return The value of the key.
+   */
+  abstract set(name: string, key: string, value: Uint8Array, ttl?: number): Promise<Uint8Array>;
+  /**
+   * Remove the specified keys.
+   *
+   * @param name Cache name, used to group keys. Should be Redis-like "some:group:name" format.
+   * @param keys The keys to delete.
+   */
+  abstract del(name: string, ...keys: string[]): Promise<void>;
+  abstract has(name: string, key: string): Promise<boolean>;
+  abstract keys(name: string): Promise<string[]>;
+}
+//#endregion
+//#region src/descriptors/$cache.d.ts
 declare const KEY = "CACHE";
 /**
  * Cache Descriptor
  */
 declare const $cache: {
-    <TReturn = string, TParameter extends any[] = any[]>(options?: CacheDescriptorOptions<TReturn, TParameter>): CacheDescriptor<TReturn, TParameter>;
-    [KIND]: string;
+  <TReturn = string, TParameter extends any[] = any[]>(options?: CacheDescriptorOptions<TReturn, TParameter>): CacheDescriptor<TReturn, TParameter>;
+  [KIND]: string;
 };
 interface CacheDescriptorOptions<TReturn, TParameter extends any[] = any[]> {
-    /**
-     * The cache name. This is useful for invalidating multiple caches at once.
-     *
-     * Store key as `cache:$name:$key`.
-     *
-     * @default ClassName:methodName
-     */
-    name?: string;
-    /**
-     * 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 | (() => CacheProvider) | "memory";
-    /**
-     * 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;
+  /**
+   * The cache name. This is useful for invalidating multiple caches at once.
+   *
+   * Store key as `cache:$name:$key`.
+   *
+   * @default ClassName:methodName
+   */
+  name?: string;
+  /**
+   * 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 | (() => CacheProvider) | "memory";
+  /**
+   * 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>;
-}
-
-/** 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 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;
-}
-
+  [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>;
+}
+//#endregion
+//#region src/providers/MemoryCacheProvider.d.ts
 type CacheName = string;
 type CacheKey = string;
 type CacheValue = {
-    data?: Buffer;
-    timeout?: Timeout;
+  data?: Uint8Array;
+  timeout?: Timeout;
 };
 declare class MemoryCacheProvider implements CacheProvider {
-    protected readonly dateTimeProvider: DateTimeProvider;
-    protected readonly log: _alepha_core.Logger;
-    protected store: Record<CacheName, Record<CacheKey, CacheValue>>;
-    get(name: string, key: string): Promise<Buffer | undefined>;
-    set(name: string, key: string, value: Buffer, ttl?: number): Promise<Buffer>;
-    del(name: string, ...keys: string[]): Promise<void>;
-    has(name: string, key: string): Promise<boolean>;
-    keys(name: string): Promise<string[]>;
-}
-
-declare const envSchema: _alepha_core.TObject<{
-    CACHE_DEFAULT_TTL: TNumber;
-    CACHE_PREFIX: TOptional<TString>;
-    CACHE_ENABLED: TBoolean;
+  protected readonly dateTimeProvider: DateTimeProvider;
+  protected readonly log: _alepha_core0.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>;
+  del(name: string, ...keys: string[]): Promise<void>;
+  has(name: string, key: string): Promise<boolean>;
+  keys(name: string): Promise<string[]>;
+}
+//#endregion
+//#region src/providers/CacheDescriptorProvider.d.ts
+declare const envSchema: _alepha_core5.TObject<{
+  CACHE_DEFAULT_TTL: _sinclair_typebox1.TNumber;
+  CACHE_PREFIX: _sinclair_typebox1.TOptional<_sinclair_typebox1.TString>;
+  CACHE_ENABLED: _sinclair_typebox1.TBoolean;
 }>;
 declare module "alepha" {
-    interface Env extends Partial<Static<typeof envSchema>> {
-    }
+  interface Env extends Partial<Static<typeof envSchema>> {}
 }
 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">;
-    register(cache: Cache): Cache<any, any[]>;
-    processDescriptors(): void;
-    getCaches(): Cache[];
-    /**
-     * 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.
-     */
-    invalidate(cache: Cache, ...keys: string[]): Promise<void>;
-    /**
-     * Run the cache handler with the given state and arguments.
-     * You must run on a $cache with a handler defined.
-     */
-    run<TReturn, TParameter extends any[]>(cache: Cache<TReturn, TParameter>, ...args: TParameter): Promise<TReturn>;
-    get<TReturn>(cache: Cache<TReturn>, key: string): Promise<TReturn | undefined>;
-    /**
-     * Manually set a value in the cache.
-     * It's used by .run() method, but you will need it when you don't have cache handler defined.
-     *
-     * @param cache Cache object with all configuration and options (even TTL).
-     * @param key Cache key, build with .key() method or manually.
-     * @param value Value to store in cache.
-     * @param ttl Override cache.ttl option.
-     */
-    set<TReturn>(cache: Cache<TReturn>, key: string, value: TReturn, ttl?: DurationLike): Promise<void>;
-    protected serialize<TReturn>(value: TReturn): Buffer;
-    protected deserialize<TReturn>(buffer: Buffer): TReturn;
+  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_core5.HookDescriptor<"configure">;
+  register(cache: Cache): Cache<any, any[]>;
+  processDescriptors(): void;
+  getCaches(): Cache[];
+  /**
+   * 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.
+   */
+  invalidate(cache: Cache, ...keys: string[]): Promise<void>;
+  /**
+   * Run the cache handler with the given state and arguments.
+   * You must run on a $cache with a handler defined.
+   */
+  run<TReturn, TParameter extends any[]>(cache: Cache<TReturn, TParameter>, ...args: TParameter): Promise<TReturn>;
+  get<TReturn>(cache: Cache<TReturn>, key: string): Promise<TReturn | undefined>;
+  /**
+   * Manually set a value in the cache.
+   * It's used by .run() method, but you will need it when you don't have cache handler defined.
+   *
+   * @param cache Cache object with all configuration and options (even TTL).
+   * @param key Cache key, build with .key() method or manually.
+   * @param value Value to store in cache.
+   * @param ttl Override cache.ttl option.
+   */
+  set<TReturn>(cache: Cache<TReturn>, key: string, value: TReturn, ttl?: DurationLike): Promise<void>;
+  protected encoder: TextEncoder;
+  protected decoder: TextDecoder;
+  protected codes: {
+    BINARY: number;
+    JSON: number;
+    STRING: number;
+  };
+  protected serialize<TReturn>(value: TReturn): Uint8Array;
+  protected deserialize<TReturn>(uint8Array: Uint8Array): Promise<TReturn>;
 }
 interface Cache<TReturn = any, TParameter extends any[] = any[]> {
-    name: string;
-    options: CacheDescriptorOptions<TReturn, TParameter>;
+  name: string;
+  options: CacheDescriptorOptions<TReturn, TParameter>;
 }
-
+//#endregion
+//#region src/index.d.ts
 /**
  * Alepha Cache Module
  *
@@ -291,8 +221,9 @@ interface Cache<TReturn = any, TParameter extends any[] = any[]> {
  * @module alepha.cache
  */
 declare class AlephaCache implements Module {
-    readonly name = "alepha.cache";
-    readonly $services: (alepha: Alepha) => Alepha;
+  readonly name = "alepha.cache";
+  readonly $services: (alepha: Alepha) => Alepha;
 }
-
-export { $cache, AlephaCache, type Cache, type CacheDescriptor, type CacheDescriptorOptions, CacheDescriptorProvider, CacheProvider, MemoryCacheProvider };
+//#endregion
+export { $cache, AlephaCache, Cache, CacheDescriptor, CacheDescriptorOptions, CacheDescriptorProvider, CacheProvider, MemoryCacheProvider };
+//# sourceMappingURL=index.d.ts.map

package/cache.js

@@ -1 +1 @@
-export * from '@alepha/cache';
+export * from '@alepha/cache'

package/core.cjs

@@ -1,12 +1,8 @@
 'use strict';
-
-var core = require('@alepha/core');
-
-
-
-Object.keys(core).forEach(function (k) {
+var m = require('@alepha/core');
+Object.keys(m).forEach(function (k) {
 	if (k !== 'default' && !Object.prototype.hasOwnProperty.call(exports, k)) Object.defineProperty(exports, k, {
 		enumerable: true,
-		get: function () { return core[k]; }
+		get: function () { return m[k]; }
 	});
-});
+});