@farcaster/frame-core 0.0.29 → 0.0.31

package/esm/types.d.ts

@@ -1,75 +1,58 @@
-import type {
-  AddFrame,
-  Ready,
-  SignIn,
-  Swap,
-  ViewProfile,
-  ViewToken,
-} from './actions'
-import type { FrameContext } from './context'
-import type {
-  EventFrameAdded,
-  EventFrameRemoved,
-  EventNotificationsDisabled,
-  EventNotificationsEnabled,
-} from './schemas'
-import type { Ethereum } from './wallet'
+import type { AddFrame, ComposeCast, Ready, SignIn, Swap, ViewProfile, ViewToken } from './actions';
+import type { FrameContext } from './context';
+import type { EventFrameAdded, EventFrameRemoved, EventNotificationsDisabled, EventNotificationsEnabled } from './schemas';
+import type { Ethereum } from './wallet';
 export type SetPrimaryButtonOptions = {
-  text: string
-  loading?: boolean
-  disabled?: boolean
-  hidden?: boolean
-}
-export * from './wallet/ethereum'
-export { DEFAULT_READY_OPTIONS, ReadyOptions } from './actions/Ready'
-export type SignInOptions = SignIn.SignInOptions
-export type SetPrimaryButton = (options: SetPrimaryButtonOptions) => void
+    text: string;
+    loading?: boolean;
+    disabled?: boolean;
+    hidden?: boolean;
+};
+export * from './wallet/ethereum';
+export { DEFAULT_READY_OPTIONS, ReadyOptions } from './actions/Ready';
+export type SignInOptions = SignIn.SignInOptions;
+export type SetPrimaryButton = (options: SetPrimaryButtonOptions) => void;
 export type WireFrameHost = {
-  context: FrameContext
-  close: () => void
-  ready: Ready.Ready
-  openUrl: (url: string) => void
-  signIn: SignIn.WireSignIn
-  setPrimaryButton: SetPrimaryButton
-  ethProviderRequest: Ethereum.EthProvideRequest
-  ethProviderRequestV2: Ethereum.RpcTransport
-  eip6963RequestProvider: () => void
-  addFrame: AddFrame.WireAddFrame
-  viewProfile: ViewProfile.ViewProfile
-  viewToken: ViewToken.ViewToken
-  swap: Swap.Swap
-}
+    context: FrameContext;
+    close: () => void;
+    ready: Ready.Ready;
+    openUrl: (url: string) => void;
+    signIn: SignIn.WireSignIn;
+    setPrimaryButton: SetPrimaryButton;
+    ethProviderRequest: Ethereum.EthProvideRequest;
+    ethProviderRequestV2: Ethereum.RpcTransport;
+    eip6963RequestProvider: () => void;
+    addFrame: AddFrame.WireAddFrame;
+    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 = {
-  context: FrameContext
-  close: () => void
-  ready: Ready.Ready
-  openUrl: (url: string) => void
-  signIn: SignIn.SignIn
-  setPrimaryButton: SetPrimaryButton
-  ethProviderRequest: Ethereum.EthProvideRequest
-  ethProviderRequestV2: Ethereum.RpcTransport
-  /**
-   * Receive forwarded eip6963:requestProvider events from the frame document.
-   * Hosts must emit an EventEip6963AnnounceProvider in response.
-   */
-  eip6963RequestProvider: () => void
-  addFrame: AddFrame.AddFrame
-  viewProfile: ViewProfile.ViewProfile
-  viewToken: ViewToken.ViewToken
-  swap: Swap.Swap
-}
+    context: FrameContext;
+    close: () => void;
+    ready: Ready.Ready;
+    openUrl: (url: string) => void;
+    signIn: SignIn.SignIn;
+    setPrimaryButton: SetPrimaryButton;
+    ethProviderRequest: Ethereum.EthProvideRequest;
+    ethProviderRequestV2: Ethereum.RpcTransport;
+    /**
+     * Receive forwarded eip6963:requestProvider events from the frame document.
+     * Hosts must emit an EventEip6963AnnounceProvider in response.
+     */
+    eip6963RequestProvider: () => void;
+    addFrame: AddFrame.AddFrame;
+    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 = {
-  event: 'frame_add_rejected'
-  reason: AddFrame.AddFrameRejectedReason
-}
+    event: 'frame_add_rejected';
+    reason: AddFrame.AddFrameRejectedReason;
+};
 export type EventPrimaryButtonClicked = {
-  event: 'primary_button_clicked'
-}
-export type FrameClientEvent =
-  | EventFrameAdded
-  | EventFrameAddRejected
-  | EventFrameRemoved
-  | EventNotificationsEnabled
-  | EventNotificationsDisabled
-  | EventPrimaryButtonClicked
-  | Ethereum.EventEip6963AnnounceProvider
+    event: 'primary_button_clicked';
+};
+export type FrameClientEvent = EventFrameAdded | EventFrameAddRejected | EventFrameRemoved | EventNotificationsEnabled | EventNotificationsDisabled | EventPrimaryButtonClicked | Ethereum.EventEip6963AnnounceProvider;

