Updating catbox to hapi 17 bindings.

types/catbox/catbox-tests.ts

@@ -1,26 +1,26 @@
-import Catbox = require("catbox");
+import { CacheItem, Client, Policy, EnginePrototypeOrObject } from "catbox";
 
-const Memory: Catbox.EnginePrototypeOrObject = {
-    start(callback: Catbox.CallBackNoResult) {},
-    stop() {},
-    get() {},
-    set() {},
-    drop() {},
+const Memory: EnginePrototypeOrObject = {
+    async start(): Promise<void> {},
+    stop(): void {},
+    async get(): Promise<null | CacheItem> {},
+    async set(): Promise<void> {},
+    async drop(): Promise<void> {},
     isReady(): boolean { return true; },
     validateSegmentName(segment: string): null { return null; },
 };
 
-const client = new Catbox.Client(Memory, { partition: 'cache' });
+const client = new Client(Memory, { partition: 'cache' });
 
-const cache = new Catbox.Policy({
+const cache = new Policy({
     expiresIn: 5000,
 }, client, 'cache');
 
-cache.set('foo', 'bar', 5000, () => {});
+cache.set('foo', 'bar', 5000).then(() => {});
 
-cache.get('foo', () => {});
+cache.get('foo').then(() => {});
 
-cache.drop('foo', () => {});
+cache.drop('foo').then(() => {});
 
 cache.isReady();
 

types/catbox/index.d.ts

@@ -1,14 +1,11 @@
-// Type definitions for catbox 7.1
+// Type definitions for catbox 10.0
 // Project: https://github.com/hapijs/catbox
-// Definitions by: Jason Swearingen <https://github.com/jasonswearingen>, AJP <https://github.com/AJamesPhillips>
+// Definitions by: Jason Swearingen <https://github.com/jasonswearingen>
+//                 AJP <https://github.com/AJamesPhillips>
+//                 Rodrigo Saboya <https://github.com/saboya>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
 // TypeScript Version: 2.4
 
-import * as Boom from 'boom';
-
-export type CallBackNoResult = (err?: Boom.BoomError) => void;
-export type CallBackWithResult<T> = (err: Boom.BoomError | null | undefined, result: T) => void;
-
 /**
  * Client
  * The Client object provides a low-level cache abstraction. The object is constructed using new Client(engine, options) where:
@@ -23,34 +20,31 @@ export type CallBackWithResult<T> = (err: Boom.BoomError | null | undefined, res
 export class Client implements ClientApi {
     constructor(engine: EnginePrototypeOrObject, options: ClientOptions);
 
-    /** start(callback) - creates a connection to the cache server. Must be called before any other method is available. The callback signature is function(err). */
-    start(callback: CallBackNoResult): void;
+    /** start() - creates a connection to the cache server. Must be called before any other method is available. */
+    start(): Promise<void>;
     /** stop() - terminates the connection to the cache server. */
     stop(): void;
     /**
      * get(key, callback) - retrieve an item from the cache engine if found where:
      *  * key - a cache key object (see [ICacheKey]).
-     *  * callback - a function with the signature function(err, cached). If the item is not found, both err and cached are null. If found, the cached object is returned
      */
-    get(key: CacheKey, callback: CallBackWithResult<null | CachedObject>): CacheItem;
+    get(key: CacheKey): Promise<null | CachedObject>;
     /**
      * set(key, value, ttl, callback) - store an item in the cache for a specified length of time, where:
      *  * key - a cache key object (see [ICacheKey]).
      *  * value - the string or object value to be stored.
      *  * ttl - a time-to-live value in milliseconds after which the item is automatically removed from the cache (or is marked invalid).
-     *  * callback - a function with the signature function(err).
      */
-    set(key: CacheKey, value: CacheItem, ttl: number, callback: CallBackNoResult): void;
+    set(key: CacheKey, value: CacheItem, ttl: number): Promise<void>;
     /**
      * drop(key, callback) - remove an item from cache where:
      *  * key - a cache key object (see [ICacheKey]).
-     *  * callback - a function with the signature function(err).
      */
-    drop(key: CacheKey, callback: CallBackNoResult): void;
+    drop(key: CacheKey): Promise<void>;
     /** isReady() - returns true if cache engine determines itself as ready, false if it is not ready. */
     isReady(): boolean;
     /** validateSegmentName(segment) - returns null if the segment name is valid (see below), otherwise should return an instance of Error with an appropriate message. */
-    validateSegmentName(segment: string): null | Boom.BoomError;
+    validateSegmentName(segment: string): null | Error;
 }
 
 export type EnginePrototypeOrObject = EnginePrototype | ClientApi;
@@ -68,34 +62,31 @@ export interface EnginePrototype {
  * @see {@link https://github.com/hapijs/catbox#api}
  */
 export interface ClientApi {
-    /** start(callback) - creates a connection to the cache server. Must be called before any other method is available. The callback signature is function(err). */
-    start(callback: CallBackNoResult): void;
+    /** start() - creates a connection to the cache server. Must be called before any other method is available. */
+    start(): Promise<void>;
     /** stop() - terminates the connection to the cache server. */
     stop(): void;
     /**
      * get(key, callback) - retrieve an item from the cache engine if found where:
      *  * key - a cache key object (see [ICacheKey]).
-     *  * callback - a function with the signature function(err, cached). If the item is not found, both err and cached are null. If found, the cached object is returned
      */
-    get(key: CacheKey, callback: CallBackWithResult<null | CachedObject>): CacheItem;
+    get(key: CacheKey): Promise<null | CachedObject>;
     /**
-     * set(key, value, ttl, callback) - store an item in the cache for a specified length of time, where:
+     * set(key, value, ttl) - store an item in the cache for a specified length of time, where:
      *  * key - a cache key object (see [ICacheKey]).
      *  * value - the string or object value to be stored.
      *  * ttl - a time-to-live value in milliseconds after which the item is automatically removed from the cache (or is marked invalid).
-     *  * callback - a function with the signature function(err).
      */
-    set(key: CacheKey, value: CacheItem, ttl: number, callback: CallBackNoResult): void;
+    set(key: CacheKey, value: CacheItem, ttl: number): Promise<void>;
     /**
-     * drop(key, callback) - remove an item from cache where:
+     * drop(key) - remove an item from cache where:
      *  * key - a cache key object (see [ICacheKey]).
-     *  * callback - a function with the signature function(err).
      */
-    drop(key: CacheKey, callback: CallBackNoResult): void;
+    drop(key: CacheKey): Promise<void>;
     /** isReady() - returns true if cache engine determines itself as ready, false if it is not ready. */
     isReady(): boolean;
     /** validateSegmentName(segment) - returns null if the segment name is valid (see below), otherwise should return an instance of Error with an appropriate message. */
-    validateSegmentName(segment: string): null | Boom.BoomError;
+    validateSegmentName(segment: string): null | Error;
 }
 
 /**
@@ -135,27 +126,24 @@ export interface ClientOptions {
 export class Policy implements PolicyAPI {
     constructor(options: PolicyOptions, cache: Client, segment: string);
     /**
-     * get(id, callback) - retrieve an item from the cache. If the item is not found and the generateFunc method was provided,
+     * get(id) - retrieve an item from the cache. If the item is not found and the generateFunc method was provided,
      * a new value is generated, stored in the cache, and returned. Multiple concurrent requests are queued and processed once. The method arguments are:
      *  * id - the unique item identifier (within the policy segment). Can be a string or an object with the required 'id' key.
-     *  * callback - the return function.
      */
-    get(id: string | {id: string}, callback: PolicyGetCallback): CacheItem;
+    get(id: string | { id: string }): Promise<PolicyGetPromiseResult | null>;
     /**
-     * set(id, value, ttl, callback) - store an item in the cache where:
+     * set(id, value, ttl) - store an item in the cache where:
      *  * id - the unique item identifier (within the policy segment).
      *  * value - the string or object value to be stored.
      *  * ttl - a time-to-live override value in milliseconds after which the item is automatically removed from the cache (or is marked invalid).
      *    This should be set to 0 in order to use the caching rules configured when creating the Policy object.
-     *  * callback - a function with the signature function(err).
      */
-    set(id: string | {id: string}, value: CacheItem, ttl: number | null, callback: CallBackNoResult): void;
+    set(id: string | { id: string }, value: CacheItem, ttl: number | null): Promise<void>;
     /**
-     * drop(id, callback) - remove the item from cache where:
+     * drop(id) - remove the item from cache where:
      *  * id - the unique item identifier (within the policy segment).
-     *  * callback - a function with the signature function(err).
      */
-    drop(id: string | {id: string}, callback: CallBackNoResult): void;
+    drop(id: string | { id: string }): Promise<void>;
     /** ttl(created) - given a created timestamp in milliseconds, returns the time-to-live left based on the configured rules. */
     ttl(created: number): number;
     /** rules(options) - changes the policy rules after construction (note that items already stored will not be affected) */
@@ -173,27 +161,24 @@ export class Policy implements PolicyAPI {
  */
 export interface PolicyAPI {
     /**
-     * get(id, callback) - retrieve an item from the cache. If the item is not found and the generateFunc method was provided,
+     * get(id) - retrieve an item from the cache. If the item is not found and the generateFunc method was provided,
      * a new value is generated, stored in the cache, and returned. Multiple concurrent requests are queued and processed once. The method arguments are:
      *  * id - the unique item identifier (within the policy segment). Can be a string or an object with the required 'id' key.
-     *  * callback - the return function.
      */
-    get(id: string | {id: string}, callback: PolicyGetCallback): CacheItem;
+    get(id: string | { id: string }): Promise<PolicyGetPromiseResult | null>;
     /**
-     * set(id, value, ttl, callback) - store an item in the cache where:
+     * set(id, value, ttl) - store an item in the cache where:
      *  * id - the unique item identifier (within the policy segment).
      *  * value - the string or object value to be stored.
      *  * ttl - a time-to-live override value in milliseconds after which the item is automatically removed from the cache (or is marked invalid).
      *    This should be set to 0 in order to use the caching rules configured when creating the Policy object.
-     *  * callback - a function with the signature function(err).
      */
-    set(id: string | {id: string}, value: CacheItem, ttl: number | null, callback: CallBackNoResult): void;
+    set(id: string | { id: string }, value: CacheItem, ttl: number | null): Promise<void>;
     /**
-     * drop(id, callback) - remove the item from cache where:
+     * drop(id) - remove the item from cache where:
      *  * id - the unique item identifier (within the policy segment).
-     *  * callback - a function with the signature function(err).
      */
-    drop(id: string | {id: string}, callback: CallBackNoResult): void;
+    drop(id: string | { id: string }): Promise<void>;
     /** ttl(created) - given a created timestamp in milliseconds, returns the time-to-live left based on the configured rules. */
     ttl(created: number): number;
     /** rules(options) - changes the policy rules after construction (note that items already stored will not be affected) */
@@ -204,16 +189,13 @@ export interface PolicyAPI {
     stats(): CacheStatisticsObject;
 }
 
-/**
- * The return function. The function signature is function(err, value, cached, report) where:
- * @param err - any errors encountered.
- * @param value - the fetched or generated value.
- * @param cached - null if a valid item was not found in the cache, or IPolicyGetCallbackCachedOptions
- * @param report - an object with logging information about the generation operation
- */
-export type PolicyGetCallback = (err: null | Boom.BoomError, value: CacheItem, cached: PolicyGetCallbackCachedOptions, report: PolicyGetCallbackReportLog) => void;
+export interface PolicyGetPromiseResult {
+    value: CacheItem;
+    cached: PolicyGetCachedOptions;
+    report: PolicyGetReportLog;
+}
 
-export interface PolicyGetCallbackCachedOptions {
+export interface PolicyGetCachedOptions {
     /** item - the cached value. */
     item: CacheItem;
     /** stored - the timestamp when the item was stored in the cache. */
@@ -262,10 +244,14 @@ export interface PolicyOptions {
     pendingGenerateTimeout?: number;
 }
 
+export interface GenerateFuncFlags {
+    ttl: number;
+}
+
 /**
  * generateFunc
  * Is used in PolicyOptions
- * A function used to generate a new cache item if one is not found in the cache when calling get(). The method's signature is function(id, next)
+ * A function used to generate a new cache item if one is not found in the cache when calling get(). The method's signature is function(id)
  * @param id - the id string or object provided to the get() method.
  * @param next - the method called when the new item is returned with the signature function(err, value, ttl) where:
  *      * err - an error condition.
@@ -273,12 +259,12 @@ export interface PolicyOptions {
  *      * ttl - the cache ttl value in milliseconds. Set to 0 to skip storing in the cache. Defaults to the cache global policy.
  * @see {@link https://github.com/hapijs/catbox#policy}
  */
-export type GenerateFunc = (id: string, next: ((err: null | Boom.BoomError, value: CacheItem, ttl?: number) => void)) => void;
+export type GenerateFunc = (id: string, flags: GenerateFuncFlags) => Promise<CacheItem>;
 
 /**
  * An object with logging information about the generation operation containing the following keys (as relevant):
  */
-export interface PolicyGetCallbackReportLog {
+export interface PolicyGetReportLog {
     /** msec - the cache lookup time in milliseconds. */
     msec: number;
     /** stored - the timestamp when the item was stored in the cache. */
@@ -288,7 +274,7 @@ export interface PolicyGetCallbackReportLog {
     /** ttl - the cache ttl value for the record. */
     ttl: number;
     /** error - lookup error. */
-    error?: Boom.BoomError;
+    error?: Error;
 }
 
 /**

types/catbox/tsconfig.json

@@ -13,11 +13,6 @@
             "../"
         ],
         "types": [],
-        "paths": {
-            "boom": [
-                "boom/v4"
-            ]
-        },
         "noEmit": true,
         "forceConsistentCasingInFileNames": true
     },

types/catbox/v7/catbox-tests.ts

@@ -0,0 +1,27 @@
+import Catbox = require("catbox");
+
+const Memory: Catbox.EnginePrototypeOrObject = {
+    start(callback: Catbox.CallBackNoResult) {},
+    stop() {},
+    get() {},
+    set() {},
+    drop() {},
+    isReady(): boolean { return true; },
+    validateSegmentName(segment: string): null { return null; },
+};
+
+const client = new Catbox.Client(Memory, { partition: 'cache' });
+
+const cache = new Catbox.Policy({
+    expiresIn: 5000,
+}, client, 'cache');
+
+cache.set('foo', 'bar', 5000, () => {});
+
+cache.get('foo', () => {});
+
+cache.drop('foo', () => {});
+
+cache.isReady();
+
+cache.stats();

types/catbox/v7/index.d.ts

@@ -0,0 +1,310 @@
+// Type definitions for catbox 7.1
+// Project: https://github.com/hapijs/catbox
+// Definitions by: Jason Swearingen <https://github.com/jasonswearingen>, AJP <https://github.com/AJamesPhillips>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+// TypeScript Version: 2.4
+
+import * as Boom from 'boom';
+
+export type CallBackNoResult = (err?: Boom.BoomError) => void;
+export type CallBackWithResult<T> = (err: Boom.BoomError | null | undefined, result: T) => void;
+
+/**
+ * Client
+ * The Client object provides a low-level cache abstraction. The object is constructed using new Client(engine, options) where:
+ * engine - is an object or a prototype function implementing the cache strategy:
+ *  * function - a prototype function with the signature function(options). catbox will call new func(options).
+ *  * object - a pre instantiated client implementation object. Does not support passing options.
+ * options - the strategy configuration object. Each strategy defines its own configuration options with the following common options:
+ *  * partition - the partition name used to isolate the cached results across multiple clients. The partition name is used as the MongoDB database name,
+ *    the Riak bucket, or as a key prefix in Redis and Memcached. To share the cache across multiple clients, use the same partition name.
+ * @see {@link https://github.com/hapijs/catbox#client}
+ */
+export class Client implements ClientApi {
+    constructor(engine: EnginePrototypeOrObject, options: ClientOptions);
+
+    /** start(callback) - creates a connection to the cache server. Must be called before any other method is available. The callback signature is function(err). */
+    start(callback: CallBackNoResult): void;
+    /** stop() - terminates the connection to the cache server. */
+    stop(): void;
+    /**
+     * get(key, callback) - retrieve an item from the cache engine if found where:
+     *  * key - a cache key object (see [ICacheKey]).
+     *  * callback - a function with the signature function(err, cached). If the item is not found, both err and cached are null. If found, the cached object is returned
+     */
+    get(key: CacheKey, callback: CallBackWithResult<null | CachedObject>): CacheItem;
+    /**
+     * set(key, value, ttl, callback) - store an item in the cache for a specified length of time, where:
+     *  * key - a cache key object (see [ICacheKey]).
+     *  * value - the string or object value to be stored.
+     *  * ttl - a time-to-live value in milliseconds after which the item is automatically removed from the cache (or is marked invalid).
+     *  * callback - a function with the signature function(err).
+     */
+    set(key: CacheKey, value: CacheItem, ttl: number, callback: CallBackNoResult): void;
+    /**
+     * drop(key, callback) - remove an item from cache where:
+     *  * key - a cache key object (see [ICacheKey]).
+     *  * callback - a function with the signature function(err).
+     */
+    drop(key: CacheKey, callback: CallBackNoResult): void;
+    /** isReady() - returns true if cache engine determines itself as ready, false if it is not ready. */
+    isReady(): boolean;
+    /** validateSegmentName(segment) - returns null if the segment name is valid (see below), otherwise should return an instance of Error with an appropriate message. */
+    validateSegmentName(segment: string): null | Boom.BoomError;
+}
+
+export type EnginePrototypeOrObject = EnginePrototype | ClientApi;
+
+/**
+ * A prototype CatBox engine function
+ */
+export interface EnginePrototype {
+    new(settings: ClientOptions): ClientApi;
+}
+
+/**
+ * Client API
+ * The Client object provides the following methods:
+ * @see {@link https://github.com/hapijs/catbox#api}
+ */
+export interface ClientApi {
+    /** start(callback) - creates a connection to the cache server. Must be called before any other method is available. The callback signature is function(err). */
+    start(callback: CallBackNoResult): void;
+    /** stop() - terminates the connection to the cache server. */
+    stop(): void;
+    /**
+     * get(key, callback) - retrieve an item from the cache engine if found where:
+     *  * key - a cache key object (see [ICacheKey]).
+     *  * callback - a function with the signature function(err, cached). If the item is not found, both err and cached are null. If found, the cached object is returned
+     */
+    get(key: CacheKey, callback: CallBackWithResult<null | CachedObject>): CacheItem;
+    /**
+     * set(key, value, ttl, callback) - store an item in the cache for a specified length of time, where:
+     *  * key - a cache key object (see [ICacheKey]).
+     *  * value - the string or object value to be stored.
+     *  * ttl - a time-to-live value in milliseconds after which the item is automatically removed from the cache (or is marked invalid).
+     *  * callback - a function with the signature function(err).
+     */
+    set(key: CacheKey, value: CacheItem, ttl: number, callback: CallBackNoResult): void;
+    /**
+     * drop(key, callback) - remove an item from cache where:
+     *  * key - a cache key object (see [ICacheKey]).
+     *  * callback - a function with the signature function(err).
+     */
+    drop(key: CacheKey, callback: CallBackNoResult): void;
+    /** isReady() - returns true if cache engine determines itself as ready, false if it is not ready. */
+    isReady(): boolean;
+    /** validateSegmentName(segment) - returns null if the segment name is valid (see below), otherwise should return an instance of Error with an appropriate message. */
+    validateSegmentName(segment: string): null | Boom.BoomError;
+}
+
+/**
+ * Any method with a key argument takes an object with the following required properties:
+ */
+export interface CacheKey {
+    /** segment - a caching segment name string. Enables using a single cache server for storing different sets of items with overlapping ids. */
+    segment: string;
+    /** id - a unique item identifier string (per segment). Can be an empty string. */
+    id: string;
+}
+
+/** Cached object contains the following: */
+export interface CachedObject {
+    /** item - the value stored in the cache using set(). */
+    item: any;
+    /** stored - the timestamp when the item was stored in the cache (in milliseconds). */
+    stored: number;
+    /** ttl - the remaining time-to-live (not the original value used when storing the object). */
+    ttl: number;
+}
+
+export type CacheItem = any;
+
+export interface ClientOptions {
+    partition: string;
+}
+
+/**
+ * The Policy object provides a convenient cache interface by setting a global policy which is automatically applied to every storage action.
+ * The object is constructed using new Policy(options, [cache, segment]) where:
+ *  * options - an object with the IPolicyOptions structure
+ *  * cache - a Client instance (which has already been started).
+ *  * segment - required when cache is provided. The segment name used to isolate cached items within the cache partition.
+ * @see {@link https://github.com/hapijs/catbox#policy}
+ */
+export class Policy implements PolicyAPI {
+    constructor(options: PolicyOptions, cache: Client, segment: string);
+    /**
+     * get(id, callback) - retrieve an item from the cache. If the item is not found and the generateFunc method was provided,
+     * a new value is generated, stored in the cache, and returned. Multiple concurrent requests are queued and processed once. The method arguments are:
+     *  * id - the unique item identifier (within the policy segment). Can be a string or an object with the required 'id' key.
+     *  * callback - the return function.
+     */
+    get(id: string | {id: string}, callback: PolicyGetCallback): CacheItem;
+    /**
+     * set(id, value, ttl, callback) - store an item in the cache where:
+     *  * id - the unique item identifier (within the policy segment).
+     *  * value - the string or object value to be stored.
+     *  * ttl - a time-to-live override value in milliseconds after which the item is automatically removed from the cache (or is marked invalid).
+     *    This should be set to 0 in order to use the caching rules configured when creating the Policy object.
+     *  * callback - a function with the signature function(err).
+     */
+    set(id: string | {id: string}, value: CacheItem, ttl: number | null, callback: CallBackNoResult): void;
+    /**
+     * drop(id, callback) - remove the item from cache where:
+     *  * id - the unique item identifier (within the policy segment).
+     *  * callback - a function with the signature function(err).
+     */
+    drop(id: string | {id: string}, callback: CallBackNoResult): void;
+    /** ttl(created) - given a created timestamp in milliseconds, returns the time-to-live left based on the configured rules. */
+    ttl(created: number): number;
+    /** rules(options) - changes the policy rules after construction (note that items already stored will not be affected) */
+    rules(options: PolicyOptions): void;
+    /** isReady() - returns true if cache engine determines itself as ready, false if it is not ready or if there is no cache engine set. */
+    isReady(): boolean;
+    /** stats - an object with cache statistics */
+    stats(): CacheStatisticsObject;
+}
+
+/**
+ * Policy API
+ * The Policy object provides the following methods:
+ * @see {@link https://github.com/hapijs/catbox#api-1}
+ */
+export interface PolicyAPI {
+    /**
+     * get(id, callback) - retrieve an item from the cache. If the item is not found and the generateFunc method was provided,
+     * a new value is generated, stored in the cache, and returned. Multiple concurrent requests are queued and processed once. The method arguments are:
+     *  * id - the unique item identifier (within the policy segment). Can be a string or an object with the required 'id' key.
+     *  * callback - the return function.
+     */
+    get(id: string | {id: string}, callback: PolicyGetCallback): CacheItem;
+    /**
+     * set(id, value, ttl, callback) - store an item in the cache where:
+     *  * id - the unique item identifier (within the policy segment).
+     *  * value - the string or object value to be stored.
+     *  * ttl - a time-to-live override value in milliseconds after which the item is automatically removed from the cache (or is marked invalid).
+     *    This should be set to 0 in order to use the caching rules configured when creating the Policy object.
+     *  * callback - a function with the signature function(err).
+     */
+    set(id: string | {id: string}, value: CacheItem, ttl: number | null, callback: CallBackNoResult): void;
+    /**
+     * drop(id, callback) - remove the item from cache where:
+     *  * id - the unique item identifier (within the policy segment).
+     *  * callback - a function with the signature function(err).
+     */
+    drop(id: string | {id: string}, callback: CallBackNoResult): void;
+    /** ttl(created) - given a created timestamp in milliseconds, returns the time-to-live left based on the configured rules. */
+    ttl(created: number): number;
+    /** rules(options) - changes the policy rules after construction (note that items already stored will not be affected) */
+    rules(options: PolicyOptions): void;
+    /** isReady() - returns true if cache engine determines itself as ready, false if it is not ready or if there is no cache engine set. */
+    isReady(): boolean;
+    /** stats - an object with cache statistics */
+    stats(): CacheStatisticsObject;
+}
+
+/**
+ * The return function. The function signature is function(err, value, cached, report) where:
+ * @param err - any errors encountered.
+ * @param value - the fetched or generated value.
+ * @param cached - null if a valid item was not found in the cache, or IPolicyGetCallbackCachedOptions
+ * @param report - an object with logging information about the generation operation
+ */
+export type PolicyGetCallback = (err: null | Boom.BoomError, value: CacheItem, cached: PolicyGetCallbackCachedOptions, report: PolicyGetCallbackReportLog) => void;
+
+export interface PolicyGetCallbackCachedOptions {
+    /** item - the cached value. */
+    item: CacheItem;
+    /** stored - the timestamp when the item was stored in the cache. */
+    stored: number;
+    /** ttl - the cache ttl value for the record. */
+    ttl: number;
+    /** isStale - true if the item is stale. */
+    isStale: boolean;
+}
+
+/**
+ * @see {@link https://github.com/hapijs/catbox#policy}
+ */
+export interface PolicyOptions {
+    /** expiresIn - relative expiration expressed in the number of milliseconds since the item was saved in the cache. Cannot be used together with expiresAt. */
+    expiresIn?: number;
+    /** expiresAt - time of day expressed in 24h notation using the 'HH:MM' format, at which point all cache records for the route expire. Uses local time. Cannot be used together with expiresIn. */
+    expiresAt?: string;
+    /** generateFunc - a function used to generate a new cache item if one is not found in the cache when calling get(). The method's signature is function(id, next) where: */
+    generateFunc?: GenerateFunc;
+    /**
+     * staleIn - number of milliseconds to mark an item stored in cache as stale and attempt to regenerate it when generateFunc is provided.
+     * Must be less than expiresIn. Alternatively function that returns staleIn value in milliseconds. The function signature is function(stored, ttl) where:
+     *  * stored - the timestamp when the item was stored in the cache (in milliseconds).
+     *  * ttl - the remaining time-to-live (not the original value used when storing the object).
+     */
+    staleIn?: number | ((stored: number, ttl: number) => number);
+    /** staleTimeout - number of milliseconds to wait before returning a stale value while generateFunc is generating a fresh value. */
+    staleTimeout?: number;
+    /**
+     * generateTimeout - number of milliseconds to wait before returning a timeout error when the generateFunc function takes too long to return a value.
+     * When the value is eventually returned, it is stored in the cache for future requests. Required if generateFunc is present.
+     * Set to false to disable timeouts which may cause all get() requests to get stuck forever.
+     */
+    generateTimeout?: number | false;
+    /** dropOnError - if true, an error or timeout in the generateFunc causes the stale value to be evicted from the cache. Defaults to true. */
+    dropOnError?: boolean;
+    /** generateOnReadError - if false, an upstream cache read error will stop the get() method from calling the generate function and will instead pass back the cache error. Defaults to true. */
+    generateOnReadError?: boolean;
+    /** generateIgnoreWriteError - if false, an upstream cache write error will be passed back with the generated value when calling the get() method. Defaults to true. */
+    generateIgnoreWriteError?: boolean;
+    /**
+     * pendingGenerateTimeout - number of milliseconds while generateFunc call is in progress for a given id, before a subsequent generateFunc call is allowed.
+     * Defaults to 0, no blocking of concurrent generateFunc calls beyond staleTimeout.
+     */
+    pendingGenerateTimeout?: number;
+}
+
+/**
+ * generateFunc
+ * Is used in PolicyOptions
+ * A function used to generate a new cache item if one is not found in the cache when calling get(). The method's signature is function(id, next)
+ * @param id - the id string or object provided to the get() method.
+ * @param next - the method called when the new item is returned with the signature function(err, value, ttl) where:
+ *      * err - an error condition.
+ *      * value - the new value generated.
+ *      * ttl - the cache ttl value in milliseconds. Set to 0 to skip storing in the cache. Defaults to the cache global policy.
+ * @see {@link https://github.com/hapijs/catbox#policy}
+ */
+export type GenerateFunc = (id: string, next: ((err: null | Boom.BoomError, value: CacheItem, ttl?: number) => void)) => void;
+
+/**
+ * An object with logging information about the generation operation containing the following keys (as relevant):
+ */
+export interface PolicyGetCallbackReportLog {
+    /** msec - the cache lookup time in milliseconds. */
+    msec: number;
+    /** stored - the timestamp when the item was stored in the cache. */
+    stored: number;
+    /** isStale - true if the item is stale. */
+    isStale: boolean;
+    /** ttl - the cache ttl value for the record. */
+    ttl: number;
+    /** error - lookup error. */
+    error?: Boom.BoomError;
+}
+
+/**
+ * an object with cache statistics where:
+ */
+export interface CacheStatisticsObject {
+    /** sets - number of cache writes. */
+    sets: number;
+    /** gets - number of cache get() requests. */
+    gets: number;
+    /** hits - number of cache get() requests in which the requested id was found in the cache (can be stale). */
+    hits: number;
+    /** stales - number of cache reads with stale requests (only counts the first request in a queued get() operation). */
+    stales: number;
+    /** generates - number of calls to the generate function. */
+    generates: number;
+    /** errors - cache operations errors. TODO check this */
+    errors: number;
+}

types/catbox/v7/tsconfig.json

@@ -0,0 +1,31 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "lib": [
+            "es6"
+        ],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictNullChecks": true,
+        "strictFunctionTypes": true,
+        "baseUrl": "../../",
+        "typeRoots": [
+            "../../"
+        ],
+        "types": [],
+        "paths": {
+            "boom": [
+                "boom/v4"
+            ],
+            "catbox": [
+                "catbox/v7"
+            ]
+        },
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.d.ts",
+        "catbox-tests.ts"
+    ]
+}

types/catbox/v7/tslint.json

@@ -0,0 +1 @@
+{ "extends": "dtslint/dt.json" }

types/h2o2/tsconfig.json

@@ -17,6 +17,9 @@
             "boom": [
                 "boom/v4"
             ],
+            "catbox": [
+                "catbox/v7"
+            ],
             "hapi": [
                 "hapi/v16"
             ],

types/hapi-auth-basic/tsconfig.json

@@ -13,11 +13,6 @@
             "../"
         ],
         "types": [],
-        "paths": {
-            "boom": [
-                "boom/v4"
-            ]
-        },
         "noEmit": true,
         "forceConsistentCasingInFileNames": true
     },

types/hapi-auth-jwt2/tsconfig.json

@@ -17,6 +17,9 @@
             "boom": [
                 "boom/v4"
             ],
+            "catbox": [
+                "catbox/v7"
+            ],
             "hapi": [
                 "hapi/v16"
             ],

types/hapi-decorators/tsconfig.json

@@ -19,6 +19,9 @@
             "boom": [
                 "boom/v4"
             ],
+            "catbox": [
+                "catbox/v7"
+            ],
             "hapi": [
                 "hapi/v16"
             ],

types/hapi/index.d.ts

@@ -453,7 +453,7 @@ export interface Request extends Podium {
      * The response object when set. The object can be modified but must not be assigned another object. To replace the response with another from within an extension point, use reply(response) to
      * override with a different response. Contains null when no response has been set (e.g. when a request terminates prematurely when the client disconnects).
      */
-    response: ResponseObject | Boom.BoomError | null;
+    response: ResponseObject | Boom.Boom | null;
 
     /**
      * Same as pre but represented as the response object created by the pre method.
@@ -3847,7 +3847,7 @@ export namespace Lifecycle {
     type ReturnValueTypes =
         (null | string | number | boolean) |
         (Buffer) |
-        (Error | Boom.BoomError) |
+        (Error | Boom.Boom) |
         (stream.Stream) |
         (object | object[]) |
         symbol |

types/hapi/test/server/server-cache-provision.ts

@@ -9,8 +9,8 @@ server.initialize();
 server.cache.provision({engine: require('catbox-memory'), name: 'countries' });
 
 const cache: catbox.Policy = server.cache({segment: 'countries', cache: 'countries', expiresIn: 60 * 60 * 1000 });
-cache.set('norway', 'oslo', 10 * 1000, () => {});
-const value = cache.get('norway', () => {});
+cache.set('norway', 'oslo', 10 * 1000).then(() => {});
+const value = cache.get('norway').then(() => {});
 
 server.start();
 

types/hapi/test/server/server-cache.ts

@@ -11,9 +11,9 @@ const catboxOptions: ServerOptionsCache = {
     expiresIn: 60 * 60 * 1000
 };
 const cache: catbox.Policy = server.cache(catboxOptions);
-cache.set('norway', 'oslo', 10 * 1000, () => {});
+cache.set('norway', 'oslo', 10 * 1000).then(() => {});
 
-const value = cache.get('norway', () => {});
+const value = cache.get('norway').then(() => {});
 console.log("Value: " + value);
 
 server.start();

types/hapi/tsconfig.json

@@ -13,11 +13,6 @@
             "../"
         ],
         "types": [],
-        "paths": {
-            "boom": [
-                "boom/v4"
-            ]
-        },
         "noEmit": true,
         "forceConsistentCasingInFileNames": true
     },

types/hapi/v16/tsconfig.json

@@ -17,6 +17,9 @@
             "boom": [
                 "boom/v4"
             ],
+            "catbox": [
+                "catbox/v7"
+            ],
             "hapi": [
                 "hapi/v16"
             ],

types/inert/tsconfig.json

@@ -13,11 +13,6 @@
             "../"
         ],
         "types": [],
-        "paths": {
-            "boom": [
-                "boom/v4"
-            ]
-        },
         "noEmit": true,
         "forceConsistentCasingInFileNames": true
     },

types/inert/v4/tsconfig.json

@@ -17,6 +17,9 @@
             "boom": [
                 "boom/v4"
             ],
+            "catbox": [
+                "catbox/v7"
+            ],
             "hapi": [
                 "hapi/v16"
             ],

types/nes/tsconfig.json

@@ -13,11 +13,6 @@
             "../"
         ],
         "types": [],
-        "paths": {
-            "boom": [
-                "boom/v4"
-            ]
-        },
         "noEmit": true,
         "forceConsistentCasingInFileNames": true
     },

types/optics-agent/tsconfig.json

@@ -13,11 +13,6 @@
             "../"
         ],
         "types": [],
-        "paths": {
-            "boom": [
-                "boom/v4"
-            ]
-        },
         "noEmit": true,
         "forceConsistentCasingInFileNames": true
     },

types/swagger-express-mw/tsconfig.json

@@ -17,6 +17,9 @@
             "boom": [
                 "boom/v4"
             ],
+            "catbox": [
+                "catbox/v7"
+            ],
             "hapi": [
                 "hapi/v16"
             ],

types/swagger-hapi/tsconfig.json

@@ -17,6 +17,9 @@
             "boom": [
                 "boom/v4"
             ],
+            "catbox": [
+                "catbox/v7"
+            ],
             "hapi": [
                 "hapi/v16"
             ],

types/swagger-node-runner/tsconfig.json

@@ -17,6 +17,9 @@
             "boom": [
                 "boom/v4"
             ],
+            "catbox": [
+                "catbox/v7"
+            ],
             "hapi": [
                 "hapi/v16"
             ],

types/swagger-restify-mw/tsconfig.json

@@ -17,6 +17,9 @@
             "boom": [
                 "boom/v4"
             ],
+            "catbox": [
+                "catbox/v7"
+            ],
             "hapi": [
                 "hapi/v16"
             ],

types/swagger-sails-hook/tsconfig.json

@@ -17,6 +17,9 @@
             "boom": [
                 "boom/v4"
             ],
+            "catbox": [
+                "catbox/v7"
+            ],
             "hapi": [
                 "hapi/v16"
             ],

types/vision/tsconfig.json

@@ -13,11 +13,6 @@
             "../"
         ],
         "types": [],
-        "paths": {
-             "boom": [
-                "boom/v4"
-            ]
-        },
         "noEmit": true,
         "forceConsistentCasingInFileNames": true
     },

types/vision/v4/tsconfig.json

@@ -17,6 +17,9 @@
             "boom": [
                 "boom/v4"
             ],
+            "catbox": [
+                "catbox/v7"
+            ],
             "hapi": [
                 "hapi/v16"
             ],

types/yar/tsconfig.json

@@ -13,11 +13,6 @@
             "../"
         ],
         "types": [],
-        "paths": {
-            "boom": [
-                "boom/v4"
-            ]
-        },
         "noEmit": true,
         "forceConsistentCasingInFileNames": true
     },