@warlock.js/cache 1.0.0

package/esm/drivers/base-cache-driver.d.ts

@@ -0,0 +1,81 @@
+import { GenericObject } from "@mongez/reinforcements";
+import { CacheData, CacheDriver, CacheOperationType } from "../types";
+export declare abstract class BaseCacheDriver<ClientType, Options extends GenericObject> implements CacheDriver<ClientType, Options> {
+    /**
+     * CLient driver
+     */
+    protected clientDriver: ClientType;
+    /**
+     * {@inheritdoc}
+     */
+    get client(): ClientType;
+    /**
+     * Set client driver
+     */
+    set client(client: ClientType);
+    /**
+     * Get the cache driver name
+     */
+    abstract name: string;
+    /**
+     * Options list
+     */
+    options: Options;
+    /**
+     * {@inheritdoc}
+     */
+    parseKey(key: string | GenericObject): Promise<string>;
+    /**
+     * {@inheritdoc}
+     */
+    setOptions(options: Options): this;
+    /**
+     * {@inheritdoc}
+     */
+    abstract removeNamespace(namespace: string): Promise<any>;
+    /**
+     * {@inheritdoc}
+     */
+    abstract set(key: string | GenericObject, value: any): Promise<any>;
+    /**
+     * {@inheritdoc}
+     */
+    abstract get(key: string | GenericObject): Promise<any>;
+    /**
+     * {@inheritdoc}
+     */
+    abstract remove(key: string | GenericObject): Promise<void>;
+    /**
+     * {@inheritdoc}
+     */
+    abstract flush(): Promise<void>;
+    /**
+     * Log the operation
+     */
+    protected log(operation: CacheOperationType, key?: string): any;
+    /**
+     * Get time to live value
+     */
+    get ttl(): any;
+    /**
+     * Get time to live value in milliseconds
+     */
+    getTtl(ttl?: number): number;
+    /**
+     * Prepare data for storage
+     */
+    protected prepareDataForStorage(data: any, ttl?: number): CacheData;
+    /**
+     * Parse fetched data from cache
+     */
+    protected parseCachedData(key: string, data: CacheData): Promise<any>;
+    /**
+     * {@inheritdoc}
+     */
+    connect(): Promise<void>;
+    /**
+     * {@inheritdoc}
+     */
+    disconnect(): Promise<void>;
+}
+//# sourceMappingURL=base-cache-driver.d.ts.map

package/esm/drivers/base-cache-driver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-cache-driver.d.ts","sourceRoot":"","sources":["../../src/drivers/base-cache-driver.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAEvD,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAC;AAuBtE,8BAAsB,eAAe,CAAC,UAAU,EAAE,OAAO,SAAS,aAAa,CAC7E,YAAW,WAAW,CAAC,UAAU,EAAE,OAAO,CAAC;IAE3C;;OAEG;IACH,SAAS,CAAC,YAAY,EAAG,UAAU,CAAC;IAEpC;;OAEG;IACH,IAAW,MAAM,IAOS,UAAU,CALnC;IAED;;OAEG;IACH,IAAW,MAAM,CAAC,MAAM,EAAE,UAAU,EAEnC;IAED;;OAEG;IACH,SAAgB,IAAI,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACI,OAAO,EAAE,OAAO,CAAa;IAEpC;;OAEG;IACU,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa;IAIjD;;OAEG;IACI,UAAU,CAAC,OAAO,EAAE,OAAO;IAKlC;;OAEG;aACa,eAAe,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC;IAEhE;;OAEG;aACa,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,EAAE,KAAK,EAAE,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAE1E;;OAEG;aACa,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC;IAE9D;;OAEG;aACa,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;IAElE;;OAEG;aACa,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAEtC;;OAEG;IACH,SAAS,CAAC,GAAG,CAAC,SAAS,EAAE,kBAAkB,EAAE,GAAG,CAAC,EAAE,MAAM;IA8BzD;;OAEG;IACH,IAAW,GAAG,QAEb;IAED;;OAEG;IACI,MAAM,CAAC,GAAG,GAAE,MAAiB;IAMpC;;OAEG;IACH,SAAS,CAAC,qBAAqB,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,MAAM;IAavD;;OAEG;cACa,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS;IAa5D;;OAEG;IACU,OAAO;IAKpB;;OAEG;IACU,UAAU;CAGxB"}

package/esm/drivers/base-cache-driver.js

