@farcaster/frame-core 0.0.28 → 0.0.29

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/esm/actions/AddFrame.d.ts

@@ -1,36 +1,40 @@
-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/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,41 +1,43 @@
-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,46 +1,47 @@
 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>;
-export {};
+  /**
+   * 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>

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,6 @@
-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 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,6 @@
-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 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/context.d.ts

@@ -1,72 +1,76 @@
-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;
-        /**
-         * Channel name
-         */
-        name: string;
-        /**
-         * Channel profile image URL
-         */
-        imageUrl?: string;
-    };
-};
-export type LocationContext = CastEmbedLocationContext | NotificationLocationContext | LauncherLocationContext | ChannelLocationContext;
-export type AccountLocation = {
-    placeId: string;
+  type: 'channel'
+  channel: {
     /**
-     * Human-readable string describing the location
+     * Channel key identifier
      */
-    description: string;
-};
-export type UserContext = {
-    fid: number;
-    username?: string;
-    displayName?: string;
+    key: string
+    /**
+     * Channel name
+     */
+    name: string
     /**
-     * Profile image URL
+     * Channel profile image URL
      */
-    pfpUrl?: string;
-    location?: AccountLocation;
-};
+    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
+}
 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,10 +1,12 @@
-export declare class BaseError<cause extends Error | undefined = undefined> extends Error {
-    name: string;
-    cause: cause;
-    constructor(message: string, options?: BaseError.Options<cause>);
+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,5 @@
-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 Context from './context'
+export * from './types'
+export * from './schemas'

package/esm/index.js

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

package/esm/internal/types.d.ts

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

package/esm/internal/types.js

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