@farcaster/frame-core 0.0.29 → 0.0.32

package/esm/schemas/manifest.d.ts

@@ -1,156 +1,198 @@
-import type { z } from 'zod'
-export declare const domainFrameConfigSchema: 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
-    homeUrl: z.ZodString
-    imageUrl: z.ZodOptional<z.ZodString>
-    buttonTitle: z.ZodOptional<z.ZodString>
-    splashImageUrl: z.ZodOptional<z.ZodString>
-    splashBackgroundColor: z.ZodOptional<z.ZodString>
-    webhookUrl: z.ZodOptional<z.ZodString>
-  },
-  'strip',
-  z.ZodTypeAny,
-  {
-    name: string
-    version: 'next' | '0.0.0' | '0.0.1' | '1'
-    iconUrl: string
-    homeUrl: string
-    splashImageUrl?: string | undefined
-    splashBackgroundColor?: string | undefined
-    imageUrl?: string | undefined
-    buttonTitle?: string | undefined
-    webhookUrl?: string | undefined
-  },
-  {
-    name: string
-    version: 'next' | '0.0.0' | '0.0.1' | '1'
-    iconUrl: string
-    homeUrl: string
-    splashImageUrl?: string | undefined
-    splashBackgroundColor?: string | undefined
-    imageUrl?: string | undefined
-    buttonTitle?: string | undefined
-    webhookUrl?: string | undefined
-  }
->
-export declare const domainManifestSchema: z.ZodObject<
-  {
-    accountAssociation: z.ZodObject<
-      {
-        header: z.ZodString
-        payload: z.ZodString
-        signature: z.ZodString
-      },
-      'strip',
-      z.ZodTypeAny,
-      {
-        header: string
-        payload: string
-        signature: string
-      },
-      {
-        header: string
-        payload: string
-        signature: string
-      }
-    >
-    frame: z.ZodOptional<
-      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
-          homeUrl: z.ZodString
-          imageUrl: z.ZodOptional<z.ZodString>
-          buttonTitle: z.ZodOptional<z.ZodString>
-          splashImageUrl: z.ZodOptional<z.ZodString>
-          splashBackgroundColor: z.ZodOptional<z.ZodString>
-          webhookUrl: z.ZodOptional<z.ZodString>
-        },
-        'strip',
-        z.ZodTypeAny,
-        {
-          name: string
-          version: 'next' | '0.0.0' | '0.0.1' | '1'
-          iconUrl: string
-          homeUrl: string
-          splashImageUrl?: string | undefined
-          splashBackgroundColor?: string | undefined
-          imageUrl?: string | undefined
-          buttonTitle?: string | undefined
-          webhookUrl?: string | undefined
-        },
-        {
-          name: string
-          version: 'next' | '0.0.0' | '0.0.1' | '1'
-          iconUrl: string
-          homeUrl: string
-          splashImageUrl?: string | undefined
-          splashBackgroundColor?: string | undefined
-          imageUrl?: string | undefined
-          buttonTitle?: string | undefined
-          webhookUrl?: string | undefined
-        }
-      >
-    >
-  },
-  'strip',
-  z.ZodTypeAny,
-  {
+import { z } from 'zod';
+export declare const domainFrameConfigSchema: 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;
+    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" | "1" | "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;
+}, {
+    name: string;
+    version: "next" | "1" | "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;
+}>;
+export declare const domainManifestSchema: z.ZodObject<{
+    accountAssociation: z.ZodObject<{
+        header: z.ZodString;
+        payload: z.ZodString;
+        signature: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        header: string;
+        payload: string;
+        signature: string;
+    }, {
+        header: string;
+        payload: string;
+        signature: string;
+    }>;
+    frame: z.ZodOptional<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;
+        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" | "1" | "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;
+    }, {
+        name: string;
+        version: "next" | "1" | "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;
+    }>>;
+}, "strip", z.ZodTypeAny, {
     accountAssociation: {
-      header: string
-      payload: string
-      signature: string
-    }
-    frame?:
-      | {
-          name: string
-          version: 'next' | '0.0.0' | '0.0.1' | '1'
-          iconUrl: string
-          homeUrl: string
-          splashImageUrl?: string | undefined
-          splashBackgroundColor?: string | undefined
-          imageUrl?: string | undefined
-          buttonTitle?: string | undefined
-          webhookUrl?: string | undefined
-        }
-      | undefined
-  },
-  {
+        header: string;
+        payload: string;
+        signature: string;
+    };
+    frame?: {
+        name: string;
+        version: "next" | "1" | "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;
+    } | undefined;
+}, {
     accountAssociation: {
-      header: string
-      payload: string
-      signature: string
-    }
-    frame?:
-      | {
-          name: string
-          version: 'next' | '0.0.0' | '0.0.1' | '1'
-          iconUrl: string
-          homeUrl: string
-          splashImageUrl?: string | undefined
-          splashBackgroundColor?: string | undefined
-          imageUrl?: string | undefined
-          buttonTitle?: string | undefined
-          webhookUrl?: string | undefined
-        }
-      | undefined
-  }
->
+        header: string;
+        payload: string;
+        signature: string;
+    };
+    frame?: {
+        name: string;
+        version: "next" | "1" | "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;
+    } | undefined;
+}>;

