A simple file server with REST API and event bus capabilities for managing text files.
npm install @tscircuit/file-server
# or
bun add @tscircuit/file-serverStart the server:
# Start with default port 3062
file-server
# Start with custom port
PORT=8080 file-serverimport winterspecBundle from "@tscircuit/file-server"
import { startServer } from "winterspec/adapters/node"
const server = await startServer(winterspecBundle, {
port: 3062,
})POST /files/upsert
Content-Type: application/json
{
"file_id": "optional-id",
"file_path": "path/to/file.txt",
"text_content": "File contents here"
}
Response: {
"file": {
"file_id": "1",
"file_path": "path/to/file.txt",
"text_content": "File contents here",
"created_at": "2024-01-01T00:00:00.000Z"
}
}GET /files/get?file_id=1
# or
GET /files/get?file_path=path/to/file.txt
Response: {
"file": {
"file_id": "1",
"file_path": "path/to/file.txt",
"text_content": "File contents here",
"created_at": "2024-01-01T00:00:00.000Z"
}
}GET /files/list
Response: {
"file_list": [
{
"file_id": "1",
"file_path": "path/to/file.txt"
}
]
}POST /events/create
Content-Type: application/json
{
"event_type": "FILE_UPDATED",
"file_path": "path/to/file.txt"
}
Response: {
"event": {
"event_id": "2",
"event_type": "FILE_UPDATED",
"file_path": "path/to/file.txt",
"created_at": "2024-01-01T00:00:00.000Z"
}
}GET /events/list
# or
GET /events/list?since=2024-01-01T00:00:00.000Z
Response: {
"event_list": [
{
"event_id": "2",
"event_type": "FILE_UPDATED",
"file_path": "path/to/file.txt",
"created_at": "2024-01-01T00:00:00.000Z"
}
]
}The server includes a web-based admin interface for managing files:
/admin/files/list- View all files/admin/files/create- Create new files/admin/files/get?file_path=...- View file details
Built-in event types:
FILE_UPDATED- Triggered when a file is created or updated
You can create custom event types by using the /events/create endpoint with your own event type names.
# Start development server
bun run dev
# Run tests
bun test
# Build for production
bun run build