@farcaster/frame-core 0.0.29 → 0.0.32

package/README.md

@@ -0,0 +1,13 @@
+# @farcaster/frame-core
+
+Build onchain social apps
+
+## Installation
+
+```bash
+pnpm add @farcaster/core
+```
+
+## Documentation
+
+For documentation and guides, visit [miniapps.farcaster.xyz](https://miniapps.farcaster.xyz).

package/dist/actions/ComposeCast.d.ts

@@ -0,0 +1,32 @@
+export type Options<close extends boolean | undefined = undefined> = {
+    /**
+     * Suggested text for the body of the cast.
+     *
+     * Mentions can be included using the human-writeable form (e.g. @farcaster).
+     **/
+    text?: string;
+    /** Suggested embeds. Max two. */
+    embeds?: [] | [string] | [string, string];
+    /** Suggested parent. */
+    parent?: {
+        type: 'cast';
+        hash: string;
+    };
+    /** Whether the app should be closed when this action is called. */
+    close?: close;
+};
+export type Result<close extends boolean | undefined = undefined> = close extends true ? undefined : {
+    cast: {
+        /** Cast of the created cast */
+        hash: string;
+        /** Text of the created cast */
+        text?: string;
+        /** Embeds of the created cast */
+        embeds?: [] | [string] | [string, string];
+        /** Parent of the created cast */
+        parent?: {
+            type: 'cast';
+            hash: string;
+        };
+    };
+};

package/dist/actions/ComposeCast.js

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

package/dist/actions/index.d.ts

@@ -1,4 +1,5 @@
 export * as AddFrame from './AddFrame';
+export * as ComposeCast from './ComposeCast';
 export * as Ready from './Ready';
 export * as SignIn from './SignIn';
 export * as Swap from './Swap';

package/dist/actions/index.js

@@ -33,8 +33,9 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ViewToken = exports.ViewProfile = exports.Swap = exports.SignIn = exports.Ready = exports.AddFrame = void 0;
+exports.ViewToken = exports.ViewProfile = exports.Swap = exports.SignIn = exports.Ready = exports.ComposeCast = exports.AddFrame = void 0;
 exports.AddFrame = __importStar(require("./AddFrame"));
+exports.ComposeCast = __importStar(require("./ComposeCast"));
 exports.Ready = __importStar(require("./Ready"));
 exports.SignIn = __importStar(require("./SignIn"));
 exports.Swap = __importStar(require("./Swap"));

package/dist/errors.d.ts

@@ -1,3 +1,6 @@
+export type GlobalErrorType<name extends string = 'Error'> = Error & {
+    name: name;
+};
 export declare class BaseError<cause extends Error | undefined = undefined> extends Error {
     name: string;
     cause: cause;

package/dist/index.d.ts

@@ -1,5 +1,7 @@
 export * from './actions';
 export * from './wallet';
+export * as Errors from './errors';
 export * as Context from './context';
+export * as Manifest from './manifest';
 export * from './types';
 export * from './schemas';

package/dist/index.js

@@ -36,9 +36,11 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Context = void 0;
+exports.Manifest = exports.Context = exports.Errors = void 0;
 __exportStar(require("./actions"), exports);
 __exportStar(require("./wallet"), exports);
+exports.Errors = __importStar(require("./errors"));
 exports.Context = __importStar(require("./context"));
+exports.Manifest = __importStar(require("./manifest"));
 __exportStar(require("./types"), exports);
 __exportStar(require("./schemas"), exports);

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

@@ -2,19 +2,19 @@ import { z } from 'zod';
 export declare const actionLaunchFrameSchema: z.ZodObject<{
     type: z.ZodLiteral<"launch_frame">;
     name: z.ZodString;
-    url: 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;
+    url?: string | undefined;
     splashImageUrl?: string | undefined;
     splashBackgroundColor?: string | undefined;
 }, {
     type: "launch_frame";
     name: string;
-    url: string;
+    url?: string | undefined;
     splashImageUrl?: string | undefined;
     splashBackgroundColor?: string | undefined;
 }>;
@@ -31,19 +31,19 @@ export declare const actionViewTokenSchema: z.ZodObject<{
 export declare const actionSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
     type: z.ZodLiteral<"launch_frame">;
     name: z.ZodString;
-    url: 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;
+    url?: string | undefined;
     splashImageUrl?: string | undefined;
     splashBackgroundColor?: string | undefined;
 }, {
     type: "launch_frame";
     name: string;
-    url: string;
+    url?: string | undefined;
     splashImageUrl?: string | undefined;
     splashBackgroundColor?: string | undefined;
 }>, z.ZodObject<{
@@ -61,19 +61,19 @@ export declare const buttonSchema: z.ZodObject<{
     action: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
         type: z.ZodLiteral<"launch_frame">;
         name: z.ZodString;
-        url: 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;
+        url?: string | undefined;
         splashImageUrl?: string | undefined;
         splashBackgroundColor?: string | undefined;
     }, {
         type: "launch_frame";
         name: string;
-        url: string;
+        url?: string | undefined;
         splashImageUrl?: string | undefined;
         splashBackgroundColor?: string | undefined;
     }>, z.ZodObject<{
@@ -91,7 +91,7 @@ export declare const buttonSchema: z.ZodObject<{
     action: {
         type: "launch_frame";
         name: string;
-        url: string;
+        url?: string | undefined;
         splashImageUrl?: string | undefined;
         splashBackgroundColor?: string | undefined;
     } | {
@@ -103,7 +103,7 @@ export declare const buttonSchema: z.ZodObject<{
     action: {
         type: "launch_frame";
         name: string;
-        url: string;
+        url?: string | undefined;
         splashImageUrl?: string | undefined;
         splashBackgroundColor?: string | undefined;
     } | {
@@ -120,19 +120,19 @@ export declare const frameEmbedNextSchema: z.ZodObject<{
         action: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
             type: z.ZodLiteral<"launch_frame">;
             name: z.ZodString;
-            url: 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;
+            url?: string | undefined;
             splashImageUrl?: string | undefined;
             splashBackgroundColor?: string | undefined;
         }, {
             type: "launch_frame";
             name: string;
-            url: string;
+            url?: string | undefined;
             splashImageUrl?: string | undefined;
             splashBackgroundColor?: string | undefined;
         }>, z.ZodObject<{
@@ -150,7 +150,7 @@ export declare const frameEmbedNextSchema: z.ZodObject<{
         action: {
             type: "launch_frame";
             name: string;
-            url: string;
+            url?: string | undefined;
             splashImageUrl?: string | undefined;
             splashBackgroundColor?: string | undefined;
         } | {
@@ -162,7 +162,7 @@ export declare const frameEmbedNextSchema: z.ZodObject<{
         action: {
             type: "launch_frame";
             name: string;
-            url: string;
+            url?: string | undefined;
             splashImageUrl?: string | undefined;
             splashBackgroundColor?: string | undefined;
         } | {
@@ -178,7 +178,7 @@ export declare const frameEmbedNextSchema: z.ZodObject<{
         action: {
             type: "launch_frame";
             name: string;
-            url: string;
+            url?: string | undefined;
             splashImageUrl?: string | undefined;
             splashBackgroundColor?: string | undefined;
         } | {
@@ -195,7 +195,7 @@ export declare const frameEmbedNextSchema: z.ZodObject<{
         action: {
             type: "launch_frame";
             name: string;
-            url: string;
+            url?: string | undefined;
             splashImageUrl?: string | undefined;
             splashBackgroundColor?: string | undefined;
         } | {
@@ -213,7 +213,7 @@ export declare const safeParseFrameEmbed: (rawResponse: unknown) => z.SafeParseR
         action: {
             type: "launch_frame";
             name: string;
-            url: string;
+            url?: string | undefined;
             splashImageUrl?: string | undefined;
             splashBackgroundColor?: string | undefined;
         } | {
@@ -230,7 +230,7 @@ export declare const safeParseFrameEmbed: (rawResponse: unknown) => z.SafeParseR
         action: {
             type: "launch_frame";
             name: string;
-            url: string;
+            url?: string | undefined;
             splashImageUrl?: string | undefined;
             splashBackgroundColor?: string | undefined;
         } | {

package/dist/schemas/embeds.js

@@ -6,7 +6,7 @@ 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,
+    url: shared_1.secureUrlSchema.optional(),
     splashImageUrl: shared_1.secureUrlSchema.optional(),
     splashBackgroundColor: shared_1.hexColorSchema.optional(),
 });

package/dist/schemas/manifest.d.ts

@@ -4,14 +4,27 @@ export declare const domainFrameConfigSchema: z.ZodObject<{
     name: z.ZodString;
     iconUrl: z.ZodString;
     homeUrl: z.ZodString;
+    /** deprecated, set ogImageUrl instead */
     imageUrl: z.ZodOptional<z.ZodString>;
+    /** deprecated, will rely on fc:frame meta tag */
     buttonTitle: z.ZodOptional<z.ZodString>;
     splashImageUrl: z.ZodOptional<z.ZodString>;
     splashBackgroundColor: z.ZodOptional<z.ZodString>;
     webhookUrl: z.ZodOptional<z.ZodString>;
+    /** see: https://github.com/farcasterxyz/miniapps/discussions/191 */
+    subtitle: z.ZodOptional<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>, string, string>>;
+    description: z.ZodOptional<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>, string, string>>;
+    screenshotUrls: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+    primaryCategory: z.ZodOptional<z.ZodEnum<["games", "social", "finance", "utility", "productivity", "health-fitness", "news-media", "music", "shopping", "education", "developer-tools", "entertainment", "art-creativity"]>>;
+    tags: z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>, string, string>, "many">>;
+    heroImageUrl: z.ZodOptional<z.ZodString>;
+    tagline: z.ZodOptional<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>, string, string>>;
+    ogTitle: z.ZodOptional<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>, string, string>>;
+    ogDescription: z.ZodOptional<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>, string, string>>;
+    ogImageUrl: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     name: string;
-    version: "next" | "0.0.0" | "0.0.1" | "1";
+    version: "next" | "1" | "0.0.0" | "0.0.1";
     iconUrl: string;
     homeUrl: string;
     splashImageUrl?: string | undefined;
@@ -19,9 +32,19 @@ export declare const domainFrameConfigSchema: z.ZodObject<{
     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;
 }, {
     name: string;
-    version: "next" | "0.0.0" | "0.0.1" | "1";
+    version: "next" | "1" | "0.0.0" | "0.0.1";
     iconUrl: string;
     homeUrl: string;
     splashImageUrl?: string | undefined;
@@ -29,6 +52,16 @@ export declare const domainFrameConfigSchema: z.ZodObject<{
     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;
 }>;
 export declare const domainManifestSchema: z.ZodObject<{
     accountAssociation: z.ZodObject<{
@@ -49,14 +82,27 @@ export declare const domainManifestSchema: z.ZodObject<{
         name: z.ZodString;
         iconUrl: z.ZodString;
         homeUrl: z.ZodString;
+        /** deprecated, set ogImageUrl instead */
         imageUrl: z.ZodOptional<z.ZodString>;
+        /** deprecated, will rely on fc:frame meta tag */
         buttonTitle: z.ZodOptional<z.ZodString>;
         splashImageUrl: z.ZodOptional<z.ZodString>;
         splashBackgroundColor: z.ZodOptional<z.ZodString>;
         webhookUrl: z.ZodOptional<z.ZodString>;
+        /** see: https://github.com/farcasterxyz/miniapps/discussions/191 */
+        subtitle: z.ZodOptional<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>, string, string>>;
+        description: z.ZodOptional<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>, string, string>>;
+        screenshotUrls: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
+        primaryCategory: z.ZodOptional<z.ZodEnum<["games", "social", "finance", "utility", "productivity", "health-fitness", "news-media", "music", "shopping", "education", "developer-tools", "entertainment", "art-creativity"]>>;
+        tags: z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>, string, string>, "many">>;
+        heroImageUrl: z.ZodOptional<z.ZodString>;
+        tagline: z.ZodOptional<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>, string, string>>;
+        ogTitle: z.ZodOptional<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>, string, string>>;
+        ogDescription: z.ZodOptional<z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>, string, string>>;
+        ogImageUrl: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
         name: string;
-        version: "next" | "0.0.0" | "0.0.1" | "1";
+        version: "next" | "1" | "0.0.0" | "0.0.1";
         iconUrl: string;
         homeUrl: string;
         splashImageUrl?: string | undefined;
@@ -64,9 +110,19 @@ export declare const domainManifestSchema: z.ZodObject<{
         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;
     }, {
         name: string;
-        version: "next" | "0.0.0" | "0.0.1" | "1";
+        version: "next" | "1" | "0.0.0" | "0.0.1";
         iconUrl: string;
         homeUrl: string;
         splashImageUrl?: string | undefined;
@@ -74,6 +130,16 @@ export declare const domainManifestSchema: z.ZodObject<{
         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;
     }>>;
 }, "strip", z.ZodTypeAny, {
     accountAssociation: {
@@ -83,7 +149,7 @@ export declare const domainManifestSchema: z.ZodObject<{
     };
     frame?: {
         name: string;
-        version: "next" | "0.0.0" | "0.0.1" | "1";
+        version: "next" | "1" | "0.0.0" | "0.0.1";
         iconUrl: string;
         homeUrl: string;
         splashImageUrl?: string | undefined;
@@ -91,6 +157,16 @@ export declare const domainManifestSchema: z.ZodObject<{
         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;
     } | undefined;
 }, {
     accountAssociation: {
@@ -100,7 +176,7 @@ export declare const domainManifestSchema: z.ZodObject<{
     };
     frame?: {
         name: string;
-        version: "next" | "0.0.0" | "0.0.1" | "1";
+        version: "next" | "1" | "0.0.0" | "0.0.1";
         iconUrl: string;
         homeUrl: string;
         splashImageUrl?: string | undefined;
@@ -108,5 +184,15 @@ export declare const domainManifestSchema: z.ZodObject<{
         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;
     } | undefined;
 }>;

package/dist/schemas/manifest.js

@@ -3,6 +3,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.domainManifestSchema = exports.domainFrameConfigSchema = void 0;
 const zod_1 = require("zod");
 const shared_1 = require("./shared");
+const primaryCategorySchema = zod_1.z.enum([
+    'games',
+    'social',
+    'finance',
+    'utility',
+    'productivity',
+    'health-fitness',
+    'news-media',
+    'music',
+    'shopping',
+    'education',
+    'developer-tools',
+    'entertainment',
+    'art-creativity',
+]);
 exports.domainFrameConfigSchema = zod_1.z.object({
     // 0.0.0 and 0.0.1 are not technically part of the spec but kept for
     // backwards compatibilty. next should always resolve to the most recent
@@ -16,11 +31,27 @@ exports.domainFrameConfigSchema = zod_1.z.object({
     name: shared_1.frameNameSchema,
     iconUrl: shared_1.secureUrlSchema,
     homeUrl: shared_1.secureUrlSchema,
+    /** deprecated, set ogImageUrl instead */
     imageUrl: shared_1.secureUrlSchema.optional(),
+    /** deprecated, will rely on fc:frame meta tag */
     buttonTitle: shared_1.buttonTitleSchema.optional(),
     splashImageUrl: shared_1.secureUrlSchema.optional(),
     splashBackgroundColor: shared_1.hexColorSchema.optional(),
     webhookUrl: shared_1.secureUrlSchema.optional(),
+    /** see: https://github.com/farcasterxyz/miniapps/discussions/191 */
+    subtitle: (0, shared_1.createSimpleStringSchema)({ max: 30 }).optional(),
+    description: (0, shared_1.createSimpleStringSchema)({ max: 170 }).optional(),
+    screenshotUrls: zod_1.z.array(shared_1.secureUrlSchema).max(3).optional(),
+    primaryCategory: primaryCategorySchema.optional(),
+    tags: zod_1.z
+        .array((0, shared_1.createSimpleStringSchema)({ max: 20, noSpaces: true }))
+        .max(5)
+        .optional(),
+    heroImageUrl: shared_1.secureUrlSchema.optional(),
+    tagline: (0, shared_1.createSimpleStringSchema)({ max: 30 }).optional(),
+    ogTitle: (0, shared_1.createSimpleStringSchema)({ max: 30 }).optional(),
+    ogDescription: (0, shared_1.createSimpleStringSchema)({ max: 100 }).optional(),
+    ogImageUrl: shared_1.secureUrlSchema.optional(),
 });
 exports.domainManifestSchema = zod_1.z.object({
     accountAssociation: shared_1.encodedJsonFarcasterSignatureSchema,

package/dist/schemas/shared.d.ts

@@ -1,4 +1,8 @@
 import { z } from 'zod';
+export declare const createSimpleStringSchema: ({ max, noSpaces, }?: {
+    max?: number;
+    noSpaces?: boolean;
+}) => z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodString, string, string>, string, string>, string, string>;
 export declare const secureUrlSchema: z.ZodString;
 export declare const frameNameSchema: z.ZodString;
 export declare const buttonTitleSchema: z.ZodString;

package/dist/schemas/shared.js

@@ -1,12 +1,39 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.jsonFarcasterSignatureHeaderSchema = exports.encodedJsonFarcasterSignatureSchema = exports.aspectRatioSchema = exports.hexColorSchema = exports.caip19TokenSchema = exports.buttonTitleSchema = exports.frameNameSchema = exports.secureUrlSchema = void 0;
+exports.jsonFarcasterSignatureHeaderSchema = exports.encodedJsonFarcasterSignatureSchema = exports.aspectRatioSchema = exports.hexColorSchema = exports.caip19TokenSchema = exports.buttonTitleSchema = exports.frameNameSchema = exports.secureUrlSchema = exports.createSimpleStringSchema = void 0;
 const zod_1 = require("zod");
+const SPECIAL_CHARS_PATTERN = /[@#$%^&*+=\/\\|~«»]/;
+const REPEATED_PUNCTUATION_PATTERN = /(!{2,}|\?{2,}|-{2,})/;
+// Unicode ranges for emoji detection:
+// \u{1F300}-\u{1F9FF} - Miscellaneous Symbols, Pictographs, Emoticons, Transport, Map, and Supplemental
+// \u{2702}-\u{27B0} - Dingbats
+// \u{2600}-\u{26FF} - Miscellaneous Symbols
+// \u{2B00}-\u{2BFF} - Miscellaneous Symbols and Arrows
+const EMOJI_PATTERN = /[\u{1F300}-\u{1F9FF}]|[\u{2702}-\u{27B0}]|[\u{2600}-\u{26FF}]|[\u{2B00}-\u{2BFF}]/u;
+const createSimpleStringSchema = ({ max, noSpaces, } = {}) => {
+    const stringValidations = noSpaces
+        ? zod_1.z
+            .string()
+            .max(max ?? Number.POSITIVE_INFINITY)
+            .regex(/^\S*$/, 'Spaces are not allowed')
+        : zod_1.z.string().max(max ?? Number.POSITIVE_INFINITY);
+    return stringValidations
+        .refine((value) => !EMOJI_PATTERN.test(value), {
+        message: 'Emojis and symbols are not allowed',
+    })
+        .refine((value) => !SPECIAL_CHARS_PATTERN.test(value), {
+        message: 'Special characters (@, #, $, %, ^, &, *, +, =, /, \\, |, ~, «, ») are not allowed',
+    })
+        .refine((value) => !REPEATED_PUNCTUATION_PATTERN.test(value), {
+        message: 'Repeated punctuations (!!, ??, --) are not allowed',
+    });
+};
+exports.createSimpleStringSchema = createSimpleStringSchema;
 exports.secureUrlSchema = zod_1.z
     .string()
     .url()
     .startsWith('https://', { message: 'Must be an https url' })
-    .max(512);
+    .max(1024);
 exports.frameNameSchema = zod_1.z.string().max(32);
 exports.buttonTitleSchema = zod_1.z.string().max(32);
 const CAIP_19_REGEX = /^[-a-z0-9]{3,8}:[-_a-zA-Z0-9]{1,32}\/(?:[-a-z0-9]{3,8}:[-.%a-zA-Z0-9]{1,128}(?:\/[-.%a-zA-Z0-9]{1,78})?|native)$/;