@farcaster/frame-core 0.0.21 → 0.0.23

package/src/schemas/manifest.ts

@@ -1,21 +1,21 @@
-import { z } from "zod";
+import { z } from 'zod'
 import {
-  secureUrlSchema,
+  buttonTitleSchema,
+  encodedJsonFarcasterSignatureSchema,
   frameNameSchema,
   hexColorSchema,
-  encodedJsonFarcasterSignatureSchema,
-  buttonTitleSchema,
-} from "./shared";
+  secureUrlSchema,
+} from './shared'
 
 export const domainFrameConfigSchema = z.object({
   // 0.0.0 and 0.0.1 are not technically part of the spec but kept for
   // backwards compatibilty. next should always resolve to the most recent
   // schema version.
   version: z.union([
-    z.literal("0.0.0"), 
-    z.literal("0.0.1"), 
-    z.literal("1"), 
-    z.literal('next')
+    z.literal('0.0.0'),
+    z.literal('0.0.1'),
+    z.literal('1'),
+    z.literal('next'),
   ]),
   name: frameNameSchema,
   iconUrl: secureUrlSchema,
@@ -25,9 +25,9 @@ export const domainFrameConfigSchema = z.object({
   splashImageUrl: secureUrlSchema.optional(),
   splashBackgroundColor: hexColorSchema.optional(),
   webhookUrl: secureUrlSchema.optional(),
-});
+})
 
 export const domainManifestSchema = z.object({
   accountAssociation: encodedJsonFarcasterSignatureSchema,
   frame: domainFrameConfigSchema.optional(),
-});
+})

package/src/schemas/notifications.ts

@@ -1,14 +1,12 @@
-import { z } from "zod";
-import { secureUrlSchema } from "./shared";
+import { z } from 'zod'
+import { secureUrlSchema } from './shared'
 
 export const notificationDetailsSchema = z.object({
   url: z.string(),
   token: z.string(),
-});
+})
 
-export type FrameNotificationDetails = z.infer<
-  typeof notificationDetailsSchema
->;
+export type FrameNotificationDetails = z.infer<typeof notificationDetailsSchema>
 
 export const sendNotificationRequestSchema = z.object({
   notificationId: z.string().max(128),
@@ -16,11 +14,11 @@ export const sendNotificationRequestSchema = z.object({
   body: z.string().max(128),
   targetUrl: secureUrlSchema,
   tokens: z.string().array().max(100),
-});
+})
 
 export type SendNotificationRequest = z.infer<
   typeof sendNotificationRequestSchema
->;
+>
 
 export const sendNotificationResponseSchema = z.object({
   result: z.object({
@@ -28,8 +26,8 @@ export const sendNotificationResponseSchema = z.object({
     invalidTokens: z.array(z.string()),
     rateLimitedTokens: z.array(z.string()),
   }),
-});
+})
 
 export type SendNotificationResponse = z.infer<
   typeof sendNotificationResponseSchema
->;
+>

package/src/schemas/shared.ts

@@ -1,37 +1,37 @@
-import { z } from "zod";
+import { z } from 'zod'
 
 export const secureUrlSchema = z
   .string()
   .url()
-  .startsWith("https://", { message: "Must be an https url" })
-  .max(512);
+  .startsWith('https://', { message: 'Must be an https url' })
+  .max(512)
 
-export const frameNameSchema = z.string().max(32);
-export const buttonTitleSchema = z.string().max(32);
+export const frameNameSchema = z.string().max(32)
+export const buttonTitleSchema = z.string().max(32)
 
 export const hexColorSchema = z
   .string()
   .regex(/^#([0-9A-F]{3}|[0-9A-F]{6})$/i, {
     message:
-      "Invalid hex color code. It should be in the format #RRGGBB or #RGB.",
-  });
+      'Invalid hex color code. It should be in the format #RRGGBB or #RGB.',
+  })
 
 export const encodedJsonFarcasterSignatureSchema = z.object({
   header: z.string(),
   payload: z.string(),
   signature: z.string(),
-});
+})
 
 export type EncodedJsonFarcasterSignatureSchema = z.infer<
   typeof encodedJsonFarcasterSignatureSchema
->;
+>
 
 export const jsonFarcasterSignatureHeaderSchema = z.object({
   fid: z.number(),
-  type: z.literal("app_key"),
-  key: z.string().startsWith("0x"),
-});
+  type: z.literal('app_key'),
+  key: z.string().startsWith('0x'),
+})
 
 export type JsonFarcasterSignatureHeaderSchema = z.infer<
   typeof jsonFarcasterSignatureHeaderSchema
->;
+>

package/src/types.ts

@@ -1,106 +1,23 @@
+import type { Address, Provider, RpcRequest, RpcResponse, RpcSchema } from 'ox'
+import type { AddFrame, SignIn } from './actions'
+import type { FrameContext } from './context'
 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>;
+  EventNotificationsEnabled,
+} from './schemas'
 
-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 SetPrimaryButtonOptions = {
+  text: string
+  loading?: boolean
+  disabled?: boolean
+  hidden?: boolean
 }
 
