@farcaster/frame-core 0.0.29 → 0.0.31

package/README.md

@@ -0,0 +1,13 @@
+# @farcaster/frame-core
+
+Build onchain social apps
+
+## Installation
+
+```bash
+pnpm add @farcaster/core
+```
+
+## Documentation
+
+For documentation and guides, visit [miniapps.farcaster.xyz](https://miniapps.farcaster.xyz).

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

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

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

@@ -33,8 +33,9 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ViewToken = exports.ViewProfile = exports.Swap = exports.SignIn = exports.Ready = exports.AddFrame = void 0;
+exports.ViewToken = exports.ViewProfile = exports.Swap = exports.SignIn = exports.Ready = exports.ComposeCast = exports.AddFrame = void 0;
 exports.AddFrame = __importStar(require("./AddFrame"));
+exports.ComposeCast = __importStar(require("./ComposeCast"));
 exports.Ready = __importStar(require("./Ready"));
 exports.SignIn = __importStar(require("./SignIn"));
 exports.Swap = __importStar(require("./Swap"));

package/dist/errors.d.ts

@@ -1,3 +1,6 @@
+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;

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

@@ -36,9 +36,11 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Context = void 0;
+exports.Manifest = exports.Context = exports.Errors = void 0;
 __exportStar(require("./actions"), exports);
 __exportStar(require("./wallet"), exports);
+exports.Errors = __importStar(require("./errors"));
 exports.Context = __importStar(require("./context"));
+exports.Manifest = __importStar(require("./manifest"));
 __exportStar(require("./types"), exports);
 __exportStar(require("./schemas"), exports);

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

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

package/dist/schemas/shared.js

@@ -6,7 +6,7 @@ exports.secureUrlSchema = zod_1.z
     .string()
     .url()
     .startsWith('https://', { message: 'Must be an https url' })
-    .max(512);
+    .max(1024);
 exports.frameNameSchema = zod_1.z.string().max(32);
 exports.buttonTitleSchema = zod_1.z.string().max(32);
 const CAIP_19_REGEX = /^[-a-z0-9]{3,8}:[-_a-zA-Z0-9]{1,32}\/(?:[-a-z0-9]{3,8}:[-.%a-zA-Z0-9]{1,128}(?:\/[-.%a-zA-Z0-9]{1,78})?|native)$/;

package/dist/types.d.ts

@@ -1,4 +1,4 @@
-import type { AddFrame, Ready, SignIn, Swap, ViewProfile, ViewToken } from './actions';
+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';
@@ -26,6 +26,7 @@ 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 = {
     context: FrameContext;
@@ -45,6 +46,7 @@ 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 = {
     event: 'frame_add_rejected';

package/esm/actions/AddFrame.d.ts

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

package/esm/actions/AddFrame.js

@@ -1,19 +1,19 @@
-import * as Errors from '../errors'
+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')
-  }
+    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')
-  }
+    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

@@ -1,13 +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
-}
+    /**
+     * 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
+    disableNativeGestures: false;
+};
+export type Ready = (options?: Partial<ReadyOptions>) => void;

package/esm/actions/Ready.js

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

package/esm/actions/SignIn.d.ts

@@ -1,43 +1,41 @@
-import * as Errors from '../errors'
-import type { OneOf } from '../internal/types'
+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
-}
+    /**
+     * 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>
+    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>
+    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()
+    readonly name = "SignIn.RejectedByUser";
+    constructor();
 }
+export {};

package/esm/actions/SignIn.js

@@ -1,10 +1,10 @@
-import * as Errors from '../errors'
+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')
-  }
+    name = 'SignIn.RejectedByUser';
+    constructor() {
+        super('Sign in rejected by user');
+    }
 }

package/esm/actions/Swap.d.ts

@@ -1,47 +1,46 @@
 export type SwapOptions = {
-  /**
-   * 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
-}
+    /**
+     * 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 SwapDetails = {
-  /**
-   * Array of tx identifiers in order of execution.
-   * Some swaps will have both an approval and swap tx.
-   */
-  transactions: `0x${string}`[]
-}
+    /**
+     * Array of tx identifiers in order of execution.
+     * Some swaps will have both an approval and swap tx.
+     */
+    transactions: `0x${string}`[];
+};
 type SwapErrorDetails = {
-  /**
-   * Error code.
-   */
-  error: string
-  /**
-   * Error message.
-   */
-  message?: string
-}
-export type SwapErrorReason = 'rejected_by_user' | 'swap_failed'
-export type SwapResult =
-  | {
-      success: true
-      swap: SwapDetails
-    }
-  | {
-      success: false
-      reason: SwapErrorReason
-      error?: SwapErrorDetails
-    }
-export type Swap = (options: SwapOptions) => Promise<SwapResult>
+    /**
+     * Error code.
+     */
+    error: string;
+    /**
+     * Error message.
+     */
+    message?: string;
+};
+export type SwapErrorReason = 'rejected_by_user' | 'swap_failed';
+export type SwapResult = {
+    success: true;
+    swap: SwapDetails;
+} | {
+    success: false;
+    reason: SwapErrorReason;
+    error?: SwapErrorDetails;
+};
+export type Swap = (options: SwapOptions) => Promise<SwapResult>;
+export {};

package/esm/actions/Swap.js

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

package/esm/actions/ViewProfile.d.ts

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

package/esm/actions/ViewProfile.js

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

package/esm/actions/ViewToken.d.ts

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

package/esm/actions/ViewToken.js

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

package/esm/actions/index.d.ts

@@ -1,6 +1,7 @@
-export * as AddFrame from './AddFrame'
-export * as Ready from './Ready'
-export * as SignIn from './SignIn'
-export * as Swap from './Swap'
-export * as ViewProfile from './ViewProfile'
-export * as ViewToken from './ViewToken'
+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';
+export * as ViewProfile from './ViewProfile';
+export * as ViewToken from './ViewToken';

package/esm/actions/index.js

@@ -1,6 +1,7 @@
-export * as AddFrame from './AddFrame'
-export * as Ready from './Ready'
-export * as SignIn from './SignIn'
-export * as Swap from './Swap'
-export * as ViewProfile from './ViewProfile'
-export * as ViewToken from './ViewToken'
+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';
+export * as ViewProfile from './ViewProfile';
+export * as ViewToken from './ViewToken';