@farcaster/frame-core 0.0.0-canary-20250430150627

package/dist/manifest.d.ts

@@ -0,0 +1,101 @@
+/**
+ * Farcaster manifest for a domain hosted at `/.well-known/farcaster.json`
+ */
+export type Manifest = {
+    accountAssociation: AccountAssociation;
+    frame: FrameConfig;
+};
+/**
+ * Signed domain association linking this frame to a Farcaster account
+ *
+ * A DomainAssociation can be generated using the {@link https://warpcast.com/~/developers/domains | Warpcast
+ * Domains Developer} tool.
+ */
+export type AccountAssociation = {
+    /**
+     * Base64URL encoded JFS signature
+     */
+    header: string;
+    /**
+     * Base64URL encoded payload signature
+     */
+    payload: string;
+    /**
+     * Base64URL encoded signature
+     */
+    signature: string;
+};
+/**
+ * Frame configuration
+ *
+ * @example
+ * ``ts
+ * const frame: FrameConfig = {
+ *   version: '1',
+ *   name: 'Yoink!',
+ *   homeUrl: 'https://yoink.party',
+ *   iconUrl: 'https://yoink.party/img/icon.png',
+ *   imageUrl: 'https://yoink.party/framesV2/opengraph-image',
+ *   buttonTitle: '🚩 Start',
+ *   splashImageUrl: 'https://yoink.party/img/splash.png',
+ *   splashImageBackgroundColor: '#eeeee4',
+ *   webhookUrl: 'https://yoink.party/webhook'
+ * };
+ * ``
+ */
+export type FrameConfig = {
+    /**
+     * Manifest version
+     *
+     * Must be the literal '1'.
+     */
+    version: '1';
+    /**
+     * App name that will be displayed to users
+     *
+     * Max length of 32 characters.
+     */
+    name: string;
+    /**
+     * Default launch URL
+     *
+     * Max length of 1024 characters.
+     */
+    homeUrl: string;
+    /**
+     * Icon URL
+     *
+     * Max length of 1024 characters. Image must be 200x200px and less than 1MB.
+     */
+    iconUrl: string;
+    /**
+     * Image URL
+     *
+     * Max length of 1024 characters. Image must have a 3:2 ratio.
+     */
+    imageUrl: string;
+    /**
+     * Default button title to use when frame is rendered.
+     *
+     * Max length of 32 characters.
+     */
+    buttonTitle: string;
+    /**
+     * Splash image URL
+     *
+     * Max length of 1024 characters. Image must be 200x200px and less than 1MB.
+     */
+    splashImageUrl?: string;
+    /**
+     * Splash background color
+     *
+     * Must be a hex color code.
+     */
+    splashBackgroundColor?: string;
+    /**
+     * URL to which clients will POST server events.
+     * Max length of 1024 characters.
+     * Required if the frame application uses notifications.
+     */
+    webhookUrl?: string;
+};

package/dist/manifest.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/schemas/embeds.d.ts

