alepha 0.7.0 → 0.7.1

package/README.md

@@ -1,7 +1,18 @@
-# Alepha
+<div align="center">
 
-Alepha is a collection of packages designed to provide a powerful and flexible framework for building applications.
-It includes a variety of tools and utilities to help developers create robust and maintainable code.
+<img src="./assets/logo.png" alt="Logo" style="width: 256px"/>
+
+<h1>Alepha</h1>
+
+<p style="max-width: 512px">
+🚧
+</p>
+
+</div>
+
+[![npm](https://img.shields.io/npm/v/alepha.svg)](https://www.npmjs.com/package/alepha)
+[![license](https://img.shields.io/npm/l/alepha.svg)](https://www.npmjs.com/package/alepha)
+[![downloads](https://img.shields.io/npm/dt/alepha.svg)](https://www.npmjs.com/package/alepha)
 
 ## Installation
 

package/cache.cjs

@@ -10,4 +10,3 @@ Object.keys(cache).forEach(function (k) {
 		get: function () { return cache[k]; }
 	});
 });
-//# sourceMappingURL=cache.cjs.map

package/cache.d.ts

@@ -91,8 +91,7 @@ interface TSchema extends TKind, SchemaOptions {
     static: unknown;
 }
 
-declare class CacheProvider {
-    constructor();
+interface CacheProvider {
     /**
      * Get the value of a key.
      *
@@ -118,6 +117,13 @@ declare class CacheProvider {
     del(group: string, ...keys: string[]): Promise<void>;
 }
 
+declare class DefaultCacheProvider implements CacheProvider {
+    constructor();
+    get(): Promise<string | undefined>;
+    set(): Promise<string>;
+    del(): Promise<void>;
+}
+
 declare const KEY = "CACHE";
 interface CacheDescriptorOptions<TReturn, TParameter extends any[] = any[]> {
     /**
@@ -134,7 +140,7 @@ interface CacheDescriptorOptions<TReturn, TParameter extends any[] = any[]> {
      * The store provider for the cache.
      * If not provided, the default store provider will be used.
      */
-    provider?: (() => CacheProvider) | "memory";
+    provider?: (() => DefaultCacheProvider) | "memory";
     /**
      * The cache group. This is useful for invalidating multiple caches at once.
      * Key is used as the group if not provided.
@@ -247,7 +253,7 @@ declare module "alepha" {
 }
 declare class CacheDescriptorProvider {
     protected readonly alepha: Alepha;
-    protected readonly cacheProvider: CacheProvider;
+    protected readonly cacheProvider: DefaultCacheProvider;
     protected readonly memoryCacheProvider: MemoryCacheProvider;
     protected readonly dateTimeProvider: DateTimeProvider;
     protected readonly env: {
@@ -257,7 +263,9 @@ declare class CacheDescriptorProvider {
     };
     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.
      */
@@ -274,21 +282,30 @@ declare class CacheDescriptorProvider {
     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>;
     /**
-     *
+     * Run the cache handler with the given state and arguments.
+     * You must run on a $cache with a handler defined.
      */
-    protected run<TReturn, TParameter extends any[]>(cache: Cache<TReturn, TParameter>, ...args: TParameter): Promise<TReturn>;
+    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): string;
+    protected deserialize<TReturn>(value: string): TReturn;
 }
 interface Cache<TReturn = any, TParameter extends any[] = any[]> {
-    options: CacheDescriptorOptions<TReturn, TParameter>;
     group: string;
+    options: CacheDescriptorOptions<TReturn, TParameter>;
 }
 
 declare const envSchema$1: _alepha_core.TObject<{
@@ -337,7 +354,7 @@ declare class RedisCacheProvider implements CacheProvider {
 }
 
 declare const envSchema: _alepha_core.TObject<{
-    CACHE_PROVIDER: TUnsafe<"memory" | "redis" | "sqlite">;
+    CACHE_PROVIDER: TUnsafe<"memory" | "redis">;
 }>;
 declare module "@alepha/core" {
     interface Env extends Partial<Static<typeof envSchema>> {
@@ -346,9 +363,9 @@ declare module "@alepha/core" {
 declare class CacheModule {
     protected readonly alepha: Alepha;
     protected readonly env: {
-        CACHE_PROVIDER: "memory" | "redis" | "sqlite";
+        CACHE_PROVIDER: "memory" | "redis";
     };
     constructor();
 }
 
-export { $cache, type Cache, type CacheDescriptor, type CacheDescriptorOptions, CacheDescriptorProvider, CacheModule, CacheProvider, MemoryCacheProvider, RedisCacheProvider };
+export { $cache, type Cache, type CacheDescriptor, type CacheDescriptorOptions, CacheDescriptorProvider, CacheModule, type CacheProvider, DefaultCacheProvider, MemoryCacheProvider, RedisCacheProvider };

package/cache.js

@@ -1,2 +1 @@
 export * from '@alepha/cache';
-//# sourceMappingURL=cache.js.map

package/core.cjs

@@ -10,4 +10,3 @@ Object.keys(core).forEach(function (k) {
 		get: function () { return core[k]; }
 	});
 });
-//# sourceMappingURL=core.cjs.map