fix: 🐛 allow typed server methods access cache methods

lib/types/server/methods.d.ts

@@ -1,4 +1,13 @@
-import { PolicyOptions } from "@hapi/catbox";
+import { CacheStatisticsObject, PolicyOptions } from "@hapi/catbox";
+
+type AnyMethod = (...args: any[]) => any;
+
+export type CachedServerMethod<T extends AnyMethod> = T & {
+    cache?: {
+        drop(...args: Parameters<T>): Promise<void>;
+        stats: CacheStatisticsObject
+    }
+}
 
 /**
  * The method function with a signature async function(...args, [flags]) where:
@@ -7,7 +16,7 @@ import { PolicyOptions } from "@hapi/catbox";
  * * * ttl - 0 if result is valid but cannot be cached. Defaults to cache policy.
  * For reference [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-servermethodname-method-options)
  */
-export type ServerMethod = (...args: any[]) => any;
+export type ServerMethod = AnyMethod
 
 /**
  * The same cache configuration used in server.cache().
@@ -71,8 +80,16 @@ export interface ServerMethodConfigurationObject {
     options?: ServerMethodOptions | undefined;
 }
 
+interface BaseServerMethods {
+    [name: string]: (
+        ServerMethod |
+        CachedServerMethod<ServerMethod> |
+        BaseServerMethods
+    );
+}
+
 /**
  * An empty interface to allow typings of custom server.methods.
  */
-export interface ServerMethods extends Record<string, ServerMethod> {
+export interface ServerMethods extends BaseServerMethods {
 }

lib/types/server/server.d.ts

@@ -52,6 +52,7 @@ import {
 } from './methods';
 import { ServerOptions } from './options';
 import { ServerState, ServerStateCookieOptions } from './state';
+import { CacheStatisticsObject } from '@hapi/catbox';
 
 /**
  *  User-extensible type for application specific state (`server.app`).
@@ -203,7 +204,7 @@ export class Server<A = ServerApplicationState> {
      * server method name is an object property.
      * [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-servermethods
      */
-    readonly methods: ServerMethods;
+    readonly methods: ServerMethods
 
     /**
      * Provides access to the server MIME database used for setting content-type information. The object must not be

test/types/index.ts

@@ -10,7 +10,9 @@ import {
     Server,
     ServerRoute,
     server as createServer,
-    ServerRegisterPluginObject
+    ServerRegisterPluginObject,
+    Lifecycle,
+    CachedServerMethod
 } from '../..';
 
 const { expect: check } = lab;
@@ -34,11 +36,20 @@ interface RequestDecorations {
     },
     RouteApp: {
         prefix: string[];
+    },
+    Pres: {
+        some: string,
+        another: number
     }
 }
 
 type AppRequest = Request<RequestDecorations>;
 
+const getNum: Lifecycle.Method = (req) => {
+
+    return 10;
+}
+
 const route: ServerRoute<RequestDecorations> = {
     method: 'POST',
     path: '/',
@@ -51,7 +62,20 @@ const route: ServerRoute<RequestDecorations> = {
             maxBytes: 1024 * 1024,
             output: 'stream',
             multipart: true
-        }
+        },
+        pre: [
+            {
+                assign: 'some',
+                method: ((req) => {
+
+                    return req.app.word;
+                }) as Lifecycle.Method<RequestDecorations>
+            },
+            {
+                assign: 'another',
+                method: getNum
+            }
+        ]
     },
     handler: (request: AppRequest, h: ResponseToolkit) => {
 
@@ -114,6 +138,14 @@ server.cache.provision({
     }
 })
 
+declare module '../..' {
+    interface ServerMethods {
+        test: {
+            add: CachedServerMethod<((a: number, b: number) => number)>;
+        }
+    }
+}
+
 server.method('test.add', (a: number, b: number) => a + b, {
     bind: server,
     cache: {
@@ -123,4 +155,6 @@ server.method('test.add', (a: number, b: number) => a + b, {
         segment: 'test-segment',
     },
     generateKey: (a: number, b: number) => `${a}${b}`
-});
+});
+
+server.methods.test.add.cache?.drop(1, 2);