PersistentAI API Documentation / @persistentai/fireflow-trpc / server / IFlowStore

Interface: IFlowStore

Defined in: packages/fireflow-trpc/server/stores/flowStore/types.ts:15

Interface for flow storage implementations

Properties

createFlow()

createFlow: (metadata) => Promise<Flow>

Defined in: packages/fireflow-trpc/server/stores/flowStore/types.ts:16

Parameters

metadata

FlowMetadata

Returns

Promise<Flow>

---

createFlowAtPath()?

optional createFlowAtPath: (metadata, parentPath) => Promise<Flow>

Defined in: packages/fireflow-trpc/server/stores/flowStore/types.ts:39

Create a flow at a specific VFS path

Parameters

metadata

FlowMetadata

Flow metadata (name, description, ownerId)

parentPath

string

Parent directory path where .fflow folder will be created

Returns

Promise<Flow>

The created flow

---

deleteFlow()

deleteFlow: (flowId) => Promise<boolean>

Defined in: packages/fireflow-trpc/server/stores/flowStore/types.ts:24

Parameters

flowId

string

Returns

Promise<boolean>

---

deleteFlowAtPath()?

optional deleteFlowAtPath: (flowPath) => Promise<boolean>

Defined in: packages/fireflow-trpc/server/stores/flowStore/types.ts:61

Delete a flow at a specific VFS path

Parameters

flowPath

string

Path to the .fflow folder to delete

Returns

Promise<boolean>

True if deleted successfully

---

getFlow()

getFlow: (flowId) => Promise<Flow | null>

Defined in: packages/fireflow-trpc/server/stores/flowStore/types.ts:17

Parameters

flowId

string

Returns

Promise<Flow | null>

---

getFlowByRef()?

optional getFlowByRef: (ref) => Promise<Flow | null>

Defined in: packages/fireflow-trpc/server/stores/flowStore/types.ts:46

Get a flow by FlowRef (path-based addressing)

Parameters

ref

FlowRef containing workspaceId, git ref, and path to .fflow folder

path

string

ref

string

workspaceId

string

Returns

Promise<Flow | null>

The flow or null if not found

---

getFlowMetadata()

getFlowMetadata: (flowId) => Promise<FlowMetadata | null>

Defined in: packages/fireflow-trpc/server/stores/flowStore/types.ts:18

Parameters

flowId

string

Returns

Promise<FlowMetadata | null>

---

hasAccess()

hasAccess: (flowId, userId) => Promise<boolean>

Defined in: packages/fireflow-trpc/server/stores/flowStore/types.ts:26

Parameters

flowId

string

userId

string

Returns

Promise<boolean>

---

listFlows()

listFlows: (ownerId, orderBy, limit) => Promise<FlowMetadata[]>

Defined in: packages/fireflow-trpc/server/stores/flowStore/types.ts:19

Parameters

ownerId

string

orderBy

ListOrderBy

limit

number

Returns

Promise<FlowMetadata[]>

---

lockFlow()

lockFlow: (flowId, timeout?) => Promise<void>

Defined in: packages/fireflow-trpc/server/stores/flowStore/types.ts:28

Parameters

flowId

string

timeout?

number

Returns

Promise<void>

---

unlockFlow()

unlockFlow: (flowId) => Promise<void>

Defined in: packages/fireflow-trpc/server/stores/flowStore/types.ts:29

Parameters

flowId

string

Returns

Promise<void>

---

updateFlow()

updateFlow: (flow) => Promise<Flow>

Defined in: packages/fireflow-trpc/server/stores/flowStore/types.ts:25

Parameters

flow

Flow

Returns

Promise<Flow>

---

updateFlowAtPath()?

optional updateFlowAtPath: (flow, flowPath) => Promise<Flow>

Defined in: packages/fireflow-trpc/server/stores/flowStore/types.ts:54

Update a flow at a specific VFS path

Parameters

flow

Flow

The flow to save

flowPath

string

Path to the .fflow folder

Returns

Promise<Flow>

The updated flow