@farcaster/frame-core 0.0.22 → 0.0.24

package/esm/types.d.ts

@@ -1,195 +1,117 @@
-import type { Address, Provider, RpcRequest, RpcResponse, RpcSchema } from 'ox'
-import type { AddFrame, SignIn } from './actions'
-import type {
-  EventFrameAdded,
-  EventFrameRemoved,
-  EventNotificationsDisabled,
-  EventNotificationsEnabled,
-  FrameNotificationDetails,
-} from './schemas'
+import type { Address, Provider, RpcRequest, RpcResponse, RpcSchema } from 'ox';
+import type { AddFrame, SignIn, ViewProfile } from './actions';
+import type { FrameContext } from './context';
+import type { EventFrameAdded, EventFrameRemoved, EventNotificationsDisabled, EventNotificationsEnabled } from './schemas';
 export type SetPrimaryButtonOptions = {
-  text: string
-  loading?: boolean
-  disabled?: boolean
-  hidden?: boolean
-}
-export type SetPrimaryButton = (options: SetPrimaryButtonOptions) => void
-export type EthProviderRequest = Provider.RequestFn<RpcSchema.Default>
-export type AccountLocation = {
-  placeId: string
-  /**
-   * Human-readable string describing the location
-   */
-  description: string
-}
-export type FrameLocationContextCastEmbed = {
-  type: 'cast_embed'
-  embed: string
-  cast: {
-    fid: number
-    hash: string
-  }
-}
-export type FrameLocationContextNotification = {
-  type: 'notification'
-  notification: {
-    notificationId: string
-    title: string
-    body: string
-  }
-}
-export type FrameLocationContextLauncher = {
-  type: 'launcher'
-}
-export type FrameLocationContext =
-  | FrameLocationContextCastEmbed
-  | FrameLocationContextNotification
-  | FrameLocationContextLauncher
-export type SafeAreaInsets = {
-  top: number
-  bottom: number
-  left: number
-  right: number
-}
-export type FrameContext = {
-  user: {
-    fid: number
-    username?: string
-    displayName?: string
+    text: string;
+    loading?: boolean;
+    disabled?: boolean;
+    hidden?: boolean;
+};
+export type SetPrimaryButton = (options: SetPrimaryButtonOptions) => void;
+export type EthProviderRequest = Provider.RequestFn<RpcSchema.Default>;
+export type ReadyOptions = {
     /**
-     * Profile image URL
+     * Disable native gestures. Use this option if your frame uses gestures
+     * that conflict with native gestures.
+     *
+     * @defaultValue false
      */
-    pfpUrl?: string
-    location?: AccountLocation
-  }
-  location?: FrameLocationContext
-  client: {
-    clientFid: number
-    added: boolean
-    notificationDetails?: FrameNotificationDetails
-    safeAreaInsets?: SafeAreaInsets
-  }
-}
-export type ReadyOptions = {
-  /**
-   * Disable native gestures. Use this option if your frame uses gestures
-   * that conflict with native gestures.
-   *
-   * @defaultValue false
-   */
-  disableNativeGestures: boolean
-}
-export declare const DEFAULT_READY_OPTIONS: ReadyOptions
+    disableNativeGestures: boolean;
+};
+export declare const DEFAULT_READY_OPTIONS: ReadyOptions;
 export type SignInOptions = {
-  /**
-   * A random string used to prevent replay attacks.
-   */
-  nonce: string
-  /**
-   * Start time at which the signature becomes valid.
-   * ISO 8601 datetime.
-   */
-  notBefore?: string
-  /**
-   * Expiration time at which the signature is no longer valid.
-   * ISO 8601 datetime.
-   */
-  expirationTime?: string
-}
+    /**
+     * A random string used to prevent replay attacks.
+     */
+    nonce: string;
+    /**
+     * Start time at which the signature becomes valid.
+     * ISO 8601 datetime.
+     */
+    notBefore?: string;
+    /**
+     * Expiration time at which the signature is no longer valid.
+     * ISO 8601 datetime.
+     */
+    expirationTime?: string;
+};
 export type WireFrameHost = {
-  context: FrameContext
-  close: () => void
-  ready: (options?: Partial<ReadyOptions>) => void
-  openUrl: (url: string) => void
-  signIn: SignIn.WireSignIn
-  setPrimaryButton: SetPrimaryButton
-  ethProviderRequest: EthProviderRequest
-  ethProviderRequestV2: RpcTransport
-  eip6963RequestProvider: () => void
-  addFrame: AddFrame.WireAddFrame
-}
+    context: FrameContext;
+    close: () => void;
+    ready: (options?: Partial<ReadyOptions>) => void;
+    openUrl: (url: string) => void;
+    signIn: SignIn.WireSignIn;
+    setPrimaryButton: SetPrimaryButton;
+    ethProviderRequest: EthProviderRequest;
+    ethProviderRequestV2: RpcTransport;
+    eip6963RequestProvider: () => void;
+    addFrame: AddFrame.WireAddFrame;
+    viewProfile: ViewProfile.ViewProfile;
+};
 export type FrameHost = {
-  context: FrameContext
-  close: () => void
-  ready: (options?: Partial<ReadyOptions>) => void
-  openUrl: (url: string) => void
-  signIn: SignIn.SignIn
-  setPrimaryButton: SetPrimaryButton
-  ethProviderRequest: EthProviderRequest
-  ethProviderRequestV2: RpcTransport
-  /**
-   * Receive forwarded eip6963:requestProvider events from the frame document.
-   * Hosts must emit an EventEip6963AnnounceProvider in response.
-   */
-  eip6963RequestProvider: () => void
-  addFrame: AddFrame.AddFrame
-}
+    context: FrameContext;
+    close: () => void;
+    ready: (options?: Partial<ReadyOptions>) => void;
+    openUrl: (url: string) => void;
+    signIn: SignIn.SignIn;
+    setPrimaryButton: SetPrimaryButton;
+    ethProviderRequest: EthProviderRequest;
+    ethProviderRequestV2: RpcTransport;
+    /**
+     * Receive forwarded eip6963:requestProvider events from the frame document.
+     * Hosts must emit an EventEip6963AnnounceProvider in response.
+     */
+    eip6963RequestProvider: () => void;
+    addFrame: AddFrame.AddFrame;
+    viewProfile: ViewProfile.ViewProfile;
+};
 export type FrameEthProviderEventData = {
-  type: 'frame_eth_provider_event'
-} & EthProviderWireEvent
-export type RpcTransport = (
-  request: RpcRequest.RpcRequest,
-) => Promise<RpcResponse.RpcResponse>
+    type: 'frame_eth_provider_event';
+} & EthProviderWireEvent;
+export type RpcTransport = (request: RpcRequest.RpcRequest) => Promise<RpcResponse.RpcResponse>;
 export type ProviderRpcError = {
-  code: number
-  details?: string
-  message?: string
-}
-export type EthProviderWireEvent =
-  | {
-      event: 'accountsChanged'
-      params: [readonly Address.Address[]]
-    }
-  | {
-      event: 'chainChanged'
-      params: [string]
-    }
-  | {
-      event: 'connect'
-      params: [Provider.ConnectInfo]
-    }
-  | {
-      event: 'disconnect'
-      params: [ProviderRpcError]
-    }
-  | {
-      event: 'message'
-      params: [Provider.Message]
-    }
-export type EmitEthProvider = <event extends EthProviderWireEvent['event']>(
-  event: event,
-  params: Extract<
-    EthProviderWireEvent,
-    {
-      event: event
-    }
-  >['params'],
-) => void
+    code: number;
+    details?: string;
+    message?: string;
+};
+export type EthProviderWireEvent = {
+    event: 'accountsChanged';
+    params: [readonly Address.Address[]];
+} | {
+    event: 'chainChanged';
+    params: [string];
+} | {
+    event: 'connect';
+    params: [Provider.ConnectInfo];
+} | {
+    event: 'disconnect';
+    params: [ProviderRpcError];
+} | {
+    event: 'message';
+    params: [Provider.Message];
+};
+export type EmitEthProvider = <event extends EthProviderWireEvent['event']>(event: event, params: Extract<EthProviderWireEvent, {
+    event: event;
+}>['params']) => void;
 export type EventFrameAddRejected = {
-  event: 'frame_add_rejected'
-  reason: AddFrame.AddFrameRejectedReason
-}
+    event: 'frame_add_rejected';
+    reason: AddFrame.AddFrameRejectedReason;
+};
 export type EventPrimaryButtonClicked = {
-  event: 'primary_button_clicked'
-}
+    event: 'primary_button_clicked';
+};
 /**
  * Metadata of the EIP-1193 Provider.
  */
 export interface EIP6963ProviderInfo {
-  icon: `data:image/${string}`
-  name: string
-  rdns: string
-  uuid: string
+    icon: `data:image/${string}`;
+    name: string;
+    rdns: string;
+    uuid: string;
 }
 export type EventEip6963AnnounceProvider = {
-  event: 'eip6963:announceProvider'
-  info: EIP6963ProviderInfo
-}
-export type FrameClientEvent =
-  | EventFrameAdded
-  | EventFrameAddRejected
-  | EventFrameRemoved
-  | EventNotificationsEnabled
-  | EventNotificationsDisabled
-  | EventPrimaryButtonClicked
-  | EventEip6963AnnounceProvider
+    event: 'eip6963:announceProvider';
+    info: EIP6963ProviderInfo;
+};
+export type FrameClientEvent = EventFrameAdded | EventFrameAddRejected | EventFrameRemoved | EventNotificationsEnabled | EventNotificationsDisabled | EventPrimaryButtonClicked | EventEip6963AnnounceProvider;

