@warlock.js/cache 1.0.0

package/esm/types.d.ts

@@ -0,0 +1,193 @@
+import type { GenericObject } from "@mongez/reinforcements";
+import type { RedisClientOptions } from "redis";
+import type { BaseCacheDriver, FileCacheDriver, MemoryCacheDriver, MemoryExtendedCacheDriver, NullCacheDriver, RedisCacheDriver } from "./drivers";
+export type CacheOperationType = "fetching" | "fetched" | "caching" | "cached" | "flushing" | "flushed" | "removing" | "removed" | "clearing" | "cleared" | "expired" | "notFound" | "connecting" | "error" | "connected" | "disconnecting" | "disconnected";
+export type MemoryCacheOptions = {
+    /**
+     * The global prefix for the cache key
+     */
+    globalPrefix?: string | (() => string);
+    /**
+     * The default TTL for the cache in seconds
+     *
+     * @default Infinity
+     */
+    ttl?: number;
+};
+export type MemoryExtendedCacheOptions = MemoryCacheOptions;
+export type LRUMemoryCacheOptions = {
+    /**
+     * The maximum number of items in the cache
+     *
+     * @default 1000
+     */
+    capacity?: number;
+};
+export type FileCacheOptions = {
+    /**
+     * The global prefix for the cache key
+     */
+    globalPrefix?: string | (() => string);
+    /**
+     * The default TTL for the cache in seconds
+     *
+     * @default 0
+     */
+    ttl?: number;
+    /**
+     * Storage cache directory
+     *
+     * @default storagePath("cache")
+     */
+    directory: string | (() => string);
+    /**
+     * File name
+     *
+     * @default cache.json
+     */
+    fileName?: string | (() => string);
+};
+export type RedisOptions = {
+    /**
+     * Redis Port
+     *
+     * @default 6379
+     */
+    port?: number;
+    /**
+     * Redis Host
+     */
+    host?: string;
+    /**
+     * Redis Username
+     */
+    username?: string;
+    /**
+     * Redis Password
+     */
+    password?: string;
+    /**
+     * Redis URL
+     *
+     * If used, it will override the host and port options
+     */
+    url?: string;
+    /**
+     * Global prefix for the cache key
+     */
+    globalPrefix?: string | (() => string);
+    /**
+     * Time to live in seconds
+     *
+     * @default Infinity
+     */
+    ttl?: number;
+    /**
+     * Redis client options
+     */
+    clientOptions?: RedisClientOptions;
+};
+export type NullCacheDriverOptions = GenericObject;
+export interface CacheDriver<ClientType, Options> {
+    /**
+     * The cache driver options
+     */
+    options: Options;
+    /**
+     * Cache driver name
+     */
+    name: string;
+    /**
+     *  Remove all cached items by namespace
+     */
+    removeNamespace(namespace: string): Promise<any>;
+    /**
+     * Set the cache driver options
+     */
+    setOptions(options: Options): any;
+    /**
+     * Parse the key to be used in the cache
+     */
+    parseKey(key: string | GenericObject): Promise<string>;
+    /**
+     * Set a value in the cache
+     *
+     * @param key The cache key, could be an object or string
+     * @param value The value to be stored in the cache
+     * @param ttl The time to live in seconds
+     */
+    set(key: string | GenericObject, value: any, ttl?: number): Promise<any>;
+    /**
+     * Get a value from the cache
+     */
+    get(key: string | GenericObject): Promise<any | null>;
+    /**
+     * Remove a value from the cache
+     */
+    remove(key: string | GenericObject): Promise<void>;
+    /**
+     * Flush the entire cache
+     */
+    flush(): Promise<void>;
+    /**
+     * Connect to the cache driver
+     */
+    connect(): Promise<any>;
+    /**
+     * The cache client
+     */
+    client?: ClientType;
+    /**
+     * Disconnect the cache driver
+     */
+    disconnect(): Promise<void>;
+}
+export type CacheData = {
+    /**
+     * Value stored in the cache
+     */
+    data: any;
+    /**
+     * The expiration date in milliseconds
+     */
+    expiresAt?: number;
+    /**
+     * Time to live in seconds
+     */
+    ttl?: number;
+};
+export type DriverClass = new () => CacheDriver<any, any>;
+type DefaultDrivers = "redis" | "file" | "memory" | "memoryExtended" | "null" | "lru";
+type MergeWithDefaultDrivers<T> = T extends undefined ? DefaultDrivers : DefaultDrivers | T;
+export type CacheConfigurations<T extends string | undefined = undefined, DriverName = MergeWithDefaultDrivers<T>> = {
+    /**
+     * The default cache driver name
+     */
+    default?: DriverName;
+    /**
+     * The cache drivers list
+     */
+    drivers: {
+        redis?: typeof RedisCacheDriver;
+        file?: typeof FileCacheDriver;
+        null?: typeof NullCacheDriver;
+        memory?: typeof MemoryCacheDriver;
+        memoryExtended?: typeof MemoryExtendedCacheDriver;
+    } & {
+        [key in Extract<T, string>]?: typeof BaseCacheDriver<any, any> | undefined;
+    };
+    /**
+     * The cache driver options
+     */
+    options: {
+        redis?: RedisOptions;
+        file?: FileCacheOptions;
+        memory?: MemoryCacheOptions;
+        memoryExtended?: MemoryExtendedCacheOptions;
+        null?: NullCacheDriverOptions;
+    } & {
+        [key in Extract<T, string>]?: GenericObject;
+    };
+};
+export {};
+//# sourceMappingURL=types.d.ts.map