@@ -0,0 +1,123 @@
+import {log}from'@warlock.js/logger';import {parseCacheKey}from'../utils.js';const messages = {
+    clearing: "Clearing namespace",
+    cleared: "Namespace cleared",
+    fetching: "Fetching key",
+    fetched: "Key fetched",
+    caching: "Caching key",
+    cached: "Key cached",
+    flushing: "Flushing cache",
+    flushed: "Cache flushed",
+    removing: "Removing key",
+    removed: "Key removed",
+    expired: "Key expired",
+    notFound: "Key not found",
+    connecting: "Connecting to the cache engine.",
+    connected: "Connected to the cache engine.",
+    disconnecting: "Disconnecting from the cache engine.",
+    disconnected: "Disconnected from the cache engine.",
+    error: "Error occurred",
+};
+class BaseCacheDriver {
+    /**
+     * CLient driver
+     */
+    clientDriver;
+    /**
+     * {@inheritdoc}
+     */
+    get client() {
+        return (this.clientDriver || this);
+    }
+    /**
+     * Set client driver
+     */
+    set client(client) {
+        this.clientDriver = client;
+    }
+    /**
+     * Options list
+     */
+    options = {};
+    /**
+     * {@inheritdoc}
+     */
+    async parseKey(key) {
+        return await parseCacheKey(key, this.options);
+    }
+    /**
+     * {@inheritdoc}
+     */
+    setOptions(options) {
+        this.options = options || {};
+        return this;
+    }
+    /**
+     * Log the operation
+     */
+    log(operation, key) {
+        if (key) {
+            // this will be likely used with file cache driver as it will convert the dot to slash
+            // to make it consistent and not to confuse developers we will output the key by making sure it's a dot
+            key = key.replaceAll("/", ".");
+        }
+        if (operation == "notFound" || operation == "expired") {
+            return log.error("cache:" + this.name, operation, (key ? key + " " : "") + messages[operation]);
+        }
+        if (operation.endsWith("ed")) {
+            return log.success("cache:" + this.name, operation, (key ? key + " " : "") + messages[operation]);
+        }
+        log.info("cache:" + this.name, operation, (key ? key + " " : "") + messages[operation]);
+    }
+    /**
+     * Get time to live value
+     */
+    get ttl() {
+        return this.options.ttl !== undefined ? this.options.ttl : Infinity;
+    }
+    /**
+     * Get time to live value in milliseconds
+     */
+    getTtl(ttl = this.ttl) {
+        if (ttl) {
+            return new Date().getTime() + ttl * 1000;
+        }
+    }
+    /**
+     * Prepare data for storage
+     */
+    prepareDataForStorage(data, ttl) {
+        const preparedData = {
+            data,
+        };
+        if (ttl) {
+            preparedData.ttl = ttl;
+            preparedData.expiresAt = this.getTtl(ttl);
+        }
+        return preparedData;
+    }
+    /**
+     * Parse fetched data from cache
+     */
+    async parseCachedData(key, data) {
+        this.log("fetched", key);
+        if (data.expiresAt && data.expiresAt < Date.now()) {
+            console.log("Expired key", key);
+            this.remove(key);
+            return null;
+        }
+        return data.data || null;
+    }
+    /**
+     * {@inheritdoc}
+     */
+    async connect() {
+        this.log("connecting");
+        this.log("connected");
+    }
+    /**
+     * {@inheritdoc}
+     */
+    async disconnect() {
+        this.log("disconnected");
+    }
+}export{BaseCacheDriver};//# sourceMappingURL=base-cache-driver.js.map