package/esm/schemas/manifest.js

@@ -1,31 +1,56 @@
-import { z } from 'zod'
-import {
-  buttonTitleSchema,
-  encodedJsonFarcasterSignatureSchema,
-  frameNameSchema,
-  hexColorSchema,
-  secureUrlSchema,
-} from './shared'
+import { z } from 'zod';
+import { buttonTitleSchema, createSimpleStringSchema, encodedJsonFarcasterSignatureSchema, frameNameSchema, hexColorSchema, secureUrlSchema, } from './shared';
+const primaryCategorySchema = z.enum([
+    'games',
+    'social',
+    'finance',
+    'utility',
+    'productivity',
+    'health-fitness',
+    'news-media',
+    'music',
+    'shopping',
+    'education',
+    'developer-tools',
+    'entertainment',
+    'art-creativity',
+]);
 export const domainFrameConfigSchema = 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
-  // schema version.
-  version: z.union([
-    z.literal('0.0.0'),
-    z.literal('0.0.1'),
-    z.literal('1'),
-    z.literal('next'),
-  ]),
-  name: frameNameSchema,
-  iconUrl: secureUrlSchema,
-  homeUrl: secureUrlSchema,
-  imageUrl: secureUrlSchema.optional(),
-  buttonTitle: buttonTitleSchema.optional(),
-  splashImageUrl: secureUrlSchema.optional(),
-  splashBackgroundColor: hexColorSchema.optional(),
-  webhookUrl: secureUrlSchema.optional(),
-})
+    // 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
+    // schema version.
+    version: z.union([
+        z.literal('0.0.0'),
+        z.literal('0.0.1'),
+        z.literal('1'),
+        z.literal('next'),
+    ]),
+    name: frameNameSchema,
+    iconUrl: secureUrlSchema,
+    homeUrl: secureUrlSchema,
+    /** deprecated, set ogImageUrl instead */
+    imageUrl: secureUrlSchema.optional(),
+    /** deprecated, will rely on fc:frame meta tag */
+    buttonTitle: buttonTitleSchema.optional(),
+    splashImageUrl: secureUrlSchema.optional(),
+    splashBackgroundColor: hexColorSchema.optional(),
+    webhookUrl: secureUrlSchema.optional(),
+    /** see: https://github.com/farcasterxyz/miniapps/discussions/191 */
+    subtitle: createSimpleStringSchema({ max: 30 }).optional(),
+    description: createSimpleStringSchema({ max: 170 }).optional(),
+    screenshotUrls: z.array(secureUrlSchema).max(3).optional(),
+    primaryCategory: primaryCategorySchema.optional(),
+    tags: z
+        .array(createSimpleStringSchema({ max: 20, noSpaces: true }))
+        .max(5)
+        .optional(),
+    heroImageUrl: secureUrlSchema.optional(),
+    tagline: createSimpleStringSchema({ max: 30 }).optional(),
+    ogTitle: createSimpleStringSchema({ max: 30 }).optional(),
+    ogDescription: createSimpleStringSchema({ max: 100 }).optional(),
+    ogImageUrl: secureUrlSchema.optional(),
+});
 export const domainManifestSchema = z.object({
-  accountAssociation: encodedJsonFarcasterSignatureSchema,
-  frame: domainFrameConfigSchema.optional(),
-})
+    accountAssociation: encodedJsonFarcasterSignatureSchema,
+    frame: domainFrameConfigSchema.optional(),
+});

package/esm/schemas/notifications.d.ts

