@farcaster/frame-core 0.1.1 → 0.1.3

package/esm/types.d.ts

@@ -1,20 +1,20 @@
-import type { AddMiniApp, ComposeCast, Ready, SendToken, SignIn, SwapToken, ViewCast, ViewProfile, ViewToken } from './actions';
-import type { FrameContext } from './context';
-import type { EventFrameAdded, EventFrameRemoved, EventNotificationsDisabled, EventNotificationsEnabled } from './schemas';
-import type { SolanaRequestFn, SolanaWireRequestFn } from './solana';
-import type { Ethereum } from './wallet';
+import type { AddMiniApp, ComposeCast, Haptics, Ready, SendToken, SignIn, SwapToken, ViewCast, ViewProfile, ViewToken } from './actions/index.ts';
+import type { FrameContext } from './context.ts';
+import type { EventFrameAdded, EventFrameRemoved, EventNotificationsDisabled, EventNotificationsEnabled } from './schemas/index.ts';
+import type { SolanaRequestFn, SolanaWireRequestFn } from './solana.ts';
+import type { Ethereum } from './wallet/index.ts';
 export type SetPrimaryButtonOptions = {
     text: string;
     loading?: boolean;
     disabled?: boolean;
     hidden?: boolean;
 };
-export * from './wallet/ethereum';
-export { DEFAULT_READY_OPTIONS, ReadyOptions } from './actions/Ready';
+export * from './wallet/ethereum.ts';
+export { DEFAULT_READY_OPTIONS, ReadyOptions } from './actions/Ready.ts';
 export type SignInOptions = SignIn.SignInOptions;
 export type SetPrimaryButton = (options: SetPrimaryButtonOptions) => void;
 export declare const miniAppHostCapabilityList: [string, ...string[]];