package/esm/drivers/base-cache-driver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-cache-driver.js","sources":["../../src/drivers/base-cache-driver.ts"],"sourcesContent":[null],"names":[],"mappings":"6EAKA,MAAM,QAAQ,GAAG;AACf,IAAA,QAAQ,EAAE,oBAAoB;AAC9B,IAAA,OAAO,EAAE,mBAAmB;AAC5B,IAAA,QAAQ,EAAE,cAAc;AACxB,IAAA,OAAO,EAAE,aAAa;AACtB,IAAA,OAAO,EAAE,aAAa;AACtB,IAAA,MAAM,EAAE,YAAY;AACpB,IAAA,QAAQ,EAAE,gBAAgB;AAC1B,IAAA,OAAO,EAAE,eAAe;AACxB,IAAA,QAAQ,EAAE,cAAc;AACxB,IAAA,OAAO,EAAE,aAAa;AACtB,IAAA,OAAO,EAAE,aAAa;AACtB,IAAA,QAAQ,EAAE,eAAe;AACzB,IAAA,UAAU,EAAE,iCAAiC;AAC7C,IAAA,SAAS,EAAE,gCAAgC;AAC3C,IAAA,aAAa,EAAE,sCAAsC;AACrD,IAAA,YAAY,EAAE,qCAAqC;AACnD,IAAA,KAAK,EAAE,gBAAgB;CACxB,CAAC;MAEoB,eAAe,CAAA;AAGnC;;AAEG;AACO,IAAA,YAAY,CAAc;AAEpC;;AAEG;AACH,IAAA,IAAW,MAAM,GAAA;AACf,QAAA,QAAQ,IAAI,CAAC,YAAY,IAAI,IAAI,EAA2B;KAC7D;AAED;;AAEG;IACH,IAAW,MAAM,CAAC,MAAkB,EAAA;AAClC,QAAA,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC;KAC5B;AAOD;;AAEG;IACI,OAAO,GAAY,EAAS,CAAC;AAEpC;;AAEG;IACI,MAAM,QAAQ,CAAC,GAA2B,EAAA;QAC/C,OAAO,MAAM,aAAa,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;KAC/C;AAED;;AAEG;AACI,IAAA,UAAU,CAAC,OAAgB,EAAA;AAChC,QAAA,IAAI,CAAC,OAAO,GAAG,OAAO,IAAI,EAAE,CAAC;AAC7B,QAAA,OAAO,IAAI,CAAC;KACb;AA2BD;;AAEG;IACO,GAAG,CAAC,SAA6B,EAAE,GAAY,EAAA;AACvD,QAAA,IAAI,GAAG,EAAE;;;YAGP,GAAG,GAAG,GAAG,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;AAChC,SAAA;AAED,QAAA,IAAI,SAAS,IAAI,UAAU,IAAI,SAAS,IAAI,SAAS,EAAE;AACrD,YAAA,OAAO,GAAG,CAAC,KAAK,CACd,QAAQ,GAAG,IAAI,CAAC,IAAI,EACpB,SAAS,EACT,CAAC,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,EAAE,IAAI,QAAQ,CAAC,SAAS,CAAC,CAC7C,CAAC;AACH,SAAA;AAED,QAAA,IAAI,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;AAC5B,YAAA,OAAO,GAAG,CAAC,OAAO,CAChB,QAAQ,GAAG,IAAI,CAAC,IAAI,EACpB,SAAS,EACT,CAAC,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,EAAE,IAAI,QAAQ,CAAC,SAAS,CAAC,CAC7C,CAAC;AACH,SAAA;AAED,QAAA,GAAG,CAAC,IAAI,CACN,QAAQ,GAAG,IAAI,CAAC,IAAI,EACpB,SAAS,EACT,CAAC,GAAG,GAAG,GAAG,GAAG,GAAG,GAAG,EAAE,IAAI,QAAQ,CAAC,SAAS,CAAC,CAC7C,CAAC;KACH;AAED;;AAEG;AACH,IAAA,IAAW,GAAG,GAAA;AACZ,QAAA,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,KAAK,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,GAAG,QAAQ,CAAC;KACrE;AAED;;AAEG;AACI,IAAA,MAAM,CAAC,GAAA,GAAc,IAAI,CAAC,GAAG,EAAA;AAClC,QAAA,IAAI,GAAG,EAAE;YACP,OAAO,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,GAAG,GAAG,GAAG,IAAI,CAAC;AAC1C,SAAA;KACF;AAED;;AAEG;IACO,qBAAqB,CAAC,IAAS,EAAE,GAAY,EAAA;AACrD,QAAA,MAAM,YAAY,GAAc;YAC9B,IAAI;SACL,CAAC;AAEF,QAAA,IAAI,GAAG,EAAE;AACP,YAAA,YAAY,CAAC,GAAG,GAAG,GAAG,CAAC;YACvB,YAAY,CAAC,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;AAC3C,SAAA;AAED,QAAA,OAAO,YAAY,CAAC;KACrB;AAED;;AAEG;AACO,IAAA,MAAM,eAAe,CAAC,GAAW,EAAE,IAAe,EAAA;AAC1D,QAAA,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;AAEzB,QAAA,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,EAAE;AACjD,YAAA,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC;AAEhC,YAAA,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;AACjB,YAAA,OAAO,IAAI,CAAC;AACb,SAAA;AAED,QAAA,OAAO,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC;KAC1B;AAED;;AAEG;AACI,IAAA,MAAM,OAAO,GAAA;AAClB,QAAA,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;AACvB,QAAA,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;KACvB;AAED;;AAEG;AACI,IAAA,MAAM,UAAU,GAAA;AACrB,QAAA,IAAI,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;KAC1B;AACF"}

package/esm/drivers/file-cache-driver.d.ts

