@deadair/sdk 0.50.1 → 0.50.2

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.
Files changed (45) hide show
  1. package/dist/activity/types/activity.types.d.ts +5 -5
  2. package/dist/art/art.client.d.ts +30 -0
  3. package/dist/art/art.client.d.ts.map +1 -1
  4. package/dist/art/types/art.types.d.ts +6 -6
  5. package/dist/authentication/types/authentication.types.d.ts +70 -70
  6. package/dist/authentication/types/registration.types.d.ts +30 -30
  7. package/dist/catalog/types/catalog.types.d.ts +49 -46
  8. package/dist/catalog/types/catalog.types.d.ts.map +1 -1
  9. package/dist/charts/types/charts.types.d.ts +5 -5
  10. package/dist/director/types/clock.types.d.ts +2 -2
  11. package/dist/director/types/director.types.d.ts +17 -17
  12. package/dist/director/types/rules.types.d.ts +5 -5
  13. package/dist/history/types/history.types.d.ts +3 -3
  14. package/dist/index.js +57 -1
  15. package/dist/index.js.map +1 -1
  16. package/dist/languages/types/languages.types.d.ts +4 -4
  17. package/dist/messaging/types/messaging.types.d.ts +3 -3
  18. package/dist/narrations/types/narrations.types.d.ts +5 -5
  19. package/dist/news/types/news.types.d.ts +5 -5
  20. package/dist/nowplaying/types/nowplaying.types.d.ts +5 -5
  21. package/dist/nowplaying/types/nowplaying.types.d.ts.map +1 -1
  22. package/dist/oauth/types/oauth.types.d.ts +17 -17
  23. package/dist/onboarding/types/onboarding.types.d.ts +4 -4
  24. package/dist/outputs/types/outputs.types.d.ts +7 -7
  25. package/dist/personas/types/personas.types.d.ts +40 -40
  26. package/dist/playlists/types/playlists.types.d.ts +7 -7
  27. package/dist/playlists/types/station.playlists.types.d.ts +13 -13
  28. package/dist/playout/types/playout.types.d.ts +16 -16
  29. package/dist/playout/types/playout.types.d.ts.map +1 -1
  30. package/dist/plugins/plugins.client.d.ts +1 -1
  31. package/dist/plugins/types/plugins.types.d.ts +33 -33
  32. package/dist/podcasts/types/podcasts.types.d.ts +8 -8
  33. package/dist/productions/types/productions.types.d.ts +4 -4
  34. package/dist/render/types/render.types.d.ts +38 -38
  35. package/dist/requests/types/requests.types.d.ts +9 -9
  36. package/dist/schedule/types/schedule.types.d.ts +8 -8
  37. package/dist/settings/types/settings.types.d.ts +6 -6
  38. package/dist/shared/types/pagination.d.ts +2 -2
  39. package/dist/station/types/logs.types.d.ts +6 -6
  40. package/dist/station/types/station.types.d.ts +10 -10
  41. package/dist/station/types/traces.types.d.ts +6 -6
  42. package/dist/storage/types/storage.types.d.ts +3 -3
  43. package/dist/stream/types/stream.types.d.ts +4 -4
  44. package/dist/topics/types/topics.types.d.ts +5 -5
  45. package/package.json +2 -2
@@ -1,7 +1,7 @@
1
1
  import { DateTime } from 'luxon';
2
2
  /**
3
3
  * One thing the station can play that is not a record
4
- * generated from [Segment](../../../../../apps/api/data/contracts/render/render.types.ck#L7)
4
+ * generated from [Segment](../../../../../apps/api/data/contracts/render/render.types.ck)
5
5
  */
