@privateaim/server-kit 0.8.4 → 0.8.5

package/src/services/cache/adapters/redis.ts

@@ -0,0 +1,69 @@
+/*
+ * Copyright (c) 2024-2024.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+
+import type { Client } from 'redis-extension';
+import { JsonAdapter } from 'redis-extension';
+import { useRedisClient } from '../../redis';
+import type { CacheClearOptions, CacheSetOptions } from '../types';
+import type { CacheAdapter } from './types';
+
+export class RedisCacheAdapter implements CacheAdapter {
+    protected client : Client;
+
+    protected instance : JsonAdapter;
+
+    constructor() {
+        this.client = useRedisClient();
+        this.instance = new JsonAdapter(this.client);
+    }
+
+    async get(key: string): Promise<any> {
+        return this.instance.get(key);
+    }
+
+    async has(key: string) : Promise<boolean> {
+        const exists = await this.client.exists(key);
+
+        return !!exists;
+    }
+
+    async set(key: string, value: any, options: CacheSetOptions): Promise<void> {
+        await this.instance.set(key, value, {
+            milliseconds: options.ttl,
+        });
+    }
+
+    async drop(key: string): Promise<void> {
+        await this.instance.drop(key);
+    }
+
+    async dropMany(keys: string[]) : Promise<void> {
+        const pipeline = this.client.pipeline();
+
+        for (let i = 0; i < keys.length; i++) {
+            pipeline.del(keys[i]);
+        }
+
+        await pipeline.exec();
+    }
+
+    async clear(options: CacheClearOptions = {}) : Promise<void> {
+        if (options.prefix) {
+            const pipeline = this.client.pipeline();
+
+            const keys = await this.client.keys(`${options.prefix}*`);
+            for (let i = 0; i < keys.length; i++) {
+                pipeline.del(keys[i]);
+            }
+
+            await pipeline.exec();
+
+            return;
+        }
+        await this.client.flushdb();
+    }
+}

package/src/services/cache/adapters/types.ts

@@ -0,0 +1,22 @@
+/*
+ * Copyright (c) 2024.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+
+import type { CacheClearOptions, CacheSetOptions } from '../types';
+
+export interface CacheAdapter {
+    set(key: string, value: any, options: CacheSetOptions): Promise<void>;
+
+    get(key: string): Promise<any | undefined>;
+
+    has(key: string) : Promise<boolean>;
+
+    drop(key: string): Promise<void>;
+
+    dropMany(keys: string[]) : Promise<void>;
+
+    clear(options: CacheClearOptions) : Promise<void>;
+}

package/src/services/cache/helper.ts

@@ -0,0 +1,13 @@
+/*
+ * Copyright (c) 2024.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+
+import { buildRedisKeyPath } from '../redis';
+import type { CacheKeyBuildOptions } from './types';
+
+export function buildCacheKey(options: CacheKeyBuildOptions) {
+    return buildRedisKeyPath(options);
+}

package/src/{core/memory-cache → services/cache}/index.ts

@@ -5,5 +5,8 @@
  * view the LICENSE file that was distributed with this source code.
  */
 
-export * from './module';
+export * from './adapters';
+export * from './helper';
 export * from './singleton';
+export * from './module';
+export * from './types';

package/src/services/cache/module.ts