@@ -0,0 +1,42 @@
+import { GenericObject } from "@mongez/reinforcements";
+import { CacheDriver, FileCacheOptions } from "../types";
+import { BaseCacheDriver } from "./base-cache-driver";
+export declare class FileCacheDriver extends BaseCacheDriver<FileCacheDriver, FileCacheOptions> implements CacheDriver<FileCacheDriver, FileCacheOptions> {
+    /**
+     * {@inheritdoc}
+     */
+    name: string;
+    /**
+     * Get the cache directory
+     */
+    get directory(): string;
+    /**
+     * Get file name
+     */
+    get fileName(): string;
+    /**
+     * {@inheritdoc}
+     */
+    removeNamespace(namespace: string): Promise<this>;
+    /**
+     * {@inheritdoc}
+     */
+    set(key: string | GenericObject, value: any, ttl?: number): Promise<this>;
+    /**
+     * {@inheritdoc}
+     */
+    get(key: string | GenericObject): Promise<any>;
+    /**
+     * {@inheritdoc}
+     */
+    remove(key: string | GenericObject): Promise<void>;
+    /**
+     * {@inheritdoc}
+     */
+    flush(): Promise<void>;
+    /**
+     * {@inheritdoc}
+     */
+    connect(): Promise<void>;
+}
+//# sourceMappingURL=file-cache-driver.d.ts.map

package/esm/drivers/file-cache-driver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-cache-driver.d.ts","sourceRoot":"","sources":["../../src/drivers/file-cache-driver.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAEvD,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AACzD,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAEtD,qBAAa,eACX,SAAQ,eAAe,CAAC,eAAe,EAAE,gBAAgB,CACzD,YAAW,WAAW,CAAC,eAAe,EAAE,gBAAgB,CAAC;IAEzD;;OAEG;IACI,IAAI,SAAU;IAErB;;OAEG;IACH,IAAW,SAAS,WAUnB;IAED;;OAEG;IACH,IAAW,QAAQ,WAQlB;IAED;;OAEG;IACU,eAAe,CAAC,SAAS,EAAE,MAAM;IAc9C;;OAEG;IACU,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,MAAM;IAkBtE;;OAEG;IACU,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa;IAoB5C;;OAEG;IACU,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa;IAe/C;;OAEG;IACU,KAAK;IAYlB;;OAEG;IACU,OAAO;CAKrB"}

package/esm/drivers/file-cache-driver.js

@@ -0,0 +1,106 @@
+import {removeDirectoryAsync,ensureDirectoryAsync,putJsonFileAsync,getJsonFileAsync}from'@mongez/fs';import path from'path';import {BaseCacheDriver}from'./base-cache-driver.js';class FileCacheDriver extends BaseCacheDriver {
+    /**
+     * {@inheritdoc}
+     */
+    name = "file";
+    /**
+     * Get the cache directory
+     */
+    get directory() {
+        const directory = this.options.directory;
+        if (typeof directory === "function") {
+            return directory();
+        }
+        throw new Error("Cache directory is not defined, please define it in the file driver options");
+    }
+    /**
+     * Get file name
+     */
+    get fileName() {
+        const fileName = this.options.fileName;
+        if (typeof fileName === "function") {
+            return fileName();
+        }
+        return "cache.json";
+    }
+    /**
+     * {@inheritdoc}
+     */
+    async removeNamespace(namespace) {
+        this.log("cleared", namespace);
+        try {
+            await removeDirectoryAsync(path.resolve(this.directory, namespace));
+            this.log("cleared", namespace);
+        }
+        catch (error) {
+            //
+        }
+        return this;
+    }
+    /**
+     * {@inheritdoc}
+     */
+    async set(key, value, ttl) {
+        key = await this.parseKey(key);
+        this.log("caching", key);
+        const data = this.prepareDataForStorage(value, ttl);
+        const fileDirectory = path.resolve(this.directory, key);
+        await ensureDirectoryAsync(fileDirectory);
+        await putJsonFileAsync(path.resolve(fileDirectory, this.fileName), data);
+        this.log("cached", key);
+        return this;
+    }
+    /**
+     * {@inheritdoc}
+     */
+    async get(key) {
+        const parsedKey = await this.parseKey(key);
+        this.log("fetching", parsedKey);
+        const fileDirectory = path.resolve(this.directory, parsedKey);
+        try {
+            const value = await getJsonFileAsync(path.resolve(fileDirectory, this.fileName));
+            return this.parseCachedData(parsedKey, value);
+        }
+        catch (error) {
+            this.log("notFound", parsedKey);
+            this.remove(key);
+            return null;
+        }
+    }
+    /**
+     * {@inheritdoc}
+     */
+    async remove(key) {
+        const parsedKey = await this.parseKey(key);
+        this.log("removing", parsedKey);
+        const fileDirectory = path.resolve(this.directory, parsedKey);
+        try {
+            await removeDirectoryAsync(fileDirectory);
+            this.log("removed", parsedKey);
+        }
+        catch (error) {
+            //
+        }
+    }
+    /**
+     * {@inheritdoc}
+     */
+    async flush() {
+        this.log("flushing");
+        if (this.options.globalPrefix) {
+            await this.removeNamespace("");
+        }
+        else {
+            await removeDirectoryAsync(this.directory);
+        }
+        this.log("flushed");
+    }
+    /**
+     * {@inheritdoc}
+     */
+    async connect() {
+        this.log("connecting");
+        await ensureDirectoryAsync(this.directory);
+        this.log("connected");
+    }
+}export{FileCacheDriver};//# sourceMappingURL=file-cache-driver.js.map

