@koloseum/utils 0.2.16 → 0.2.18

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

@@ -1507,3 +1507,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 = 3600) => {
+        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.18",
 	"author": "Koloseum Technologies Limited",
 	"type": "module",
 	"description": "Utility logic for use across Koloseum web apps (TypeScript)",
@@ -29,23 +29,23 @@
 		"test": "vitest --run"
 	},
 	"dependencies": {
-		"@supabase/supabase-js": "^2.50.1",
-		"@sveltejs/kit": "^2.22.0",
+		"@supabase/supabase-js": "^2.57.4",
+		"@sveltejs/kit": "^2.41.0",
 		"kenya-administrative-divisions": "^0.0.18",
 		"postgres-interval": "^4.0.2",
 		"sanitize-html": "^2.17.0",
-		"uuid": "^11.1.0",
+		"uuid": "^13.0.0",
 		"validator": "^13.15.15"
 	},
 	"devDependencies": {
-		"@koloseum/types": "^0.2.5",
-		"@playwright/test": "^1.53.1",
-		"@suprsend/web-components": "^0.2.1",
+		"@koloseum/types": "^0.2.6",
+		"@playwright/test": "^1.55.0",
+		"@suprsend/web-components": "^0.4.0",
 		"@types/sanitize-html": "^2.16.0",
 		"@types/uuid": "^10.0.0",
-		"@types/validator": "^13.15.2",
-		"prettier": "^3.6.0",
-		"typescript": "^5.8.3",
+		"@types/validator": "^13.15.3",
+		"prettier": "^3.6.2",
+		"typescript": "^5.9.2",
 		"vitest": "^3.2.4"
 	}
 }