limited-cache 2.0.0 → 2.1.1

package/dist/core/lowLevelFunctions.js

@@ -0,0 +1,240 @@
+import { objectAssign, objectCreate, dateNow, hasOwnProperty } from './builtIns.js';
+import { CURRENT_META_VERSION, MAXIMUM_CACHE_TIME, defaultOptions } from './defaultOptions.js';
+/* Initialization and options */
+const positiveNumberOrZero = (value) => Math.max(value, 0) || 0;
+const normalizeOptions = (cacheMetaOptions) => {
+    objectAssign(cacheMetaOptions, {
+        maxCacheSize: positiveNumberOrZero(cacheMetaOptions.maxCacheSize),
+        maxCacheTime: positiveNumberOrZero(cacheMetaOptions.maxCacheTime),
+        opLimit: positiveNumberOrZero(cacheMetaOptions.opLimit),
+    });
+    if (process.env.NODE_ENV !== 'production') {
+        cacheMetaOptions.warnIfItemPurgedBeforeTime = positiveNumberOrZero(cacheMetaOptions.warnIfItemPurgedBeforeTime);
+    }
+    return cacheMetaOptions;
+};
+const isCacheMeta = (cacheMeta) => {
+    return !!cacheMeta && !!cacheMeta.limitedCacheMetaVersion;
+};
+const upgradeCacheMeta = (cacheMeta) => {
+    if (!isCacheMeta(cacheMeta)) {
+        throw new Error('Limited-cache metadata is missing: please check your usage');
+    }
+    if (cacheMeta.limitedCacheMetaVersion !== CURRENT_META_VERSION) {
+        // Version is out of date! (Today the only prior version is 1)
+        // Version 1: Cache meta cannot be migrated because timestamps and keys are incompatible
+        console.warn('Limited-cache metadata is from an incompatible version (1). It must be reset.');
+        cacheMeta.limitedCacheMetaVersion = CURRENT_META_VERSION;
+        lowLevelReset(cacheMeta);
+    }
+};
+const lowLevelSetOptions = (cacheMeta, options) => {
+    upgradeCacheMeta(cacheMeta);
+    return normalizeOptions(objectAssign(cacheMeta.options, options));
+};
+const lowLevelInit = (optionsOrCacheMeta) => {
+    if (isCacheMeta(optionsOrCacheMeta)) {
+        const existingCacheMeta = optionsOrCacheMeta;
+        upgradeCacheMeta(existingCacheMeta);
+        return existingCacheMeta;
+    }
+    // Else: it's options
+    const fullOptions = normalizeOptions({ ...defaultOptions, ...optionsOrCacheMeta });
+    // The cacheMeta is created once, and persists per instance
+    const newCacheMeta = lowLevelReset({
+        limitedCacheMetaVersion: CURRENT_META_VERSION,
+        options: fullOptions,
+    });
+    return newCacheMeta;
+};
+/* Internal cache manipulation */
+const _getExpireTime = (cacheMeta, cacheKey) => {
+    const { options: { maxCacheTime }, keyInfo: { [cacheKey]: keyInfo }, } = cacheMeta;
+    if (!keyInfo) {
+        // A missing record is always treated as expired
+        return 0;
+    }
+    // If we have an exact expireTime then honor it. Otherwise it'll depend on the current maxCacheTime.
+    const [setTime, expireTime] = keyInfo;
+    return expireTime || setTime + (maxCacheTime || MAXIMUM_CACHE_TIME);
+};
+const _cacheKeyHasExpired = (cacheMeta, cacheKey, now) => {
+    return _getExpireTime(cacheMeta, cacheKey) < now;
+};
+const lowLevelDoMaintenance = (cacheMeta) => {
+    upgradeCacheMeta(cacheMeta);
+    const { cache, keyList, keyInfo } = cacheMeta;
+    const now = dateNow();
+    // Rebuild cache from keyList only, checking timestamps to auto-remove expired
+    const [newCache, newKeyList, newKeyInfo] = keyList.reduce((acc, cacheKey) => {
+        const [accCache, accKeyList, accKeyInfo] = acc;
+        if (!_cacheKeyHasExpired(cacheMeta, cacheKey, now)) {
+            accCache[cacheKey] = cache[cacheKey];
+            accKeyList.push(cacheKey);
+            accKeyInfo[cacheKey] = keyInfo[cacheKey];
+        }
+        return acc;
+    }, [
+        {},
+        [],
+        objectCreate(null),
+    ]);
+    return objectAssign(cacheMeta, {
+        cache: newCache,
+        keyList: newKeyList,
+        keyInfo: newKeyInfo,
+        opsLeft: cacheMeta.options.opLimit,
+    });
+};
+const _removeFromIndex = (cacheMeta, startIndex, now) => {
+    const { cache, keyList, keyInfo } = cacheMeta;
+    // Always remove the item requested, and also remove any neighbors who have expired
+    let nextIndex = startIndex;
+    let nextCacheKey = keyList[startIndex];
+    const keyListLength = keyList.length;
+    do {
+        // Remove the 'next' item
+        cache[nextCacheKey] = keyInfo[nextCacheKey] = undefined;
+        // Now advance and decide whether to keep going
+        nextIndex++;
+        nextCacheKey = keyList[nextIndex];
+    } while (nextIndex < keyListLength && _cacheKeyHasExpired(cacheMeta, nextCacheKey, now));
+    // Remove the index for everything from the startIndex until we stopped
+    keyList.splice(startIndex, nextIndex - startIndex);
+};
+const _removeItemsToMakeRoom = (cacheMeta, now) => {
+    const { options: { scanLimit, warnIfItemPurgedBeforeTime }, cache, keyList, keyInfo, } = cacheMeta;
+    // These track the soonest-to-expire thing we've found. It may not actually be "oldest".
+    // By default we'll remove the item at the head of the queue, unless we find something better.
+    let oldestItemIndex = 0;
+    let oldestExpireTime = _getExpireTime(cacheMeta, keyList[0]);
+    if (oldestExpireTime > now) {
+        // The head of the list hasn't yet expired: scan for a better candidate to remove
+        let indexToCheck = 0;
+        const maxIndexToCheck = Math.min(keyList.length, scanLimit);
+        while (indexToCheck < maxIndexToCheck) {
+            const cacheKeyForIndex = keyList[indexToCheck];
+            const expireTimeForIndex = _getExpireTime(cacheMeta, cacheKeyForIndex);
+            // We only consider it if it's eligible for expiration: otherwise it can't be a better option
+            // than the default head-of-queue
+            if (expireTimeForIndex < now) {
+                // We found an expired item! This wins automatically
+                oldestItemIndex = indexToCheck;
+                oldestExpireTime = 0;
+                break;
+            }
+            if (expireTimeForIndex < oldestExpireTime) {
+                // We have a new leader
+                oldestItemIndex = indexToCheck;
+                oldestExpireTime = expireTimeForIndex;
+            }
+            indexToCheck += 1;
+        }
+    }
+    // Warn if the 'oldest' item is more recent than we'd like: this means it cycled into and out of
+    // cache too quickly for the cache to be useful.
+    if (process.env.NODE_ENV !== 'production' &&
+        warnIfItemPurgedBeforeTime &&
+        oldestExpireTime > now) {
+        const oldestItemKey = keyList[oldestItemIndex];
+        const [oldestItemSetTime, oldestItemExpireTime] = keyInfo[oldestItemKey];
+        if (now - oldestItemSetTime < warnIfItemPurgedBeforeTime) {
+            console.warn('Purged an item from cache while it was still fresh: you may want to increase maxCacheSize', {
+                currentTime: now,
+                key: oldestItemKey,
+                item: cache[oldestItemKey],
+                setTime: oldestItemSetTime,
+                expireTime: oldestItemExpireTime,
+                timeInCache: now - oldestItemSetTime,
+            });
+        }
+    }
+    // Remove the oldest item we found, plus any expired neighbors
+    _removeFromIndex(cacheMeta, oldestItemIndex, now);
+};
+/* Accessors */
+const lowLevelHas = (cacheMeta, cacheKey) => {
+    upgradeCacheMeta(cacheMeta);
+    const { cache } = cacheMeta;
+    if (hasOwnProperty.call(cache, cacheKey) && cache[cacheKey] !== undefined) {
+        if (!_cacheKeyHasExpired(cacheMeta, cacheKey, dateNow())) {
+            return true;
+        }
+        // If it's expired, clear the value so that we can short-circuit future lookups
+        cache[cacheKey] = undefined;
+    }
+    return false;
+};
+const lowLevelGetOne = (cacheMeta, cacheKey) => {
+    upgradeCacheMeta(cacheMeta);
+    if (lowLevelHas(cacheMeta, cacheKey)) {
+        return cacheMeta.cache[cacheKey];
+    }
+    return;
+};
+const lowLevelGetAll = (cacheMeta) => {
+    upgradeCacheMeta(cacheMeta);
+    // Remove all expired values, and return whatever's left
+    lowLevelDoMaintenance(cacheMeta);
+    // Retype because there won't be any `undefined` values after doMaintenance
+    return cacheMeta.cache;
+};
+const lowLevelSet = (cacheMeta, cacheKey, item) => {
+    upgradeCacheMeta(cacheMeta);
+    const { options: { maxCacheSize }, keyList, keyInfo, } = cacheMeta;
+    const now = dateNow();
+    const isNew = !keyInfo[cacheKey];
+    if (cacheMeta.cache[cacheKey] !== item) {
+        // The cache itself is immutable (but the rest of cacheMeta is not)
+        cacheMeta.cache = {
+            ...cacheMeta.cache,
+            [cacheKey]: item,
+        };
+    }
+    // We've now set or updated it. Regardless of whether it's new, bump its set time
+    // @TODO: expireTime override
+    keyInfo[cacheKey] = [now, 0];
+    if (isNew) {
+        // It's a new key: grow the cache, then shrink it if we can
+        keyList.push(cacheKey);
+        cacheMeta.opsLeft--;
+        if (cacheMeta.opsLeft <= 0) {
+            // Time for an oil change
+            lowLevelDoMaintenance(cacheMeta);
+        }
+        if (maxCacheSize && cacheMeta.keyList.length > maxCacheSize) {
+            // We're still over the limit: drop at least one item
+            _removeItemsToMakeRoom(cacheMeta, now);
+        }
+    }
+    if (_cacheKeyHasExpired(cacheMeta, keyList[0], now)) {
+        // While we're here, if we need to expire the head of the queue then drop it
+        _removeFromIndex(cacheMeta, 0, now);
+    }
+    return cacheMeta;
+};
+const lowLevelRemove = (cacheMeta, cacheKey) => {
+    upgradeCacheMeta(cacheMeta);
+    const { cache, keyInfo } = cacheMeta;
+    if (keyInfo[cacheKey]) {
+        if (cache[cacheKey] !== undefined) {
+            cacheMeta.cache = {
+                ...cache,
+                [cacheKey]: undefined,
+            };
+        }
+        keyInfo[cacheKey] = undefined;
+    }
+    return cacheMeta;
+};
+const lowLevelReset = (cacheMeta) => {
+    upgradeCacheMeta(cacheMeta);
+    return objectAssign(cacheMeta, {
+        cache: {},
+        keyList: [],
+        keyInfo: objectCreate(null),
+        opsLeft: cacheMeta.options.opLimit,
+    });
+};
+export { isCacheMeta, upgradeCacheMeta, lowLevelInit, lowLevelGetOne, lowLevelGetAll, lowLevelHas, lowLevelSet, lowLevelRemove, lowLevelReset, lowLevelDoMaintenance, lowLevelSetOptions, };
+//# sourceMappingURL=lowLevelFunctions.js.map

