@jointly/cache-candidate 1.1.5 → 1.3.0

package/README.md

@@ -2,6 +2,14 @@
 
 This is a library providing both a higher-order function and a decorator to cache the result of a function/method if given conditions are met.
 
+# How do I install it?
+
+You can install it by using the following command:
+
+```bash
+npm install @jointly/cache-candidate
+```
+
 # Examples
 
 ## Use-case #1: DB query
@@ -25,7 +33,7 @@ await cachedGetUsers({ name: 'John' }); // <-- This won't be cached, because the
 await cachedGetUsers({ name: 'John' }); // <-- This won't be cached, because the requestsThreshold is 3 in the last 30 seconds
 await cachedGetUsers({ name: 'John' }); // <-- This WILL be cached, because the requestsThreshold is 3 in the last 30 seconds!
 await cachedGetUsers({ name: 'Jack' }); // <-- This won't be cached, because parameters are different
-await sleep(60000); // <-- This will flush the cache because of the ttl
+await sleep(61000); // <-- This will wait enough time (ttl) for the cache record to expire
 await cachedGetUsers({ name: 'John' }); // <-- This won't be cached, because the requestsThreshold is 3 in the last 30 seconds
 ```
 ## Use-case #2: DB query - Different timeFrame
@@ -48,7 +56,7 @@ await cachedGetUsers({ name: 'John' }); // <-- This won't be cached, because the
 await cachedGetUsers({ name: 'John' }); // <-- This won't be cached, because the requestsThreshold is 3 in the last 45 seconds
 await cachedGetUsers({ name: 'John' }); // <-- This WILL be cached, because the requestsThreshold is 3 in the last 45 seconds!
 await cachedGetUsers({ name: 'Jack' }); // <-- This won't be cached, because parameters are different
-await sleep(30000); // <-- This will flush the cache because of the ttl
+await sleep(31000); // <-- This will wait enough time (ttl) for the cache record to expire
 await cachedGetUsers({ name: 'John' }); // <-- This WILL be cached, because the requestsThreshold is 3 in the last 45 seconds!
 ```
 
