feat: add an option to enable manifest parsing

framesjs · Dec 9, 2024 · 37e92a6 · 37e92a6
1 parent bb96c9a
commit 37e92a6
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 0 deletions.
diff --git a/packages/render/src/unstable-types.ts b/packages/render/src/unstable-types.ts
@@ -137,6 +137,14 @@ export type UseFrameOptions<
   frameActionProxy: string;
   /** the route used to GET the initial frame via proxy */
   frameGetProxy: string;
+  /**
+   * Will request the Farcaster Frames v2 manifest.
+   *
+   * This is only valid for Frames v2 and GET requests.
+   *
+   * @defaultValue false
+   */
+  parseFarcasterManifest?: boolean;
   /**
    * Called on initial frame load.
    *
@@ -501,6 +509,14 @@ export type UseFetchFrameOptions<
    * URL or path to the frame proxy handling POST requests.
    */
   frameActionProxy: string;
+  /**
+   * Will request the Farcaster Frames v2 manifest.
+   *
+   * This is only valid for Frames v2 and GET requests.
+   *
+   * @defaultValue false
+   */
+  parseFarcasterManifest?: boolean;
   /**
    * Extra payload to be sent with the POST request.
    */

diff --git a/packages/render/src/unstable-use-fetch-frame.ts b/packages/render/src/unstable-use-fetch-frame.ts
@@ -55,6 +55,7 @@ export function useFetchFrame<
   frameActionProxy,
   frameGetProxy,
   extraButtonRequestPayload,
+  parseFarcasterManifest = false,
   onTransaction,
   transactionDataSuffix,
   onSignature,
@@ -157,6 +158,7 @@ export function useFetchFrame<
       proxyUrl: frameGetProxy,
       fetchFn,
       url: request.url,
+      parseFarcasterManifest,
     });
 
     const endTime = new Date();
@@ -800,6 +802,10 @@ function proxyUrlAndSearchParamsToUrl(
 type FetchProxiedArg = {
   proxyUrl: string;
   fetchFn: typeof fetch;
+  /**
+   * Valid only for GET requests
+   */
+  parseFarcasterManifest?: boolean;
 } & (
   | {
       frameAction: SignedFrameAction;
@@ -836,6 +842,10 @@ async function fetchProxied(
     );
   }
 
+  if (params.parseFarcasterManifest) {
+    searchParams.set("parseFarcasterManifest", "true");
+  }
+
   searchParams.set("url", params.url);
 
   const proxyUrl = proxyUrlAndSearchParamsToUrl(params.proxyUrl, searchParams);

diff --git a/packages/render/src/unstable-use-frame.tsx b/packages/render/src/unstable-use-frame.tsx
@@ -172,6 +172,7 @@ export function useFrame_unstable<
   frameActionProxy,
   /** Ex: /frames */
   frameGetProxy,
+  parseFarcasterManifest = false,
   extraButtonRequestPayload,
   resolveSigner: resolveSpecification,
   onError = onErrorFallback,
@@ -238,6 +239,7 @@ export function useFrame_unstable<
     onTransactionProcessingSuccess,
     onTransactionStart,
     onTransactionSuccess,
+    parseFarcasterManifest,
   });
 
   const fetchFrameRef = useFreshRef(fetchFrame);