@@ -0,0 +1,243 @@
+import { z } from 'zod';
+export declare const actionLaunchFrameSchema: z.ZodObject<{
+    type: z.ZodLiteral<"launch_frame">;
+    name: z.ZodString;
+    url: z.ZodOptional<z.ZodString>;
+    splashImageUrl: z.ZodOptional<z.ZodString>;
+    splashBackgroundColor: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    type: "launch_frame";
+    name: string;
+    url?: string | undefined;
+    splashImageUrl?: string | undefined;
+    splashBackgroundColor?: string | undefined;
+}, {
+    type: "launch_frame";
+    name: string;
+    url?: string | undefined;
+    splashImageUrl?: string | undefined;
+    splashBackgroundColor?: string | undefined;
+}>;
+export declare const actionViewTokenSchema: z.ZodObject<{
+    type: z.ZodLiteral<"view_token">;
+    token: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "view_token";
+    token: string;
+}, {
+    type: "view_token";
+    token: string;
+}>;
+export declare const actionSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+    type: z.ZodLiteral<"launch_frame">;
+    name: z.ZodString;
+    url: z.ZodOptional<z.ZodString>;
+    splashImageUrl: z.ZodOptional<z.ZodString>;
+    splashBackgroundColor: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    type: "launch_frame";
+    name: string;
+    url?: string | undefined;
+    splashImageUrl?: string | undefined;
+    splashBackgroundColor?: string | undefined;
+}, {
+    type: "launch_frame";
+    name: string;
+    url?: string | undefined;
+    splashImageUrl?: string | undefined;
+    splashBackgroundColor?: string | undefined;
+}>, z.ZodObject<{
+    type: z.ZodLiteral<"view_token">;
+    token: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: "view_token";
+    token: string;
+}, {
+    type: "view_token";
+    token: string;
+}>]>;
+export declare const buttonSchema: z.ZodObject<{
+    title: z.ZodString;
+    action: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+        type: z.ZodLiteral<"launch_frame">;
+        name: z.ZodString;
+        url: z.ZodOptional<z.ZodString>;
+        splashImageUrl: z.ZodOptional<z.ZodString>;
+        splashBackgroundColor: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        type: "launch_frame";
+        name: string;
+        url?: string | undefined;
+        splashImageUrl?: string | undefined;
+        splashBackgroundColor?: string | undefined;
+    }, {
+        type: "launch_frame";
+        name: string;
+        url?: string | undefined;
+        splashImageUrl?: string | undefined;
+        splashBackgroundColor?: string | undefined;
+    }>, z.ZodObject<{
+        type: z.ZodLiteral<"view_token">;
+        token: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        type: "view_token";
+        token: string;
+    }, {
+        type: "view_token";
+        token: string;
+    }>]>;
+}, "strip", z.ZodTypeAny, {
+    title: string;
+    action: {
+        type: "launch_frame";
+        name: string;
+        url?: string | undefined;
+        splashImageUrl?: string | undefined;
+        splashBackgroundColor?: string | undefined;
+    } | {
+        type: "view_token";
+        token: string;
+    };
+}, {
+    title: string;
+    action: {
+        type: "launch_frame";
+        name: string;
+        url?: string | undefined;
+        splashImageUrl?: string | undefined;
+        splashBackgroundColor?: string | undefined;
+    } | {
+        type: "view_token";
+        token: string;
+    };
+}>;
+export declare const frameEmbedNextSchema: z.ZodObject<{
+    version: z.ZodLiteral<"next">;
+    imageUrl: z.ZodString;
+    aspectRatio: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"1:1">, z.ZodLiteral<"3:2">]>>;
+    button: z.ZodObject<{
+        title: z.ZodString;
+        action: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
+            type: z.ZodLiteral<"launch_frame">;
+            name: z.ZodString;
+            url: z.ZodOptional<z.ZodString>;
+            splashImageUrl: z.ZodOptional<z.ZodString>;
+            splashBackgroundColor: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            type: "launch_frame";
+            name: string;
+            url?: string | undefined;
+            splashImageUrl?: string | undefined;
+            splashBackgroundColor?: string | undefined;
+        }, {
+            type: "launch_frame";
+            name: string;
+            url?: string | undefined;
+            splashImageUrl?: string | undefined;
+            splashBackgroundColor?: string | undefined;
+        }>, z.ZodObject<{
+            type: z.ZodLiteral<"view_token">;
+            token: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            type: "view_token";
+            token: string;
+        }, {
+            type: "view_token";
+            token: string;
+        }>]>;
+    }, "strip", z.ZodTypeAny, {
+        title: string;
+        action: {
+            type: "launch_frame";
+            name: string;
+            url?: string | undefined;
+            splashImageUrl?: string | undefined;
+            splashBackgroundColor?: string | undefined;
+        } | {
+            type: "view_token";
+            token: string;
+        };
+    }, {
+        title: string;
+        action: {
+            type: "launch_frame";
+            name: string;
+            url?: string | undefined;
+            splashImageUrl?: string | undefined;
+            splashBackgroundColor?: string | undefined;
+        } | {
+            type: "view_token";
+            token: string;
+        };
+    }>;
+}, "strip", z.ZodTypeAny, {
+    version: "next";
+    imageUrl: string;
+    button: {
+        title: string;
+        action: {
+            type: "launch_frame";
+            name: string;
+            url?: string | undefined;
+            splashImageUrl?: string | undefined;
+            splashBackgroundColor?: string | undefined;
+        } | {
+            type: "view_token";
+            token: string;
+        };
+    };
+    aspectRatio?: "1:1" | "3:2" | undefined;
+}, {
+    version: "next";
+    imageUrl: string;
+    button: {
+        title: string;
+        action: {
+            type: "launch_frame";
+            name: string;
+            url?: string | undefined;
+            splashImageUrl?: string | undefined;
+            splashBackgroundColor?: string | undefined;
+        } | {
+            type: "view_token";
+            token: string;
+        };
+    };
+    aspectRatio?: "1:1" | "3:2" | undefined;
+}>;
+export declare const safeParseFrameEmbed: (rawResponse: unknown) => z.SafeParseReturnType<{
+    version: "next";
+    imageUrl: string;
+    button: {
+        title: string;
+        action: {
+            type: "launch_frame";
+            name: string;
+            url?: string | undefined;
+            splashImageUrl?: string | undefined;
+            splashBackgroundColor?: string | undefined;
+        } | {
+            type: "view_token";
+            token: string;
+        };
+    };
+    aspectRatio?: "1:1" | "3:2" | undefined;
+}, {
+    version: "next";
+    imageUrl: string;
+    button: {
+        title: string;
+        action: {
+            type: "launch_frame";
+            name: string;
+            url?: string | undefined;
+            splashImageUrl?: string | undefined;
+            splashBackgroundColor?: string | undefined;
+        } | {
+            type: "view_token";
+            token: string;
+        };
+    };
+    aspectRatio?: "1:1" | "3:2" | undefined;
+}>;
+export type FrameEmbedNext = z.infer<typeof frameEmbedNextSchema>;

