@farcaster/frame-core 0.0.10 → 0.0.12

package/src/types.ts

@@ -1,5 +1,5 @@
 import type { Address, Provider, RpcRequest, RpcResponse, RpcSchema } from "ox";
-import { z } from "zod";
+import { FrameNotificationDetails } from "./schemas";
 
 export type SetPrimaryButton = (options: {
   text: string;
@@ -18,7 +18,15 @@ export type AccountLocation = {
   description: string;
 };
 
-export type FrameLocationNotificationContext = {
+export type FrameLocationContextCastEmbed = {
+  type: "cast_embed";
+  cast: {
+    fid: number;
+    hash: string;
+  };
+};
+
+export type FrameLocationContextNotification = {
   type: "notification";
   notification: {
     notificationId: string;
@@ -27,7 +35,14 @@ export type FrameLocationNotificationContext = {
   };
 };
 
-export type FrameLocationContext = FrameLocationNotificationContext;
+export type FrameLocationContextLauncher = {
+  type: "launcher";
+};
+
+export type FrameLocationContext =
+  | FrameLocationContextCastEmbed
+  | FrameLocationContextNotification
+  | FrameLocationContextLauncher;
 
 export type FrameContext = {
   user: {
@@ -40,16 +55,13 @@ export type FrameContext = {
     pfpUrl?: string;
   };
   location?: FrameLocationContext;
+  client: {
+    clientFid: number;
+    added: boolean;
+    notificationDetails?: FrameNotificationDetails;
+  };
 };
 
-export const notificationDetailsSchema = z.object({
-  url: z.string(),
-  token: z.string(),
-});
-export type FrameNotificationDetails = z.infer<
-  typeof notificationDetailsSchema
->;
-
 export type AddFrameResult =
   | {
       added: true;
@@ -57,21 +69,29 @@ export type AddFrameResult =
     }
   | {
       added: false;
-      reason: "invalid-domain-manifest" | "rejected-by-user";
+      reason: "invalid_domain_manifest" | "rejected_by_user";
     };
 
 export type AddFrame = () => Promise<AddFrameResult>;
 
+export type ReadyOptions = {
+  /**
+   * Disable native gestures. Use this option if your frame uses gestures
+   * that conflict with native gestures.
+   *
+   * @defaultValue false
+   */
+  disableNativeGestures: boolean;
+};
+
+export const DEFAULT_READY_OPTIONS: ReadyOptions = {
+  disableNativeGestures: false,
+}
+
 export type FrameHost = {
   context: FrameContext;
   close: () => void;
-  ready: (options: Partial<{ 
-    /**
-      * Disable native gestures. Use this option if your frame uses gestures
-      * that conflict with native gestures. 
-      */
-    disableNativeGestures: boolean; 
-  }>) => void;
+  ready: (options?: Partial<ReadyOptions>) => void;
   openUrl: (url: string) => void;
   setPrimaryButton: SetPrimaryButton;
   ethProviderRequest: EthProviderRequest;
@@ -79,88 +99,8 @@ export type FrameHost = {
   addFrame: AddFrame;
 };
 
-export const eventSchema = z.object({
-  header: z.string(),
-  payload: z.string(),
-  signature: z.string(),
-});
-export type EventSchema = z.infer<typeof eventSchema>;
-
-// JSON Farcaster Signature header after decoding
-
-export const eventHeaderSchema = z.object({
-  fid: z.number(),
-  type: z.literal("app_key"),
-  key: z.string().startsWith("0x"),
-});
-export type EventHeader = z.infer<typeof eventHeaderSchema>;
-
-// Webhook event payload after decoding
-
-export const eventFrameAddedPayloadSchema = z.object({
-  event: z.literal("frame-added"),
-  notificationDetails: notificationDetailsSchema.optional(),
-});
-export type EventFrameAddedPayload = z.infer<
-  typeof eventFrameAddedPayloadSchema
->;
-
-export const eventFrameRemovedPayloadSchema = z.object({
-  event: z.literal("frame-removed"),
-});
-export type EventFrameRemovedPayload = z.infer<
-  typeof eventFrameRemovedPayloadSchema
->;
-
-export const eventNotificationsEnabledPayloadSchema = z.object({
-  event: z.literal("notifications-enabled"),
-  notificationDetails: notificationDetailsSchema.required(),
-});
-export type EventNotificationsEnabledPayload = z.infer<
-  typeof eventNotificationsEnabledPayloadSchema
->;
-
-export const notificationsDisabledPayloadSchema = z.object({
-  event: z.literal("notifications-disabled"),
-});
-export type EventNotificationsDisabledPayload = z.infer<
-  typeof notificationsDisabledPayloadSchema
->;
-
-export const eventPayloadSchema = z.discriminatedUnion("event", [
-  eventFrameAddedPayloadSchema,
-  eventFrameRemovedPayloadSchema,
-  eventNotificationsEnabledPayloadSchema,
-  notificationsDisabledPayloadSchema,
-]);
-export type FrameEvent = z.infer<typeof eventPayloadSchema>;
-
-// Notifications API request and response formats
-
-export const sendNotificationRequestSchema = z.object({
-  notificationId: z.string().uuid(),
-  title: z.string().max(32),
-  body: z.string().max(128),
-  targetUrl: z.string().max(256),
-  tokens: z.string().array().max(100),
-});
-export type SendNotificationRequest = z.infer<
-  typeof sendNotificationRequestSchema
->;
-
-export const sendNotificationResponseSchema = z.object({
-  result: z.object({
-    successfulTokens: z.array(z.string()),
-    invalidTokens: z.array(z.string()),
-    rateLimitedTokens: z.array(z.string()),
-  }),
-});
-export type SendNotificationResponse = z.infer<
-  typeof sendNotificationResponseSchema
->;
-
 export type FrameEthProviderEventData = {
-  type: 'frameEthProviderEvent',
+  type: "frame_eth_provider_event";
 } & EthProviderWireEvent;
 
 export type RpcTransport = (
@@ -171,28 +111,31 @@ 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']
->(
+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']
+  params: Extract<EthProviderWireEvent, { event: event }>["params"]
 ) => void;