fix: tighten types

godaddy · Nov 21, 2024 · cb90cb8 · cb90cb8
1 parent 7f8e0f2
commit cb90cb8
Show file tree

Hide file tree

Showing 5 changed files with 36 additions and 16 deletions.
diff --git a/packages/gasket-nextjs/lib/request/index.js b/packages/gasket-nextjs/lib/request/index.js
@@ -1,6 +1,11 @@
 import { makeGasketRequest, WeakPromiseKeeper } from '@gasket/request';
 import { cookies, headers } from 'next/headers';
 
+/** @typedef {import('@gasket/request').GasketRequest} GasketRequest */
+
+/**
+ * @type {import('@gasket/request').WeakPromiseKeeper<Headers, GasketRequest>}
+ */
 const keeper = new WeakPromiseKeeper();
 
 /** @type {import('.').request} */

diff --git a/packages/gasket-request/lib/index.d.ts b/packages/gasket-request/lib/index.d.ts
@@ -10,9 +10,8 @@ export type RequestLike = {
 }
 
 /**
- *
+ * Capture the cookies as a key/value object
  * @see https://developer.mozilla.org/en-US/docs/Web/API/CookieStore/getAll
- * @param cookieStore
  */
 async function objectFromCookieStore(cookieStore: CookieStore): Promise<Record<string, string>>;
 
@@ -33,7 +32,12 @@ export class GasketRequest {
   path: string
 }
 
-export class WeakPromiseKeeper extends WeakMap {}
+export class WeakPromiseKeeper<Key extends WeakKey = WeakKey, Value = any> {
+  set(key: Key, value: Promise<Value>): this
+  get(key: Key): Promise<Value> | Value
+  has(key: Key): boolean
+  delete(key: Key): boolean
+}
 
 /**
  * Get a normalized request object for GasketActions
@@ -45,3 +49,6 @@ type RequestActionWrapperFn<Result, Args extends Array<unknown>> = (gasket: Gask
 
 export function withGasketRequest<Result, Args extends Array<unknown>>(actionFn: RequestActionFn<Result, Args>): RequestActionWrapperFn<Result, Args>;
 export function withGasketRequestCache<Result, Args extends Array<unknown>>(actionFn: RequestActionFn<Result, Args>): RequestActionWrapperFn<Result, Args>;
+
+
+const map = new WeakPromiseKeeper<GasketRequest, any>();
diff --git a/packages/gasket-request/lib/keeper.js b/packages/gasket-request/lib/keeper.js
@@ -1,5 +1,5 @@
 /**
- * @type {import('./index.js').WeakPromiseKeeper}
+ * @type {typeof import('./index.js').WeakPromiseKeeper}
  */
 // @ts-ignore - https://github.com/microsoft/TypeScript/issues/56664
 export class WeakPromiseKeeper extends WeakMap {

diff --git a/packages/gasket-request/lib/request.js b/packages/gasket-request/lib/request.js
@@ -1,5 +1,20 @@
 import { WeakPromiseKeeper } from './keeper.js';
 
+/**
+ * @type {import('./index.js').GasketRequest}
+ */
+export class GasketRequest {
+  constructor(normalizedRequest) {
+    this.headers = normalizedRequest.headers;
+    this.cookies = normalizedRequest.cookies;
+    this.query = normalizedRequest.query;
+    this.path = normalizedRequest.path;
+  }
+}
+
+/**
+ * @type {import('./index.js').WeakPromiseKeeper<Headers|Record<string,string>, GasketRequest>}
+ */
 const keeper = new WeakPromiseKeeper();
 
 /**
@@ -13,18 +28,6 @@ async function objectFromCookieStore(cookieStore) {
     }, {});
 }
 
-/**
- * @type {import('./index.js').GasketRequest}
- */
-export class GasketRequest {
-  constructor(normalizedRequest) {
-    this.headers = normalizedRequest.headers;
-    this.cookies = normalizedRequest.cookies;
-    this.query = normalizedRequest.query;
-    this.path = normalizedRequest.path;
-  }
-}
-
 /**
  * @type {import('./index.js').makeGasketRequest}
  */

diff --git a/packages/gasket-request/lib/wrappers.js b/packages/gasket-request/lib/wrappers.js
@@ -1,8 +1,13 @@
 import { makeGasketRequest } from './request.js';
 import { WeakPromiseKeeper } from './keeper.js';
 
+/** @typedef {import('./index.js').GasketRequest} GasketRequest */
+
 /** @type {typeof import('./index.d.ts').withGasketRequestCache} */
 export function withGasketRequestCache(actionFn) {
+  /**
+   * @type {import('./index.js').WeakPromiseKeeper<GasketRequest>}
+   */
   const keeper = new WeakPromiseKeeper();
 
   return async (gasket, req, ...args) => {