ChainGraph API Documentation / @badaitech/chaingraph-trpc / server / IFolderStore

Interface: IFolderStore

Defined in: packages/chaingraph-trpc/server/stores/folderStore/types.ts:60

Interface for folder storage implementations

Properties

createFolder()

createFolder: (input) => Promise<FlowFolder>

Defined in: packages/chaingraph-trpc/server/stores/folderStore/types.ts:64

Creates a new folder

Parameters

input

CreateFolderInput

Returns

Promise<FlowFolder>

---

deleteFolder()

deleteFolder: (folderId) => Promise<boolean>

Defined in: packages/chaingraph-trpc/server/stores/folderStore/types.ts:100

Deletes a folder (must be empty unless using cascade)

Parameters

folderId

string

Returns

Promise<boolean>

---

getFolder()

getFolder: (folderId) => Promise<FlowFolder | null>

Defined in: packages/chaingraph-trpc/server/stores/folderStore/types.ts:69

Retrieves a folder by ID

Parameters

folderId

string

Returns

Promise<FlowFolder | null>

---

getMaxFlowOrderInFolder()

getMaxFlowOrderInFolder: (folderId, ownerId) => Promise<number>

Defined in: packages/chaingraph-trpc/server/stores/folderStore/types.ts:112

Gets the maximum order value for flows in a folder Used for appending new flows

Parameters

folderId

string | null

ownerId

string

Returns

Promise<number>

---

getMaxOrderInParent()

getMaxOrderInParent: (parentFolderId, ownerId) => Promise<number>

Defined in: packages/chaingraph-trpc/server/stores/folderStore/types.ts:106

Gets the maximum order value in a parent folder (for folders) Used for appending new folders

Parameters

parentFolderId

string | null

ownerId

string

Returns

Promise<number>

---

hasAccess()

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

Defined in: packages/chaingraph-trpc/server/stores/folderStore/types.ts:127

Checks if user has access to a folder

Parameters

folderId

string

userId

string

Returns

Promise<boolean>

---

listChildFolders()

listChildFolders: (parentFolderId) => Promise<FlowFolder[]>

Defined in: packages/chaingraph-trpc/server/stores/folderStore/types.ts:85

Lists child folders of a parent

Parameters

parentFolderId

string | null

Returns

Promise<FlowFolder[]>

---

listFlowsInFolder()

listFlowsInFolder: (folderId) => Promise<FlowMetadata[]>

Defined in: packages/chaingraph-trpc/server/stores/folderStore/types.ts:117

Lists flows in a specific folder (direct children only)

Parameters

folderId

string | null

Returns

Promise<FlowMetadata[]>

---

listFlowsInFolderSubtree()

listFlowsInFolderSubtree: (folderId, ownerId) => Promise<FlowMetadata[]>

Defined in: packages/chaingraph-trpc/server/stores/folderStore/types.ts:122

Lists flows in a folder and all its descendants

Parameters

folderId

string | null

ownerId

string

Returns

Promise<FlowMetadata[]>

---

listFolders()

listFolders: (ownerId, orderBy?, limit?, rootFolderId?) => Promise<FlowFolder[]>

Defined in: packages/chaingraph-trpc/server/stores/folderStore/types.ts:75

Lists all folders for a user

Parameters

ownerId

string

orderBy?

string

limit?

number

rootFolderId?

Optional root folder to filter descendants only

string | null

Returns

Promise<FlowFolder[]>

---

moveFolder()

moveFolder: (input) => Promise<FlowFolder>

Defined in: packages/chaingraph-trpc/server/stores/folderStore/types.ts:95

Moves a folder to a new parent and order

Parameters

input

MoveFolderInput

Returns

Promise<FlowFolder>

---

updateFolder()

updateFolder: (input) => Promise<FlowFolder>

Defined in: packages/chaingraph-trpc/server/stores/folderStore/types.ts:90

Updates a folder's metadata (name, description, color)

Parameters

input

UpdateFolderInput

Returns

Promise<FlowFolder>