@farcaster/frame-core 0.0.28 → 0.0.31

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-present Merkle Manufactory Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

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

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

@@ -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/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 {};

package/esm/schemas/shared.js

@@ -3,7 +3,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);
 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)$/;