@farcaster/frame-core 0.1.10 → 0.3.0

package/esm/actions/SwapToken.d.ts

@@ -1,46 +0,0 @@
-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, 1 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

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

package/esm/actions/ViewCast.d.ts

@@ -1,25 +0,0 @@
-export type ViewCastOptions = {
-    /**
-     * The hash of the cast to view.
-     * @example "0x6a112e2d35e2d2008e25dd29811e8769d1edd9ca"
-     */
-    hash: string;
-    /**
-     * Whether the app should be closed when this action is called.
-     * If true, the app will be closed after opening the cast view.
-     */
-    close?: boolean;
-};
-/**
- * Opens a cast view in the Farcaster client.
- *
- * @example
- * ```ts
- * await sdk.actions.viewCast({
- *   hash: "0x6a112e2d35e2d2008e25dd29811e8769d1edd9ca"
- * })
- * ```
- *
- * @see {@link https://miniapps.farcaster.xyz/docs/sdk/actions/view-cast | View Cast Documentation}
- */
-export type ViewCast = (options: ViewCastOptions) => Promise<void>;

package/esm/actions/ViewCast.js

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

package/esm/actions/ViewProfile.d.ts

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

package/esm/actions/ViewProfile.js

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

package/esm/actions/ViewToken.d.ts

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

package/esm/actions/ViewToken.js

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

package/esm/actions/index.d.ts

@@ -1,10 +0,0 @@
-export * as AddMiniApp from './AddMiniApp.ts';
-export * as ComposeCast from './ComposeCast.ts';
-export * as Haptics from './Haptics.ts';
-export * as Ready from './Ready.ts';
-export * as SignIn from './SignIn.ts';
-export * as SendToken from './SendToken.ts';
-export * as SwapToken from './SwapToken.ts';
-export * as ViewCast from './ViewCast.ts';
-export * as ViewProfile from './ViewProfile.ts';
-export * as ViewToken from './ViewToken.ts';

package/esm/actions/index.js

@@ -1,10 +0,0 @@
-export * as AddMiniApp from "./AddMiniApp.js";
-export * as ComposeCast from "./ComposeCast.js";
-export * as Haptics from "./Haptics.js";
-export * as Ready from "./Ready.js";
-export * as SignIn from "./SignIn.js";
-export * as SendToken from "./SendToken.js";
-export * as SwapToken from "./SwapToken.js";
-export * as ViewCast from "./ViewCast.js";
-export * as ViewProfile from "./ViewProfile.js";
-export * as ViewToken from "./ViewToken.js";

package/esm/back.d.ts

@@ -1,13 +0,0 @@
-export type BackState = {
-    /**
-     * Is the back control visible. Note that on mobile devices Farcaster clients
-     * may support a gesture based control rather than button control.
-     *
-     * @default false
-     */
-    visible: boolean;
-};
-export declare const DEFAULT_BACK_STATE: {
-    visible: false;
-};
-export type UpdateBackState = (state: BackState) => Promise<void>;

package/esm/back.js

@@ -1,3 +0,0 @@
-export const DEFAULT_BACK_STATE = {
-    visible: false,
-};

package/esm/context.d.ts

@@ -1,94 +0,0 @@
-import type { FrameNotificationDetails } from './schemas/index.ts';
-export type MiniappUser = {
-    fid: number;
-    username?: string;
-    displayName?: string;
-    pfpUrl?: string;
-};
-export interface MiniappCast {
-    author: MiniappUser;
-    hash: string;
-    parentHash?: string;
-    parentFid?: number;
-    timestamp?: number;
-    mentions?: MiniappUser[];
-    text: string;
-    embeds?: string[];
-    channelKey?: string;
-}
-export type CastEmbedLocationContext = {
-    type: 'cast_embed';
-    embed: string;
-    cast: MiniappCast;
-};
-export type CastShareLocationContext = {
-    type: 'cast_share';
-    cast: MiniappCast;
-};
-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 | CastShareLocationContext | 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 ClientFeatures = {
-    haptics: boolean;
-};
-export type FrameContext = {
-    client: ClientContext;
-    user: UserContext;
-    location?: LocationContext;
-    features?: ClientFeatures;
-};

package/esm/context.js

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

package/esm/errors.d.ts

@@ -1,13 +0,0 @@
-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

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

@@ -1,8 +0,0 @@
-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

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

package/esm/manifest.d.ts