package/esm/drivers/file-cache-driver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"file-cache-driver.js","sources":["../../src/drivers/file-cache-driver.ts"],"sourcesContent":[null],"names":[],"mappings":"iLAWM,MAAO,eACX,SAAQ,eAAkD,CAAA;AAG1D;;AAEG;IACI,IAAI,GAAG,MAAM,CAAC;AAErB;;AAEG;AACH,IAAA,IAAW,SAAS,GAAA;AAClB,QAAA,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC;AAEzC,QAAA,IAAI,OAAO,SAAS,KAAK,UAAU,EAAE;YACnC,OAAO,SAAS,EAAE,CAAC;AACpB,SAAA;AAED,QAAA,MAAM,IAAI,KAAK,CACb,6EAA6E,CAC9E,CAAC;KACH;AAED;;AAEG;AACH,IAAA,IAAW,QAAQ,GAAA;AACjB,QAAA,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC;AAEvC,QAAA,IAAI,OAAO,QAAQ,KAAK,UAAU,EAAE;YAClC,OAAO,QAAQ,EAAE,CAAC;AACnB,SAAA;AAED,QAAA,OAAO,YAAY,CAAC;KACrB;AAED;;AAEG;IACI,MAAM,eAAe,CAAC,SAAiB,EAAA;AAC5C,QAAA,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QAE/B,IAAI;AACF,YAAA,MAAM,oBAAoB,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC,CAAC;AAEpE,YAAA,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;AAChC,SAAA;AAAC,QAAA,OAAO,KAAK,EAAE;;AAEf,SAAA;AAED,QAAA,OAAO,IAAI,CAAC;KACb;AAED;;AAEG;AACI,IAAA,MAAM,GAAG,CAAC,GAA2B,EAAE,KAAU,EAAE,GAAY,EAAA;QACpE,GAAG,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;AAE/B,QAAA,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;QAEzB,MAAM,IAAI,GAAG,IAAI,CAAC,qBAAqB,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;AAEpD,QAAA,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;AAExD,QAAA,MAAM,oBAAoB,CAAC,aAAa,CAAC,CAAC;AAE1C,QAAA,MAAM,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,IAAI,CAAC,QAAQ,CAAC,EAAE,IAAI,CAAC,CAAC;AAEzE,QAAA,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;AAExB,QAAA,OAAO,IAAI,CAAC;KACb;AAED;;AAEG;IACI,MAAM,GAAG,CAAC,GAA2B,EAAA;QAC1C,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;AAE3C,QAAA,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;AAEhC,QAAA,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QAE9D,IAAI;AACF,YAAA,MAAM,KAAK,GAAG,MAAM,gBAAgB,CAClC,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,IAAI,CAAC,QAAQ,CAAC,CAC3C,CAAC;YAEF,OAAO,IAAI,CAAC,eAAe,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;AAC/C,SAAA;AAAC,QAAA,OAAO,KAAK,EAAE;AACd,YAAA,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;AAChC,YAAA,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;AACjB,YAAA,OAAO,IAAI,CAAC;AACb,SAAA;KACF;AAED;;AAEG;IACI,MAAM,MAAM,CAAC,GAA2B,EAAA;QAC7C,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;AAC3C,QAAA,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;AAEhC,QAAA,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QAE9D,IAAI;AACF,YAAA,MAAM,oBAAoB,CAAC,aAAa,CAAC,CAAC;AAE1C,YAAA,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;AAChC,SAAA;AAAC,QAAA,OAAO,KAAK,EAAE;;AAEf,SAAA;KACF;AAED;;AAEG;AACI,IAAA,MAAM,KAAK,GAAA;AAChB,QAAA,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;AAErB,QAAA,IAAI,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE;AAC7B,YAAA,MAAM,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC,CAAC;AAChC,SAAA;AAAM,aAAA;AACL,YAAA,MAAM,oBAAoB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;AAC5C,SAAA;AAED,QAAA,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;KACrB;AAED;;AAEG;AACI,IAAA,MAAM,OAAO,GAAA;AAClB,QAAA,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;AACvB,QAAA,MAAM,oBAAoB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;AAC3C,QAAA,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;KACvB;AACF"}

