@farcaster/miniapp-core 0.0.0-canary-20250630212339

package/dist/index.d.ts

@@ -0,0 +1,10 @@
+export * from './actions/index.ts';
+export * from './wallet/index.ts';
+export * as Back from './back.ts';
+export * as Errors from './errors.ts';
+export * as Context from './context.ts';
+export * as Manifest from './manifest.ts';
+export * from './types.ts';
+export * from './schemas/index.ts';
+export * from './solana.ts';
+export * from './solanaWire.ts';

package/dist/index.js

@@ -0,0 +1,49 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+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);
+};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Manifest = exports.Context = exports.Errors = exports.Back = void 0;
+__exportStar(require("./actions/index.js"), exports);
+__exportStar(require("./wallet/index.js"), exports);
+exports.Back = __importStar(require("./back.js"));
+exports.Errors = __importStar(require("./errors.js"));
+exports.Context = __importStar(require("./context.js"));
+exports.Manifest = __importStar(require("./manifest.js"));
+__exportStar(require("./types.js"), exports);
+__exportStar(require("./schemas/index.js"), exports);
+__exportStar(require("./solana.js"), exports);
+__exportStar(require("./solanaWire.js"), exports);

package/dist/internal/types.d.ts

@@ -0,0 +1,8 @@
+type Compute<type> = {
+    [key in keyof type]: type[key];
+} & unknown;
+type KeyofUnion<type> = type extends type ? keyof type : never;
+export type OneOf<union extends object, fallback extends object | undefined = undefined, keys extends KeyofUnion<union> = KeyofUnion<union>> = union extends infer item ? Compute<item & {
+    [key in Exclude<keys, keyof item>]?: fallback extends object ? key extends keyof fallback ? fallback[key] : undefined : undefined;
+}> : never;
+export {};

package/dist/internal/types.js

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

package/dist/manifest.d.ts

@@ -0,0 +1,113 @@
+/**
+ * Farcaster manifest for a domain hosted at `/.well-known/farcaster.json`
+ */
+export type Manifest = {
+    accountAssociation: AccountAssociation;
+    miniapp?: MiniAppConfig;
+    frame?: MiniAppConfig;
+};
+/**
+ * Signed domain association linking this miniapp to a Farcaster account
+ *
+ * A DomainAssociation can be generated using the {@link https://farcaster.xyz/~/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;
+};
+/**
+ * MiniApp configuration
+ *
+ * @example
+ * ``ts
+ * const miniapp: MiniAppConfig = {
+ *   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 MiniAppConfig = {
+    /**
+     * 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 miniapp 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 miniapp application uses notifications.
+     */
+    webhookUrl?: string;
+    /**
+     * Canonical domain for the miniapp application.
+     * If specified, this domain will be treated as the primary domain for the miniapp.
+     * Max length of 1024 characters.
+     */
+    canonicalDomain?: string;
+};
+/**
+ * Helper function to get the MiniApp config from a manifest,
+ * supporting both 'miniapp' and 'frame' properties during the transition period
+ */
+export declare function getMiniAppConfig(manifest: Manifest): MiniAppConfig | undefined;

package/dist/manifest.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMiniAppConfig = getMiniAppConfig;
+/**
+ * Helper function to get the MiniApp config from a manifest,
+ * supporting both 'miniapp' and 'frame' properties during the transition period
+ */
+function getMiniAppConfig(manifest) {
+    return manifest.miniapp || manifest.frame;
+}

package/dist/schemas/embeds.d.ts

