@farcaster/frame-core 0.0.10 → 0.0.12

package/dist/types.d.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;
     loading?: boolean;
@@ -14,7 +14,14 @@ 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;
@@ -22,7 +29,10 @@ export type FrameLocationNotificationContext = {
         body: string;
     };
 };
-export type FrameLocationContext = FrameLocationNotificationContext;
+export type FrameLocationContextLauncher = {
+    type: "launcher";
+};
+export type FrameLocationContext = FrameLocationContextCastEmbed | FrameLocationContextNotification | FrameLocationContextLauncher;
 export type FrameContext = {
     user: {
         fid: number;
@@ -34,250 +44,42 @@ export type FrameContext = {
         pfpUrl?: string;
     };
     location?: FrameLocationContext;
+    client: {
+        clientFid: number;
+        added: boolean;
+        notificationDetails?: FrameNotificationDetails;
+    };
 };
-export declare const notificationDetailsSchema: z.ZodObject<{
-    url: z.ZodString;
-    token: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    url: string;
-    token: string;
-}, {
-    url: string;
-    token: string;
-}>;
-export type FrameNotificationDetails = z.infer<typeof notificationDetailsSchema>;
 export type AddFrameResult = {
     added: true;
     notificationDetails?: FrameNotificationDetails;
 } | {
     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 declare const DEFAULT_READY_OPTIONS: ReadyOptions;
 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;
     ethProviderRequestV2: RpcTransport;
     addFrame: AddFrame;
 };
-export declare const eventSchema: z.ZodObject<{
-    header: z.ZodString;
-    payload: z.ZodString;
-    signature: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    header: string;
-    payload: string;
-    signature: string;
-}, {
-    header: string;
-    payload: string;
-    signature: string;
-}>;
-export type EventSchema = z.infer<typeof eventSchema>;
-export declare const eventHeaderSchema: z.ZodObject<{
-    fid: z.ZodNumber;
-    type: z.ZodLiteral<"app_key">;
-    key: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    type: "app_key";
-    fid: number;
-    key: string;
-}, {
-    type: "app_key";
-    fid: number;
-    key: string;
-}>;
-export type EventHeader = z.infer<typeof eventHeaderSchema>;
-export declare const eventFrameAddedPayloadSchema: z.ZodObject<{
-    event: z.ZodLiteral<"frame-added">;
-    notificationDetails: z.ZodOptional<z.ZodObject<{
-        url: z.ZodString;
-        token: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        url: string;
-        token: string;
-    }, {
-        url: string;
-        token: string;
-    }>>;
-}, "strip", z.ZodTypeAny, {
-    event: "frame-added";
-    notificationDetails?: {
-        url: string;
-        token: string;
-    } | undefined;
-}, {
-    event: "frame-added";
-    notificationDetails?: {
-        url: string;
-        token: string;
-    } | undefined;
-}>;
-export type EventFrameAddedPayload = z.infer<typeof eventFrameAddedPayloadSchema>;
-export declare const eventFrameRemovedPayloadSchema: z.ZodObject<{
-    event: z.ZodLiteral<"frame-removed">;
-}, "strip", z.ZodTypeAny, {
-    event: "frame-removed";
-}, {
-    event: "frame-removed";
-}>;
-export type EventFrameRemovedPayload = z.infer<typeof eventFrameRemovedPayloadSchema>;
-export declare const eventNotificationsEnabledPayloadSchema: z.ZodObject<{
-    event: z.ZodLiteral<"notifications-enabled">;
-    notificationDetails: z.ZodObject<{
-        url: z.ZodString;
-        token: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        url: string;
-        token: string;
-    }, {
-        url: string;
-        token: string;
-    }>;
-}, "strip", z.ZodTypeAny, {
-    event: "notifications-enabled";
-    notificationDetails: {
-        url: string;
-        token: string;
-    };
-}, {
-    event: "notifications-enabled";
-    notificationDetails: {
-        url: string;
-        token: string;
-    };
-}>;
-export type EventNotificationsEnabledPayload = z.infer<typeof eventNotificationsEnabledPayloadSchema>;
-export declare const notificationsDisabledPayloadSchema: z.ZodObject<{
-    event: z.ZodLiteral<"notifications-disabled">;
-}, "strip", z.ZodTypeAny, {
-    event: "notifications-disabled";
-}, {
-    event: "notifications-disabled";
-}>;
-export type EventNotificationsDisabledPayload = z.infer<typeof notificationsDisabledPayloadSchema>;
-export declare const eventPayloadSchema: z.ZodDiscriminatedUnion<"event", [z.ZodObject<{
-    event: z.ZodLiteral<"frame-added">;
-    notificationDetails: z.ZodOptional<z.ZodObject<{
-        url: z.ZodString;
-        token: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        url: string;
-        token: string;
-    }, {
-        url: string;
-        token: string;
-    }>>;
-}, "strip", z.ZodTypeAny, {
-    event: "frame-added";
-    notificationDetails?: {
-        url: string;
-        token: string;
-    } | undefined;
-}, {
-    event: "frame-added";
-    notificationDetails?: {
-        url: string;
-        token: string;
-    } | undefined;
-}>, z.ZodObject<{
-    event: z.ZodLiteral<"frame-removed">;
-}, "strip", z.ZodTypeAny, {
-    event: "frame-removed";
-}, {
-    event: "frame-removed";
-}>, z.ZodObject<{
-    event: z.ZodLiteral<"notifications-enabled">;
-    notificationDetails: z.ZodObject<{
-        url: z.ZodString;
-        token: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        url: string;
-        token: string;
-    }, {
-        url: string;
-        token: string;
-    }>;
-}, "strip", z.ZodTypeAny, {
-    event: "notifications-enabled";
-    notificationDetails: {
-        url: string;
-        token: string;
-    };
-}, {
-    event: "notifications-enabled";
-    notificationDetails: {
-        url: string;
-        token: string;
-    };
-}>, z.ZodObject<{
-    event: z.ZodLiteral<"notifications-disabled">;
-}, "strip", z.ZodTypeAny, {
-    event: "notifications-disabled";
-}, {
-    event: "notifications-disabled";
-}>]>;
-export type FrameEvent = z.infer<typeof eventPayloadSchema>;
-export declare const sendNotificationRequestSchema: z.ZodObject<{
-    notificationId: z.ZodString;
-    title: z.ZodString;
-    body: z.ZodString;
-    targetUrl: z.ZodString;
-    tokens: z.ZodArray<z.ZodString, "many">;
-}, "strip", z.ZodTypeAny, {
-    notificationId: string;
-    title: string;
-    body: string;
-    targetUrl: string;
-    tokens: string[];
-}, {
-    notificationId: string;
-    title: string;
-    body: string;
-    targetUrl: string;
-    tokens: string[];
-}>;
-export type SendNotificationRequest = z.infer<typeof sendNotificationRequestSchema>;
-export declare const sendNotificationResponseSchema: z.ZodObject<{
-    result: z.ZodObject<{
-        successfulTokens: z.ZodArray<z.ZodString, "many">;
-        invalidTokens: z.ZodArray<z.ZodString, "many">;
-        rateLimitedTokens: z.ZodArray<z.ZodString, "many">;
-    }, "strip", z.ZodTypeAny, {
-        successfulTokens: string[];
-        invalidTokens: string[];
-        rateLimitedTokens: string[];
-    }, {
-        successfulTokens: string[];
-        invalidTokens: string[];
-        rateLimitedTokens: string[];
-    }>;
-}, "strip", z.ZodTypeAny, {
-    result: {
-        successfulTokens: string[];
-        invalidTokens: string[];
-        rateLimitedTokens: string[];
-    };
-}, {
-    result: {
-        successfulTokens: string[];
-        invalidTokens: string[];
-        rateLimitedTokens: string[];
-    };
-}>;
-export type SendNotificationResponse = z.infer<typeof sendNotificationResponseSchema>;
 export type FrameEthProviderEventData = {
-    type: 'frameEthProviderEvent';
+    type: "frame_eth_provider_event";
 } & EthProviderWireEvent;
 export type RpcTransport = (request: RpcRequest.RpcRequest) => Promise<RpcResponse.RpcResponse>;
 export type ProviderRpcError = {
@@ -301,6 +103,6 @@ export type EthProviderWireEvent = {
     event: "message";
     params: [Provider.Message];
 };
-export type EmitEthProvider = <event extends EthProviderWireEvent['event']>(event: event, params: Extract<EthProviderWireEvent, {
+export type EmitEthProvider = <event extends EthProviderWireEvent["event"]>(event: event, params: Extract<EthProviderWireEvent, {
     event: event;
-}>['params']) => void;
+}>["params"]) => void;

package/dist/types.js

@@ -1,52 +1,3 @@
-import { z } from "zod";
-export const notificationDetailsSchema = z.object({
-    url: z.string(),
-    token: z.string(),
-});
-export const eventSchema = z.object({
-    header: z.string(),
-    payload: z.string(),
-    signature: z.string(),
-});
-// JSON Farcaster Signature header after decoding
-export const eventHeaderSchema = z.object({
-    fid: z.number(),
-    type: z.literal("app_key"),
-    key: z.string().startsWith("0x"),
-});
-// Webhook event payload after decoding
-export const eventFrameAddedPayloadSchema = z.object({
-    event: z.literal("frame-added"),
-    notificationDetails: notificationDetailsSchema.optional(),
-});
-export const eventFrameRemovedPayloadSchema = z.object({
-    event: z.literal("frame-removed"),
-});
-export const eventNotificationsEnabledPayloadSchema = z.object({
-    event: z.literal("notifications-enabled"),
-    notificationDetails: notificationDetailsSchema.required(),
-});
-export const notificationsDisabledPayloadSchema = z.object({
-    event: z.literal("notifications-disabled"),
-});
-export const eventPayloadSchema = z.discriminatedUnion("event", [
-    eventFrameAddedPayloadSchema,
-    eventFrameRemovedPayloadSchema,
-    eventNotificationsEnabledPayloadSchema,
-    notificationsDisabledPayloadSchema,
-]);
-// 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 const sendNotificationResponseSchema = z.object({
-    result: z.object({
-        successfulTokens: z.array(z.string()),
-        invalidTokens: z.array(z.string()),
-        rateLimitedTokens: z.array(z.string()),
-    }),
-});
+export const DEFAULT_READY_OPTIONS = {
+    disableNativeGestures: false,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@farcaster/frame-core",
-  "version": "0.0.10",
+  "version": "0.0.12",
   "main": "dist/index.js",
   "scripts": {
     "clean": "rm -rf dist",

package/src/index.ts

@@ -1 +1,2 @@
 export * from "./types";
+export * from "./schemas";

package/src/schemas/embeds.ts

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

package/src/schemas/events.ts

@@ -0,0 +1,47 @@
+import { z } from 'zod';
+import { notificationDetailsSchema } from './notifications';
+
+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>;
+
+

package/src/schemas/index.ts

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

package/src/schemas/manifest.ts

@@ -0,0 +1,17 @@
+import { z } from 'zod';
+import { secureUrlSchema, frameNameSchema, colorValueSchema, encodedJsonFarcasterSignatureSchema } from './shared';
+
+export const domainFrameConfig = z.object({
+  version: z.string(),
+  name: frameNameSchema,
+  iconUrl: secureUrlSchema,
+  homeUrl: secureUrlSchema,
+  splashImageUrl: secureUrlSchema.optional(),
+  splashBackgroundColor: colorValueSchema.optional(),
+  webhookUrl: secureUrlSchema.optional()
+});
+
+export const domainManifest = z.object({
+  accountAssociation: encodedJsonFarcasterSignatureSchema,
+  frame: domainFrameConfig.optional(),
+});

package/src/schemas/notifications.ts

@@ -0,0 +1,35 @@
+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 const sendNotificationRequestSchema = z.object({
+  notificationId: z.string().max(128),
+  title: z.string().max(32),
+  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({
+    successfulTokens: z.array(z.string()),
+    invalidTokens: z.array(z.string()),
+    rateLimitedTokens: z.array(z.string()),
+  }),
+});
+
+export type SendNotificationResponse = z.infer<
+  typeof sendNotificationResponseSchema
+>;

package/src/schemas/shared.ts

@@ -0,0 +1,23 @@
+import { z } from 'zod';
+
+export const secureUrlSchema = z.string().url().startsWith('https://', { message: 'Must be an https url' }).max(512);
+
+export const frameNameSchema = z.string().max(32);
+
+export const colorValueSchema = z.string().max(9).optional();
+
+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"),
+});
+
+export type JsonFarcasterSignatureHeaderSchema = z.infer<typeof jsonFarcasterSignatureHeaderSchema>;