Skip to content

PersistentAI API Documentation / @persistent-ai/fireflow-types / FireFlowBridgeAPI

Interface: FireFlowBridgeAPI

Defined in: packages/fireflow-types/src/miniapp/bridge.ts:151

The complete window.fireflow API surface.

Identical in both iframe and standalone modes, except:

  • miniapp namespace is only present in standalone mode
  • context fields differ slightly (nodeId/portId vs appId/userId)

Properties

context

context: BridgeContext

Defined in: packages/fireflow-types/src/miniapp/bridge.ts:152


data

data: BridgeDataAPI

Defined in: packages/fireflow-types/src/miniapp/bridge.ts:156


events

events: BridgeEventsAPI

Defined in: packages/fireflow-types/src/miniapp/bridge.ts:157


execution

execution: BridgeExecutionAPI

Defined in: packages/fireflow-types/src/miniapp/bridge.ts:161


log()

log: (...args) => void

Defined in: packages/fireflow-types/src/miniapp/bridge.ts:167

Parameters

args

...unknown[]

Returns

void


messages

messages: BridgeMessagesAPI

Defined in: packages/fireflow-types/src/miniapp/bridge.ts:158


miniapp?

optional miniapp: BridgeMiniAppAPI

Defined in: packages/fireflow-types/src/miniapp/bridge.ts:165

Present only in standalone MiniApp mode (undefined in editor iframe).


ready

ready: Promise<void>

Defined in: packages/fireflow-types/src/miniapp/bridge.ts:153


streams

streams: BridgeStreamsAPI

Defined in: packages/fireflow-types/src/miniapp/bridge.ts:159


theme

theme: "light" | "dark" | "auto"

Defined in: packages/fireflow-types/src/miniapp/bridge.ts:154


vfs

vfs: BridgeVFSAPI

Defined in: packages/fireflow-types/src/miniapp/bridge.ts:162


workflow

workflow: BridgeWorkflowAPI

Defined in: packages/fireflow-types/src/miniapp/bridge.ts:160

Licensed under BUSL-1.1