@@ -0,0 +1,128 @@
+import { z } from 'zod/v4';
+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>;
+}, z.core.$strip>;
+export declare const actionLaunchMiniAppSchema: z.ZodObject<{
+    type: z.ZodLiteral<"launch_miniapp">;
+    name: z.ZodString;
+    url: z.ZodOptional<z.ZodString>;
+    splashImageUrl: z.ZodOptional<z.ZodString>;
+    splashBackgroundColor: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export declare const actionViewTokenSchema: z.ZodObject<{
+    type: z.ZodLiteral<"view_token">;
+    token: z.ZodString;
+}, z.core.$strip>;
+export declare const actionSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    type: z.ZodLiteral<"launch_miniapp">;
+    name: z.ZodString;
+    url: z.ZodOptional<z.ZodString>;
+    splashImageUrl: z.ZodOptional<z.ZodString>;
+    splashBackgroundColor: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<"view_token">;
+    token: z.ZodString;
+}, z.core.$strip>, 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>;
+}, z.core.$strip>]>;
+export declare const buttonSchema: z.ZodObject<{
+    title: z.ZodString;
+    action: z.ZodDiscriminatedUnion<[z.ZodObject<{
+        type: z.ZodLiteral<"launch_miniapp">;
+        name: z.ZodString;
+        url: z.ZodOptional<z.ZodString>;
+        splashImageUrl: z.ZodOptional<z.ZodString>;
+        splashBackgroundColor: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>, z.ZodObject<{
+        type: z.ZodLiteral<"view_token">;
+        token: z.ZodString;
+    }, z.core.$strip>, 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>;
+    }, z.core.$strip>]>;
+}, z.core.$strip>;
+export declare const miniAppEmbedNextSchema: z.ZodObject<{
+    version: z.ZodLiteral<"next">;
+    imageUrl: z.ZodString;
+    aspectRatio: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"1:1">, z.ZodLiteral<"3:2">]>>;
+    button: z.ZodObject<{
+        title: z.ZodString;
+        action: z.ZodDiscriminatedUnion<[z.ZodObject<{
+            type: z.ZodLiteral<"launch_miniapp">;
+            name: z.ZodString;
+            url: z.ZodOptional<z.ZodString>;
+            splashImageUrl: z.ZodOptional<z.ZodString>;
+            splashBackgroundColor: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>, z.ZodObject<{
+            type: z.ZodLiteral<"view_token">;
+            token: z.ZodString;
+        }, z.core.$strip>, 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>;
+        }, z.core.$strip>]>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export declare const safeParseMiniAppEmbed: (rawResponse: unknown) => z.ZodSafeParseResult<{
+    version: "next";
+    imageUrl: string;
+    button: {
+        title: string;
+        action: {
+            type: "launch_miniapp";
+            name: string;
+            url?: string | undefined;
+            splashImageUrl?: string | undefined;
+            splashBackgroundColor?: string | undefined;
+        } | {
+            type: "view_token";
+            token: string;
+        } | {
+            type: "launch_frame";
+            name: string;
+            url?: string | undefined;
+            splashImageUrl?: string | undefined;
+            splashBackgroundColor?: string | undefined;
+        };
+    };
+    aspectRatio?: "1:1" | "3:2" | undefined;
+}>;
+export declare const safeParseFrameEmbed: (rawResponse: unknown) => z.ZodSafeParseResult<{
+    version: "next";
+    imageUrl: string;
+    button: {
+        title: string;
+        action: {
+            type: "launch_miniapp";
+            name: string;
+            url?: string | undefined;
+            splashImageUrl?: string | undefined;
+            splashBackgroundColor?: string | undefined;
+        } | {
+            type: "view_token";
+            token: string;
+        } | {
+            type: "launch_frame";
+            name: string;
+            url?: string | undefined;
+            splashImageUrl?: string | undefined;
+            splashBackgroundColor?: string | undefined;
+        };
+    };
+    aspectRatio?: "1:1" | "3:2" | undefined;
+}>;
+export type MiniAppEmbedNext = z.infer<typeof miniAppEmbedNextSchema>;
+export type FrameEmbedNext = MiniAppEmbedNext;

package/dist/schemas/embeds.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.safeParseFrameEmbed = exports.safeParseMiniAppEmbed = exports.miniAppEmbedNextSchema = exports.buttonSchema = exports.actionSchema = exports.actionViewTokenSchema = exports.actionLaunchMiniAppSchema = exports.actionLaunchFrameSchema = void 0;
+const v4_1 = require("zod/v4");
+const shared_ts_1 = require("./shared.js");
+exports.actionLaunchFrameSchema = v4_1.z.object({
+    type: v4_1.z.literal('launch_frame'),
+    name: shared_ts_1.miniAppNameSchema,
+    url: shared_ts_1.secureUrlSchema.optional(),
+    splashImageUrl: shared_ts_1.secureUrlSchema.optional(),
+    splashBackgroundColor: shared_ts_1.hexColorSchema.optional(),
+});
+exports.actionLaunchMiniAppSchema = v4_1.z.object({
+    type: v4_1.z.literal('launch_miniapp'),
+    name: shared_ts_1.miniAppNameSchema,
+    url: shared_ts_1.secureUrlSchema.optional(),
+    splashImageUrl: shared_ts_1.secureUrlSchema.optional(),
+    splashBackgroundColor: shared_ts_1.hexColorSchema.optional(),
+});
+exports.actionViewTokenSchema = v4_1.z.object({
+    type: v4_1.z.literal('view_token'),
+    token: shared_ts_1.caip19TokenSchema,
+});
+exports.actionSchema = v4_1.z.discriminatedUnion('type', [
+    exports.actionLaunchMiniAppSchema,
+    exports.actionViewTokenSchema,
+    // Remove after compatibility period
+    exports.actionLaunchFrameSchema,
+]);
+exports.buttonSchema = v4_1.z.object({
+    title: shared_ts_1.buttonTitleSchema,
+    action: exports.actionSchema,
+});
+exports.miniAppEmbedNextSchema = v4_1.z.object({
+    version: v4_1.z.literal('next'),
+    imageUrl: shared_ts_1.secureUrlSchema,
+    aspectRatio: shared_ts_1.aspectRatioSchema.optional(),
+    button: exports.buttonSchema,
+});
+const safeParseMiniAppEmbed = (rawResponse) => exports.miniAppEmbedNextSchema.safeParse(rawResponse);
+exports.safeParseMiniAppEmbed = safeParseMiniAppEmbed;
+// Backward compatibility - also parse fc:frame meta tags
+exports.safeParseFrameEmbed = exports.safeParseMiniAppEmbed;

package/dist/schemas/events.d.ts

@@ -0,0 +1,63 @@
+import { z } from 'zod/v4';
+export declare const eventMiniAppAddedSchema: z.ZodObject<{
+    event: z.ZodLiteral<"miniapp_added">;
+    notificationDetails: z.ZodOptional<z.ZodObject<{
+        url: z.ZodString;
+        token: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type EventMiniAppAdded = z.infer<typeof eventMiniAppAddedSchema>;
+export declare const eventFrameAddedSchema: z.ZodObject<{
+    event: z.ZodLiteral<"frame_added">;
+    notificationDetails: z.ZodOptional<z.ZodObject<{
+        url: z.ZodString;
+        token: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type EventFrameAdded = z.infer<typeof eventFrameAddedSchema>;
+export declare const eventMiniAppRemovedSchema: z.ZodObject<{
+    event: z.ZodLiteral<"miniapp_removed">;
+}, z.core.$strip>;
+export type EventMiniAppRemoved = z.infer<typeof eventMiniAppRemovedSchema>;
+export declare const eventFrameRemovedSchema: z.ZodObject<{
+    event: z.ZodLiteral<"frame_removed">;
+}, z.core.$strip>;
+export type EventFrameRemoved = z.infer<typeof eventFrameRemovedSchema>;
+export declare const eventNotificationsEnabledSchema: z.ZodObject<{
+    event: z.ZodLiteral<"notifications_enabled">;
+    notificationDetails: z.ZodObject<{
+        url: z.ZodNonOptional<z.ZodString>;
+        token: z.ZodNonOptional<z.ZodString>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type EventNotificationsEnabled = z.infer<typeof eventNotificationsEnabledSchema>;
+export declare const notificationsDisabledSchema: z.ZodObject<{
+    event: z.ZodLiteral<"notifications_disabled">;
+}, z.core.$strip>;
+export type EventNotificationsDisabled = z.infer<typeof notificationsDisabledSchema>;
+export declare const serverEventSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    event: z.ZodLiteral<"miniapp_added">;
+    notificationDetails: z.ZodOptional<z.ZodObject<{
+        url: z.ZodString;
+        token: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>, z.ZodObject<{
+    event: z.ZodLiteral<"miniapp_removed">;
+}, z.core.$strip>, z.ZodObject<{
+    event: z.ZodLiteral<"notifications_enabled">;
+    notificationDetails: z.ZodObject<{
+        url: z.ZodNonOptional<z.ZodString>;
+        token: z.ZodNonOptional<z.ZodString>;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    event: z.ZodLiteral<"notifications_disabled">;
+}, z.core.$strip>, z.ZodObject<{
+    event: z.ZodLiteral<"frame_added">;
+    notificationDetails: z.ZodOptional<z.ZodObject<{
+        url: z.ZodString;
+        token: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>, z.ZodObject<{
+    event: z.ZodLiteral<"frame_removed">;
+}, z.core.$strip>]>;
+export type MiniAppServerEvent = z.infer<typeof serverEventSchema>;

package/dist/schemas/events.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serverEventSchema = exports.notificationsDisabledSchema = exports.eventNotificationsEnabledSchema = exports.eventFrameRemovedSchema = exports.eventMiniAppRemovedSchema = exports.eventFrameAddedSchema = exports.eventMiniAppAddedSchema = void 0;
+const v4_1 = require("zod/v4");
+const notifications_ts_1 = require("./notifications.js");
+exports.eventMiniAppAddedSchema = v4_1.z.object({
+    event: v4_1.z.literal('miniapp_added'),
+    notificationDetails: notifications_ts_1.notificationDetailsSchema.optional(),
+});
+exports.eventFrameAddedSchema = v4_1.z.object({
+    event: v4_1.z.literal('frame_added'),
+    notificationDetails: notifications_ts_1.notificationDetailsSchema.optional(),
+});
+exports.eventMiniAppRemovedSchema = v4_1.z.object({
+    event: v4_1.z.literal('miniapp_removed'),
+});
+exports.eventFrameRemovedSchema = v4_1.z.object({
+    event: v4_1.z.literal('frame_removed'),
+});
+exports.eventNotificationsEnabledSchema = v4_1.z.object({
+    event: v4_1.z.literal('notifications_enabled'),
+    notificationDetails: notifications_ts_1.notificationDetailsSchema.required(),
+});
+exports.notificationsDisabledSchema = v4_1.z.object({
+    event: v4_1.z.literal('notifications_disabled'),
+});
+exports.serverEventSchema = v4_1.z.discriminatedUnion('event', [
+    exports.eventMiniAppAddedSchema,
+    exports.eventMiniAppRemovedSchema,
+    exports.eventNotificationsEnabledSchema,
+    exports.notificationsDisabledSchema,
+    // Remove after compatibility period
+    exports.eventFrameAddedSchema,
+    exports.eventFrameRemovedSchema,
+]);

package/dist/schemas/index.d.ts

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

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.js"), exports);
+__exportStar(require("./events.js"), exports);
+__exportStar(require("./shared.js"), exports);
+__exportStar(require("./manifest.js"), exports);
+__exportStar(require("./notifications.js"), exports);