@@ -0,0 +1,41 @@
+/*
+ * Copyright (c) 2024.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+
+import type { CacheAdapter } from './adapters';
+import type { CacheClearOptions, CacheSetOptions } from './types';
+
+export class Cache {
+    protected adapter : CacheAdapter;
+
+    constructor(adapter: CacheAdapter) {
+        this.adapter = adapter;
+    }
+
+    async set(key: string, value: any, options: CacheSetOptions = {}) : Promise<void> {
+        await this.adapter.set(key, value, options);
+    }
+
+    async get(key: string) : Promise<any | undefined> {
+        return this.adapter.get(key);
+    }
+
+    async has(key: string) : Promise<boolean> {
+        return this.adapter.has(key);
+    }
+
+    async drop(key: string) : Promise<void> {
+        return this.adapter.drop(key);
+    }
+
+    async dropMany(keys: string[]) : Promise<void> {
+        return this.adapter.dropMany(keys);
+    }
+
+    async clear(options: CacheClearOptions = {}) : Promise<void> {
+        return this.adapter.clear(options);
+    }
+}

package/src/services/cache/singleton.ts

@@ -0,0 +1,30 @@
+/*
+ * Copyright (c) 2024.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+
+import { singa } from 'singa';
+import { isRedisClientUsable } from '../redis';
+import type { CacheAdapter } from './adapters';
+import { MemoryCacheAdapter, RedisCacheAdapter } from './adapters';
+import { Cache } from './module';
+
+const instance = singa<Cache>({
+    name: 'cache',
+    factory: () => {
+        let adapter : CacheAdapter;
+        if (isRedisClientUsable()) {
+            adapter = new RedisCacheAdapter();
+        } else {
+            adapter = new MemoryCacheAdapter();
+        }
+
+        return new Cache(adapter);
+    },
+});
+
+export function useCache() {
+    return instance.use();
+}

package/src/services/cache/types.ts

@@ -0,0 +1,24 @@
+/*
+ * Copyright (c) 2024.
+ * Author Peter Placzek (tada5hi)
+ * For the full copyright and license information,
+ * view the LICENSE file that was distributed with this source code.
+ */
+
+export type CacheKeyBuildOptions = {
+    key: string,
+    prefix?: string,
+    suffix?: string
+};
+
+export type CacheSetOptions = {
+    /**
+     * Time to live in milliseconds (ms).
+     */
+    ttl?: number
+};
+
+export type CacheClearOptions = {
+    prefix?: string,
+    suffix?: string
+};

package/src/services/index.ts

@@ -7,6 +7,7 @@
 
 export * from './amqp';
 export * from './authup';
+export * from './cache';
 export * from './logger';
 export * from './redis';
 export * from './vault';

package/test/unit/memory-cache.spec.ts

@@ -5,25 +5,26 @@
  * view the LICENSE file that was distributed with this source code.
  */
 
