@farcaster/miniapp-core 0.3.7 → 0.3.9

package/src/actions/SignManifest.ts

@@ -0,0 +1,77 @@
+import * as Errors from '../errors.ts'
+import type { OneOf } from '../internal/types.ts'
+
+export type SignManifestOptions = {
+  domain: string
+}
+
+export type SignManifestResult = {
+  header: string
+  payload: string
+  signature: string
+}
+
+export type SignManifest = (
+  options: SignManifestOptions,
+) => Promise<SignManifestResult>
+
+type RejectedByUserJsonError = {
+  type: 'rejected_by_user'
+}
+
+type InvalidDomainJsonError = {
+  type: 'invalid_domain'
+}
+
+type GenericErrorJsonError = {
+  type: 'generic_error'
+  message?: string
+}
+
+export type SignManifestJsonError =
+  | RejectedByUserJsonError
+  | InvalidDomainJsonError
+  | GenericErrorJsonError
+
+export type SignManifestRejectedReason = SignManifestJsonError['type']
+
+export type SignManifestJsonResult = OneOf<
+  { result: SignManifestResult } | { error: SignManifestJsonError }
+>
+
+export type WireSignManifest = (
+  options: SignManifestOptions,
+) => Promise<SignManifestJsonResult>
+
+/**
+ * Thrown when sign manifest action was rejected by the user.
+ */
+export class RejectedByUser extends Errors.BaseError {
+  override readonly name = 'SignManifest.RejectedByUser'
+
+  constructor() {
+    super('Sign manifest rejected by user')
+  }
+}
+
+/**
+ * Thrown when the provided domain is invalid.
+ */
+export class InvalidDomain extends Errors.BaseError {
+  override readonly name = 'SignManifest.InvalidDomain'
+
+  constructor() {
+    super('Invalid domain provided')
+  }
+}
+
+/**
+ * Thrown when manifest signing fails for generic reasons.
+ */
+export class GenericError extends Errors.BaseError {
+  override readonly name = 'SignManifest.GenericError'
+
+  constructor(message = 'Manifest signing failed') {
+    super(message)
+  }
+}

package/src/actions/index.ts

@@ -6,6 +6,7 @@ export * as Ready from './Ready.ts'
 export * as RequestCameraAndMicrophoneAccess from './RequestCameraAndMicrophoneAccess.ts'
 export * as SendToken from './SendToken.ts'
 export * as SignIn from './SignIn.ts'
+export * as SignManifest from './SignManifest.ts'
 export * as SwapToken from './SwapToken.ts'
 export * as ViewCast from './ViewCast.ts'
 export * as ViewProfile from './ViewProfile.ts'

package/src/schemas/events.ts

@@ -8,25 +8,12 @@ export const eventMiniAppAddedSchema = z.object({
 
 export type EventMiniAppAdded = z.infer<typeof eventMiniAppAddedSchema>
 
-export const eventFrameAddedSchema = z.object({
-  event: z.literal('frame_added'),
-  notificationDetails: notificationDetailsSchema.optional(),
-})
-
-export type EventFrameAdded = z.infer<typeof eventFrameAddedSchema>
-
 export const eventMiniAppRemovedSchema = z.object({
   event: z.literal('miniapp_removed'),
 })
 
 export type EventMiniAppRemoved = z.infer<typeof eventMiniAppRemovedSchema>
 
-export const eventFrameRemovedSchema = z.object({
-  event: z.literal('frame_removed'),
-})
-
-export type EventFrameRemoved = z.infer<typeof eventFrameRemovedSchema>
-
 export const eventNotificationsEnabledSchema = z.object({
   event: z.literal('notifications_enabled'),
   notificationDetails: notificationDetailsSchema.required(),
@@ -49,9 +36,6 @@ export const serverEventSchema = z.discriminatedUnion('event', [
   eventMiniAppRemovedSchema,
   eventNotificationsEnabledSchema,
   notificationsDisabledSchema,
-  // Remove after compatibility period
-  eventFrameAddedSchema,
-  eventFrameRemovedSchema,
 ])
 
 export type MiniAppServerEvent = z.infer<typeof serverEventSchema>

package/src/types.ts

@@ -11,6 +11,7 @@ import type {
   RequestCameraAndMicrophoneAccess,
   SendToken,
   SignIn,
+  SignManifest,
   SwapToken,
   ViewCast,
   ViewProfile,
@@ -19,8 +20,6 @@ import type {
 import type { UpdateBackState } from './back.ts'
 import type { MiniAppContext } from './context.ts'
 import type {
-  EventFrameAdded,
-  EventFrameRemoved,
   EventMiniAppAdded,
   EventMiniAppRemoved,
   EventNotificationsDisabled,
@@ -64,6 +63,7 @@ export const miniAppHostCapabilityList = [
   'actions.swapToken',
   'actions.openMiniApp',
   'actions.requestCameraAndMicrophoneAccess',
+  'experimental.signManifest',
   'haptics.impactOccurred',
   'haptics.notificationOccurred',
   'haptics.selectionChanged',
@@ -83,6 +83,7 @@ export type WireMiniAppHost = {
   ready: Ready.Ready
   openUrl: (url: string) => void
   signIn: SignIn.WireSignIn
+  signManifest: SignManifest.WireSignManifest
   setPrimaryButton: SetPrimaryButton
   ethProviderRequest: Ethereum.EthProvideRequest
   ethProviderRequestV2: Ethereum.RpcTransport
@@ -114,6 +115,7 @@ export type MiniAppHost = {
   ready: Ready.Ready
   openUrl: (url: string) => void
   signIn: SignIn.SignIn
+  signManifest: SignManifest.SignManifest
   setPrimaryButton: SetPrimaryButton
   ethProviderRequest: Ethereum.EthProvideRequest
   ethProviderRequestV2: Ethereum.RpcTransport
@@ -143,11 +145,6 @@ export type MiniAppHost = {
   updateBackState: UpdateBackState
 }
 
-export type EventFrameAddRejected = {
-  event: 'frame_add_rejected'
-  reason: AddMiniApp.AddMiniAppRejectedReason
-}
-
 export type EventMiniAppAddRejected = {
   event: 'miniapp_add_rejected'
   reason: AddMiniApp.AddMiniAppRejectedReason
@@ -170,6 +167,3 @@ export type MiniAppClientEvent =
   | EventPrimaryButtonClicked
   | EventBackNavigationTriggered
   | Ethereum.EventEip6963AnnounceProvider
-  | EventFrameAdded
-  | EventFrameAddRejected
-  | EventFrameRemoved