6
6
  export interface Segment {
7
7
  id: string;
@@ -32,7 +32,7 @@ export interface Segment {
32
32
  }
33
33
  /**
34
34
  * Something for the station to say, before anything has said it
35
- * generated from [SegmentCreate](../../../../../apps/api/data/contracts/render/render.types.ck#L23)
35
+ * generated from [SegmentCreate](../../../../../apps/api/data/contracts/render/render.types.ck)
36
36
  */
37
37
  export interface SegmentCreate {
38
38
  /** What the console calls it, and what the mount is labelled with while it airs */
@@ -52,7 +52,7 @@ export interface SegmentCreate {
52
52
  * Documentation rather than validation: a multipart body reaches the service as the raw parser and
53
53
  * the generated client types the body as `FormData`, so nothing checks this shape. It says what to
54
54
  * send
55
- * generated from [SegmentUpload](../../../../../apps/api/data/contracts/render/render.types.ck#L36)
55
+ * generated from [SegmentUpload](../../../../../apps/api/data/contracts/render/render.types.ck)
56
56
  */
57
57
  export interface SegmentUpload {
58
58
  /** The audio itself. mp3, wav, ogg, flac or m4a, and at most 50 MB */
@@ -64,7 +64,7 @@ export interface SegmentUpload {
64
64
  }
65
65
  /**
66
66
  * A voice the station can be asked to speak in
67
- * generated from [Voice](../../../../../apps/api/data/contracts/render/render.types.ck#L46)
67
+ * generated from [Voice](../../../../../apps/api/data/contracts/render/render.types.ck)
68
68
  */
69
69
  export interface Voice {
70
70
  /** What to pass as a segment's `voice`. Empty means the plugin's own default */
@@ -76,12 +76,12 @@ export interface Voice {
76
76
  }
77
77
  /**
78
78
  * Whether there are words, and if not, which way it went wrong
79
- * generated from [ScriptOutcome](../../../../../apps/api/data/contracts/render/render.types.ck#L59)
79
+ * generated from [ScriptOutcome](../../../../../apps/api/data/contracts/render/render.types.ck)
80
80
  */
81
81
  export type ScriptOutcome = 'written' | 'declined' | 'failed';
82
82
  /**
83
83
  * A record a writer was told about, kept as it was told
84
- * generated from [ScriptNeighbour](../../../../../apps/api/data/contracts/render/render.types.ck#L61)
84
+ * generated from [ScriptNeighbour](../../../../../apps/api/data/contracts/render/render.types.ck)
85
85
  */
86
86
  export interface ScriptNeighbour {
87
87
  title: string;
@@ -91,7 +91,7 @@ export interface ScriptNeighbour {
91
91
  }
92
92
  /**
93
93
  * What the provider said the attempt cost, when it said anything
94
- * generated from [ScriptUsage](../../../../../apps/api/data/contracts/render/render.types.ck#L67)
94
+ * generated from [ScriptUsage](../../../../../apps/api/data/contracts/render/render.types.ck)
95
95
  */
96
96
  export interface ScriptUsage {
97
97
  inputTokens?: number;
@@ -100,7 +100,7 @@ export interface ScriptUsage {
100
100
  }
101
101
  /**
102
102
  * One turn of the conversation a writer sent
103
- * generated from [ScriptPromptMessage](../../../../../apps/api/data/contracts/render/render.types.ck#L73)
103
+ * generated from [ScriptPromptMessage](../../../../../apps/api/data/contracts/render/render.types.ck)
104
104
  */
105
105
  export interface ScriptPromptMessage {
106
106
  role: string;
@@ -116,12 +116,12 @@ export interface ScriptPromptMessage {
116
116
  * `neutral` is a real answer rather than an absence. Rating something back to nothing is a thing an
117
117
  * operator does, and it has to be distinguishable from never having listened, which is the field
118
118
  * being absent on the attempt.
119
- * generated from [ScriptRating](../../../../../apps/api/data/contracts/render/render.types.ck#L110)
119
+ * generated from [ScriptRating](../../../../../apps/api/data/contracts/render/render.types.ck)
120
120
  */
121
121
  export type ScriptRating = 'liked' | 'neutral' | 'disliked';
122
122
  /**
123
123
  * Words to hear before anything has aired them
124
- * generated from [SpeechPreviewRequest](../../../../../apps/api/data/contracts/render/render.types.ck#L131)
124
+ * generated from [SpeechPreviewRequest](../../../../../apps/api/data/contracts/render/render.types.ck)
125
125
  */
126
126
  export interface SpeechPreviewRequest {
127
127
  /** What to say. Far under a segment's 20000 because this is one break heard once, and the cap is what bounds a cache keyed on the words themselves */
@@ -135,7 +135,7 @@ export interface SpeechPreviewRequest {
135
135
  }
136
136
  /**
137
137
  * The window the counts cover
138
- * generated from [ScriptHistorySummaryQuery](../../../../../apps/api/data/contracts/render/render.types.ck#L139)
138
+ * generated from [ScriptHistorySummaryQuery](../../../../../apps/api/data/contracts/render/render.types.ck)
139
139
  */
140
140
  export interface ScriptHistorySummaryQuery {
141
141
  /** How far back to count. Defaults to 24, and a week at most, because past that the nightly sweep may already have taken the rows and the count would quietly be of what survived rather than of what happened */
@@ -143,7 +143,7 @@ export interface ScriptHistorySummaryQuery {
143
143
  }
144
144
  /**
145
145
  * One presenter's attempts in the window
146
- * generated from [ScriptHistorySummaryRow](../../../../../apps/api/data/contracts/render/render.types.ck#L143)
146
+ * generated from [ScriptHistorySummaryRow](../../../../../apps/api/data/contracts/render/render.types.ck)
147
147
  */
148
148
  export interface ScriptHistorySummaryRow {
149
149
  /** Absent means nobody was presenting, which is an ordinary state rather than a gap in the data */
@@ -155,7 +155,7 @@ export interface ScriptHistorySummaryRow {
155
155
  }
156
156
  /**
157
157
  * What one pass over the inbox did
158
- * generated from [SegmentScanResult](../../../../../apps/api/data/contracts/render/render.types.ck#L155)
158
+ * generated from [SegmentScanResult](../../../../../apps/api/data/contracts/render/render.types.ck)
159
159
  */
160
160
  export interface SegmentScanResult {
161
161
  /** Audio files seen, whether or not they were already known */
@@ -167,7 +167,7 @@ export interface SegmentScanResult {
167
167
  }
168
168
  /**
169
169
  * One name the station says differently from how it is written
170
- * generated from [Pronunciation](../../../../../apps/api/data/contracts/render/render.types.ck#L161)
170
+ * generated from [Pronunciation](../../../../../apps/api/data/contracts/render/render.types.ck)
171
171
  */
172
172
  export interface Pronunciation {
173
173
  id: string;
@@ -190,7 +190,7 @@ export interface Pronunciation {
190
190
  }
191
191
  /**
192
192
  * A name and how to say it
193
- * generated from [PronunciationWrite](../../../../../apps/api/data/contracts/render/render.types.ck#L178)
193
+ * generated from [PronunciationWrite](../../../../../apps/api/data/contracts/render/render.types.ck)
194
194
  */
195
195
  export interface PronunciationWrite {
196
196
  written: string;
@@ -199,14 +199,14 @@ export interface PronunciationWrite {
199
199
  }
200
200
  /**
201
201
  * Accepting a proposal, turning one down, or taking an entry out of use without losing it
202
- * generated from [PronunciationStateWrite](../../../../../apps/api/data/contracts/render/render.types.ck#L183)
202
+ * generated from [PronunciationStateWrite](../../../../../apps/api/data/contracts/render/render.types.ck)
203
203
  */
204
204
  export interface PronunciationStateWrite {
205
205
  state: 'active' | 'suggested' | 'rejected';
206
206
  }
207
207
  /**
208
208
  * Which part of the lexicon to read
209
- * generated from [PronunciationQuery](../../../../../apps/api/data/contracts/render/render.types.ck#L187)
209
+ * generated from [PronunciationQuery](../../../../../apps/api/data/contracts/render/render.types.ck)
210
210
  */
211
211
  export interface PronunciationQuery {
212
212
  /** Absent is all of it */
@@ -215,7 +215,7 @@ export interface PronunciationQuery {
215
215
  /**
216
216
  * Where in a break a sound may fall. `start` is before the first word, `end` after the last, and
217
217
  * `middle` anywhere between two words
218
- * generated from [PadPlacement](../../../../../apps/api/data/contracts/render/render.types.ck#L214)
218
+ * generated from [PadPlacement](../../../../../apps/api/data/contracts/render/render.types.ck)
219
219
  */
220
220
  export type PadPlacement = 'start' | 'middle' | 'end';
221
221
  /**
@@ -224,7 +224,7 @@ export type PadPlacement = 'start' | 'middle' | 'end';
224
224
  * Documentation rather than validation: a multipart body reaches the service as the raw parser and
225
225
  * the generated client types the body as `FormData`, so nothing checks this shape. It says what to
226
226
  * send
227
- * generated from [PadUpload](../../../../../apps/api/data/contracts/render/render.types.ck#L227)
227
+ * generated from [PadUpload](../../../../../apps/api/data/contracts/render/render.types.ck)
228
228
  */
229
229
  export interface PadUpload {
230
230
  /** The audio itself. mp3, wav, ogg, flac or m4a, and at most 25 MB */
@@ -242,7 +242,7 @@ export interface PadUpload {
242
242
  * The operator names the address, so this is them choosing a file exactly as dropping one in the
243
243
  * library is. Nothing inspects what comes back and nothing records a claim about its licence -- see
244
244
  * `docs/internals/render.md` under "Pads", whose line is redistribution rather than use
245
- * generated from [PadFetch](../../../../../apps/api/data/contracts/render/render.types.ck#L239)
245
+ * generated from [PadFetch](../../../../../apps/api/data/contracts/render/render.types.ck)
246
246
  */
247
247
  export interface PadFetch {
248
248
  /** Where the audio is. Followed once, bounded, and refused unless what comes back is a format the station serves */
@@ -258,7 +258,7 @@ export interface PadFetch {
258
258
  *
259
259
  * One library, cut as many ways as an operator likes. `personas.soundboard` holds the `key`, so
260
260
  * renaming a set unpoints every persona naming it — which is why `personas` says who those are
261
- * generated from [PadSet](../../../../../apps/api/data/contracts/render/render.types.ck#L255)
261
+ * generated from [PadSet](../../../../../apps/api/data/contracts/render/render.types.ck)
262
262
  */
263
263
  export interface PadSet {
264
264
  id: string;
@@ -279,7 +279,7 @@ export interface PadSetInput {
279
279
  }
280
280
  /**
281
281
  * A set an operator is naming, or renaming
282
- * generated from [PadSetWrite](../../../../../apps/api/data/contracts/render/render.types.ck#L264)
282
+ * generated from [PadSetWrite](../../../../../apps/api/data/contracts/render/render.types.ck)
283
283
  */
284
284
  export interface PadSetWrite {
285
285
  key: string;
@@ -288,7 +288,7 @@ export interface PadSetWrite {
288
288
  }
289
289
  /**
290
290
  * Which pad, and whether it is on the set
291
- * generated from [PadSetMembership](../../../../../apps/api/data/contracts/render/render.types.ck#L270)
291
+ * generated from [PadSetMembership](../../../../../apps/api/data/contracts/render/render.types.ck)
292
292
  */
293
293
  export interface PadSetMembership {
294
294
  padId: string;
@@ -296,14 +296,14 @@ export interface PadSetMembership {
296
296
  }
297
297
  /**
298
298
  * Turning a pad down, or putting one back
299
- * generated from [PadState](../../../../../apps/api/data/contracts/render/render.types.ck#L275)
299
+ * generated from [PadState](../../../../../apps/api/data/contracts/render/render.types.ck)
300
300
  */
301
301
  export interface PadState {
302
302
  state: 'active' | 'rejected';
303
303
  }
304
304
  /**
305
305
  * What one pass over the pad library did
306
- * generated from [PadScanResult](../../../../../apps/api/data/contracts/render/render.types.ck#L279)
306
+ * generated from [PadScanResult](../../../../../apps/api/data/contracts/render/render.types.ck)
307
307
  */
308
308
  export interface PadScanResult {
309
309
  /** Audio files seen, whether or not anything changed */
@@ -319,19 +319,19 @@ export interface PadScanResult {
319
319
  }
320
320
  /**
321
321
  * Which copy of a segment's audio. `original` is what the station airs. `share` is a small copy made for a listener to send on, AAC in an .m4a, never aired
322
- * generated from [SegmentAudioRendition](../../../../../apps/api/data/contracts/render/render.types.ck#L287)
322
+ * generated from [SegmentAudioRendition](../../../../../apps/api/data/contracts/render/render.types.ck)
323
323
  */
324
324
  export type SegmentAudioRendition = 'original' | 'share';
325
325
  /**
326
326
  * Everything the station can play that is not a record
327
- * generated from [SegmentList](../../../../../apps/api/data/contracts/render/render.types.ck#L42)
327
+ * generated from [SegmentList](../../../../../apps/api/data/contracts/render/render.types.ck)
328
328
  */
329
329
  export interface SegmentList {
330
330
  segments: Segment[];
331
331
  }
332
332
  /**
333
333
  * The voices the station's current speech plugin offers
334
- * generated from [VoiceList](../../../../../apps/api/data/contracts/render/render.types.ck#L52)
334
+ * generated from [VoiceList](../../../../../apps/api/data/contracts/render/render.types.ck)
335
335
  */
336
336
  export interface VoiceList {
337
337
  voices: Voice[];
@@ -344,7 +344,7 @@ export interface VoiceList {
344
344
  }
345
345
  /**
346
346
  * One page of what the station has written, newest first
347
- * generated from [ScriptHistoryQuery](../../../../../apps/api/data/contracts/render/render.types.ck#L116)
347
+ * generated from [ScriptHistoryQuery](../../../../../apps/api/data/contracts/render/render.types.ck)
348
348
  */
349
349
  export interface ScriptHistoryQuery {
350
350
  limit?: number;
@@ -360,7 +360,7 @@ export interface ScriptHistoryQuery {
360
360
  }
361
361
  /**
362
362
  * One attempt to write something the station would say, including the ones that came to nothing
363
- * generated from [ScriptAttempt](../../../../../apps/api/data/contracts/render/render.types.ck#L78)
363
+ * generated from [ScriptAttempt](../../../../../apps/api/data/contracts/render/render.types.ck)
364
364
  */
365
365
  export interface ScriptAttempt {
366
366
  id: string;
@@ -433,14 +433,14 @@ export interface ScriptAttemptInput {
433
433
  /** Rehydrates every wire-encoded scalar in a ScriptAttempt into its runtime type. Mutates and returns `raw`. */
434
434
  export declare function reviveScriptAttempt(raw: ScriptAttempt): ScriptAttempt;
435
435
  /**
436
- * generated from [ScriptRatingInput](../../../../../apps/api/data/contracts/render/render.types.ck#L112)
436
+ * generated from [ScriptRatingInput](../../../../../apps/api/data/contracts/render/render.types.ck)
437
437
  */
438
438
  export interface ScriptRatingInput {
439
439
  rating: ScriptRating;
440
440
  }
441
441
  /**
442
442
  * What each presenter has written lately, and over how long
443
- * generated from [ScriptHistorySummary](../../../../../apps/api/data/contracts/render/render.types.ck#L150)
443
+ * generated from [ScriptHistorySummary](../../../../../apps/api/data/contracts/render/render.types.ck)
444
444
  */
445
445
  export interface ScriptHistorySummary {
446
446
  /** The window actually counted, echoed so a console can label the numbers it draws */
@@ -449,7 +449,7 @@ export interface ScriptHistorySummary {
449
449
  }
450
450
  /**
451
451
  * The station's lexicon, oldest first
452
- * generated from [PronunciationList](../../../../../apps/api/data/contracts/render/render.types.ck#L174)
452
+ * generated from [PronunciationList](../../../../../apps/api/data/contracts/render/render.types.ck)
453
453
  */
454
454
  export interface PronunciationList {
455
455
  pronunciations: Pronunciation[];
@@ -460,7 +460,7 @@ export interface PronunciationList {
460
460
  * `name` is what a script writes to hit it and `label` is what a person reads: two columns rather
461
461
  * than one, because a token for a model and prose for an operator are different things and the
462
462
  * filename produces both
463
- * generated from [Pad](../../../../../apps/api/data/contracts/render/render.types.ck#L196)
463
+ * generated from [Pad](../../../../../apps/api/data/contracts/render/render.types.ck)
464
464
  */
465
465
  export interface Pad {
466
466
  id: string;
@@ -509,7 +509,7 @@ export interface PadInput {
509
509
  export declare function revivePad(raw: Pad): Pad;
510
510
  /**
511
511
  * Where and when a pad may be hit, written together because the console edits them together
512
- * generated from [PadUse](../../../../../apps/api/data/contracts/render/render.types.ck#L217)
512
+ * generated from [PadUse](../../../../../apps/api/data/contracts/render/render.types.ck)
513
513
  */
514
514
  export interface PadUse {
515
515
  /** At least one: a sound that may go nowhere is a sound turned down, which is what `PadState` is for */
@@ -518,14 +518,14 @@ export interface PadUse {
518
518
  cue?: string;
519
519
  }
520
520
  /**
521
- * generated from [SegmentAudioQuery](../../../../../apps/api/data/contracts/render/render.types.ck#L289)
521
+ * generated from [SegmentAudioQuery](../../../../../apps/api/data/contracts/render/render.types.ck)
522
522
  */
523
523
  export interface SegmentAudioQuery {
524
524
  /** A purpose the station interprets rather than a format the caller picks, so what `share` means can change without any caller changing */
525
525
  rendition?: SegmentAudioRendition;
526
526
  }
527
527
  /**
528
- * generated from [ScriptHistoryPage](../../../../../apps/api/data/contracts/render/render.types.ck#L126)
528
+ * generated from [ScriptHistoryPage](../../../../../apps/api/data/contracts/render/render.types.ck)
529
529
  */
530
530
  export interface ScriptHistoryPage {
531
531
  attempts: ScriptAttempt[];
@@ -541,7 +541,7 @@ export interface ScriptHistoryPageInput {
541
541
  export declare function reviveScriptHistoryPage(raw: ScriptHistoryPage): ScriptHistoryPage;
542
542
  /**
543
543
  * Every sound the station holds, and the sets over it
544
- * generated from [PadList](../../../../../apps/api/data/contracts/render/render.types.ck#L246)
544
+ * generated from [PadList](../../../../../apps/api/data/contracts/render/render.types.ck)
545
545
  */
546
546
  export interface PadList {
547
547
  pads: Pad[];
@@ -1,7 +1,7 @@
1
1
  import { DateTime } from 'luxon';
2
2
  /**
3
3
  * A music provider's copy of a record the station has not taken in yet
4
- * generated from [RequestableSource](../../../../../apps/api/data/contracts/requests/requests.types.ck#L7)
4
+ * generated from [RequestableSource](../../../../../apps/api/data/contracts/requests/requests.types.ck)
5
5
  */
6
6
  export interface RequestableSource {
7
7
  /** The plugin that carries it */
@@ -10,16 +10,16 @@ export interface RequestableSource {
10
10
  externalId: string;
11
11
  }
12
12
  /**
13
- * generated from [RequestStatus](../../../../../apps/api/data/contracts/requests/requests.types.ck#L26)
13
+ * generated from [RequestStatus](../../../../../apps/api/data/contracts/requests/requests.types.ck)
14
14
  */
15
15
  export type RequestStatus = 'waiting' | 'pending' | 'queued' | 'aired' | 'declined' | 'expired';
16
16
  /**
17
- * generated from [RequestSource](../../../../../apps/api/data/contracts/requests/requests.types.ck#L28)
17
+ * generated from [RequestSource](../../../../../apps/api/data/contracts/requests/requests.types.ck)
18
18
  */
19
19
  export type RequestSource = 'app' | 'chat';
20
20
  /**
21
21
  * Turn a request down
22
- * generated from [ListenerRequestDecline](../../../../../apps/api/data/contracts/requests/requests.types.ck#L56)
22
+ * generated from [ListenerRequestDecline](../../../../../apps/api/data/contracts/requests/requests.types.ck)
23
23
  */
24
24
  export interface ListenerRequestDecline {
25
25
  /** What to tell the listener. Omit for a plain no */
@@ -27,7 +27,7 @@ export interface ListenerRequestDecline {
27
27
  }
28
28
  /**
29
29
  * A record the station could be asked for: one it holds, or one a music provider carries
30
- * generated from [RequestableTrack](../../../../../apps/api/data/contracts/requests/requests.types.ck#L12)
30
+ * generated from [RequestableTrack](../../../../../apps/api/data/contracts/requests/requests.types.ck)
31
31
  */
32
32
  export interface RequestableTrack {
33
33
  /** What to send as `trackId` to make the request. Absent for a record from a provider, which is asked for by `source` instead */
@@ -44,7 +44,7 @@ export interface RequestableTrack {
44
44
  }
45
45
  /**
46
46
  * Ask the station to play a record
47
- * generated from [ListenerRequestCreate](../../../../../apps/api/data/contracts/requests/requests.types.ck#L48)
47
+ * generated from [ListenerRequestCreate](../../../../../apps/api/data/contracts/requests/requests.types.ck)
48
48
  */
49
49
  export interface ListenerRequestCreate {
50
50
  /** A record from the request search that the station holds. Send this or `source`, never both */
@@ -60,7 +60,7 @@ export interface ListenerRequestCreate {
60
60
  }
61
61
  /**
62
62
  * A record somebody asked the station to play, and what became of it
63
- * generated from [ListenerRequest](../../../../../apps/api/data/contracts/requests/requests.types.ck#L30)
63
+ * generated from [ListenerRequest](../../../../../apps/api/data/contracts/requests/requests.types.ck)
64
64
  */
65
65
  export interface ListenerRequest {
66
66
  id: string;
@@ -88,14 +88,14 @@ export interface ListenerRequest {
88
88
  export declare function reviveListenerRequest(raw: ListenerRequest): ListenerRequest;
89
89
  /**
90
90
  * Records matching a search, best matches first, the station's own before any a provider carries
91
- * generated from [RequestableTrackList](../../../../../apps/api/data/contracts/requests/requests.types.ck#L22)
91
+ * generated from [RequestableTrackList](../../../../../apps/api/data/contracts/requests/requests.types.ck)
92
92
  */
93
93
  export interface RequestableTrackList {
94
94
  tracks: RequestableTrack[];
95
95
  }
96
96
  /**
97
97
  * Requests, newest first
98
- * generated from [ListenerRequestList](../../../../../apps/api/data/contracts/requests/requests.types.ck#L44)
98
+ * generated from [ListenerRequestList](../../../../../apps/api/data/contracts/requests/requests.types.ck)
99
99
  */
100
100
  export interface ListenerRequestList {
101
101
  requests: ListenerRequest[];
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * A host who sits in on a slot on some nights, saying whose show it usually is
3
- * generated from [SlotGuestHost](../../../../../apps/api/data/contracts/schedule/schedule.types.ck#L38)
3
+ * generated from [SlotGuestHost](../../../../../apps/api/data/contracts/schedule/schedule.types.ck)
4
4
  */
5
5
  export interface SlotGuestHost {
6
6
  /** Who sits in. A host; a caller or a guest who drops by can never present a show */
@@ -14,7 +14,7 @@ export interface SlotGuestHost {
14
14
  }
15
15
  /**
16
16
  * Somebody who presents beside a slot's host, every night or some of them
17
- * generated from [SlotCoHost](../../../../../apps/api/data/contracts/schedule/schedule.types.ck#L46)
17
+ * generated from [SlotCoHost](../../../../../apps/api/data/contracts/schedule/schedule.types.ck)
18
18
  */
19
19
  export interface SlotCoHost {
20
20
  /** Who co-presents. A host; a caller or a guest who drops by can never present a show */
@@ -28,7 +28,7 @@ export interface SlotCoHost {
28
28
  }
29
29
  /**
30
30
  * A window of the station's day to draw
31
- * generated from [ScheduleTimetableQuery](../../../../../apps/api/data/contracts/schedule/schedule.types.ck#L58)
31
+ * generated from [ScheduleTimetableQuery](../../../../../apps/api/data/contracts/schedule/schedule.types.ck)
32
32
  */
33
33
  export interface ScheduleTimetableQuery {
34
34
  /** The first day to draw, as `YYYY-MM-DD` on the station's own calendar. Absent means the station's today, which is the only way a caller that does not know the station's timezone can anchor */
@@ -38,7 +38,7 @@ export interface ScheduleTimetableQuery {
38
38
  }
39
39
  /**
40
40
  * One block: this slot, on this day, between these two times
41
- * generated from [ScheduleOccurrence](../../../../../apps/api/data/contracts/schedule/schedule.types.ck#L71)
41
+ * generated from [ScheduleOccurrence](../../../../../apps/api/data/contracts/schedule/schedule.types.ck)
42
42
  */
43
43
  export interface ScheduleOccurrence {
44
44
  slotId: string;
@@ -50,7 +50,7 @@ export interface ScheduleOccurrence {
50
50
  }
51
51
  /**
52
52
  * One stretch of the station's day: from this time, on these days, the station plays this
53
- * generated from [ScheduleSlot](../../../../../apps/api/data/contracts/schedule/schedule.types.ck#L8)
53
+ * generated from [ScheduleSlot](../../../../../apps/api/data/contracts/schedule/schedule.types.ck)
54
54
  */
55
55
  export interface ScheduleSlot {
56
56
  id: string;
@@ -153,7 +153,7 @@ export interface ScheduleSlotInput {
153
153
  }
154
154
  /**
155
155
  * The station's day as blocks, ready to draw
156
- * generated from [ScheduleTimetable](../../../../../apps/api/data/contracts/schedule/schedule.types.ck#L64)
156
+ * generated from [ScheduleTimetable](../../../../../apps/api/data/contracts/schedule/schedule.types.ck)
157
157
  */
158
158
  export interface ScheduleTimetable {
159
159
  /** The range actually drawn, echoed so a caller steps forward and back by adding days to a string rather than by knowing the station's timezone */
@@ -163,7 +163,7 @@ export interface ScheduleTimetable {
163
163
  }
164
164
  /**
165
165
  * Which slot the clock says should be on right now, and what follows it
166
- * generated from [ScheduleNow](../../../../../apps/api/data/contracts/schedule/schedule.types.ck#L79)
166
+ * generated from [ScheduleNow](../../../../../apps/api/data/contracts/schedule/schedule.types.ck)
167
167
  */
168
168
  export interface ScheduleNow {
169
169
  /** What time it is on the station's own clock, in the same zone-naive `YYYY-MM-DD HH:mm:ss` shape as a block's ends. It is here so a caller can say how much of the block is left without knowing the station's timezone: subtracting two readings taken in one frame is arithmetic, deriving one is not */
@@ -184,7 +184,7 @@ export interface ScheduleNow {
184
184
  upcoming: ScheduleOccurrence[];
185
185
  }
186
186
  /**
187
- * generated from [ScheduleSlotList](../../../../../apps/api/data/contracts/schedule/schedule.types.ck#L53)
187
+ * generated from [ScheduleSlotList](../../../../../apps/api/data/contracts/schedule/schedule.types.ck)
188
188
  */
189
189
  export interface ScheduleSlotList {
190
190
  slots: ScheduleSlot[];
@@ -1,20 +1,20 @@
1
1
  import type { ConfigFieldDescriptor } from '../../plugins/types/plugins.types.js';
2
2
  /**
3
3
  * Which part of the console owns a setting. Every one of these but `schedule`, `personas`, `phrasings` and `providers` is a section of the settings page; `schedule` is edited on the schedule page, beside the timetable it describes, `personas` on the characters page, beside the names it stands behind, `phrasings` on the Voice page's Phrasings tab, beside everything else about what the station says, and `providers` on the Providers section, which draws each capability beside the plugins that answer it rather than as a form of text fields.
4
- * generated from [SettingGroup](../../../../../apps/api/data/contracts/settings/settings.types.ck#L7)
4
+ * generated from [SettingGroup](../../../../../apps/api/data/contracts/settings/settings.types.ck)
5
5
  */
6
6
  export type SettingGroup = 'station' | 'stream' | 'housekeeping' | 'mail' | 'signin' | 'rotation' | 'breaks' | 'bulletins' | 'playout' | 'render' | 'llm' | 'analysis' | 'schedule' | 'personas' | 'phrasings' | 'providers';
7
7
  /**
8
8
  * A submitted settings form. Partial: a key that is present is written, a key that is absent is left
9
9
  * alone, so a console may send one field. A secret submitted blank clears it
10
- * generated from [StationSettingsInput](../../../../../apps/api/data/contracts/settings/settings.types.ck#L53)
10
+ * generated from [StationSettingsInput](../../../../../apps/api/data/contracts/settings/settings.types.ck)
11
11
  */
12
12
  export interface StationSettingsInput {
13
13
  values: Record<string, unknown>;
14
14
  }
15
15
  /**
16
16
  * One identity provider row, and whether its issuer answered as one
17
- * generated from [SigninProviderCheck](../../../../../apps/api/data/contracts/settings/settings.types.ck#L58)
17
+ * generated from [SigninProviderCheck](../../../../../apps/api/data/contracts/settings/settings.types.ck)
18
18
  */
19
19
  export interface SigninProviderCheck {
20
20
  /** The row's name */
@@ -32,14 +32,14 @@ export interface SigninProviderCheck {
32
32
  * A station setting as the console needs to render it. `ConfigFieldDescriptor` is the plugins area's,
33
33
  * and shared deliberately: a plugin's settings form and the station's are the same problem, and the
34
34
  * console renders both with one component
35
- * generated from [StationSettingDescriptor](../../../../../apps/api/data/contracts/settings/settings.types.ck#L39)
35
+ * generated from [StationSettingDescriptor](../../../../../apps/api/data/contracts/settings/settings.types.ck)
36
36
  */
37
37
  export interface StationSettingDescriptor extends ConfigFieldDescriptor {
38
38
  group: SettingGroup;
39
39
  }
40
40
  /**
41
41
  * Every identity provider row the station could read, and the ones it could not use at all
42
- * generated from [SigninProvidersCheck](../../../../../apps/api/data/contracts/settings/settings.types.ck#L67)
42
+ * generated from [SigninProvidersCheck](../../../../../apps/api/data/contracts/settings/settings.types.ck)
43
43
  */
44
44
  export interface SigninProvidersCheck {
45
45
  /** In the order the rows are listed */
@@ -49,7 +49,7 @@ export interface SigninProvidersCheck {
49
49
  }
50
50
  /**
51
51
  * Every station setting, with what it is currently worth
52
- * generated from [StationSettings](../../../../../apps/api/data/contracts/settings/settings.types.ck#L44)
52
+ * generated from [StationSettings](../../../../../apps/api/data/contracts/settings/settings.types.ck)
53
53
  */
54
54
  export interface StationSettings {
55
55
  descriptors: StationSettingDescriptor[];
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * Represents a pagination object
3
- * generated from [Pagination](../../../../../apps/api/data/contracts/shared/pagination.ck#L7)
3
+ * generated from [Pagination](../../../../../apps/api/data/contracts/shared/pagination.ck)
4
4
  */
5
5
  export interface Pagination {
6
6
  /** The page number */
@@ -21,7 +21,7 @@ export interface PaginationInput {
21
21
  sort?: 'asc' | 'desc';
22
22
  }
23
23
  /**
24
- * generated from [PaginationWithActive](../../../../../apps/api/data/contracts/shared/pagination.ck#L14)
24
+ * generated from [PaginationWithActive](../../../../../apps/api/data/contracts/shared/pagination.ck)
25
25
  */
26
26
  export interface PaginationWithActive extends Pagination {
27
27
  /** Optionally filter by whether the items are active */
@@ -5,12 +5,12 @@ import { DateTime } from 'luxon';
5
5
  * by `DeadairLogger`, which tees every level the app-wide `Logger` has, `trace` included. Narrowing
6
6
  * here would make a `trace` line unrepresentable in the type of the surface that reads the file it
7
7
  * is in.
8
- * generated from [LogLevel](../../../../../apps/api/data/contracts/station/logs.types.ck#L12)
8
+ * generated from [LogLevel](../../../../../apps/api/data/contracts/station/logs.types.ck)
9
9
  */
10
10
  export type LogLevel = 'trace' | 'debug' | 'info' | 'warn' | 'error';
11
11
  /**
12
12
  * One log file this install has, whether or not anything has been written to it
13
- * generated from [LogSource](../../../../../apps/api/data/contracts/station/logs.types.ck#L14)
13
+ * generated from [LogSource](../../../../../apps/api/data/contracts/station/logs.types.ck)
14
14
  */
15
15
  export interface LogSource {
16
16
  /** A closed set the API owns: `api`, `liquidsoap`, `shim`. Never a path */
@@ -31,7 +31,7 @@ export interface LogSource {
31
31
  export declare function reviveLogSource(raw: LogSource): LogSource;
32
32
  /**
33
33
  * One line, as far as it could be read back
34
- * generated from [LogLine](../../../../../apps/api/data/contracts/station/logs.types.ck#L28)
34
+ * generated from [LogLine](../../../../../apps/api/data/contracts/station/logs.types.ck)
35
35
  */
36
36
  export interface LogLine {
37
37
  /** Absent on a line this API did not write, and on one of its own that did not parse */
@@ -42,7 +42,7 @@ export interface LogLine {
42
42
  text: string;
43
43
  }
44
44
  /**
45
- * generated from [LogQuery](../../../../../apps/api/data/contracts/station/logs.types.ck#L41)
45
+ * generated from [LogQuery](../../../../../apps/api/data/contracts/station/logs.types.ck)
46
46
  */
47
47
  export interface LogQuery {
48
48
  limit?: number;
@@ -50,7 +50,7 @@ export interface LogQuery {
50
50
  level?: LogLevel;
51
51
  }
52
52
  /**
53
- * generated from [LogSourceList](../../../../../apps/api/data/contracts/station/logs.types.ck#L24)
53
+ * generated from [LogSourceList](../../../../../apps/api/data/contracts/station/logs.types.ck)
54
54
  */
55
55
  export interface LogSourceList {
56
56
  /** Every source, in a fixed order, including the ones that are not present */
@@ -59,7 +59,7 @@ export interface LogSourceList {
59
59
  /** Rehydrates every wire-encoded scalar in a LogSourceList into its runtime type. Mutates and returns `raw`. */
60
60
  export declare function reviveLogSourceList(raw: LogSourceList): LogSourceList;
61
61
  /**
62
- * generated from [LogPage](../../../../../apps/api/data/contracts/station/logs.types.ck#L34)
62
+ * generated from [LogPage](../../../../../apps/api/data/contracts/station/logs.types.ck)
63
63
  */
64
64
  export interface LogPage {
65
65
  sourceId: string;