@farcaster/frame-core 0.1.4 → 0.1.6

package/dist/back.d.ts

@@ -0,0 +1,13 @@
+export type BackState = {
+    /**
+     * Is the back control visible. Note that on mobile devices Farcaster clients
+     * may support a gesture based control rather than button control.
+     *
+     * @default false
+     */
+    visible: boolean;
+};
+export declare const DEFAULT_BACK_STATE: {
+    visible: false;
+};
+export type UpdateBackState = (state: BackState) => Promise<void>;

package/dist/back.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_BACK_STATE = void 0;
+exports.DEFAULT_BACK_STATE = {
+    visible: false,
+};

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 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';

package/dist/index.js

@@ -36,9 +36,10 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Manifest = exports.Context = exports.Errors = void 0;
+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"));

package/dist/schemas/manifest.d.ts

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-export declare const domainFrameConfigSchema: z.ZodObject<{
+export declare const domainFrameConfigSchema: z.ZodEffects<z.ZodObject<{
     version: z.ZodUnion<[z.ZodLiteral<"0.0.0">, z.ZodLiteral<"0.0.1">, z.ZodLiteral<"1">, z.ZodLiteral<"next">]>;
     name: z.ZodString;
     iconUrl: z.ZodString;
@@ -27,6 +27,9 @@ export declare const domainFrameConfigSchema: z.ZodObject<{
     /** see https://github.com/farcasterxyz/miniapps/discussions/256 */
     requiredChains: z.ZodOptional<z.ZodArray<z.ZodEnum<[string, ...string[]]>, "many">>;
     requiredCapabilities: z.ZodOptional<z.ZodArray<z.ZodEnum<[string, ...string[]]>, "many">>;
+    /** see https://github.com/farcasterxyz/miniapps/discussions/158 */
+    /** Documentation will be added once this feature is finalized. */
+    castShareUrl: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     name: string;
     version: "1" | "next" | "0.0.0" | "0.0.1";
@@ -50,6 +53,7 @@ export declare const domainFrameConfigSchema: z.ZodObject<{
     noindex?: boolean | undefined;
     requiredChains?: string[] | undefined;
     requiredCapabilities?: string[] | undefined;
+    castShareUrl?: string | undefined;
 }, {
     name: string;
     version: "1" | "next" | "0.0.0" | "0.0.1";
@@ -73,6 +77,55 @@ export declare const domainFrameConfigSchema: z.ZodObject<{
     noindex?: boolean | undefined;
     requiredChains?: string[] | undefined;
     requiredCapabilities?: string[] | undefined;
+    castShareUrl?: string | undefined;
+}>, {
+    name: string;
+    version: "1" | "next" | "0.0.0" | "0.0.1";
+    iconUrl: string;
+    homeUrl: string;
+    splashImageUrl?: string | undefined;
+    splashBackgroundColor?: string | undefined;
+    imageUrl?: string | undefined;
+    buttonTitle?: string | undefined;
+    webhookUrl?: string | undefined;
+    subtitle?: string | undefined;
+    description?: string | undefined;
+    screenshotUrls?: string[] | undefined;
+    primaryCategory?: "games" | "social" | "finance" | "utility" | "productivity" | "health-fitness" | "news-media" | "music" | "shopping" | "education" | "developer-tools" | "entertainment" | "art-creativity" | undefined;
+    tags?: string[] | undefined;
+    heroImageUrl?: string | undefined;
+    tagline?: string | undefined;
+    ogTitle?: string | undefined;
+    ogDescription?: string | undefined;
+    ogImageUrl?: string | undefined;
+    noindex?: boolean | undefined;
+    requiredChains?: string[] | undefined;
+    requiredCapabilities?: string[] | undefined;
+    castShareUrl?: string | undefined;
+}, {
+    name: string;
+    version: "1" | "next" | "0.0.0" | "0.0.1";
+    iconUrl: string;
+    homeUrl: string;
+    splashImageUrl?: string | undefined;
+    splashBackgroundColor?: string | undefined;
+    imageUrl?: string | undefined;
+    buttonTitle?: string | undefined;
+    webhookUrl?: string | undefined;
+    subtitle?: string | undefined;
+    description?: string | undefined;
+    screenshotUrls?: string[] | undefined;
+    primaryCategory?: "games" | "social" | "finance" | "utility" | "productivity" | "health-fitness" | "news-media" | "music" | "shopping" | "education" | "developer-tools" | "entertainment" | "art-creativity" | undefined;
+    tags?: string[] | undefined;
+    heroImageUrl?: string | undefined;
+    tagline?: string | undefined;
+    ogTitle?: string | undefined;
+    ogDescription?: string | undefined;
+    ogImageUrl?: string | undefined;
+    noindex?: boolean | undefined;
+    requiredChains?: string[] | undefined;
+    requiredCapabilities?: string[] | undefined;
+    castShareUrl?: string | undefined;
 }>;
 export declare const domainManifestSchema: z.ZodObject<{
     accountAssociation: z.ZodObject<{
@@ -88,7 +141,7 @@ export declare const domainManifestSchema: z.ZodObject<{
         payload: string;
         signature: string;
     }>;
-    frame: z.ZodOptional<z.ZodObject<{
+    frame: z.ZodOptional<z.ZodEffects<z.ZodObject<{
         version: z.ZodUnion<[z.ZodLiteral<"0.0.0">, z.ZodLiteral<"0.0.1">, z.ZodLiteral<"1">, z.ZodLiteral<"next">]>;
         name: z.ZodString;
         iconUrl: z.ZodString;
@@ -116,6 +169,9 @@ export declare const domainManifestSchema: z.ZodObject<{
         /** see https://github.com/farcasterxyz/miniapps/discussions/256 */
         requiredChains: z.ZodOptional<z.ZodArray<z.ZodEnum<[string, ...string[]]>, "many">>;
         requiredCapabilities: z.ZodOptional<z.ZodArray<z.ZodEnum<[string, ...string[]]>, "many">>;
+        /** see https://github.com/farcasterxyz/miniapps/discussions/158 */
+        /** Documentation will be added once this feature is finalized. */
+        castShareUrl: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
         name: string;
         version: "1" | "next" | "0.0.0" | "0.0.1";
@@ -139,6 +195,55 @@ export declare const domainManifestSchema: z.ZodObject<{
         noindex?: boolean | undefined;
         requiredChains?: string[] | undefined;
         requiredCapabilities?: string[] | undefined;
+        castShareUrl?: string | undefined;
+    }, {
+        name: string;
+        version: "1" | "next" | "0.0.0" | "0.0.1";
+        iconUrl: string;
+        homeUrl: string;
+        splashImageUrl?: string | undefined;
+        splashBackgroundColor?: string | undefined;
+        imageUrl?: string | undefined;
+        buttonTitle?: string | undefined;
+        webhookUrl?: string | undefined;
+        subtitle?: string | undefined;
+        description?: string | undefined;
+        screenshotUrls?: string[] | undefined;
+        primaryCategory?: "games" | "social" | "finance" | "utility" | "productivity" | "health-fitness" | "news-media" | "music" | "shopping" | "education" | "developer-tools" | "entertainment" | "art-creativity" | undefined;
+        tags?: string[] | undefined;
+        heroImageUrl?: string | undefined;
+        tagline?: string | undefined;
+        ogTitle?: string | undefined;
+        ogDescription?: string | undefined;
+        ogImageUrl?: string | undefined;
+        noindex?: boolean | undefined;
+        requiredChains?: string[] | undefined;
+        requiredCapabilities?: string[] | undefined;
+        castShareUrl?: string | undefined;
+    }>, {
+        name: string;
+        version: "1" | "next" | "0.0.0" | "0.0.1";
+        iconUrl: string;
+        homeUrl: string;
+        splashImageUrl?: string | undefined;
+        splashBackgroundColor?: string | undefined;
+        imageUrl?: string | undefined;
+        buttonTitle?: string | undefined;
+        webhookUrl?: string | undefined;
+        subtitle?: string | undefined;
+        description?: string | undefined;
+        screenshotUrls?: string[] | undefined;
+        primaryCategory?: "games" | "social" | "finance" | "utility" | "productivity" | "health-fitness" | "news-media" | "music" | "shopping" | "education" | "developer-tools" | "entertainment" | "art-creativity" | undefined;
+        tags?: string[] | undefined;
+        heroImageUrl?: string | undefined;
+        tagline?: string | undefined;
+        ogTitle?: string | undefined;
+        ogDescription?: string | undefined;
+        ogImageUrl?: string | undefined;
+        noindex?: boolean | undefined;
+        requiredChains?: string[] | undefined;
+        requiredCapabilities?: string[] | undefined;
+        castShareUrl?: string | undefined;
     }, {
         name: string;
         version: "1" | "next" | "0.0.0" | "0.0.1";
@@ -162,6 +267,7 @@ export declare const domainManifestSchema: z.ZodObject<{
         noindex?: boolean | undefined;
         requiredChains?: string[] | undefined;
         requiredCapabilities?: string[] | undefined;
+        castShareUrl?: string | undefined;
     }>>;
 }, "strip", z.ZodTypeAny, {
     accountAssociation: {
@@ -192,6 +298,7 @@ export declare const domainManifestSchema: z.ZodObject<{
         noindex?: boolean | undefined;
         requiredChains?: string[] | undefined;
         requiredCapabilities?: string[] | undefined;
+        castShareUrl?: string | undefined;
     } | undefined;
 }, {
     accountAssociation: {
@@ -222,5 +329,6 @@ export declare const domainManifestSchema: z.ZodObject<{
         noindex?: boolean | undefined;
         requiredChains?: string[] | undefined;
         requiredCapabilities?: string[] | undefined;
+        castShareUrl?: string | undefined;
     } | undefined;
 }>;

package/dist/schemas/manifest.js

@@ -37,7 +37,8 @@ const chainList = [
     'eip155:42220', // Celo
     'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp', // Solana
 ];
-exports.domainFrameConfigSchema = zod_1.z.object({
+exports.domainFrameConfigSchema = zod_1.z
+    .object({
     // 0.0.0 and 0.0.1 are not technically part of the spec but kept for
     // backwards compatibility. next should always resolve to the most recent
     // schema version.
@@ -79,6 +80,24 @@ exports.domainFrameConfigSchema = zod_1.z.object({
         .array(zod_1.z.enum(types_ts_1.miniAppHostCapabilityList))
         .max(types_ts_1.miniAppHostCapabilityList.length)
         .optional(),
+    /** see https://github.com/farcasterxyz/miniapps/discussions/158 */
+    /** Documentation will be added once this feature is finalized. */
+    castShareUrl: shared_ts_1.secureUrlSchema.optional(),
+})
+    .refine((data) => {
+    if (data.castShareUrl === undefined)
+        return true;
+    try {
+        const homeUrlDomain = new URL(data.homeUrl).hostname;
+        const castShareUrlDomain = new URL(data.castShareUrl).hostname;
+        return homeUrlDomain === castShareUrlDomain;
+    }
+    catch {
+        return false;
+    }
+}, {
+    message: 'castShareUrl must have the same domain as homeUrl',
+    path: ['castShareUrl'],
 });
 exports.domainManifestSchema = zod_1.z.object({
     accountAssociation: shared_ts_1.encodedJsonFarcasterSignatureSchema,

package/dist/types.d.ts

@@ -1,5 +1,6 @@
 import type { ImpactOccurred, NotificationOccurred, SelectionChanged } from './actions/Haptics.ts';
 import type { AddMiniApp, ComposeCast, Ready, SendToken, SignIn, SwapToken, ViewCast, ViewProfile, ViewToken } from './actions/index.ts';
+import type { UpdateBackState } from './back.ts';
 import type { FrameContext } from './context.ts';
 import type { EventFrameAdded, EventFrameRemoved, EventNotificationsDisabled, EventNotificationsEnabled } from './schemas/index.ts';
 import type { SolanaRequestFn, SolanaWireRequestFn } from './solana.ts';
@@ -16,7 +17,7 @@ export type SignInOptions = SignIn.SignInOptions;
 export type SetPrimaryButton = (options: SetPrimaryButtonOptions) => void;
 export type { ImpactOccurred, NotificationOccurred, SelectionChanged };
 export declare const miniAppHostCapabilityList: [string, ...string[]];
-export type MiniAppHostCapability = 'wallet.getEthereumProvider' | 'wallet.getSolanaProvider' | 'actions.ready' | 'actions.openUrl' | 'actions.close' | 'actions.setPrimaryButton' | 'actions.addMiniApp' | 'actions.signIn' | 'actions.viewCast' | 'actions.viewProfile' | 'actions.composeCast' | 'actions.viewToken' | 'actions.sendToken' | 'actions.swapToken' | 'haptics.impactOccurred' | 'haptics.notificationOccurred' | 'haptics.selectionChanged';
+export type MiniAppHostCapability = 'wallet.getEthereumProvider' | 'wallet.getSolanaProvider' | 'actions.ready' | 'actions.openUrl' | 'actions.close' | 'actions.setPrimaryButton' | 'actions.addMiniApp' | 'actions.signIn' | 'actions.viewCast' | 'actions.viewProfile' | 'actions.composeCast' | 'actions.viewToken' | 'actions.sendToken' | 'actions.swapToken' | 'haptics.impactOccurred' | 'haptics.notificationOccurred' | 'haptics.selectionChanged' | 'back';
 export type GetCapabilities = () => Promise<MiniAppHostCapability[]>;
 export type GetChains = () => Promise<string[]>;
 export type WireFrameHost = {
@@ -42,6 +43,7 @@ export type WireFrameHost = {
     selectionChanged: SelectionChanged;
     getCapabilities: GetCapabilities;
     getChains: GetChains;
+    updateBackState: UpdateBackState;
 };
 export type FrameHost = {
     context: FrameContext;
@@ -70,6 +72,7 @@ export type FrameHost = {
     selectionChanged: SelectionChanged;
     getCapabilities: GetCapabilities;
     getChains: GetChains;
+    updateBackState: UpdateBackState;
 };
 export type EventFrameAddRejected = {
     event: 'frame_add_rejected';
@@ -78,4 +81,7 @@ export type EventFrameAddRejected = {
 export type EventPrimaryButtonClicked = {
     event: 'primary_button_clicked';
 };
-export type FrameClientEvent = EventFrameAdded | EventFrameAddRejected | EventFrameRemoved | EventNotificationsEnabled | EventNotificationsDisabled | EventPrimaryButtonClicked | Ethereum.EventEip6963AnnounceProvider;
+export type EventBackNavigationTriggered = {
+    event: 'back_navigation_triggered';
+};
+export type FrameClientEvent = EventFrameAdded | EventFrameAddRejected | EventFrameRemoved | EventNotificationsEnabled | EventNotificationsDisabled | EventPrimaryButtonClicked | EventBackNavigationTriggered | Ethereum.EventEip6963AnnounceProvider;

package/dist/types.js

@@ -37,4 +37,5 @@ exports.miniAppHostCapabilityList = [
     'haptics.impactOccurred',
     'haptics.notificationOccurred',
     'haptics.selectionChanged',
+    'back',
 ];

package/esm/back.d.ts

@@ -0,0 +1,13 @@
+export type BackState = {
+    /**
+     * Is the back control visible. Note that on mobile devices Farcaster clients
+     * may support a gesture based control rather than button control.
+     *
+     * @default false
+     */
+    visible: boolean;
+};
+export declare const DEFAULT_BACK_STATE: {
+    visible: false;
+};
+export type UpdateBackState = (state: BackState) => Promise<void>;

package/esm/back.js

@@ -0,0 +1,3 @@
+export const DEFAULT_BACK_STATE = {
+    visible: false,
+};

package/esm/index.d.ts

@@ -1,5 +1,6 @@
 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';

package/esm/index.js

@@ -1,5 +1,6 @@
 export * from "./actions/index.js";
 export * from "./wallet/index.js";
+export * as Back from "./back.js";
 export * as Errors from "./errors.js";
 export * as Context from "./context.js";
 export * as Manifest from "./manifest.js";

package/esm/schemas/manifest.d.ts

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-export declare const domainFrameConfigSchema: z.ZodObject<{
+export declare const domainFrameConfigSchema: z.ZodEffects<z.ZodObject<{
     version: z.ZodUnion<[z.ZodLiteral<"0.0.0">, z.ZodLiteral<"0.0.1">, z.ZodLiteral<"1">, z.ZodLiteral<"next">]>;
     name: z.ZodString;
     iconUrl: z.ZodString;
@@ -27,6 +27,9 @@ export declare const domainFrameConfigSchema: z.ZodObject<{
     /** see https://github.com/farcasterxyz/miniapps/discussions/256 */
     requiredChains: z.ZodOptional<z.ZodArray<z.ZodEnum<[string, ...string[]]>, "many">>;
     requiredCapabilities: z.ZodOptional<z.ZodArray<z.ZodEnum<[string, ...string[]]>, "many">>;
+    /** see https://github.com/farcasterxyz/miniapps/discussions/158 */
+    /** Documentation will be added once this feature is finalized. */
+    castShareUrl: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     name: string;
     version: "1" | "next" | "0.0.0" | "0.0.1";
@@ -50,6 +53,7 @@ export declare const domainFrameConfigSchema: z.ZodObject<{
     noindex?: boolean | undefined;
     requiredChains?: string[] | undefined;
     requiredCapabilities?: string[] | undefined;
+    castShareUrl?: string | undefined;
 }, {
     name: string;
     version: "1" | "next" | "0.0.0" | "0.0.1";
@@ -73,6 +77,55 @@ export declare const domainFrameConfigSchema: z.ZodObject<{
     noindex?: boolean | undefined;
     requiredChains?: string[] | undefined;
     requiredCapabilities?: string[] | undefined;
+    castShareUrl?: string | undefined;
+}>, {
+    name: string;
+    version: "1" | "next" | "0.0.0" | "0.0.1";
+    iconUrl: string;
+    homeUrl: string;
+    splashImageUrl?: string | undefined;
+    splashBackgroundColor?: string | undefined;
+    imageUrl?: string | undefined;
+    buttonTitle?: string | undefined;
+    webhookUrl?: string | undefined;
+    subtitle?: string | undefined;
+    description?: string | undefined;
+    screenshotUrls?: string[] | undefined;
+    primaryCategory?: "games" | "social" | "finance" | "utility" | "productivity" | "health-fitness" | "news-media" | "music" | "shopping" | "education" | "developer-tools" | "entertainment" | "art-creativity" | undefined;
+    tags?: string[] | undefined;
+    heroImageUrl?: string | undefined;
+    tagline?: string | undefined;
+    ogTitle?: string | undefined;
+    ogDescription?: string | undefined;
+    ogImageUrl?: string | undefined;
+    noindex?: boolean | undefined;
+    requiredChains?: string[] | undefined;
+    requiredCapabilities?: string[] | undefined;
+    castShareUrl?: string | undefined;
+}, {
+    name: string;
+    version: "1" | "next" | "0.0.0" | "0.0.1";
+    iconUrl: string;
+    homeUrl: string;
+    splashImageUrl?: string | undefined;
+    splashBackgroundColor?: string | undefined;
+    imageUrl?: string | undefined;
+    buttonTitle?: string | undefined;
+    webhookUrl?: string | undefined;
+    subtitle?: string | undefined;
+    description?: string | undefined;
+    screenshotUrls?: string[] | undefined;
+    primaryCategory?: "games" | "social" | "finance" | "utility" | "productivity" | "health-fitness" | "news-media" | "music" | "shopping" | "education" | "developer-tools" | "entertainment" | "art-creativity" | undefined;
+    tags?: string[] | undefined;
+    heroImageUrl?: string | undefined;
+    tagline?: string | undefined;
+    ogTitle?: string | undefined;
+    ogDescription?: string | undefined;
+    ogImageUrl?: string | undefined;
+    noindex?: boolean | undefined;
+    requiredChains?: string[] | undefined;
+    requiredCapabilities?: string[] | undefined;
+    castShareUrl?: string | undefined;
 }>;
 export declare const domainManifestSchema: z.ZodObject<{
     accountAssociation: z.ZodObject<{
@@ -88,7 +141,7 @@ export declare const domainManifestSchema: z.ZodObject<{
         payload: string;
         signature: string;
     }>;
-    frame: z.ZodOptional<z.ZodObject<{
+    frame: z.ZodOptional<z.ZodEffects<z.ZodObject<{
         version: z.ZodUnion<[z.ZodLiteral<"0.0.0">, z.ZodLiteral<"0.0.1">, z.ZodLiteral<"1">, z.ZodLiteral<"next">]>;
         name: z.ZodString;
         iconUrl: z.ZodString;
@@ -116,6 +169,9 @@ export declare const domainManifestSchema: z.ZodObject<{
         /** see https://github.com/farcasterxyz/miniapps/discussions/256 */
         requiredChains: z.ZodOptional<z.ZodArray<z.ZodEnum<[string, ...string[]]>, "many">>;
         requiredCapabilities: z.ZodOptional<z.ZodArray<z.ZodEnum<[string, ...string[]]>, "many">>;
+        /** see https://github.com/farcasterxyz/miniapps/discussions/158 */
+        /** Documentation will be added once this feature is finalized. */
+        castShareUrl: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
         name: string;
         version: "1" | "next" | "0.0.0" | "0.0.1";
@@ -139,6 +195,55 @@ export declare const domainManifestSchema: z.ZodObject<{
         noindex?: boolean | undefined;
         requiredChains?: string[] | undefined;
         requiredCapabilities?: string[] | undefined;
+        castShareUrl?: string | undefined;
+    }, {
+        name: string;
+        version: "1" | "next" | "0.0.0" | "0.0.1";
+        iconUrl: string;
+        homeUrl: string;
+        splashImageUrl?: string | undefined;
+        splashBackgroundColor?: string | undefined;
+        imageUrl?: string | undefined;
+        buttonTitle?: string | undefined;
+        webhookUrl?: string | undefined;
+        subtitle?: string | undefined;
+        description?: string | undefined;
+        screenshotUrls?: string[] | undefined;
+        primaryCategory?: "games" | "social" | "finance" | "utility" | "productivity" | "health-fitness" | "news-media" | "music" | "shopping" | "education" | "developer-tools" | "entertainment" | "art-creativity" | undefined;
+        tags?: string[] | undefined;
+        heroImageUrl?: string | undefined;
+        tagline?: string | undefined;
+        ogTitle?: string | undefined;
+        ogDescription?: string | undefined;
+        ogImageUrl?: string | undefined;
+        noindex?: boolean | undefined;
+        requiredChains?: string[] | undefined;
+        requiredCapabilities?: string[] | undefined;
+        castShareUrl?: string | undefined;
+    }>, {
+        name: string;
+        version: "1" | "next" | "0.0.0" | "0.0.1";
+        iconUrl: string;
+        homeUrl: string;
+        splashImageUrl?: string | undefined;
+        splashBackgroundColor?: string | undefined;
+        imageUrl?: string | undefined;
+        buttonTitle?: string | undefined;
+        webhookUrl?: string | undefined;
+        subtitle?: string | undefined;
+        description?: string | undefined;
+        screenshotUrls?: string[] | undefined;
+        primaryCategory?: "games" | "social" | "finance" | "utility" | "productivity" | "health-fitness" | "news-media" | "music" | "shopping" | "education" | "developer-tools" | "entertainment" | "art-creativity" | undefined;
+        tags?: string[] | undefined;
+        heroImageUrl?: string | undefined;
+        tagline?: string | undefined;
+        ogTitle?: string | undefined;
+        ogDescription?: string | undefined;
+        ogImageUrl?: string | undefined;
+        noindex?: boolean | undefined;
+        requiredChains?: string[] | undefined;
+        requiredCapabilities?: string[] | undefined;
+        castShareUrl?: string | undefined;
     }, {
         name: string;
         version: "1" | "next" | "0.0.0" | "0.0.1";
@@ -162,6 +267,7 @@ export declare const domainManifestSchema: z.ZodObject<{
         noindex?: boolean | undefined;
         requiredChains?: string[] | undefined;
         requiredCapabilities?: string[] | undefined;
+        castShareUrl?: string | undefined;
     }>>;
 }, "strip", z.ZodTypeAny, {
     accountAssociation: {
@@ -192,6 +298,7 @@ export declare const domainManifestSchema: z.ZodObject<{
         noindex?: boolean | undefined;
         requiredChains?: string[] | undefined;
         requiredCapabilities?: string[] | undefined;
+        castShareUrl?: string | undefined;
     } | undefined;
 }, {
     accountAssociation: {
@@ -222,5 +329,6 @@ export declare const domainManifestSchema: z.ZodObject<{
         noindex?: boolean | undefined;
         requiredChains?: string[] | undefined;
         requiredCapabilities?: string[] | undefined;
+        castShareUrl?: string | undefined;
     } | undefined;
 }>;

package/esm/schemas/manifest.js

@@ -34,7 +34,8 @@ const chainList = [
     'eip155:42220', // Celo
     'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp', // Solana
 ];
-export const domainFrameConfigSchema = z.object({
+export const domainFrameConfigSchema = z
+    .object({
     // 0.0.0 and 0.0.1 are not technically part of the spec but kept for
     // backwards compatibility. next should always resolve to the most recent
     // schema version.
@@ -76,6 +77,24 @@ export const domainFrameConfigSchema = z.object({
         .array(z.enum(miniAppHostCapabilityList))
         .max(miniAppHostCapabilityList.length)
         .optional(),
+    /** see https://github.com/farcasterxyz/miniapps/discussions/158 */
+    /** Documentation will be added once this feature is finalized. */
+    castShareUrl: secureUrlSchema.optional(),
+})
+    .refine((data) => {
+    if (data.castShareUrl === undefined)
+        return true;
+    try {
+        const homeUrlDomain = new URL(data.homeUrl).hostname;
+        const castShareUrlDomain = new URL(data.castShareUrl).hostname;
+        return homeUrlDomain === castShareUrlDomain;
+    }
+    catch {
+        return false;
+    }
+}, {
+    message: 'castShareUrl must have the same domain as homeUrl',
+    path: ['castShareUrl'],
 });
 export const domainManifestSchema = z.object({
     accountAssociation: encodedJsonFarcasterSignatureSchema,