@ztimson/utils 0.27.4 → 0.27.5

package/dist/cache.d.ts

@@ -9,6 +9,8 @@ export type CacheOptions = {
     } | string;
     /** Keep or delete cached items once expired, defaults to delete */
     expiryPolicy?: 'delete' | 'keep';
+    /** Least Recently Used size limit */
+    sizeLimit?: number;
 };
 export type CachedValue<T> = T & {
     _expired?: boolean;
@@ -19,12 +21,14 @@ export type CachedValue<T> = T & {
 export declare class Cache<K extends string | number | symbol, T> {
     readonly key?: keyof T | undefined;
     readonly options: CacheOptions;
+    private _loading;
     private store;
+    private timers;
+    private lruOrder;
     /** Support index lookups */
     [key: string | number | symbol]: CachedValue<T> | any;
     /** Whether cache is complete */
     complete: boolean;
-    private _loading;
     /** Await initial loading */
     loading: Promise<void>;
     /**
@@ -35,6 +39,8 @@ export declare class Cache<K extends string | number | symbol, T> {
     constructor(key?: keyof T | undefined, options?: CacheOptions);
     private getKey;
     private save;
+    private clearTimer;
+    private touchLRU;
     /**
      * Get all cached items
      * @return {T[]} Array of items
@@ -109,5 +115,5 @@ export declare class Cache<K extends string | number | symbol, T> {
      * Get all cached items
      * @return {T[]} Array of items
      */
-    values: CachedValue<T>[];
+    values: (expired?: boolean) => CachedValue<T>[];
 }

package/dist/index.cjs

@@ -456,17 +456,19 @@ ${opts.message || this.desc}`;
      * @param options
      */
     constructor(key, options = {}) {
-      __publicField(this, "store", {});
+      __publicField(this, "_loading");
+      __publicField(this, "store", /* @__PURE__ */ new Map());
+      __publicField(this, "timers", /* @__PURE__ */ new Map());
+      __publicField(this, "lruOrder", []);
       /** Whether cache is complete */
       __publicField(this, "complete", false);
-      __publicField(this, "_loading");
       /** Await initial loading */
       __publicField(this, "loading", new Promise((r) => this._loading = r));
       /**
        * Get all cached items
        * @return {T[]} Array of items
        */
-      __publicField(this, "values", this.all());
+      __publicField(this, "values", this.all);
       var _a, _b, _c, _d;
       this.key = key;
       this.options = options;
@@ -478,14 +480,18 @@ ${opts.message || this.desc}`;
             const persists = this.options.persistentStorage;
             const table = await persists.storage.createTable({ name: persists.key, key: this.key });
             const rows = await table.getAll();
-            Object.assign(this.store, rows.reduce((acc, row) => ({ ...acc, [this.getKey(row)]: row }), {}));
+            for (const row of rows) this.store.set(this.getKey(row), row);
             this._loading();
           })();
         } else if (((_d = (_c = this.options.persistentStorage) == null ? void 0 : _c.storage) == null ? void 0 : _d.getItem) != void 0) {
-          const stored = this.options.persistentStorage.storage.getItem(this.options.persistentStorage.key);
-          if (stored != null) try {
-            Object.assign(this.store, JSON.parse(stored));
-          } catch {
+          const { storage, key: key2 } = this.options.persistentStorage;
+          const stored = storage.getItem(key2);
+          if (stored != null) {
+            try {
+              const obj = JSON.parse(stored);
+              for (const k of Object.keys(obj)) this.store.set(k, obj[k]);
+            } catch {
+            }
           }
           this._loading();
         }
@@ -515,26 +521,50 @@ ${opts.message || this.desc}`;
       if (!!(persists == null ? void 0 : persists.storage)) {
         if (((_a = persists.storage) == null ? void 0 : _a.database) != void 0) {
           persists.storage.createTable({ name: persists.key, key: this.key }).then((table) => {
-            if (key) {
-              const value = this.get(key);
+            if (key !== void 0) {
+              const value = this.get(key, true);
               if (value != null) table.set(value, key);
               else table.delete(key);
             } else {
               table.clear();
-              this.all().forEach((row) => table.add(row));
+              this.all(true).forEach((row) => table.add(row));
             }
           });
         } else if (((_b = persists.storage) == null ? void 0 : _b.setItem) != void 0) {
-          persists.storage.setItem(persists.storage.key, JSONSanitize(this.all(true)));
+          const obj = {};
+          for (const [k, v] of this.store.entries()) obj[k] = v;
+          persists.storage.setItem(persists.key, JSONSanitize(obj));
         }
       }
     }
+    clearTimer(key) {
+      const t = this.timers.get(key);
+      if (t) {
+        clearTimeout(t);
+        this.timers.delete(key);
+      }
+    }
+    touchLRU(key) {
+      if (!this.options.sizeLimit || this.options.sizeLimit <= 0) return;
+      const idx = this.lruOrder.indexOf(key);
+      if (idx >= 0) this.lruOrder.splice(idx, 1);
+      this.lruOrder.push(key);
+      while (this.lruOrder.length > (this.options.sizeLimit || 0)) {
+        const lru = this.lruOrder.shift();
+        if (lru !== void 0) this.delete(lru);
+      }
+    }
     /**
      * Get all cached items
      * @return {T[]} Array of items
      */
     all(expired) {
-      return deepCopy(Object.values(this.store).filter((v) => expired || !v._expired));
+      const out = [];
+      for (const v of this.store.values()) {
+        const val = v;
+        if (expired || !(val == null ? void 0 : val._expired)) out.push(deepCopy(val));
+      }
+      return out;
     }
     /**
      * Add a new item to the cache. Like set, but finds key automatically
@@ -564,7 +594,10 @@ ${opts.message || this.desc}`;
      */
     clear() {
       this.complete = false;
-      this.store = {};
+      for (const [k, t] of this.timers) clearTimeout(t);
+      this.timers.clear();
+      this.lruOrder = [];
+      this.store.clear();
       this.save();
       return this;
     }
@@ -573,7 +606,10 @@ ${opts.message || this.desc}`;
      * @param {K} key Item's primary key
      */
     delete(key) {
-      delete this.store[key];
+      this.clearTimer(key);
+      const idx = this.lruOrder.indexOf(key);
+      if (idx >= 0) this.lruOrder.splice(idx, 1);
+      this.store.delete(key);
       this.save(key);
       return this;
     }
@@ -582,7 +618,12 @@ ${opts.message || this.desc}`;
      * @return {[K, T][]} Key-value pairs array
      */
     entries(expired) {
-      return deepCopy(Object.entries(this.store).filter((v) => expired || !(v == null ? void 0 : v._expired)));
+      const out = [];
+      for (const [k, v] of this.store.entries()) {
+        const val = v;
+        if (expired || !(val == null ? void 0 : val._expired)) out.push([k, deepCopy(val)]);
+      }
+      return out;
     }
     /**
      * Manually expire a cached item
@@ -591,8 +632,12 @@ ${opts.message || this.desc}`;
     expire(key) {
       this.complete = false;
       if (this.options.expiryPolicy == "keep") {
-        this.store[key]._expired = true;
-        this.save(key);
+        const v = this.store.get(key);
+        if (v) {
+          v._expired = true;
+          this.store.set(key, v);
+          this.save(key);
+        }
       } else this.delete(key);
       return this;
     }
@@ -603,7 +648,11 @@ ${opts.message || this.desc}`;
      * @returns {T | undefined} Cached item or undefined if nothing matched
      */
     find(filter, expired) {
-      return Object.values(this.store).find((row) => (expired || !row._expired) && includes(row, filter));
+      for (const v of this.store.values()) {
+        const row = v;
+        if ((expired || !row._expired) && includes(row, filter)) return deepCopy(row);
+      }
+      return void 0;
     }
     /**
      * Get item from the cache
@@ -612,7 +661,10 @@ ${opts.message || this.desc}`;
      * @return {T} Cached item
      */
     get(key, expired) {
-      const cached = deepCopy(this.store[key] ?? null);
+      const raw = this.store.get(key);
+      if (raw == null) return null;
+      const cached = deepCopy(raw);
+      this.touchLRU(key);
       if (expired || !(cached == null ? void 0 : cached._expired)) return cached;
       return null;
     }
@@ -621,17 +673,23 @@ ${opts.message || this.desc}`;
      * @return {K[]} Array of keys
      */
     keys(expired) {
-      return Object.keys(this.store).filter((k) => expired || !this.store[k]._expired);
+      const out = [];
+      for (const [k, v] of this.store.entries()) {
+        const val = v;
+        if (expired || !(val == null ? void 0 : val._expired)) out.push(k);
+      }
+      return out;
     }
     /**
      * Get map of cached items
      * @return {Record<K, T>}
      */
     map(expired) {
-      const copy = deepCopy(this.store);
-      if (!expired) Object.keys(copy).forEach((k) => {
-        if (copy[k]._expired) delete copy[k];
-      });
+      const copy = {};
+      for (const [k, v] of this.store.entries()) {
+        const val = v;
+        if (expired || !(val == null ? void 0 : val._expired)) copy[k] = deepCopy(val);
+      }
       return copy;
     }
     /**
@@ -643,12 +701,17 @@ ${opts.message || this.desc}`;
      */
     set(key, value, ttl = this.options.ttl) {
       if (this.options.expiryPolicy == "keep") delete value._expired;
-      this.store[key] = value;
+      this.clearTimer(key);
+      this.store.set(key, value);
+      this.touchLRU(key);
       this.save(key);
-      if (ttl) setTimeout(() => {
-        this.expire(key);
-        this.save(key);
-      }, (ttl || 0) * 1e3);
+      if (ttl) {
+        const t = setTimeout(() => {
+          this.expire(key);
+          this.save(key);
+        }, (ttl || 0) * 1e3);
+        this.timers.set(key, t);
+      }
       return this;
     }
   }