package/esm/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAChD,OAAO,KAAK,EACV,eAAe,EACf,eAAe,EACf,iBAAiB,EACjB,yBAAyB,EACzB,eAAe,EACf,gBAAgB,EACjB,MAAM,WAAW,CAAC;AAEnB,MAAM,MAAM,kBAAkB,GAC1B,UAAU,GACV,SAAS,GACT,SAAS,GACT,QAAQ,GACR,UAAU,GACV,SAAS,GACT,UAAU,GACV,SAAS,GACT,UAAU,GACV,SAAS,GACT,SAAS,GACT,UAAU,GACV,YAAY,GACZ,OAAO,GACP,WAAW,GACX,eAAe,GACf,cAAc,CAAC;AAEnB,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,MAAM,CAAC,CAAC;IACvC;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG,kBAAkB,CAAC;AAE5D,MAAM,MAAM,qBAAqB,GAAG;IAClC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,MAAM,CAAC,CAAC;IACvC;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,SAAS,EAAE,MAAM,GAAG,CAAC,MAAM,MAAM,CAAC,CAAC;IACnC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,MAAM,CAAC,CAAC;CACpC,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,MAAM,CAAC,CAAC;IACvC;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,aAAa,CAAC,EAAE,kBAAkB,CAAC;CACpC,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG,aAAa,CAAC;AAEnD,MAAM,WAAW,WAAW,CAAC,UAAU,EAAE,OAAO;IAC9C;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACjD;;OAEG;IACH,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,GAAG,CAAC;IAClC;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACvD;;;;;;OAMG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC;IACzE;;OAEG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,GAAG,OAAO,CAAC,GAAG,GAAG,IAAI,CAAC,CAAC;IACtD;;OAEG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnD;;OAEG;IACH,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACvB;;OAEG;IACH,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC;IACxB;;OAEG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB;;OAEG;IACH,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAC7B;AAED,MAAM,MAAM,SAAS,GAAG;IACtB;;OAEG;IACH,IAAI,EAAE,GAAG,CAAC;IACV;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,UAAU,WAAW,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;AAE1D,KAAK,cAAc,GACf,OAAO,GACP,MAAM,GACN,QAAQ,GACR,gBAAgB,GAChB,MAAM,GACN,KAAK,CAAC;AAEV,KAAK,uBAAuB,CAAC,CAAC,IAAI,CAAC,SAAS,SAAS,GACjD,cAAc,GACd,cAAc,GAAG,CAAC,CAAC;AAEvB,MAAM,MAAM,mBAAmB,CAC7B,CAAC,SAAS,MAAM,GAAG,SAAS,GAAG,SAAS,EACxC,UAAU,GAAG,uBAAuB,CAAC,CAAC,CAAC,IACrC;IACF;;OAEG;IACH,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB;;OAEG;IACH,OAAO,EAAE;QACP,KAAK,CAAC,EAAE,OAAO,gBAAgB,CAAC;QAChC,IAAI,CAAC,EAAE,OAAO,eAAe,CAAC;QAC9B,IAAI,CAAC,EAAE,OAAO,eAAe,CAAC;QAC9B,MAAM,CAAC,EAAE,OAAO,iBAAiB,CAAC;QAClC,cAAc,CAAC,EAAE,OAAO,yBAAyB,CAAC;KACnD,GAAG;SACD,GAAG,IAAI,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,OAAO,eAAe,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,SAAS;KAC3E,CAAC;IACF;;OAEG;IACH,OAAO,EAAE;QACP,KAAK,CAAC,EAAE,YAAY,CAAC;QACrB,IAAI,CAAC,EAAE,gBAAgB,CAAC;QACxB,MAAM,CAAC,EAAE,kBAAkB,CAAC;QAC5B,cAAc,CAAC,EAAE,0BAA0B,CAAC;QAC5C,IAAI,CAAC,EAAE,sBAAsB,CAAC;KAC/B,GAAG;SACD,GAAG,IAAI,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,aAAa;KAC5C,CAAC;CACH,CAAC"}

