@farcaster/frame-core 0.0.21 → 0.0.23

package/esm/types.d.ts

@@ -1,155 +1,140 @@
-import type { Address, Provider, RpcRequest, RpcResponse, RpcSchema } from "ox";
-import { FrameNotificationDetails, EventFrameAdded, EventFrameRemoved, EventNotificationsEnabled, EventNotificationsDisabled } from "./schemas";
-import * as SignIn from "./actions/signIn";
-export type SetPrimaryButton = (options: {
-    text: string;
-    loading?: boolean;
-    disabled?: boolean;
-    hidden?: boolean;
-}) => 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 AddFrameRejectedReason = "invalid_domain_manifest" | "rejected_by_user";
-export type AddFrameResult = {
-    added: true;
-    notificationDetails?: FrameNotificationDetails;
-} | {
-    added: false;
-    reason: AddFrameRejectedReason;
-};
-export type AddFrame = () => Promise<AddFrameResult>;
+import type { Address, Provider, RpcRequest, RpcResponse, RpcSchema } from 'ox'
+import type { AddFrame, SignIn } 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 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;
+  /**
+   * 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
 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;
-    addFrame: AddFrame;
-};
+  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
+}
 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;
-    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
+}
 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: AddFrameRejectedReason;
-};
+  event: 'frame_add_rejected'
+  reason: AddFrame.AddFrameRejectedReason
+}
 export type EventPrimaryButtonClicked = {
-    event: "primary_button_clicked";
-};
-export type FrameClientEvent = EventFrameAdded | EventFrameAddRejected | EventFrameRemoved | EventNotificationsEnabled | EventNotificationsDisabled | EventPrimaryButtonClicked;
+  event: 'primary_button_clicked'
+}
+/**
+ * Metadata of the EIP-1193 Provider.
+ */
+export interface EIP6963ProviderInfo {
+  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

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.21",
+  "version": "0.0.23",
   "main": "dist/index.js",
   "module": "esm/index.js",
   "files": [
@@ -9,13 +9,12 @@
     "src"
   ],
   "devDependencies": {
-    "tsup": "^8.3.5",
-    "typescript": "^5.6.3",
+    "typescript": "^5.7.2",
     "@farcaster/tsconfig": "0.0.2"
   },
   "dependencies": {
-    "ox": "^0.4.0",
-    "zod": "^3.23.8"
+    "ox": "^0.4.4",
+    "zod": "^3.24.1"
   },
   "publishConfig": {
     "access": "public"

package/src/actions/AddFrame.ts

@@ -0,0 +1,51 @@
+import * as Errors from '../errors'
+import type { OneOf } from '../internal/types'
+import type { FrameNotificationDetails } from '../schemas'
+
+export type AddFrameResult = {
+  notificationDetails?: FrameNotificationDetails
+}
+
+export type AddFrame = () => Promise<AddFrameResult>
+
+type InvalidDomainManifestJsonError = {
+  type: 'invalid_domain_manifest'
+}
+
+type RejectedByUserJsonError = {
+  type: 'rejected_by_user'
+}
+
+export type AddFrameJsonError =
+  | InvalidDomainManifestJsonError
+  | RejectedByUserJsonError
+
+export type AddFrameRejectedReason = AddFrameJsonError['type']
+
+export type AddFrameJsonResult = OneOf<
+  { result: AddFrameResult } | { error: AddFrameJsonError }
+>
+
+export type WireAddFrame = () => Promise<AddFrameJsonResult>
+
+/**
+ * Thrown when the frame does not have a valid domain manifest.
+ */
+export class InvalidDomainManifest extends Errors.BaseError {
+  override readonly name = 'AddFrame.InvalidDomainManifest'
+
+  constructor() {
+    super('Invalid domain manifest')
+  }
+}
+
+/**
+ * Thrown when add frame action was rejected by the user.
+ */
+export class RejectedByUser extends Errors.BaseError {
+  override readonly name = 'AddFrame.RejectedByUser'
+
+  constructor() {
+    super('Add frame rejected by user')
+  }
+}

package/src/actions/SignIn.ts

@@ -0,0 +1,51 @@
+import * as Errors from '../errors'
+import type { OneOf } from '../internal/types'
+
+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
+}
+
+export type SignInResult = {
+  signature: string
+  message: string
+}
+
+export type SignIn = (options: SignInOptions) => Promise<SignInResult>
+
+type RejectedByUserJsonError = {
+  type: 'rejected_by_user'
+}
+
+export type SignInJsonError = RejectedByUserJsonError
+
+export type SignInJsonResult = OneOf<
+  { result: SignInResult } | { error: SignInJsonError }
+>
+
+export type WireSignIn = (options: SignInOptions) => Promise<SignInJsonResult>
+
+/**
+ * Thrown when a sign in action was rejected.
+ */
+export class RejectedByUser extends Errors.BaseError {
+  override readonly name = 'SignIn.RejectedByUser'
+
+  constructor() {
+    super('Sign in rejected by user')
+  }
+}

package/src/actions/index.ts

@@ -0,0 +1,2 @@
+export * as AddFrame from './AddFrame'
+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/errors.ts

@@ -1,12 +1,12 @@
 export class BaseError<
-  cause extends Error | undefined = undefined
+  cause extends Error | undefined = undefined,
 > extends Error {
-  override name = "BaseError";
-  cause: cause;
+  override name = 'BaseError'
+  cause: cause
 
   constructor(message: string, options: BaseError.Options<cause> = {}) {
     super(message, options.cause ? { cause: options.cause } : undefined)
-    this.cause = options.cause as any;
+    this.cause = options.cause as any
   }
 }
 

package/src/index.ts

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

package/src/internal/types.ts

@@ -1,4 +1,6 @@
-export type Compute<type> = { [key in keyof type]: type[key] } & unknown
+type Compute<type> = { [key in keyof type]: type[key] } & unknown
+
+type KeyofUnion<type> = type extends type ? keyof type : never
 
 export type OneOf<
   union extends object,
@@ -16,6 +18,3 @@ export type OneOf<
       }
     >
   : never
