summary refs log tree commit diff
path: root/gateway/src/schema/Activity.ts
blob: f1665efdc05e2133d8d18026360fd844064223a9 (plain) (blame)
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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
import { EmojiSchema } from "./Emoji";

export const ActivitySchema = {
	afk: Boolean,
	status: String,
	$activities: [
		{
			name: String,
			type: Number,
			$url: String,
			$created_at: Date,
			$timestamps: [
				{
					$start: Number,
					$end: Number,
				},
			],
			$application_id: String,
			$details: String,
			$state: String,
			$emoji: {
				$name: String,
				$id: String,
				$amimated: Boolean,
			},
			$party: {
				$id: String,
				$size: [Number, Number],
			},
			$assets: {
				$large_image: String,
				$large_text: String,
				$small_image: String,
				$small_text: String,
			},
			$secrets: {
				$join: String,
				$spectate: String,
				$match: String,
			},
			$instance: Boolean,
			$flags: String,
		},
	],
	$since: Number, // unix time (in milliseconds) of when the client went idle, or null if the client is not idle
};

export interface ActivitySchema {
	afk: boolean;
	status: string;
	activities?: [
		{
			name: string; // the activity's name
			type: number; // activity type // TODO: check if its between range 0-5
			url?: string; // stream url, is validated when type is 1
			created_at?: number; // unix timestamp of when the activity was added to the user's session
			timestamps?: {
				// unix timestamps for start and/or end of the game
				start: number;
				end: number;
			};
			application_id?: string; // application id for the game
			details?: string;
			state?: string;
			emoji?: EmojiSchema;
			party?: {
				id?: string;
				size?: [number]; // used to show the party's current and maximum size // TODO: array length 2
			};
			assets?: {
				large_image?: string; // the id for a large asset of the activity, usually a snowflake
				large_text?: string; // text displayed when hovering over the large image of the activity
				small_image?: string; // the id for a small asset of the activity, usually a snowflake
				small_text?: string; // text displayed when hovering over the small image of the activity
			};
			secrets?: {
				join?: string; // the secret for joining a party
				spectate?: string; // the secret for spectating a game
				match?: string; // the secret for a specific instanced match
			};
			instance?: boolean;
			flags: string; // activity flags OR d together, describes what the payload includes
		}
	];
	since?: number; // unix time (in milliseconds) of when the client went idle, or null if the client is not idle
}