@farcaster/frame-core 0.0.17 → 0.0.19

package/src/schemas/events.ts

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

package/src/types.ts

@@ -1,5 +1,18 @@
-import type { Address, Provider, RpcRequest, RpcResponse, RpcSchema } from "ox";
-import { FrameNotificationDetails } from "./schemas";
+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;
@@ -53,6 +66,7 @@ export type FrameContext = {
      * Profile image URL
      */
     pfpUrl?: string;
+    location?: AccountLocation;
   };
   location?: FrameLocationContext;
   client: {
@@ -62,6 +76,10 @@ export type FrameContext = {
   };
 };
 
+export type AddFrameRejectedReason =
+  | "invalid_domain_manifest"
+  | "rejected_by_user";
+
 export type AddFrameResult =
   | {
       added: true;
@@ -69,7 +87,7 @@ export type AddFrameResult =
     }
   | {
       added: false;
-      reason: "invalid_domain_manifest" | "rejected_by_user";
+      reason: AddFrameRejectedReason;
     };
 
 export type AddFrame = () => Promise<AddFrameResult>;
@@ -88,11 +106,43 @@ export const DEFAULT_READY_OPTIONS: ReadyOptions = {
   disableNativeGestures: false,
 };
 
+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 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;
+};
+
 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;
@@ -139,3 +189,20 @@ 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;
+};
+
+export type EventPrimaryButtonClicked = {
+  event: "primary_button_clicked";
+};
+
+export type FrameClientEvent =
+  | EventFrameAdded
+  | EventFrameAddRejected
+  | EventFrameRemoved
+  | EventNotificationsEnabled
+  | EventNotificationsDisabled
+  | EventPrimaryButtonClicked;