@gorgonjs/gorgon 1.4.1 → 1.5.0

package/dist/index.umd.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.umd.js","sources":["../provider/memory.ts","../index.ts"],"sourcesContent":["import {IGorgonCacheProvider, GorgonPolicySanitized} from '../index';\n\ninterface IGorgonMemoryCacheProvider extends IGorgonCacheProvider {\n  _clear: (key:string) => boolean;\n}\n\n// Created as a function to allow for multiple instances of the memory cache, if needed\nconst MemoryCacheCreator = ():IGorgonMemoryCacheProvider =>{\n\n  const cache = {};\n  const hOP = cache.hasOwnProperty;\n\n// Memory cache is about the simplist cache possible, use it as an example\n  const memoryCache = {\n\n    init: async() => {\n    // This should be used to update the cache on boot,\n    // memory cache will be blank on boot by default\n      return;\n    },\n\n    get: async(key:string) => {\n\n      if (hOP.call(cache, key) && cache[key].val) {\n      // The cached item exists, return it\n        return cache[key].val;\n      } else {\n      // The cached item does not exist reject\n        return undefined;\n      }\n\n    },\n\n    set: async(key:string, value:any, policy: GorgonPolicySanitized) => {\n\n    // Clear in case it exists\n      await  memoryCache.clear(key);\n\n    // Set a timemout to self-remove from the cache if in policy\n      var to = false as boolean | number;\n\n      if (policy && policy.expiry && policy.expiry > 0) {\n        to = setTimeout(function() {\n          memoryCache.clear(key);\n        }, policy.expiry);\n      }\n\n    // Store the cached item\n      cache[key] = {\n        policy: policy,\n        val: value,\n        to: to,\n      };\n\n      return value;\n\n    },\n\n    keys: async() => {\n      return Object.keys(cache);\n    },\n\n    clear: async(key?:string) => {\n\n    // Clears a single key or complete clear on empty\n    // Clear all items in the cache\n      if (!key) {\n        for (var i in cache) {\n          memoryCache._clear(i);\n        }\n        return true;\n      }\n\n      return memoryCache._clear(key);\n    },\n\n    _clear: (key:string) => {\n    // Clear a single item, making sure to remove the extra timeout\n      if (hOP.call(cache, key)) {\n        if (cache[key].to) {\n          clearTimeout(cache[key].to);\n        }\n\n        cache[key] = null;\n        delete cache[key];\n        return true;\n      }\n\n      return false;\n    },\n\n  };\n\n  return memoryCache;\n\n}\n\nexport default MemoryCacheCreator;\n","import MemoryCache from './provider/memory';\n\nexport type asyncFunction = () => Promise<any> | (() => any);\nexport type GorgonSettings = {\n  debug: boolean;\n  defaultProvider: string;\n  retry: number;\n}\nexport type GorgonSettingsInput = {\n  debug?: boolean;\n  defaultProvider?: string;\n  retry?: number;\n}\nexport type GorgonPolicy = {\n  expiry: number | Date | false;\n  provider: string;\n};\nexport type GorgonPolicyInput = GorgonPolicy | number | Date;\nexport type GorgonPolicySanitized = {\n  expiry: number | false;\n  provider: string;\n};\ntype GorgonCurrentTaskItem = Array<{\n  res?: any;\n  rej?: any;\n  queued: Date;\n}>;\nexport interface IGorgonCacheProvider {\n  init: () => Promise<void>;\n  get: (key: string) => Promise<any>;\n  set: <R>(key: string, value: R, policy: GorgonPolicySanitized) => Promise<R>;\n  clear: (key?: string) => Promise<boolean>;\n  keys: () => Promise<string[]>;\n}\n\nconst Gorgon = (() => {\n\n  const currentTasks = {} as {[key: string]: GorgonCurrentTaskItem};\n  const hOP = currentTasks.hasOwnProperty;\n\n  const settings = {\n    debug: false,\n    defaultProvider: 'memory',\n    retry: 5000,\n  } as GorgonSettings;\n\n  const policyMaker = function(incPolicy?: GorgonPolicyInput) {\n    const outPolicy = {\n      expiry: false,\n      provider: settings.defaultProvider,\n    } as GorgonPolicySanitized;\n\n    // Blank policy, false, or no policy. lets store forever\n    if (!incPolicy) {\n      return outPolicy;\n    }\n\n    // Type is a full policy object\n    if(incPolicy instanceof Date) {\n      var d = new Date();\n\n      outPolicy.expiry = Math.ceil((incPolicy.getTime() - d.getTime()) / 1000);\n    }else if (typeof incPolicy === 'object' && incPolicy.expiry) {\n      if(incPolicy.expiry instanceof Date) {\n        outPolicy.expiry = Math.ceil((incPolicy.expiry.getTime() - d.getTime()) / 1000);\n      }else{\n        outPolicy.expiry = incPolicy.expiry;\n      }\n      outPolicy.provider = incPolicy.provider || outPolicy.provider;\n    } else if(typeof incPolicy === 'object') {\n      outPolicy.provider = incPolicy.provider || outPolicy.provider;\n    } else if(typeof incPolicy === 'number') {\n      outPolicy.expiry = incPolicy;\n    }\n\n    // Number is too small, negative or not a number\n    outPolicy.expiry = outPolicy.expiry && outPolicy.expiry > 0 ? outPolicy.expiry : false;\n\n    return outPolicy;\n  };\n\n  const gorgonCore = {\n\n    // Providers available for use\n    providers: {} as {[key: string]: IGorgonCacheProvider},\n\n    // Allows for settings on the gorgon cache\n    settings: (newSettings?: GorgonSettingsInput) => {\n      if (!newSettings) {\n        return settings;\n      }\n\n      Object.assign(settings, newSettings); // only overwrite ones sent in; keep others at existing\n\n      return settings;\n    },\n\n    // Add a provider\n    addProvider: (name: string, provider:IGorgonCacheProvider) => {\n      provider.init(); // Trigger for provider to clear any old cache items or any other cleanup\n      gorgonCore.providers[name] = provider;\n    },\n\n    // Place an item into the cache\n    put: async<R>(key:string, value:R, policy?: GorgonPolicyInput):Promise<R> => {\n      policy = policyMaker(policy);\n      var prov = gorgonCore.providers[policy.provider];\n\n      return prov.set(key, value, policyMaker(policy));\n    },\n\n        // Clear one or all items in the cache\n    clear: async(key: string, provider?: string) => {\n\n      var prov = gorgonCore.providers[provider || settings.defaultProvider];\n\n      // Clear a wildcard search of objects\n      if (key && key.indexOf('*') > -1) {\n        return prov.keys().then(function(keys) {\n          var cacheMatchKeys = keys.filter(function(str) {\n            return new RegExp('^' + key.split('*').join('.*') + '$').test(str);\n          });\n\n          var clearPromises = cacheMatchKeys.map(prov.clear);\n          // Incase someone somehow used a wildcard in their cached key (don't do this)\n\n          clearPromises.push(prov.clear(key));\n          return Promise.all(clearPromises);\n        });\n      }\n\n      // Not a special clear\n      return prov.clear(key);\n\n    },\n\n    // Clear all keys/values in the cache\n    clearAll: async(provider?: string) => {\n      var prov = gorgonCore.providers[provider || settings.defaultProvider];\n\n      return prov.clear();\n    },\n\n    // Allows you to instantly overwite a cache object\n    overwrite: async(key:string, asyncFunc: asyncFunction, policy?: GorgonPolicyInput) => {\n\n      try{\n        const resolvedData = await asyncFunc();\n\n        const val = await gorgonCore.put(key, resolvedData, policyMaker(policy));\n\n        return val;\n      }catch (e) {\n        throw e;\n      }\n\n    },\n\n    // Allows you to get from the cache or pull from the promise\n    get: async<R>(key:string, asyncFunc:() => R, policy?: GorgonPolicyInput):Promise<R> => {\n\n      policy = policyMaker(policy);\n      const prov = gorgonCore.providers[policy.provider];\n\n      const currentVal = await prov.get(key); // Most providers will only lookup by key and return false on not found\n\n      // If we have a current value sent it out; cache hit!\n      if(currentVal !== undefined) {\n        if(settings.debug) {console.info('[Gorgon] Cache hit for key: ' + key, currentVal);}\n        return currentVal;\n      }\n\n      // Are we currently already running this cache item?\n      if (hOP.call(currentTasks, key) && Array.isArray(currentTasks[key]) && currentTasks[key].length > 0) {\n        // Add to the current task, but ignore if any items is below retry anyway threshold\n        var oldQueue = false;\n\n        for (var i in currentTasks[key]) {\n          if(currentTasks[key][i].queued < new Date(Date.now() - settings.retry)) {\n            oldQueue = true;\n          }\n        }\n\n        // Add to the current queue\n        if(!oldQueue) {\n          if(settings.debug) {console.info('[Gorgon] Cache miss, in progress, adding to current queue for key: ' + key);}\n\n          var concurent = new Promise(function(resolve: (value: R) => void, reject) {\n            currentTasks[key].push({\n              res: resolve,\n              rej: reject,\n              queued: new Date(),\n            });\n          });\n\n          return concurent;\n        }\n      }else{\n        // Add current task to list, this is the first one so the primary\n        currentTasks[key] = [{queued: new Date()}];\n      }\n\n      try{\n        if(settings.debug) {console.info('[Gorgon] Cache miss, resolving item for: ' + key);}\n\n        // This is the primary item, lets resolve and push it out\n        const resolvedData = await asyncFunc();\n\n        if(settings.debug) {console.info('[Gorgon] Cache resolved, resolved item for: ' + key, resolvedData);}\n\n        const val = await gorgonCore.put(key, resolvedData, policyMaker(policy));\n\n        if (hOP.call(currentTasks, key)) {\n          for (var i in currentTasks[key]) {\n            if(currentTasks[key][i].res) {\n              if(settings.debug) {console.info('[Gorgon] Cache queue resolved for: ' + key, resolvedData);}\n\n              currentTasks[key][i].res(val);\n            }\n          }\n\n          currentTasks[key] = [];\n          delete currentTasks[key];\n        }\n\n        return val;\n\n      }catch (e) {\n        if (hOP.call(currentTasks, key)) {\n          for (var i in currentTasks[key]) {\n            if(currentTasks[key][i].rej) {\n              currentTasks[key][i].rej(e);\n            }\n          }\n\n          currentTasks[key] = [];\n          delete currentTasks[key];\n        }\n\n        throw e;\n      }\n\n    },\n\n\n  };\n\n  gorgonCore.addProvider('memory', MemoryCache()); // Default provider, light weight and simple\n\n  return gorgonCore;\n\n})();\n\nexport {MemoryCache};\nexport default Gorgon;\n"],"names":["MemoryCacheCreator","cache","hOP","memoryCache","key","value","policy","to","Gorgon","currentTasks","settings","policyMaker","incPolicy","outPolicy","d","gorgonCore","newSettings","name","provider","prov","keys","cacheMatchKeys","str","clearPromises","asyncFunc","resolvedData","e","currentVal","oldQueue","i","concurent","resolve","reject","val","MemoryCache"],"mappings":"8NAOM,MAAAA,EAAqB,IAAgC,CAEzD,MAAMC,EAAQ,CAAA,EACRC,EAAMD,EAAM,eAGZE,EAAc,CAElB,KAAM,SAAW,CAIjB,EAEA,IAAK,MAAMC,GAAe,CAEpB,GAAAF,EAAI,KAAKD,EAAOG,CAAG,GAAKH,EAAMG,CAAG,EAAE,IAE9B,OAAAH,EAAMG,CAAG,EAAE,GAMtB,EAEA,IAAK,MAAMA,EAAYC,EAAWC,IAAkC,CAG3D,MAAAH,EAAY,MAAMC,CAAG,EAG5B,IAAIG,EAAK,GAET,OAAID,GAAUA,EAAO,QAAUA,EAAO,OAAS,IAC7CC,EAAK,WAAW,UAAW,CACzBJ,EAAY,MAAMC,CAAG,CAAA,EACpBE,EAAO,MAAM,GAIlBL,EAAMG,CAAG,EAAI,CACX,OAAAE,EACA,IAAKD,EACL,GAAAE,CAAA,EAGKF,CAET,EAEA,KAAM,SACG,OAAO,KAAKJ,CAAK,EAG1B,MAAO,MAAMG,GAAgB,CAI3B,GAAI,CAACA,EAAK,CACR,QAAS,KAAKH,EACZE,EAAY,OAAO,CAAC,EAEf,MAAA,EACT,CAEO,OAAAA,EAAY,OAAOC,CAAG,CAC/B,EAEA,OAASA,GAEHF,EAAI,KAAKD,EAAOG,CAAG,GACjBH,EAAMG,CAAG,EAAE,IACA,aAAAH,EAAMG,CAAG,EAAE,EAAE,EAG5BH,EAAMG,CAAG,EAAI,KACb,OAAOH,EAAMG,CAAG,EACT,IAGF,EACT,EAIK,OAAAD,CAET,EC5DMK,GAAU,IAAM,CAEpB,MAAMC,EAAe,CAAA,EACfP,EAAMO,EAAa,eAEnBC,EAAW,CACf,MAAO,GACP,gBAAiB,SACjB,MAAO,GAAA,EAGHC,EAAc,SAASC,EAA+B,CAC1D,MAAMC,EAAY,CAChB,OAAQ,GACR,SAAUH,EAAS,eAAA,EAIrB,GAAI,CAACE,EACI,OAAAC,EAIT,GAAGD,aAAqB,KAAM,CACxB,IAAAE,MAAQ,KAEFD,EAAA,OAAS,KAAK,MAAMD,EAAU,UAAYE,EAAE,QAAQ,GAAK,GAAI,CAC/D,MAAA,OAAOF,GAAc,UAAYA,EAAU,QAChDA,EAAU,kBAAkB,KACnBC,EAAA,OAAS,KAAK,MAAMD,EAAU,OAAO,QAAY,EAAAE,EAAE,QAAQ,GAAK,GAAI,EAE9ED,EAAU,OAASD,EAAU,OAErBC,EAAA,SAAWD,EAAU,UAAYC,EAAU,UAC7C,OAAOD,GAAc,SACnBC,EAAA,SAAWD,EAAU,UAAYC,EAAU,SAC7C,OAAOD,GAAc,WAC7BC,EAAU,OAASD,GAIrB,OAAAC,EAAU,OAASA,EAAU,QAAUA,EAAU,OAAS,EAAIA,EAAU,OAAS,GAE1EA,CAAA,EAGHE,EAAa,CAGjB,UAAW,CAAC,EAGZ,SAAWC,IACJA,GAIE,OAAA,OAAON,EAAUM,CAAW,EAE5BN,GAIT,YAAa,CAACO,EAAcC,IAAkC,CAC5DA,EAAS,KAAK,EACHH,EAAA,UAAUE,CAAI,EAAIC,CAC/B,EAGA,IAAK,MAASd,EAAYC,EAASC,IAA0C,CAC3EA,EAASK,EAAYL,CAAM,EAC3B,IAAIa,EAAOJ,EAAW,UAAUT,EAAO,QAAQ,EAE/C,OAAOa,EAAK,IAAIf,EAAKC,EAAOM,EAAYL,CAAM,CAAC,CACjD,EAGA,MAAO,MAAMF,EAAac,IAAsB,CAE9C,IAAIC,EAAOJ,EAAW,UAAUG,GAAYR,EAAS,eAAe,EAGpE,OAAIN,GAAOA,EAAI,QAAQ,GAAG,EAAI,GACrBe,EAAK,KAAA,EAAO,KAAK,SAASC,EAAM,CACrC,IAAIC,EAAiBD,EAAK,OAAO,SAASE,EAAK,CAC7C,OAAO,IAAI,OAAO,IAAMlB,EAAI,MAAM,GAAG,EAAE,KAAK,IAAI,EAAI,GAAG,EAAE,KAAKkB,CAAG,CAAA,CAClE,EAEGC,EAAgBF,EAAe,IAAIF,EAAK,KAAK,EAGjD,OAAAI,EAAc,KAAKJ,EAAK,MAAMf,CAAG,CAAC,EAC3B,QAAQ,IAAImB,CAAa,CAAA,CACjC,EAIIJ,EAAK,MAAMf,CAAG,CAEvB,EAGA,SAAU,MAAMc,GAAsB,CACpC,IAAIC,EAAOJ,EAAW,UAAUG,GAAYR,EAAS,eAAe,EAEpE,OAAOS,EAAK,OACd,EAGA,UAAW,MAAMf,EAAYoB,EAA0BlB,IAA+B,CAEjF,GAAA,CACK,MAAAmB,EAAe,MAAMD,IAIpB,OAFK,MAAMT,EAAW,IAAIX,EAAKqB,EAAcd,EAAYL,CAAM,CAAC,QAGjEoB,EAAG,CACH,MAAAA,CACR,CAEF,EAGA,IAAK,MAAStB,EAAYoB,EAAmBlB,IAA0C,CAErFA,EAASK,EAAYL,CAAM,EAG3B,MAAMqB,EAAa,MAFNZ,EAAW,UAAUT,EAAO,QAAQ,EAEnB,IAAIF,CAAG,EAGrC,GAAGuB,IAAe,OAChB,OAAGjB,EAAS,OAAgB,QAAA,KAAK,+BAAiCN,EAAKuB,CAAU,EAC1EA,EAIT,GAAIzB,EAAI,KAAKO,EAAcL,CAAG,GAAK,MAAM,QAAQK,EAAaL,CAAG,CAAC,GAAKK,EAAaL,CAAG,EAAE,OAAS,EAAG,CAEnG,IAAIwB,EAAW,GAEN,QAAAC,KAAKpB,EAAaL,CAAG,EACzBK,EAAaL,CAAG,EAAEyB,CAAC,EAAE,OAAS,IAAI,KAAK,KAAK,IAAA,EAAQnB,EAAS,KAAK,IACxDkB,EAAA,IAKf,GAAG,CAACA,EAAU,CACTlB,EAAS,OAAgB,QAAA,KAAK,sEAAwEN,CAAG,EAE5G,IAAI0B,EAAY,IAAI,QAAQ,SAASC,EAA6BC,EAAQ,CAC3DvB,EAAAL,CAAG,EAAE,KAAK,CACrB,IAAK2B,EACL,IAAKC,EACL,WAAY,IAAK,CAClB,CAAA,CACF,EAEM,OAAAF,CACT,CAAA,MAGarB,EAAAL,CAAG,EAAI,CAAC,CAAC,OAAY,IAAA,KAAO,EAGxC,GAAA,CACEM,EAAS,OAAgB,QAAA,KAAK,4CAA8CN,CAAG,EAG5E,MAAAqB,EAAe,MAAMD,IAExBd,EAAS,OAAgB,QAAA,KAAK,+CAAiDN,EAAKqB,CAAY,EAE7F,MAAAQ,EAAM,MAAMlB,EAAW,IAAIX,EAAKqB,EAAcd,EAAYL,CAAM,CAAC,EAEvE,GAAIJ,EAAI,KAAKO,EAAcL,CAAG,EAAG,CACtB,QAAAyB,KAAKpB,EAAaL,CAAG,EACzBK,EAAaL,CAAG,EAAEyB,CAAC,EAAE,MACnBnB,EAAS,OAAgB,QAAA,KAAK,sCAAwCN,EAAKqB,CAAY,EAE1FhB,EAAaL,CAAG,EAAEyB,CAAC,EAAE,IAAII,CAAG,GAInBxB,EAAAL,CAAG,EAAI,GACpB,OAAOK,EAAaL,CAAG,CACzB,CAEO,OAAA6B,QAEDP,EAAG,CACT,GAAIxB,EAAI,KAAKO,EAAcL,CAAG,EAAG,CACtB,QAAAyB,KAAKpB,EAAaL,CAAG,EACzBK,EAAaL,CAAG,EAAEyB,CAAC,EAAE,KACtBpB,EAAaL,CAAG,EAAEyB,CAAC,EAAE,IAAIH,CAAC,EAIjBjB,EAAAL,CAAG,EAAI,GACpB,OAAOK,EAAaL,CAAG,CACzB,CAEM,MAAAsB,CACR,CAEF,CAAA,EAKS,OAAAX,EAAA,YAAY,SAAUmB,EAAa,CAAA,EAEvCnB,CAET,GAAG"}
+{"version":3,"file":"index.umd.js","sources":["../provider/memory.ts","../index.ts"],"sourcesContent":["import {IGorgonCacheProvider, GorgonPolicySanitized} from '../index';\n\ninterface IGorgonMemoryCacheProvider extends IGorgonCacheProvider {\n  _clear: (key:string) => boolean;\n}\n\n// Created as a function to allow for multiple instances of the memory cache, if needed\nconst MemoryCacheCreator = ():IGorgonMemoryCacheProvider =>{\n\n  const cache = {};\n  const hOP = cache.hasOwnProperty;\n\n// Memory cache is about the simplist cache possible, use it as an example\n  const memoryCache = {\n\n    init: async() => {\n    // This should be used to update the cache on boot,\n    // memory cache will be blank on boot by default\n      return;\n    },\n\n    get: async(key:string) => {\n\n      if (hOP.call(cache, key) && cache[key].val) {\n      // The cached item exists, return it\n        return cache[key].val;\n      } else {\n      // The cached item does not exist reject\n        return undefined;\n      }\n\n    },\n\n    set: async(key:string, value:any, policy: GorgonPolicySanitized) => {\n\n    // Clear in case it exists\n      await  memoryCache.clear(key);\n\n    // Set a timemout to self-remove from the cache if in policy\n      var to = false as boolean | number;\n\n      if (policy && policy.expiry && policy.expiry > 0) {\n        to = setTimeout(function() {\n          memoryCache.clear(key);\n        }, policy.expiry);\n      }\n\n    // Store the cached item\n      cache[key] = {\n        policy: policy,\n        val: value,\n        to: to,\n      };\n\n      return value;\n\n    },\n\n    keys: async() => {\n      return Object.keys(cache);\n    },\n\n    clear: async(key?:string) => {\n\n    // Clears a single key or complete clear on empty\n    // Clear all items in the cache\n      if (!key) {\n        for (var i in cache) {\n          memoryCache._clear(i);\n        }\n        return true;\n      }\n\n      return memoryCache._clear(key);\n    },\n\n    _clear: (key:string) => {\n    // Clear a single item, making sure to remove the extra timeout\n      if (hOP.call(cache, key)) {\n        if (cache[key].to) {\n          clearTimeout(cache[key].to);\n        }\n\n        cache[key] = null;\n        delete cache[key];\n        return true;\n      }\n\n      return false;\n    },\n\n  };\n\n  return memoryCache;\n\n}\n\nexport default MemoryCacheCreator;\n","import MemoryCache from './provider/memory';\n\nexport type asyncFunction = () => Promise<any> | (() => any);\nexport type GorgonHookKey =\n  | 'settings'\n  | 'addProvider'\n  | 'put'\n  | 'clear'\n  | 'clearAll'\n  | 'overwrite'\n  | 'get'\n  | 'valueError';\nexport type GorgonHook = (key: GorgonHookKey, input?: any, output?: any) => void;\nexport type GorgonSettings = {\n  debug: boolean;\n  defaultProvider: string;\n  retry: number;\n};\nexport type GorgonSettingsInput = {\n  debug?: boolean;\n  defaultProvider?: string;\n  retry?: number;\n};\nexport type GorgonPolicy = {\n  expiry: number | Date | false;\n  provider: string;\n};\nexport type GorgonPolicyInput = GorgonPolicy | number | Date;\nexport type GorgonPolicySanitized = {\n  expiry: number | false;\n  provider: string;\n};\ntype GorgonCurrentTaskItem = Array<{\n  res?: any;\n  rej?: any;\n  queued: Date;\n}>;\nexport interface IGorgonCacheProvider {\n  init: () => Promise<void>;\n  get: (key: string) => Promise<any>;\n  set: <R>(key: string, value: R, policy: GorgonPolicySanitized) => Promise<R>;\n  clear: (key?: string) => Promise<boolean>;\n  keys: () => Promise<string[]>;\n}\n\nconst Gorgon = (() => {\n  const currentTasks = {} as { [key: string]: GorgonCurrentTaskItem };\n  const hOP = currentTasks.hasOwnProperty;\n\n  const settings = {\n    debug: false,\n    defaultProvider: 'memory',\n    retry: 5000,\n  } as GorgonSettings;\n\n  const policyMaker = function (incPolicy?: GorgonPolicyInput) {\n    const outPolicy = {\n      expiry: false,\n      provider: settings.defaultProvider,\n    } as GorgonPolicySanitized;\n\n    // Blank policy, false, or no policy. lets store forever\n    if (!incPolicy) {\n      return outPolicy;\n    }\n\n    // Type is a full policy object\n    if (incPolicy instanceof Date) {\n      var d = new Date();\n\n      outPolicy.expiry = Math.ceil((incPolicy.getTime() - d.getTime()) / 1000);\n    } else if (typeof incPolicy === 'object' && incPolicy.expiry) {\n      if (incPolicy.expiry instanceof Date) {\n        outPolicy.expiry = Math.ceil((incPolicy.expiry.getTime() - d.getTime()) / 1000);\n      } else {\n        outPolicy.expiry = incPolicy.expiry;\n      }\n      outPolicy.provider = incPolicy.provider || outPolicy.provider;\n    } else if (typeof incPolicy === 'object') {\n      outPolicy.provider = incPolicy.provider || outPolicy.provider;\n    } else if (typeof incPolicy === 'number') {\n      outPolicy.expiry = incPolicy;\n    }\n\n    // Number is too small, negative or not a number\n    outPolicy.expiry = outPolicy.expiry && outPolicy.expiry > 0 ? outPolicy.expiry : false;\n\n    return outPolicy;\n  };\n\n  const gorgonCore = {\n    // Providers available for use\n    providers: {} as { [key: string]: IGorgonCacheProvider },\n\n    // Hooks\n    hooks: {} as { [key: string]: Array<GorgonHook> },\n\n    _callHooks: (key: GorgonHookKey, input?: any, output?: any) => {\n      if (hOP.call(gorgonCore.hooks, key)) {\n        for (var i in gorgonCore.hooks[key]) {\n          if (typeof gorgonCore.hooks[key][i] === 'function') {\n            try {\n              gorgonCore.hooks[key][i](key, input, output);\n            } catch (e) {\n              console.error('[Gorgon] Hook error for hook: ' + key, e);\n            }\n          }\n        }\n      }\n    },\n\n    // Allows for settings on the gorgon cache\n    settings: (newSettings?: GorgonSettingsInput) => {\n      if (!newSettings) {\n        return settings;\n      }\n\n      Object.assign(settings, newSettings); // only overwrite ones sent in; keep others at existing\n\n      gorgonCore._callHooks('settings', newSettings, settings);\n\n      return settings;\n    },\n\n    // add a hook or array of hooks\n    addHook: (key: GorgonHookKey, hook: GorgonHook | Array<GorgonHook>) => {\n      if (!hOP.call(gorgonCore.hooks, key)) {\n        gorgonCore.hooks[key] = [];\n      }\n\n      if (Array.isArray(hook)) {\n        gorgonCore.hooks[key] = gorgonCore.hooks[key].concat(hook);\n      } else {\n        gorgonCore.hooks[key].push(hook);\n      }\n    },\n\n    // Add a provider\n    addProvider: (name: string, provider: IGorgonCacheProvider) => {\n      provider.init(); // Trigger for provider to clear any old cache items or any other cleanup\n      gorgonCore.providers[name] = provider;\n\n      gorgonCore._callHooks('addProvider', { name, provider });\n    },\n\n    // Place an item into the cache\n    put: async <R>(key: string, value: R, policy?: GorgonPolicyInput): Promise<R> => {\n      policy = policyMaker(policy);\n      var prov = gorgonCore.providers[policy.provider];\n\n      gorgonCore._callHooks('put', { key, value, policy }, value);\n\n      return prov.set(key, value, policyMaker(policy));\n    },\n\n    // Clear one or all items in the cache\n    clear: async (key: string, provider?: string) => {\n      var prov = gorgonCore.providers[provider || settings.defaultProvider];\n\n      gorgonCore._callHooks('clear', { key, provider });\n\n      // Clear a wildcard search of objects\n      if (key && key.indexOf('*') > -1) {\n        return prov.keys().then(function (keys) {\n          var cacheMatchKeys = keys.filter(function (str) {\n            return new RegExp('^' + key.split('*').join('.*') + '$').test(str);\n          });\n\n          var clearPromises = cacheMatchKeys.map(prov.clear);\n          // Incase someone somehow used a wildcard in their cached key (don't do this)\n\n          clearPromises.push(prov.clear(key));\n          return Promise.all(clearPromises);\n        });\n      }\n\n      // Not a special clear\n      return prov.clear(key);\n    },\n\n    // Clear all keys/values in the cache\n    clearAll: async (provider?: string) => {\n      var prov = gorgonCore.providers[provider || settings.defaultProvider];\n\n      gorgonCore._callHooks('clearAll', { provider });\n\n      return prov.clear();\n    },\n\n    // Allows you to instantly overwite a cache object\n    overwrite: async (key: string, asyncFunc: asyncFunction, policy?: GorgonPolicyInput) => {\n      try {\n        const resolvedData = await asyncFunc();\n\n        const val = await gorgonCore.put(key, resolvedData, policyMaker(policy));\n\n        gorgonCore._callHooks('overwrite', { key, asyncFunc, policy }, val);\n\n        return val;\n      } catch (e) {\n        throw e;\n      }\n    },\n\n    // Allows you to get from the cache or pull from the promise\n    get: async <R>(key: string, asyncFunc: () => R, policy?: GorgonPolicyInput): Promise<R> => {\n      policy = policyMaker(policy);\n      const prov = gorgonCore.providers[policy.provider];\n\n      const currentVal = await prov.get(key); // Most providers will only lookup by key and return false on not found\n\n      // If we have a current value sent it out; cache hit!\n      if (currentVal !== undefined) {\n        if (settings.debug) {\n          console.info('[Gorgon] Cache hit for key: ' + key, currentVal);\n        }\n\n        gorgonCore._callHooks('get', { key, asyncFunc, policy, cacheHit: true, queued: false }, currentVal);\n\n        return currentVal;\n      }\n\n      // Are we currently already running this cache item?\n      if (hOP.call(currentTasks, key) && Array.isArray(currentTasks[key]) && currentTasks[key].length > 0) {\n        // Add to the current task, but ignore if any items is below retry anyway threshold\n        var oldQueue = false;\n\n        for (var i in currentTasks[key]) {\n          if (currentTasks[key][i].queued < new Date(Date.now() - settings.retry)) {\n            oldQueue = true;\n          }\n        }\n\n        // Add to the current queue\n        if (!oldQueue) {\n          if (settings.debug) {\n            console.info('[Gorgon] Cache miss, in progress, adding to current queue for key: ' + key);\n          }\n\n          var concurent = new Promise(function (resolve: (value: R) => void, reject) {\n            currentTasks[key].push({\n              res: resolve,\n              rej: reject,\n              queued: new Date(),\n            });\n          });\n\n          gorgonCore._callHooks('get', { key, asyncFunc, policy, cacheHit: false, queued: true }, concurent);\n\n          return concurent;\n        }\n      } else {\n        // Add current task to list, this is the first one so the primary\n        currentTasks[key] = [{ queued: new Date() }];\n      }\n\n      try {\n        if (settings.debug) {\n          console.info('[Gorgon] Cache miss, resolving item for: ' + key);\n        }\n\n        // This is the primary item\n        const resolver = asyncFunc();\n\n        gorgonCore._callHooks('get', { key, asyncFunc, policy, cacheHit: false, queued: false }, resolver);\n\n        // wait for it to finish then push it out\n        const resolvedData = await resolver;\n\n        if (settings.debug) {\n          console.info('[Gorgon] Cache resolved, resolved item for: ' + key, resolvedData);\n        }\n\n        const val = await gorgonCore.put(key, resolvedData, policyMaker(policy));\n\n        if (hOP.call(currentTasks, key)) {\n          for (var i in currentTasks[key]) {\n            if (currentTasks[key][i].res) {\n              if (settings.debug) {\n                console.info('[Gorgon] Cache queue resolved for: ' + key, resolvedData);\n              }\n\n              currentTasks[key][i].res(val);\n            }\n          }\n\n          currentTasks[key] = [];\n          delete currentTasks[key];\n        }\n\n        return val;\n      } catch (e) {\n        if (hOP.call(currentTasks, key)) {\n          for (var i in currentTasks[key]) {\n            if (currentTasks[key][i].rej) {\n              currentTasks[key][i].rej(e);\n            }\n          }\n\n          gorgonCore._callHooks('valueError', { key, asyncFunc, policy, cacheHit: false, queued: false }, e);\n\n          currentTasks[key] = [];\n          delete currentTasks[key];\n        }\n\n        throw e;\n      }\n    },\n  };\n\n  gorgonCore.addProvider('memory', MemoryCache()); // Default provider, light weight and simple\n\n  return gorgonCore;\n})();\n\nexport { MemoryCache };\nexport default Gorgon;\n"],"names":["MemoryCacheCreator","cache","hOP","memoryCache","key","value","policy","to","i","Gorgon","currentTasks","settings","policyMaker","incPolicy","outPolicy","d","gorgonCore","input","output","e","newSettings","hook","name","provider","prov","keys","cacheMatchKeys","str","clearPromises","asyncFunc","resolvedData","val","currentVal","oldQueue","concurent","resolve","reject","resolver","MemoryCache"],"mappings":"8NAOM,MAAAA,EAAqB,IAAgC,CAEzD,MAAMC,EAAQ,CAAA,EACRC,EAAMD,EAAM,eAGZE,EAAc,CAElB,KAAM,SAAW,CAIjB,EAEA,IAAK,MAAMC,GAAe,CAEpB,GAAAF,EAAI,KAAKD,EAAOG,CAAG,GAAKH,EAAMG,CAAG,EAAE,IAE9B,OAAAH,EAAMG,CAAG,EAAE,GAMtB,EAEA,IAAK,MAAMA,EAAYC,EAAWC,IAAkC,CAG3D,MAAAH,EAAY,MAAMC,CAAG,EAG5B,IAAIG,EAAK,GAET,OAAID,GAAUA,EAAO,QAAUA,EAAO,OAAS,IAC7CC,EAAK,WAAW,UAAW,CACzBJ,EAAY,MAAMC,CAAG,CAAA,EACpBE,EAAO,MAAM,GAIlBL,EAAMG,CAAG,EAAI,CACX,OAAAE,EACA,IAAKD,EACL,GAAAE,CAAA,EAGKF,CAET,EAEA,KAAM,SACG,OAAO,KAAKJ,CAAK,EAG1B,MAAO,MAAMG,GAAgB,CAI3B,GAAI,CAACA,EAAK,CACR,QAASI,KAAKP,EACZE,EAAY,OAAOK,CAAC,EAEf,MAAA,EACT,CAEO,OAAAL,EAAY,OAAOC,CAAG,CAC/B,EAEA,OAASA,GAEHF,EAAI,KAAKD,EAAOG,CAAG,GACjBH,EAAMG,CAAG,EAAE,IACA,aAAAH,EAAMG,CAAG,EAAE,EAAE,EAG5BH,EAAMG,CAAG,EAAI,KACb,OAAOH,EAAMG,CAAG,EACT,IAGF,EACT,EAIK,OAAAD,CAET,EClDMM,GAAU,IAAM,CACpB,MAAMC,EAAe,CAAA,EACfR,EAAMQ,EAAa,eAEnBC,EAAW,CACf,MAAO,GACP,gBAAiB,SACjB,MAAO,GAAA,EAGHC,EAAc,SAAUC,EAA+B,CAC3D,MAAMC,EAAY,CAChB,OAAQ,GACR,SAAUH,EAAS,eAAA,EAIrB,GAAI,CAACE,EACI,OAAAC,EAIT,GAAID,aAAqB,KAAM,CACzB,IAAAE,MAAQ,KAEFD,EAAA,OAAS,KAAK,MAAMD,EAAU,UAAYE,EAAE,QAAQ,GAAK,GAAI,CAC9D,MAAA,OAAOF,GAAc,UAAYA,EAAU,QAChDA,EAAU,kBAAkB,KACpBC,EAAA,OAAS,KAAK,MAAMD,EAAU,OAAO,QAAY,EAAAE,EAAE,QAAQ,GAAK,GAAI,EAE9ED,EAAU,OAASD,EAAU,OAErBC,EAAA,SAAWD,EAAU,UAAYC,EAAU,UAC5C,OAAOD,GAAc,SACpBC,EAAA,SAAWD,EAAU,UAAYC,EAAU,SAC5C,OAAOD,GAAc,WAC9BC,EAAU,OAASD,GAIrB,OAAAC,EAAU,OAASA,EAAU,QAAUA,EAAU,OAAS,EAAIA,EAAU,OAAS,GAE1EA,CAAA,EAGHE,EAAa,CAEjB,UAAW,CAAC,EAGZ,MAAO,CAAC,EAER,WAAY,CAACZ,EAAoBa,EAAaC,IAAiB,CAC7D,GAAIhB,EAAI,KAAKc,EAAW,MAAOZ,CAAG,GAChC,QAAS,KAAKY,EAAW,MAAMZ,CAAG,EAChC,GAAI,OAAOY,EAAW,MAAMZ,CAAG,EAAE,CAAC,GAAM,WAClC,GAAA,CACFY,EAAW,MAAMZ,CAAG,EAAE,CAAC,EAAEA,EAAKa,EAAOC,CAAM,QACpCC,EAAG,CACF,QAAA,MAAM,iCAAmCf,EAAKe,CAAC,CACzD,EAIR,EAGA,SAAWC,IACJA,IAIE,OAAA,OAAOT,EAAUS,CAAW,EAExBJ,EAAA,WAAW,WAAYI,EAAaT,CAAQ,GAEhDA,GAIT,QAAS,CAACP,EAAoBiB,IAAyC,CAChEnB,EAAI,KAAKc,EAAW,MAAOZ,CAAG,IACtBY,EAAA,MAAMZ,CAAG,EAAI,IAGtB,MAAM,QAAQiB,CAAI,EACTL,EAAA,MAAMZ,CAAG,EAAIY,EAAW,MAAMZ,CAAG,EAAE,OAAOiB,CAAI,EAEzDL,EAAW,MAAMZ,CAAG,EAAE,KAAKiB,CAAI,CAEnC,EAGA,YAAa,CAACC,EAAcC,IAAmC,CAC7DA,EAAS,KAAK,EACHP,EAAA,UAAUM,CAAI,EAAIC,EAE7BP,EAAW,WAAW,cAAe,CAAE,KAAAM,EAAM,SAAAC,CAAU,CAAA,CACzD,EAGA,IAAK,MAAUnB,EAAaC,EAAUC,IAA2C,CAC/EA,EAASM,EAAYN,CAAM,EAC3B,IAAIkB,EAAOR,EAAW,UAAUV,EAAO,QAAQ,EAE/C,OAAAU,EAAW,WAAW,MAAO,CAAE,IAAAZ,EAAK,MAAAC,EAAO,OAAAC,CAAA,EAAUD,CAAK,EAEnDmB,EAAK,IAAIpB,EAAKC,EAAOO,EAAYN,CAAM,CAAC,CACjD,EAGA,MAAO,MAAOF,EAAamB,IAAsB,CAC/C,IAAIC,EAAOR,EAAW,UAAUO,GAAYZ,EAAS,eAAe,EAKpE,OAHAK,EAAW,WAAW,QAAS,CAAE,IAAAZ,EAAK,SAAAmB,CAAU,CAAA,EAG5CnB,GAAOA,EAAI,QAAQ,GAAG,EAAI,GACrBoB,EAAK,KAAA,EAAO,KAAK,SAAUC,EAAM,CACtC,IAAIC,EAAiBD,EAAK,OAAO,SAAUE,EAAK,CAC9C,OAAO,IAAI,OAAO,IAAMvB,EAAI,MAAM,GAAG,EAAE,KAAK,IAAI,EAAI,GAAG,EAAE,KAAKuB,CAAG,CAAA,CAClE,EAEGC,EAAgBF,EAAe,IAAIF,EAAK,KAAK,EAGjD,OAAAI,EAAc,KAAKJ,EAAK,MAAMpB,CAAG,CAAC,EAC3B,QAAQ,IAAIwB,CAAa,CAAA,CACjC,EAIIJ,EAAK,MAAMpB,CAAG,CACvB,EAGA,SAAU,MAAOmB,GAAsB,CACrC,IAAIC,EAAOR,EAAW,UAAUO,GAAYZ,EAAS,eAAe,EAEpE,OAAAK,EAAW,WAAW,WAAY,CAAE,SAAAO,CAAU,CAAA,EAEvCC,EAAK,OACd,EAGA,UAAW,MAAOpB,EAAayB,EAA0BvB,IAA+B,CAClF,GAAA,CACI,MAAAwB,EAAe,MAAMD,IAErBE,EAAM,MAAMf,EAAW,IAAIZ,EAAK0B,EAAclB,EAAYN,CAAM,CAAC,EAEvE,OAAAU,EAAW,WAAW,YAAa,CAAE,IAAAZ,EAAK,UAAAyB,EAAW,OAAAvB,CAAA,EAAUyB,CAAG,EAE3DA,QACAZ,EAAG,CACJ,MAAAA,CACR,CACF,EAGA,IAAK,MAAUf,EAAayB,EAAoBvB,IAA2C,CACzFA,EAASM,EAAYN,CAAM,EAG3B,MAAM0B,EAAa,MAFNhB,EAAW,UAAUV,EAAO,QAAQ,EAEnB,IAAIF,CAAG,EAGrC,GAAI4B,IAAe,OACjB,OAAIrB,EAAS,OACH,QAAA,KAAK,+BAAiCP,EAAK4B,CAAU,EAGpDhB,EAAA,WAAW,MAAO,CAAE,IAAAZ,EAAK,UAAAyB,EAAW,OAAAvB,EAAQ,SAAU,GAAM,OAAQ,EAAM,EAAG0B,CAAU,EAE3FA,EAIT,GAAI9B,EAAI,KAAKQ,EAAcN,CAAG,GAAK,MAAM,QAAQM,EAAaN,CAAG,CAAC,GAAKM,EAAaN,CAAG,EAAE,OAAS,EAAG,CAEnG,IAAI6B,EAAW,GAEN,QAAAzB,KAAKE,EAAaN,CAAG,EACxBM,EAAaN,CAAG,EAAEI,CAAC,EAAE,OAAS,IAAI,KAAK,KAAK,IAAA,EAAQG,EAAS,KAAK,IACzDsB,EAAA,IAKf,GAAI,CAACA,EAAU,CACTtB,EAAS,OACH,QAAA,KAAK,sEAAwEP,CAAG,EAG1F,IAAI8B,EAAY,IAAI,QAAQ,SAAUC,EAA6BC,EAAQ,CAC5D1B,EAAAN,CAAG,EAAE,KAAK,CACrB,IAAK+B,EACL,IAAKC,EACL,WAAY,IAAK,CAClB,CAAA,CACF,EAEU,OAAApB,EAAA,WAAW,MAAO,CAAE,IAAAZ,EAAK,UAAAyB,EAAW,OAAAvB,EAAQ,SAAU,GAAO,OAAQ,EAAK,EAAG4B,CAAS,EAE1FA,CACT,CAAA,MAGaxB,EAAAN,CAAG,EAAI,CAAC,CAAE,OAAY,IAAA,KAAQ,EAGzC,GAAA,CACEO,EAAS,OACH,QAAA,KAAK,4CAA8CP,CAAG,EAIhE,MAAMiC,EAAWR,IAENb,EAAA,WAAW,MAAO,CAAE,IAAAZ,EAAK,UAAAyB,EAAW,OAAAvB,EAAQ,SAAU,GAAO,OAAQ,EAAM,EAAG+B,CAAQ,EAGjG,MAAMP,EAAe,MAAMO,EAEvB1B,EAAS,OACH,QAAA,KAAK,+CAAiDP,EAAK0B,CAAY,EAG3E,MAAAC,EAAM,MAAMf,EAAW,IAAIZ,EAAK0B,EAAclB,EAAYN,CAAM,CAAC,EAEvE,GAAIJ,EAAI,KAAKQ,EAAcN,CAAG,EAAG,CACtB,QAAAI,KAAKE,EAAaN,CAAG,EACxBM,EAAaN,CAAG,EAAEI,CAAC,EAAE,MACnBG,EAAS,OACH,QAAA,KAAK,sCAAwCP,EAAK0B,CAAY,EAGxEpB,EAAaN,CAAG,EAAEI,CAAC,EAAE,IAAIuB,CAAG,GAInBrB,EAAAN,CAAG,EAAI,GACpB,OAAOM,EAAaN,CAAG,CACzB,CAEO,OAAA2B,QACAZ,EAAG,CACV,GAAIjB,EAAI,KAAKQ,EAAcN,CAAG,EAAG,CACtB,QAAAI,KAAKE,EAAaN,CAAG,EACxBM,EAAaN,CAAG,EAAEI,CAAC,EAAE,KACvBE,EAAaN,CAAG,EAAEI,CAAC,EAAE,IAAIW,CAAC,EAInBH,EAAA,WAAW,aAAc,CAAE,IAAAZ,EAAK,UAAAyB,EAAW,OAAAvB,EAAQ,SAAU,GAAO,OAAQ,EAAM,EAAGa,CAAC,EAEpFT,EAAAN,CAAG,EAAI,GACpB,OAAOM,EAAaN,CAAG,CACzB,CAEM,MAAAe,CACR,CACF,CAAA,EAGS,OAAAH,EAAA,YAAY,SAAUsB,EAAa,CAAA,EAEvCtB,CACT,GAAG"}

