@farcaster/frame-sdk 0.0.64 → 0.1.0

package/dist/sdkEmitter.d.ts

@@ -1,15 +0,0 @@
-import EventEmitter from 'eventemitter3';
-import type { Emitter, EventMap } from './types.ts';
-export declare function createEmitter(): Emitter;
-export declare const emitter: {
-    eventNames: () => (keyof EventMap)[];
-    listeners: <T extends keyof EventMap>(event: T) => ((...args: EventEmitter.ArgumentMap<EventMap>[Extract<T, keyof EventMap>]) => void)[];
-    listenerCount: (event: keyof EventMap) => number;
-    emit: <T extends keyof EventMap>(event: T, ...args: EventEmitter.ArgumentMap<EventMap>[Extract<T, keyof EventMap>]) => boolean;
-    on: <T extends keyof EventMap>(event: T, fn: (...args: EventEmitter.ArgumentMap<EventMap>[Extract<T, keyof EventMap>]) => void, context?: any) => EventEmitter<EventMap, any>;
-    addListener: <T extends keyof EventMap>(event: T, fn: (...args: EventEmitter.ArgumentMap<EventMap>[Extract<T, keyof EventMap>]) => void, context?: any) => EventEmitter<EventMap, any>;
-    once: <T extends keyof EventMap>(event: T, fn: (...args: EventEmitter.ArgumentMap<EventMap>[Extract<T, keyof EventMap>]) => void, context?: any) => EventEmitter<EventMap, any>;
-    removeListener: <T extends keyof EventMap>(event: T, fn?: ((...args: EventEmitter.ArgumentMap<EventMap>[Extract<T, keyof EventMap>]) => void) | undefined, context?: any, once?: boolean) => EventEmitter<EventMap, any>;
-    off: <T extends keyof EventMap>(event: T, fn?: ((...args: EventEmitter.ArgumentMap<EventMap>[Extract<T, keyof EventMap>]) => void) | undefined, context?: any, once?: boolean) => EventEmitter<EventMap, any>;
-    removeAllListeners: (event?: keyof EventMap | undefined) => EventEmitter<EventMap, any>;
-};

package/dist/sdkEmitter.js

@@ -1,23 +0,0 @@
-import EventEmitter from 'eventemitter3';
-export function createEmitter() {
-    const emitter = new EventEmitter();
-    return {
-        get eventNames() {
-            return emitter.eventNames.bind(emitter);
-        },
-        get listenerCount() {
-            return emitter.listenerCount.bind(emitter);
-        },
-        get listeners() {
-            return emitter.listeners.bind(emitter);
-        },
-        addListener: emitter.addListener.bind(emitter),
-        emit: emitter.emit.bind(emitter),
-        off: emitter.off.bind(emitter),
-        on: emitter.on.bind(emitter),
-        once: emitter.once.bind(emitter),
-        removeAllListeners: emitter.removeAllListeners.bind(emitter),
-        removeListener: emitter.removeListener.bind(emitter),
-    };
-}
-export const emitter = createEmitter();

package/dist/solanaProvider.d.ts

@@ -1,3 +0,0 @@
-import { type SolanaWalletProvider } from '@farcaster/frame-core';
-declare function getSolanaProvider(): Promise<SolanaWalletProvider | undefined>;
-export { getSolanaProvider };

package/dist/solanaProvider.js

@@ -1,19 +0,0 @@
-import { createSolanaWalletProvider, unwrapSolanaProviderRequest, } from '@farcaster/frame-core';
-import { frameHost } from "./frameHost.js";
-const { solanaProviderRequest } = frameHost;
-let solanaProvider;
-if (solanaProviderRequest) {
-    solanaProvider = createSolanaWalletProvider(unwrapSolanaProviderRequest(solanaProviderRequest));
-}
-async function getSolanaProvider() {
-    let capabilities;
-    try {
-        capabilities = await frameHost.getCapabilities();
-    }
-    catch { }
-    if (!capabilities?.includes('wallet.getSolanaProvider')) {
-        return undefined;
-    }
-    return solanaProvider;
-}
-export { getSolanaProvider };

package/dist/types.d.ts

