@farcaster/frame-core 0.1.4 → 0.1.6

package/src/schemas/manifest.ts

@@ -44,49 +44,69 @@ const chainList: [string, ...string[]] = [
   'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp', // Solana
 ]
 
-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.
-  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(),
-  /** see: https://github.com/farcasterxyz/miniapps/discussions/204 */
-  noindex: z.boolean().optional(),
-  /** see https://github.com/farcasterxyz/miniapps/discussions/256 */
-  requiredChains: z.array(z.enum(chainList)).max(chainList.length).optional(),
-  requiredCapabilities: z
-    .array(z.enum(miniAppHostCapabilityList))
-    .max(miniAppHostCapabilityList.length)
-    .optional(),
-})
+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.
+    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(),
+    /** see: https://github.com/farcasterxyz/miniapps/discussions/204 */
+    noindex: z.boolean().optional(),
+    /** see https://github.com/farcasterxyz/miniapps/discussions/256 */
+    requiredChains: z.array(z.enum(chainList)).max(chainList.length).optional(),
+    requiredCapabilities: z
+      .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,

package/src/types.ts

@@ -14,6 +14,7 @@ import type {
   ViewProfile,
   ViewToken,
 } from './actions/index.ts'
+import type { UpdateBackState } from './back.ts'
 import type { FrameContext } from './context.ts'
 import type {
   EventFrameAdded,
@@ -60,6 +61,7 @@ export const miniAppHostCapabilityList: [string, ...string[]] = [
   'haptics.impactOccurred',
   'haptics.notificationOccurred',
   'haptics.selectionChanged',
+  'back',
 ]
 
 export type MiniAppHostCapability =
@@ -80,6 +82,7 @@ export type MiniAppHostCapability =
   | 'haptics.impactOccurred'
   | 'haptics.notificationOccurred'
   | 'haptics.selectionChanged'
+  | 'back'
 
 export type GetCapabilities = () => Promise<MiniAppHostCapability[]>
 
@@ -111,6 +114,7 @@ export type WireFrameHost = {
   selectionChanged: SelectionChanged
   getCapabilities: GetCapabilities
   getChains: GetChains
+  updateBackState: UpdateBackState
 }
 
 export type FrameHost = {
@@ -142,6 +146,7 @@ export type FrameHost = {
   selectionChanged: SelectionChanged
   getCapabilities: GetCapabilities
   getChains: GetChains
+  updateBackState: UpdateBackState
 }
 
 export type EventFrameAddRejected = {
@@ -153,6 +158,10 @@ export type EventPrimaryButtonClicked = {
   event: 'primary_button_clicked'
 }
 
+export type EventBackNavigationTriggered = {
+  event: 'back_navigation_triggered'
+}
+
 export type FrameClientEvent =
   | EventFrameAdded
   | EventFrameAddRejected
@@ -160,4 +169,5 @@ export type FrameClientEvent =
   | EventNotificationsEnabled
   | EventNotificationsDisabled
   | EventPrimaryButtonClicked
+  | EventBackNavigationTriggered
   | Ethereum.EventEip6963AnnounceProvider