@farcaster/frame-sdk 0.0.64 → 0.1.0

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@farcaster/frame-sdk",
-  "version": "0.0.64",
+  "version": "0.1.0",
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/farcasterxyz/frames.git",
+    "url": "https://github.com/farcasterxyz/miniapps.git",
     "directory": "packages/frame-sdk"
   },
   "main": "dist/index.js",
@@ -16,14 +16,17 @@
     "esbuild": "^0.25.0",
     "mipd": "^0.0.7",
     "typescript": "^5.8.3",
-    "@farcaster/tsconfig": "0.0.5"
+    "@farcaster/tsconfig": "0.1.0"
   },
   "dependencies": {
     "@farcaster/quick-auth": "^0.0.6",
     "comlink": "^4.4.2",
     "eventemitter3": "^5.0.1",
     "ox": "^0.4.4",
-    "@farcaster/frame-core": "0.2.0"
+    "@farcaster/miniapp-sdk": "0.1.0"
+  },
+  "engines": {
+    "node": ">=22.11.0"
   },
   "scripts": {
     "clean": "rm -rf dist",

package/src/index.ts

@@ -1,11 +1,40 @@
-import { sdk } from './sdk.ts'
+// Deprecation warning
+if (typeof console !== 'undefined' && console.warn) {
+  console.warn(
+    '[DEPRECATION WARNING] @farcaster/frame-sdk is deprecated. Please migrate to @farcaster/miniapp-sdk. ' +
+      'See https://github.com/farcasterxyz/frames/blob/main/MIGRATION.md for migration guide.',
+  )
+}
 
-export * from './frameHost.ts'
-export * from './sdk.ts'
-export * from '@farcaster/frame-core'
+// Re-export everything from miniapp-sdk
+export * from '@farcaster/miniapp-sdk'
 
-export * as QuickAuth from './quickAuth.ts'
+// Import for aliasing
+import { miniAppHost, sdk as miniAppSdk } from '@farcaster/miniapp-sdk'
 
-export { quickAuth } from './quickAuth.ts'
+// Backward compatibility exports
+export const sdk = miniAppSdk
 
+// Create a proxy for frameHost that logs deprecation warning on first access
+let frameHostWarningShown = false
+export const frameHost = new Proxy(miniAppHost, {
+  get(target, prop, receiver) {
+    if (
+      !frameHostWarningShown &&
+      typeof console !== 'undefined' &&
+      console.warn
+    ) {
+      console.warn(
+        '[DEPRECATION WARNING] frameHost is deprecated. Please use miniAppHost instead. ' +
+          'Import from @farcaster/miniapp-sdk and use miniAppHost.',
+      )
+      frameHostWarningShown = true
+    }
+    return Reflect.get(target, prop, receiver)
+  },
+})
+
+export type FrameSDK = typeof miniAppSdk
+
+// Default export
 export default sdk

package/dist/back.d.ts

@@ -1,15 +0,0 @@
-import type { WireFrameHost } from '@farcaster/frame-core';
-import type { Remote } from 'comlink';
-import type { Emitter } from './types.ts';
-export type Back = {
-    visible: boolean;
-    show: () => Promise<void>;
-    hide: () => Promise<void>;
-    onback: (() => unknown) | null;
-    enableWebNavigation: () => Promise<void>;
-    disableWebNavigation: () => Promise<void>;
-};
-export declare const createBack: (options: {
-    emitter: Emitter;
-    frameHost: Remote<WireFrameHost>;
-}) => Back;

package/dist/back.js

@@ -1,88 +0,0 @@
-export const createBack = ({ frameHost, emitter }) => {
-    let teardownWebNavigation = undefined;
-    let backCb = null;
-    return {
-        visible: false,
-        get onback() {
-            return backCb;
-        },
-        set onback(cb) {
-            if (backCb) {
-                emitter.removeListener('backNavigationTriggered', backCb);
-            }
-            backCb = cb;
-            if (cb) {
-                emitter.addListener('backNavigationTriggered', cb);
-            }
-        },
-        async show() {
-            await frameHost.updateBackState({
-                visible: true,
-            });
-            this.visible = true;
-        },
-        async hide() {
-            await frameHost.updateBackState({
-                visible: false,
-            });
-            this.visible = false;
-        },
-        async enableWebNavigation() {
-            teardownWebNavigation = setupWebBack({
-                back: this,
-                emitter,
-            });
-        },
-        async disableWebNavigation() {
-            teardownWebNavigation?.();
-            teardownWebNavigation = undefined;
-        },
-    };
-};
-function setupWebBack({ emitter, back, }) {
-    const navigation = getWebNavigation();
-    if (navigation) {
-        return setupNavigationApi({ emitter, back, navigation });
-    }
-    if (typeof window !== 'undefined') {
-        return setupFallback({ emitter, back, window });
-    }
-}
-function getWebNavigation() {
-    if (typeof window !== 'undefined' && window.navigation !== undefined) {
-        return window.navigation;
-    }
-}
-function setupNavigationApi({ emitter, back, navigation, }) {
-    function handleNavigateSuccess() {
-        if (navigation.canGoBack) {
-            back.show();
-        }
-        else {
-            back.hide();
-        }
-    }
-    function handleBackNavigationTriggered() {
-        if (back.visible && navigation.canGoBack) {
-            navigation.back();
-        }
-    }
-    navigation.addEventListener('navigatesuccess', handleNavigateSuccess);
-    emitter.addListener('backNavigationTriggered', handleBackNavigationTriggered);
-    return () => {
-        navigation.removeEventListener('navigatesuccess', handleNavigateSuccess);
-        emitter.removeListener('backNavigationTriggered', handleBackNavigationTriggered);
-    };
-}
-function setupFallback({ emitter, back, window, }) {
-    back.show();
-    function handleBackNavigationTriggered() {
-        if (back.visible) {
-            window.history.back();
-        }
-    }
-    emitter.addListener('backNavigationTriggered', handleBackNavigationTriggered);
-    return () => {
-        emitter.removeListener('backNavigationTriggered', handleBackNavigationTriggered);
-    };
-}

package/dist/endpoint.d.ts

@@ -1,2 +0,0 @@
-import { type Endpoint } from 'comlink';
-export declare const endpoint: Endpoint;

package/dist/endpoint.js

@@ -1,32 +0,0 @@
-import { windowEndpoint } from 'comlink';
-const mockEndpoint = {
-    postMessage() {
-        // noop
-    },
-    addEventListener: () => {
-        // noop
-    },
-    removeEventListener: () => {
-        // noop
-    },
-};
-const webViewEndpoint = {
-    postMessage: (data) => {
-        console.debug('[webview:req]', data);
-        window.ReactNativeWebView.postMessage(JSON.stringify(data));
-    },
-    addEventListener: (_, listener, ...args) => {
-        document.addEventListener('FarcasterFrameCallback', listener, ...args);
-    },
-    removeEventListener: (_, listener) => {
-        document.removeEventListener('FarcasterFrameCallback', listener);
-    },
-};
-export const endpoint = (() => {
-    // No actions are actually gonna take place during SSR, thus it's safe to return mocked endpoint
-    if (typeof window === 'undefined')
-        return mockEndpoint;
-    return window?.ReactNativeWebView
-        ? webViewEndpoint
-        : windowEndpoint(window?.parent ?? window);
-})();

package/dist/ethereumProvider.d.ts

@@ -1,3 +0,0 @@
-import * as Provider from 'ox/Provider';
-export declare const ethereumProvider: Provider.Provider;
-export declare function getEthereumProvider(): Promise<Provider.Provider | undefined>;

package/dist/ethereumProvider.js

@@ -1,132 +0,0 @@
-import * as Provider from 'ox/Provider';
-import * as RpcRequest from 'ox/RpcRequest';
-import * as RpcResponse from 'ox/RpcResponse';
-import { frameHost } from "./frameHost.js";
-const emitter = Provider.createEmitter();
-const store = RpcRequest.createStore();
-function toProviderRpcError({ code, details, }) {
-    switch (code) {
-        case 4001:
-            return new Provider.UserRejectedRequestError();
-        case 4100:
-            return new Provider.UnauthorizedError();
-        case 4200:
-            return new Provider.UnsupportedMethodError();
-        case 4900:
-            return new Provider.DisconnectedError();
-        case 4901:
-            return new Provider.ChainDisconnectedError();
-        default:
-            return new Provider.ProviderRpcError(code, details ?? 'Unknown provider RPC error');
-    }
-}
-export const ethereumProvider = Provider.from({
-    ...emitter,
-    async request(args) {
-        // @ts-expect-error
-        const request = store.prepare(args);
-        try {
-            const response = await frameHost
-                .ethProviderRequestV2(request)
-                .then((res) => RpcResponse.parse(res, { request, raw: true }));
-            if (response.error) {
-                throw toProviderRpcError(response.error);
-            }
-            return response.result;
-        }
-        catch (e) {
-            // ethProviderRequestV2 not supported, fall back to v1
-            if (e instanceof Error &&
-                e.message.match(/cannot read property 'apply'/i)) {
-                return await frameHost.ethProviderRequest(request);
-            }
-            if (e instanceof Provider.ProviderRpcError ||
-                e instanceof RpcResponse.BaseError) {
-                throw e;
-            }
-            throw new RpcResponse.InternalError({
-                message: e instanceof Error ? e.message : undefined,
-            });
-        }
-    },
-});
-export async function getEthereumProvider() {
-    try {
-        const capabilities = await frameHost.getCapabilities();
-        if (!capabilities.includes('wallet.getEthereumProvider') &&
-            !capabilities.includes('wallet.getEvmProvider')) {
-            // We used getEvmProvider for a short period before getEthereumProvider.
-            // In case we're talking to an old host, we check the old key.
-            return undefined;
-        }
-        return ethereumProvider;
-    }
-    catch {
-        // If this is an old frame host that doesn't support getCapabilities,
-        // getEthereumProvider will assume that it's supported
-        return ethereumProvider;
-    }
-}
-function announceEvmProvider(detail) {
-    const event = new CustomEvent('eip6963:announceProvider', { detail: Object.freeze(detail) });
-    window.dispatchEvent(event);
-    const handler = () => window.dispatchEvent(event);
-    window.addEventListener('eip6963:requestProvider', handler);
-    return () => window.removeEventListener('eip6963:requestProvider', handler);
-}
-// Required to pass SSR
-if (typeof document !== 'undefined') {
-    // forward eip6963:requestProvider events to the host
-    document.addEventListener('eip6963:requestProvider', () => {
-        frameHost.eip6963RequestProvider();
-    });
-    // react native webview events
-    document.addEventListener('FarcasterFrameEthProviderEvent', (event) => {
-        if (event instanceof MessageEvent) {
-            const ethProviderEvent = event.data;
-            // @ts-expect-error
-            emitter.emit(ethProviderEvent.event, ...ethProviderEvent.params);
-        }
-    });
-    document.addEventListener('FarcasterFrameEvent', (event) => {
-        if (event instanceof MessageEvent) {
-            const frameEvent = event.data;
-            if (frameEvent.event === 'eip6963:announceProvider') {
-                announceEvmProvider({
-                    info: frameEvent.info,
-                    provider: ethereumProvider,
-                });
-            }
-        }
-    });
-}
-// Required to pass SSR
-if (typeof window !== 'undefined') {
-    // forward eip6963:requestProvider events to the host
-    window.addEventListener('eip6963:requestProvider', () => {
-        frameHost.eip6963RequestProvider();
-    });
-    // web events
-    window.addEventListener('message', (event) => {
-        if (event instanceof MessageEvent) {
-            if (event.data.type === 'frameEthProviderEvent') {
-                const ethProviderEvent = event.data;
-                // @ts-expect-error
-                emitter.emit(ethProviderEvent.event, ...ethProviderEvent.params);
-            }
-        }
-    });
-    window.addEventListener('message', (event) => {
-        if (event instanceof MessageEvent) {
-            if (event.data.type === 'frameEvent') {
-                const frameEvent = event.data.event;
-                if (frameEvent.event === 'eip6963:announceProvider') {
-                    announceEvmProvider({
-                        info: frameEvent.info,
-                        provider: ethereumProvider,
-                    });
-                }
-            }
-        }
-    });
-}

package/dist/frameHost.d.ts

@@ -1,2 +0,0 @@
-import type { WireFrameHost } from '@farcaster/frame-core';
-export declare const frameHost: import("comlink").Remote<WireFrameHost>;

package/dist/frameHost.js

@@ -1,3 +0,0 @@
-import { wrap } from 'comlink';
-import { endpoint } from "./endpoint.js";
-export const frameHost = wrap(endpoint);

package/dist/quickAuth.d.ts

@@ -1,42 +0,0 @@
-import { SignIn } from '@farcaster/frame-core';
-export declare namespace getToken {
-    type Options = {
-        /**
-         * Use a custom Quick Auth server, otherwise defaults to the public
-         * instance provided by Farcaster.
-         *
-         * @default https://auth.farcaster.xyz
-         */
-        quickAuthServerOrigin?: string;
-        /**
-         * Acquire a new token even if one is already in memory and not expired.
-         *
-         * @default false
-         */
-        force?: string;
-    };
-    type ReturnValue = {
-        token: string;
-    };
-    type ReturnType = Promise<ReturnValue>;
-    type ErrorType = SignIn.RejectedByUser | Error;
-}
-export type QuickAuth = {
-    /**
-     * Returns the session token if one is present and not expired.
-     */
-    readonly token: string | undefined;
-    /**
-     * Get a Quick Auth JWT.
-     *
-     * If a token is already in memory and not expired it will be returned unless
-     * `force` is used. Otherwise a new token will be acquired.
-     */
-    getToken: (options?: getToken.Options) => getToken.ReturnType;
-    /**
-     * Make an authenticated fetch request. The `Authorization` header will
-     * contain `Bearer ${token}` where token is a Quick Auth session token.
-     */
-    fetch: typeof fetch;
-};
-export declare const quickAuth: QuickAuth;

package/dist/quickAuth.js

@@ -1,74 +0,0 @@
-import { SignIn } from '@farcaster/frame-core';
-import { decodeJwt } from '@farcaster/quick-auth/decodeJwt';
-import { createLightClient } from '@farcaster/quick-auth/light';
-import * as Siwe from 'ox/Siwe';
-import { frameHost } from './frameHost.js';
-export const quickAuth = (() => {
-    let current;
-    let pendingPromise = undefined;
-    async function getTokenInner(options) {
-        const quickAuthClient = createLightClient({
-            origin: options.quickAuthServerOrigin,
-        });
-        const { nonce } = await quickAuthClient.generateNonce();
-        const response = await frameHost.signIn({
-            nonce,
-            acceptAuthAddress: true,
-        });
-        if (response.result) {
-            const parsedSiwe = Siwe.parseMessage(response.result.message);
-            // The Farcaster Client rendering the Mini App will set the domain
-            // based on the URL it's rendering. It should always be set.
-            if (!parsedSiwe.domain) {
-                throw new Error('Missing domain on SIWE message');
-            }
-            const verifyResult = await quickAuthClient.verifySiwf({
-                domain: parsedSiwe.domain,
-                message: response.result.message,
-                signature: response.result.signature,
-            });
-            current = {
-                token: verifyResult.token,
-                payload: decodeJwt(verifyResult.token),
-            };
-            return verifyResult;
-        }
-        if (response.error.type === 'rejected_by_user') {
-            throw new SignIn.RejectedByUser();
-        }
-        throw new Error('Unreachable');
-    }
-    return {
-        get token() {
-            if (current &&
-                new Date(current.payload.exp * 1000) > new Date(Date.now() + 15000)) {
-                return current.token;
-            }
-            return undefined;
-        },
-        async getToken(options = {}) {
-            const force = options.force ?? false;
-            if (current &&
-                !force &&
-                new Date(current.payload.exp * 1000) > new Date(Date.now() + 15000)) {
-                return { token: current.token };
-            }
-            if (!pendingPromise) {
-                pendingPromise = getTokenInner(options);
-            }
-            pendingPromise.finally(() => {
-                pendingPromise = undefined;
-            });
-            return pendingPromise;
-        },
-        async fetch(url, options) {
-            const { token } = await this.getToken();
-            const headers = new Headers(options?.headers);
-            headers.set('Authorization', `Bearer ${token}`);
-            return fetch(url, {
-                ...options,
-                headers,
-            });
-        },
-    };
-})();

package/dist/sdk.d.ts

@@ -1,2 +0,0 @@
-import type { FrameSDK } from './types.ts';
-export declare const sdk: FrameSDK;

package/dist/sdk.js

@@ -1,182 +0,0 @@
-import { AddMiniApp, SignIn, } from '@farcaster/frame-core';
-import { createBack } from "./back.js";
-import { ethereumProvider, getEthereumProvider } from "./ethereumProvider.js";
-import { frameHost } from "./frameHost.js";
-import { quickAuth } from "./quickAuth.js";
-import { emitter } from "./sdkEmitter.js";
-import { getSolanaProvider } from "./solanaProvider.js";
-let cachedIsInMiniAppResult = 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) {
-    // 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((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;
-}
-const addMiniApp = async () => {
-    const response = await frameHost.addFrame();
-    if (response.result) {
-        return response.result;
-    }
-    if (response.error.type === 'invalid_domain_manifest') {
-        throw new AddMiniApp.InvalidDomainManifest();
-    }
-    if (response.error.type === 'rejected_by_user') {
-        throw new AddMiniApp.RejectedByUser();
-    }
-    throw new Error('Unreachable');
-};
-export const sdk = {
-    ...emitter,
-    getCapabilities: frameHost.getCapabilities,
-    getChains: frameHost.getChains,
-    isInMiniApp,
-    context: frameHost.context,
-    back: createBack({ frameHost, emitter }),
-    quickAuth,
-    actions: {
-        setPrimaryButton: frameHost.setPrimaryButton.bind(frameHost),
-        ready: async (options = {}) => {
-            return await frameHost.ready(options);
-        },
-        close: frameHost.close.bind(frameHost),
-        viewCast: frameHost.viewCast.bind(frameHost),
-        viewProfile: frameHost.viewProfile.bind(frameHost),
-        signIn: async (options) => {
-            const response = await frameHost.signIn(options);
-            if (response.result) {
-                return response.result;
-            }
-            if (response.error.type === 'rejected_by_user') {
-                throw new SignIn.RejectedByUser();
-            }
-            throw new Error('Unreachable');
-        },
-        openUrl: (urlArg) => {
-            const url = typeof urlArg === 'string' ? urlArg : urlArg.url;
-            return frameHost.openUrl(url.trim());
-        },
-        addFrame: addMiniApp,
-        addMiniApp,
-        composeCast(options = {}) {
-            return frameHost.composeCast(options);
-        },
-        viewToken: frameHost.viewToken.bind(frameHost),
-        sendToken: frameHost.sendToken.bind(frameHost),
-        swapToken: frameHost.swapToken.bind(frameHost),
-    },
-    experimental: {
-        getSolanaProvider,
-        quickAuth(options) {
-            return quickAuth.getToken(options);
-        },
-    },
-    wallet: {
-        ethProvider: ethereumProvider,
-        getEthereumProvider,
-        getSolanaProvider,
-    },
-    haptics: {
-        impactOccurred: frameHost.impactOccurred.bind(frameHost),
-        notificationOccurred: frameHost.notificationOccurred.bind(frameHost),
-        selectionChanged: frameHost.selectionChanged.bind(frameHost),
-    },
-};
-// Required to pass SSR
-if (typeof document !== 'undefined') {
-    // react native webview events
-    document.addEventListener('FarcasterFrameEvent', (event) => {
-        if (event instanceof MessageEvent) {
-            const frameEvent = event.data;
-            if (frameEvent.event === 'primary_button_clicked') {
-                emitter.emit('primaryButtonClicked');
-            }
-            else if (frameEvent.event === 'frame_added') {
-                emitter.emit('frameAdded', {
-                    notificationDetails: frameEvent.notificationDetails,
-                });
-            }
-            else if (frameEvent.event === 'frame_add_rejected') {
-                emitter.emit('frameAddRejected', { reason: frameEvent.reason });
-            }
-            else if (frameEvent.event === 'frame_removed') {
-                emitter.emit('frameRemoved');
-            }
-            else if (frameEvent.event === 'notifications_enabled') {
-                emitter.emit('notificationsEnabled', {
-                    notificationDetails: frameEvent.notificationDetails,
-                });
-            }
-            else if (frameEvent.event === 'notifications_disabled') {
-                emitter.emit('notificationsDisabled');
-            }
-            else if (frameEvent.event === 'back_navigation_triggered') {
-                emitter.emit('backNavigationTriggered');
-            }
-        }
-    });
-}
-// Required to pass SSR
-if (typeof window !== 'undefined') {
-    // web events
-    window.addEventListener('message', (event) => {
-        if (event instanceof MessageEvent) {
-            if (event.data.type === 'frameEvent') {
-                const frameEvent = event.data.event;
-                if (frameEvent.event === 'primary_button_clicked') {
-                    emitter.emit('primaryButtonClicked');
-                }
-                else if (frameEvent.event === 'frame_added') {
-                    emitter.emit('frameAdded', {
-                        notificationDetails: frameEvent.notificationDetails,
-                    });
-                }
-                else if (frameEvent.event === 'frame_add_rejected') {
-                    emitter.emit('frameAddRejected', { reason: frameEvent.reason });
-                }
-                else if (frameEvent.event === 'frame_removed') {
-                    emitter.emit('frameRemoved');
-                }
-                else if (frameEvent.event === 'notifications_enabled') {
-                    emitter.emit('notificationsEnabled', {
-                        notificationDetails: frameEvent.notificationDetails,
-                    });
-                }
-                else if (frameEvent.event === 'notifications_disabled') {
-                    emitter.emit('notificationsDisabled');
-                }
-                else if (frameEvent.event === 'back_navigation_triggered') {
-                    emitter.emit('backNavigationTriggered');
-                }
-            }
-        }
-    });
-}