@@ -1,74 +0,0 @@
-import type { AddMiniApp, ComposeCast, Context, FrameNotificationDetails, GetCapabilities, GetChains, ImpactOccurred, NotificationOccurred, Ready, SelectionChanged, SendToken, SetPrimaryButtonOptions, SignIn, SolanaWalletProvider, SwapToken, ViewCast, ViewProfile, ViewToken } from '@farcaster/frame-core';
-import type { EventEmitter } from 'eventemitter3';
-import type * as Provider from 'ox/Provider';
-import type { Back } from './back.ts';
-import type { QuickAuth } from './quickAuth.ts';
-declare global {
-    interface Window {
-        ReactNativeWebView: {
-            postMessage: (message: string) => void;
-        };
-    }
-}
-/** Combines members of an intersection into a readable type. */
-type Compute<type> = {
-    [key in keyof type]: type[key];
-} & unknown;
-export type EventMap = {
-    primaryButtonClicked: () => void;
-    frameAdded: ({ notificationDetails, }: {
-        notificationDetails?: FrameNotificationDetails;
-    }) => void;
-    frameAddRejected: ({ reason, }: {
-        reason: AddMiniApp.AddMiniAppRejectedReason;
-    }) => void;
-    frameRemoved: () => void;
-    notificationsEnabled: ({ notificationDetails, }: {
-        notificationDetails: FrameNotificationDetails;
-    }) => void;
-    notificationsDisabled: () => void;
-    backNavigationTriggered: () => void;
-};
-export type Emitter = Compute<EventEmitter<EventMap>>;
-type SetPrimaryButton = (options: SetPrimaryButtonOptions) => Promise<void>;
-export type FrameSDK = {
-    getCapabilities: GetCapabilities;
-    getChains: GetChains;
-    isInMiniApp: () => Promise<boolean>;
-    context: Promise<Context.FrameContext>;
-    back: Back;
-    quickAuth: QuickAuth;
-    actions: {
-        ready: (options?: Partial<Ready.ReadyOptions>) => Promise<void>;
-        openUrl: (url: string) => Promise<void>;
-        close: () => Promise<void>;
-        setPrimaryButton: SetPrimaryButton;
-        addFrame: AddMiniApp.AddMiniApp;
-        addMiniApp: AddMiniApp.AddMiniApp;
-        signIn: SignIn.SignIn;
-        viewCast: ViewCast.ViewCast;
-        viewProfile: ViewProfile.ViewProfile;
-        composeCast: <close extends boolean | undefined = undefined>(options?: ComposeCast.Options<close>) => Promise<ComposeCast.Result<close>>;
-        viewToken: ViewToken.ViewToken;
-        sendToken: SendToken.SendToken;
-        swapToken: SwapToken.SwapToken;
-    };
-    experimental: {
-        getSolanaProvider: () => Promise<SolanaWalletProvider | undefined>;
-        /**
-         * @deprecated - use `sdk.quickAuth.getToken`
-         */
-        quickAuth: QuickAuth['getToken'];
-    };
-    wallet: {
-        ethProvider: Provider.Provider;
-        getEthereumProvider: () => Promise<Provider.Provider | undefined>;
-        getSolanaProvider: () => Promise<SolanaWalletProvider | undefined>;
-    };
-    haptics: {
-        impactOccurred: ImpactOccurred;
-        notificationOccurred: NotificationOccurred;
-        selectionChanged: SelectionChanged;
-    };
-} & Emitter;
-export {};

package/dist/types.js

@@ -1 +0,0 @@
-export {};

package/src/back.ts

@@ -1,143 +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 const createBack: (options: {
-  emitter: Emitter
-  frameHost: Remote<WireFrameHost>
-}) => Back = ({ frameHost, emitter }) => {
-  let teardownWebNavigation: (() => void) | undefined = undefined
-  let backCb: (() => unknown) | null = 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,
-}: {
-  emitter: Emitter
-  back: Back
-}) {
-  const navigation = getWebNavigation()
-  if (navigation) {
-    return setupNavigationApi({ emitter, back, navigation })
-  }
-
-  if (typeof window !== 'undefined') {
-    return setupFallback({ emitter, back, window })
-  }
-}
-
-function getWebNavigation(): Navigation | undefined {
-  if (typeof window !== 'undefined' && window.navigation !== undefined) {
-    return window.navigation
-  }
-}
-
-function setupNavigationApi({
-  emitter,
-  back,
-  navigation,
-}: {
-  emitter: Emitter
-  back: Back
-  navigation: 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,
-}: {
-  emitter: Emitter
-  back: Back
-  window: Window
-}) {
-  back.show()
-
-  function handleBackNavigationTriggered() {
-    if (back.visible) {
-      window.history.back()
-    }
-  }
-
-  emitter.addListener('backNavigationTriggered', handleBackNavigationTriggered)
-
-  return () => {
-    emitter.removeListener(
-      'backNavigationTriggered',
-      handleBackNavigationTriggered,
-    )
-  }
-}

package/src/endpoint.ts