package/dist/schemas/embeds.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.safeParseFrameEmbed = exports.frameEmbedNextSchema = exports.buttonSchema = exports.actionSchema = exports.actionViewTokenSchema = exports.actionLaunchFrameSchema = void 0;
+const zod_1 = require("zod");
+const shared_1 = require("./shared");
+exports.actionLaunchFrameSchema = zod_1.z.object({
+    type: zod_1.z.literal('launch_frame'),
+    name: shared_1.frameNameSchema,
+    url: shared_1.secureUrlSchema.optional(),
+    splashImageUrl: shared_1.secureUrlSchema.optional(),
+    splashBackgroundColor: shared_1.hexColorSchema.optional(),
+});
+exports.actionViewTokenSchema = zod_1.z.object({
+    type: zod_1.z.literal('view_token'),
+    token: shared_1.caip19TokenSchema,
+});
+exports.actionSchema = zod_1.z.discriminatedUnion('type', [
+    exports.actionLaunchFrameSchema,
+    exports.actionViewTokenSchema,
+]);
+exports.buttonSchema = zod_1.z.object({
+    title: shared_1.buttonTitleSchema,
+    action: exports.actionSchema,
+});
+exports.frameEmbedNextSchema = zod_1.z.object({
+    version: zod_1.z.literal('next'),
+    imageUrl: shared_1.secureUrlSchema,
+    aspectRatio: shared_1.aspectRatioSchema.optional(),
+    button: exports.buttonSchema,
+});
+const safeParseFrameEmbed = (rawResponse) => exports.frameEmbedNextSchema.safeParse(rawResponse);
+exports.safeParseFrameEmbed = safeParseFrameEmbed;

package/dist/schemas/events.d.ts

@@ -0,0 +1,131 @@
+import { z } from 'zod';
+export declare const eventFrameAddedSchema: 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 EventFrameAdded = z.infer<typeof eventFrameAddedSchema>;
+export declare const eventFrameRemovedSchema: z.ZodObject<{
+    event: z.ZodLiteral<"frame_removed">;
+}, "strip", z.ZodTypeAny, {
+    event: "frame_removed";
+}, {
+    event: "frame_removed";
+}>;
+export type EventFrameRemoved = z.infer<typeof eventFrameRemovedSchema>;
+export declare const eventNotificationsEnabledSchema: 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 EventNotificationsEnabled = z.infer<typeof eventNotificationsEnabledSchema>;
+export declare const notificationsDisabledSchema: z.ZodObject<{
+    event: z.ZodLiteral<"notifications_disabled">;
+}, "strip", z.ZodTypeAny, {
+    event: "notifications_disabled";
+}, {
+    event: "notifications_disabled";
+}>;
+export type EventNotificationsDisabled = z.infer<typeof notificationsDisabledSchema>;
+export declare const serverEventSchema: 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 FrameServerEvent = z.infer<typeof serverEventSchema>;

package/dist/schemas/events.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serverEventSchema = exports.notificationsDisabledSchema = exports.eventNotificationsEnabledSchema = exports.eventFrameRemovedSchema = exports.eventFrameAddedSchema = void 0;
+const zod_1 = require("zod");
+const notifications_1 = require("./notifications");
+exports.eventFrameAddedSchema = zod_1.z.object({
+    event: zod_1.z.literal('frame_added'),
+    notificationDetails: notifications_1.notificationDetailsSchema.optional(),
+});
+exports.eventFrameRemovedSchema = zod_1.z.object({
+    event: zod_1.z.literal('frame_removed'),
+});
+exports.eventNotificationsEnabledSchema = zod_1.z.object({
+    event: zod_1.z.literal('notifications_enabled'),
+    notificationDetails: notifications_1.notificationDetailsSchema.required(),
+});
+exports.notificationsDisabledSchema = zod_1.z.object({
+    event: zod_1.z.literal('notifications_disabled'),
+});
+exports.serverEventSchema = zod_1.z.discriminatedUnion('event', [
+    exports.eventFrameAddedSchema,
+    exports.eventFrameRemovedSchema,
+    exports.eventNotificationsEnabledSchema,
+    exports.notificationsDisabledSchema,
+]);

package/dist/schemas/index.d.ts

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

package/dist/schemas/index.js

@@ -0,0 +1,21 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./embeds"), exports);
+__exportStar(require("./events"), exports);
+__exportStar(require("./shared"), exports);
+__exportStar(require("./manifest"), exports);
+__exportStar(require("./notifications"), exports);