@letsmoe/otter-sdk 0.0.0-stage → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +185 -2
- package/package.json +40 -4
- package/src/aes-gcm.ts +189 -0
- package/src/browser.ts +39 -0
- package/src/client.ts +23 -0
- package/src/context.ts +87 -0
- package/src/definition.ts +104 -0
- package/src/errors.ts +85 -0
- package/src/extract.ts +134 -0
- package/src/generated/index.ts +79 -0
- package/src/generated/runtime/batcher.ts +275 -0
- package/src/generated/runtime/createClient.ts +68 -0
- package/src/generated/runtime/error.ts +29 -0
- package/src/generated/runtime/fetcher.ts +97 -0
- package/src/generated/runtime/generateGraphqlOperation.ts +225 -0
- package/src/generated/runtime/index.ts +13 -0
- package/src/generated/runtime/linkTypeMap.ts +156 -0
- package/src/generated/runtime/typeSelection.ts +95 -0
- package/src/generated/runtime/types.ts +69 -0
- package/src/generated/schema.graphql +838 -0
- package/src/generated/schema.ts +1611 -0
- package/src/generated/types.ts +1744 -0
- package/src/hosters/dead-link.ts +55 -0
- package/src/hosters/dood.ts +69 -0
- package/src/hosters/filemoon.ts +152 -0
- package/src/hosters/generic.ts +63 -0
- package/src/hosters/index.ts +14 -0
- package/src/hosters/recaptcha.ts +61 -0
- package/src/hosters/registry.ts +74 -0
- package/src/hosters/streamtape.ts +63 -0
- package/src/hosters/vidara.ts +48 -0
- package/src/hosters/vinovo.ts +55 -0
- package/src/hosters/voe-decoding.ts +131 -0
- package/src/hosters/voe-domains.ts +39 -0
- package/src/hosters/voe.ts +95 -0
- package/src/http-client.ts +295 -0
- package/src/http.ts +97 -0
- package/src/index.ts +10 -0
- package/src/languages.ts +73 -0
- package/src/match.ts +120 -0
- package/src/model.ts +110 -0
- package/src/packer.ts +106 -0
- package/src/plugin.ts +4 -0
- package/src/run.ts +88 -0
- package/src/runtime.ts +274 -0
- package/src/testing.ts +123 -0
- package/src/timing.ts +11 -0
- package/src/types.ts +148 -0
- package/src/url.ts +60 -0
|
@@ -0,0 +1,838 @@
|
|
|
1
|
+
enum MediaType {
|
|
2
|
+
MOVIE
|
|
3
|
+
SERIES
|
|
4
|
+
EPISODE
|
|
5
|
+
}
|
|
6
|
+
|
|
7
|
+
"""A movie or a series."""
|
|
8
|
+
type Title {
|
|
9
|
+
id: ID!
|
|
10
|
+
mediaType: MediaType!
|
|
11
|
+
tmdbId: Int!
|
|
12
|
+
imdbId: String
|
|
13
|
+
title: String!
|
|
14
|
+
originalTitle: String
|
|
15
|
+
overview: String
|
|
16
|
+
tagline: String
|
|
17
|
+
|
|
18
|
+
"""Release date of a movie, first air date of a series."""
|
|
19
|
+
releaseDate: String
|
|
20
|
+
year: Int
|
|
21
|
+
|
|
22
|
+
"""Minutes; movies only."""
|
|
23
|
+
runtime: Int
|
|
24
|
+
status: String
|
|
25
|
+
voteAverage: Float!
|
|
26
|
+
voteCount: Int!
|
|
27
|
+
popularity: Float!
|
|
28
|
+
posterPath: String
|
|
29
|
+
backdropPath: String
|
|
30
|
+
logoPath: String
|
|
31
|
+
|
|
32
|
+
"""YouTube key of the trailer."""
|
|
33
|
+
trailerKey: String
|
|
34
|
+
genres: [String!]!
|
|
35
|
+
keywords: [String!]!
|
|
36
|
+
|
|
37
|
+
"""
|
|
38
|
+
False for titles only seen in lists; reading them through Query.title fetches the rest.
|
|
39
|
+
"""
|
|
40
|
+
detailFetched: Boolean!
|
|
41
|
+
credits: [Credit!]!
|
|
42
|
+
|
|
43
|
+
"""TMDB recommendations first, then other work of the director and leads."""
|
|
44
|
+
related(limit: Int = 20): [Title!]!
|
|
45
|
+
|
|
46
|
+
"""Series only."""
|
|
47
|
+
seasons: [Season!]!
|
|
48
|
+
|
|
49
|
+
"""
|
|
50
|
+
Series only: regular seasons, without specials. 0 until the detail was fetched.
|
|
51
|
+
"""
|
|
52
|
+
seasonCount: Int!
|
|
53
|
+
|
|
54
|
+
"""Movies only. Stored links; Subscription.streams finds new ones."""
|
|
55
|
+
streams: [Stream!]!
|
|
56
|
+
progress(profileId: ID!): WatchProgress
|
|
57
|
+
rating(profileId: ID!): Float
|
|
58
|
+
inWatchlist(profileId: ID!): Boolean!
|
|
59
|
+
|
|
60
|
+
"""
|
|
61
|
+
Whether the profile gets news about this title: the Notify me bell's choice, else whether it is on My List.
|
|
62
|
+
"""
|
|
63
|
+
notifying(profileId: ID!): Boolean!
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
type Season {
|
|
67
|
+
id: ID!
|
|
68
|
+
seasonNumber: Int!
|
|
69
|
+
name: String
|
|
70
|
+
overview: String
|
|
71
|
+
airDate: String
|
|
72
|
+
posterPath: String
|
|
73
|
+
episodeCount: Int!
|
|
74
|
+
|
|
75
|
+
"""Fetched from TMDB on first read."""
|
|
76
|
+
episodes: [Episode!]!
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
type Episode {
|
|
80
|
+
id: ID!
|
|
81
|
+
tmdbId: Int!
|
|
82
|
+
seasonNumber: Int!
|
|
83
|
+
episodeNumber: Int!
|
|
84
|
+
name: String
|
|
85
|
+
overview: String
|
|
86
|
+
airDate: String
|
|
87
|
+
runtime: Int
|
|
88
|
+
stillPath: String
|
|
89
|
+
voteAverage: Float!
|
|
90
|
+
series: Title!
|
|
91
|
+
streams: [Stream!]!
|
|
92
|
+
progress(profileId: ID!): WatchProgress
|
|
93
|
+
|
|
94
|
+
"""The episode after this one, crossing seasons."""
|
|
95
|
+
next: Episode
|
|
96
|
+
|
|
97
|
+
"""
|
|
98
|
+
Parts viewers skip (intro, recap, credits, preview), from TheIntroDB; empty when nobody timed them.
|
|
99
|
+
"""
|
|
100
|
+
skipSegments: [SkipSegment!]!
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
"""A skippable part of an episode."""
|
|
104
|
+
type SkipSegment {
|
|
105
|
+
"""intro, recap, credits or preview"""
|
|
106
|
+
kind: String!
|
|
107
|
+
startSeconds: Float!
|
|
108
|
+
|
|
109
|
+
"""Null when it runs to the end."""
|
|
110
|
+
endSeconds: Float
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
type Person {
|
|
114
|
+
id: ID!
|
|
115
|
+
tmdbId: Int!
|
|
116
|
+
name: String!
|
|
117
|
+
profilePath: String
|
|
118
|
+
biography: String
|
|
119
|
+
birthday: String
|
|
120
|
+
deathday: String
|
|
121
|
+
placeOfBirth: String
|
|
122
|
+
knownForDepartment: String
|
|
123
|
+
|
|
124
|
+
"""
|
|
125
|
+
Titles the person is credited on, newest first; job (e.g. "Director") keeps only those crew credits.
|
|
126
|
+
"""
|
|
127
|
+
filmography(job: String): [Title!]!
|
|
128
|
+
|
|
129
|
+
"""
|
|
130
|
+
Actors who appear most often alongside this person in their best-known roles.
|
|
131
|
+
"""
|
|
132
|
+
coStars(limit: Int = 12): [CoStar!]!
|
|
133
|
+
|
|
134
|
+
"""
|
|
135
|
+
This person's titles that fit the profile's taste best, without disliked or finished ones.
|
|
136
|
+
"""
|
|
137
|
+
recommendedFor(profileId: ID!, limit: Int = 20): [Title!]!
|
|
138
|
+
}
|
|
139
|
+
|
|
140
|
+
type CoStar {
|
|
141
|
+
person: Person!
|
|
142
|
+
|
|
143
|
+
"""How many of this person's titles they share."""
|
|
144
|
+
sharedTitles: Int!
|
|
145
|
+
}
|
|
146
|
+
|
|
147
|
+
type Credit {
|
|
148
|
+
person: Person!
|
|
149
|
+
|
|
150
|
+
"""cast or crew"""
|
|
151
|
+
role: String!
|
|
152
|
+
job: String
|
|
153
|
+
character: String
|
|
154
|
+
order: Int!
|
|
155
|
+
}
|
|
156
|
+
|
|
157
|
+
type Stream {
|
|
158
|
+
id: ID!
|
|
159
|
+
plugin: String!
|
|
160
|
+
url: String!
|
|
161
|
+
label: String
|
|
162
|
+
quality: String
|
|
163
|
+
language: String
|
|
164
|
+
format: String
|
|
165
|
+
sizeBytes: Float
|
|
166
|
+
speedBps: Float
|
|
167
|
+
|
|
168
|
+
"""Null until someone tried to play it."""
|
|
169
|
+
playable: Boolean
|
|
170
|
+
foundAt: String!
|
|
171
|
+
}
|
|
172
|
+
|
|
173
|
+
type StreamUpdate {
|
|
174
|
+
streams: [Stream!]!
|
|
175
|
+
|
|
176
|
+
"""True on the last update of a lookup."""
|
|
177
|
+
done: Boolean!
|
|
178
|
+
}
|
|
179
|
+
|
|
180
|
+
type ResolvedStream {
|
|
181
|
+
"""Playable URL, proxied through the backend when the host needs headers."""
|
|
182
|
+
url: String!
|
|
183
|
+
mimeType: String!
|
|
184
|
+
quality: String
|
|
185
|
+
|
|
186
|
+
"""The stored link this was resolved from."""
|
|
187
|
+
streamId: ID
|
|
188
|
+
}
|
|
189
|
+
|
|
190
|
+
type WatchProgress {
|
|
191
|
+
mediaId: ID!
|
|
192
|
+
progressSeconds: Float!
|
|
193
|
+
durationSeconds: Float!
|
|
194
|
+
completed: Boolean!
|
|
195
|
+
updatedAt: String!
|
|
196
|
+
}
|
|
197
|
+
|
|
198
|
+
type ContinueItem {
|
|
199
|
+
title: Title!
|
|
200
|
+
|
|
201
|
+
"""For series: the episode to continue or the next one."""
|
|
202
|
+
episode: Episode
|
|
203
|
+
progress: WatchProgress
|
|
204
|
+
}
|
|
205
|
+
|
|
206
|
+
type HistoryEntry {
|
|
207
|
+
title: Title!
|
|
208
|
+
episode: Episode
|
|
209
|
+
progress: WatchProgress!
|
|
210
|
+
}
|
|
211
|
+
|
|
212
|
+
type Recommendation {
|
|
213
|
+
title: Title!
|
|
214
|
+
|
|
215
|
+
"""Why, e.g. "Because you watched Heat"."""
|
|
216
|
+
reason: String!
|
|
217
|
+
source: String!
|
|
218
|
+
score: Float!
|
|
219
|
+
}
|
|
220
|
+
|
|
221
|
+
"""
|
|
222
|
+
Narrows search results; omitted fields don't filter. Runtime is in minutes.
|
|
223
|
+
"""
|
|
224
|
+
input TitleFilter {
|
|
225
|
+
minRating: Float
|
|
226
|
+
minRuntime: Int
|
|
227
|
+
maxRuntime: Int
|
|
228
|
+
minSeasons: Int
|
|
229
|
+
maxSeasons: Int
|
|
230
|
+
}
|
|
231
|
+
|
|
232
|
+
"""Titles featuring the lead actor of a title the profile rated well."""
|
|
233
|
+
type MoreWithRow {
|
|
234
|
+
person: Person!
|
|
235
|
+
becauseOf: Title!
|
|
236
|
+
items: [Title!]!
|
|
237
|
+
}
|
|
238
|
+
|
|
239
|
+
type RecommendationRow {
|
|
240
|
+
key: String!
|
|
241
|
+
title: String!
|
|
242
|
+
items: [Title!]!
|
|
243
|
+
}
|
|
244
|
+
|
|
245
|
+
type Profile {
|
|
246
|
+
id: ID!
|
|
247
|
+
name: String!
|
|
248
|
+
avatarUrl: String
|
|
249
|
+
hasPin: Boolean!
|
|
250
|
+
isChild: Boolean!
|
|
251
|
+
|
|
252
|
+
"""
|
|
253
|
+
Audio languages, most preferred first (ISO 639-1, e.g. de, en). Links in these languages are tried first, dubs before subs.
|
|
254
|
+
"""
|
|
255
|
+
languages: [String!]!
|
|
256
|
+
|
|
257
|
+
"""Show captions by default"""
|
|
258
|
+
subtitlesEnabled: Boolean!
|
|
259
|
+
|
|
260
|
+
"""
|
|
261
|
+
Preferred caption language (ISO 639-1); null = the profile's first language
|
|
262
|
+
"""
|
|
263
|
+
subtitleLanguage: String
|
|
264
|
+
subtitleSize: SubtitleSize!
|
|
265
|
+
|
|
266
|
+
"""Boost dialogue over music and effects"""
|
|
267
|
+
voiceBoost: Boolean!
|
|
268
|
+
}
|
|
269
|
+
|
|
270
|
+
"""
|
|
271
|
+
An external subtitle file for a movie or episode, found by a subtitles plugin.
|
|
272
|
+
"""
|
|
273
|
+
type Subtitle {
|
|
274
|
+
id: ID!
|
|
275
|
+
|
|
276
|
+
"""ISO 639-1, e.g. de, en"""
|
|
277
|
+
language: String!
|
|
278
|
+
|
|
279
|
+
"""Display label, e.g. 'Deutsch' or 'English (SDH)'"""
|
|
280
|
+
label: String!
|
|
281
|
+
|
|
282
|
+
"""Release name the file was made for, when the source says"""
|
|
283
|
+
release: String
|
|
284
|
+
hearingImpaired: Boolean!
|
|
285
|
+
|
|
286
|
+
"""Plugin that found it"""
|
|
287
|
+
source: String!
|
|
288
|
+
|
|
289
|
+
"""
|
|
290
|
+
Path on the backend, e.g. /api/subtitles/<id>.vtt; clients prefix their backend origin
|
|
291
|
+
"""
|
|
292
|
+
vttUrl: String!
|
|
293
|
+
|
|
294
|
+
"""Same file as SRT (for DLNA TVs), /api/subtitles/<id>.srt"""
|
|
295
|
+
srtUrl: String!
|
|
296
|
+
}
|
|
297
|
+
|
|
298
|
+
enum SubtitleSize {
|
|
299
|
+
SMALL
|
|
300
|
+
MEDIUM
|
|
301
|
+
LARGE
|
|
302
|
+
}
|
|
303
|
+
|
|
304
|
+
type PinCheck {
|
|
305
|
+
success: Boolean!
|
|
306
|
+
|
|
307
|
+
"""After a failure, seconds until the next attempt is allowed."""
|
|
308
|
+
waitSeconds: Int!
|
|
309
|
+
}
|
|
310
|
+
|
|
311
|
+
enum TmdbKeyStatus {
|
|
312
|
+
OK
|
|
313
|
+
MISSING
|
|
314
|
+
|
|
315
|
+
"""TMDB rejected the key in use."""
|
|
316
|
+
INVALID
|
|
317
|
+
}
|
|
318
|
+
|
|
319
|
+
type Settings {
|
|
320
|
+
"""The user's own key; empty while the built-in one is used."""
|
|
321
|
+
tmdbApiKey: String!
|
|
322
|
+
tmdbLanguage: String!
|
|
323
|
+
tmdbKeyStatus: TmdbKeyStatus!
|
|
324
|
+
usesDefaultTmdbKey: Boolean!
|
|
325
|
+
|
|
326
|
+
"""Whether this build has a built-in key to fall back to (in use or not)."""
|
|
327
|
+
hasDefaultTmdbKey: Boolean!
|
|
328
|
+
|
|
329
|
+
"""Whether the first-run TMDB key dialog was answered."""
|
|
330
|
+
tmdbKeyPromptSeen: Boolean!
|
|
331
|
+
requireVpn: Boolean!
|
|
332
|
+
|
|
333
|
+
"""Whether errors are sent to the developers (PostHog error tracking)."""
|
|
334
|
+
errorReporting: Boolean!
|
|
335
|
+
|
|
336
|
+
"""
|
|
337
|
+
Whether every TV cast is logged in detail, not only failed ones (opt-in).
|
|
338
|
+
"""
|
|
339
|
+
castLogs: Boolean!
|
|
340
|
+
disabledPlugins: [String!]!
|
|
341
|
+
}
|
|
342
|
+
|
|
343
|
+
input SettingsInput {
|
|
344
|
+
tmdbApiKey: String
|
|
345
|
+
tmdbLanguage: String
|
|
346
|
+
tmdbKeyPromptSeen: Boolean
|
|
347
|
+
requireVpn: Boolean
|
|
348
|
+
errorReporting: Boolean
|
|
349
|
+
castLogs: Boolean
|
|
350
|
+
}
|
|
351
|
+
|
|
352
|
+
type PluginSettingField {
|
|
353
|
+
key: String!
|
|
354
|
+
label: String!
|
|
355
|
+
description: String
|
|
356
|
+
type: String!
|
|
357
|
+
required: Boolean!
|
|
358
|
+
default: String
|
|
359
|
+
value: String
|
|
360
|
+
}
|
|
361
|
+
|
|
362
|
+
input PluginSettingInput {
|
|
363
|
+
key: String!
|
|
364
|
+
value: String!
|
|
365
|
+
}
|
|
366
|
+
|
|
367
|
+
type Plugin {
|
|
368
|
+
name: String!
|
|
369
|
+
displayName: String
|
|
370
|
+
description: String
|
|
371
|
+
icon: String
|
|
372
|
+
version: String!
|
|
373
|
+
capabilities: [String!]!
|
|
374
|
+
enabled: Boolean!
|
|
375
|
+
|
|
376
|
+
"""
|
|
377
|
+
False when the plugin needs something missing here (e.g. FlareSolverr).
|
|
378
|
+
"""
|
|
379
|
+
available: Boolean!
|
|
380
|
+
settings: [PluginSettingField!]!
|
|
381
|
+
|
|
382
|
+
"""Set when the plugin's site needs the user's account."""
|
|
383
|
+
account: PluginAccount
|
|
384
|
+
}
|
|
385
|
+
|
|
386
|
+
"""A plugin's login on its site. The password is never returned."""
|
|
387
|
+
type PluginAccount {
|
|
388
|
+
"""Where users without an account can make one."""
|
|
389
|
+
signupUrl: String
|
|
390
|
+
|
|
391
|
+
"""Null while no account is saved."""
|
|
392
|
+
username: String
|
|
393
|
+
loggedIn: Boolean!
|
|
394
|
+
|
|
395
|
+
"""Why the last login failed."""
|
|
396
|
+
error: String
|
|
397
|
+
}
|
|
398
|
+
|
|
399
|
+
type Status {
|
|
400
|
+
tmdbConfigured: Boolean!
|
|
401
|
+
|
|
402
|
+
"""
|
|
403
|
+
False while the last TMDB request got no answer (offline, or a VPN or DNS filter blocks it).
|
|
404
|
+
"""
|
|
405
|
+
tmdbReachable: Boolean!
|
|
406
|
+
|
|
407
|
+
"""Whether the backend's traffic to the internet goes through a VPN."""
|
|
408
|
+
vpnConnected: Boolean!
|
|
409
|
+
|
|
410
|
+
"""
|
|
411
|
+
A VPN is up, but Otter's traffic skips it (e.g. Otter is excluded by the VPN's split tunnelling).
|
|
412
|
+
"""
|
|
413
|
+
vpnBypassed: Boolean!
|
|
414
|
+
requireVpn: Boolean!
|
|
415
|
+
}
|
|
416
|
+
|
|
417
|
+
enum NotificationKind {
|
|
418
|
+
"""A movie on the list got its first stream links."""
|
|
419
|
+
AVAILABLE
|
|
420
|
+
|
|
421
|
+
"""A series on the list aired a new episode."""
|
|
422
|
+
NEW_EPISODE
|
|
423
|
+
|
|
424
|
+
"""A movie or episode on the list releases soon."""
|
|
425
|
+
COMING_SOON
|
|
426
|
+
}
|
|
427
|
+
|
|
428
|
+
type Notification {
|
|
429
|
+
id: ID!
|
|
430
|
+
kind: NotificationKind!
|
|
431
|
+
|
|
432
|
+
"""E.g. "Now available", "Coming 11 February"."""
|
|
433
|
+
heading: String!
|
|
434
|
+
body: String
|
|
435
|
+
createdAt: String!
|
|
436
|
+
read: Boolean!
|
|
437
|
+
|
|
438
|
+
"""The movie or series."""
|
|
439
|
+
title: Title!
|
|
440
|
+
|
|
441
|
+
"""Set when the notification is about one episode."""
|
|
442
|
+
episode: Episode
|
|
443
|
+
}
|
|
444
|
+
|
|
445
|
+
enum DownloadStatus {
|
|
446
|
+
QUEUED
|
|
447
|
+
DOWNLOADING
|
|
448
|
+
DONE
|
|
449
|
+
FAILED
|
|
450
|
+
}
|
|
451
|
+
|
|
452
|
+
"""A movie or episode saved for offline playback."""
|
|
453
|
+
type Download {
|
|
454
|
+
id: ID!
|
|
455
|
+
status: DownloadStatus!
|
|
456
|
+
|
|
457
|
+
"""0..1"""
|
|
458
|
+
progress: Float!
|
|
459
|
+
|
|
460
|
+
"""Bytes received so far (the full size once done)."""
|
|
461
|
+
sizeBytes: Float!
|
|
462
|
+
error: String
|
|
463
|
+
createdAt: String!
|
|
464
|
+
|
|
465
|
+
"""The movie, or the episode's series."""
|
|
466
|
+
title: Title!
|
|
467
|
+
episode: Episode
|
|
468
|
+
|
|
469
|
+
"""Local playable URL once done."""
|
|
470
|
+
url: String
|
|
471
|
+
mimeType: String
|
|
472
|
+
}
|
|
473
|
+
|
|
474
|
+
enum TogetherStatus {
|
|
475
|
+
"""Hosting, nobody joined yet."""
|
|
476
|
+
WAITING
|
|
477
|
+
|
|
478
|
+
"""Joined, looking for the host."""
|
|
479
|
+
CONNECTING
|
|
480
|
+
CONNECTED
|
|
481
|
+
|
|
482
|
+
"""The host left."""
|
|
483
|
+
CLOSED
|
|
484
|
+
|
|
485
|
+
"""The host could not be reached."""
|
|
486
|
+
FAILED
|
|
487
|
+
}
|
|
488
|
+
|
|
489
|
+
"""Someone in a Watch Together room."""
|
|
490
|
+
type TogetherPeer {
|
|
491
|
+
id: ID!
|
|
492
|
+
name: String!
|
|
493
|
+
|
|
494
|
+
"""The profile's avatar (e.g. otter:classic)."""
|
|
495
|
+
avatar: String
|
|
496
|
+
}
|
|
497
|
+
|
|
498
|
+
"""
|
|
499
|
+
A Watch Together room: peers meet over Nostr relays, then sync peer-to-peer.
|
|
500
|
+
"""
|
|
501
|
+
type TogetherRoom {
|
|
502
|
+
"""Eight characters; share it so others can join."""
|
|
503
|
+
code: String!
|
|
504
|
+
hosting: Boolean!
|
|
505
|
+
status: TogetherStatus!
|
|
506
|
+
self: TogetherPeer!
|
|
507
|
+
|
|
508
|
+
"""Everyone connected, including self."""
|
|
509
|
+
peers: [TogetherPeer!]!
|
|
510
|
+
}
|
|
511
|
+
|
|
512
|
+
"""An app payload (JSON) from another participant."""
|
|
513
|
+
type TogetherMessage {
|
|
514
|
+
from: TogetherPeer!
|
|
515
|
+
payload: String!
|
|
516
|
+
}
|
|
517
|
+
|
|
518
|
+
type TogetherUpdate {
|
|
519
|
+
"""Null when there is no room."""
|
|
520
|
+
room: TogetherRoom
|
|
521
|
+
message: TogetherMessage
|
|
522
|
+
}
|
|
523
|
+
|
|
524
|
+
enum CatalogSort {
|
|
525
|
+
POPULAR
|
|
526
|
+
TOP_RATED
|
|
527
|
+
}
|
|
528
|
+
|
|
529
|
+
"""
|
|
530
|
+
Curated discover rows. Blockbusters are movies only, bingeworthy is series only; the others work for both.
|
|
531
|
+
"""
|
|
532
|
+
enum CatalogTheme {
|
|
533
|
+
HIDDEN_GEMS
|
|
534
|
+
BLOCKBUSTERS
|
|
535
|
+
FEEL_GOOD
|
|
536
|
+
BINGEWORTHY
|
|
537
|
+
}
|
|
538
|
+
|
|
539
|
+
type CatalogRow {
|
|
540
|
+
genre: String!
|
|
541
|
+
items: [Title!]!
|
|
542
|
+
}
|
|
543
|
+
|
|
544
|
+
type Query {
|
|
545
|
+
"""A movie or series, fetched from TMDB when missing or stale."""
|
|
546
|
+
title(id: ID!): Title
|
|
547
|
+
episode(id: ID!): Episode
|
|
548
|
+
|
|
549
|
+
"""
|
|
550
|
+
A person with biography and filmography, fetched when missing or stale.
|
|
551
|
+
"""
|
|
552
|
+
person(id: ID!): Person
|
|
553
|
+
|
|
554
|
+
"""TMDB search; results are stored as titles."""
|
|
555
|
+
search(query: String!, mediaType: MediaType, limit: Int = 20, filter: TitleFilter): [Title!]!
|
|
556
|
+
trending(mediaType: MediaType): [Title!]!
|
|
557
|
+
|
|
558
|
+
"""
|
|
559
|
+
Upcoming releases (soonest first), then recent ones (newest first). Series: currently airing.
|
|
560
|
+
"""
|
|
561
|
+
newAndComingSoon(mediaType: MediaType!): [Title!]!
|
|
562
|
+
|
|
563
|
+
"""
|
|
564
|
+
Lead actors of the profile's most recently watched titles of one type, the most frequent first; empty before any history.
|
|
565
|
+
"""
|
|
566
|
+
watchedActors(profileId: ID!, mediaType: MediaType!, limit: Int = 15): [Person!]!
|
|
567
|
+
|
|
568
|
+
"""
|
|
569
|
+
More titles with the lead actor of the profile's latest well-rated title; null before any good rating.
|
|
570
|
+
"""
|
|
571
|
+
moreWith(profileId: ID!, mediaType: MediaType!): MoreWithRow
|
|
572
|
+
|
|
573
|
+
"""Stored titles of one type, most popular first."""
|
|
574
|
+
browse(mediaType: MediaType!, genre: String, limit: Int = 40, offset: Int = 0): [Title!]!
|
|
575
|
+
genres: [String!]!
|
|
576
|
+
|
|
577
|
+
"""
|
|
578
|
+
Popular or top-rated titles straight from TMDB's catalog (stored as titles), to fill Home before the profile has history.
|
|
579
|
+
"""
|
|
580
|
+
catalog(mediaType: MediaType!, sort: CatalogSort = POPULAR): [Title!]!
|
|
581
|
+
|
|
582
|
+
"""
|
|
583
|
+
One themed row of TMDB's catalog (stored as titles); empty when the theme doesn't fit the media type.
|
|
584
|
+
"""
|
|
585
|
+
catalogTheme(mediaType: MediaType!, theme: CatalogTheme!): [Title!]!
|
|
586
|
+
|
|
587
|
+
"""
|
|
588
|
+
Up to count genre rows of popular TMDB titles, skipping the genre names in exclude.
|
|
589
|
+
"""
|
|
590
|
+
catalogRows(mediaType: MediaType!, count: Int = 6, exclude: [String!]): [CatalogRow!]!
|
|
591
|
+
recommendations(profileId: ID!, mediaType: MediaType, limit: Int = 24, offset: Int = 0, refresh: Boolean = false): [Recommendation!]!
|
|
592
|
+
recommendationRows(profileId: ID!, rows: Int = 8, perRow: Int = 20): [RecommendationRow!]!
|
|
593
|
+
continueWatching(profileId: ID!, limit: Int = 20): [ContinueItem!]!
|
|
594
|
+
history(profileId: ID!, limit: Int = 50): [HistoryEntry!]!
|
|
595
|
+
watchlist(profileId: ID!): [Title!]!
|
|
596
|
+
|
|
597
|
+
"""
|
|
598
|
+
Titles the profile rated well (I like this, Love this), latest rating first.
|
|
599
|
+
"""
|
|
600
|
+
likedTitles(profileId: ID!, limit: Int = 30): [Title!]!
|
|
601
|
+
|
|
602
|
+
"""Newest first."""
|
|
603
|
+
notifications(profileId: ID!, limit: Int = 30): [Notification!]!
|
|
604
|
+
unreadNotificationCount(profileId: ID!): Int!
|
|
605
|
+
|
|
606
|
+
"""Newest first."""
|
|
607
|
+
downloads(profileId: ID!): [Download!]!
|
|
608
|
+
|
|
609
|
+
"""
|
|
610
|
+
Folder finished downloads are saved to as named video files; null when they are not.
|
|
611
|
+
"""
|
|
612
|
+
downloadsFolder: String
|
|
613
|
+
|
|
614
|
+
"""The open Watch Together room, if any."""
|
|
615
|
+
togetherRoom: TogetherRoom
|
|
616
|
+
|
|
617
|
+
"""
|
|
618
|
+
Subtitle files for a movie or episode (same id as streams/findStreams), best first. Ranked by the profile's caption language, then its other languages; at most 3 per language. Asks subtitles plugins when nothing fresh is stored.
|
|
619
|
+
"""
|
|
620
|
+
subtitles(mediaId: ID!, profileId: ID): [Subtitle!]!
|
|
621
|
+
profiles: [Profile!]!
|
|
622
|
+
settings: Settings!
|
|
623
|
+
|
|
624
|
+
"""Whether TMDB accepts the key; errors when TMDB can't be reached."""
|
|
625
|
+
checkTmdbKey(key: String!): Boolean!
|
|
626
|
+
plugins: [Plugin!]!
|
|
627
|
+
status: Status!
|
|
628
|
+
|
|
629
|
+
"""
|
|
630
|
+
The household's Neoworks account, which syncs profiles, history, lists, ratings and settings between devices.
|
|
631
|
+
"""
|
|
632
|
+
neoworksAccount: NeoworksAccount!
|
|
633
|
+
}
|
|
634
|
+
|
|
635
|
+
type NeoworksAccount {
|
|
636
|
+
signedIn: Boolean!
|
|
637
|
+
|
|
638
|
+
"""Null while signed out, and when Neoworks didn't share it."""
|
|
639
|
+
email: String
|
|
640
|
+
name: String
|
|
641
|
+
|
|
642
|
+
"""The last sync since the backend started; null before the first."""
|
|
643
|
+
lastSync: NeoworksSync
|
|
644
|
+
}
|
|
645
|
+
|
|
646
|
+
type NeoworksSync {
|
|
647
|
+
at: String!
|
|
648
|
+
|
|
649
|
+
"""Local records changed by other devices."""
|
|
650
|
+
received: Int!
|
|
651
|
+
|
|
652
|
+
"""Rows written from this device."""
|
|
653
|
+
sent: Int!
|
|
654
|
+
|
|
655
|
+
"""Why the sync stopped; null when it worked."""
|
|
656
|
+
failure: String
|
|
657
|
+
}
|
|
658
|
+
|
|
659
|
+
enum ChallengeKind {
|
|
660
|
+
"""Pass the check and send back the site's cookies."""
|
|
661
|
+
CLEARANCE
|
|
662
|
+
|
|
663
|
+
"""
|
|
664
|
+
Open the page, pass any check, and send back the first URL off the site (e.g. the hoster a link page redirects to).
|
|
665
|
+
"""
|
|
666
|
+
NAVIGATION
|
|
667
|
+
}
|
|
668
|
+
|
|
669
|
+
"""
|
|
670
|
+
A site's bot check (Cloudflare, Turnstile) the phone app solves in a WebView, like FlareSolverr.
|
|
671
|
+
"""
|
|
672
|
+
type Challenge {
|
|
673
|
+
id: ID!
|
|
674
|
+
kind: ChallengeKind!
|
|
675
|
+
|
|
676
|
+
"""The page to open; the check passes on it."""
|
|
677
|
+
url: String!
|
|
678
|
+
domain: String!
|
|
679
|
+
|
|
680
|
+
"""
|
|
681
|
+
Show the page to the user: the hidden attempt failed and they are waiting to play.
|
|
682
|
+
"""
|
|
683
|
+
interactive: Boolean!
|
|
684
|
+
}
|
|
685
|
+
|
|
686
|
+
type Mutation {
|
|
687
|
+
"""
|
|
688
|
+
The app passed a bot check: its cookies for the site, the WebView's user agent they are bound to, and for a NAVIGATION the URL it led to.
|
|
689
|
+
"""
|
|
690
|
+
completeChallenge(id: ID!, cookies: String!, userAgent: String!, finalUrl: String): Boolean!
|
|
691
|
+
|
|
692
|
+
"""The app couldn't pass a bot check, e.g. hidden while it wants a click."""
|
|
693
|
+
failChallenge(id: ID!, reason: String!): Boolean!
|
|
694
|
+
|
|
695
|
+
"""
|
|
696
|
+
Ask every streams plugin again for a movie or episode, in the background.
|
|
697
|
+
"""
|
|
698
|
+
findStreams(id: ID!): Boolean!
|
|
699
|
+
|
|
700
|
+
"""
|
|
701
|
+
Turn a stored stream into a playable URL; only succeeds when the link really delivers video.
|
|
702
|
+
"""
|
|
703
|
+
resolveStream(streamId: ID!): ResolvedStream!
|
|
704
|
+
|
|
705
|
+
"""
|
|
706
|
+
Resolves several links at once (most preferred first) and returns the fastest that really delivers video. Fails only when none plays.
|
|
707
|
+
"""
|
|
708
|
+
resolveBestStream(streamIds: [ID!]!): ResolvedStream!
|
|
709
|
+
recordProgress(profileId: ID!, mediaId: ID!, progressSeconds: Float!, durationSeconds: Float!): WatchProgress!
|
|
710
|
+
setRating(profileId: ID!, mediaId: ID!, rating: Float!): Boolean!
|
|
711
|
+
clearRating(profileId: ID!, mediaId: ID!): Boolean!
|
|
712
|
+
addToWatchlist(profileId: ID!, mediaId: ID!): Boolean!
|
|
713
|
+
removeFromWatchlist(profileId: ID!, mediaId: ID!): Boolean!
|
|
714
|
+
|
|
715
|
+
"""
|
|
716
|
+
The Notify me bell: news about a movie or series on or off, on My List or not. Adding to or removing from My List resets it.
|
|
717
|
+
"""
|
|
718
|
+
setNotifying(profileId: ID!, mediaId: ID!, notifying: Boolean!): Boolean!
|
|
719
|
+
markNotificationsRead(profileId: ID!): Boolean!
|
|
720
|
+
|
|
721
|
+
"""
|
|
722
|
+
Check every title on any My List for news now instead of at the next sweep; returns when done. Used by the phone's background check.
|
|
723
|
+
"""
|
|
724
|
+
checkNotifications: Boolean!
|
|
725
|
+
|
|
726
|
+
"""
|
|
727
|
+
Queue a movie or episode for download; a failed one is retried. streamId picks the link, otherwise the best ones are tried.
|
|
728
|
+
"""
|
|
729
|
+
startDownload(profileId: ID!, mediaId: ID!, streamId: ID): Download!
|
|
730
|
+
|
|
731
|
+
"""Remove a download (stops it when running)."""
|
|
732
|
+
deleteDownload(id: ID!): Boolean!
|
|
733
|
+
|
|
734
|
+
"""
|
|
735
|
+
Open the downloads folder in the file manager of the machine the backend runs on.
|
|
736
|
+
"""
|
|
737
|
+
openDownloadsFolder: Boolean!
|
|
738
|
+
|
|
739
|
+
"""Open a Watch Together room as the profile; replaces any open room."""
|
|
740
|
+
hostTogether(profileId: ID!): TogetherRoom!
|
|
741
|
+
|
|
742
|
+
"""Join a room by its code as the profile; replaces any open room."""
|
|
743
|
+
joinTogether(profileId: ID!, code: String!): TogetherRoom!
|
|
744
|
+
leaveTogether: Boolean!
|
|
745
|
+
|
|
746
|
+
"""
|
|
747
|
+
Store a link another Watch Together participant plays, so it can be resolved here.
|
|
748
|
+
"""
|
|
749
|
+
adoptStream(mediaId: ID!, url: String!, plugin: String!, label: String): Stream!
|
|
750
|
+
|
|
751
|
+
"""Send a JSON payload to everyone else in the room."""
|
|
752
|
+
sendTogether(payload: String!): Boolean!
|
|
753
|
+
|
|
754
|
+
"""The first profile's top language also becomes the TMDB language."""
|
|
755
|
+
createProfile(name: String!, avatarUrl: String, pin: String, isChild: Boolean = false, languages: [String!]): Profile!
|
|
756
|
+
|
|
757
|
+
"""
|
|
758
|
+
Changes the given fields; omitted fields stay. An empty pin removes the PIN; an empty subtitleLanguage clears it.
|
|
759
|
+
"""
|
|
760
|
+
updateProfile(id: ID!, name: String, avatarUrl: String, isChild: Boolean, pin: String, languages: [String!], subtitlesEnabled: Boolean, subtitleLanguage: String, subtitleSize: SubtitleSize, voiceBoost: Boolean): Profile!
|
|
761
|
+
deleteProfile(id: ID!): Boolean!
|
|
762
|
+
verifyPin(profileId: ID!, pin: String!): PinCheck!
|
|
763
|
+
updateSettings(input: SettingsInput!): Settings!
|
|
764
|
+
|
|
765
|
+
"""
|
|
766
|
+
Asks TMDB right now whether it answers; also updates Status.tmdbReachable.
|
|
767
|
+
"""
|
|
768
|
+
checkTmdbConnection: Boolean!
|
|
769
|
+
setPluginEnabled(name: String!, enabled: Boolean!): Plugin!
|
|
770
|
+
setPluginSettings(name: String!, values: [PluginSettingInput!]!): Plugin!
|
|
771
|
+
|
|
772
|
+
"""
|
|
773
|
+
Logs in to a plugin's site; the account is saved only when the site accepts it.
|
|
774
|
+
"""
|
|
775
|
+
loginPlugin(name: String!, username: String!, password: String!): Plugin!
|
|
776
|
+
|
|
777
|
+
"""Forgets a plugin's account."""
|
|
778
|
+
logoutPlugin(name: String!): Plugin!
|
|
779
|
+
|
|
780
|
+
"""
|
|
781
|
+
Check npm for newer plugin releases now and install them (local builds stay). Fails when PLUGIN_AUTO_UPDATE=false.
|
|
782
|
+
"""
|
|
783
|
+
updatePlugins: PluginUpdateReport!
|
|
784
|
+
|
|
785
|
+
"""
|
|
786
|
+
Starts signing in to Neoworks and returns the page to open in a browser. returnTo is the web app's origin (e.g. http://nas.local:3000); the Android app leaves it out.
|
|
787
|
+
"""
|
|
788
|
+
startNeoworksSignIn(returnTo: String): String!
|
|
789
|
+
|
|
790
|
+
"""
|
|
791
|
+
Finishes the sign-in with the code and state otter.letsmoe.com/auth/callback received.
|
|
792
|
+
"""
|
|
793
|
+
completeNeoworksSignIn(code: String!, state: String!): NeoworksAccount!
|
|
794
|
+
|
|
795
|
+
"""
|
|
796
|
+
Signs this device out; the household's data stays in Neoworks for its other devices.
|
|
797
|
+
"""
|
|
798
|
+
signOutOfNeoworks: NeoworksAccount!
|
|
799
|
+
|
|
800
|
+
"""
|
|
801
|
+
Syncs with Neoworks now; returns when done, with the result in lastSync.
|
|
802
|
+
"""
|
|
803
|
+
syncNeoworks: NeoworksAccount!
|
|
804
|
+
|
|
805
|
+
"""
|
|
806
|
+
Starts a sync in the background and returns at once; the apps call it when they open.
|
|
807
|
+
"""
|
|
808
|
+
syncNeoworksSoon: Boolean!
|
|
809
|
+
}
|
|
810
|
+
|
|
811
|
+
type PluginUpdate {
|
|
812
|
+
"""The plugin's name, as in Plugin.name"""
|
|
813
|
+
name: String!
|
|
814
|
+
fromVersion: String!
|
|
815
|
+
toVersion: String!
|
|
816
|
+
}
|
|
817
|
+
|
|
818
|
+
type PluginUpdateReport {
|
|
819
|
+
updated: [PluginUpdate!]!
|
|
820
|
+
|
|
821
|
+
"""Plugin folders whose check, download or install failed"""
|
|
822
|
+
failed: [String!]!
|
|
823
|
+
}
|
|
824
|
+
|
|
825
|
+
type Subscription {
|
|
826
|
+
"""
|
|
827
|
+
Stream list of a movie or episode as plugins answer. Starts a lookup when the stored links are stale.
|
|
828
|
+
"""
|
|
829
|
+
streams(id: ID!): StreamUpdate!
|
|
830
|
+
|
|
831
|
+
"""The Watch Together room as it changes, and messages from the others."""
|
|
832
|
+
together: TogetherUpdate!
|
|
833
|
+
|
|
834
|
+
"""
|
|
835
|
+
Bot checks to solve, for the phone app; while it listens, plugins that need solving are available.
|
|
836
|
+
"""
|
|
837
|
+
challenges: Challenge!
|
|
838
|
+
}
|