@farcaster/frame-core 0.0.0-canary-20250430150627

package/esm/actions/AddFrame.js

@@ -0,0 +1,19 @@
+import * as Errors from '../errors';
+/**
+ * Thrown when the frame does not have a valid domain manifest.
+ */
+export class InvalidDomainManifest extends Errors.BaseError {
+    name = 'AddFrame.InvalidDomainManifest';
+    constructor() {
+        super('Invalid domain manifest');
+    }
+}
+/**
+ * Thrown when add frame action was rejected by the user.
+ */
+export class RejectedByUser extends Errors.BaseError {
+    name = 'AddFrame.RejectedByUser';
+    constructor() {
+        super('Add frame rejected by user');
+    }
+}

package/esm/actions/ComposeCast.d.ts

@@ -0,0 +1,32 @@
+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/esm/actions/ComposeCast.js

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

package/esm/actions/Ready.d.ts

@@ -0,0 +1,13 @@
+export type ReadyOptions = {
+    /**
+     * Disable native gestures. Use this option if your frame uses gestures
+     * that conflict with native gestures.
+     *
+     * @defaultValue false
+     */
+    disableNativeGestures: boolean;
+};
+export declare const DEFAULT_READY_OPTIONS: {
+    disableNativeGestures: false;
+};
+export type Ready = (options?: Partial<ReadyOptions>) => void;

package/esm/actions/Ready.js

@@ -0,0 +1,3 @@
+export const DEFAULT_READY_OPTIONS = {
+    disableNativeGestures: false,
+};

package/esm/actions/SendToken.d.ts

@@ -0,0 +1,48 @@
+export type SendTokenOptions = {
+    /**
+     * CAIP-19 asset ID
+     * For example, Base USDC:
+     * eip155:8453/erc20:0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913
+     */
+    token?: string;
+    /**
+     * Token amount, as numeric string.
+     * For example, 10 USDC: 1000000
+     */
+    amount?: string;
+    /**
+     * Recipient address.
+     */
+    recipientAddress?: string;
+    /**
+     * Recipient fid.
+     */
+    recipientFid?: number;
+};
+type SendTokenDetails = {
+    /**
+     * Tx identifier.
+     */
+    transaction: `0x${string}`;
+};
+type SendTokenErrorDetails = {
+    /**
+     * Error code.
+     */
+    error: string;
+    /**
+     * Error message.
+     */
+    message?: string;
+};
+export type SendTokenErrorReason = 'rejected_by_user' | 'send_failed';
+export type SendTokenResult = {
+    success: true;
+    send: SendTokenDetails;
+} | {
+    success: false;
+    reason: SendTokenErrorReason;
+    error?: SendTokenErrorDetails;
+};
+export type SendToken = (options: SendTokenOptions) => Promise<SendTokenResult>;
+export {};

package/esm/actions/SendToken.js

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

package/esm/actions/SignIn.d.ts

@@ -0,0 +1,41 @@
+import * as Errors from '../errors';
+import type { OneOf } from '../internal/types';
+export type SignInOptions = {
+    /**
+     * A random string used to prevent replay attacks.
+     */
+    nonce: string;
+    /**
+     * Start time at which the signature becomes valid.
+     * ISO 8601 datetime.
+     */
+    notBefore?: string;
+    /**
+     * Expiration time at which the signature is no longer valid.
+     * ISO 8601 datetime.
+     */
+    expirationTime?: string;
+};
+export type SignInResult = {
+    signature: string;
+    message: string;
+};
+export type SignIn = (options: SignInOptions) => Promise<SignInResult>;
+type RejectedByUserJsonError = {
+    type: 'rejected_by_user';
+};
+export type SignInJsonError = RejectedByUserJsonError;
+export type SignInJsonResult = OneOf<{
+    result: SignInResult;
+} | {
+    error: SignInJsonError;
+}>;
+export type WireSignIn = (options: SignInOptions) => Promise<SignInJsonResult>;
+/**
+ * Thrown when a sign in action was rejected.
+ */
+export declare class RejectedByUser extends Errors.BaseError {
+    readonly name = "SignIn.RejectedByUser";
+    constructor();
+}
+export {};

package/esm/actions/SignIn.js

@@ -0,0 +1,10 @@
+import * as Errors from '../errors';
+/**
+ * Thrown when a sign in action was rejected.
+ */
+export class RejectedByUser extends Errors.BaseError {
+    name = 'SignIn.RejectedByUser';
+    constructor() {
+        super('Sign in rejected by user');
+    }
+}

package/esm/actions/SwapToken.d.ts

@@ -0,0 +1,46 @@
+export type SwapTokenOptions = {
+    /**
+     * CAIP-19 asset ID
+     * For example, Base USDC:
+     * eip155:8453/erc20:0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913
+     */
+    sellToken?: string;
+    /**
+     * CAIP-19 token ID. For example, OP ETH:
+     * eip155:10/native
+     */
+    buyToken?: string;
+    /**
+     * Sell token amount, as numeric string.
+     * For example, 10 USDC: 1000000
+     */
+    sellAmount?: string;
+};
+type SwapTokenDetails = {
+    /**
+     * Array of tx identifiers in order of execution.
+     * Some swaps will have both an approval and swap tx.
+     */
+    transactions: `0x${string}`[];
+};
+type SwapTokenErrorDetails = {
+    /**
+     * Error code.
+     */
+    error: string;
+    /**
+     * Error message.
+     */
+    message?: string;
+};
+export type SwapErrorReason = 'rejected_by_user' | 'swap_failed';
+export type SwapTokenResult = {
+    success: true;
+    swap: SwapTokenDetails;
+} | {
+    success: false;
+    reason: SwapErrorReason;
+    error?: SwapTokenErrorDetails;
+};
+export type SwapToken = (options: SwapTokenOptions) => Promise<SwapTokenResult>;
+export {};

