summaryrefslogtreecommitdiff
path: root/common/packets.d.ts
blob: 369d2218db96845d0e42ff4b19265270b881fb32 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
/*
    This file is part of keks-meet (https://codeberg.org/metamuffin/keks-meet)
    which is licensed under the GNU Affero General Public License (version 3); see /COPYING.
    Copyright (C) 2022 metamuffin <metamuffin@disroot.org>
*/

// copy pasted from dom.lib.d.ts because it can not be referenced in the server.
type Sdp = string
interface F_RTCIceCandidateInit {
    candidate?: string
    sdpMLineIndex?: number | null
    sdpMid?: string | null
    usernameFragment?: string | null
}

export type ClientboundPacket =
    { init: { your_id: number, version: string } }
    | { client_join: { id: number } } // join: more like "appear" - also sent when you join for others that were there before you.
    | { client_leave: { id: number } }
    | { message: { sender: number, message: string /* encrypted RelayMessageWrapper */ } }

export type ServerboundPacket =
    { ping: null }
    | { relay: { recipient?: number, message: string /* encrypted RelayMessageWrapper */ } }

export interface RelayMessageWrapper {
    sender: number, // redundancy to ensure the server didn't cheat
    inner: RelayMessage
}

export type RelayMessage =
    { chat: ChatMessage }
    | { identify: { username: string } }
    | { provide: ProvideInfo }
    | { request: { id: string } }
    | { provide_stop: { id: string } }
    | { request_stop: { id: string } }
    | { offer: Sdp }
    | { answer: Sdp }
    | { ice_candidate: F_RTCIceCandidateInit }

export interface ChatMessage { text?: string, image?: string }
export type ResourceKind = "track" | "file"
export type TrackKind = "audio" | "video"
export interface ProvideInfo {
    id: string // for datachannels this is `label`, for tracks this will be the `id` of the only associated stream.
    kind: ResourceKind
    track_kind?: TrackKind // used to indicate a/v for tracks only
    label?: string
    size?: number // size for file transfers
}