fpv-laptimer-client 0.0.0-stage → 0.0.2

package/types/types.d.ts

@@ -0,0 +1,368 @@
+/**
+ * A channel (a seat on the page: slot 1 = index 0).
+ */
+export type Channel = {
+    /**
+     * 0, 1, …
+     */
+    index: number;
+    /**
+     * "R1" … "R8" or the MHz as text
+     */
+    name: string;
+    mhz: number;
+    /**
+     * false: does not fly along
+     */
+    enabled: boolean;
+    pilot_id: number | null;
+    /**
+     * callsign of the assigned pilot
+     */
+    pilot: string | null;
+    /**
+     * free text instead of a pilot (wins over `pilot`)
+     */
+    label: string;
+    /**
+     * what the page shows
+     */
+    shown: string;
+};
+export type Pilot = {
+    id: number;
+    /**
+     * callsign (unique)
+     */
+    name: string;
+    /**
+     * may be empty
+     */
+    full_name: string;
+};
+/**
+ * One seat's result in a session (`results`, in seat order).
+ */
+export type SeatResult = {
+    channel: number;
+    channel_name: string;
+    mhz: number;
+    pilot_id: number | null;
+    /**
+     * shown name: callsign, free text or channel name
+     */
+    pilot: string;
+    /**
+     * null without a lap
+     */
+    position: number | null;
+    laps: number;
+    lap_times_us: number[];
+    last_lap_us: number | null;
+    best_lap_us: number | null;
+    best_consecutive_us: number | null;
+    total_us: number | null;
+    holeshot_us: number | null;
+    finished: boolean;
+};
+/**
+ * A pass through the gate (only in `sessions.get`).
+ */
+export type Pass = {
+    id: number;
+    channel: number;
+    time_us: number;
+    peak_db: number;
+    /**
+     * added by hand
+     */
+    manual: boolean;
+    deleted: boolean;
+    /**
+     * 0 = finish, 1 = arming gate
+     */
+    gate: number;
+    /**
+     * deleted by the server, and why
+     */
+    rejected?: "no_arming" | null | undefined;
+    /**
+     * where the detector put it (null: added by hand; differs from time_us: moved by hand)
+     */
+    detected_us?: number | null | undefined;
+};
+/**
+ * A correction of a pass (only in `sessions.get`, as `changes`).
+ */
+export type PassChange = {
+    pass_id: number | null;
+    channel: number;
+    action: "add" | "delete" | "restore" | "move" | "reject";
+    from_us: number | null;
+    to_us: number | null;
+    rejected: string | null;
+    /**
+     * while the session ran
+     */
+    live: boolean;
+    origin: "seite" | "editor" | "api" | "server";
+    at_us: number;
+};
+export type StartMode = "holeshot" | "from_start" | "flying";
+export type Session = {
+    id: number;
+    /**
+     * false = training
+     */
+    race: boolean;
+    phase: "countdown" | "running" | "ended";
+    start_mode: StartMode;
+    end: "open" | "laps" | "seconds";
+    end_value: number | null;
+    countdown_s: number;
+    min_lap_s: number;
+    created_us: number;
+    start_us: number;
+    ended_us: number | null;
+    confirmed_us: number | null;
+    needs_confirmation: boolean;
+    results: SeatResult[];
+    /**
+     * only from `sessions.get`
+     */
+    passes?: Pass[] | undefined;
+    /**
+     * only from `sessions.get`: every correction of a pass
+     */
+    changes?: PassChange[] | undefined;
+};
+export type Board = {
+    id: string;
+    port: string;
+    /**
+     * finish, arming or off
+     */
+    role: string;
+    ok: boolean;
+    error: string | null;
+    levels_per_s: number;
+};
+export type State = {
+    now_us: number;
+    /**
+     * the running session
+     */
+    session: Session | null;
+    /**
+     * the ended race waiting for confirmation
+     */
+    unconfirmed: Session | null;
+    channels: Channel[];
+    pilots: Pilot[];
+    boards: Board[];
+};
+export type PilotStats = {
+    pilot_id: number | null;
+    label: string;
+    best_lap_us: number | null;
+    best_consecutive_us: number | null;
+    sessions: number;
+    races: number;
+    wins: number;
+};
+export type Stats = {
+    today_races: number;
+    /**
+     * best lap first
+     */
+    all: PilotStats[];
+    today: PilotStats[];
+};
+/**
+ * Arguments of `session.start`.
+ */
+export type StartOptions = {
+    /**
+     * true: race, false: training (default)
+     */
+    race?: boolean | undefined;
+    /**
+     * race: end after this many laps (1–100)
+     */
+    laps?: number | undefined;
+    /**
+     * race: end after this many seconds (10–3600), instead of laps
+     */
+    seconds?: number | undefined;
+    /**
+     * race: 0–60
+     */
+    countdown_s?: number | undefined;
+    /**
+     * race
+     */
+    start_mode?: StartMode | undefined;
+};
+/**
+ * Arguments of `channels.set` (only given fields change).
+ */
+export type ChannelChange = {
+    /**
+     * callsign, null = nobody
+     */
+    pilot?: string | null | undefined;
+    /**
+     * instead of `pilot`
+     */
+    pilot_id?: number | null | undefined;
+    /**
+     * make an unknown callsign a pilot
+     */
+    create?: boolean | undefined;
+    /**
+     * free text instead of a pilot ("" = none)
+     */
+    label?: string | undefined;
+    enabled?: boolean | undefined;
+    /**
+     * "R1" … "R8" or MHz (5300–6000); not during a session
+     */
+    frequency?: string | number | undefined;
+};
+/**
+ * Fields every event about a pilot has ("Sitz" in docs/api/events.md).
+ */
+export type Seat = {
+    channel: number;
+    channel_name: string;
+    mhz: number;
+    pilot_id: number | null;
+    pilot: string;
+};
+export type SessionStartedData = {
+    session_id: number;
+    race: boolean;
+    start_mode: StartMode;
+    end: "open" | "laps" | "seconds";
+    end_value: number | null;
+    countdown_s: number;
+    created_us: number;
+    start_us: number;
+    pilot_count: number;
+    seats: Seat[];
+};
+export type CountdownData = {
+    session_id: number;
+    race: boolean;
+    seconds_left: number;
+};
+export type StartSignalData = {
+    session_id: number;
+    race: boolean;
+    start_us: number;
+};
+export type PilotPassData = Seat & {
+    session_id: number;
+    race: boolean;
+    pass_id: number;
+    time_us: number;
+    manual: boolean;
+    kind: "lap" | "holeshot" | "start" | "ignored";
+    lap: number | null;
+    lap_time_us: number | null;
+    lap_time_s: number | null;
+    laps: number;
+    best_lap_us: number | null;
+    best_lap_s: number | null;
+    personal_best: boolean;
+    session_best: boolean;
+    holeshot_us: number | null;
+    finished: boolean;
+    position: number | null;
+};
+export type PilotFinishedData = Seat & {
+    session_id: number;
+    laps: number;
+    total_us: number | null;
+    total_s: number | null;
+    best_lap_us: number | null;
+    best_lap_s: number | null;
+    position: number | null;
+};
+export type SessionStoppedData = {
+    session_id: number;
+    race: boolean;
+    reason: "stopped" | "finished" | "cancelled";
+    ended_us: number;
+    needs_confirmation: boolean;
+    /**
+     * race only
+     */
+    winner: string | null;
+    results: SeatResult[];
+};
+export type RaceConfirmedData = {
+    session_id: number;
+    race: boolean;
+    confirmed_us: number;
+    winner: string | null;
+    results: SeatResult[];
+};
+export type PilotEventData = {
+    pilot_id: number;
+    name: string;
+    /**
+     * not in pilot_deleted
+     */
+    full_name?: string | undefined;
+};
+/**
+ * Event name → its `data`.
+ */
+export type EventMap = {
+    session_started: SessionStartedData;
+    countdown: CountdownData;
+    start_signal: StartSignalData;
+    pilot_pass: PilotPassData;
+    pilot_finished: PilotFinishedData;
+    session_stopped: SessionStoppedData;
+    race_confirmed: RaceConfirmedData;
+    session_deleted: {
+        session_id: number;
+        race: boolean;
+    };
+    sessions_reset: {
+        deleted: number;
+    };
+    passes_changed: {
+        session_id: number;
+    };
+    channels_changed: {
+        channels: Channel[];
+    };
+    pilot_added: PilotEventData;
+    pilot_updated: PilotEventData;
+    pilot_deleted: PilotEventData;
+};
+/**
+ * An event as it comes over the WebSocket.
+ */
+export type EventMessage<D = any> = {
+    type: "event";
+    event: string;
+    /**
+     * counts from 1 since the server started; a gap = missed events
+     */
+    seq: number;
+    time_us: number;
+    data: D;
+};
+/**
+ * The first message after connecting.
+ */
+export type Hello = {
+    type: "hello";
+    api: number;
+    state: State | null;
+    commands: string[];
+};