-import { MemoryCache } from '../../src';
+import { Cache, MemoryCacheAdapter } from '../../src';
 
 describe('memory-cache', () => {
-    it('should support operations (set,get,has,del)', () => {
-        const cache = new MemoryCache();
-        cache.set('foo', { bar: 'baz' }, {
+    it('should support operations (set,get,has,del)', async () => {
+        const adapter = new MemoryCacheAdapter();
+        const cache = new Cache(adapter);
+        await cache.set('foo', { bar: 'baz' }, {
             ttl: 1000 * 60 * 15,
         });
 
-        expect(cache.has('foo')).toBeTruthy();
+        expect(await cache.has('foo')).toBeTruthy();
 
-        let value = cache.get('foo');
+        let value = await cache.get('foo');
         expect(value).toEqual({ bar: 'baz' });
 
-        cache.del('foo');
+        await cache.drop('foo');
 
-        expect(cache.has('foo')).toBeFalsy();
+        expect(await cache.has('foo')).toBeFalsy();
 
-        value = cache.get('foo');
+        value = await cache.get('foo');
         expect(value).toBeUndefined();
     });
 });

package/dist/core/memory-cache/index.d.ts

@@ -1,3 +0,0 @@
-export * from './module';
-export * from './singleton';
-//# sourceMappingURL=index.d.ts.map

package/dist/core/memory-cache/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/core/memory-cache/index.ts"],"names":[],"mappings":"AAOA,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC"}

package/dist/core/memory-cache/module.d.ts

@@ -1,15 +0,0 @@
-import TTLCache from '@isaacs/ttlcache';
-type BlockerOptions = {
-    ttl: number;
-};
-export declare class MemoryCache<KEY extends string = string, VALUE = any> {
-    protected options: BlockerOptions;
-    protected cache: TTLCache<KEY, VALUE>;
-    constructor(options?: Partial<BlockerOptions>);
-    set(id: KEY, value: VALUE, options: BlockerOptions): void;
-    get(id: KEY): VALUE | undefined;
-    del(id: KEY): void;
-    has(id: KEY): boolean;
-}
-export {};
-//# sourceMappingURL=module.d.ts.map

package/dist/core/memory-cache/module.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"module.d.ts","sourceRoot":"","sources":["../../../src/core/memory-cache/module.ts"],"names":[],"mappings":"AAOA,OAAO,QAAQ,MAAM,kBAAkB,CAAC;AAExC,KAAK,cAAc,GAAG;IAClB,GAAG,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,qBAAa,WAAW,CACpB,GAAG,SAAS,MAAM,GAAG,MAAM,EAC3B,KAAK,GAAG,GAAG;IAEX,SAAS,CAAC,OAAO,EAAG,cAAc,CAAC;IAEnC,SAAS,CAAC,KAAK,EAAG,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBAE3B,OAAO,GAAE,OAAO,CAAC,cAAc,CAAM;IASjD,GAAG,CAAC,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,cAAc;IAMlD,GAAG,CAAC,EAAE,EAAE,GAAG,GAAG,KAAK,GAAG,SAAS;IAI/B,GAAG,CAAC,EAAE,EAAE,GAAG,GAAI,IAAI;IAInB,GAAG,CAAC,EAAE,EAAE,GAAG,GAAI,OAAO;CAGzB"}

package/dist/core/memory-cache/singleton.d.ts

@@ -1,3 +0,0 @@
-import { MemoryCache } from './module';
-export declare function useMemoryCache(): MemoryCache<string, any>;
-//# sourceMappingURL=singleton.d.ts.map

package/dist/core/memory-cache/singleton.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"singleton.d.ts","sourceRoot":"","sources":["../../../src/core/memory-cache/singleton.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAOvC,wBAAgB,cAAc,6BAE7B"}

package/src/core/memory-cache/module.ts

@@ -1,48 +0,0 @@
-/*
- * Copyright (c) 2024.
- * Author Peter Placzek (tada5hi)
- * For the full copyright and license information,
- * view the LICENSE file that was distributed with this source code.
- */
-
-import TTLCache from '@isaacs/ttlcache';
-
-type BlockerOptions = {
-    ttl: number;
-};
-
-export class MemoryCache<
-    KEY extends string = string,
-    VALUE = any,
-> {
-    protected options : BlockerOptions;
-
-    protected cache : TTLCache<KEY, VALUE>;
-
-    constructor(options: Partial<BlockerOptions> = {}) {
-        this.options = {
-            // 60 seconds
-            ttl: 1000 * 60,
-            ...options,
-        };
-        this.cache = new TTLCache<KEY, VALUE>();
-    }
-
-    set(id: KEY, value: VALUE, options: BlockerOptions) {
-        this.cache.set(id, value, {
-            ttl: options.ttl,
-        });
-    }
-
-    get(id: KEY): VALUE | undefined {
-        return this.cache.get(id);
-    }
-
-    del(id: KEY) : void {
-        this.cache.delete(id);
-    }
-
-    has(id: KEY) : boolean {
-        return this.cache.has(id);
-    }
-}

package/src/core/memory-cache/singleton.ts

@@ -1,18 +0,0 @@
-/*
- * Copyright (c) 2024.
- * Author Peter Placzek (tada5hi)
- * For the full copyright and license information,
- * view the LICENSE file that was distributed with this source code.
- */
-
-import { singa } from 'singa';
-import { MemoryCache } from './module';
-
-const instance = singa<MemoryCache>({
-    name: 'queueRouter',
-    factory: () => new MemoryCache(),
-});
-
-export function useMemoryCache() {
-    return instance.use();
-}