@farcaster/frame-core 0.2.0 → 0.3.1

package/dist/actions/AddMiniApp.d.ts

@@ -1,36 +0,0 @@
-import * as Errors from '../errors.ts';
-import type { OneOf } from '../internal/types.ts';
-import type { FrameNotificationDetails } from '../schemas/index.ts';
-export type AddMiniAppResult = {
-    notificationDetails?: FrameNotificationDetails;
-};
-export type AddMiniApp = () => Promise<AddMiniAppResult>;
-type InvalidDomainManifestJsonError = {
-    type: 'invalid_domain_manifest';
-};
-type RejectedByUserJsonError = {
-    type: 'rejected_by_user';
-};
-export type AddMiniAppJsonError = InvalidDomainManifestJsonError | RejectedByUserJsonError;
-export type AddMiniAppRejectedReason = AddMiniAppJsonError['type'];
-export type AddMiniAppJsonResult = OneOf<{
-    result: AddMiniAppResult;
-} | {
-    error: AddMiniAppJsonError;
-}>;
-export type WireAddMiniApp = () => Promise<AddMiniAppJsonResult>;
-/**
- * Thrown when the frame does not have a valid domain manifest.
- */
-export declare class InvalidDomainManifest extends Errors.BaseError {
-    readonly name = "AddMiniApp.InvalidDomainManifest";
-    constructor();
-}
-/**
- * Thrown when add frame action was rejected by the user.
- */
-export declare class RejectedByUser extends Errors.BaseError {
-    readonly name = "AddMiniApp.RejectedByUser";
-    constructor();
-}
-export {};

package/dist/actions/AddMiniApp.js

@@ -1,57 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RejectedByUser = exports.InvalidDomainManifest = void 0;
-const Errors = __importStar(require("../errors.js"));
-/**
- * Thrown when the frame does not have a valid domain manifest.
- */
-class InvalidDomainManifest extends Errors.BaseError {
-    name = 'AddMiniApp.InvalidDomainManifest';
-    constructor() {
-        super('Invalid domain manifest');
-    }
-}
-exports.InvalidDomainManifest = InvalidDomainManifest;
-/**
- * Thrown when add frame action was rejected by the user.
- */
-class RejectedByUser extends Errors.BaseError {
-    name = 'AddMiniApp.RejectedByUser';
-    constructor() {
-        super('Add frame rejected by user');
-    }
-}
-exports.RejectedByUser = RejectedByUser;

package/dist/actions/ComposeCast.d.ts

@@ -1,37 +0,0 @@
-export type Options<close extends boolean | undefined = undefined> = {
-    /**
-     * Suggested text for the body of the cast.
-     *
-     * Mentions can be included using the human-writable 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;
-    /** Whether the cast should be posted to a channel. */
-    channelKey?: string;
-};
-export type ComposeCastInnerResult = {
-    /** 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;
-    };
-    /** Channel key of the created cast */
-    channelKey?: string;
-};
-export type Result<close extends boolean | undefined = undefined> = close extends true ? undefined : {
-    cast: ComposeCastInnerResult | null;
-};

package/dist/actions/ComposeCast.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/actions/Haptics.d.ts

@@ -1,5 +0,0 @@
-export type ImpactOccurredType = 'light' | 'medium' | 'heavy' | 'soft' | 'rigid';
-export type NotificationOccurredType = 'success' | 'warning' | 'error';
-export type ImpactOccurred = (type: ImpactOccurredType) => Promise<void>;
-export type NotificationOccurred = (type: NotificationOccurredType) => Promise<void>;
-export type SelectionChanged = () => Promise<void>;

package/dist/actions/Haptics.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/actions/Ready.d.ts

@@ -1,13 +0,0 @@
-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/dist/actions/Ready.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_READY_OPTIONS = void 0;
-exports.DEFAULT_READY_OPTIONS = {
-    disableNativeGestures: false,
-};

package/dist/actions/SendToken.d.ts

@@ -1,48 +0,0 @@
-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/dist/actions/SendToken.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/actions/SignIn.d.ts

@@ -1,55 +0,0 @@
-import * as Errors from '../errors.ts';
-import type { OneOf } from '../internal/types.ts';
-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;
-    /**
-     * Whether an [Auth
-     * Address](https://github.com/farcasterxyz/protocol/discussions/225) signed
-     * message is acceptable. Defaults to `false` to maintain backwards
-     * compatibility, though applications should set this to `true` for the best
-     * user experience assuming their verification method supports it.
-     *
-     * @default false
-     */
-    acceptAuthAddress?: boolean;
-};
-export type SignInResult = {
-    signature: string;
-    message: string;
-    /**
-     * Indicates if the signature was produced by a custody or auth address.
-     */
-    authMethod: 'custody' | 'authAddress';
-};
-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/dist/actions/SignIn.js

@@ -1,47 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RejectedByUser = void 0;
-const Errors = __importStar(require("../errors.js"));
-/**
- * Thrown when a sign in action was rejected.
- */
-class RejectedByUser extends Errors.BaseError {
-    name = 'SignIn.RejectedByUser';
-    constructor() {
-        super('Sign in rejected by user');
-    }
-}
-exports.RejectedByUser = RejectedByUser;

package/dist/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/dist/actions/SwapToken.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/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/dist/actions/ViewCast.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/actions/ViewProfile.d.ts

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

package/dist/actions/ViewProfile.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/actions/ViewToken.d.ts

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

package/dist/actions/ViewToken.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/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/dist/actions/index.js

@@ -1,46 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ViewToken = exports.ViewProfile = exports.ViewCast = exports.SwapToken = exports.SendToken = exports.SignIn = exports.Ready = exports.Haptics = exports.ComposeCast = exports.AddMiniApp = void 0;
-exports.AddMiniApp = __importStar(require("./AddMiniApp.js"));
-exports.ComposeCast = __importStar(require("./ComposeCast.js"));
-exports.Haptics = __importStar(require("./Haptics.js"));
-exports.Ready = __importStar(require("./Ready.js"));
-exports.SignIn = __importStar(require("./SignIn.js"));
-exports.SendToken = __importStar(require("./SendToken.js"));
-exports.SwapToken = __importStar(require("./SwapToken.js"));
-exports.ViewCast = __importStar(require("./ViewCast.js"));
-exports.ViewProfile = __importStar(require("./ViewProfile.js"));
-exports.ViewToken = __importStar(require("./ViewToken.js"));

package/dist/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/dist/back.js

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_BACK_STATE = void 0;
-exports.DEFAULT_BACK_STATE = {
-    visible: false,
-};

package/dist/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/dist/context.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/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/dist/errors.js

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseError = void 0;
-class BaseError extends Error {
-    name = 'BaseError';
-    cause;
-    constructor(message, options = {}) {
-        super(message, options.cause ? { cause: options.cause } : undefined);
-        this.cause = options.cause;
-    }
-}
-exports.BaseError = BaseError;

package/dist/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/dist/internal/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });