@farcaster/frame-core 0.1.8 → 0.2.0

package/src/schemas/manifest.ts

@@ -3,6 +3,7 @@ import { miniAppHostCapabilityList } from '../types.ts'
 import {
   buttonTitleSchema,
   createSimpleStringSchema,
+  domainSchema,
   encodedJsonFarcasterSignatureSchema,
   frameNameSchema,
   hexColorSchema,
@@ -25,7 +26,7 @@ const primaryCategorySchema = z.enum([
   'art-creativity',
 ])
 
-const chainList: [string, ...string[]] = [
+const chainList = [
   'eip155:1', // Ethereum mainnet
   'eip155:8453', // Base mainnet
   'eip155:42161', // Arbitrum One
@@ -42,7 +43,12 @@ const chainList: [string, ...string[]] = [
   'eip155:10143', // Monad testnet
   'eip155:42220', // Celo
   'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp', // Solana
-]
+] as const
+
+function removeArrayDuplicates<T>(arr: T[]) {
+  const set = new Set(arr)
+  return Array.from(set)
+}
 
 export const domainFrameConfigSchema = z
   .object({
@@ -82,14 +88,19 @@ export const domainFrameConfigSchema = z
     /** 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(),
+    requiredChains: z
+      .array(z.enum(chainList))
+      .transform(removeArrayDuplicates)
+      .optional(),
     requiredCapabilities: z
       .array(z.enum(miniAppHostCapabilityList))
-      .max(miniAppHostCapabilityList.length)
+      .transform(removeArrayDuplicates)
       .optional(),
     /** see https://github.com/farcasterxyz/miniapps/discussions/158 */
     /** Documentation will be added once this feature is finalized. */
     castShareUrl: secureUrlSchema.optional(),
+    /** Canonical domain for the frame application */
+    canonicalDomain: domainSchema.optional(),
   })
   .refine(
     (data) => {

package/src/schemas/shared.ts

@@ -58,6 +58,34 @@ export const hexColorSchema = z
       'Invalid hex color code. It should be in the format #RRGGBB or #RGB.',
   })
 
+// Domain validation regex:
+// - Each label (part between dots) must start and end with alphanumeric
+// - Labels can contain hyphens in the middle
+// - Cannot have consecutive dots
+// - Must have at least one dot (TLD required)
+// - TLD must be at least 2 characters and only letters
+const DOMAIN_REGEX =
+  /^(?!.*\.\.)([a-zA-Z0-9]([a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z]{2,}$/
+
+export const domainSchema = z
+  .string()
+  .max(1024)
+  .regex(DOMAIN_REGEX, {
+    message: 'Must be a valid domain name (e.g., example.com, sub.example.com)',
+  })
+  .refine((value) => !value.includes('://'), {
+    message: 'Domain must not include protocol (http://, https://, etc.)',
+  })
+  .refine((value) => !value.includes('/'), {
+    message: 'Domain must not include path separators',
+  })
+  .refine((value) => !value.includes('@'), {
+    message: 'Domain must not include @ symbol',
+  })
+  .refine((value) => !value.includes(':'), {
+    message: 'Domain must not include port numbers',
+  })
+
 export const aspectRatioSchema = z.union([z.literal('1:1'), z.literal('3:2')])
 
 export const encodedJsonFarcasterSignatureSchema = z.object({

package/src/types.ts

@@ -43,7 +43,7 @@ export type SetPrimaryButton = (options: SetPrimaryButtonOptions) => void
 // Export haptics types
 export type { ImpactOccurred, NotificationOccurred, SelectionChanged }
 
-export const miniAppHostCapabilityList: [string, ...string[]] = [
+export const miniAppHostCapabilityList = [
   'wallet.getEthereumProvider',
   'wallet.getSolanaProvider',
   'actions.ready',
@@ -62,27 +62,9 @@ export const miniAppHostCapabilityList: [string, ...string[]] = [
   'haptics.notificationOccurred',
   'haptics.selectionChanged',
   'back',
-]
+] as const
 
-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 MiniAppHostCapability = (typeof miniAppHostCapabilityList)[number]
 
 export type GetCapabilities = () => Promise<MiniAppHostCapability[]>