package/dist/core/lowLevelFunctions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lowLevelFunctions.js","sourceRoot":"","sources":["../../src/core/lowLevelFunctions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AACpF,OAAO,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAS/F,gCAAgC;AAEhC,MAAM,oBAAoB,GAAG,CAAC,KAAa,EAAU,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;AAEhF,MAAM,gBAAgB,GAAG,CAAC,gBAAyC,EAA2B,EAAE;IAC9F,YAAY,CAAC,gBAAgB,EAAE;QAC7B,YAAY,EAAE,oBAAoB,CAAC,gBAAgB,CAAC,YAAY,CAAC;QACjE,YAAY,EAAE,oBAAoB,CAAC,gBAAgB,CAAC,YAAY,CAAC;QACjE,OAAO,EAAE,oBAAoB,CAAC,gBAAgB,CAAC,OAAO,CAAC;KACxD,CAAC,CAAC;IAEH,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY,EAAE;QACzC,gBAAgB,CAAC,0BAA0B,GAAG,oBAAoB,CAChE,gBAAgB,CAAC,0BAA0B,CAC5C,CAAC;KACH;IACD,OAAO,gBAAgB,CAAC;AAC1B,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAAC,SAA2B,EAAW,EAAE;IAC3D,OAAO,CAAC,CAAC,SAAS,IAAI,CAAC,CAAC,SAAS,CAAC,uBAAuB,CAAC;AAC5D,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,SAA2B,EAAQ,EAAE;IAC7D,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,EAAE;QAC3B,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;KAC/E;IACD,IAAI,SAAS,CAAC,uBAAuB,KAAK,oBAAoB,EAAE;QAC9D,8DAA8D;QAC9D,wFAAwF;QACxF,OAAO,CAAC,IAAI,CAAC,+EAA+E,CAAC,CAAC;QAC9F,SAAS,CAAC,uBAAuB,GAAG,oBAAoB,CAAC;QACzD,aAAa,CAAC,SAAS,CAAC,CAAC;KAC1B;AACH,CAAC,CAAC;AAEF,MAAM,kBAAkB,GAAG,CACzB,SAAqC,EACrC,OAA4B,EACC,EAAE;IAC/B,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAC5B,OAAO,gBAAgB,CAAC,YAAY,CAAC,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;AACpE,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CACnB,kBAAqE,EACzC,EAAE;IAC9B,IAAI,WAAW,CAAC,kBAAgD,CAAC,EAAE;QACjE,MAAM,iBAAiB,GAAG,kBAAgD,CAAC;QAC3E,gBAAgB,CAAC,iBAAiB,CAAC,CAAC;QACpC,OAAO,iBAAiB,CAAC;KAC1B;IACD,qBAAqB;IACrB,MAAM,WAAW,GAAG,gBAAgB,CAAC,EAAE,GAAG,cAAc,EAAE,GAAG,kBAAkB,EAAE,CAAC,CAAC;IAEnF,2DAA2D;IAC3D,MAAM,YAAY,GAAG,aAAa,CAAC;QACjC,uBAAuB,EAAE,oBAAoB;QAC7C,OAAO,EAAE,WAAW;KACS,CAAC,CAAC;IAEjC,OAAO,YAAY,CAAC;AACtB,CAAC,CAAC;AAEF,iCAAiC;AAEjC,MAAM,cAAc,GAAG,CAAC,SAA2B,EAAE,QAAgB,EAAU,EAAE;IAC/E,MAAM,EACJ,OAAO,EAAE,EAAE,YAAY,EAAE,EACzB,OAAO,EAAE,EAAE,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,GACjC,GAAG,SAAS,CAAC;IACd,IAAI,CAAC,OAAO,EAAE;QACZ,gDAAgD;QAChD,OAAO,CAAC,CAAC;KACV;IACD,oGAAoG;IACpG,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,OAAO,CAAC;IACtC,OAAO,UAAU,IAAI,OAAO,GAAG,CAAC,YAAY,IAAI,kBAAkB,CAAC,CAAC;AACtE,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAC1B,SAA2B,EAC3B,QAAgB,EAChB,GAAW,EACF,EAAE;IACX,OAAO,cAAc,CAAC,SAAS,EAAE,QAAQ,CAAC,GAAG,GAAG,CAAC;AACnD,CAAC,CAAC;AAEF,MAAM,qBAAqB,GAAG,CAC5B,SAAqC,EACT,EAAE;IAC9B,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAC5B,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,SAAS,CAAC;IAC9C,MAAM,GAAG,GAAG,OAAO,EAAE,CAAC;IAEtB,8EAA8E;IAC9E,MAAM,CAAC,QAAQ,EAAE,UAAU,EAAE,UAAU,CAAC,GAAG,OAAO,CAAC,MAAM,CACvD,CAAC,GAAG,EAAE,QAAQ,EAAE,EAAE;QAChB,MAAM,CAAC,QAAQ,EAAE,UAAU,EAAE,UAAU,CAAC,GAAG,GAAG,CAAC;QAC/C,IAAI,CAAC,mBAAmB,CAAC,SAAS,EAAE,QAAQ,EAAE,GAAG,CAAC,EAAE;YAClD,QAAQ,CAAC,QAAQ,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC;YACrC,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YAC1B,UAAU,CAAC,QAAQ,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;SAC1C;QACD,OAAO,GAAG,CAAC;IACb,CAAC,EACD;QACE,EAAiC;QACjC,EAAmC;QACnC,YAAY,CAAC,IAAI,CAAkC;KACpD,CACF,CAAC;IAEF,OAAO,YAAY,CAAC,SAAS,EAAE;QAC7B,KAAK,EAAE,QAAQ;QACf,OAAO,EAAE,UAAU;QACnB,OAAO,EAAE,UAAU;QACnB,OAAO,EAAE,SAAS,CAAC,OAAO,CAAC,OAAO;KACnC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAC,SAA2B,EAAE,UAAkB,EAAE,GAAW,EAAQ,EAAE;IAC9F,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,SAAS,CAAC;IAE9C,mFAAmF;IACnF,IAAI,SAAS,GAAG,UAAU,CAAC;IAC3B,IAAI,YAAY,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC;IACvC,MAAM,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC;IACrC,GAAG;QACD,yBAAyB;QAEzB,KAAK,CAAC,YAAY,CAAC,GAAG,OAAO,CAAC,YAAY,CAAC,GAAG,SAAS,CAAC;QAExD,+CAA+C;QAC/C,SAAS,EAAE,CAAC;QACZ,YAAY,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;KACnC,QAAQ,SAAS,GAAG,aAAa,IAAI,mBAAmB,CAAC,SAAS,EAAE,YAAY,EAAE,GAAG,CAAC,EAAE;IAEzF,uEAAuE;IACvE,OAAO,CAAC,MAAM,CAAC,UAAU,EAAE,SAAS,GAAG,UAAU,CAAC,CAAC;AACrD,CAAC,CAAC;AAEF,MAAM,sBAAsB,GAAG,CAAC,SAA2B,EAAE,GAAW,EAAQ,EAAE;IAChF,MAAM,EACJ,OAAO,EAAE,EAAE,SAAS,EAAE,0BAA0B,EAAE,EAClD,KAAK,EACL,OAAO,EACP,OAAO,GACR,GAAG,SAAS,CAAC;IAEd,wFAAwF;IACxF,8FAA8F;IAC9F,IAAI,eAAe,GAAG,CAAC,CAAC;IACxB,IAAI,gBAAgB,GAAG,cAAc,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;IAE7D,IAAI,gBAAgB,GAAG,GAAG,EAAE;QAC1B,iFAAiF;QACjF,IAAI,YAAY,GAAG,CAAC,CAAC;QACrB,MAAM,eAAe,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;QAC5D,OAAO,YAAY,GAAG,eAAe,EAAE;YACrC,MAAM,gBAAgB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;YAC/C,MAAM,kBAAkB,GAAG,cAAc,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAC;YAEvE,6FAA6F;YAC7F,iCAAiC;YACjC,IAAI,kBAAkB,GAAG,GAAG,EAAE;gBAC5B,oDAAoD;gBACpD,eAAe,GAAG,YAAY,CAAC;gBAC/B,gBAAgB,GAAG,CAAC,CAAC;gBACrB,MAAM;aACP;YACD,IAAI,kBAAkB,GAAG,gBAAgB,EAAE;gBACzC,uBAAuB;gBACvB,eAAe,GAAG,YAAY,CAAC;gBAC/B,gBAAgB,GAAG,kBAAkB,CAAC;aACvC;YACD,YAAY,IAAI,CAAC,CAAC;SACnB;KACF;IAED,gGAAgG;IAChG,gDAAgD;IAChD,IACE,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,YAAY;QACrC,0BAA0B;QAC1B,gBAAgB,GAAG,GAAG,EACtB;QACA,MAAM,aAAa,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;QAC/C,MAAM,CAAC,iBAAiB,EAAE,oBAAoB,CAAC,GAAG,OAAO,CAAC,aAAa,CAAqB,CAAC;QAE7F,IAAI,GAAG,GAAG,iBAAiB,GAAG,0BAA0B,EAAE;YACxD,OAAO,CAAC,IAAI,CACV,2FAA2F,EAC3F;gBACE,WAAW,EAAE,GAAG;gBAChB,GAAG,EAAE,aAAa;gBAClB,IAAI,EAAE,KAAK,CAAC,aAAa,CAAC;gBAC1B,OAAO,EAAE,iBAAiB;gBAC1B,UAAU,EAAE,oBAAoB;gBAChC,WAAW,EAAE,GAAG,GAAG,iBAAiB;aACrC,CACF,CAAC;SACH;KACF;IAED,8DAA8D;IAC9D,gBAAgB,CAAC,SAAS,EAAE,eAAe,EAAE,GAAG,CAAC,CAAC;AACpD,CAAC,CAAC;AAEF,eAAe;AAEf,MAAM,WAAW,GAAG,CAClB,SAAqC,EACrC,QAAgB,EACP,EAAE;IACX,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAC5B,MAAM,EAAE,KAAK,EAAE,GAAG,SAAS,CAAC;IAC5B,IAAI,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,SAAS,EAAE;QACzE,IAAI,CAAC,mBAAmB,CAAC,SAAS,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,EAAE;YACxD,OAAO,IAAI,CAAC;SACb;QACD,+EAA+E;QAC/E,KAAK,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC;KAC7B;IACD,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CACrB,SAAqC,EACrC,QAAgB,EACM,EAAE;IACxB,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAC5B,IAAI,WAAW,CAAC,SAAS,EAAE,QAAQ,CAAC,EAAE;QACpC,OAAO,SAAS,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;KAClC;IACD,OAAO;AACT,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CACrB,SAAqC,EACX,EAAE;IAC5B,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAC5B,wDAAwD;IACxD,qBAAqB,CAAC,SAAS,CAAC,CAAC;IACjC,2EAA2E;IAC3E,OAAO,SAAS,CAAC,KAAiC,CAAC;AACrD,CAAC,CAAC;AAEF,MAAM,WAAW,GAAG,CAClB,SAAqC,EACrC,QAAgB,EAChB,IAAc,EACc,EAAE;IAC9B,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAE5B,MAAM,EACJ,OAAO,EAAE,EAAE,YAAY,EAAE,EACzB,OAAO,EACP,OAAO,GACR,GAAG,SAAS,CAAC;IAEd,MAAM,GAAG,GAAG,OAAO,EAAE,CAAC;IACtB,MAAM,KAAK,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAEjC,IAAI,SAAS,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,IAAI,EAAE;QACtC,mEAAmE;QACnE,SAAS,CAAC,KAAK,GAAG;YAChB,GAAG,SAAS,CAAC,KAAK;YAClB,CAAC,QAAQ,CAAC,EAAE,IAAI;SACjB,CAAC;KACH;IACD,iFAAiF;IACjF,6BAA6B;IAC7B,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;IAE7B,IAAI,KAAK,EAAE;QACT,2DAA2D;QAC3D,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAEvB,SAAS,CAAC,OAAO,EAAE,CAAC;QACpB,IAAI,SAAS,CAAC,OAAO,IAAI,CAAC,EAAE;YAC1B,yBAAyB;YACzB,qBAAqB,CAAC,SAAS,CAAC,CAAC;SAClC;QAED,IAAI,YAAY,IAAI,SAAS,CAAC,OAAO,CAAC,MAAM,GAAG,YAAY,EAAE;YAC3D,qDAAqD;YACrD,sBAAsB,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;SACxC;KACF;IAED,IAAI,mBAAmB,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE;QACnD,4EAA4E;QAC5E,gBAAgB,CAAC,SAAS,EAAE,CAAC,EAAE,GAAG,CAAC,CAAC;KACrC;IAED,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,cAAc,GAAG,CACrB,SAAqC,EACrC,QAAgB,EACY,EAAE;IAC9B,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAC5B,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,SAAS,CAAC;IAErC,IAAI,OAAO,CAAC,QAAQ,CAAC,EAAE;QACrB,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,SAAS,EAAE;YACjC,SAAS,CAAC,KAAK,GAAG;gBAChB,GAAG,KAAK;gBACR,CAAC,QAAQ,CAAC,EAAE,SAAS;aACtB,CAAC;SACH;QACD,OAAO,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC;KAC/B;IAED,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CACpB,SAAqC,EACT,EAAE;IAC9B,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAC5B,OAAO,YAAY,CAAC,SAAS,EAAE;QAC7B,KAAK,EAAE,EAAE;QACT,OAAO,EAAE,EAAE;QACX,OAAO,EAAE,YAAY,CAAC,IAAI,CAAC;QAC3B,OAAO,EAAE,SAAS,CAAC,OAAO,CAAC,OAAO;KACnC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,OAAO,EACL,WAAW,EACX,gBAAgB,EAChB,YAAY,EACZ,cAAc,EACd,cAAc,EACd,WAAW,EACX,WAAW,EACX,cAAc,EACd,aAAa,EACb,qBAAqB,EACrB,kBAAkB,GACnB,CAAC"}