-export type MiniAppHostCapability = 'wallet.getEthereumProvider' | 'wallet.getSolanaProvider' | 'actions.ready' | 'actions.openUrl' | 'actions.close' | 'actions.setPrimaryButton' | 'actions.addMiniApp' | 'actions.signIn' | 'actions.viewCast' | 'actions.viewProfile' | 'actions.composeCast' | 'actions.viewToken' | 'actions.sendToken' | 'actions.swapToken';
+export type MiniAppHostCapability = 'wallet.getEthereumProvider' | 'wallet.getSolanaProvider' | 'actions.ready' | 'actions.openUrl' | 'actions.close' | 'actions.setPrimaryButton' | 'actions.addMiniApp' | 'actions.signIn' | 'actions.viewCast' | 'actions.viewProfile' | 'actions.composeCast' | 'actions.viewToken' | 'actions.sendToken' | 'actions.swapToken' | 'actions.haptics.impactOccurred' | 'actions.haptics.notificationOccurred' | 'actions.haptics.selectionChanged';
 export type GetCapabilities = () => Promise<MiniAppHostCapability[]>;
 export type GetChains = () => Promise<string[]>;
 export type WireFrameHost = {
@@ -35,6 +35,9 @@ export type WireFrameHost = {
     sendToken: SendToken.SendToken;
     swapToken: SwapToken.SwapToken;
     composeCast: <close extends boolean | undefined = undefined>(options: ComposeCast.Options<close>) => Promise<ComposeCast.Result<close>>;
+    impactOccurred: Haptics.ImpactOccurred;
+    notificationOccurred: Haptics.NotificationOccurred;
+    selectionChanged: Haptics.SelectionChanged;
     getCapabilities: GetCapabilities;
     getChains: GetChains;
 };
@@ -60,6 +63,9 @@ export type FrameHost = {
     sendToken: SendToken.SendToken;
     swapToken: SwapToken.SwapToken;
     composeCast: <close extends boolean | undefined = undefined>(options: ComposeCast.Options<close>) => Promise<ComposeCast.Result<close>>;
+    impactOccurred: Haptics.ImpactOccurred;
+    notificationOccurred: Haptics.NotificationOccurred;
+    selectionChanged: Haptics.SelectionChanged;
     getCapabilities: GetCapabilities;
     getChains: GetChains;
 };

package/esm/types.js

@@ -1,6 +1,6 @@
 // start backwards compat, remove in 1.0
-export * from './wallet/ethereum';
-export { DEFAULT_READY_OPTIONS } from './actions/Ready';
+export * from "./wallet/ethereum.js";
+export { DEFAULT_READY_OPTIONS } from "./actions/Ready.js";
 export const miniAppHostCapabilityList = [
     'wallet.getEthereumProvider',
     'wallet.getSolanaProvider',
@@ -16,4 +16,7 @@ export const miniAppHostCapabilityList = [
     'actions.viewToken',
     'actions.sendToken',
     'actions.swapToken',
+    'actions.haptics.impactOccurred',
+    'actions.haptics.notificationOccurred',
+    'actions.haptics.selectionChanged',
 ];

package/esm/wallet/index.d.ts

@@ -1 +1 @@
-export * as Ethereum from './ethereum';
+export * as Ethereum from './ethereum.ts';

package/esm/wallet/index.js

@@ -1 +1 @@
-export * as Ethereum from './ethereum';
+export * as Ethereum from "./ethereum.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@farcaster/frame-core",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "license": "MIT",
   "repository": {
     "type": "git",
@@ -18,7 +18,7 @@
     "@vitest/coverage-v8": "^2.1.8",
     "typescript": "^5.8.3",
     "vitest": "^2.1.9",
-    "@farcaster/tsconfig": "0.0.4"
+    "@farcaster/tsconfig": "0.0.5"
   },
   "dependencies": {
     "@solana/web3.js": "^1.98.2",

package/src/actions/AddMiniApp.ts

@@ -1,6 +1,6 @@
-import * as Errors from '../errors'
-import type { OneOf } from '../internal/types'
-import type { FrameNotificationDetails } from '../schemas'
+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

package/src/actions/Haptics.ts

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

package/src/actions/SignIn.ts

@@ -1,5 +1,5 @@
-import * as Errors from '../errors'
-import type { OneOf } from '../internal/types'
+import * as Errors from '../errors.ts'
+import type { OneOf } from '../internal/types.ts'
 
 export type SignInOptions = {
   /**

package/src/actions/index.ts

@@ -1,9 +1,10 @@
-export * as AddMiniApp from './AddMiniApp'
-export * as ComposeCast from './ComposeCast'
-export * as Ready from './Ready'
-export * as SignIn from './SignIn'
-export * as SendToken from './SendToken'
-export * as SwapToken from './SwapToken'
-export * as ViewCast from './ViewCast'
-export * as ViewProfile from './ViewProfile'
-export * as ViewToken from './ViewToken'
+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/src/context.ts

@@ -1,4 +1,4 @@
-import type { FrameNotificationDetails } from './schemas'
+import type { FrameNotificationDetails } from './schemas/index.ts'
 
 export type CastEmbedLocationContext = {
   type: 'cast_embed'
@@ -83,8 +83,13 @@ export type ClientContext = {
   safeAreaInsets?: SafeAreaInsets
 }
 
+export type ClientFeatures = {
+  haptics: boolean
+}
+
 export type FrameContext = {
   client: ClientContext
   user: UserContext
   location?: LocationContext
+  features?: ClientFeatures
 }

package/src/index.ts

@@ -1,9 +1,9 @@
-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'
-export * from './solana'
-export * from './solanaWire'
+export * from './actions/index.ts'
+export * from './wallet/index.ts'
+export * as Errors from './errors.ts'
+export * as Context from './context.ts'
+export * as Manifest from './manifest.ts'
+export * from './types.ts'
+export * from './schemas/index.ts'
+export * from './solana.ts'
+export * from './solanaWire.ts'

package/src/manifest.ts

@@ -9,7 +9,7 @@ export type Manifest = {
 /**
  * Signed domain association linking this frame to a Farcaster account
  *
- * A DomainAssociation can be generated using the {@link https://warpcast.com/~/developers/domains | Warpcast
+ * A DomainAssociation can be generated using the {@link https://farcaster.xyz/~/developers/domains | Warpcast
  * Domains Developer} tool.
  */
 export type AccountAssociation = {

package/src/schemas/embeds.ts

@@ -6,7 +6,7 @@ import {
   frameNameSchema,
   hexColorSchema,
   secureUrlSchema,
-} from './shared'
+} from './shared.ts'
 
 export const actionLaunchFrameSchema = z.object({
   type: z.literal('launch_frame'),

package/src/schemas/events.ts

@@ -1,5 +1,5 @@
 import { z } from 'zod'
-import { notificationDetailsSchema } from './notifications'
+import { notificationDetailsSchema } from './notifications.ts'
 
 export const eventFrameAddedSchema = z.object({
   event: z.literal('frame_added'),

package/src/schemas/index.ts

@@ -1,5 +1,5 @@
-export * from './embeds'
-export * from './events'
-export * from './shared'
-export * from './manifest'
-export * from './notifications'
+export * from './embeds.ts'
+export * from './events.ts'
+export * from './shared.ts'
+export * from './manifest.ts'
+export * from './notifications.ts'

package/src/schemas/manifest.ts

@@ -1,5 +1,5 @@
 import { z } from 'zod'
-import { miniAppHostCapabilityList } from '../types'
+import { miniAppHostCapabilityList } from '../types.ts'
 import {
   buttonTitleSchema,
   createSimpleStringSchema,
@@ -7,7 +7,7 @@ import {
   frameNameSchema,
   hexColorSchema,
   secureUrlSchema,
-} from './shared'
+} from './shared.ts'
 
 const primaryCategorySchema = z.enum([
   'games',

package/src/schemas/notifications.ts

@@ -1,5 +1,5 @@
 import { z } from 'zod'
-import { secureUrlSchema } from './shared'
+import { secureUrlSchema } from './shared.ts'
 
 export const notificationDetailsSchema = z.object({
   url: z.string(),

package/src/solanaWire.ts

@@ -14,7 +14,7 @@ import type {
   SolanaWireRequestFn,
   SolanaWireSignAndSendTransactionRequestArguments,
   SolanaWireSignTransactionRequestArguments,
-} from './solana'
+} from './solana.ts'
 
 function serializeTransaction(transaction: SolanaCombinedTransaction): string {
   return Buffer.from(

package/src/types.ts

@@ -1,6 +1,7 @@
 import type {
   AddMiniApp,
   ComposeCast,
+  Haptics,
   Ready,
   SendToken,
   SignIn,
@@ -8,16 +9,16 @@ import type {
   ViewCast,
   ViewProfile,
   ViewToken,
-} from './actions'
-import type { FrameContext } from './context'
+} from './actions/index.ts'
+import type { FrameContext } from './context.ts'
 import type {
   EventFrameAdded,
   EventFrameRemoved,
   EventNotificationsDisabled,
   EventNotificationsEnabled,
-} from './schemas'
-import type { SolanaRequestFn, SolanaWireRequestFn } from './solana'
-import type { Ethereum } from './wallet'
+} from './schemas/index.ts'
+import type { SolanaRequestFn, SolanaWireRequestFn } from './solana.ts'
+import type { Ethereum } from './wallet/index.ts'
 
 export type SetPrimaryButtonOptions = {
   text: string
@@ -27,8 +28,8 @@ export type SetPrimaryButtonOptions = {
 }
 
 // start backwards compat, remove in 1.0
-export * from './wallet/ethereum'
-export { DEFAULT_READY_OPTIONS, ReadyOptions } from './actions/Ready'
+export * from './wallet/ethereum.ts'
+export { DEFAULT_READY_OPTIONS, ReadyOptions } from './actions/Ready.ts'
 export type SignInOptions = SignIn.SignInOptions
 // end backwards compat
 
@@ -49,6 +50,9 @@ export const miniAppHostCapabilityList: [string, ...string[]] = [
   'actions.viewToken',
   'actions.sendToken',
   'actions.swapToken',
+  'actions.haptics.impactOccurred',
+  'actions.haptics.notificationOccurred',
+  'actions.haptics.selectionChanged',
 ]
 
 export type MiniAppHostCapability =
@@ -66,6 +70,9 @@ export type MiniAppHostCapability =
   | 'actions.viewToken'
   | 'actions.sendToken'
   | 'actions.swapToken'
+  | 'actions.haptics.impactOccurred'
+  | 'actions.haptics.notificationOccurred'
+  | 'actions.haptics.selectionChanged'
 
 export type GetCapabilities = () => Promise<MiniAppHostCapability[]>
 
@@ -92,6 +99,9 @@ export type WireFrameHost = {
   composeCast: <close extends boolean | undefined = undefined>(
     options: ComposeCast.Options<close>,
   ) => Promise<ComposeCast.Result<close>>
+  impactOccurred: Haptics.ImpactOccurred
+  notificationOccurred: Haptics.NotificationOccurred
+  selectionChanged: Haptics.SelectionChanged
   getCapabilities: GetCapabilities
   getChains: GetChains
 }
@@ -120,6 +130,9 @@ export type FrameHost = {
   composeCast: <close extends boolean | undefined = undefined>(
     options: ComposeCast.Options<close>,
   ) => Promise<ComposeCast.Result<close>>
+  impactOccurred: Haptics.ImpactOccurred
+  notificationOccurred: Haptics.NotificationOccurred
+  selectionChanged: Haptics.SelectionChanged
   getCapabilities: GetCapabilities
   getChains: GetChains
 }

package/src/wallet/index.ts

@@ -1 +1 @@
-export * as Ethereum from './ethereum'
+export * as Ethereum from './ethereum.ts'