package/esm/drivers/index.d.ts

@@ -0,0 +1,8 @@
+export * from "./base-cache-driver";
+export * from "./file-cache-driver";
+export * from "./lru-memory-cache-driver";
+export * from "./memory-cache-driver";
+export * from "./memory-extended-cache-driver";
+export * from "./null-cache-driver";
+export * from "./redis-cache-driver";
+//# sourceMappingURL=index.d.ts.map

package/esm/drivers/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/drivers/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,qBAAqB,CAAC;AACpC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,uBAAuB,CAAC;AACtC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC"}

package/esm/drivers/lru-memory-cache-driver.d.ts

@@ -0,0 +1,84 @@
+import { GenericObject } from "@mongez/reinforcements";
+import { CacheDriver, LRUMemoryCacheOptions } from "../types";
+import { BaseCacheDriver } from "./base-cache-driver";
+declare class CacheNode {
+    key: string;
+    value: any;
+    next: CacheNode | null;
+    prev: CacheNode | null;
+    constructor(key: string, value: any);
+}
+/**
+ * LRU Memory Cache Driver
+ * The concept of LRU is to remove the least recently used data
+ * whenever the cache is full
+ * The question that resides here is how to tell the cache is full?
+ */
+export declare class LRUMemoryCacheDriver extends BaseCacheDriver<LRUMemoryCacheDriver, LRUMemoryCacheOptions> implements CacheDriver<LRUMemoryCacheDriver, LRUMemoryCacheOptions> {
+    /**
+     * {@inheritdoc}
+     */
+    name: string;
+    /**
+     * Cache map
+     */
+    protected cache: Map<string, CacheNode>;
+    /**
+     * Head of the cache
+     */
+    protected head: CacheNode;
+    /**
+     * Tail of the cache
+     */
+    protected tail: CacheNode;
+    /**
+     * {@inheritdoc}
+     */
+    constructor();
+    /**
+     * Initialize the cache
+     */
+    init(): void;
+    /**
+     * {@inheritdoc}
+     */
+    removeNamespace(_namespace: string): Promise<void>;
+    /**
+     * {@inheritdoc}
+     */
+    set(key: string | GenericObject, value: any, _ttl?: number): Promise<this>;
+    /**
+     * Move the node to the head
+     */
+    protected moveHead(node: CacheNode): void;
+    /**
+     * Remove the node from the cache
+     */
+    protected removeNode(node: CacheNode): void;
+    /**
+     * Add the node to the head
+     */
+    protected addNode(node: CacheNode): void;
+    /**
+     * Remove the tail node
+     */
+    protected removeTail(): void;
+    /**
+     * {@inheritdoc}
+     */
+    get(key: string | GenericObject): Promise<any>;
+    /**
+     * {@inheritdoc}
+     */
+    remove(key: string | GenericObject): Promise<void>;
+    /**
+     * {@inheritdoc}
+     */
+    flush(): Promise<void>;
+    /**
+     * Get lru capacity
+     */
+    get capacity(): number;
+}
+export {};
+//# sourceMappingURL=lru-memory-cache-driver.d.ts.map

package/esm/drivers/lru-memory-cache-driver.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"lru-memory-cache-driver.d.ts","sourceRoot":"","sources":["../../src/drivers/lru-memory-cache-driver.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAC;AAC9D,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAEtD,cAAM,SAAS;IAIJ,GAAG,EAAE,MAAM;IACX,KAAK,EAAE,GAAG;IAJZ,IAAI,EAAE,SAAS,GAAG,IAAI,CAAQ;IAC9B,IAAI,EAAE,SAAS,GAAG,IAAI,CAAQ;gBAE5B,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,GAAG;CAIpB;AAED;;;;;GAKG;AACH,qBAAa,oBACX,SAAQ,eAAe,CAAC,oBAAoB,EAAE,qBAAqB,CACnE,YAAW,WAAW,CAAC,oBAAoB,EAAE,qBAAqB,CAAC;IAEnE;;OAEG;IACI,IAAI,SAAS;IAEpB;;OAEG;IACH,SAAS,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,EAAE,SAAS,CAAC,CAAa;IAEpD;;OAEG;IACH,SAAS,CAAC,IAAI,EAAE,SAAS,CAA2B;IAEpD;;OAEG;IACH,SAAS,CAAC,IAAI,EAAE,SAAS,CAA2B;IAEpD;;OAEG;;IAOH;;OAEG;IACI,IAAI;IAKX;;OAEG;IACU,eAAe,CAAC,UAAU,EAAE,MAAM;IAI/C;;OAEG;IACU,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,EAAE,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,MAAM;IA2BvE;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,SAAS;IAKlC;;OAEG;IACH,SAAS,CAAC,UAAU,CAAC,IAAI,EAAE,SAAS;IAKpC;;OAEG;IACH,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,SAAS;IAOjC;;OAEG;IACH,SAAS,CAAC,UAAU;IAQpB;;OAEG;IACU,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa;IAmB5C;;OAEG;IACU,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa;IAe/C;;OAEG;IACU,KAAK;IAUlB;;OAEG;IACH,IAAW,QAAQ,WAElB;CACF"}

