@orient-bot/dashboard

Dashboard package for the Orient.

Features

• Dashboard API Server: Express-based API for dashboard data
• Health Monitoring: System health checks and status
• Stats Aggregation: Message and usage statistics
• Chat Management: Configure chat permissions
• Schedule Management: Manage scheduled messages

Installation

pnpm add @orient-bot/dashboard

Usage

Starting the Server

import { startDashboardServer } from '@orient-bot/dashboard';

await startDashboardServer({
  port: 3001,
  staticPath: './public',
});

Using the Router

import express from 'express';
import { createDashboardRouter } from '@orient-bot/dashboard/server';

const app = express();
app.use('/dashboard/api', createDashboardRouter());

API Endpoints

| Endpoint | Method | Description | | ---------------- | ------ | ----------------------- | | /api/health | GET | Health check | | /api/stats | GET | Platform statistics | | /api/chats | GET | List chats | | /api/schedules | GET | List scheduled messages |

Types

The package exports all types for dashboard data:

import type {
  HealthStatus,
  PlatformStats,
  ChatConfig,
  ScheduledMessage,
  AuditLogEntry,
} from '@orient-bot/dashboard';

Development

# Build
pnpm build

# Watch mode
pnpm dev

# Test
pnpm test