package/esm/actions/SwapToken.js

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

package/esm/actions/ViewProfile.d.ts

@@ -0,0 +1,4 @@
+export type ViewProfileOptions = {
+    fid: number;
+};
+export type ViewProfile = (options: ViewProfileOptions) => Promise<void>;

package/esm/actions/ViewProfile.js

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

package/esm/actions/ViewToken.d.ts

@@ -0,0 +1,4 @@
+export type ViewTokenOptions = {
+    token: string;
+};
+export type ViewToken = (options: ViewTokenOptions) => Promise<void>;

package/esm/actions/ViewToken.js

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

package/esm/actions/index.d.ts

@@ -0,0 +1,8 @@
+export * as AddFrame from './AddFrame';
+export * as ComposeCast from './ComposeCast';
+export * as Ready from './Ready';
+export * as SignIn from './SignIn';
+export * as SendToken from './SendToken';
+export * as SwapToken from './SwapToken';
+export * as ViewProfile from './ViewProfile';
+export * as ViewToken from './ViewToken';

package/esm/actions/index.js

@@ -0,0 +1,8 @@
+export * as AddFrame from './AddFrame';
+export * as ComposeCast from './ComposeCast';
+export * as Ready from './Ready';
+export * as SignIn from './SignIn';
+export * as SendToken from './SendToken';
+export * as SwapToken from './SwapToken';
+export * as ViewProfile from './ViewProfile';
+export * as ViewToken from './ViewToken';

package/esm/context.d.ts

@@ -0,0 +1,72 @@
+import type { FrameNotificationDetails } from './schemas';
+export type CastEmbedLocationContext = {
+    type: 'cast_embed';
+    embed: string;
+    cast: {
+        fid: number;
+        hash: string;
+    };
+};
+export type NotificationLocationContext = {
+    type: 'notification';
+    notification: {
+        notificationId: string;
+        title: string;
+        body: string;
+    };
+};
+export type LauncherLocationContext = {
+    type: 'launcher';
+};
+export type ChannelLocationContext = {
+    type: 'channel';
+    channel: {
+        /**
+         * Channel key identifier
+         */
+        key: string;
+        /**
+         * Channel name
+         */
+        name: string;
+        /**
+         * Channel profile image URL
+         */
+        imageUrl?: string;
+    };
+};
+export type LocationContext = CastEmbedLocationContext | NotificationLocationContext | LauncherLocationContext | ChannelLocationContext;
+export type AccountLocation = {
+    placeId: string;
+    /**
+     * Human-readable string describing the location
+     */
+    description: string;
+};
+export type UserContext = {
+    fid: number;
+    username?: string;
+    displayName?: string;
+    /**
+     * Profile image URL
+     */
+    pfpUrl?: string;
+    location?: AccountLocation;
+};
+export type SafeAreaInsets = {
+    top: number;
+    bottom: number;
+    left: number;
+    right: number;
+};
+export type ClientContext = {
+    clientFid: number;
+    added: boolean;
+    notificationDetails?: FrameNotificationDetails;
+    safeAreaInsets?: SafeAreaInsets;
+};
+export type FrameContext = {
+    client: ClientContext;
+    user: UserContext;
+    location?: LocationContext;
+};

package/esm/context.js

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

package/esm/errors.d.ts

@@ -0,0 +1,13 @@
+export type GlobalErrorType<name extends string = 'Error'> = Error & {
+    name: name;
+};
+export declare class BaseError<cause extends Error | undefined = undefined> extends Error {
+    name: string;
+    cause: cause;
+    constructor(message: string, options?: BaseError.Options<cause>);
+}
+export declare namespace BaseError {
+    type Options<cause extends Error | undefined = Error | undefined> = {
+        cause?: cause | undefined;
+    };
+}

package/esm/errors.js

@@ -0,0 +1,8 @@
+export class BaseError extends Error {
+    name = 'BaseError';
+    cause;
+    constructor(message, options = {}) {
+        super(message, options.cause ? { cause: options.cause } : undefined);
+        this.cause = options.cause;
+    }
+}

package/esm/index.d.ts

@@ -0,0 +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/esm/index.js

@@ -0,0 +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/esm/internal/types.d.ts

@@ -0,0 +1,8 @@
+type Compute<type> = {
+    [key in keyof type]: type[key];
+} & unknown;
+type KeyofUnion<type> = type extends type ? keyof type : never;
+export type OneOf<union extends object, fallback extends object | undefined = undefined, keys extends KeyofUnion<union> = KeyofUnion<union>> = union extends infer item ? Compute<item & {
+    [key in Exclude<keys, keyof item>]?: fallback extends object ? key extends keyof fallback ? fallback[key] : undefined : undefined;
+}> : never;
+export {};

package/esm/internal/types.js

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

package/esm/manifest.d.ts

@@ -0,0 +1,101 @@
+/**
+ * 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/esm/manifest.js

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