summary refs log tree commit diff
path: root/src/schemas/api/reports/ReportMenu.ts
blob: 3c47e194ebdf9009d513a20f932b8b5602e47297 (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
87
88
89
90
91
92
93
94
95
96
/*
	Spacebar: A FOSS re-implementation and extension of the Discord.com backend.
	Copyright (C) 2025 Spacebar and Spacebar Contributors

	This program is free software: you can redistribute it and/or modify
	it under the terms of the GNU Affero General Public License as published
	by the Free Software Foundation, either version 3 of the License, or
	(at your option) any later version.

	This program is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
	GNU Affero General Public License for more details.

	You should have received a copy of the GNU Affero General Public License
	along with this program.  If not, see <https://www.gnu.org/licenses/>.
*/

export enum ReportMenuType {
    GUILD = "guild",
    GUILD_DISCOVERY = "guild_discovery",
    GUILD_DIRECTORY_ENTRY = "guild_directory_entry",
    GUILD_SCHEDULED_EVENT = "guild_scheduled_event",
    MESSAGE = "message",
    STAGE_CHANNEL = "stage_channel",
    FIRST_DM = "first_dm",
    USER = "user",
    APPLICATION = "application",
    WIDGET = "widget",
}

export type ReportMenuTypeNameArray = ReportMenuType[];
export const ReportMenuTypeNames: Record<ReportMenuType, string> = {
    [ReportMenuType.GUILD]: "guild",
    [ReportMenuType.GUILD_DISCOVERY]: "guild_discovery",
    [ReportMenuType.GUILD_DIRECTORY_ENTRY]: "guild_directory_entry",
    [ReportMenuType.GUILD_SCHEDULED_EVENT]: "guild_scheduled_event",
    [ReportMenuType.MESSAGE]: "message",
    [ReportMenuType.STAGE_CHANNEL]: "stage_channel",
    [ReportMenuType.FIRST_DM]: "first_dm",
    [ReportMenuType.USER]: "user",
    [ReportMenuType.APPLICATION]: "application",
    [ReportMenuType.WIDGET]: "widget",
};

export enum ReportButtonType {
    SUBMIT = "submit",
    DONE = "done",
    CANCEL = "cancel",
    NEXT = "next",
}

export interface ReportingMenuResponse {
    name: string;
    version: string;
    variant: string;
    postback_url: string;
    language?: string;
    root_node_id: number;
    success_node_id: number;
    fail_node_id: number;
    nodes: Record<number, ReportNode>;
}

export interface ReportNode {
    id: number;
    report_type?: string;
    key: string;
    header: string;
    subheader?: string;
    info?: string;
    children: ReportNodeChild[];
    elements: ReportElement[];
    button?: ReportButton;
    is_multi_select_required: boolean;
    is_auto_submit: boolean;
}

export interface ReportButton {
    type: ReportButtonType;
    target: number | null;
}

export interface ReportNodeChild {
    name: string;
    target_node_id: number;
}

export interface ReportElement {
    name: string;
    type: string;
    data: object;
    should_submit_data: boolean;
    skip_if_unlocalized: boolean;
    is_localized: boolean;
}