@@ -1,101 +0,0 @@
-/**
- * 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://farcaster.xyz/~/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

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

package/esm/schemas/embeds.d.ts

@@ -1,243 +0,0 @@
-import { z } from 'zod';
-export declare const actionLaunchFrameSchema: z.ZodObject<{
-    type: z.ZodLiteral<"launch_frame">;
-    name: z.ZodString;
-    url: z.ZodOptional<z.ZodString>;
-    splashImageUrl: z.ZodOptional<z.ZodString>;
-    splashBackgroundColor: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    type: "launch_frame";
-    name: string;
-    url?: string | undefined;
-    splashImageUrl?: string | undefined;
-    splashBackgroundColor?: string | undefined;
-}, {
-    type: "launch_frame";
-    name: string;
-    url?: string | undefined;
-    splashImageUrl?: string | undefined;
-    splashBackgroundColor?: string | undefined;
-}>;
-export declare const actionViewTokenSchema: z.ZodObject<{
-    type: z.ZodLiteral<"view_token">;
-    token: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    type: "view_token";
-    token: string;
-}, {
-    type: "view_token";
-    token: string;
-}>;
-export declare const actionSchema: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
-    type: z.ZodLiteral<"launch_frame">;
-    name: z.ZodString;
-    url: z.ZodOptional<z.ZodString>;
-    splashImageUrl: z.ZodOptional<z.ZodString>;
-    splashBackgroundColor: z.ZodOptional<z.ZodString>;
-}, "strip", z.ZodTypeAny, {
-    type: "launch_frame";
-    name: string;
-    url?: string | undefined;
-    splashImageUrl?: string | undefined;
-    splashBackgroundColor?: string | undefined;
-}, {
-    type: "launch_frame";
-    name: string;
-    url?: string | undefined;
-    splashImageUrl?: string | undefined;
-    splashBackgroundColor?: string | undefined;
-}>, z.ZodObject<{
-    type: z.ZodLiteral<"view_token">;
-    token: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    type: "view_token";
-    token: string;
-}, {
-    type: "view_token";
-    token: string;
-}>]>;
-export declare const buttonSchema: z.ZodObject<{
-    title: z.ZodString;
-    action: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
-        type: z.ZodLiteral<"launch_frame">;
-        name: z.ZodString;
-        url: z.ZodOptional<z.ZodString>;
-        splashImageUrl: z.ZodOptional<z.ZodString>;
-        splashBackgroundColor: z.ZodOptional<z.ZodString>;
-    }, "strip", z.ZodTypeAny, {
-        type: "launch_frame";
-        name: string;
-        url?: string | undefined;
-        splashImageUrl?: string | undefined;
-        splashBackgroundColor?: string | undefined;
-    }, {
-        type: "launch_frame";
-        name: string;
-        url?: string | undefined;
-        splashImageUrl?: string | undefined;
-        splashBackgroundColor?: string | undefined;
-    }>, z.ZodObject<{
-        type: z.ZodLiteral<"view_token">;
-        token: z.ZodString;
-    }, "strip", z.ZodTypeAny, {
-        type: "view_token";
-        token: string;
-    }, {
-        type: "view_token";
-        token: string;
-    }>]>;
-}, "strip", z.ZodTypeAny, {
-    title: string;
-    action: {
-        type: "launch_frame";
-        name: string;
-        url?: string | undefined;
-        splashImageUrl?: string | undefined;
-        splashBackgroundColor?: string | undefined;
-    } | {
-        type: "view_token";
-        token: string;
-    };
-}, {
-    title: string;
-    action: {
-        type: "launch_frame";
-        name: string;
-        url?: string | undefined;
-        splashImageUrl?: string | undefined;
-        splashBackgroundColor?: string | undefined;
-    } | {
-        type: "view_token";
-        token: string;
-    };
-}>;
-export declare const frameEmbedNextSchema: z.ZodObject<{
-    version: z.ZodLiteral<"next">;
-    imageUrl: z.ZodString;
-    aspectRatio: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"1:1">, z.ZodLiteral<"3:2">]>>;
-    button: z.ZodObject<{
-        title: z.ZodString;
-        action: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
-            type: z.ZodLiteral<"launch_frame">;
-            name: z.ZodString;
-            url: z.ZodOptional<z.ZodString>;
-            splashImageUrl: z.ZodOptional<z.ZodString>;
-            splashBackgroundColor: z.ZodOptional<z.ZodString>;
-        }, "strip", z.ZodTypeAny, {
-            type: "launch_frame";
-            name: string;
-            url?: string | undefined;
-            splashImageUrl?: string | undefined;
-            splashBackgroundColor?: string | undefined;
-        }, {
-            type: "launch_frame";
-            name: string;
-            url?: string | undefined;
-            splashImageUrl?: string | undefined;
-            splashBackgroundColor?: string | undefined;
-        }>, z.ZodObject<{
-            type: z.ZodLiteral<"view_token">;
-            token: z.ZodString;
-        }, "strip", z.ZodTypeAny, {
-            type: "view_token";
-            token: string;
-        }, {
-            type: "view_token";
-            token: string;
-        }>]>;
-    }, "strip", z.ZodTypeAny, {
-        title: string;
-        action: {
-            type: "launch_frame";
-            name: string;
-            url?: string | undefined;
-            splashImageUrl?: string | undefined;
-            splashBackgroundColor?: string | undefined;
-        } | {
-            type: "view_token";
-            token: string;
-        };
-    }, {
-        title: string;
-        action: {
-            type: "launch_frame";
-            name: string;
-            url?: string | undefined;
-            splashImageUrl?: string | undefined;
-            splashBackgroundColor?: string | undefined;
-        } | {
-            type: "view_token";
-            token: string;
-        };
-    }>;
-}, "strip", z.ZodTypeAny, {
-    version: "next";
-    imageUrl: string;
-    button: {
-        title: string;
-        action: {
-            type: "launch_frame";
-            name: string;
-            url?: string | undefined;
-            splashImageUrl?: string | undefined;
-            splashBackgroundColor?: string | undefined;
-        } | {
-            type: "view_token";
-            token: string;
-        };
-    };
-    aspectRatio?: "1:1" | "3:2" | undefined;
-}, {
-    version: "next";
-    imageUrl: string;
-    button: {
-        title: string;
-        action: {
-            type: "launch_frame";
-            name: string;
-            url?: string | undefined;
-            splashImageUrl?: string | undefined;
-            splashBackgroundColor?: string | undefined;
-        } | {
-            type: "view_token";
-            token: string;
-        };
-    };
-    aspectRatio?: "1:1" | "3:2" | undefined;
-}>;
-export declare const safeParseFrameEmbed: (rawResponse: unknown) => z.SafeParseReturnType<{
-    version: "next";
-    imageUrl: string;
-    button: {
-        title: string;
-        action: {
-            type: "launch_frame";
-            name: string;
-            url?: string | undefined;
-            splashImageUrl?: string | undefined;
-            splashBackgroundColor?: string | undefined;
-        } | {
-            type: "view_token";
-            token: string;
-        };
-    };
-    aspectRatio?: "1:1" | "3:2" | undefined;
-}, {
-    version: "next";
-    imageUrl: string;
-    button: {
-        title: string;
-        action: {
-            type: "launch_frame";
-            name: string;
-            url?: string | undefined;
-            splashImageUrl?: string | undefined;
-            splashBackgroundColor?: string | undefined;
-        } | {
-            type: "view_token";
-            token: string;
-        };
-    };
-    aspectRatio?: "1:1" | "3:2" | undefined;
-}>;
-export type FrameEmbedNext = z.infer<typeof frameEmbedNextSchema>;

package/esm/schemas/embeds.js

@@ -1,28 +0,0 @@
-import { z } from 'zod';
-import { aspectRatioSchema, buttonTitleSchema, caip19TokenSchema, frameNameSchema, hexColorSchema, secureUrlSchema, } from "./shared.js";
-export const actionLaunchFrameSchema = z.object({
-    type: z.literal('launch_frame'),
-    name: frameNameSchema,
-    url: secureUrlSchema.optional(),
-    splashImageUrl: secureUrlSchema.optional(),
-    splashBackgroundColor: hexColorSchema.optional(),
-});
-export const actionViewTokenSchema = z.object({
-    type: z.literal('view_token'),
-    token: caip19TokenSchema,
-});
-export const actionSchema = z.discriminatedUnion('type', [
-    actionLaunchFrameSchema,
-    actionViewTokenSchema,
-]);
-export const buttonSchema = z.object({
-    title: buttonTitleSchema,
-    action: actionSchema,
-});
-export const frameEmbedNextSchema = z.object({
-    version: z.literal('next'),
-    imageUrl: secureUrlSchema,
-    aspectRatio: aspectRatioSchema.optional(),
-    button: buttonSchema,
-});
-export const safeParseFrameEmbed = (rawResponse) => frameEmbedNextSchema.safeParse(rawResponse);