-
-export type KeyofUnion<type> = type extends type ? keyof type : never
-

package/src/schemas/embeds.ts

@@ -1,35 +1,35 @@
-import { z } from "zod";
+import { z } from 'zod'
 import {
-  hexColorSchema,
+  buttonTitleSchema,
   frameNameSchema,
+  hexColorSchema,
   secureUrlSchema,
-  buttonTitleSchema,
-} from "./shared";
+} from './shared'
 
 export const actionLaunchFrameSchema = z.object({
-  type: z.literal("launch_frame"),
+  type: z.literal('launch_frame'),
   name: frameNameSchema,
   url: secureUrlSchema,
   splashImageUrl: secureUrlSchema.optional(),
   splashBackgroundColor: hexColorSchema.optional(),
-});
+})
 
-export const actionSchema = z.discriminatedUnion("type", [
+export const actionSchema = z.discriminatedUnion('type', [
   actionLaunchFrameSchema,
-]);
+])
 
 export const buttonSchema = z.object({
   title: buttonTitleSchema,
   action: actionSchema,
-});
+})
 
 export const frameEmbedNextSchema = z.object({
-  version: z.literal("next"),
+  version: z.literal('next'),
   imageUrl: secureUrlSchema,
   button: buttonSchema,
-});
+})
 
 export const safeParseFrameEmbed = (rawResponse: unknown) =>
-  frameEmbedNextSchema.safeParse(rawResponse);
+  frameEmbedNextSchema.safeParse(rawResponse)
 
-export type FrameEmbedNext = z.infer<typeof frameEmbedNextSchema>;
+export type FrameEmbedNext = z.infer<typeof frameEmbedNextSchema>

package/src/schemas/events.ts

@@ -1,41 +1,41 @@
-import { z } from "zod";
-import { notificationDetailsSchema } from "./notifications";
+import { z } from 'zod'
+import { notificationDetailsSchema } from './notifications'
 
 export const eventFrameAddedSchema = z.object({
-  event: z.literal("frame_added"),
+  event: z.literal('frame_added'),
   notificationDetails: notificationDetailsSchema.optional(),
-});
+})
 
-export type EventFrameAdded = z.infer<typeof eventFrameAddedSchema>;
+export type EventFrameAdded = z.infer<typeof eventFrameAddedSchema>
 
 export const eventFrameRemovedSchema = z.object({
-  event: z.literal("frame_removed"),
-});
+  event: z.literal('frame_removed'),
+})
 
-export type EventFrameRemoved = z.infer<typeof eventFrameRemovedSchema>;
+export type EventFrameRemoved = z.infer<typeof eventFrameRemovedSchema>
 
 export const eventNotificationsEnabledSchema = z.object({
-  event: z.literal("notifications_enabled"),
+  event: z.literal('notifications_enabled'),
   notificationDetails: notificationDetailsSchema.required(),
-});
+})
 
 export type EventNotificationsEnabled = z.infer<
   typeof eventNotificationsEnabledSchema
->;
+>
 
 export const notificationsDisabledSchema = z.object({
-  event: z.literal("notifications_disabled"),
-});
+  event: z.literal('notifications_disabled'),
+})
 
 export type EventNotificationsDisabled = z.infer<
   typeof notificationsDisabledSchema
->;
+>
 
-export const serverEventSchema = z.discriminatedUnion("event", [
+export const serverEventSchema = z.discriminatedUnion('event', [
   eventFrameAddedSchema,
   eventFrameRemovedSchema,
   eventNotificationsEnabledSchema,
   notificationsDisabledSchema,
-]);
+])
 
-export type FrameServerEvent = z.infer<typeof serverEventSchema>;
+export type FrameServerEvent = z.infer<typeof serverEventSchema>

package/src/schemas/index.ts

@@ -1,5 +1,5 @@
-export * from "./embeds";
-export * from "./events";
-export * from "./shared";
-export * from "./manifest";
-export * from "./notifications";
+export * from './embeds'
+export * from './events'
+export * from './shared'
+export * from './manifest'
+export * from './notifications'