package/index.ts

@@ -1,16 +1,26 @@
 import MemoryCache from './provider/memory';
 
 export type asyncFunction = () => Promise<any> | (() => any);
+export type GorgonHookKey =
+  | 'settings'
+  | 'addProvider'
+  | 'put'
+  | 'clear'
+  | 'clearAll'
+  | 'overwrite'
+  | 'get'
+  | 'valueError';
+export type GorgonHook = (key: GorgonHookKey, input?: any, output?: any) => void;
 export type GorgonSettings = {
   debug: boolean;
   defaultProvider: string;
   retry: number;
-}
+};
 export type GorgonSettingsInput = {
   debug?: boolean;
   defaultProvider?: string;
   retry?: number;
-}
+};
 export type GorgonPolicy = {
   expiry: number | Date | false;
   provider: string;
@@ -34,8 +44,7 @@ export interface IGorgonCacheProvider {
 }
 
 const Gorgon = (() => {
-
-  const currentTasks = {} as {[key: string]: GorgonCurrentTaskItem};
+  const currentTasks = {} as { [key: string]: GorgonCurrentTaskItem };
   const hOP = currentTasks.hasOwnProperty;
 
   const settings = {
@@ -44,7 +53,7 @@ const Gorgon = (() => {
     retry: 5000,
   } as GorgonSettings;
 
-  const policyMaker = function(incPolicy?: GorgonPolicyInput) {
+  const policyMaker = function (incPolicy?: GorgonPolicyInput) {
     const outPolicy = {
       expiry: false,
       provider: settings.defaultProvider,
@@ -56,20 +65,20 @@ const Gorgon = (() => {
     }
 
     // Type is a full policy object
-    if(incPolicy instanceof Date) {
+    if (incPolicy instanceof Date) {
       var d = new Date();
 
       outPolicy.expiry = Math.ceil((incPolicy.getTime() - d.getTime()) / 1000);
-    }else if (typeof incPolicy === 'object' && incPolicy.expiry) {
-      if(incPolicy.expiry instanceof Date) {
+    } else if (typeof incPolicy === 'object' && incPolicy.expiry) {
+      if (incPolicy.expiry instanceof Date) {
         outPolicy.expiry = Math.ceil((incPolicy.expiry.getTime() - d.getTime()) / 1000);
-      }else{
+      } else {
         outPolicy.expiry = incPolicy.expiry;
       }
       outPolicy.provider = incPolicy.provider || outPolicy.provider;
-    } else if(typeof incPolicy === 'object') {
+    } else if (typeof incPolicy === 'object') {
       outPolicy.provider = incPolicy.provider || outPolicy.provider;
-    } else if(typeof incPolicy === 'number') {
+    } else if (typeof incPolicy === 'number') {
       outPolicy.expiry = incPolicy;
     }
 
@@ -80,9 +89,25 @@ const Gorgon = (() => {
   };
 
   const gorgonCore = {
-
     // Providers available for use
-    providers: {} as {[key: string]: IGorgonCacheProvider},
+    providers: {} as { [key: string]: IGorgonCacheProvider },
+
+    // Hooks
+    hooks: {} as { [key: string]: Array<GorgonHook> },
+
+    _callHooks: (key: GorgonHookKey, input?: any, output?: any) => {
+      if (hOP.call(gorgonCore.hooks, key)) {
+        for (var i in gorgonCore.hooks[key]) {
+          if (typeof gorgonCore.hooks[key][i] === 'function') {
+            try {
+              gorgonCore.hooks[key][i](key, input, output);
+            } catch (e) {
+              console.error('[Gorgon] Hook error for hook: ' + key, e);
+            }
+          }
+        }
+      }
+    },
 
     // Allows for settings on the gorgon cache
     settings: (newSettings?: GorgonSettingsInput) => {
@@ -92,32 +117,52 @@ const Gorgon = (() => {
 
       Object.assign(settings, newSettings); // only overwrite ones sent in; keep others at existing
 
+      gorgonCore._callHooks('settings', newSettings, settings);
+
       return settings;
     },
 
+    // add a hook or array of hooks
+    addHook: (key: GorgonHookKey, hook: GorgonHook | Array<GorgonHook>) => {
+      if (!hOP.call(gorgonCore.hooks, key)) {
+        gorgonCore.hooks[key] = [];
+      }
+
+      if (Array.isArray(hook)) {
+        gorgonCore.hooks[key] = gorgonCore.hooks[key].concat(hook);
+      } else {
+        gorgonCore.hooks[key].push(hook);
+      }
+    },
+
     // Add a provider
-    addProvider: (name: string, provider:IGorgonCacheProvider) => {
+    addProvider: (name: string, provider: IGorgonCacheProvider) => {
       provider.init(); // Trigger for provider to clear any old cache items or any other cleanup
       gorgonCore.providers[name] = provider;
+
+      gorgonCore._callHooks('addProvider', { name, provider });
     },
 
     // Place an item into the cache
-    put: async<R>(key:string, value:R, policy?: GorgonPolicyInput):Promise<R> => {
+    put: async <R>(key: string, value: R, policy?: GorgonPolicyInput): Promise<R> => {
       policy = policyMaker(policy);
       var prov = gorgonCore.providers[policy.provider];
 
+      gorgonCore._callHooks('put', { key, value, policy }, value);
+
       return prov.set(key, value, policyMaker(policy));
     },
 
-        // Clear one or all items in the cache
-    clear: async(key: string, provider?: string) => {
-
+    // Clear one or all items in the cache
+    clear: async (key: string, provider?: string) => {
       var prov = gorgonCore.providers[provider || settings.defaultProvider];
 
+      gorgonCore._callHooks('clear', { key, provider });
+
       // Clear a wildcard search of objects
       if (key && key.indexOf('*') > -1) {
-        return prov.keys().then(function(keys) {
-          var cacheMatchKeys = keys.filter(function(str) {
+        return prov.keys().then(function (keys) {
+          var cacheMatchKeys = keys.filter(function (str) {
             return new RegExp('^' + key.split('*').join('.*') + '$').test(str);
           });
 
@@ -131,42 +176,47 @@ const Gorgon = (() => {
 
       // Not a special clear
       return prov.clear(key);
-
     },
 
     // Clear all keys/values in the cache
-    clearAll: async(provider?: string) => {
+    clearAll: async (provider?: string) => {
       var prov = gorgonCore.providers[provider || settings.defaultProvider];
 
+      gorgonCore._callHooks('clearAll', { provider });
+
       return prov.clear();
     },
 
     // Allows you to instantly overwite a cache object
-    overwrite: async(key:string, asyncFunc: asyncFunction, policy?: GorgonPolicyInput) => {
-
-      try{
+    overwrite: async (key: string, asyncFunc: asyncFunction, policy?: GorgonPolicyInput) => {
+      try {
         const resolvedData = await asyncFunc();
 
         const val = await gorgonCore.put(key, resolvedData, policyMaker(policy));
 
+        gorgonCore._callHooks('overwrite', { key, asyncFunc, policy }, val);
+
         return val;
-      }catch (e) {
+      } catch (e) {
         throw e;
       }
-
     },
 
     // Allows you to get from the cache or pull from the promise
-    get: async<R>(key:string, asyncFunc:() => R, policy?: GorgonPolicyInput):Promise<R> => {
-
+    get: async <R>(key: string, asyncFunc: () => R, policy?: GorgonPolicyInput): Promise<R> => {
       policy = policyMaker(policy);
       const prov = gorgonCore.providers[policy.provider];
 
       const currentVal = await prov.get(key); // Most providers will only lookup by key and return false on not found
 
       // If we have a current value sent it out; cache hit!
-      if(currentVal !== undefined) {
-        if(settings.debug) {console.info('[Gorgon] Cache hit for key: ' + key, currentVal);}
+      if (currentVal !== undefined) {
+        if (settings.debug) {
+          console.info('[Gorgon] Cache hit for key: ' + key, currentVal);
+        }
+
+        gorgonCore._callHooks('get', { key, asyncFunc, policy, cacheHit: true, queued: false }, currentVal);
+
         return currentVal;
       }
 
@@ -176,16 +226,18 @@ const Gorgon = (() => {
         var oldQueue = false;
 
         for (var i in currentTasks[key]) {
-          if(currentTasks[key][i].queued < new Date(Date.now() - settings.retry)) {
+          if (currentTasks[key][i].queued < new Date(Date.now() - settings.retry)) {
             oldQueue = true;
           }
         }
 
         // Add to the current queue
-        if(!oldQueue) {
-          if(settings.debug) {console.info('[Gorgon] Cache miss, in progress, adding to current queue for key: ' + key);}
+        if (!oldQueue) {
+          if (settings.debug) {
+            console.info('[Gorgon] Cache miss, in progress, adding to current queue for key: ' + key);
+          }
 
-          var concurent = new Promise(function(resolve: (value: R) => void, reject) {
+          var concurent = new Promise(function (resolve: (value: R) => void, reject) {
             currentTasks[key].push({
               res: resolve,
               rej: reject,
@@ -193,27 +245,40 @@ const Gorgon = (() => {
             });
           });
 
+          gorgonCore._callHooks('get', { key, asyncFunc, policy, cacheHit: false, queued: true }, concurent);
+
           return concurent;
         }
-      }else{
+      } else {
         // Add current task to list, this is the first one so the primary
-        currentTasks[key] = [{queued: new Date()}];
+        currentTasks[key] = [{ queued: new Date() }];
       }
 
-      try{
-        if(settings.debug) {console.info('[Gorgon] Cache miss, resolving item for: ' + key);}
+      try {
+        if (settings.debug) {
+          console.info('[Gorgon] Cache miss, resolving item for: ' + key);
+        }
 
-        // This is the primary item, lets resolve and push it out
-        const resolvedData = await asyncFunc();
+        // This is the primary item
+        const resolver = asyncFunc();
+
+        gorgonCore._callHooks('get', { key, asyncFunc, policy, cacheHit: false, queued: false }, resolver);
 
-        if(settings.debug) {console.info('[Gorgon] Cache resolved, resolved item for: ' + key, resolvedData);}
+        // wait for it to finish then push it out
+        const resolvedData = await resolver;
+
+        if (settings.debug) {
+          console.info('[Gorgon] Cache resolved, resolved item for: ' + key, resolvedData);
+        }
 
         const val = await gorgonCore.put(key, resolvedData, policyMaker(policy));
 
         if (hOP.call(currentTasks, key)) {
           for (var i in currentTasks[key]) {
-            if(currentTasks[key][i].res) {
-              if(settings.debug) {console.info('[Gorgon] Cache queue resolved for: ' + key, resolvedData);}
+            if (currentTasks[key][i].res) {
+              if (settings.debug) {
+                console.info('[Gorgon] Cache queue resolved for: ' + key, resolvedData);
+              }
 
               currentTasks[key][i].res(val);
             }
@@ -224,32 +289,29 @@ const Gorgon = (() => {
         }
 
         return val;
-
-      }catch (e) {
+      } catch (e) {
         if (hOP.call(currentTasks, key)) {
           for (var i in currentTasks[key]) {
-            if(currentTasks[key][i].rej) {
+            if (currentTasks[key][i].rej) {
               currentTasks[key][i].rej(e);
             }
           }
 
+          gorgonCore._callHooks('valueError', { key, asyncFunc, policy, cacheHit: false, queued: false }, e);
+
           currentTasks[key] = [];
           delete currentTasks[key];
         }
 
         throw e;
       }
-
     },
-
-
   };
 
   gorgonCore.addProvider('memory', MemoryCache()); // Default provider, light weight and simple
 
   return gorgonCore;
-
 })();
 
-export {MemoryCache};
+export { MemoryCache };
 export default Gorgon;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gorgonjs/gorgon",
-  "version": "1.4.1",
+  "version": "1.5.0",
   "description": "A simple caching library for async functions",
   "homepage": "https://gorgonjs.dev",
   "main": "./dist/index.umd.js",
@@ -38,6 +38,7 @@
     "@typescript-eslint/eslint-plugin": "^6.0.0",
     "@typescript-eslint/parser": "^6.0.0",
     "@vitest/coverage-c8": "^0.25.0",
+    "@vitest/coverage-v8": "^0.34.3",
     "eslint": "^8.45.0",
     "jest": "^27.5.1",
     "typescript": "^5.1.6",