/
types.ts
198 lines (167 loc) · 4.26 KB
/
types.ts
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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
import PubNub, {
ChannelMetadataObject,
ObjectCustom,
PublishParameters,
SendFileParameters,
} from "pubnub"
import { User } from "./entities/user"
import { Message } from "./entities/message"
import { Event } from "./entities/event"
import { Channel } from "./entities/channel"
import { ThreadChannel } from "./entities/thread-channel"
export type ChannelType = "direct" | "group" | "public"
export enum MessageType {
TEXT = "text",
}
export enum MessageActionType {
REACTIONS = "reactions",
DELETED = "deleted",
EDITED = "edited",
}
export type TextMessageContent = {
type: MessageType.TEXT
text: string
files?: { name: string; id: string; url: string; type?: string }[]
}
export type EventContent = {
typing: {
value: boolean
}
report: {
text?: string
reason: string
reportedMessageTimetoken?: string
reportedMessageChannelId?: string
reportedUserId?: string
}
receipt: {
messageTimetoken: string
}
mention: {
messageTimetoken: string
channel: string
}
invite: {
channelType: ChannelType | "unknown"
channelId: string
}
custom: any
}
export type EventType = keyof EventContent
export type MessageActions = {
[type: string]: {
[value: string]: Array<{
uuid: string
actionTimetoken: string | number
}>
}
}
export type DeleteParameters = {
soft?: boolean
}
export type MessageMentionedUsers = {
[nameOccurrenceIndex: number]: {
id: string
name: string
}
}
export type MessageReferencedChannels = {
[nameOccurrenceIndex: number]: {
id: string
name: string
}
}
export type MessageDraftOptions = Omit<PublishParameters, "message" | "channel">
export type SendTextOptionParams = Omit<PublishParameters, "message" | "channel"> & {
mentionedUsers?: MessageMentionedUsers
referencedChannels?: MessageReferencedChannels
textLinks?: TextLink[]
quotedMessage?: Message
files?: FileList | File[] | SendFileParameters["file"][]
}
export type EnhancedMessageEvent = PubNub.MessageEvent & {
userMetadata?: {
[key: string]: any
}
}
export type MessageDTOParams =
| PubNub.FetchMessagesResponse["channels"]["channel"][0]
| EnhancedMessageEvent
export type ThreadMessageDTOParams = MessageDTOParams & { parentChannelId: string }
export type MembershipResponse = Awaited<ReturnType<User["getMemberships"]>>
export type OptionalAllBut<T, K extends keyof T> = Partial<T> & Pick<T, K>
export type ChannelDTOParams = OptionalAllBut<ChannelMetadataObject<ObjectCustom>, "id"> & {
status?: string
type?: ChannelType
}
export type ThreadChannelDTOParams = ChannelDTOParams & {
parentChannelId: string
parentMessage: Message
}
export type MessageDraftConfig = {
userSuggestionSource: "channel" | "global"
isTypingIndicatorTriggered: boolean
userLimit: number
channelLimit: number
}
export type TextLink = {
startIndex: number
endIndex: number
link: string
}
export type GetLinkedTextParams = {
mentionedUserRenderer: (userId: string, mentionedName: string) => any
plainLinkRenderer: (link: string) => any
textLinkRenderer: (text: string, link: string) => any
}
export type PayloadForTextTypes = {
text: {
text: string
}
mention: {
name: string
id: string
}
plainLink: {
link: string
}
textLink: {
text: string
link: string
}
channelReference: {
name: string
id: string
}
}
export type TextTypes = keyof PayloadForTextTypes
export type TextTypeElement<T extends TextTypes> = { type: T; content: PayloadForTextTypes[T] }
export type MixedTextTypedElement =
| TextTypeElement<"text">
| TextTypeElement<"mention">
| TextTypeElement<"plainLink">
| TextTypeElement<"textLink">
| TextTypeElement<"channelReference">
export type ErrorLoggerSetParams = {
key: string
error: unknown
thrownFunctionArguments: IArguments
}
export declare class ErrorLoggerImplementation {
setItem(key: string, params: ErrorLoggerSetParams): void
getStorageObject(): Record<string, unknown>
}
export type ChannelMentionData = {
event: Event<"mention">
channelId: string
message: Message
userId: string
}
export type ThreadMentionData = {
event: Event<"mention">
parentChannelId: string
threadChannelId: string
message: Message
userId: string
}
export type UserMentionData = ChannelMentionData | ThreadMentionData