@koloseum/utils 0.2.16 → 0.2.17

package/dist/utils.d.ts

@@ -289,3 +289,43 @@ export declare const Utility: {
      */
     validateSocialMediaHandle: (handle: string) => boolean;
 };
+export declare const Cache: {
+    /**
+     * Delete cached data from Valkey.
+     * @param valkey - The Valkey client instance
+     * @param cachePrefix - The cache prefix
+     * @param key - The cache key
+     */
+    deleteData: (valkey: any, cachePrefix: string, key: string) => Promise<void>;
+    /**
+     * Generate cache key with consistent formatting
+     * @param prefix - The key prefix
+     * @param params - Additional parameters to include in the key
+     * @returns The formatted cache key
+     */
+    generateDataKey: (prefix: string, ...params: (string | number)[]) => string;
+    /**
+     * Get cached data from Valkey.
+     * @param valkey - The Valkey client instance
+     * @param cachePrefix - The cache prefix
+     * @param key - The cache key
+     * @returns The cached data, or `null` if not found
+     */
+    getData: <T>(valkey: any, cachePrefix: string, key: string) => Promise<T | null>;
+    /**
+     * Invalidate cache by pattern
+     * @param valkey - The Valkey client instance
+     * @param cachePrefix - The cache prefix
+     * @param pattern - The pattern to match keys against (e.g., "app-config*")
+     */
+    invalidateDataByPattern: (valkey: any, cachePrefix: string, pattern: string) => Promise<void>;
+    /**
+     * Set data in Valkey cache.
+     * @param valkey - The Valkey client instance
+     * @param cachePrefix - The cache prefix
+     * @param key - The cache key
+     * @param data - The data to cache
+     * @param ttl - The time to live in seconds; defaults to 1 hour
+     */
+    setData: <T>(valkey: any, cachePrefix: string, key: string, data: T, ttl?: number) => Promise<void>;
+};

package/dist/utils.js

@@ -6,6 +6,8 @@ import validator from "validator";
 const parsePgInterval = (await import("postgres-interval")).default;
 const sanitize = (await import("sanitize-html")).default;
 const { trim, escape, isMobilePhone, isURL } = validator;
+// Cache constants
+const DEFAULT_TTL = 3600; // 1 hour in seconds
 const { KenyaAdministrativeDivisions } = (await import("kenya-administrative-divisions")).default;
 /* DUMMY DATA */
 export const Data = {
@@ -1507,3 +1509,76 @@ export const Utility = {
         !handle.startsWith("@") &&
         Boolean(handle.match(Utility.socialMediaHandleRegex))
 };
+/* CACHE FUNCTIONS */
+export const Cache = {
+    /**
+     * Delete cached data from Valkey.
+     * @param valkey - The Valkey client instance
+     * @param cachePrefix - The cache prefix
+     * @param key - The cache key
+     */
+    deleteData: async (valkey, cachePrefix, key) => {
+        try {
+            await valkey.del(`${cachePrefix}${key}`);
+        }
+        catch (error) {
+            console.error("Cache delete error:", error);
+        }
+    },
+    /**
+     * Generate cache key with consistent formatting
+     * @param prefix - The key prefix
+     * @param params - Additional parameters to include in the key
+     * @returns The formatted cache key
+     */
+    generateDataKey: (prefix, ...params) => `${prefix}:${params.join(":")}`,
+    /**
+     * Get cached data from Valkey.
+     * @param valkey - The Valkey client instance
+     * @param cachePrefix - The cache prefix
+     * @param key - The cache key
+     * @returns The cached data, or `null` if not found
+     */
+    getData: async (valkey, cachePrefix, key) => {
+        try {
+            const cached = await valkey.get(`${cachePrefix}${key}`);
+            return cached ? JSON.parse(cached) : null;
+        }
+        catch (error) {
+            console.error("Cache get error:", error);
+            return null;
+        }
+    },
+    /**
+     * Invalidate cache by pattern
+     * @param valkey - The Valkey client instance
+     * @param cachePrefix - The cache prefix
+     * @param pattern - The pattern to match keys against (e.g., "app-config*")
+     */
+    invalidateDataByPattern: async (valkey, cachePrefix, pattern) => {
+        try {
+            const keys = await valkey.keys(`${cachePrefix}${pattern}`);
+            if (keys.length > 0)
+                await valkey.del(...keys);
+        }
+        catch (error) {
+            console.error("Cache pattern invalidation error:", error);
+        }
+    },
+    /**
+     * Set data in Valkey cache.
+     * @param valkey - The Valkey client instance
+     * @param cachePrefix - The cache prefix
+     * @param key - The cache key
+     * @param data - The data to cache
+     * @param ttl - The time to live in seconds; defaults to 1 hour
+     */
+    setData: async (valkey, cachePrefix, key, data, ttl = DEFAULT_TTL) => {
+        try {
+            await valkey.setex(`${cachePrefix}${key}`, ttl, JSON.stringify(data));
+        }
+        catch (error) {
+            console.error("Cache set error:", error);
+        }
+    }
+};

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@koloseum/utils",
-	"version": "0.2.16",
+	"version": "0.2.17",
 	"author": "Koloseum Technologies Limited",
 	"type": "module",
 	"description": "Utility logic for use across Koloseum web apps (TypeScript)",