package/dist/index.cjs

@@ -0,0 +1,388 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  CURRENT_META_VERSION: () => CURRENT_META_VERSION,
+  LimitedCache: () => LimitedCache,
+  LimitedCacheObject: () => LimitedCacheObject,
+  MAXIMUM_CACHE_TIME: () => MAXIMUM_CACHE_TIME,
+  defaultOptions: () => defaultOptions,
+  getCacheMetaFromObject: () => getCacheMetaFromObject,
+  isCacheMeta: () => isCacheMeta,
+  limitedCacheUtil: () => limitedCacheUtil,
+  lowLevelDoMaintenance: () => lowLevelDoMaintenance,
+  lowLevelGetAll: () => lowLevelGetAll,
+  lowLevelGetOne: () => lowLevelGetOne,
+  lowLevelHas: () => lowLevelHas,
+  lowLevelInit: () => lowLevelInit,
+  lowLevelRemove: () => lowLevelRemove,
+  lowLevelReset: () => lowLevelReset,
+  lowLevelSet: () => lowLevelSet,
+  lowLevelSetOptions: () => lowLevelSetOptions,
+  upgradeCacheMeta: () => upgradeCacheMeta
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/core/defaultOptions.ts
+var CURRENT_META_VERSION = 2;
+var MAXIMUM_CACHE_TIME = 365 * 86400 * 1e3;
+var defaultOptions = {
+  // Public
+  maxCacheSize: 100,
+  maxCacheTime: 86400 * 1e3,
+  // Development-only
+  warnIfItemPurgedBeforeTime: 5e3,
+  // Private
+  opLimit: 200,
+  scanLimit: 50
+};
+
+// src/core/builtIns.ts
+var {
+  create: objectCreate,
+  assign: objectAssign,
+  prototype: { hasOwnProperty }
+} = Object;
+var dateNow = Date.now;
+
+// src/core/lowLevelFunctions.ts
+var positiveNumberOrZero = (value) => Math.max(value, 0) || 0;
+var normalizeOptions = (cacheMetaOptions) => {
+  objectAssign(cacheMetaOptions, {
+    maxCacheSize: positiveNumberOrZero(cacheMetaOptions.maxCacheSize),
+    maxCacheTime: positiveNumberOrZero(cacheMetaOptions.maxCacheTime),
+    opLimit: positiveNumberOrZero(cacheMetaOptions.opLimit)
+  });
+  if (process.env.NODE_ENV !== "production") {
+    cacheMetaOptions.warnIfItemPurgedBeforeTime = positiveNumberOrZero(
+      cacheMetaOptions.warnIfItemPurgedBeforeTime
+    );
+  }
+  return cacheMetaOptions;
+};
+var isCacheMeta = (cacheMeta) => {
+  return !!cacheMeta && !!cacheMeta.limitedCacheMetaVersion;
+};
+var upgradeCacheMeta = (cacheMeta) => {
+  if (!isCacheMeta(cacheMeta)) {
+    throw new Error("Limited-cache metadata is missing: please check your usage");
+  }
+  if (cacheMeta.limitedCacheMetaVersion !== CURRENT_META_VERSION) {
+    console.warn("Limited-cache metadata is from an incompatible version (1). It must be reset.");
+    cacheMeta.limitedCacheMetaVersion = CURRENT_META_VERSION;
+    lowLevelReset(cacheMeta);
+  }
+};
+var lowLevelSetOptions = (cacheMeta, options) => {
+  upgradeCacheMeta(cacheMeta);
+  return normalizeOptions(objectAssign(cacheMeta.options, options));
+};
+var lowLevelInit = (optionsOrCacheMeta) => {
+  if (isCacheMeta(optionsOrCacheMeta)) {
+    const existingCacheMeta = optionsOrCacheMeta;
+    upgradeCacheMeta(existingCacheMeta);
+    return existingCacheMeta;
+  }
+  const fullOptions = normalizeOptions({ ...defaultOptions, ...optionsOrCacheMeta });
+  const newCacheMeta = lowLevelReset({
+    limitedCacheMetaVersion: CURRENT_META_VERSION,
+    options: fullOptions
+  });
+  return newCacheMeta;
+};
+var _getExpireTime = (cacheMeta, cacheKey) => {
+  const {
+    options: { maxCacheTime },
+    keyInfo: { [cacheKey]: keyInfo }
+  } = cacheMeta;
+  if (!keyInfo) {
+    return 0;
+  }
+  const [setTime, expireTime] = keyInfo;
+  return expireTime || setTime + (maxCacheTime || MAXIMUM_CACHE_TIME);
+};
+var _cacheKeyHasExpired = (cacheMeta, cacheKey, now) => {
+  return _getExpireTime(cacheMeta, cacheKey) < now;
+};
+var lowLevelDoMaintenance = (cacheMeta) => {
+  upgradeCacheMeta(cacheMeta);
+  const { cache, keyList, keyInfo } = cacheMeta;
+  const now = dateNow();
+  const [newCache, newKeyList, newKeyInfo] = keyList.reduce(
+    (acc, cacheKey) => {
+      const [accCache, accKeyList, accKeyInfo] = acc;
+      if (!_cacheKeyHasExpired(cacheMeta, cacheKey, now)) {
+        accCache[cacheKey] = cache[cacheKey];
+        accKeyList.push(cacheKey);
+        accKeyInfo[cacheKey] = keyInfo[cacheKey];
+      }
+      return acc;
+    },
+    [
+      {},
+      [],
+      objectCreate(null)
+    ]
+  );
+  return objectAssign(cacheMeta, {
+    cache: newCache,
+    keyList: newKeyList,
+    keyInfo: newKeyInfo,
+    opsLeft: cacheMeta.options.opLimit
+  });
+};
+var _removeFromIndex = (cacheMeta, startIndex, now) => {
+  const { cache, keyList, keyInfo } = cacheMeta;
+  let nextIndex = startIndex;
+  let nextCacheKey = keyList[startIndex];
+  const keyListLength = keyList.length;
+  do {
+    cache[nextCacheKey] = keyInfo[nextCacheKey] = void 0;
+    nextIndex++;
+    nextCacheKey = keyList[nextIndex];
+  } while (nextIndex < keyListLength && _cacheKeyHasExpired(cacheMeta, nextCacheKey, now));
+  keyList.splice(startIndex, nextIndex - startIndex);
+};
+var _removeItemsToMakeRoom = (cacheMeta, now) => {
+  const {
+    options: { scanLimit, warnIfItemPurgedBeforeTime },
+    cache,
+    keyList,
+    keyInfo
+  } = cacheMeta;
+  let oldestItemIndex = 0;
+  let oldestExpireTime = _getExpireTime(cacheMeta, keyList[0]);
+  if (oldestExpireTime > now) {
+    let indexToCheck = 0;
+    const maxIndexToCheck = Math.min(keyList.length, scanLimit);
+    while (indexToCheck < maxIndexToCheck) {
+      const cacheKeyForIndex = keyList[indexToCheck];
+      const expireTimeForIndex = _getExpireTime(cacheMeta, cacheKeyForIndex);
+      if (expireTimeForIndex < now) {
+        oldestItemIndex = indexToCheck;
+        oldestExpireTime = 0;
+        break;
+      }
+      if (expireTimeForIndex < oldestExpireTime) {
+        oldestItemIndex = indexToCheck;
+        oldestExpireTime = expireTimeForIndex;
+      }
+      indexToCheck += 1;
+    }
+  }
+  if (process.env.NODE_ENV !== "production" && warnIfItemPurgedBeforeTime && oldestExpireTime > now) {
+    const oldestItemKey = keyList[oldestItemIndex];
+    const [oldestItemSetTime, oldestItemExpireTime] = keyInfo[oldestItemKey];
+    if (now - oldestItemSetTime < warnIfItemPurgedBeforeTime) {
+      console.warn(
+        "Purged an item from cache while it was still fresh: you may want to increase maxCacheSize",
+        {
+          currentTime: now,
+          key: oldestItemKey,
+          item: cache[oldestItemKey],
+          setTime: oldestItemSetTime,
+          expireTime: oldestItemExpireTime,
+          timeInCache: now - oldestItemSetTime
+        }
+      );
+    }
+  }
+  _removeFromIndex(cacheMeta, oldestItemIndex, now);
+};
+var lowLevelHas = (cacheMeta, cacheKey) => {
+  upgradeCacheMeta(cacheMeta);
+  const { cache } = cacheMeta;
+  if (hasOwnProperty.call(cache, cacheKey) && cache[cacheKey] !== void 0) {
+    if (!_cacheKeyHasExpired(cacheMeta, cacheKey, dateNow())) {
+      return true;
+    }
+    cache[cacheKey] = void 0;
+  }
+  return false;
+};
+var lowLevelGetOne = (cacheMeta, cacheKey) => {
+  upgradeCacheMeta(cacheMeta);
+  if (lowLevelHas(cacheMeta, cacheKey)) {
+    return cacheMeta.cache[cacheKey];
+  }
+  return;
+};
+var lowLevelGetAll = (cacheMeta) => {
+  upgradeCacheMeta(cacheMeta);
+  lowLevelDoMaintenance(cacheMeta);
+  return cacheMeta.cache;
+};
+var lowLevelSet = (cacheMeta, cacheKey, item) => {
+  upgradeCacheMeta(cacheMeta);
+  const {
+    options: { maxCacheSize },
+    keyList,
+    keyInfo
+  } = cacheMeta;
+  const now = dateNow();
+  const isNew = !keyInfo[cacheKey];
+  if (cacheMeta.cache[cacheKey] !== item) {
+    cacheMeta.cache = {
+      ...cacheMeta.cache,
+      [cacheKey]: item
+    };
+  }
+  keyInfo[cacheKey] = [now, 0];
+  if (isNew) {
+    keyList.push(cacheKey);
+    cacheMeta.opsLeft--;
+    if (cacheMeta.opsLeft <= 0) {
+      lowLevelDoMaintenance(cacheMeta);
+    }
+    if (maxCacheSize && cacheMeta.keyList.length > maxCacheSize) {
+      _removeItemsToMakeRoom(cacheMeta, now);
+    }
+  }
+  if (_cacheKeyHasExpired(cacheMeta, keyList[0], now)) {
+    _removeFromIndex(cacheMeta, 0, now);
+  }
+  return cacheMeta;
+};
+var lowLevelRemove = (cacheMeta, cacheKey) => {
+  upgradeCacheMeta(cacheMeta);
+  const { cache, keyInfo } = cacheMeta;
+  if (keyInfo[cacheKey]) {
+    if (cache[cacheKey] !== void 0) {
+      cacheMeta.cache = {
+        ...cache,
+        [cacheKey]: void 0
+      };
+    }
+    keyInfo[cacheKey] = void 0;
+  }
+  return cacheMeta;
+};
+var lowLevelReset = (cacheMeta) => {
+  upgradeCacheMeta(cacheMeta);
+  return objectAssign(cacheMeta, {
+    cache: {},
+    keyList: [],
+    keyInfo: objectCreate(null),
+    opsLeft: cacheMeta.options.opLimit
+  });
+};
+
+// src/core/LimitedCache.ts
+var bindFunctionToCacheMeta = (fn, cacheMeta) => fn.bind(null, cacheMeta);
+var LimitedCache = (options) => {
+  const cacheMeta = lowLevelInit(options);
+  return {
+    get: bindFunctionToCacheMeta(lowLevelGetOne, cacheMeta),
+    getAll: bindFunctionToCacheMeta(lowLevelGetAll, cacheMeta),
+    has: bindFunctionToCacheMeta(lowLevelHas, cacheMeta),
+    set: (cacheKey, item) => {
+      lowLevelSet(cacheMeta, cacheKey, item);
+      return item;
+    },
+    remove: (cacheKey) => {
+      lowLevelRemove(cacheMeta, cacheKey);
+      return true;
+    },
+    reset: bindFunctionToCacheMeta(lowLevelReset, cacheMeta),
+    getCacheMeta: () => cacheMeta,
+    getOptions: () => cacheMeta.options,
+    setOptions: bindFunctionToCacheMeta(lowLevelSetOptions, cacheMeta),
+    doMaintenance: bindFunctionToCacheMeta(lowLevelDoMaintenance, cacheMeta)
+  };
+};
+
+// src/core/LimitedCacheObject.ts
+var proxyHandler = {
+  get: (cacheMeta, cacheKey) => {
+    if (cacheKey === "hasOwnProperty") {
+      return hasOwnProperty;
+    }
+    return lowLevelGetOne(cacheMeta, cacheKey);
+  },
+  getOwnPropertyDescriptor: (cacheMeta, cacheKey) => {
+    const hasResult = lowLevelHas(cacheMeta, cacheKey);
+    const getResult = lowLevelGetOne(cacheMeta, cacheKey);
+    if (hasResult) {
+      return {
+        configurable: true,
+        enumerable: hasResult,
+        value: getResult,
+        writable: true
+      };
+    }
+    return;
+  },
+  has: lowLevelHas,
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  set: (cacheMeta, cacheKey, item) => {
+    lowLevelSet(cacheMeta, cacheKey, item);
+    return item;
+  },
+  deleteProperty: (cacheMeta, cacheKey) => {
+    lowLevelRemove(cacheMeta, cacheKey);
+    return true;
+  },
+  ownKeys: (cacheMeta) => Object.keys(lowLevelGetAll(cacheMeta))
+};
+var cacheMetasForProxies = /* @__PURE__ */ new WeakMap();
+var LimitedCacheObject = (options) => {
+  const cacheMeta = lowLevelInit(options);
+  const limitedCacheObject = new Proxy(cacheMeta, proxyHandler);
+  cacheMetasForProxies.set(limitedCacheObject, cacheMeta);
+  return limitedCacheObject;
+};
+var getCacheMetaFromObject = (instance) => {
+  return cacheMetasForProxies.get(instance);
+};
+
+// src/core/limitedCacheUtil.ts
+var limitedCacheUtil = {
+  init: lowLevelInit,
+  get: lowLevelGetOne,
+  getAll: lowLevelGetAll,
+  has: lowLevelHas,
+  set: lowLevelSet,
+  remove: lowLevelRemove,
+  reset: lowLevelReset,
+  doMaintenance: lowLevelDoMaintenance,
+  setOptions: lowLevelSetOptions
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  CURRENT_META_VERSION,
+  LimitedCache,
+  LimitedCacheObject,
+  MAXIMUM_CACHE_TIME,
+  defaultOptions,
+  getCacheMetaFromObject,
+  isCacheMeta,
+  limitedCacheUtil,
+  lowLevelDoMaintenance,
+  lowLevelGetAll,
+  lowLevelGetOne,
+  lowLevelHas,
+  lowLevelInit,
+  lowLevelRemove,
+  lowLevelReset,
+  lowLevelSet,
+  lowLevelSetOptions,
+  upgradeCacheMeta
+});