package/esm/drivers/lru-memory-cache-driver.js

@@ -0,0 +1,151 @@
+import {BaseCacheDriver}from'./base-cache-driver.js';class CacheNode {
+    key;
+    value;
+    next = null;
+    prev = null;
+    constructor(key, value) {
+        this.key = key;
+        this.value = value;
+        //
+    }
+}
+/**
+ * LRU Memory Cache Driver
+ * The concept of LRU is to remove the least recently used data
+ * whenever the cache is full
+ * The question that resides here is how to tell the cache is full?
+ */
+class LRUMemoryCacheDriver extends BaseCacheDriver {
+    /**
+     * {@inheritdoc}
+     */
+    name = "lru";
+    /**
+     * Cache map
+     */
+    cache = new Map();
+    /**
+     * Head of the cache
+     */
+    head = new CacheNode("", null);
+    /**
+     * Tail of the cache
+     */
+    tail = new CacheNode("", null);
+    /**
+     * {@inheritdoc}
+     */
+    constructor() {
+        super();
+        this.init();
+    }
+    /**
+     * Initialize the cache
+     */
+    init() {
+        this.head.next = this.tail;
+        this.tail.prev = this.head;
+    }
+    /**
+     * {@inheritdoc}
+     */
+    async removeNamespace(_namespace) {
+        throw new Error("Namespace is not supported in LRU cache driver.");
+    }
+    /**
+     * {@inheritdoc}
+     */
+    async set(key, value, _ttl) {
+        key = await this.parseKey(key);
+        this.log("caching", key);
+        const node = this.cache.get(key);
+        if (node) {
+            node.value = value;
+            this.moveHead(node);
+        }
+        else {
+            const node = new CacheNode(key, value);
+            this.cache.set(key, node);
+            this.addNode(node);
+            if (this.cache.size > this.capacity) {
+                this.removeTail();
+            }
+        }
+        this.log("cached", key);
+        return this;
+    }
+    /**
+     * Move the node to the head
+     */
+    moveHead(node) {
+        this.removeNode(node);
+        this.addNode(node);
+    }
+    /**
+     * Remove the node from the cache
+     */
+    removeNode(node) {
+        node.prev.next = node.next;
+        node.next.prev = node.prev;
+    }
+    /**
+     * Add the node to the head
+     */
+    addNode(node) {
+        node.next = this.head.next;
+        node.prev = this.head;
+        this.head.next.prev = node;
+        this.head.next = node;
+    }
+    /**
+     * Remove the tail node
+     */
+    removeTail() {
+        const node = this.tail.prev;
+        this.removeNode(node);
+        this.cache.delete(node.key);
+    }
+    /**
+     * {@inheritdoc}
+     */
+    async get(key) {
+        const parsedKey = await this.parseKey(key);
+        this.log("fetching", parsedKey);
+        const node = this.cache.get(parsedKey);
+        if (!node) {
+            this.log("notFound", parsedKey);
+            return null;
+        }
+        this.moveHead(node);
+        this.log("fetched", parsedKey);
+        return node.value;
+    }
+    /**
+     * {@inheritdoc}
+     */
+    async remove(key) {
+        const parsedKey = await this.parseKey(key);
+        this.log("removing", parsedKey);
+        const node = this.cache.get(parsedKey);
+        if (node) {
+            this.removeNode(node);
+            this.cache.delete(parsedKey);
+        }
+        this.log("removed", parsedKey);
+    }
+    /**
+     * {@inheritdoc}
+     */
+    async flush() {
+        this.log("flushing");
+        this.cache.clear();
+        this.init();
+        this.log("flushed");
+    }
+    /**
+     * Get lru capacity
+     */
+    get capacity() {
+        return this.options.capacity || 1000;
+    }
+}export{LRUMemoryCacheDriver};//# sourceMappingURL=lru-memory-cache-driver.js.map

