@farcaster/frame-sdk 0.0.18 → 0.0.20

package/src/sdk.ts

@@ -2,6 +2,7 @@ import { EventEmitter } from "eventemitter3";
 import { FrameSDK, Emitter, EventMap } from "./types";
 import { frameHost } from "./frameHost";
 import { provider } from "./provider";
+import { FrameClientEvent, SignIn } from "@farcaster/frame-core";
 
 export function createEmitter(): Emitter {
   const emitter = new EventEmitter<EventMap>();
@@ -35,6 +36,19 @@ export const sdk: FrameSDK = {
     setPrimaryButton: frameHost.setPrimaryButton.bind(frameHost),
     ready: frameHost.ready.bind(frameHost),
     close: frameHost.close.bind(frameHost),
+    signIn: async (options) => {
+      const response = await frameHost.signIn(options);
+      console.log(response);
+      if (response.result) {
+        return response.result;
+      }
+
+      if (response.error.type === "rejected_by_user") {
+        throw new SignIn.RejectedByUser();
+      }
+
+      throw new Error("Unreachable");
+    },
     openUrl: (url: string) => {
       return frameHost.openUrl(url.trim());
     },
@@ -50,8 +64,23 @@ if (typeof document !== "undefined") {
   // react native webview events
   document.addEventListener("FarcasterFrameEvent", (event) => {
     if (event instanceof MessageEvent) {
-      if (event.data.type === "primaryButtonClicked") {
+      const frameEvent = event.data as FrameClientEvent;
+      if (frameEvent.event === "primary_button_clicked") {
         emitter.emit("primaryButtonClicked");
+      } else if (frameEvent.event === "frame_added") {
+        emitter.emit("frameAdded", {
+          notificationDetails: frameEvent.notificationDetails,
+        });
+      } else if (frameEvent.event === "frame_add_rejected") {
+        emitter.emit("frameAddRejected", { reason: frameEvent.reason });
+      } else if (frameEvent.event === "frame_removed") {
+        emitter.emit("frameRemoved");
+      } else if (frameEvent.event === "notifications_enabled") {
+        emitter.emit("notificationsEnabled", {
+          notificationDetails: frameEvent.notificationDetails,
+        });
+      } else if (frameEvent.event === "notifications_disabled") {
+        emitter.emit("notificationsDisabled");
       }
     }
   });
@@ -63,8 +92,23 @@ if (typeof window !== "undefined") {
   window.addEventListener("message", (event) => {
     if (event instanceof MessageEvent) {
       if (event.data.type === "frameEvent") {
-        if (event.data.event === "primaryButtonClicked") {
+        const frameEvent = event.data.event as FrameClientEvent;
+        if (frameEvent.event === "primary_button_clicked") {
           emitter.emit("primaryButtonClicked");
+        } else if (frameEvent.event === "frame_added") {
+          emitter.emit("frameAdded", {
+            notificationDetails: frameEvent.notificationDetails,
+          });
+        } else if (frameEvent.event === "frame_add_rejected") {
+          emitter.emit("frameAddRejected", { reason: frameEvent.reason });
+        } else if (frameEvent.event === "frame_removed") {
+          emitter.emit("frameRemoved");
+        } else if (frameEvent.event === "notifications_enabled") {
+          emitter.emit("notificationsEnabled", {
+            notificationDetails: frameEvent.notificationDetails,
+          });
+        } else if (frameEvent.event === "notifications_disabled") {
+          emitter.emit("notificationsDisabled");
         }
       }
     }

package/src/types.ts

@@ -4,6 +4,9 @@ import type {
   FrameContext,
   AddFrame,
   ReadyOptions,
+  SignIn,
+  FrameNotificationDetails,
+  AddFrameRejectedReason,
 } from "@farcaster/frame-core";
 
 declare global {
@@ -21,6 +24,19 @@ export type Compute<type> = { [key in keyof type]: type[key] } & unknown;
 
 export type EventMap = {
   primaryButtonClicked: () => void;
+  frameAdded: ({
+    notificationDetails,
+  }: {
+    notificationDetails?: FrameNotificationDetails;
+  }) => void;
+  frameAddRejected: ({ reason }: { reason: AddFrameRejectedReason }) => void;
+  frameRemoved: () => void;
+  notificationsEnabled: ({
+    notificationDetails,
+  }: {
+    notificationDetails: FrameNotificationDetails;
+  }) => void;
+  notificationsDisabled: () => void;
 };
 
 export type Emitter = Compute<EventEmitter<EventMap>>;
@@ -37,6 +53,7 @@ export type FrameSDK = {
   actions: {
     ready: (options?: Partial<ReadyOptions>) => Promise<void>;
     openUrl: (url: string) => Promise<void>;
+    signIn: SignIn.SignIn;
     close: () => Promise<void>;
     setPrimaryButton: SetPrimaryButton;
     addFrame: AddFrame;