-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 SetPrimaryButton = (options: SetPrimaryButtonOptions) => void
 
-export type AddFrame = () => Promise<AddFrameResult>;
+export type EthProviderRequest = Provider.RequestFn<RpcSchema.Default>
 
 export type ReadyOptions = {
   /**
@@ -109,105 +26,126 @@ export type ReadyOptions = {
    *
    * @defaultValue false
    */
-  disableNativeGestures: boolean;
-};
+  disableNativeGestures: boolean
+}
 
 export const DEFAULT_READY_OPTIONS: ReadyOptions = {
   disableNativeGestures: false,
-};
+}
 
 export type SignInOptions = {
   /**
    * A random string used to prevent replay attacks.
    */
-  nonce: string;
+  nonce: string
 
   /**
    * Start time at which the signature becomes valid.
    * ISO 8601 datetime.
    */
-  notBefore?: string;
+  notBefore?: string
 
   /**
    * Expiration time at which the signature is no longer valid.
    * ISO 8601 datetime.
    */
-  expirationTime?: string;
-};
+  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;
+  type: 'frame_eth_provider_event'
+} & EthProviderWireEvent
 
 export type RpcTransport = (
   request: RpcRequest.RpcRequest,
-) => Promise<RpcResponse.RpcResponse>;
+) => Promise<RpcResponse.RpcResponse>
 
 export type ProviderRpcError = {
-  code: number;
-  details?: string;
-  message?: string;
-};
+  code: number
+  details?: string
+  message?: string
+}
 
 export type EthProviderWireEvent =
   | {
-      event: "accountsChanged";
-      params: [readonly Address.Address[]];
+      event: 'accountsChanged'
+      params: [readonly Address.Address[]]
     }
   | {
-      event: "chainChanged";
-      params: [string];
+      event: 'chainChanged'
+      params: [string]
     }
   | {
-      event: "connect";
-      params: [Provider.ConnectInfo];
+      event: 'connect'
+      params: [Provider.ConnectInfo]
     }
   | {
-      event: "disconnect";
-      params: [ProviderRpcError];
+      event: 'disconnect'
+      params: [ProviderRpcError]
     }
   | {
-      event: "message";
-      params: [Provider.Message];
-    };
+      event: 'message'
+      params: [Provider.Message]
+    }
 
-export type EmitEthProvider = <event extends EthProviderWireEvent["event"]>(
+export type EmitEthProvider = <event extends EthProviderWireEvent['event']>(
   event: event,
-  params: Extract<EthProviderWireEvent, { event: event }>["params"],
-) => void;
+  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";
-};
+  event: 'primary_button_clicked'
+}
+
+/**
+ * Metadata of the EIP-1193 Provider.
+ */
+export interface EIP6963ProviderInfo {
+  icon: `data:image/${string}` // RFC-2397
+  name: string
+  rdns: string
+  uuid: string
+}
+
+export type EventEip6963AnnounceProvider = {
+  event: 'eip6963:announceProvider'
+  info: EIP6963ProviderInfo
+}
 
 export type FrameClientEvent =
   | EventFrameAdded
@@ -215,4 +153,5 @@ export type FrameClientEvent =
   | EventFrameRemoved
   | EventNotificationsEnabled
   | EventNotificationsDisabled
-  | EventPrimaryButtonClicked;
+  | EventPrimaryButtonClicked
+  | EventEip6963AnnounceProvider

package/esm/actions/signIn.d.ts

@@ -1,40 +0,0 @@
-import * as Errors from '../errors';
-import { 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>;
-export type RejectedByUserError = {
-    type: 'rejected_by_user';
-};
-export type JsonSignInError = RejectedByUserError;
-export type WireSignInResponse = OneOf<{
-    result: SignInResult;
-} | {
-    error: JsonSignInError;
-}>;
-export type WireSignIn = (options: SignInOptions) => Promise<WireSignInResponse>;
-/**
- * Thrown when a sign in action was rejected.
- */
-export declare class RejectedByUser extends Errors.BaseError {
-    readonly name = "SignIn.RejectedByUser";
-    constructor();
-}

package/esm/actions/signIn.js

@@ -1,10 +0,0 @@
-import * as Errors from '../errors';
-/**
- * Thrown when a sign in action was rejected.
- */
-export class RejectedByUser extends Errors.BaseError {
-    name = 'SignIn.RejectedByUser';
-    constructor() {
-        super("Sign in rejected by user");
-    }
-}

package/src/actions/signIn.ts

@@ -1,50 +0,0 @@
-import type { Address } from 'ox';
-import * as Errors from '../errors'
-import { 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>;
-
-export type RejectedByUserError  = {
-  type: 'rejected_by_user'
-};
-
-export type JsonSignInError = RejectedByUserError;
-
-export type WireSignInResponse = OneOf<{ result: SignInResult } | { error: JsonSignInError }>
-
-export type WireSignIn = (options: SignInOptions) => Promise<WireSignInResponse>;
-
-/**
- * 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")
-  }
-}