Merge pull request #5 from zeytechinc/bugfix/expose-cachemgr

Exposes cache manager interface.

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zeytech/cache-adonisjs",
   "description": "Provides LRU and Timed LRU in-memory cache with support for Adonis 6+",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "engines": {
     "node": ">=20.6.0"
   },

src/cache_manager.ts

@@ -12,8 +12,9 @@ import { CacheEngineType } from './cache.js'
 import { CacheEngine, MemoryCacheEngine, RedisCacheEngine } from './engines/index.js'
 import { LRUCache } from './lru_cache.js'
 import { TLRUCache } from './tlru_cache.js'
+import { CacheManagerContract } from './types.js'
 
-export class CacheManager {
+export class CacheManager implements CacheManagerContract {
   #caches: Map<string, LRUCache<any> | TLRUCache<any>>
 
   constructor() {

src/types.ts

@@ -1,4 +1,6 @@
-import { CacheItem } from './cache.js'
+import { CacheEngineType, CacheItem } from './cache.js'
+import { LRUCache } from './lru_cache.js'
+import { TLRUCache } from './tlru_cache.js'
 
 export interface BaseHealthCheckMetadata {
   size: number
@@ -49,3 +51,25 @@ export interface BaseCache<T> {
   getHealthCheckMessage(): Promise<string>
   getHealthCheckMeta(includeItems?: boolean, dateFormat?: string): Promise<object>
 }
+export interface CacheManagerContract {
+  createLRUCache<T>(
+    key: string,
+    maxItems: number,
+    storage: CacheEngineType,
+    displayName?: string,
+    connectionName?: string
+  ): LRUCache<T>
+  createTLRUCache<T>(
+    key: string,
+    maxItems: number,
+    maxItemAge: number,
+    storage: CacheEngineType,
+    displayName?: string,
+    connectionName?: string
+  ): TLRUCache<T>
+  getLRUCache<T>(key: string): LRUCache<T> | undefined
+  getTLRUCache<T>(key: string): TLRUCache<T> | undefined
+  getKeys(): string[]
+  removeCache(key: string): Promise<boolean>
+  shutdown(): Promise<void>
+}