@pluslabs/utils 0.2.1 → 0.3.1

package/dist/main/cache/index.d.ts

@@ -0,0 +1,42 @@
+declare class CacheKey {
+    private key;
+    /**
+     * The time to live for the cache key in seconds
+     */
+    ttl: number;
+    constructor(prefix: string, ...args: string[]);
+    setTtl(ttl: number): this;
+    add(...values: (string | number | boolean)[]): this;
+    get(): string;
+}
+type CacheKeysManagerOptions<R extends Record<string, readonly string[]>> = {
+    registry: R;
+    namespace: string;
+    redisClient?: {
+        get<T = string>(key: string): Promise<T | null>;
+        set<T = string>(key: string, value: T, options: {
+            ex: number;
+        }): Promise<void>;
+        del(key: string): Promise<void>;
+        [key: string]: any;
+    };
+};
+/**
+ * Creates a cache keys manager
+ * @param options - The options for the cache keys manager
+ * @param options.registry - The registry of cache keys
+ * @param options.namespace - The namespace for the cache keys
+ * @param options.redisClient - The redis client to use for the cache keys manager
+ * @returns The cache keys manager
+ */
+declare function createCacheKeysManager<R extends Record<string, readonly string[]>>(options: CacheKeysManagerOptions<R>): {
+    getCacheKey: <K extends keyof R, V extends R[K][number], Args extends (string | number | boolean)[]>(root: K, node: V, ...identifiers: Args) => CacheKey;
+    invalidateCacheKey: <K_1 extends keyof R, V_1 extends R[K_1][number], Args_1 extends (string | number | boolean)[]>(root: K_1, key: V_1, ...identifiers: Args_1) => Promise<void>;
+    getCachedData: <T, K_2 extends keyof R, V_2 extends R[K_2][number]>(options: {
+        cacheKey: string | (() => [K_2, V_2, ...(string | number | boolean)[]]);
+        queryFn: () => Promise<T | null>;
+        ttl?: number | undefined;
+    }) => Promise<T | null>;
+};
+export default createCacheKeysManager;
+//# sourceMappingURL=index.d.ts.map

package/dist/main/cache/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/cache/index.ts"],"names":[],"mappings":"AAEA,cAAM,QAAQ;IACV,OAAO,CAAC,GAAG,CAAW;IAEtB;;OAEG;IACI,GAAG,EAAE,MAAM,CAAe;gBAErB,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE;IAI7C,MAAM,CAAC,GAAG,EAAE,MAAM;IAKlB,GAAG,CAAC,GAAG,MAAM,EAAE,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,EAAE;IAK5C,GAAG;CAGN;AAED,KAAK,uBAAuB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC,IAAI;IACxE,QAAQ,EAAE,CAAC,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE;QACV,GAAG,CAAC,CAAC,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;QAChD,GAAG,CAAC,CAAC,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE;YAAE,EAAE,EAAE,MAAM,CAAA;SAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAC/E,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAChC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACtB,CAAC;CACL,CAAC;AAEF;;;;;;;GAOG;AACH,iBAAS,sBAAsB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC,EACvE,OAAO,EAAE,uBAAuB,CAAC,CAAC,CAAC;;wKAqBO,QAAQ,IAAI,CAAC;;;;;;EA0F1D;AAED,eAAe,sBAAsB,CAAC"}

package/dist/main/cache/index.js