@@ -71,7 +79,7 @@ const cachedGetUsers = cacheCandidate(getUsers, {
 await cachedGetUsers({ name: 'John' }); // <-- This will be cached, because the candidateFunction returns true
 await cachedGetUsers({ name: 'John' }); // <-- This will return the cached value
 await cachedGetUsers({ name: 'Jack' }); // <-- This won't be cached, because the candidateFunction returns false
-await sleep(30000); // <-- This will invalidate the cache because of the ttl
+await sleep(31000); // <-- This will invalidate the cache because of the ttl
 ```
 
 # How does it work?
@@ -141,8 +149,8 @@ The conditions are, within the given `timeFrame`:
 
 - If a `candidateFunction` is provided, it returns `true` at least once.  
   The candidateFunction ignores all the other conditions.  
-- If a `millisecondsThreshold` is provided, the function execution time passed such threshold at least `requestThreshold` times.
-- If only a `requestThreshold` is provided (default), the function is called at least `requestThreshold` times.
+- If a `millisecondThreshold` is provided, the function execution time passed such threshold at least `requestsThreshold` times.
+- If only a `requestsThreshold` is provided (default), the function is called at least `requestsThreshold` times.
 
 # Other Info
 
@@ -199,4 +207,4 @@ The cache key is composed based on the following criteria, allowing multiple fil
 
 # Contributing
 
-Please, refer to the [CONTRIBUTING.md](https://github.com/JointlyTech/cache-candidate/blob/main/CONTRIBUTING.md) file for more information.
+Please, refer to the [CONTRIBUTING.md](https://github.com/JointlyTech/cache-candidate/blob/main/CONTRIBUTING.md) file for more information.

package/dist/index.js

@@ -1 +1 @@
-"use strict";var $=Object.create;var f=Object.defineProperty;var L=Object.getOwnPropertyDescriptor;var U=Object.getOwnPropertyNames;var W=Object.getPrototypeOf,X=Object.prototype.hasOwnProperty;var _=(e,t)=>()=>(t||e((t={exports:{}}).exports,t),t.exports),K=(e,t)=>{for(var n in t)f(e,n,{get:t[n],enumerable:!0})},b=(e,t,n,r)=>{if(t&&typeof t=="object"||typeof t=="function")for(let a of U(t))!X.call(e,a)&&a!==n&&f(e,a,{get:()=>t[a],enumerable:!(r=L(t,a))||r.enumerable});return e};var y=(e,t,n)=>(n=e!=null?$(W(e)):{},b(t||!e||!e.__esModule?f(n,"default",{value:e,enumerable:!0}):n,e)),B=e=>b(f({},"__esModule",{value:!0}),e);var A=_((we,w)=>{"use strict";var E=Object.defineProperty,z=Object.getOwnPropertyDescriptor,G=Object.getOwnPropertyNames,V=Object.prototype.hasOwnProperty,Y=(e,t)=>{for(var n in t)E(e,n,{get:t[n],enumerable:!0})},Z=(e,t,n,r)=>{if(t&&typeof t=="object"||typeof t=="function")for(let a of G(t))!V.call(e,a)&&a!==n&&E(e,a,{get:()=>t[a],enumerable:!(r=z(t,a))||r.enumerable});return e},ee=e=>Z(E({},"__esModule",{value:!0}),e),H={};Y(H,{Hooks:()=>F});w.exports=ee(H);var F=(e=>(e.INIT="INIT",e.EXECUTION_PRE="EXECUTION_PRE",e.EXECUTION_POST="EXECUTION_POST",e.DATACACHE_RECORD_ADD_PRE="DATACACHE_RECORD_ADD_PRE",e.DATACACHE_RECORD_ADD_POST="DATACACHE_RECORD_ADD_POST",e.DATACACHE_RECORD_DELETE_PRE="DATACACHE_RECORD_DELETE_PRE",e.DATACACHE_RECORD_DELETE_POST="DATACACHE_RECORD_DELETE_POST",e.CACHE_HIT="CACHE_HIT",e))(F||{})});var N=_((ke,S)=>{"use strict";var D=Object.defineProperty,te=Object.getOwnPropertyDescriptor,ne=Object.getOwnPropertyNames,ae=Object.prototype.hasOwnProperty,re=(e,t)=>{for(var n in t)D(e,n,{get:t[n],enumerable:!0})},oe=(e,t,n,r)=>{if(t&&typeof t=="object"||typeof t=="function")for(let a of ne(t))!ae.call(e,a)&&a!==n&&D(e,a,{get:()=>t[a],enumerable:!(r=te(t,a))||r.enumerable});return e},ie=e=>oe(D({},"__esModule",{value:!0}),e),k={};re(k,{Hook:()=>se,hook:()=>de});S.exports=ie(k);var ce={before:()=>{},after:()=>{}},ue={before:()=>{},after:()=>{}};function se(e){return function(t,n,r){let a={},o=r.value,{before:i,after:c}={...ce,...e};return r.value=function(...u){i({context:a,args:u,target:t,propertyKey:n,descriptor:r});let s=o.apply(this,u);return c({context:a,args:u,target:t,propertyKey:n,descriptor:r,result:s}),s},r}}function de(e){return function(t){let n={},{before:r,after:a}={...ue,...e};return function(...o){r({context:n,args:o});let i=t(...o);return a({context:n,args:o,result:i}),i}}}});var xe={};K(xe,{CacheCandidate:()=>Re,CacheCandidateOptionsDefault:()=>T,DataCacheRecordNotFound:()=>m,RunningQueryRecordNotFound:()=>g,cacheCandidate:()=>Pe});module.exports=B(xe);var v=(e=new Map)=>({get:async t=>e.get(JSON.stringify(t)),has:async t=>e.has(JSON.stringify(t)),set:async(t,n)=>e.set(JSON.stringify(t),n),delete:async t=>e.delete(JSON.stringify(t))});var T={ttl:6e5,timeFrame:3e4,requestsThreshold:3,cache:v(),keepAlive:!1,plugins:[],events:{onCacheHit:e=>e,onCacheSet:e=>e,onCacheDelete:e=>e,onBeforeFunctionExecution:e=>e,onAfterFunctionExecution:e=>e}};var m=Symbol("DataCacheRecordNotFound"),g=Symbol("RunningQueryRecordNotFound");var q=require("crypto");var I=y(A()),M=y(N());async function l(e,t,n){for(let r of t){let a=r.hooks.filter(i=>i.hook===e);if(a.length>1)throw new Error(`Only one hook instance per plugin is allowed. ${r.name} has ${a.length} instances of ${e}}`);if(a.length===0)continue;let o=a[0];if(le(o))await o.action(n,r.additionalParameters);else throw new Error(`Hook ${e} for plugin ${r.name} is not actionable.`)}}function le(e){return[e.action!==void 0,typeof e.action=="function"].every(t=>t===!0)}function j(e,t,n,r){return(0,M.hook)({before:()=>{l(e,n.plugins,r)},after:({result:a})=>{l(t,n.plugins,{...r,result:a})}})}function O({options:e}){e.plugins&&e.plugins.forEach(t=>{if(!t.hooks||!Array.isArray(t.hooks)||t.hooks.length===0)throw new Error(`Plugin ${t.name} has no hooks.`);t.hooks.forEach(n=>{if(!I.Hooks[n.hook])throw new Error(`Invalid hook ${n}`)})})}var h=y(A());function he(e,t){return Date.now()<e+t.timeFrame}function Ce({key:e,timeframeCache:t,executionTime:n,executionEnd:r}){t.has(e)?t.get(e).push({executionTime:n,executionEnd:r}):t.set(e,[{executionEnd:r,executionTime:n}])}function me({options:e,key:t,timeframeCache:n}){if(n.has(t)){let r=n.get(t),a=r.filter(({executionEnd:o})=>he(o,e));r.length!==a.length&&n.set(t,a)}}function fe({key:e,runningQueryCache:t}){return t.has(e)?t.get(e):g}function R(...e){return(0,q.createHash)("sha256").update(e.join("|")).digest("hex")}function ge({birthTime:e,options:t}){return Date.now()-e>=t.ttl}async function pe({options:e,key:t,HookPayload:n}){if(await e.cache.has(t)){let{result:r,birthTime:a}=await e.cache.get(t);return ge({birthTime:a,options:e})?(await J({options:e,key:t,HookPayload:n}),m):r}return m}async function ye({options:e,key:t,result:n}){return e.cache.set(t,{result:n,birthTime:Date.now()},e.ttl)}async function J({options:e,key:t,HookPayload:n}){j(h.Hooks.DATACACHE_RECORD_DELETE_PRE,h.Hooks.DATACACHE_RECORD_DELETE_POST,e,n)(e.cache.delete)(t).then(()=>{e.events.onCacheDelete({key:t})})}async function Q({result:e,runningQueryCache:t,key:n,executionStart:r,options:a,timeframeCache:o,timeFrameTimeoutCache:i,args:c,HookPayload:u}){let s=Date.now(),C=s-r;a.events.onAfterFunctionExecution({key:n,executionTime:C}),Ce({key:n,timeframeCache:o,executionTime:C,executionEnd:s}),Te({options:a,key:n,timeframeCache:o,executionTime:C,args:c})>=a.requestsThreshold?(await l(h.Hooks.DATACACHE_RECORD_ADD_PRE,a.plugins,u),ye({options:a,key:n,result:e}).then(async()=>{await l(h.Hooks.DATACACHE_RECORD_ADD_POST,a.plugins,{...u,result:e}),a.events.onCacheSet({key:n})}).finally(()=>{t.delete(n),i.set(n,setTimeout(()=>{J({options:a,key:n,HookPayload:u})},a.ttl).unref())})):t.delete(n)}function Te({options:e,key:t,timeframeCache:n,executionTime:r,args:a}){let o=0,i=n.get(t);return e.candidateFunction?o=Ae(e,r,a,i):e.millisecondThreshold?o=Ee(r,e,i):o=i.length,o}function Ee(e,t,n){let r=0;return e>t.millisecondThreshold&&(r=n.filter(a=>a.executionTime>t.millisecondThreshold).length),r}function Ae(e,t,n,r){let a=0;return e.candidateFunction({timeFrameCacheRecords:r,options:e,args:n})&&(a=e.requestsThreshold),a}function De({timeFrameTimeoutCache:e,key:t,options:n}){clearTimeout(e.get(t)),e.set(t,setTimeout(()=>{n.cache.delete(t)},n.ttl).unref())}function Oe(e=10){return Math.random().toString(36).substring(2,e+2)}async function P({options:e,key:t,timeFrameTimeoutCache:n,runningQueryCache:r,timeframeCache:a,args:o,originalMethod:i}){let c={options:{...e,plugins:void 0},key:t,timeFrameTimeoutCache:n,runningQueryCache:r,timeframeCache:a,fnArgs:o};await l(h.Hooks.INIT,e.plugins,c);let u=await pe({options:e,key:t,HookPayload:c});if(u!==m)return e.keepAlive&&De({timeFrameTimeoutCache:n,key:t,options:e}),await l(h.Hooks.CACHE_HIT,e.plugins,{...c,result:u}),e.events.onCacheHit({key:t}),Promise.resolve(u);let s=fe({key:t,runningQueryCache:r});if(s!==g)return await l(h.Hooks.CACHE_HIT,e.plugins,{...c,result:s}),e.events.onCacheHit({key:t}),s;me({options:e,key:t,timeframeCache:a}),await l(h.Hooks.EXECUTION_PRE,e.plugins,c),e.events.onBeforeFunctionExecution({key:t});let C=Date.now(),d=i(...o);return await l(h.Hooks.EXECUTION_POST,e.plugins,{...c,result:d}),d instanceof Promise?(r.set(t,d),d.then(p=>Q({result:p,runningQueryCache:r,key:t,executionStart:C,options:e,timeframeCache:a,timeFrameTimeoutCache:n,args:o,HookPayload:c})),d):(Q({result:d,runningQueryCache:r,key:t,executionStart:C,options:e,timeframeCache:a,timeFrameTimeoutCache:n,args:o,HookPayload:c}),d)}function x(e){let t=new Map,n=new Map,r=Oe(),a=new Map,o={...T,...e};return{timeframeCache:t,runningQueryCache:n,uniqueIdentifier:r,timeFrameTimeoutCache:a,options:o}}function Re(e={}){let{timeframeCache:t,runningQueryCache:n,uniqueIdentifier:r,timeFrameTimeoutCache:a,options:o}=x(e);return O({options:o}),function(i,c,u){let s=u.value;u.value=async function(...C){let d=i.constructor.name+JSON.stringify(this),p=R([c,r,d,JSON.stringify(C)]);return P({options:o,key:p,timeFrameTimeoutCache:a,runningQueryCache:n,timeframeCache:t,args:C,originalMethod:s})}}}function Pe(e,t={}){let{timeframeCache:n,runningQueryCache:r,uniqueIdentifier:a,timeFrameTimeoutCache:o,options:i}=x(t);return O({options:i}),async(...c)=>P({options:i,key:R([a,JSON.stringify(c)]),timeFrameTimeoutCache:o,runningQueryCache:r,timeframeCache:n,args:c,originalMethod:e})}0&&(module.exports={CacheCandidate,CacheCandidateOptionsDefault,DataCacheRecordNotFound,RunningQueryRecordNotFound,cacheCandidate});
+"use strict";var $=Object.create;var m=Object.defineProperty;var L=Object.getOwnPropertyDescriptor;var W=Object.getOwnPropertyNames;var X=Object.getPrototypeOf,K=Object.prototype.hasOwnProperty;var b=(e,t)=>()=>(t||e((t={exports:{}}).exports,t),t.exports),B=(e,t)=>{for(var n in t)m(e,n,{get:t[n],enumerable:!0})},v=(e,t,n,r)=>{if(t&&typeof t=="object"||typeof t=="function")for(let a of W(t))!K.call(e,a)&&a!==n&&m(e,a,{get:()=>t[a],enumerable:!(r=L(t,a))||r.enumerable});return e};var g=(e,t,n)=>(n=e!=null?$(X(e)):{},v(t||!e||!e.__esModule?m(n,"default",{value:e,enumerable:!0}):n,e)),z=e=>v(m({},"__esModule",{value:!0}),e);var y=b((Fe,S)=>{"use strict";var A=Object.defineProperty,G=Object.getOwnPropertyDescriptor,V=Object.getOwnPropertyNames,Y=Object.prototype.hasOwnProperty,Z=(e,t)=>{for(var n in t)A(e,n,{get:t[n],enumerable:!0})},ee=(e,t,n,r)=>{if(t&&typeof t=="object"||typeof t=="function")for(let a of V(t))!Y.call(e,a)&&a!==n&&A(e,a,{get:()=>t[a],enumerable:!(r=G(t,a))||r.enumerable});return e},te=e=>ee(A({},"__esModule",{value:!0}),e),k={};Z(k,{Hooks:()=>F});S.exports=te(k);var F=(e=>(e.SETUP="SETUP",e.INIT="INIT",e.EXECUTION_PRE="EXECUTION_PRE",e.EXECUTION_POST="EXECUTION_POST",e.DATACACHE_RECORD_ADD_PRE="DATACACHE_RECORD_ADD_PRE",e.DATACACHE_RECORD_ADD_POST="DATACACHE_RECORD_ADD_POST",e.DATACACHE_RECORD_DELETE_PRE="DATACACHE_RECORD_DELETE_PRE",e.DATACACHE_RECORD_DELETE_POST="DATACACHE_RECORD_DELETE_POST",e.CACHE_HIT="CACHE_HIT",e))(F||{})});var M=b((Se,I)=>{"use strict";var P=Object.defineProperty,ne=Object.getOwnPropertyDescriptor,ae=Object.getOwnPropertyNames,re=Object.prototype.hasOwnProperty,oe=(e,t)=>{for(var n in t)P(e,n,{get:t[n],enumerable:!0})},ie=(e,t,n,r)=>{if(t&&typeof t=="object"||typeof t=="function")for(let a of ae(t))!re.call(e,a)&&a!==n&&P(e,a,{get:()=>t[a],enumerable:!(r=ne(t,a))||r.enumerable});return e},ce=e=>ie(P({},"__esModule",{value:!0}),e),N={};oe(N,{Hook:()=>de,hook:()=>le});I.exports=ce(N);var ue={before:()=>{},after:()=>{}},se={before:()=>{},after:()=>{}};function de(e){return function(t,n,r){let a={},o=r.value,{before:i,after:c}={...ue,...e};return r.value=function(...u){i({context:a,args:u,target:t,propertyKey:n,descriptor:r});let d=o.apply(this,u);return c({context:a,args:u,target:t,propertyKey:n,descriptor:r,result:d}),d},r}}function le(e){return function(t){let n={},{before:r,after:a}={...se,...e};return function(...o){r({context:n,args:o});let i=t(...o);return a({context:n,args:o,result:i}),i}}}});var _e={};B(_e,{CacheCandidate:()=>Re,CacheCandidateOptionsDefault:()=>T,DataCacheRecordNotFound:()=>f,RunningQueryRecordNotFound:()=>p,cacheCandidate:()=>xe});module.exports=z(_e);var w=(e=new Map)=>({get:async t=>e.get(JSON.stringify(t)),has:async t=>e.has(JSON.stringify(t)),set:async(t,n)=>e.set(JSON.stringify(t),n),delete:async t=>e.delete(JSON.stringify(t))});var T={ttl:6e5,timeFrame:3e4,requestsThreshold:3,cache:w(),keepAlive:!1,plugins:[],events:{onCacheHit:e=>e,onCacheSet:e=>e,onCacheDelete:e=>e,onBeforeFunctionExecution:e=>e,onAfterFunctionExecution:e=>e}};var f=Symbol("DataCacheRecordNotFound"),p=Symbol("RunningQueryRecordNotFound");var H=g(y());var J=require("crypto");var j=g(y()),U=g(M());async function s(e,t,n){for(let r of t){let a=r.hooks.filter(i=>i.hook===e);if(a.length>1)throw new Error(`Only one hook instance per plugin is allowed. ${r.name} has ${a.length} instances of ${e}}`);if(a.length===0)continue;let o=a[0];if(he(o))await o.action(n,r.additionalParameters);else throw new Error(`Hook ${e} for plugin ${r.name} is not actionable.`)}}function he(e){return[e.action!==void 0,typeof e.action=="function"].every(t=>t===!0)}function Q(e,t,n,r){return(0,U.hook)({before:()=>{s(e,n.plugins,r)},after:({result:a})=>{s(t,n.plugins,{...r,result:a})}})}function D({options:e}){e.plugins&&e.plugins.forEach(t=>{if(!t.hooks||!Array.isArray(t.hooks)||t.hooks.length===0)throw new Error(`Plugin ${t.name} has no hooks.`);t.hooks.forEach(n=>{if(!j.Hooks[n.hook])throw new Error(`Invalid hook ${n}`)})})}var h=g(y());function Ce(e,t){return Date.now()<e+t.timeFrame}function fe({key:e,timeframeCache:t,executionTime:n,executionEnd:r}){t.has(e)?t.get(e).push({executionTime:n,executionEnd:r}):t.set(e,[{executionEnd:r,executionTime:n}])}function me({options:e,key:t,timeframeCache:n}){if(n.has(t)){let r=n.get(t),a=r.filter(({executionEnd:o})=>Ce(o,e));r.length!==a.length&&n.set(t,a)}}function ge({key:e,runningQueryCache:t}){return t.has(e)?t.get(e):p}function O(...e){return(0,J.createHash)("sha256").update(e.join("|")).digest("hex")}function pe({birthTime:e,options:t}){return Date.now()-e>=t.ttl}async function ye({options:e,key:t,HookPayload:n}){if(await e.cache.has(t)){let{result:r,birthTime:a}=await e.cache.get(t);return pe({birthTime:a,options:e})?(await R({options:e,key:t,HookPayload:n}),f):r}return f}async function Ee({options:e,key:t,result:n}){return e.cache.set(t,{result:n,birthTime:Date.now()},e.ttl)}async function R({options:e,key:t,HookPayload:n}){Q(h.Hooks.DATACACHE_RECORD_DELETE_PRE,h.Hooks.DATACACHE_RECORD_DELETE_POST,e,n)(e.cache.delete)(t).then(()=>{e.events.onCacheDelete({key:t})})}async function q({result:e,runningQueryCache:t,key:n,executionStart:r,options:a,timeframeCache:o,timeoutCache:i,args:c,HookPayload:u}){let d=Date.now(),C=d-r;a.events.onAfterFunctionExecution({key:n,executionTime:C}),fe({key:n,timeframeCache:o,executionTime:C,executionEnd:d}),Te({options:a,key:n,timeframeCache:o,executionTime:C,args:c})>=a.requestsThreshold?(await s(h.Hooks.DATACACHE_RECORD_ADD_PRE,a.plugins,u),Ee({options:a,key:n,result:e}).then(async()=>{await s(h.Hooks.DATACACHE_RECORD_ADD_POST,a.plugins,{...u,result:e}),a.events.onCacheSet({key:n})}).finally(()=>{t.delete(n),i.set(n,setTimeout(()=>{R({options:a,key:n,HookPayload:u}),i.delete(n)},a.ttl).unref())})):t.delete(n)}function Te({options:e,key:t,timeframeCache:n,executionTime:r,args:a}){let o=0,i=n.get(t);return e.candidateFunction?o=Pe(e,r,a,i):e.millisecondThreshold?o=Ae(r,e,i):o=i.length,o}function Ae(e,t,n){let r=0;return e>t.millisecondThreshold&&(r=n.filter(a=>a.executionTime>t.millisecondThreshold).length),r}function Pe(e,t,n,r){let a=0;return e.candidateFunction({timeFrameCacheRecords:r,options:e,args:n})&&(a=e.requestsThreshold),a}function De({timeoutCache:e,key:t,options:n,HookPayload:r}){clearTimeout(e.get(t)),e.set(t,setTimeout(()=>{R({options:n,key:t,HookPayload:r}),e.delete(t)},n.ttl).unref())}function Oe(e=10){return Math.random().toString(36).substring(2,e+2)}async function x({options:e,key:t,timeoutCache:n,runningQueryCache:r,timeframeCache:a,args:o,originalMethod:i}){let c={options:{...e,plugins:void 0},key:t,timeoutCache:n,runningQueryCache:r,timeframeCache:a,fnArgs:o};await s(h.Hooks.INIT,e.plugins,c);let u=await ye({options:e,key:t,HookPayload:c});if(u!==f)return e.keepAlive&&De({timeoutCache:n,key:t,options:e,HookPayload:c}),await s(h.Hooks.CACHE_HIT,e.plugins,{...c,result:u}),e.events.onCacheHit({key:t}),Promise.resolve(u);let d=ge({key:t,runningQueryCache:r});if(d!==p)return await s(h.Hooks.CACHE_HIT,e.plugins,{...c,result:d}),d;me({options:e,key:t,timeframeCache:a}),await s(h.Hooks.EXECUTION_PRE,e.plugins,c),e.events.onBeforeFunctionExecution({key:t});let C=Date.now(),l=i(...o);return await s(h.Hooks.EXECUTION_POST,e.plugins,{...c,result:l}),l instanceof Promise?(r.set(t,l),l.then(E=>q({result:E,runningQueryCache:r,key:t,executionStart:C,options:e,timeframeCache:a,timeoutCache:n,args:o,HookPayload:c})),l):(q({result:l,runningQueryCache:r,key:t,executionStart:C,options:e,timeframeCache:a,timeoutCache:n,args:o,HookPayload:c}),l)}function _(e){let t=new Map,n=new Map,r=Oe(),a=new Map,o={...T,...e};return{timeframeCache:t,runningQueryCache:n,uniqueIdentifier:r,timeoutCache:a,options:o}}function Re(e={}){let{timeframeCache:t,runningQueryCache:n,uniqueIdentifier:r,timeoutCache:a,options:o}=_(e);return D({options:o}),s(H.Hooks.SETUP,o.plugins,{options:{...o,plugins:void 0},key:"",timeoutCache:a,runningQueryCache:n,timeframeCache:t,fnArgs:[]}),function(i,c,u){let d=u.value;u.value=async function(...C){let l=i.constructor.name+JSON.stringify(this),E=O([c,r,l,JSON.stringify(C)]);return x({options:o,key:E,timeoutCache:a,runningQueryCache:n,timeframeCache:t,args:C,originalMethod:d})}}}function xe(e,t={}){let{timeframeCache:n,runningQueryCache:r,uniqueIdentifier:a,timeoutCache:o,options:i}=_(t);return D({options:i}),s(H.Hooks.SETUP,i.plugins,{options:{...i,plugins:void 0},key:"",timeoutCache:o,runningQueryCache:r,timeframeCache:n,fnArgs:[]}),async(...c)=>x({options:i,key:O([a,JSON.stringify(c)]),timeoutCache:o,runningQueryCache:r,timeframeCache:n,args:c,originalMethod:e})}0&&(module.exports={CacheCandidate,CacheCandidateOptionsDefault,DataCacheRecordNotFound,RunningQueryRecordNotFound,cacheCandidate});

package/dist/internal.d.ts

@@ -1,10 +1,10 @@
-import { CacheCandidateOptions, TimeFrameTimeoutCache, RunningQueryCache, TimeFrameCache } from './models';
+import { CacheCandidateOptions, TimeoutCache, RunningQueryCache, TimeFrameCache } from './models';
 export declare function getDataCacheKey(...args: any[]): string;
 export declare function uniqid(length?: number): string;
-export declare function letsCandidate({ options, key, timeFrameTimeoutCache, runningQueryCache, timeframeCache, args, originalMethod }: {
+export declare function letsCandidate({ options, key, timeoutCache, runningQueryCache, timeframeCache, args, originalMethod }: {
     options: CacheCandidateOptions;
     key: string;
-    timeFrameTimeoutCache: TimeFrameTimeoutCache;
+    timeoutCache: TimeoutCache;
     runningQueryCache: RunningQueryCache;
     timeframeCache: TimeFrameCache;
     args: any[];
@@ -14,6 +14,6 @@ export declare function getInitialState(_options: Partial<CacheCandidateOptions>
     timeframeCache: TimeFrameCache;
     runningQueryCache: RunningQueryCache;
     uniqueIdentifier: string;
-    timeFrameTimeoutCache: TimeFrameTimeoutCache;
+    timeoutCache: TimeoutCache;
     options: CacheCandidateOptions;
 };

package/dist/models.d.ts

@@ -10,6 +10,7 @@ export interface CacheCandidateCacheAdapter {
     set: (key: string, value: any, ttl: number) => Promise<any>;
     has: (key: string) => Promise<boolean>;
     delete: (key: string) => Promise<boolean>;
+    [key: string]: any;
 }
 export interface CacheCandidateOptions {
     ttl: number;
@@ -49,6 +50,6 @@ export interface TimeFrameCacheRecord {
 }
 export type TimeFrameCache = Map<string, Array<TimeFrameCacheRecord>>;
 export type RunningQueryCache = Map<string, Promise<any>>;
-export type TimeFrameTimeoutCache = Map<string, NodeJS.Timeout>;
+export type TimeoutCache = Map<string, NodeJS.Timeout>;
 export declare const DataCacheRecordNotFound: unique symbol;
 export declare const RunningQueryRecordNotFound: unique symbol;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@jointly/cache-candidate",
   "private": false,
-  "version": "1.1.5",
+  "version": "1.3.0",
   "main": "dist/index.js",
   "module": "dist/index.js",
   "types": "dist/index.d.ts",