fix: make hooks generic

framesjs · Nov 4, 2024 · b8270b3 · b8270b3
1 parent 65950d5
commit b8270b3
Show file tree

Hide file tree

Showing 3 changed files with 58 additions and 16 deletions.
diff --git a/packages/render/src/unstable-types.ts b/packages/render/src/unstable-types.ts
@@ -49,7 +49,7 @@ export type ResolveSignerFunction = (
 export type UseFrameOptions<
   TExtraDataPending = unknown,
   TExtraDataDone = unknown,
-  TExtraDataoneRedirect = unknown,
+  TExtraDataDoneRedirect = unknown,
   TExtraDataRequestError = unknown,
   TExtraDataMesssage = unknown,
 > = {
@@ -61,7 +61,7 @@ export type UseFrameOptions<
       UseFrameStateOptions<
         TExtraDataPending,
         TExtraDataDone,
-        TExtraDataoneRedirect,
+        TExtraDataDoneRedirect,
         TExtraDataRequestError,
         TExtraDataMesssage
       >,
@@ -70,7 +70,7 @@ export type UseFrameOptions<
   ) => UseFrameStateReturn<
     TExtraDataPending,
     TExtraDataDone,
-    TExtraDataoneRedirect,
+    TExtraDataDoneRedirect,
     TExtraDataRequestError,
     TExtraDataMesssage
   >;
@@ -218,7 +218,7 @@ export type FramesStackItem<
 export type UseFrameReturnValue<
   TExtraDataPending = unknown,
   TExtraDataDone = unknown,
-  TExtraDataoneRedirect = unknown,
+  TExtraDataDoneRedirect = unknown,
   TExtraDataRequestError = unknown,
   TExtraDataMesssage = unknown,
 > = {
@@ -236,7 +236,7 @@ export type UseFrameReturnValue<
     FrameReducerActions<
       TExtraDataPending,
       TExtraDataDone,
-      TExtraDataoneRedirect,
+      TExtraDataDoneRedirect,
       TExtraDataRequestError,
       TExtraDataMesssage
     >
@@ -247,7 +247,7 @@ export type UseFrameReturnValue<
   readonly framesStack: FramesStack<
     TExtraDataPending,
     TExtraDataDone,
-    TExtraDataoneRedirect,
+    TExtraDataDoneRedirect,
     TExtraDataRequestError,
     TExtraDataMesssage
   >;
@@ -318,9 +318,21 @@ export type FrameReducerActions<
       extra: TExtraDone;
     };
 
-export type UseFetchFrameOptions = {
+export type UseFetchFrameOptions<
+  TExtraPending = unknown,
+  TExtraDone = unknown,
+  TExtraDoneRedirect = unknown,
+  TExtraRequestError = unknown,
+  TExtraMesssage = unknown,
+> = {
   frameState: FrameState;
-  frameStateAPI: FrameStateAPI;
+  frameStateAPI: FrameStateAPI<
+    TExtraPending,
+    TExtraDone,
+    TExtraDoneRedirect,
+    TExtraRequestError,
+    TExtraMesssage
+  >;
   /**
    * URL or path to the frame proxy handling GET requests.
    */

diff --git a/packages/render/src/unstable-use-fetch-frame.ts b/packages/render/src/unstable-use-fetch-frame.ts
@@ -43,7 +43,13 @@ function defaultErrorHandler(error: Error): void {
   console.error(error);
 }
 
-export function useFetchFrame({
+export function useFetchFrame<
+  TExtraPending = unknown,
+  TExtraDone = unknown,
+  TExtraDoneRedirect = unknown,
+  TExtraRequestError = unknown,
+  TExtraMesssage = unknown,
+>({
   frameStateAPI,
   frameState,
   frameActionProxy,
@@ -67,7 +73,13 @@ export function useFetchFrame({
   onTransactionProcessingError,
   onTransactionProcessingStart,
   onTransactionProcessingSuccess,
-}: UseFetchFrameOptions): FetchFrameFunction {
+}: UseFetchFrameOptions<
+  TExtraPending,
+  TExtraDone,
+  TExtraDoneRedirect,
+  TExtraRequestError,
+  TExtraMesssage
+>): FetchFrameFunction {
   async function handleFailedResponse({
     response,
     endTime,
@@ -76,7 +88,7 @@ export function useFetchFrame({
   }: {
     endTime: Date;
     response: Response;
-    frameStackPendingItem: FrameStackPending;
+    frameStackPendingItem: FrameStackPending<TExtraPending>;
     onError?: (error: Error) => void;
   }): Promise<void> {
     if (response.ok) {
@@ -228,15 +240,15 @@ export function useFetchFrame({
     request: FramePOSTRequest<SignerStateActionContext>,
     options?: {
       preflightRequest?: {
-        pendingFrameStackItem: FrameStackPostPending;
+        pendingFrameStackItem: FrameStackPostPending<TExtraPending>;
         startTime: Date;
       };
       shouldClear?: boolean;
       onError?: (error: Error) => void;
       onSuccess?: () => void;
     }
   ): Promise<void> {
-    let pendingItem: FrameStackPostPending;
+    let pendingItem: FrameStackPostPending<TExtraPending>;
 
     if (frameState.type === "not-initialized") {
       throw new Error(
@@ -301,7 +313,7 @@ export function useFetchFrame({
       onSuccess: onSuccessInternal,
     }: {
       response: Response;
-      currentPendingItem: FrameStackPostPending;
+      currentPendingItem: FrameStackPostPending<TExtraPending>;
       onError?: (error: Error) => void;
       onSuccess?: () => void;
     }): Promise<void> {

diff --git a/packages/render/src/unstable-use-frame.tsx b/packages/render/src/unstable-use-frame.tsx
@@ -137,7 +137,13 @@ export type {
 };
 
 // eslint-disable-next-line camelcase -- this is only temporary
-export function useFrame_unstable({
+export function useFrame_unstable<
+  TExtraDataPending = unknown,
+  TExtraDataDone = unknown,
+  TExtraDataDoneRedirect = unknown,
+  TExtraDataRequestError = unknown,
+  TExtraDataMesssage = unknown,
+>({
   frameStateHook: useFrameStateHook = useFrameState,
   homeframeUrl,
   onMint = onMintFallback,
@@ -166,7 +172,19 @@ export function useFrame_unstable({
   onTransactionProcessingSuccess,
   onTransactionStart,
   onTransactionSuccess,
-}: UseFrameOptions): UseFrameReturnValue {
+}: UseFrameOptions<
+  TExtraDataPending,
+  TExtraDataDone,
+  TExtraDataDoneRedirect,
+  TExtraDataRequestError,
+  TExtraDataMesssage
+>): UseFrameReturnValue<
+  TExtraDataPending,
+  TExtraDataDone,
+  TExtraDataDoneRedirect,
+  TExtraDataRequestError,
+  TExtraDataMesssage
+> {
   const [inputText, setInputText] = useState("");
   const inputTextRef = useFreshRef(inputText);
   const [frameState, frameStateAPI] = useFrameStateHook({