@photon-ai/dashboard-api

@photon-ai/dashboard-api

Public API type contract for the Photon Dashboard.

This package exposes only the type surface of the public API — there's no runtime code. Use it with @elysiajs/eden to get end-to-end type-safe HTTP calls in a CLI, SDK, or third-party client.

Install

Install the types package plus its two peer deps (this package ships only type declarations — no runtime code):

bun add -d @photon-ai/dashboard-api elysia @elysiajs/eden

Published automatically on each dashboard release; the version tracks the release tag (dashboard v1.2.0 -> @photon-ai/dashboard-api@1.2.0).

Usage

import { treaty } from "@elysiajs/eden";
import type { PublicApp } from "@photon-ai/dashboard-api";

const api = treaty<PublicApp>("https://api.photon.codes");

const { data, error } = await api.api.projects.get();
//                              ^? typed

What's exposed

Only public, end-user-facing routes. Admin and internal routes live behind a separate App type and are never bundled here.

Versioning

The major version of this package tracks the public API contract. Breaking changes to public routes bump the major; additive routes bump the minor.

elysia and @elysiajs/eden are declared as peer dependencies — pin them to the same version range as the dashboard server (currently ^1.4).