@farcaster/frame-core 0.0.28 → 0.0.31

package/src/actions/index.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/src/errors.ts

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

package/src/index.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/src/manifest.ts

@@ -0,0 +1,113 @@
+/**
+ * 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/src/schemas/shared.ts

@@ -4,7 +4,7 @@ export const secureUrlSchema = z
   .string()
   .url()
   .startsWith('https://', { message: 'Must be an https url' })
-  .max(512)
+  .max(1024)
 
 export const frameNameSchema = z.string().max(32)
 export const buttonTitleSchema = z.string().max(32)

package/src/types.ts

@@ -1,5 +1,6 @@
 import type {
   AddFrame,
+  ComposeCast,
   Ready,
   SignIn,
   Swap,
@@ -44,6 +45,9 @@ export type WireFrameHost = {
   viewProfile: ViewProfile.ViewProfile
   viewToken: ViewToken.ViewToken
   swap: Swap.Swap
+  composeCast: <close extends boolean | undefined = undefined>(
+    options: ComposeCast.Options<close>,
+  ) => Promise<ComposeCast.Result<close>>
 }
 
 export type FrameHost = {
@@ -64,6 +68,9 @@ export type FrameHost = {
   viewProfile: ViewProfile.ViewProfile
   viewToken: ViewToken.ViewToken
   swap: Swap.Swap
+  composeCast: <close extends boolean | undefined = undefined>(
+    options: ComposeCast.Options<close>,
+  ) => Promise<ComposeCast.Result<close>>
 }
 
 export type EventFrameAddRejected = {