@@ -1,34 +0,0 @@
-import { type Endpoint, windowEndpoint } from 'comlink'
-
-const mockEndpoint: Endpoint = {
-  postMessage() {
-    // noop
-  },
-  addEventListener: () => {
-    // noop
-  },
-  removeEventListener: () => {
-    // noop
-  },
-}
-
-const webViewEndpoint: Endpoint = {
-  postMessage: (data: unknown) => {
-    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/src/ethereumProvider.ts

@@ -1,183 +0,0 @@
-import type {
-  EthProviderWireEvent,
-  FrameClientEvent,
-  MiniAppHostCapability,
-} from '@farcaster/frame-core'
-import type {
-  AnnounceProviderParameters,
-  AnnounceProviderReturnType,
-  EIP1193Provider,
-  EIP6963ProviderDetail,
-} from 'mipd'
-import * as Provider from 'ox/Provider'
-import * as RpcRequest from 'ox/RpcRequest'
-import * as RpcResponse from 'ox/RpcResponse'
-import { frameHost } from './frameHost.ts'
-
-const emitter = Provider.createEmitter()
-const store = RpcRequest.createStore()
-
-type GenericProviderRpcError = {
-  code: number
-  details?: string
-}
-
-function toProviderRpcError({
-  code,
-  details,
-}: GenericProviderRpcError): Provider.ProviderRpcError {
-  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.Provider = 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(): Promise<
-  Provider.Provider | undefined
-> {
-  try {
-    const capabilities = await frameHost.getCapabilities()
-    if (
-      !capabilities.includes('wallet.getEthereumProvider') &&
-      !capabilities.includes('wallet.getEvmProvider' as MiniAppHostCapability)
-    ) {
-      // 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: AnnounceProviderParameters,
-): AnnounceProviderReturnType {
-  const event: CustomEvent<EIP6963ProviderDetail> = 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 as EthProviderWireEvent
-      // @ts-expect-error
-      emitter.emit(ethProviderEvent.event, ...ethProviderEvent.params)
-    }
-  })
-
-  document.addEventListener('FarcasterFrameEvent', (event) => {
-    if (event instanceof MessageEvent) {
-      const frameEvent = event.data as FrameClientEvent
-      if (frameEvent.event === 'eip6963:announceProvider') {
-        announceEvmProvider({
-          info: frameEvent.info,
-          provider: ethereumProvider as EIP1193Provider,
-        })
-      }
-    }
-  })
-}
-
-// 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 as EthProviderWireEvent
-        // @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 as FrameClientEvent
-        if (frameEvent.event === 'eip6963:announceProvider') {
-          announceEvmProvider({
-            info: frameEvent.info,
-            provider: ethereumProvider as EIP1193Provider,
-          })
-        }
-      }
-    }
-  })
-}

package/src/frameHost.ts

@@ -1,5 +0,0 @@
-import type { WireFrameHost } from '@farcaster/frame-core'
-import { wrap } from 'comlink'
-import { endpoint } from './endpoint.ts'
-
-export const frameHost = wrap<WireFrameHost>(endpoint)

package/src/navigation.d.ts