package/esm/drivers/lru-memory-cache-driver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lru-memory-cache-driver.js","sources":["../../src/drivers/lru-memory-cache-driver.ts"],"sourcesContent":[null],"names":[],"mappings":"qDAIA,MAAM,SAAS,CAAA;AAIJ,IAAA,GAAA,CAAA;AACA,IAAA,KAAA,CAAA;IAJF,IAAI,GAAqB,IAAI,CAAC;IAC9B,IAAI,GAAqB,IAAI,CAAC;IACrC,WACS,CAAA,GAAW,EACX,KAAU,EAAA;QADV,IAAG,CAAA,GAAA,GAAH,GAAG,CAAQ;QACX,IAAK,CAAA,KAAA,GAAL,KAAK,CAAK;;KAGlB;AACF,CAAA;AAED;;;;;AAKG;AACG,MAAO,oBACX,SAAQ,eAA4D,CAAA;AAGpE;;AAEG;IACI,IAAI,GAAG,KAAK,CAAC;AAEpB;;AAEG;AACO,IAAA,KAAK,GAA2B,IAAI,GAAG,EAAE,CAAC;AAEpD;;AAEG;IACO,IAAI,GAAc,IAAI,SAAS,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;AAEpD;;AAEG;IACO,IAAI,GAAc,IAAI,SAAS,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;AAEpD;;AAEG;AACH,IAAA,WAAA,GAAA;AACE,QAAA,KAAK,EAAE,CAAC;QAER,IAAI,CAAC,IAAI,EAAE,CAAC;KACb;AAED;;AAEG;IACI,IAAI,GAAA;QACT,IAAI,CAAC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QAC3B,IAAI,CAAC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;KAC5B;AAED;;AAEG;IACI,MAAM,eAAe,CAAC,UAAkB,EAAA;AAC7C,QAAA,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;KACpE;AAED;;AAEG;AACI,IAAA,MAAM,GAAG,CAAC,GAA2B,EAAE,KAAU,EAAE,IAAa,EAAA;QACrE,GAAG,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;AAE/B,QAAA,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;QAEzB,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAE,CAAC;AAClC,QAAA,IAAI,IAAI,EAAE;AACR,YAAA,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;AAEnB,YAAA,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AACrB,SAAA;AAAM,aAAA;YACL,MAAM,IAAI,GAAG,IAAI,SAAS,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YAEvC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;AAE1B,YAAA,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAEnB,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,GAAG,IAAI,CAAC,QAAQ,EAAE;gBACnC,IAAI,CAAC,UAAU,EAAE,CAAC;AACnB,aAAA;AACF,SAAA;AAED,QAAA,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;AAExB,QAAA,OAAO,IAAI,CAAC;KACb;AAED;;AAEG;AACO,IAAA,QAAQ,CAAC,IAAe,EAAA;AAChC,QAAA,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;AACtB,QAAA,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;KACpB;AAED;;AAEG;AACO,IAAA,UAAU,CAAC,IAAe,EAAA;QAClC,IAAI,CAAC,IAAK,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QAC5B,IAAI,CAAC,IAAK,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;KAC7B;AAED;;AAEG;AACO,IAAA,OAAO,CAAC,IAAe,EAAA;QAC/B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;AAC3B,QAAA,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACtB,IAAI,CAAC,IAAI,CAAC,IAAK,CAAC,IAAI,GAAG,IAAI,CAAC;AAC5B,QAAA,IAAI,CAAC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;KACvB;AAED;;AAEG;IACO,UAAU,GAAA;AAClB,QAAA,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,IAAK,CAAC;AAE7B,QAAA,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QAEtB,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;KAC7B;AAED;;AAEG;IACI,MAAM,GAAG,CAAC,GAA2B,EAAA;QAC1C,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;AAE3C,QAAA,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;QAEhC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAEvC,IAAI,CAAC,IAAI,EAAE;AACT,YAAA,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;AAChC,YAAA,OAAO,IAAI,CAAC;AACb,SAAA;AAED,QAAA,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AAEpB,QAAA,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QAE/B,OAAO,IAAI,CAAC,KAAK,CAAC;KACnB;AAED;;AAEG;IACI,MAAM,MAAM,CAAC,GAA2B,EAAA;QAC7C,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;AAE3C,QAAA,IAAI,CAAC,GAAG,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;QAEhC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;AAEvC,QAAA,IAAI,IAAI,EAAE;AACR,YAAA,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;AACtB,YAAA,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;AAC9B,SAAA;AAED,QAAA,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;KAChC;AAED;;AAEG;AACI,IAAA,MAAM,KAAK,GAAA;AAChB,QAAA,IAAI,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;AAErB,QAAA,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;QAEnB,IAAI,CAAC,IAAI,EAAE,CAAC;AAEZ,QAAA,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;KACrB;AAED;;AAEG;AACH,IAAA,IAAW,QAAQ,GAAA;AACjB,QAAA,OAAO,IAAI,CAAC,OAAO,CAAC,QAAQ,IAAI,IAAI,CAAC;KACtC;AACF"}