PersistentAI API Documentation / @persistentai/fireflow-vfs / / IFileTypeDefinitionSerializable

Interface: IFileTypeDefinitionSerializable

Defined in: packages/fireflow-vfs/src/types/file-type-definition.ts:149

Serializable file type definition for tRPC transport. Excludes Zod schemas (replaced with JSON Schema) and functions.

Extends

• Omit<IFileTypeDefinition, "createSchema" | "defaultContent" | "preCreateHook">

Properties

actions

actions: FileAction[]

Defined in: packages/fireflow-vfs/src/types/file-type-definition.ts:121

Available actions for this file type

Inherited from

IFileTypeDefinition.actions

---

category

category: FileTypeCategory

Defined in: packages/fireflow-vfs/src/types/file-type-definition.ts:104

Category for grouping in menus

Inherited from

IFileTypeDefinition.category

---

creatable

creatable: boolean

Defined in: packages/fireflow-vfs/src/types/file-type-definition.ts:151

Whether this type supports creation (has createSchema)

---

createSchemaJSON?

optional createSchemaJSON: JsonSchema7Type

Defined in: packages/fireflow-vfs/src/types/file-type-definition.ts:157

JSON Schema 7 for creation form (converted from Zod schema)

---

description?

optional description: string

Defined in: packages/fireflow-vfs/src/types/file-type-definition.ts:92

Brief description for tooltips

Inherited from

IFileTypeDefinition.description

---

dropNodeType?

optional dropNodeType: string

Defined in: packages/fireflow-vfs/src/types/file-type-definition.ts:142

Node type to create when this file is dropped onto the flow canvas

Inherited from

IFileTypeDefinition.dropNodeType

---

editable

editable: boolean

Defined in: packages/fireflow-vfs/src/types/file-type-definition.ts:133

Whether file content is editable

Inherited from

IFileTypeDefinition.editable

---

extensions

extensions: string[]

Defined in: packages/fireflow-vfs/src/types/file-type-definition.ts:95

File extensions this type handles (e.g., ['.fflow', '.ffw'])

Inherited from

IFileTypeDefinition.extensions

---

handler

handler: FileHandler

Defined in: packages/fireflow-vfs/src/types/file-type-definition.ts:124

Handler that opens this file type

Inherited from

IFileTypeDefinition.handler

---

hasPreCreateHook

hasPreCreateHook: boolean

Defined in: packages/fireflow-vfs/src/types/file-type-definition.ts:154

Whether this type needs backend resource creation before file write

---

icon

icon: string

Defined in: packages/fireflow-vfs/src/types/file-type-definition.ts:101

Icon identifier (lucide icon name or custom)

Inherited from

IFileTypeDefinition.icon

---

id

id: string

Defined in: packages/fireflow-vfs/src/types/file-type-definition.ts:86

Unique identifier (e.g., 'fflow', 'json', 'markdown')

Inherited from

IFileTypeDefinition.id

---

mimeTypes?

optional mimeTypes: string[]

Defined in: packages/fireflow-vfs/src/types/file-type-definition.ts:98

MIME types this type handles (fallback identification)

Inherited from

IFileTypeDefinition.mimeTypes

---

name

name: string

Defined in: packages/fireflow-vfs/src/types/file-type-definition.ts:89

Human-readable name (e.g., 'FireFlow Flow')

Inherited from

IFileTypeDefinition.name

---

previewable

previewable: boolean

Defined in: packages/fireflow-vfs/src/types/file-type-definition.ts:136

Whether file can be previewed inline

Inherited from

IFileTypeDefinition.previewable

---

priority?

optional priority: number

Defined in: packages/fireflow-vfs/src/types/file-type-definition.ts:139

Priority for extension conflicts (higher wins)

Inherited from

IFileTypeDefinition.priority

---

virtual

virtual: boolean

Defined in: packages/fireflow-vfs/src/types/file-type-definition.ts:127

Whether file can expose virtual children

Inherited from

IFileTypeDefinition.virtual

---

virtualChildType?

optional virtualChildType: VirtualChildType

Defined in: packages/fireflow-vfs/src/types/file-type-definition.ts:130

Virtual child type identifier (for virtual: true types)

Inherited from

IFileTypeDefinition.virtualChildType