package/dist/index.d.ts

@@ -1,6 +1,7 @@
-export * from './core/defaultOptions';
-export * from './core/LimitedCache';
-export * from './core/LimitedCacheObject';
-export * from './core/limitedCacheUtil';
-export * from './core/lowLevelFunctions';
-export * from './types';
+export * from './core/defaultOptions.js';
+export * from './core/LimitedCache.js';
+export * from './core/LimitedCacheObject.js';
+export * from './core/limitedCacheUtil.js';
+export * from './core/lowLevelFunctions.js';
+export * from './types.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAC;AACzC,cAAc,wBAAwB,CAAC;AACvC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,4BAA4B,CAAC;AAE3C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,YAAY,CAAC"}

package/dist/index.js

@@ -1,8 +1,7 @@
-
-'use strict'
-
-if (process.env.NODE_ENV === 'production') {
-  module.exports = require('./limited-cache.cjs.production.min.js')
-} else {
-  module.exports = require('./limited-cache.cjs.development.js')
-}
+export * from './core/defaultOptions.js';
+export * from './core/LimitedCache.js';
+export * from './core/LimitedCacheObject.js';
+export * from './core/limitedCacheUtil.js';
+export * from './core/lowLevelFunctions.js';
+export * from './types.js';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,0BAA0B,CAAC;AACzC,cAAc,wBAAwB,CAAC;AACvC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,4BAA4B,CAAC;AAE3C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,YAAY,CAAC"}