package/esm/types.js

@@ -1,3 +1,3 @@
 export const DEFAULT_READY_OPTIONS = {
-  disableNativeGestures: false,
-}
+    disableNativeGestures: false,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@farcaster/frame-core",
-  "version": "0.0.22",
+  "version": "0.0.24",
   "main": "dist/index.js",
   "module": "esm/index.js",
   "files": [

package/src/actions/ViewProfile.ts

@@ -0,0 +1,5 @@
+export type ViewProfileOptions = {
+  fid: number
+}
+
+export type ViewProfile = (options: ViewProfileOptions) => Promise<void>

package/src/actions/index.ts

@@ -1,2 +1,3 @@
 export * as AddFrame from './AddFrame'
+export * as ViewProfile from './ViewProfile'
 export * as SignIn from './SignIn'

package/src/context.ts

@@ -0,0 +1,90 @@
+import type { FrameNotificationDetails } from './schemas'
+
+export type CastEmbedLocationContext = {
+  type: 'cast_embed'
+  embed: string
+  cast: {
+    fid: number
+    hash: string
+  }
+}
+
+export type NotificationLocationContext = {
+  type: 'notification'
+  notification: {
+    notificationId: string
+    title: string
+    body: string
+  }
+}
+
+export type LauncherLocationContext = {
+  type: 'launcher'
+}
+
+export type ChannelLocationContext = {
+  type: 'channel'
+  channel: {
+    /**
+     * Channel key identifier
+     */
+    key: string
+
+    /**
+     * Channel name
+     */
+    name: string
+
+    /**
+     * Channel profile image URL
+     */
+    imageUrl?: string
+  }
+}
+
+export type LocationContext =
+  | CastEmbedLocationContext
+  | NotificationLocationContext
+  | LauncherLocationContext
+  | ChannelLocationContext
+
+export type AccountLocation = {
+  placeId: string
+
+  /**
+   * Human-readable string describing the location
+   */
+  description: string
+}
+
+export type UserContext = {
+  fid: number
+  username?: string
+  displayName?: string
+
+  /**
+   * Profile image URL
+   */
+  pfpUrl?: string
+  location?: AccountLocation
+}
+
+export type SafeAreaInsets = {
+  top: number
+  bottom: number
+  left: number
+  right: number
+}
+
+export type ClientContext = {
+  clientFid: number
+  added: boolean
+  notificationDetails?: FrameNotificationDetails
+  safeAreaInsets?: SafeAreaInsets
+}
+
+export type FrameContext = {
+  client: ClientContext
+  user: UserContext
+  location?: LocationContext
+}

package/src/index.ts

@@ -1,3 +1,4 @@
 export * from './actions'
-export * from './schemas'
+export * as Context from './context'
 export * from './types'
+export * from './schemas'

package/src/types.ts

@@ -1,11 +1,11 @@
 import type { Address, Provider, RpcRequest, RpcResponse, RpcSchema } from 'ox'
-import type { AddFrame, SignIn } from './actions'
+import type { AddFrame, SignIn, ViewProfile } from './actions'
+import type { FrameContext } from './context'
 import type {
   EventFrameAdded,
   EventFrameRemoved,
   EventNotificationsDisabled,
   EventNotificationsEnabled,
-  FrameNotificationDetails,
 } from './schemas'
 
 export type SetPrimaryButtonOptions = {
@@ -19,68 +19,6 @@ export type SetPrimaryButton = (options: SetPrimaryButtonOptions) => void
 
 export type EthProviderRequest = Provider.RequestFn<RpcSchema.Default>
 
-export type AccountLocation = {
-  placeId: string
-  /**
-   * Human-readable string describing the location
-   */
-  description: string
-}
-
-export type FrameLocationContextCastEmbed = {
-  type: 'cast_embed'
-  embed: string
-  cast: {
-    fid: number
-    hash: string
-  }
-}
-
-export type FrameLocationContextNotification = {
-  type: 'notification'
-  notification: {
-    notificationId: string
-    title: string
-    body: string
-  }
-}
-
-export type FrameLocationContextLauncher = {
-  type: 'launcher'
-}
-
-export type FrameLocationContext =
-  | FrameLocationContextCastEmbed
-  | FrameLocationContextNotification
-  | FrameLocationContextLauncher
-
-export type SafeAreaInsets = {
-  top: number
-  bottom: number
-  left: number
-  right: number
-}
-
-export type FrameContext = {
-  user: {
-    fid: number
-    username?: string
-    displayName?: string
-    /**
-     * Profile image URL
-     */
-    pfpUrl?: string
-    location?: AccountLocation
-  }
-  location?: FrameLocationContext
-  client: {
-    clientFid: number
-    added: boolean
-    notificationDetails?: FrameNotificationDetails
-    safeAreaInsets?: SafeAreaInsets
-  }
-}
-
 export type ReadyOptions = {
   /**
    * Disable native gestures. Use this option if your frame uses gestures
@@ -125,6 +63,7 @@ export type WireFrameHost = {
   ethProviderRequestV2: RpcTransport
   eip6963RequestProvider: () => void
   addFrame: AddFrame.WireAddFrame
+  viewProfile: ViewProfile.ViewProfile
 }
 
 export type FrameHost = {
@@ -142,6 +81,7 @@ export type FrameHost = {
    */
   eip6963RequestProvider: () => void
   addFrame: AddFrame.AddFrame
+  viewProfile: ViewProfile.ViewProfile
 }
 
 export type FrameEthProviderEventData = {