-
Notifications
You must be signed in to change notification settings - Fork 1
/
plugin.d.ts
327 lines (278 loc) · 8 KB
/
plugin.d.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
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
//Reference Scriptfile
//Intended exclusively for auto-complete in your IDE, not for execution
declare class ScriptException extends Error {
constructor(type: string, msg: string);
}
declare class TimeoutException extends ScriptException {
constructor(msg: string);
}
declare class Thumbnails {
constructor(thumbnails: Thumbnail[])
}
declare class Thumbnail {
constructor(url: string, quality: number, type: string);
}
declare class PlatformID {
constructor(platform: string, id: string, pluginId: string);
}
declare class ResultCapabilities {
constructor(types: string[], sorts: string[], filters: FilterGroup[])
}
declare class FilterGroup {
constructor(name: string, filters: string[], isMultiSelect: boolean, id: string);
}
declare class FilterCapability {
constructor(name: string, value: string, id: string);
}
declare class PlatformAuthorLink {
constructor(id: PlatformID, name: string, url: string, thumbnail: string, subscribers: number);
}
declare interface PlatformVideoDef {
id: PlatformID,
name: string,
alternativeName?: string;
thumbnails: Thumbnails,
author: PlatformAuthorLink,
uploadDate: number,
url: string,
duration: number,
viewCount: number,
isLive: boolean
}
declare class PlatformVideo implements PlatformVideoDef {
id: PlatformID;
name: string;
alternativeName?: string;
thumbnails: Thumbnails;
author: PlatformAuthorLink;
uploadDate: number;
url: string;
duration: number;
viewCount: number;
isLive: boolean;
constructor(obj: PlatformVideoDef);
}
declare interface PlatformVideoDetailsDef extends PlatformVideoDef {
description: string,
video: VideoSourceDescriptor,
dash?: DashSource,
hls?: HLSSource,
live: SubtitleSource[]
}
declare class PlatformVideoDetails extends PlatformVideo {
constructor(obj: PlatformVideoDetailsDef);
}
//Sources
declare interface IVideoSourceDescriptor {}
declare interface MuxVideoSourceDescriptorDef {
isUnMuxed: boolean,
videoSources: VideoSource[]
}
declare class MuxVideoSourceDescriptor implements IVideoSourceDescriptor {
constructor(obj: VideoSourceDescriptorDef);
}
declare interface UnMuxVideoSourceDescriptorDef {
isUnMuxed: boolean,
videoSources: VideoSource[]
}
class UnMuxVideoSourceDescriptor implements IVideoSourceDescriptor {
constructor(videoSourcesOrObj: VideoSource[], audioSources: AudioSource[]);
constructor(videoSourcesOrObj: UnMuxVideoSourceDescriptorDef);
}
declare interface IVideoSource {
}
declare interface IAudioSource {
}
interface VideoUrlSourceDef implements IVideoSource {
width: number,
height: number,
container: string,
codec: string,
name: string,
bitrate: number,
duration: number,
url: string
}
class VideoUrlSource {
constructor(obj: VideoUrlSourceDef);
}
interface YTVideoSourceDef extends VideoUrlSource {
itagId: number,
initStart: number,
initEnd: number,
indexStart: number,
indexEnd: number,
}
class YTVideoSource extends VideoUrlSource {
constructor(obj: YTVideoSourceDef);
}
interface AudioUrlSourceDef {
name: string,
bitrate: number,
container: string,
codecs: string,
duration: number,
url: string,
language: string
}
class AudioUrlSource implements IAudioSource {
constructor(obj: AudioUrlSourceDef);
}
interface YTAudioSourceDef extends AudioUrlSource {
itagId: number,
initStart: number,
initEnd: number,
indexStart: number,
indexEnd: number,
audioChannels: number
}
class YTAudioSource extends AudioUrlSource {
constructor(obj: YTAudioSourceDef);
}
interface HLSSourceDef {
name: string,
duration: number,
url: string
}
class HLSSource implements IVideoSource {
constructor(obj: HLSSourceDef);
}
interface DashSourceDef {
name: string,
duration: number,
url: string
}
class DashSource implements IVideoSource {
constructor(obj: DashSourceDef)
}
//Channel
interface PlatformChannelDef {
id: string,
name: string,
thumbnail: string,
banner: string,
subscribers: number,
description: string,
url: string,
links?: Map<string>
}
class PlatformChannel {
constructor(obj: PlatformChannelDef);
}
//Ratings
interface IRating {
type: number
}
declare class RatingLikes implements IRating {
constructor(likes: number);
}
declare class RatingLikesDislikes implements IRating {
constructor(likes: number, dislikes: number);
}
declare class RatingScaler implements IRating {
constructor(value: number);
}
declare interface CommentDef {
contextUrl: string,
author: PlatformAuthorLink,
message: string,
rating: IRating,
date: number,
replyCount: number,
context: any
}
declare class Comment {
constructor(obj: CommentDef);
}
declare class LiveEventPager {
nextRequest: number;
constructor(results: ILiveEvent[], hasMore: boolean, context: any);
hasMorePagers(): boolean
nextPage(): LiveEventPager; //Could be self
}
class ILiveEvent {
type: String
}
declare class LiveEventComment extends ILiveEvent {
constructor(name: string, message: string, thumbnail?: string);
}
declare class LiveEventDonation extends ILiveEvent {
constructor(amount: number, name: string, message: string, thumbnail?: string);
}
declare class LiveEventViewCount extends ILiveEvent {
constructor(viewCount: number);
}
declare class LiveEventRaid extends ILiveEvent {
constructor(targetUrl: string, targetName: string, targetThumbnail: string);
}
//Pagers
declare class VideoPager {
constructor(results: PlatformVideo[], hasMore: boolean, context: any);
hasMorePagers(): boolean
nextPage(): VideoPager; //Could be self
}
declare class ChannelPager {
constructor(results: PlatformVideo[], hasMore: boolean, context: any);
hasMorePagers(): boolean;
nextPage(): ChannelPager; //Could be self
}
declare class CommentPager {
constructor(results: PlatformVideo[], hasMore: boolean, context: any);
hasMorePagers(): boolean
nextPage(): CommentPager; //Could be self
}
interface Map<T> {
[Key: string]: T;
}
//To override by plugin
declare const SET_ALTERNATIVE_METADATA: boolean;
interface Source {
getHome(): VideoPager;
enable(config: SourceConfig);
disable();
searchSuggestions(query: string): string[];
search(query: string, type: string, order: string, filters): VideoPager;
getSearchCapabilities(): ResultCapabilities
//Optional
searchChannelVideos(channelUrl: string, query: string, type: string, order: string, filters): VideoPager;
//Optional
getSearchChannelVideoCapabilities(): ResultCapabilities;
isChannelUrl(url: string): boolean;
getChannel(url: string): PlatformChannel;
getChannelVideos(url: string, type: string, order: string, filters): VideoPager;
getChannelCapabilities(): ResultCapabilities;
isVideoDetailsUrl(url: string): boolean;
getVideoDetails(url: string): PlatformVideoDetails;
//Optional
getComments(url: string): CommentPager;
//Optional
getSubComments(comment: Comment): CommentPager;
//Optional
getUserSubscriptions(): string[];
//Optional
getUserPlaylists(): string[];
//Optional
isPlaylistUrl(url: string): boolean;
//Optional
getPlaylist(url): string[];
}
const source: Source;
interface BridgeHttpResponse {
isOk: boolean;
code: number;
body?: string;
headers?: Record<string, string[]>;
}
interface PackageHttpMethods<R = BridgeHttpResponse> {
GET(url: string, headers: Record<string, string[]>): R;
POST(url: string, contentType: string, body: string, headers: Record<string, string[]>): R;
request(method: string, url: string, headers: Record<string, string[]>): R;
requestWithBody(method: string, url: string, body: string, headers: Record<string, string[]>): R;
}
interface PackageHttpBatch extends PackageHttpMethods<PackageHttpBatch> {
execute(): BridgeHttpResponse[];
}
interface PackageHttp extends PackageHttpMethods<BridgeHttpResponse> {
batch(): PackageHttpBatch;
}
const http: PackageHttp;