@tmlmobilidade/go-interfaces-cachedb 20260911.937.57 → 20260911.1325.23

package/dist/interface.d.ts

@@ -1,5 +1,6 @@
 import { type RedisClientType } from '@tmlmobilidade/go-clients-redis';
 import { type CacheDbKey } from './keys.js';
+import { CachedData } from './types.js';
 declare class CacheDbClass {
     private static _instance;
     private client;
@@ -35,6 +36,14 @@ declare class CacheDbClass {
      * @throws Will throw an error if the retrieval process fails.
      */
     get(key: CacheDbKey): Promise<null | string>;
+    /**
+     * Retrieves a cache entry by its key.
+     * @param key The key of the cache entry to retrieve.
+     * @returns A promise that resolves with the cache entry value,
+     * or `null` if not found.
+     * @throws Will throw an error if the retrieval process fails.
+     */
+    getNew<T>(key: CacheDbKey): Promise<CachedData<T> | null>;
     /**
      * Scans cache keys by pattern.
      * @param pattern The redis pattern to match.
@@ -48,6 +57,13 @@ declare class CacheDbClass {
      * @param ttl Optional time-to-live (TTL) in seconds. Omit when not needed.
      */
     set(key: CacheDbKey, value: string, ttl?: number): Promise<void>;
+    /**
+     * Saves a cache entry with an optional time-to-live (TTL).
+     * @param key The key of the cache entry to save.
+     * @param value The value of the cache entry to save. Must be a string.
+     * @param ttl Optional time-to-live (TTL) in seconds. Omit when not needed.
+     */
+    setNew<T>(key: CacheDbKey, value: T, ttl?: number): Promise<void>;
     protected connectToClient(): Promise<RedisClientType>;
     /**
      * Initializes the Redis client.

package/dist/interface.js

@@ -1,5 +1,6 @@
 /* * */
 import { RedisDatabaseClient } from '@tmlmobilidade/go-clients-redis';
+import { Dates } from '@tmlmobilidade/go-utils-dates';
 import { asyncSingletonProxy } from '@tmlmobilidade/utils';
 /* * */
 class CacheDbClass {
@@ -70,6 +71,19 @@ class CacheDbClass {
             return null;
         return result;
     }
+    /**
+     * Retrieves a cache entry by its key.
+     * @param key The key of the cache entry to retrieve.
+     * @returns A promise that resolves with the cache entry value,
+     * or `null` if not found.
+     * @throws Will throw an error if the retrieval process fails.
+     */
+    async getNew(key) {
+        const result = await this.client.get(key);
+        if (typeof result !== 'string')
+            return null;
+        return JSON.parse(result);
+    }
     /**
      * Scans cache keys by pattern.
      * @param pattern The redis pattern to match.
@@ -101,6 +115,24 @@ class CacheDbClass {
         else
             await this.client.set(key, value);
     }
+    /**
+     * Saves a cache entry with an optional time-to-live (TTL).
+     * @param key The key of the cache entry to save.
+     * @param value The value of the cache entry to save. Must be a string.
+     * @param ttl Optional time-to-live (TTL) in seconds. Omit when not needed.
+     */
+    async setNew(key, value, ttl) {
+        // Add the value to the CachedData object
+        const cachedData = {
+            data: value,
+            timestamp: Dates.now('utc').unix_milliseconds,
+        };
+        // Set cache with optional TTL
+        if (ttl)
+            await this.client.set(key, JSON.stringify(cachedData), { expiration: { type: 'EX', value: ttl } });
+        else
+            await this.client.set(key, JSON.stringify(cachedData));
+    }
     connectToClient() {
         return RedisDatabaseClient.getClient({ prefix: 'CACHEDB' });
     }

package/dist/types.d.ts

@@ -0,0 +1,5 @@
+import { type UnixMilliseconds } from '@tmlmobilidade/go-types-shared';
+export interface CachedData<T> {
+    data: T;
+    timestamp: UnixMilliseconds;
+}

package/dist/types.js

@@ -0,0 +1,2 @@
+/* * */
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@tmlmobilidade/go-interfaces-cachedb",
-	"version": "20260911.937.57",
+	"version": "20260911.1325.23",
 	"author": {
 		"email": "iso@tmlmobilidade.pt",
 		"name": "TML-ISO"
@@ -37,6 +37,8 @@
 	},
 	"dependencies": {
 		"@tmlmobilidade/go-clients-redis": "*",
+		"@tmlmobilidade/go-types-shared": "*",
+		"@tmlmobilidade/go-utils-dates": "*",
 		"@tmlmobilidade/utils": "*"
 	},
 	"devDependencies": {