package/esm/types.js

@@ -1,3 +1,3 @@
 // start backwards compat, remove in 1.0
-export * from './wallet/ethereum'
-export { DEFAULT_READY_OPTIONS } from './actions/Ready'
+export * from './wallet/ethereum';
+export { DEFAULT_READY_OPTIONS } from './actions/Ready';

package/esm/wallet/ethereum.d.ts

@@ -1,58 +1,43 @@
-import type { Address, Provider, RpcRequest, RpcResponse, RpcSchema } from 'ox'
-export type EthProvideRequest<
-  schema extends RpcSchema.Generic = RpcSchema.Default,
-> = Provider.RequestFn<schema>
+import type { Address, Provider, RpcRequest, RpcResponse, RpcSchema } from 'ox';
+export type EthProvideRequest<schema extends RpcSchema.Generic = RpcSchema.Default> = Provider.RequestFn<schema>;
 export type FrameEthProviderEventData = {
-  type: 'frame_eth_provider_event'
-} & EthProviderWireEvent
-export type RpcTransport = (
-  request: RpcRequest.RpcRequest,
-) => Promise<RpcResponse.RpcResponse>
+    type: 'frame_eth_provider_event';
+} & EthProviderWireEvent;
+export type RpcTransport = (request: RpcRequest.RpcRequest) => Promise<RpcResponse.RpcResponse>;
 export type ProviderRpcError = {
-  code: number
-  details?: string
-  message?: string
-}
-export type EthProviderWireEvent =
-  | {
-      event: 'accountsChanged'
-      params: [readonly Address.Address[]]
-    }
-  | {
-      event: 'chainChanged'
-      params: [string]
-    }
-  | {
-      event: 'connect'
-      params: [Provider.ConnectInfo]
-    }
-  | {
-      event: 'disconnect'
-      params: [ProviderRpcError]
-    }
-  | {
-      event: 'message'
-      params: [Provider.Message]
-    }
-export type EmitEthProvider = <event extends EthProviderWireEvent['event']>(
-  event: event,
-  params: Extract<
-    EthProviderWireEvent,
-    {
-      event: event
-    }
-  >['params'],
-) => void
+    code: number;
+    details?: string;
+    message?: string;
+};
+export type EthProviderWireEvent = {
+    event: 'accountsChanged';
+    params: [readonly Address.Address[]];
+} | {
+    event: 'chainChanged';
+    params: [string];
+} | {
+    event: 'connect';
+    params: [Provider.ConnectInfo];
+} | {
+    event: 'disconnect';
+    params: [ProviderRpcError];
+} | {
+    event: 'message';
+    params: [Provider.Message];
+};
+export type EmitEthProvider = <event extends EthProviderWireEvent['event']>(event: event, params: Extract<EthProviderWireEvent, {
+    event: event;
+}>['params']) => void;
 /**
  * Metadata of the EIP-1193 Provider.
  */
 export interface EIP6963ProviderInfo {
-  icon: `data:image/${string}`
-  name: string
-  rdns: string
-  uuid: string
+    icon: `data:image/${string}`;
+    name: string;
+    rdns: string;
+    uuid: string;
 }
 export type EventEip6963AnnounceProvider = {
-  event: 'eip6963:announceProvider'
-  info: EIP6963ProviderInfo
-}
+    event: 'eip6963:announceProvider';
+    info: EIP6963ProviderInfo;
+};

package/esm/wallet/ethereum.js

@@ -1 +1 @@
-export {}
+export {};

package/esm/wallet/index.d.ts

@@ -1 +1 @@
-export * as Ethereum from './ethereum'
+export * as Ethereum from './ethereum';

package/esm/wallet/index.js

@@ -1 +1 @@
-export * as Ethereum from './ethereum'
+export * as Ethereum from './ethereum';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@farcaster/frame-core",
-  "version": "0.0.29",
+  "version": "0.0.31",
   "license": "MIT",
   "repository": {
     "type": "git",

package/src/actions/ComposeCast.ts

@@ -0,0 +1,36 @@
+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/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 = {