package/esm/utils.d.ts

@@ -0,0 +1,20 @@
+import { GenericObject } from "@mongez/reinforcements";
+/**
+ * Make a proper key for the cache
+ */
+export declare function parseCacheKey(key: string | GenericObject, options?: {
+    globalPrefix?: string | (() => string);
+}): Promise<string>;
+export declare enum EXPIRES_AFTER {
+    HALF_HOUR = 1800,
+    ONE_HOUR = 3600,
+    HALF_DAY = 43200,
+    ONE_DAY = 86400,
+    ONE_WEEK = 604800,
+    HALF_MONTH = 1296000,
+    ONE_MONTH = 2592000,
+    TWO_MONTHS = 5184000,
+    SIX_MONTHS = 15768000,
+    ONE_YEAR = 31536000
+}
+//# sourceMappingURL=utils.d.ts.map

package/esm/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAS,MAAM,wBAAwB,CAAC;AAE9D;;GAEG;AACH,wBAAsB,aAAa,CACjC,GAAG,EAAE,MAAM,GAAG,aAAa,EAC3B,OAAO,GAAE;IAAE,YAAY,CAAC,EAAE,MAAM,GAAG,CAAC,MAAM,MAAM,CAAC,CAAA;CAAO,mBAezD;AAED,oBAAY,aAAa;IACvB,SAAS,OAAO;IAChB,QAAQ,OAAO;IACf,QAAQ,QAAQ;IAChB,OAAO,QAAQ;IACf,QAAQ,SAAS;IACjB,UAAU,UAAU;IACpB,SAAS,UAAU;IACnB,UAAU,UAAU;IACpB,UAAU,WAAW;IACrB,QAAQ,WAAW;CACpB"}

package/esm/utils.js