@@ -0,0 +1,118 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const DEFAULT_TTL = 10 * 60; // 10 minutes
+class CacheKey {
+    constructor(prefix, ...args) {
+        var _a, _b;
+        /**
+         * The time to live for the cache key in seconds
+         */
+        this.ttl = DEFAULT_TTL;
+        this.key = [prefix, (_b = (_a = process.env.NODE_ENV) === null || _a === void 0 ? void 0 : _a.substring(0, 4)) !== null && _b !== void 0 ? _b : 'dev', ...args];
+    }
+    setTtl(ttl) {
+        this.ttl = ttl;
+        return this;
+    }
+    add(...values) {
+        this.key.push(...((values === null || values === void 0 ? void 0 : values.map((value) => { var _a; return (_a = value === null || value === void 0 ? void 0 : value.toString()) !== null && _a !== void 0 ? _a : value; })) || []));
+        return this;
+    }
+    get() {
+        return this.key.join(':');
+    }
+}
+/**
+ * Creates a cache keys manager
+ * @param options - The options for the cache keys manager
+ * @param options.registry - The registry of cache keys
+ * @param options.namespace - The namespace for the cache keys
+ * @param options.redisClient - The redis client to use for the cache keys manager
+ * @returns The cache keys manager
+ */
+function createCacheKeysManager(options) {
+    const { registry, namespace, redisClient } = options;
+    function getCacheKey(root, node, ...identifiers) {
+        return new CacheKey(namespace, root.toString(), node, ...((identifiers === null || identifiers === void 0 ? void 0 : identifiers.map((arg) => { var _a; return (_a = arg === null || arg === void 0 ? void 0 : arg.toString()) !== null && _a !== void 0 ? _a : arg; })) || []));
+    }
+    function invalidateCacheKey(root, key, ...identifiers) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const cacheKey = getCacheKey(root, key, ...identifiers);
+            if (process.env.NODE_ENV !== 'production' && !redisClient) {
+                console.warn('[Cache Keys Manager] You tried to invalidate a cache key with no redis client');
+                return;
+            }
+            yield (redisClient === null || redisClient === void 0 ? void 0 : redisClient.del(cacheKey.get()));
+        });
+    }
+    function getCachedData(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { cacheKey, queryFn, ttl = DEFAULT_TTL } = options;
+            let cacheKeyString;
+            if (typeof cacheKey === 'string') {
+                cacheKeyString = cacheKey;
+            }
+            else {
+                const keyTuple = cacheKey();
+                cacheKeyString = getCacheKey(keyTuple[0], keyTuple[1], ...keyTuple.slice(2)).get();
+            }
+            try {
+                // Check cache first
+                const cachedData = yield (redisClient === null || redisClient === void 0 ? void 0 : redisClient.get(cacheKeyString));
+                if (cachedData) {
+                    return cachedData;
+                }
+            }
+            catch (error) {
+                console.error({
+                    error,
+                    cacheKey: cacheKeyString,
+                    message: 'Redis error, falling back to database'
+                });
+            }
+            // If not in cache or Redis error, get from database
+            try {
+                const data = yield queryFn();
+                if (!data) {
+                    return null;
+                }
+                // Try to cache the result, but don't fail if Redis is down
+                try {
+                    yield (redisClient === null || redisClient === void 0 ? void 0 : redisClient.set(cacheKeyString, data, { ex: ttl }));
+                }
+                catch (error) {
+                    console.error({
+                        error,
+                        cacheKey: cacheKeyString,
+                        message: 'Failed to cache data, but continuing with database result'
+                    });
+                }
+                return data;
+            }
+            catch (error) {
+                console.error({
+                    error,
+                    cacheKey: cacheKeyString,
+                    message: 'Database query failed'
+                });
+                return null;
+            }
+        });
+    }
+    return {
+        getCacheKey,
+        invalidateCacheKey,
+        getCachedData
+    };
+}
+exports.default = createCacheKeysManager;
+//# sourceMappingURL=index.js.map

package/dist/main/cache/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/cache/index.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,MAAM,WAAW,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,aAAa;AAE1C,MAAM,QAAQ;IAQV,YAAY,MAAc,EAAE,GAAG,IAAc;;QAL7C;;WAEG;QACI,QAAG,GAAW,WAAW,CAAC;QAG7B,IAAI,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,MAAA,MAAA,OAAO,CAAC,GAAG,CAAC,QAAQ,0CAAE,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,mCAAI,KAAK,EAAE,GAAG,IAAI,CAAC,CAAC;IACjF,CAAC;IAED,MAAM,CAAC,GAAW;QACd,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,GAAG,CAAC,GAAG,MAAqC;QACxC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,WAAC,OAAA,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,QAAQ,EAAE,mCAAI,KAAK,CAAA,EAAA,CAAC,KAAI,EAAE,CAAC,CAAC,CAAC;QAC7E,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,GAAG;QACC,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC9B,CAAC;CACJ;AAaD;;;;;;;GAOG;AACH,SAAS,sBAAsB,CAC3B,OAAmC;IAEnC,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC;IAErD,SAAS,WAAW,CAIlB,IAAO,EAAE,IAAO,EAAE,GAAG,WAAiB;QACpC,OAAO,IAAI,QAAQ,CACf,SAAS,EACT,IAAI,CAAC,QAAQ,EAAE,EACf,IAAI,EACJ,GAAG,CAAC,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,WAAC,OAAA,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,QAAQ,EAAE,mCAAI,GAAG,CAAA,EAAA,CAAC,KAAI,EAAE,CAAC,CAC/D,CAAC;IACN,CAAC;IAED,SAAe,kBAAkB,CAI/B,IAAO,EAAE,GAAM,EAAE,GAAG,WAAiB;;YACnC,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,WAAW,CAAC,CAAC;YAExD,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY,IAAI,CAAC,WAAW,EAAE;gBACvD,OAAO,CAAC,IAAI,CACR,+EAA+E,CAClF,CAAC;gBACF,OAAO;aACV;YAED,MAAM,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,GAAG,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,CAAA,CAAC;QAC3C,CAAC;KAAA;IAQD,SAAe,aAAa,CAA+C,OAI1E;;YACG,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,GAAG,WAAW,EAAE,GAAG,OAAO,CAAC;YAEzD,IAAI,cAAc,CAAC;YAEnB,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE;gBAC9B,cAAc,GAAG,QAAQ,CAAC;aAC7B;iBAAM;gBACH,MAAM,QAAQ,GAAG,QAAQ,EAAyB,CAAC;gBACnD,cAAc,GAAG,WAAW,CACxB,QAAQ,CAAC,CAAC,CAAC,EACX,QAAQ,CAAC,CAAC,CAAC,EACX,GAAI,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAmC,CAC1D,CAAC,GAAG,EAAE,CAAC;aACX;YAED,IAAI;gBACA,oBAAoB;gBACpB,MAAM,UAAU,GAAG,MAAM,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,GAAG,CAAI,cAAc,CAAC,CAAA,CAAC;gBAE7D,IAAI,UAAU,EAAE;oBACZ,OAAO,UAAe,CAAC;iBAC1B;aACJ;YAAC,OAAO,KAAU,EAAE;gBACjB,OAAO,CAAC,KAAK,CAAC;oBACV,KAAK;oBACL,QAAQ,EAAE,cAAc;oBACxB,OAAO,EAAE,uCAAuC;iBACnD,CAAC,CAAC;aACN;YAED,oDAAoD;YACpD,IAAI;gBACA,MAAM,IAAI,GAAG,MAAM,OAAO,EAAE,CAAC;gBAE7B,IAAI,CAAC,IAAI,EAAE;oBACP,OAAO,IAAI,CAAC;iBACf;gBAED,2DAA2D;gBAC3D,IAAI;oBACA,MAAM,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,GAAG,CAAC,cAAc,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,CAAA,CAAC;iBAC7D;gBAAC,OAAO,KAAU,EAAE;oBACjB,OAAO,CAAC,KAAK,CAAC;wBACV,KAAK;wBACL,QAAQ,EAAE,cAAc;wBACxB,OAAO,EAAE,2DAA2D;qBACvE,CAAC,CAAC;iBACN;gBAED,OAAO,IAAI,CAAC;aACf;YAAC,OAAO,KAAU,EAAE;gBACjB,OAAO,CAAC,KAAK,CAAC;oBACV,KAAK;oBACL,QAAQ,EAAE,cAAc;oBACxB,OAAO,EAAE,uBAAuB;iBACnC,CAAC,CAAC;gBAEH,OAAO,IAAI,CAAC;aACf;QACL,CAAC;KAAA;IAED,OAAO;QACH,WAAW;QACX,kBAAkB;QAClB,aAAa;KAChB,CAAC;AACN,CAAC;AAED,kBAAe,sBAAsB,CAAC"}