@@ -1,191 +0,0 @@
-interface Window {
-  readonly navigation?: Navigation
-}
-
-interface NavigationEventMap {
-  navigate: NavigateEvent
-  navigatesuccess: Event
-  navigateerror: ErrorEvent
-  currententrychange: NavigationCurrentEntryChangeEvent
-}
-
-interface NavigationResult {
-  committed: Promise<NavigationHistoryEntry>
-  finished: Promise<NavigationHistoryEntry>
-}
-
-declare class Navigation extends EventTarget {
-  entries(): NavigationHistoryEntry[]
-  readonly currentEntry: NavigationHistoryEntry | null
-  updateCurrentEntry(options: NavigationUpdateCurrentEntryOptions): void
-  readonly transition: NavigationTransition | null
-
-  readonly canGoBack: boolean
-  readonly canGoForward: boolean
-
-  navigate(url: string, options?: NavigationNavigateOptions): NavigationResult
-  reload(options?: NavigationReloadOptions): NavigationResult
-
-  traverseTo(key: string, options?: NavigationOptions): NavigationResult
-  back(options?: NavigationOptions): NavigationResult
-  forward(options?: NavigationOptions): NavigationResult
-
-  onnavigate: ((this: Navigation, ev: NavigateEvent) => any) | null
-  onnavigatesuccess: ((this: Navigation, ev: Event) => any) | null
-  onnavigateerror: ((this: Navigation, ev: ErrorEvent) => any) | null
-  oncurrententrychange:
-    | ((this: Navigation, ev: NavigationCurrentEntryChangeEvent) => any)
-    | null
-
-  addEventListener<K extends keyof NavigationEventMap>(
-    type: K,
-    listener: (this: Navigation, ev: NavigationEventMap[K]) => any,
-    options?: boolean | AddEventListenerOptions,
-  ): void
-  addEventListener(
-    type: string,
-    listener: EventListenerOrEventListenerObject,
-    options?: boolean | AddEventListenerOptions,
-  ): void
-  removeEventListener<K extends keyof NavigationEventMap>(
-    type: K,
-    listener: (this: Navigation, ev: NavigationEventMap[K]) => any,
-    options?: boolean | EventListenerOptions,
-  ): void
-  removeEventListener(
-    type: string,
-    listener: EventListenerOrEventListenerObject,
-    options?: boolean | EventListenerOptions,
-  ): void
-}
-
-declare class NavigationTransition {
-  readonly navigationType: NavigationTypeString
-  readonly from: NavigationHistoryEntry
-  readonly finished: Promise<void>
-}
-
-interface NavigationHistoryEntryEventMap {
-  dispose: Event
-}
-
-interface NavigationHistoryEntry extends EventTarget {
-  readonly key: string
-  readonly id: string
-  readonly url: string | null
-  readonly index: number
-  readonly sameDocument: boolean
-
-  getState(): unknown
-
-  ondispose: ((this: NavigationHistoryEntry, ev: Event) => any) | null
-
-  addEventListener<K extends keyof NavigationHistoryEntryEventMap>(
-    type: K,
-    listener: (
-      this: NavigationHistoryEntry,
-      ev: NavigationHistoryEntryEventMap[K],
-    ) => any,
-    options?: boolean | AddEventListenerOptions,
-  ): void
-  addEventListener(
-    type: string,
-    listener: EventListenerOrEventListenerObject,
-    options?: boolean | AddEventListenerOptions,
-  ): void
-  removeEventListener<K extends keyof NavigationHistoryEntryEventMap>(
-    type: K,
-    listener: (
-      this: NavigationHistoryEntry,
-      ev: NavigationHistoryEntryEventMap[K],
-    ) => any,
-    options?: boolean | EventListenerOptions,
-  ): void
-  removeEventListener(
-    type: string,
-    listener: EventListenerOrEventListenerObject,
-    options?: boolean | EventListenerOptions,
-  ): void
-}
-
-declare let NavigationHistoryEntry: {
-  prototype: NavigationHistoryEntry
-  new (): NavigationHistoryEntry
-}
-
-type NavigationTypeString = 'reload' | 'push' | 'replace' | 'traverse'
-
-interface NavigationUpdateCurrentEntryOptions {
-  state: unknown
-}
-
-interface NavigationOptions {
-  info?: unknown
-}
-
-interface NavigationNavigateOptions extends NavigationOptions {
-  state?: unknown
-  history?: 'auto' | 'push' | 'replace'
-}
-
-interface NavigationReloadOptions extends NavigationOptions {
-  state?: unknown
-}
-
-declare class NavigationCurrentEntryChangeEvent extends Event {
-  constructor(type: string, eventInit?: NavigationCurrentEntryChangeEventInit)
-
-  readonly navigationType: NavigationTypeString | null
-  readonly from: NavigationHistoryEntry
-}
-
-interface NavigationCurrentEntryChangeEventInit extends EventInit {
-  navigationType?: NavigationTypeString | null
-  from: NavigationHistoryEntry
-}
-
-declare class NavigateEvent extends Event {
-  constructor(type: string, eventInit?: NavigateEventInit)
-
-  readonly navigationType: NavigationTypeString
-  readonly canIntercept: boolean
-  readonly userInitiated: boolean
-  readonly hashChange: boolean
-  readonly hasUAVisualTransition: boolean
-  readonly destination: NavigationDestination
-  readonly signal: AbortSignal
-  readonly formData: FormData | null
-  readonly downloadRequest: string | null
-  readonly info?: unknown
-
-  intercept(options?: NavigationInterceptOptions): void
-  scroll(): void
-}
-
-interface NavigateEventInit extends EventInit {
-  navigationType?: NavigationTypeString
-  canIntercept?: boolean
-  userInitiated?: boolean
-  hashChange?: boolean
-  destination: NavigationDestination
-  signal: AbortSignal
-  formData?: FormData | null
-  downloadRequest?: string | null
-  info?: unknown
-}
-
-interface NavigationInterceptOptions {
-  handler?: () => Promise<void>
-  focusReset?: 'after-transition' | 'manual'
-  scroll?: 'after-transition' | 'manual'
-}
-
-declare class NavigationDestination {
-  readonly url: string
-  readonly key: string | null
-  readonly id: string | null
-  readonly index: number
-  readonly sameDocument: boolean
-
-  getState(): unknown
-}