@@ -0,0 +1,27 @@
+import {rtrim}from'@mongez/reinforcements';/**
+ * Make a proper key for the cache
+ */
+async function parseCacheKey(key, options = {}) {
+    if (typeof key === "object") {
+        key = JSON.stringify(key);
+    }
+    // remove any curly braces and double quotes
+    key = key.replace(/[{}"]/g, "").replaceAll(":", ".").replaceAll(",", ".");
+    const cachePrefix = typeof options.globalPrefix === "function"
+        ? await options.globalPrefix()
+        : options.globalPrefix;
+    return String(cachePrefix ? rtrim(cachePrefix, ".") + "." + key : key);
+}
+var EXPIRES_AFTER;
+(function (EXPIRES_AFTER) {
+    EXPIRES_AFTER[EXPIRES_AFTER["HALF_HOUR"] = 1800] = "HALF_HOUR";
+    EXPIRES_AFTER[EXPIRES_AFTER["ONE_HOUR"] = 3600] = "ONE_HOUR";
+    EXPIRES_AFTER[EXPIRES_AFTER["HALF_DAY"] = 43200] = "HALF_DAY";
+    EXPIRES_AFTER[EXPIRES_AFTER["ONE_DAY"] = 86400] = "ONE_DAY";
+    EXPIRES_AFTER[EXPIRES_AFTER["ONE_WEEK"] = 604800] = "ONE_WEEK";
+    EXPIRES_AFTER[EXPIRES_AFTER["HALF_MONTH"] = 1296000] = "HALF_MONTH";
+    EXPIRES_AFTER[EXPIRES_AFTER["ONE_MONTH"] = 2592000] = "ONE_MONTH";
+    EXPIRES_AFTER[EXPIRES_AFTER["TWO_MONTHS"] = 5184000] = "TWO_MONTHS";
+    EXPIRES_AFTER[EXPIRES_AFTER["SIX_MONTHS"] = 15768000] = "SIX_MONTHS";
+    EXPIRES_AFTER[EXPIRES_AFTER["ONE_YEAR"] = 31536000] = "ONE_YEAR";
+})(EXPIRES_AFTER || (EXPIRES_AFTER = {}));export{EXPIRES_AFTER,parseCacheKey};//# sourceMappingURL=utils.js.map

package/esm/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sources":["../src/utils.ts"],"sourcesContent":[null],"names":[],"mappings":"2CAEA;;AAEG;AACI,eAAe,aAAa,CACjC,GAA2B,EAC3B,UAAsD,EAAE,EAAA;AAExD,IAAA,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;AAC3B,QAAA,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;AAC3B,KAAA;;IAGD,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;AAE1E,IAAA,MAAM,WAAW,GACf,OAAO,OAAO,CAAC,YAAY,KAAK,UAAU;AACxC,UAAE,MAAM,OAAO,CAAC,YAAY,EAAE;AAC9B,UAAE,OAAO,CAAC,YAAY,CAAC;IAE3B,OAAO,MAAM,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,EAAE,GAAG,CAAC,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,CAAC,CAAC;AACzE,CAAC;IAEW,cAWX;AAXD,CAAA,UAAY,aAAa,EAAA;AACvB,IAAA,aAAA,CAAA,aAAA,CAAA,WAAA,CAAA,GAAA,IAAA,CAAA,GAAA,WAAgB,CAAA;AAChB,IAAA,aAAA,CAAA,aAAA,CAAA,UAAA,CAAA,GAAA,IAAA,CAAA,GAAA,UAAe,CAAA;AACf,IAAA,aAAA,CAAA,aAAA,CAAA,UAAA,CAAA,GAAA,KAAA,CAAA,GAAA,UAAgB,CAAA;AAChB,IAAA,aAAA,CAAA,aAAA,CAAA,SAAA,CAAA,GAAA,KAAA,CAAA,GAAA,SAAe,CAAA;AACf,IAAA,aAAA,CAAA,aAAA,CAAA,UAAA,CAAA,GAAA,MAAA,CAAA,GAAA,UAAiB,CAAA;AACjB,IAAA,aAAA,CAAA,aAAA,CAAA,YAAA,CAAA,GAAA,OAAA,CAAA,GAAA,YAAoB,CAAA;AACpB,IAAA,aAAA,CAAA,aAAA,CAAA,WAAA,CAAA,GAAA,OAAA,CAAA,GAAA,WAAmB,CAAA;AACnB,IAAA,aAAA,CAAA,aAAA,CAAA,YAAA,CAAA,GAAA,OAAA,CAAA,GAAA,YAAoB,CAAA;AACpB,IAAA,aAAA,CAAA,aAAA,CAAA,YAAA,CAAA,GAAA,QAAA,CAAA,GAAA,YAAqB,CAAA;AACrB,IAAA,aAAA,CAAA,aAAA,CAAA,UAAA,CAAA,GAAA,QAAA,CAAA,GAAA,UAAmB,CAAA;AACrB,CAAC,EAXW,aAAa,KAAb,aAAa,GAWxB,EAAA,CAAA,CAAA"}

package/package.json

@@ -0,0 +1,39 @@
+{
+    "name": "@warlock.js/cache",
+    "version": "1.0.0",
+    "description": "A Robust Cache Manager for Nodejs",
+    "main": "./cjs/index.js",
+    "dependencies": {
+        "@mongez/fs": "^3.0.4",
+        "redis": "^4.6.10",
+        "@warlock.js/logger": "^1.0.0",
+        "@mongez/reinforcements": "^2.3.9",
+        "@mongez/supportive-is": "^2.0.3"
+    },
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/warlockjs/cache"
+    },
+    "keywords": [
+        "nodejs",
+        "cache",
+        "redis",
+        "lru",
+        "memory",
+        "caching",
+        "warlockjs",
+        "warlock.js",
+        "cache-manager",
+        "cache-manager-nodejs",
+        "cache-manager-node",
+        "cache-manager-nodejs-redis",
+        "cache-manager-node-redis",
+        "cache-manager-nodejs-memory",
+        "cache-manager-node-memory",
+        "cache-manager-nodejs-memcached"
+    ],
+    "author": "hassanzohdy",
+    "license": "MIT",
+    "module": "./esm/index.js",
+    "typings": "./cjs/index.d.ts"
+}