package/dist/main/gpt/index.d.ts

@@ -4,7 +4,7 @@ type ProactiveRequestData = {
     client_id: string;
     client_phone_number: string;
 };
-declare const gpt: {
+export declare const gpt: {
     extension: {
         /**
          * Send a proactive request to MagicGPT extension
@@ -14,5 +14,5 @@ declare const gpt: {
         proactiveRequest: (source: string, data: ProactiveRequestData) => void;
     };
 };
-export default gpt;
+export {};
 //# sourceMappingURL=index.d.ts.map

package/dist/main/gpt/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/gpt/index.ts"],"names":[],"mappings":"AAAA,KAAK,oBAAoB,GAAG;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,mBAAmB,EAAE,MAAM,CAAC;CAC/B,CAAC;AAEF,QAAA,MAAM,GAAG;;QAED;;;;WAIG;mCACwB,MAAM,QAAQ,oBAAoB;;CAmBpE,CAAC;AAEF,eAAe,GAAG,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/gpt/index.ts"],"names":[],"mappings":"AAAA,KAAK,oBAAoB,GAAG;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,mBAAmB,EAAE,MAAM,CAAC;CAC/B,CAAC;AAEF,eAAO,MAAM,GAAG;;QAER;;;;WAIG;mCACwB,MAAM,QAAQ,oBAAoB;;CAmBpE,CAAC"}

package/dist/main/gpt/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const gpt = {
+exports.gpt = void 0;
+exports.gpt = {
     extension: {
         /**
          * Send a proactive request to MagicGPT extension
@@ -23,5 +24,4 @@ const gpt = {
         }
     }
 };
-exports.default = gpt;
 //# sourceMappingURL=index.js.map

package/dist/main/gpt/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/gpt/index.ts"],"names":[],"mappings":";;AAOA,MAAM,GAAG,GAAG;IACR,SAAS,EAAE;QACP;;;;WAIG;QACH,gBAAgB,EAAE,CAAC,MAAc,EAAE,IAA0B,EAAE,EAAE;YAC7D,MAAM,CAAC,WAAW,CACd,IAAI,CAAC,SAAS,CAAC;gBACX,MAAM,EAAE,mBAAmB;gBAC3B,IAAI,EAAE,IAAI,CACN,IAAI,CAAC,SAAS,CAAC;oBACX,MAAM;oBACN,IAAI,EAAE;wBACF,UAAU,EAAE,IAAI,CAAC,UAAU;wBAC3B,YAAY,EAAE,IAAI,CAAC,YAAY;wBAC/B,SAAS,EAAE,IAAI,CAAC,SAAS;wBACzB,mBAAmB,EAAE,IAAI,CAAC,mBAAmB;qBAChD;iBACJ,CAAC,CACL;aACJ,CAAC,CACL,CAAC;QACN,CAAC;KACJ;CACJ,CAAC;AAEF,kBAAe,GAAG,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/gpt/index.ts"],"names":[],"mappings":";;;AAOa,QAAA,GAAG,GAAG;IACf,SAAS,EAAE;QACP;;;;WAIG;QACH,gBAAgB,EAAE,CAAC,MAAc,EAAE,IAA0B,EAAE,EAAE;YAC7D,MAAM,CAAC,WAAW,CACd,IAAI,CAAC,SAAS,CAAC;gBACX,MAAM,EAAE,mBAAmB;gBAC3B,IAAI,EAAE,IAAI,CACN,IAAI,CAAC,SAAS,CAAC;oBACX,MAAM;oBACN,IAAI,EAAE;wBACF,UAAU,EAAE,IAAI,CAAC,UAAU;wBAC3B,YAAY,EAAE,IAAI,CAAC,YAAY;wBAC/B,SAAS,EAAE,IAAI,CAAC,SAAS;wBACzB,mBAAmB,EAAE,IAAI,CAAC,mBAAmB;qBAChD;iBACJ,CAAC,CACL;aACJ,CAAC,CACL,CAAC;QACN,CAAC;KACJ;CACJ,CAAC"}

package/dist/main/index.d.ts

@@ -1,4 +1,6 @@
-import gpt from './gpt';
-export { gpt };
+import * as gpt from './gpt';
+import createCacheKeysManager from './cache';
 export * from './stamp';
+export * from './cache';
+export { gpt, createCacheKeysManager };
 //# sourceMappingURL=index.d.ts.map

package/dist/main/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,OAAO,CAAC;AACxB,OAAO,EAAE,GAAG,EAAE,CAAC;AAEf,cAAc,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,GAAG,MAAM,OAAO,CAAC;AAC7B,OAAO,sBAAsB,MAAM,SAAS,CAAC;AAE7C,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AAExB,OAAO,EAAE,GAAG,EAAE,sBAAsB,EAAE,CAAC"}

package/dist/main/index.js

@@ -10,6 +10,18 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
 }));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
@@ -17,8 +29,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.gpt = void 0;
-const gpt_1 = __importDefault(require("./gpt"));
-exports.gpt = gpt_1.default;
+exports.createCacheKeysManager = exports.gpt = void 0;
+const gpt = __importStar(require("./gpt"));
+exports.gpt = gpt;
+const cache_1 = __importDefault(require("./cache"));
+exports.createCacheKeysManager = cache_1.default;
 __exportStar(require("./stamp"), exports);
+__exportStar(require("./cache"), exports);
 //# sourceMappingURL=index.js.map

package/dist/main/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA,gDAAwB;AACf,cADF,aAAG,CACE;AAEZ,0CAAwB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2CAA6B;AAMpB,kBAAG;AALZ,oDAA6C;AAK/B,iCALP,eAAsB,CAKO;AAHpC,0CAAwB;AACxB,0CAAwB"}

package/dist/module/cache/index.d.ts

@@ -0,0 +1,42 @@
+declare class CacheKey {
+    private key;
+    /**
+     * The time to live for the cache key in seconds
+     */
+    ttl: number;
+    constructor(prefix: string, ...args: string[]);
+    setTtl(ttl: number): this;
+    add(...values: (string | number | boolean)[]): this;
+    get(): string;
+}
+type CacheKeysManagerOptions<R extends Record<string, readonly string[]>> = {
+    registry: R;
+    namespace: string;
+    redisClient?: {
+        get<T = string>(key: string): Promise<T | null>;
+        set<T = string>(key: string, value: T, options: {
+            ex: number;
+        }): Promise<void>;
+        del(key: string): Promise<void>;
+        [key: string]: any;
+    };
+};
+/**
+ * Creates a cache keys manager
+ * @param options - The options for the cache keys manager
+ * @param options.registry - The registry of cache keys
+ * @param options.namespace - The namespace for the cache keys
+ * @param options.redisClient - The redis client to use for the cache keys manager
+ * @returns The cache keys manager
+ */
+declare function createCacheKeysManager<R extends Record<string, readonly string[]>>(options: CacheKeysManagerOptions<R>): {
+    getCacheKey: <K extends keyof R, V extends R[K][number], Args extends (string | number | boolean)[]>(root: K, node: V, ...identifiers: Args) => CacheKey;
+    invalidateCacheKey: <K_1 extends keyof R, V_1 extends R[K_1][number], Args_1 extends (string | number | boolean)[]>(root: K_1, key: V_1, ...identifiers: Args_1) => Promise<void>;
+    getCachedData: <T, K_2 extends keyof R, V_2 extends R[K_2][number]>(options: {
+        cacheKey: string | (() => [K_2, V_2, ...(string | number | boolean)[]]);
+        queryFn: () => Promise<T | null>;
+        ttl?: number | undefined;
+    }) => Promise<T | null>;
+};
+export default createCacheKeysManager;
+//# sourceMappingURL=index.d.ts.map

package/dist/module/cache/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/cache/index.ts"],"names":[],"mappings":"AAEA,cAAM,QAAQ;IACV,OAAO,CAAC,GAAG,CAAW;IAEtB;;OAEG;IACI,GAAG,EAAE,MAAM,CAAe;gBAErB,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,MAAM,EAAE;IAI7C,MAAM,CAAC,GAAG,EAAE,MAAM;IAKlB,GAAG,CAAC,GAAG,MAAM,EAAE,CAAC,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,EAAE;IAK5C,GAAG;CAGN;AAED,KAAK,uBAAuB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC,IAAI;IACxE,QAAQ,EAAE,CAAC,CAAC;IACZ,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE;QACV,GAAG,CAAC,CAAC,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;QAChD,GAAG,CAAC,CAAC,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE;YAAE,EAAE,EAAE,MAAM,CAAA;SAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAC/E,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;QAChC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACtB,CAAC;CACL,CAAC;AAEF;;;;;;;GAOG;AACH,iBAAS,sBAAsB,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC,EACvE,OAAO,EAAE,uBAAuB,CAAC,CAAC,CAAC;;wKAqBO,QAAQ,IAAI,CAAC;;;;;;EA0F1D;AAED,eAAe,sBAAsB,CAAC"}

package/dist/module/cache/index.js

@@ -0,0 +1,116 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+const DEFAULT_TTL = 10 * 60; // 10 minutes
+class CacheKey {
+    constructor(prefix, ...args) {
+        var _a, _b;
+        /**
+         * The time to live for the cache key in seconds
+         */
+        this.ttl = DEFAULT_TTL;
+        this.key = [prefix, (_b = (_a = process.env.NODE_ENV) === null || _a === void 0 ? void 0 : _a.substring(0, 4)) !== null && _b !== void 0 ? _b : 'dev', ...args];
+    }
+    setTtl(ttl) {
+        this.ttl = ttl;
+        return this;
+    }
+    add(...values) {
+        this.key.push(...((values === null || values === void 0 ? void 0 : values.map((value) => { var _a; return (_a = value === null || value === void 0 ? void 0 : value.toString()) !== null && _a !== void 0 ? _a : value; })) || []));
+        return this;
+    }
+    get() {
+        return this.key.join(':');
+    }
+}
+/**
+ * Creates a cache keys manager
+ * @param options - The options for the cache keys manager
+ * @param options.registry - The registry of cache keys
+ * @param options.namespace - The namespace for the cache keys
+ * @param options.redisClient - The redis client to use for the cache keys manager
+ * @returns The cache keys manager
+ */
+function createCacheKeysManager(options) {
+    const { registry, namespace, redisClient } = options;
+    function getCacheKey(root, node, ...identifiers) {
+        return new CacheKey(namespace, root.toString(), node, ...((identifiers === null || identifiers === void 0 ? void 0 : identifiers.map((arg) => { var _a; return (_a = arg === null || arg === void 0 ? void 0 : arg.toString()) !== null && _a !== void 0 ? _a : arg; })) || []));
+    }
+    function invalidateCacheKey(root, key, ...identifiers) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const cacheKey = getCacheKey(root, key, ...identifiers);
+            if (process.env.NODE_ENV !== 'production' && !redisClient) {
+                console.warn('[Cache Keys Manager] You tried to invalidate a cache key with no redis client');
+                return;
+            }
+            yield (redisClient === null || redisClient === void 0 ? void 0 : redisClient.del(cacheKey.get()));
+        });
+    }
+    function getCachedData(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { cacheKey, queryFn, ttl = DEFAULT_TTL } = options;
+            let cacheKeyString;
+            if (typeof cacheKey === 'string') {
+                cacheKeyString = cacheKey;
+            }
+            else {
+                const keyTuple = cacheKey();
+                cacheKeyString = getCacheKey(keyTuple[0], keyTuple[1], ...keyTuple.slice(2)).get();
+            }
+            try {
+                // Check cache first
+                const cachedData = yield (redisClient === null || redisClient === void 0 ? void 0 : redisClient.get(cacheKeyString));
+                if (cachedData) {
+                    return cachedData;
+                }
+            }
+            catch (error) {
+                console.error({
+                    error,
+                    cacheKey: cacheKeyString,
+                    message: 'Redis error, falling back to database'
+                });
+            }
+            // If not in cache or Redis error, get from database
+            try {
+                const data = yield queryFn();
+                if (!data) {
+                    return null;
+                }
+                // Try to cache the result, but don't fail if Redis is down
+                try {
+                    yield (redisClient === null || redisClient === void 0 ? void 0 : redisClient.set(cacheKeyString, data, { ex: ttl }));
+                }
+                catch (error) {
+                    console.error({
+                        error,
+                        cacheKey: cacheKeyString,
+                        message: 'Failed to cache data, but continuing with database result'
+                    });
+                }
+                return data;
+            }
+            catch (error) {
+                console.error({
+                    error,
+                    cacheKey: cacheKeyString,
+                    message: 'Database query failed'
+                });
+                return null;
+            }
+        });
+    }
+    return {
+        getCacheKey,
+        invalidateCacheKey,
+        getCachedData
+    };
+}
+export default createCacheKeysManager;
+//# sourceMappingURL=index.js.map

