@farcaster/frame-sdk 0.0.0-canary-20250430152807 → 0.0.0-canary-20250508001237

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-import type { AddFrame, ComposeCast, Context, FrameNotificationDetails, Ready, SendToken, SetPrimaryButtonOptions, SignIn, SwapToken, ViewProfile, ViewToken } from '@farcaster/frame-core';
+import type { AddFrame, ComposeCast, Context, FrameNotificationDetails, Ready, SendToken, SetPrimaryButtonOptions, ShareStateProvider, SignIn, SwapToken, ViewProfile, ViewToken } from '@farcaster/frame-core';
 import type { EventEmitter } from 'eventemitter3';
 import type * as Provider from 'ox/Provider';
 declare global {
@@ -29,6 +29,7 @@ export type EventMap = {
 export type Emitter = Compute<EventEmitter<EventMap>>;
 type SetPrimaryButton = (options: SetPrimaryButtonOptions) => Promise<void>;
 export type FrameSDK = {
+    isInMiniApp: () => Promise<boolean>;
     context: Promise<Context.FrameContext>;
     actions: {
         ready: (options?: Partial<Ready.ReadyOptions>) => Promise<void>;
@@ -48,5 +49,6 @@ export type FrameSDK = {
     wallet: {
         ethProvider: Provider.Provider;
     };
+    setShareStateProvider: (fn: ShareStateProvider) => void;
 } & Emitter;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@farcaster/frame-sdk",
-  "version": "0.0.0-canary-20250430152807",
+  "version": "0.0.0-canary-20250508001237",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -22,7 +22,7 @@
     "comlink": "^4.4.2",
     "eventemitter3": "^5.0.1",
     "ox": "^0.4.4",
-    "@farcaster/frame-core": "0.0.0-canary-20250430152807"
+    "@farcaster/frame-core": "0.0.0-canary-20250508001237"
   },
   "scripts": {
     "clean": "rm -rf dist",

package/src/sdk.ts

@@ -1,4 +1,10 @@
-import { AddFrame, type FrameClientEvent, SignIn } from '@farcaster/frame-core'
+import {
+  AddFrame,
+  type FrameClientEvent,
+  type ShareStateProvider,
+  SignIn,
+} from '@farcaster/frame-core'
+import { proxy } from 'comlink'
 import { EventEmitter } from 'eventemitter3'
 import { frameHost } from './frameHost'
 import { provider } from './provider'
@@ -28,9 +34,52 @@ export function createEmitter(): Emitter {
 }
 
 const emitter = createEmitter()
+let cachedIsInMiniAppResult: boolean | null = null
+
+/**
+ * Determines if the current environment is a MiniApp context.
+ *
+ * @param timeoutMs - Optional timeout in milliseconds (default: 50)
+ * @returns Promise resolving to boolean indicating if in MiniApp context
+ */
+async function isInMiniApp(timeoutMs = 50): Promise<boolean> {
+  // Return cached result if we've already determined we are in a MiniApp
+  if (cachedIsInMiniAppResult === true) {
+    return true
+  }
+
+  // Check for SSR environment - definitely not a MiniApp
+  if (typeof window === 'undefined') {
+    return false
+  }
+
+  // Short-circuit: definitely NOT a MiniApp
+  if (!window.ReactNativeWebView && window === window.parent) {
+    return false
+  }
+
+  // At this point, we MIGHT be in a MiniApp (iframe or RN WebView)
+  // but need to verify by checking for context communication.
+  const isInMiniApp = await Promise.race([
+    frameHost.context.then((context) => !!context), // Check if context resolves to truthy
+    new Promise<boolean>((resolve) => {
+      setTimeout(() => resolve(false), timeoutMs) // Timeout resolves to false
+    }),
+  ]).catch(() => {
+    return false
+  })
+
+  // Cache the result ONLY if true (we are confirmed to be in a MiniApp)
+  if (isInMiniApp) {
+    cachedIsInMiniAppResult = true
+  }
+
+  return isInMiniApp
+}
 
 export const sdk: FrameSDK = {
   ...emitter,
+  isInMiniApp,
   context: frameHost.context,
   actions: {
     setPrimaryButton: frameHost.setPrimaryButton.bind(frameHost),
@@ -81,6 +130,9 @@ export const sdk: FrameSDK = {
   wallet: {
     ethProvider: provider,
   },
+  setShareStateProvider: (fn: ShareStateProvider) => {
+    frameHost.setShareStateProvider.bind(frameHost)(proxy(fn))
+  },
 }
 
 // Required to pass SSR

package/src/types.ts

@@ -6,6 +6,7 @@ import type {
   Ready,
   SendToken,
   SetPrimaryButtonOptions,
+  ShareStateProvider,
   SignIn,
   SwapToken,
   ViewProfile,
@@ -51,6 +52,7 @@ export type Emitter = Compute<EventEmitter<EventMap>>
 type SetPrimaryButton = (options: SetPrimaryButtonOptions) => Promise<void>
 
 export type FrameSDK = {
+  isInMiniApp: () => Promise<boolean>
   context: Promise<Context.FrameContext>
   actions: {
     ready: (options?: Partial<Ready.ReadyOptions>) => Promise<void>
@@ -72,4 +74,5 @@ export type FrameSDK = {
   wallet: {
     ethProvider: Provider.Provider
   }
+  setShareStateProvider: (fn: ShareStateProvider) => void
 } & Emitter