@farcaster/frame-core 0.0.11 → 0.0.12

package/dist/types.js

@@ -1,55 +1,3 @@
-import { z } from "zod";
-export const notificationDetailsSchema = z.object({
-    url: z.string(),
-    token: z.string(),
-});
 export const DEFAULT_READY_OPTIONS = {
     disableNativeGestures: false,
 };
-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().max(128),
-    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()),
-    }),
-});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@farcaster/frame-core",
-  "version": "0.0.11",
+  "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>;

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;
@@ -44,14 +44,6 @@ export type FrameLocationContext =
   | FrameLocationContextNotification
   | FrameLocationContextLauncher;
 
-export const notificationDetailsSchema = z.object({
-  url: z.string(),
-  token: z.string(),
-});
-export type FrameNotificationDetails = z.infer<
-  typeof notificationDetailsSchema
->;
-
 export type FrameContext = {
   user: {
     fid: number;
@@ -107,86 +99,6 @@ 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().max(128),
-  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: "frame_eth_provider_event";
 } & EthProviderWireEvent;