package/dist/module/cache/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/cache/index.ts"],"names":[],"mappings":";;;;;;;;;AAAA,MAAM,WAAW,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,aAAa;AAE1C,MAAM,QAAQ;IAQV,YAAY,MAAc,EAAE,GAAG,IAAc;;QAL7C;;WAEG;QACI,QAAG,GAAW,WAAW,CAAC;QAG7B,IAAI,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,MAAA,MAAA,OAAO,CAAC,GAAG,CAAC,QAAQ,0CAAE,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,mCAAI,KAAK,EAAE,GAAG,IAAI,CAAC,CAAC;IACjF,CAAC;IAED,MAAM,CAAC,GAAW;QACd,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,GAAG,CAAC,GAAG,MAAqC;QACxC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,WAAC,OAAA,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,QAAQ,EAAE,mCAAI,KAAK,CAAA,EAAA,CAAC,KAAI,EAAE,CAAC,CAAC,CAAC;QAC7E,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,GAAG;QACC,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC9B,CAAC;CACJ;AAaD;;;;;;;GAOG;AACH,SAAS,sBAAsB,CAC3B,OAAmC;IAEnC,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,WAAW,EAAE,GAAG,OAAO,CAAC;IAErD,SAAS,WAAW,CAIlB,IAAO,EAAE,IAAO,EAAE,GAAG,WAAiB;QACpC,OAAO,IAAI,QAAQ,CACf,SAAS,EACT,IAAI,CAAC,QAAQ,EAAE,EACf,IAAI,EACJ,GAAG,CAAC,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,WAAC,OAAA,MAAA,GAAG,aAAH,GAAG,uBAAH,GAAG,CAAE,QAAQ,EAAE,mCAAI,GAAG,CAAA,EAAA,CAAC,KAAI,EAAE,CAAC,CAC/D,CAAC;IACN,CAAC;IAED,SAAe,kBAAkB,CAI/B,IAAO,EAAE,GAAM,EAAE,GAAG,WAAiB;;YACnC,MAAM,QAAQ,GAAG,WAAW,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,WAAW,CAAC,CAAC;YAExD,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY,IAAI,CAAC,WAAW,EAAE;gBACvD,OAAO,CAAC,IAAI,CACR,+EAA+E,CAClF,CAAC;gBACF,OAAO;aACV;YAED,MAAM,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,GAAG,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,CAAA,CAAC;QAC3C,CAAC;KAAA;IAQD,SAAe,aAAa,CAA+C,OAI1E;;YACG,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,GAAG,WAAW,EAAE,GAAG,OAAO,CAAC;YAEzD,IAAI,cAAc,CAAC;YAEnB,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE;gBAC9B,cAAc,GAAG,QAAQ,CAAC;aAC7B;iBAAM;gBACH,MAAM,QAAQ,GAAG,QAAQ,EAAyB,CAAC;gBACnD,cAAc,GAAG,WAAW,CACxB,QAAQ,CAAC,CAAC,CAAC,EACX,QAAQ,CAAC,CAAC,CAAC,EACX,GAAI,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAmC,CAC1D,CAAC,GAAG,EAAE,CAAC;aACX;YAED,IAAI;gBACA,oBAAoB;gBACpB,MAAM,UAAU,GAAG,MAAM,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,GAAG,CAAI,cAAc,CAAC,CAAA,CAAC;gBAE7D,IAAI,UAAU,EAAE;oBACZ,OAAO,UAAe,CAAC;iBAC1B;aACJ;YAAC,OAAO,KAAU,EAAE;gBACjB,OAAO,CAAC,KAAK,CAAC;oBACV,KAAK;oBACL,QAAQ,EAAE,cAAc;oBACxB,OAAO,EAAE,uCAAuC;iBACnD,CAAC,CAAC;aACN;YAED,oDAAoD;YACpD,IAAI;gBACA,MAAM,IAAI,GAAG,MAAM,OAAO,EAAE,CAAC;gBAE7B,IAAI,CAAC,IAAI,EAAE;oBACP,OAAO,IAAI,CAAC;iBACf;gBAED,2DAA2D;gBAC3D,IAAI;oBACA,MAAM,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,GAAG,CAAC,cAAc,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,CAAA,CAAC;iBAC7D;gBAAC,OAAO,KAAU,EAAE;oBACjB,OAAO,CAAC,KAAK,CAAC;wBACV,KAAK;wBACL,QAAQ,EAAE,cAAc;wBACxB,OAAO,EAAE,2DAA2D;qBACvE,CAAC,CAAC;iBACN;gBAED,OAAO,IAAI,CAAC;aACf;YAAC,OAAO,KAAU,EAAE;gBACjB,OAAO,CAAC,KAAK,CAAC;oBACV,KAAK;oBACL,QAAQ,EAAE,cAAc;oBACxB,OAAO,EAAE,uBAAuB;iBACnC,CAAC,CAAC;gBAEH,OAAO,IAAI,CAAC;aACf;QACL,CAAC;KAAA;IAED,OAAO;QACH,WAAW;QACX,kBAAkB;QAClB,aAAa;KAChB,CAAC;AACN,CAAC;AAED,eAAe,sBAAsB,CAAC"}

