fix: 🐛 reflect reality of Hapi methods in types

hapijs · Jul 29, 2024 · e63d51e · e63d51e
1 parent 4a4188b
commit e63d51e
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 17 deletions.
diff --git a/lib/types/route.d.ts b/lib/types/route.d.ts
@@ -354,7 +354,7 @@ export interface RouteOptionsPreObject<Refs extends ReqRef = ReqRefDefaults> {
     /**
      * a lifecycle method.
      */
-    method: Lifecycle.Method<any>;
+    method: Lifecycle.Method<Refs>;
     /**
      * key name used to assign the response of the method to in request.pre and request.preResponses.
      */

diff --git a/lib/types/server/methods.d.ts b/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 {
 }
diff --git a/lib/types/server/server.d.ts b/lib/types/server/server.d.ts
@@ -204,14 +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: {
-        [K in keyof ServerMethods]: ServerMethods[K] & {
-            cache?: {
-                drop(...args: Parameters<ServerMethods[K]>): Promise<void>;
-                stats: CacheStatisticsObject
-            }
-        }
-    };
+    readonly methods: ServerMethods
 
     /**
      * Provides access to the server MIME database used for setting content-type information. The object must not be

diff --git a/test/types/index.ts b/test/types/index.ts
@@ -11,7 +11,8 @@ import {
     ServerRoute,
     server as createServer,
     ServerRegisterPluginObject,
-    Lifecycle
+    Lifecycle,
+    CachedServerMethod
 } from '../..';
 
 const { expect: check } = lab;
@@ -139,7 +140,9 @@ server.cache.provision({
 
 declare module '../..' {
     interface ServerMethods {
-        'test.add'(a: number, b: number): number;
+        test: {
+            add: CachedServerMethod<((a: number, b: number) => number)>;
+        }
     }
 }
 
@@ -154,6 +157,4 @@ server.method('test.add', (a: number, b: number) => a + b, {
     generateKey: (a: number, b: number) => `${a}${b}`
 });
 
-
-
-server.methods['test.add'].cache?.drop(1, 2);
+server.methods.test.add.cache?.drop(1, 2);