summary refs log tree commit diff
path: root/src/schemas/uncategorised/MessageCreateSchema.ts
blob: 069e4841787b244860629bb6aceba8cf3c9bb70a (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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
/*
	Spacebar: A FOSS re-implementation and extension of the Discord.com backend.
	Copyright (C) 2023 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/>.
*/

import { Snowflake } from "../Identifiers";
import {
    InteractionType,
    AllowedMentions,
    MessageReference,
    ApplicationCommandType,
    BaseMessageComponents,
    Embed,
    PollAnswer,
    PollMedia,
    PublicUser,
    float,
    base64str,
} from "@spacebar/schemas";

export type BaseMessageCreateAttachment = {
    filename: string;
    title?: string; // clips only?
    description?: string; // alt text

    duration_secs?: float; //flat
    waveform?: base64str; //base64 byte array

    is_clip?: boolean;
    is_thumbnail?: boolean;
    is_remix?: boolean;
    is_spoiler?: boolean;

    clip_created_at?: Date;
    clip_participant_ids?: Snowflake[];
};

export type MessageCreateAttachment = BaseMessageCreateAttachment & {
    id: string;
};

export type MessageCreateCloudAttachment = BaseMessageCreateAttachment & {
    id?: string;
    uploaded_filename: string;
    original_content_type?: string;
};

export interface MessageCreateSchema {
    type?: number;
    content?: string;
    mobile_network_type?: string;
    nonce?: string;
    channel_id?: string;
    tts?: boolean;
    flags?: number;
    embeds?: Embed[] | null;
    embed?: Embed | null;
    // TODO: ^ embed is deprecated in favor of embeds (https://discord.com/developers/docs/resources/channel#message-object)
    allowed_mentions?: AllowedMentions | null;
    message_reference?: MessageReference | null;
    payload_json?: string;
    file?: { filename: string };
    // TODO: we should create an interface for attachments
    attachments?: (MessageCreateAttachment | MessageCreateCloudAttachment)[];
    sticker_ids?: string[] | null;
    components?: BaseMessageComponents[] | null;
    poll?: PollCreationSchema | null;
    enforce_nonce?: boolean; // For Discord compatibility, it's the default behavior here
    applied_tags?: string[]; // TODO: Not implemented yet, for webhooks in forums
    thread_name?: string; // TODO: Not implemented yet, for webhooks
    avatar_url?: string; // TODO: Not implemented yet, for webhooks
    interaction?: MessageInteractionSchema;
    interaction_metadata?: MessageInteractionSchema;
}

// TypeScript complains once this is used above
export interface PollCreationSchema {
    question: PollMedia;
    answers: PollAnswer[];
    duration?: number;
    allow_multiselect?: boolean;
    layout_type?: number;
}

interface MessageInteractionSchema {
    id: string;
    type: InteractionType;
    name: string;
    command_type?: ApplicationCommandType;
    ephemerality_reason?: number;
    user?: PublicUser; // It has to be optional cause LSP gives an errors for some reason
    user_id?: string;
    authorizing_integration_owners?: object; // It has to be optional cause LSP gives an errors for some reason
    original_response_message_id?: Snowflake;
    interacted_message_id?: Snowflake;
    triggering_interaction_metadata?: MessageInteractionSchema;
    target_user?: PublicUser;
    target_message_id?: Snowflake;
}