package/dist/module/gpt/index.d.ts

@@ -4,7 +4,7 @@ type ProactiveRequestData = {
     client_id: string;
     client_phone_number: string;
 };
-declare const gpt: {
+export declare const gpt: {
     extension: {
         /**
          * Send a proactive request to MagicGPT extension
@@ -14,5 +14,5 @@ declare const gpt: {
         proactiveRequest: (source: string, data: ProactiveRequestData) => void;
     };
 };
-export default gpt;
+export {};
 //# sourceMappingURL=index.d.ts.map

package/dist/module/gpt/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/gpt/index.ts"],"names":[],"mappings":"AAAA,KAAK,oBAAoB,GAAG;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,mBAAmB,EAAE,MAAM,CAAC;CAC/B,CAAC;AAEF,QAAA,MAAM,GAAG;;QAED;;;;WAIG;mCACwB,MAAM,QAAQ,oBAAoB;;CAmBpE,CAAC;AAEF,eAAe,GAAG,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/gpt/index.ts"],"names":[],"mappings":"AAAA,KAAK,oBAAoB,GAAG;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,mBAAmB,EAAE,MAAM,CAAC;CAC/B,CAAC;AAEF,eAAO,MAAM,GAAG;;QAER;;;;WAIG;mCACwB,MAAM,QAAQ,oBAAoB;;CAmBpE,CAAC"}

package/dist/module/gpt/index.js

@@ -1,4 +1,4 @@
-const gpt = {
+export const gpt = {
     extension: {
         /**
          * Send a proactive request to MagicGPT extension
@@ -21,5 +21,4 @@ const gpt = {
         }
     }
 };
-export default gpt;
 //# sourceMappingURL=index.js.map

package/dist/module/gpt/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/gpt/index.ts"],"names":[],"mappings":"AAOA,MAAM,GAAG,GAAG;IACR,SAAS,EAAE;QACP;;;;WAIG;QACH,gBAAgB,EAAE,CAAC,MAAc,EAAE,IAA0B,EAAE,EAAE;YAC7D,MAAM,CAAC,WAAW,CACd,IAAI,CAAC,SAAS,CAAC;gBACX,MAAM,EAAE,mBAAmB;gBAC3B,IAAI,EAAE,IAAI,CACN,IAAI,CAAC,SAAS,CAAC;oBACX,MAAM;oBACN,IAAI,EAAE;wBACF,UAAU,EAAE,IAAI,CAAC,UAAU;wBAC3B,YAAY,EAAE,IAAI,CAAC,YAAY;wBAC/B,SAAS,EAAE,IAAI,CAAC,SAAS;wBACzB,mBAAmB,EAAE,IAAI,CAAC,mBAAmB;qBAChD;iBACJ,CAAC,CACL;aACJ,CAAC,CACL,CAAC;QACN,CAAC;KACJ;CACJ,CAAC;AAEF,eAAe,GAAG,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/gpt/index.ts"],"names":[],"mappings":"AAOA,MAAM,CAAC,MAAM,GAAG,GAAG;IACf,SAAS,EAAE;QACP;;;;WAIG;QACH,gBAAgB,EAAE,CAAC,MAAc,EAAE,IAA0B,EAAE,EAAE;YAC7D,MAAM,CAAC,WAAW,CACd,IAAI,CAAC,SAAS,CAAC;gBACX,MAAM,EAAE,mBAAmB;gBAC3B,IAAI,EAAE,IAAI,CACN,IAAI,CAAC,SAAS,CAAC;oBACX,MAAM;oBACN,IAAI,EAAE;wBACF,UAAU,EAAE,IAAI,CAAC,UAAU;wBAC3B,YAAY,EAAE,IAAI,CAAC,YAAY;wBAC/B,SAAS,EAAE,IAAI,CAAC,SAAS;wBACzB,mBAAmB,EAAE,IAAI,CAAC,mBAAmB;qBAChD;iBACJ,CAAC,CACL;aACJ,CAAC,CACL,CAAC;QACN,CAAC;KACJ;CACJ,CAAC"}

package/dist/module/index.d.ts

@@ -1,4 +1,6 @@
-import gpt from './gpt';
-export { gpt };
+import * as gpt from './gpt';
+import createCacheKeysManager from './cache';
 export * from './stamp';
+export * from './cache';
+export { gpt, createCacheKeysManager };
 //# sourceMappingURL=index.d.ts.map

package/dist/module/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,OAAO,CAAC;AACxB,OAAO,EAAE,GAAG,EAAE,CAAC;AAEf,cAAc,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,GAAG,MAAM,OAAO,CAAC;AAC7B,OAAO,sBAAsB,MAAM,SAAS,CAAC;AAE7C,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AAExB,OAAO,EAAE,GAAG,EAAE,sBAAsB,EAAE,CAAC"}

package/dist/module/index.js

@@ -1,4 +1,6 @@
-import gpt from './gpt';
-export { gpt };
+import * as gpt from './gpt';
+import createCacheKeysManager from './cache';
 export * from './stamp';
+export * from './cache';
+export { gpt, createCacheKeysManager };
 //# sourceMappingURL=index.js.map

package/dist/module/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,OAAO,CAAC;AACxB,OAAO,EAAE,GAAG,EAAE,CAAC;AAEf,cAAc,SAAS,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,GAAG,MAAM,OAAO,CAAC;AAC7B,OAAO,sBAAsB,MAAM,SAAS,CAAC;AAE7C,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AAExB,OAAO,EAAE,GAAG,EAAE,sBAAsB,EAAE,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@pluslabs/utils",
-    "version": "0.2.1",
+    "version": "0.3.1",
     "description": "A set of utilities used across projects",
     "keywords": [
         "javascript",

package/src/cache/index.ts

@@ -0,0 +1,163 @@
+const DEFAULT_TTL = 10 * 60; // 10 minutes
+
+class CacheKey {
+    private key: string[];
+
+    /**
+     * The time to live for the cache key in seconds
+     */
+    public ttl: number = DEFAULT_TTL;
+
+    constructor(prefix: string, ...args: string[]) {
+        this.key = [prefix, process.env.NODE_ENV?.substring(0, 4) ?? 'dev', ...args];
+    }
+
+    setTtl(ttl: number) {
+        this.ttl = ttl;
+        return this;
+    }
+
+    add(...values: (string | number | boolean)[]) {
+        this.key.push(...(values?.map((value) => value?.toString() ?? value) || []));
+        return this;
+    }
+
+    get() {
+        return this.key.join(':');
+    }
+}
+
+type CacheKeysManagerOptions<R extends Record<string, readonly string[]>> = {
+    registry: R;
+    namespace: string;
+    redisClient?: {
+        get<T = string>(key: string): Promise<T | null>;
+        set<T = string>(key: string, value: T, options: { ex: number }): Promise<void>;
+        del(key: string): Promise<void>;
+        [key: string]: any;
+    };
+};
+
+/**
+ * Creates a cache keys manager
+ * @param options - The options for the cache keys manager
+ * @param options.registry - The registry of cache keys
+ * @param options.namespace - The namespace for the cache keys
+ * @param options.redisClient - The redis client to use for the cache keys manager
+ * @returns The cache keys manager
+ */
+function createCacheKeysManager<R extends Record<string, readonly string[]>>(
+    options: CacheKeysManagerOptions<R>
+) {
+    const { registry, namespace, redisClient } = options;
+
+    function getCacheKey<
+        K extends keyof R,
+        V extends R[K][number],
+        Args extends (string | number | boolean)[]
+    >(root: K, node: V, ...identifiers: Args) {
+        return new CacheKey(
+            namespace,
+            root.toString(),
+            node,
+            ...(identifiers?.map((arg) => arg?.toString() ?? arg) || [])
+        );
+    }
+
+    async function invalidateCacheKey<
+        K extends keyof R,
+        V extends R[K][number],
+        Args extends (string | number | boolean)[]
+    >(root: K, key: V, ...identifiers: Args): Promise<void> {
+        const cacheKey = getCacheKey(root, key, ...identifiers);
+
+        if (process.env.NODE_ENV !== 'production' && !redisClient) {
+            console.warn(
+                '[Cache Keys Manager] You tried to invalidate a cache key with no redis client'
+            );
+            return;
+        }
+
+        await redisClient?.del(cacheKey.get());
+    }
+
+    type CacheKeyTuple<K extends keyof R, V extends R[K][number]> = [
+        K,
+        V,
+        ...(string | number | boolean)[]
+    ];
+
+    async function getCachedData<T, K extends keyof R, V extends R[K][number]>(options: {
+        cacheKey: string | (() => CacheKeyTuple<K, V>);
+        queryFn: () => Promise<T | null>;
+        ttl?: number;
+    }): Promise<T | null> {
+        const { cacheKey, queryFn, ttl = DEFAULT_TTL } = options;
+
+        let cacheKeyString;
+
+        if (typeof cacheKey === 'string') {
+            cacheKeyString = cacheKey;
+        } else {
+            const keyTuple = cacheKey() as CacheKeyTuple<K, V>;
+            cacheKeyString = getCacheKey(
+                keyTuple[0],
+                keyTuple[1],
+                ...(keyTuple.slice(2) as (string | number | boolean)[])
+            ).get();
+        }
+
+        try {
+            // Check cache first
+            const cachedData = await redisClient?.get<T>(cacheKeyString);
+
+            if (cachedData) {
+                return cachedData as T;
+            }
+        } catch (error: any) {
+            console.error({
+                error,
+                cacheKey: cacheKeyString,
+                message: 'Redis error, falling back to database'
+            });
+        }
+
+        // If not in cache or Redis error, get from database
+        try {
+            const data = await queryFn();
+
+            if (!data) {
+                return null;
+            }
+
+            // Try to cache the result, but don't fail if Redis is down
+            try {
+                await redisClient?.set(cacheKeyString, data, { ex: ttl });
+            } catch (error: any) {
+                console.error({
+                    error,
+                    cacheKey: cacheKeyString,
+                    message: 'Failed to cache data, but continuing with database result'
+                });
+            }
+
+            return data;
+        } catch (error: any) {
+            console.error({
+                error,
+                cacheKey: cacheKeyString,
+                message: 'Database query failed'
+            });
+
+            return null;
+        }
+    }
+
+    return {
+        getCacheKey,
+        invalidateCacheKey,
+        getCachedData
+    };
+}
+
+export default createCacheKeysManager;

package/src/gpt/index.ts

@@ -5,7 +5,7 @@ type ProactiveRequestData = {
     client_phone_number: string;
 };
 
-const gpt = {
+export const gpt = {
     extension: {
         /**
          * Send a proactive request to MagicGPT extension
@@ -32,5 +32,3 @@ const gpt = {
         }
     }
 };
-
-export default gpt;

package/src/index.ts

@@ -1,4 +1,7 @@
-import gpt from './gpt';
-export { gpt };
+import * as gpt from './gpt';
+import createCacheKeysManager from './cache';
 
 export * from './stamp';
+export * from './cache';
+
+export { gpt, createCacheKeysManager };