@farcaster/frame-core 0.0.29 → 0.0.31

package/esm/context.d.ts

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

package/esm/context.js

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

package/esm/errors.d.ts

@@ -1,12 +1,13 @@
-export declare class BaseError<
-  cause extends Error | undefined = undefined,
-> extends Error {
-  name: string
-  cause: cause
-  constructor(message: string, options?: BaseError.Options<cause>)
+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
-  }
+    type Options<cause extends Error | undefined = Error | undefined> = {
+        cause?: cause | undefined;
+    };
 }

package/esm/errors.js

@@ -1,8 +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
-  }
+    name = 'BaseError';
+    cause;
+    constructor(message, options = {}) {
+        super(message, options.cause ? { cause: options.cause } : undefined);
+        this.cause = options.cause;
+    }
 }

package/esm/index.d.ts

@@ -1,5 +1,7 @@
-export * from './actions'
-export * from './wallet'
-export * as Context from './context'
-export * from './types'
-export * from './schemas'
+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 Context from './context'
-export * from './types'
-export * from './schemas'
+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

@@ -1,19 +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
+    [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 +1 @@
-export {}
+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 {};