@@ -1,88 +1,60 @@
-import type { z } from 'zod'
-export declare const notificationDetailsSchema: z.ZodObject<
-  {
-    url: z.ZodString
-    token: z.ZodString
-  },
-  'strip',
-  z.ZodTypeAny,
-  {
-    url: string
-    token: string
-  },
-  {
-    url: string
-    token: string
-  }
->
-export type FrameNotificationDetails = z.infer<typeof notificationDetailsSchema>
-export declare const sendNotificationRequestSchema: z.ZodObject<
-  {
-    notificationId: z.ZodString
-    title: z.ZodString
-    body: z.ZodString
-    targetUrl: z.ZodString
-    tokens: z.ZodArray<z.ZodString, 'many'>
-  },
-  'strip',
-  z.ZodTypeAny,
-  {
-    title: string
-    notificationId: string
-    body: string
-    targetUrl: string
-    tokens: string[]
-  },
-  {
-    title: string
-    notificationId: string
-    body: string
-    targetUrl: string
-    tokens: string[]
-  }
->
-export type SendNotificationRequest = z.infer<
-  typeof sendNotificationRequestSchema
->
-export declare const sendNotificationResponseSchema: z.ZodObject<
-  {
-    result: z.ZodObject<
-      {
-        successfulTokens: z.ZodArray<z.ZodString, 'many'>
-        invalidTokens: z.ZodArray<z.ZodString, 'many'>
-        rateLimitedTokens: z.ZodArray<z.ZodString, 'many'>
-      },
-      'strip',
-      z.ZodTypeAny,
-      {
-        successfulTokens: string[]
-        invalidTokens: string[]
-        rateLimitedTokens: string[]
-      },
-      {
-        successfulTokens: string[]
-        invalidTokens: string[]
-        rateLimitedTokens: string[]
-      }
-    >
-  },
-  'strip',
-  z.ZodTypeAny,
-  {
+import { z } from 'zod';
+export declare const notificationDetailsSchema: z.ZodObject<{
+    url: z.ZodString;
+    token: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    url: string;
+    token: string;
+}, {
+    url: string;
+    token: string;
+}>;
+export type FrameNotificationDetails = z.infer<typeof notificationDetailsSchema>;
+export declare const sendNotificationRequestSchema: z.ZodObject<{
+    notificationId: z.ZodString;
+    title: z.ZodString;
+    body: z.ZodString;
+    targetUrl: z.ZodString;
+    tokens: z.ZodArray<z.ZodString, "many">;
+}, "strip", z.ZodTypeAny, {
+    title: string;
+    notificationId: string;
+    body: string;
+    targetUrl: string;
+    tokens: string[];
+}, {
+    title: string;
+    notificationId: string;
+    body: string;
+    targetUrl: string;
+    tokens: string[];
+}>;
+export type SendNotificationRequest = z.infer<typeof sendNotificationRequestSchema>;
+export declare const sendNotificationResponseSchema: z.ZodObject<{
+    result: z.ZodObject<{
+        successfulTokens: z.ZodArray<z.ZodString, "many">;
+        invalidTokens: z.ZodArray<z.ZodString, "many">;
+        rateLimitedTokens: z.ZodArray<z.ZodString, "many">;
+    }, "strip", z.ZodTypeAny, {
+        successfulTokens: string[];
+        invalidTokens: string[];
+        rateLimitedTokens: string[];
+    }, {
+        successfulTokens: string[];
+        invalidTokens: string[];
+        rateLimitedTokens: string[];
+    }>;
+}, "strip", z.ZodTypeAny, {
     result: {
-      successfulTokens: string[]
-      invalidTokens: string[]
-      rateLimitedTokens: string[]
-    }
-  },
-  {
+        successfulTokens: string[];
+        invalidTokens: string[];
+        rateLimitedTokens: string[];
+    };
+}, {
     result: {
-      successfulTokens: string[]
-      invalidTokens: string[]
-      rateLimitedTokens: string[]
-    }
-  }
->
-export type SendNotificationResponse = z.infer<
-  typeof sendNotificationResponseSchema
->
+        successfulTokens: string[];
+        invalidTokens: string[];
+        rateLimitedTokens: string[];
+    };
+}>;
+export type SendNotificationResponse = z.infer<typeof sendNotificationResponseSchema>;

package/esm/schemas/notifications.js

@@ -1,20 +1,20 @@
-import { z } from 'zod'
-import { secureUrlSchema } from './shared'
+import { z } from 'zod';
+import { secureUrlSchema } from './shared';
 export const notificationDetailsSchema = z.object({
-  url: z.string(),
-  token: z.string(),
-})
+    url: z.string(),
+    token: z.string(),
+});
 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),
-})
+    notificationId: z.string().max(128),
+    title: z.string().max(32),
+    body: z.string().max(128),
+    targetUrl: secureUrlSchema,
+    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()),
-  }),
-})
+    result: z.object({
+        successfulTokens: z.array(z.string()),
+        invalidTokens: z.array(z.string()),
+        rateLimitedTokens: z.array(z.string()),
+    }),
+});