@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
@@ -2,7 +2,7 @@ import { DateTime } from 'luxon';
2
2
  import type { OidcProvider } from './authentication.types.js';
3
3
  import type { PublicKeyCredentialWithAttestation } from './authentication.types.js';
4
4
  /**
5
- * generated from [PhoneFactorRegistration](../../../../../apps/api/data/contracts/authentication/registration.types.ck#L7)
5
+ * generated from [PhoneFactorRegistration](../../../../../apps/api/data/contracts/authentication/registration.types.ck)
6
6
  */
7
7
  export interface PhoneFactorRegistration {
8
8
  /** The method of the factor */
@@ -13,7 +13,7 @@ export interface PhoneFactorRegistration {
13
13
  codeChallenge: string;
14
14
  }
15
15
  /**
16
- * generated from [PasswordFactorRegistration](../../../../../apps/api/data/contracts/authentication/registration.types.ck#L13)
16
+ * generated from [PasswordFactorRegistration](../../../../../apps/api/data/contracts/authentication/registration.types.ck)
17
17
  */
18
18
  export interface PasswordFactorRegistration {
19
19
  /** The method of the factor */
@@ -22,7 +22,7 @@ export interface PasswordFactorRegistration {
22
22
  value: string;
23
23
  }
24
24
  /**
25
- * generated from [EmailFactorRegistration](../../../../../apps/api/data/contracts/authentication/registration.types.ck#L18)
25
+ * generated from [EmailFactorRegistration](../../../../../apps/api/data/contracts/authentication/registration.types.ck)
26
26
  */
27
27
  export interface EmailFactorRegistration {
28
28
  /** The method of the factor */
@@ -33,7 +33,7 @@ export interface EmailFactorRegistration {
33
33
  codeChallenge: string;
34
34
  }
35
35
  /**
36
- * generated from [AuthenticatorFactorRegistration](../../../../../apps/api/data/contracts/authentication/registration.types.ck#L24)
36
+ * generated from [AuthenticatorFactorRegistration](../../../../../apps/api/data/contracts/authentication/registration.types.ck)
37
37
  */
38
38
  export interface AuthenticatorFactorRegistration {
39
39
  /** The method of the factor */
@@ -44,7 +44,7 @@ export interface AuthenticatorFactorRegistration {
44
44
  label?: string;
45
45
  }
46
46
  /**
47
- * generated from [FidoFactorRegistration](../../../../../apps/api/data/contracts/authentication/registration.types.ck#L30)
47
+ * generated from [FidoFactorRegistration](../../../../../apps/api/data/contracts/authentication/registration.types.ck)
48
48
  */
49
49
  export interface FidoFactorRegistration {
50
50
  /** The method of the factor */
@@ -54,7 +54,7 @@ export interface FidoFactorRegistration {
54
54
  }
55
55
  /**
56
56
  * Link an identity provider to the signed-in account. Answered with the provider's address; the browser goes there and comes back to Security
57
- * generated from [OidcFactorRegistration](../../../../../apps/api/data/contracts/authentication/registration.types.ck#L35)
57
+ * generated from [OidcFactorRegistration](../../../../../apps/api/data/contracts/authentication/registration.types.ck)
58
58
  */
59
59
  export interface OidcFactorRegistration {
60
60
  /** The method of the factor */
@@ -63,7 +63,7 @@ export interface OidcFactorRegistration {
63
63
  provider: OidcProvider;
64
64
  }
65
65
  /**
66
- * generated from [PhoneFactorRegistrationResponse](../../../../../apps/api/data/contracts/authentication/registration.types.ck#L42)
66
+ * generated from [PhoneFactorRegistrationResponse](../../../../../apps/api/data/contracts/authentication/registration.types.ck)
67
67
  */
68
68
  export interface PhoneFactorRegistrationResponse {
69
69
  /** The method of the factor */
@@ -78,7 +78,7 @@ export interface PhoneFactorRegistrationResponse {
78
78
  /** Rehydrates every wire-encoded scalar in a PhoneFactorRegistrationResponse into its runtime type. Mutates and returns `raw`. */
79
79
  export declare function revivePhoneFactorRegistrationResponse(raw: PhoneFactorRegistrationResponse): PhoneFactorRegistrationResponse;
80
80
  /**
81
- * generated from [PasswordFactorRegistrationResponse](../../../../../apps/api/data/contracts/authentication/registration.types.ck#L49)
81
+ * generated from [PasswordFactorRegistrationResponse](../../../../../apps/api/data/contracts/authentication/registration.types.ck)
82
82
  */
83
83
  export interface PasswordFactorRegistrationResponse {
84
84
  /** The method of the factor */
@@ -87,7 +87,7 @@ export interface PasswordFactorRegistrationResponse {
87
87
  needsReset: boolean;
88
88
  }
89
89
  /**
90
- * generated from [EmailFactorRegistrationResponse](../../../../../apps/api/data/contracts/authentication/registration.types.ck#L54)
90
+ * generated from [EmailFactorRegistrationResponse](../../../../../apps/api/data/contracts/authentication/registration.types.ck)
91
91
  */
92
92
  export interface EmailFactorRegistrationResponse {
93
93
  /** The method of the factor */
@@ -102,7 +102,7 @@ export interface EmailFactorRegistrationResponse {
102
102
  /** Rehydrates every wire-encoded scalar in a EmailFactorRegistrationResponse into its runtime type. Mutates and returns `raw`. */
103
103
  export declare function reviveEmailFactorRegistrationResponse(raw: EmailFactorRegistrationResponse): EmailFactorRegistrationResponse;
104
104
  /**
105
- * generated from [AuthenticatorFactorRegistrationResponse](../../../../../apps/api/data/contracts/authentication/registration.types.ck#L61)
105
+ * generated from [AuthenticatorFactorRegistrationResponse](../../../../../apps/api/data/contracts/authentication/registration.types.ck)
106
106
  */
107
107
  export interface AuthenticatorFactorRegistrationResponse {
108
108
  /** The method of the factor */
@@ -124,7 +124,7 @@ export interface AuthenticatorFactorRegistrationResponse {
124
124
  export declare function reviveAuthenticatorFactorRegistrationResponse(raw: AuthenticatorFactorRegistrationResponse): AuthenticatorFactorRegistrationResponse;
125
125
  /**
126
126
  * The FIDO factor attestation information
127
- * generated from [FidoFactorAttestation](../../../../../apps/api/data/contracts/authentication/registration.types.ck#L71)
127
+ * generated from [FidoFactorAttestation](../../../../../apps/api/data/contracts/authentication/registration.types.ck)
128
128
  */
129
129
  export interface FidoFactorAttestation {
130
130
  /** The relying party */
@@ -151,7 +151,7 @@ export interface FidoFactorAttestation {
151
151
  attestation: 'direct' | 'indirect' | 'none';
152
152
  }
153
153
  /**
154
- * generated from [OidcFactorRegistrationResponse](../../../../../apps/api/data/contracts/authentication/registration.types.ck#L96)
154
+ * generated from [OidcFactorRegistrationResponse](../../../../../apps/api/data/contracts/authentication/registration.types.ck)
155
155
  */
156
156
  export interface OidcFactorRegistrationResponse {
157
157
  /** The method of the factor */
@@ -164,7 +164,7 @@ export interface OidcFactorRegistrationResponse {
164
164
  /** Rehydrates every wire-encoded scalar in a OidcFactorRegistrationResponse into its runtime type. Mutates and returns `raw`. */
165
165
  export declare function reviveOidcFactorRegistrationResponse(raw: OidcFactorRegistrationResponse): OidcFactorRegistrationResponse;
166
166
  /**
167
- * generated from [PhoneFactorRegistrationVerification](../../../../../apps/api/data/contracts/authentication/registration.types.ck#L104)
167
+ * generated from [PhoneFactorRegistrationVerification](../../../../../apps/api/data/contracts/authentication/registration.types.ck)
168
168
  */
169
169
  export interface PhoneFactorRegistrationVerification {
170
170
  /** The method of the factor */
@@ -177,7 +177,7 @@ export interface PhoneFactorRegistrationVerification {
177
177
  codeVerifier: string;
178
178
  }
179
179
  /**
180
- * generated from [EmailFactorRegistrationVerification](../../../../../apps/api/data/contracts/authentication/registration.types.ck#L111)
180
+ * generated from [EmailFactorRegistrationVerification](../../../../../apps/api/data/contracts/authentication/registration.types.ck)
181
181
  */
182
182
  export interface EmailFactorRegistrationVerification {
183
183
  /** The method of the factor */
@@ -190,7 +190,7 @@ export interface EmailFactorRegistrationVerification {
190
190
  codeVerifier: string;
191
191
  }
192
192
  /**
193
- * generated from [AuthenticatorFactorRegistrationVerification](../../../../../apps/api/data/contracts/authentication/registration.types.ck#L118)
193
+ * generated from [AuthenticatorFactorRegistrationVerification](../../../../../apps/api/data/contracts/authentication/registration.types.ck)
194
194
  */
195
195
  export interface AuthenticatorFactorRegistrationVerification {
196
196
  /** The method of the factor */
@@ -203,7 +203,7 @@ export interface AuthenticatorFactorRegistrationVerification {
203
203
  codeVerifier: string;
204
204
  }
205
205
  /**
206
- * generated from [FidoFactorRegistrationVerification](../../../../../apps/api/data/contracts/authentication/registration.types.ck#L125)
206
+ * generated from [FidoFactorRegistrationVerification](../../../../../apps/api/data/contracts/authentication/registration.types.ck)
207
207
  */
208
208
  export interface FidoFactorRegistrationVerification {
209
209
  /** The method of the factor */
@@ -215,7 +215,7 @@ export interface FidoFactorRegistrationVerification {
215
215
  }
216
216
  /**
217
217
  * Begin enrolling a TOTP authenticator during a pending login MFA challenge (no session — authorized by the challenge)
218
- * generated from [MfaEnrollAuthenticatorStart](../../../../../apps/api/data/contracts/authentication/registration.types.ck#L133)
218
+ * generated from [MfaEnrollAuthenticatorStart](../../../../../apps/api/data/contracts/authentication/registration.types.ck)
219
219
  */
220
220
  export interface MfaEnrollAuthenticatorStart {
221
221
  /** The pending MFA challenge from the `mfa_required` login response */
@@ -225,7 +225,7 @@ export interface MfaEnrollAuthenticatorStart {
225
225
  }
226
226
  /**
227
227
  * Verify the first TOTP code, persist the authenticator, and complete login
228
- * generated from [MfaEnrollAuthenticatorVerify](../../../../../apps/api/data/contracts/authentication/registration.types.ck#L138)
228
+ * generated from [MfaEnrollAuthenticatorVerify](../../../../../apps/api/data/contracts/authentication/registration.types.ck)
229
229
  */
230
230
  export interface MfaEnrollAuthenticatorVerify {
231
231
  /** The same pending MFA challenge */
@@ -237,12 +237,12 @@ export interface MfaEnrollAuthenticatorVerify {
237
237
  }
238
238
  /**
239
239
  * A second-factor method a user may enroll
240
- * generated from [EnrollmentMethod](../../../../../apps/api/data/contracts/authentication/registration.types.ck#L144)
240
+ * generated from [EnrollmentMethod](../../../../../apps/api/data/contracts/authentication/registration.types.ck)
241
241
  */
242
242
  export type EnrollmentMethod = 'authenticator' | 'phone' | 'fido';
243
243
  /**
244
244
  * Begin enrolling an SMS phone factor during a pending login MFA challenge (no session — authorized by the challenge)
245
- * generated from [MfaEnrollPhoneStart](../../../../../apps/api/data/contracts/authentication/registration.types.ck#L150)
245
+ * generated from [MfaEnrollPhoneStart](../../../../../apps/api/data/contracts/authentication/registration.types.ck)
246
246
  */
247
247
  export interface MfaEnrollPhoneStart {
248
248
  /** The pending MFA challenge from the `mfa_required` login response */
@@ -252,7 +252,7 @@ export interface MfaEnrollPhoneStart {
252
252
  }
253
253
  /**
254
254
  * Acknowledges the phone registration and that an OTP was texted
255
- * generated from [MfaEnrollPhoneStartResponse](../../../../../apps/api/data/contracts/authentication/registration.types.ck#L155)
255
+ * generated from [MfaEnrollPhoneStartResponse](../../../../../apps/api/data/contracts/authentication/registration.types.ck)
256
256
  */
257
257
  export interface MfaEnrollPhoneStartResponse {
258
258
  /** The method of the factor */
@@ -268,7 +268,7 @@ export interface MfaEnrollPhoneStartResponse {
268
268
  export declare function reviveMfaEnrollPhoneStartResponse(raw: MfaEnrollPhoneStartResponse): MfaEnrollPhoneStartResponse;
269
269
  /**
270
270
  * Verify the texted OTP, persist the phone factor, and complete login
271
- * generated from [MfaEnrollPhoneVerify](../../../../../apps/api/data/contracts/authentication/registration.types.ck#L162)
271
+ * generated from [MfaEnrollPhoneVerify](../../../../../apps/api/data/contracts/authentication/registration.types.ck)
272
272
  */
273
273
  export interface MfaEnrollPhoneVerify {
274
274
  /** The same pending MFA challenge */
@@ -280,7 +280,7 @@ export interface MfaEnrollPhoneVerify {
280
280
  }
281
281
  /**
282
282
  * Begin enrolling a passkey during a pending login MFA challenge (no session — authorized by the challenge)
283
- * generated from [MfaEnrollFidoStart](../../../../../apps/api/data/contracts/authentication/registration.types.ck#L168)
283
+ * generated from [MfaEnrollFidoStart](../../../../../apps/api/data/contracts/authentication/registration.types.ck)
284
284
  */
285
285
  export interface MfaEnrollFidoStart {
286
286
  /** The pending MFA challenge from the `mfa_required` login response */
@@ -290,7 +290,7 @@ export interface MfaEnrollFidoStart {
290
290
  }
291
291
  /**
292
292
  * Post the new credential back, persist the passkey factor, and complete login
293
- * generated from [MfaEnrollFidoVerify](../../../../../apps/api/data/contracts/authentication/registration.types.ck#L181)
293
+ * generated from [MfaEnrollFidoVerify](../../../../../apps/api/data/contracts/authentication/registration.types.ck)
294
294
  */
295
295
  export interface MfaEnrollFidoVerify {
296
296
  /** The same pending MFA challenge */
@@ -301,11 +301,11 @@ export interface MfaEnrollFidoVerify {
301
301
  credential: PublicKeyCredentialWithAttestation;
302
302
  }
303
303
  /**
304
- * generated from [AuthenticationFactorRegistration](../../../../../apps/api/data/contracts/authentication/registration.types.ck#L40)
304
+ * generated from [AuthenticationFactorRegistration](../../../../../apps/api/data/contracts/authentication/registration.types.ck)
305
305
  */
306
306
  export type AuthenticationFactorRegistration = PhoneFactorRegistration | PasswordFactorRegistration | EmailFactorRegistration | AuthenticatorFactorRegistration | FidoFactorRegistration | OidcFactorRegistration;
307
307
  /**
308
- * generated from [FidoFactorRegistrationResponse](../../../../../apps/api/data/contracts/authentication/registration.types.ck#L88)
308
+ * generated from [FidoFactorRegistrationResponse](../../../../../apps/api/data/contracts/authentication/registration.types.ck)
309
309
  */
310
310
  export interface FidoFactorRegistrationResponse {
311
311
  /** The method of the factor */
@@ -323,7 +323,7 @@ export interface FidoFactorRegistrationResponse {
323
323
  export declare function reviveFidoFactorRegistrationResponse(raw: FidoFactorRegistrationResponse): FidoFactorRegistrationResponse;
324
324
  /**
325
325
  * WebAuthn attestation options for `navigator.credentials.create`
326
- * generated from [MfaEnrollFidoStartResponse](../../../../../apps/api/data/contracts/authentication/registration.types.ck#L173)
326
+ * generated from [MfaEnrollFidoStartResponse](../../../../../apps/api/data/contracts/authentication/registration.types.ck)
327
327
  */
328
328
  export interface MfaEnrollFidoStartResponse {
329
329
  /** The method of the factor */
@@ -340,19 +340,19 @@ export interface MfaEnrollFidoStartResponse {
340
340
  /** Rehydrates every wire-encoded scalar in a MfaEnrollFidoStartResponse into its runtime type. Mutates and returns `raw`. */
341
341
  export declare function reviveMfaEnrollFidoStartResponse(raw: MfaEnrollFidoStartResponse): MfaEnrollFidoStartResponse;
342
342
  /**
343
- * generated from [AuthenticationFactorRegistrationVerification](../../../../../apps/api/data/contracts/authentication/registration.types.ck#L131)
343
+ * generated from [AuthenticationFactorRegistrationVerification](../../../../../apps/api/data/contracts/authentication/registration.types.ck)
344
344
  */
345
345
  export type AuthenticationFactorRegistrationVerification = PhoneFactorRegistrationVerification | EmailFactorRegistrationVerification | AuthenticatorFactorRegistrationVerification | FidoFactorRegistrationVerification;
346
346
  /**
347
347
  * Which second factors this instance permits enrolling. `phone` is present only when an SMS provider is configured (SMS_DELIVERY != noop); `authenticator` and `fido` are always available.
348
- * generated from [EnrollmentMethods](../../../../../apps/api/data/contracts/authentication/registration.types.ck#L146)
348
+ * generated from [EnrollmentMethods](../../../../../apps/api/data/contracts/authentication/registration.types.ck)
349
349
  */
350
350
  export interface EnrollmentMethods {
351
351
  /** The enrollable factor methods, in suggested display order */
352
352
  methods: EnrollmentMethod[];
353
353
  }
354
354
  /**
355
- * generated from [AuthenticationFactorRegistrationResponse](../../../../../apps/api/data/contracts/authentication/registration.types.ck#L102)
355
+ * generated from [AuthenticationFactorRegistrationResponse](../../../../../apps/api/data/contracts/authentication/registration.types.ck)
356
356
  */
357
357
  export type AuthenticationFactorRegistrationResponse = PhoneFactorRegistrationResponse | PasswordFactorRegistrationResponse | EmailFactorRegistrationResponse | AuthenticatorFactorRegistrationResponse | FidoFactorRegistrationResponse | OidcFactorRegistrationResponse;
358
358
  /** Rehydrates every wire-encoded scalar in a AuthenticationFactorRegistrationResponse into its runtime type. Mutates and returns `raw`. */
@@ -4,7 +4,7 @@ import type { PaginationInput } from '../../shared/types/pagination.js';
4
4
  /**
5
5
  * What the station has been told about a record. `neutral` is the absence of an opinion rather than
6
6
  * a middling one, and it is what rating something back to nothing means.
7
- * generated from [Rating](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L9)
7
+ * generated from [Rating](../../../../../apps/api/data/contracts/catalog/catalog.types.ck)
8
8
  */
9
9
  export type Rating = 'liked' | 'neutral' | 'disliked';
10
10
  /**
@@ -18,7 +18,7 @@ export type Rating = 'liked' | 'neutral' | 'disliked';
18
18
  * The failure columns are here rather than hidden because that is the question this page exists to
19
19
  * answer. A row with `attempts` and no `fetchedAt` is a remembered failure, and `lastError` with
20
20
  * `nextAttemptAt` is the whole of why a perfectly good-looking record will not play.
21
- * generated from [TrackBinding](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L73)
21
+ * generated from [TrackBinding](../../../../../apps/api/data/contracts/catalog/catalog.types.ck)
22
22
  */
23
23
  export interface TrackBinding {
24
24
  /** `track_sources.id`, which is also what the audio URL carries */
@@ -54,7 +54,7 @@ export declare function reviveTrackBinding(raw: TrackBinding): TrackBinding;
54
54
  * argues at length: a measurement of a truncated download is confident and wrong, so every reader in
55
55
  * the app filters on `complete` and a page that showed only a date would be reporting a record as
56
56
  * measured that nothing will use the measurement of.
57
- * generated from [TrackAnalysis](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L98)
57
+ * generated from [TrackAnalysis](../../../../../apps/api/data/contracts/catalog/catalog.types.ck)
58
58
  */
59
59
  export interface TrackAnalysis {
60
60
  schemaVersion: number;
@@ -72,7 +72,7 @@ export interface TrackAnalysisInput {
72
72
  export declare function reviveTrackAnalysis(raw: TrackAnalysis): TrackAnalysis;
73
73
  /**
74
74
  * One airing of a record, as this page needs it: when, and under which broadcast.
75
- * generated from [TrackPlay](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L109)
75
+ * generated from [TrackPlay](../../../../../apps/api/data/contracts/catalog/catalog.types.ck)
76
76
  */
77
77
  export interface TrackPlay {
78
78
  airedAt: DateTime;
@@ -90,7 +90,7 @@ export declare function reviveTrackPlay(raw: TrackPlay): TrackPlay;
90
90
  * A count rather than a bare 204, because the interesting answers are the small ones: clearing the
91
91
  * audio of a record with three copies and being told `1` is the station saying two of them were
92
92
  * never here — which is a fact about the record and not about the button.
93
- * generated from [TrackClearResult](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L132)
93
+ * generated from [TrackClearResult](../../../../../apps/api/data/contracts/catalog/catalog.types.ck)
94
94
  */
95
95
  export interface TrackClearResult {
96
96
  trackId: string;
@@ -104,7 +104,7 @@ export interface TrackClearResultInput {
104
104
  /**
105
105
  * Where the singing starts and stops on one record, and which answer that is. Times are milliseconds
106
106
  * from the start of the file, the timeline a lyric's timings use. Never the words themselves.
107
- * generated from [VocalMarkersDetail](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L140)
107
+ * generated from [VocalMarkersDetail](../../../../../apps/api/data/contracts/catalog/catalog.types.ck)
108
108
  */
109
109
  export interface VocalMarkersDetail {
110
110
  trackId: string;
@@ -121,7 +121,7 @@ export interface VocalMarkersDetailInput {
121
121
  }
122
122
  /**
123
123
  * An operator's correction: either the record is instrumental, or the singing starts at `onsetMs`.
124
- * generated from [VocalMarkersInput](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L149)
124
+ * generated from [VocalMarkersInput](../../../../../apps/api/data/contracts/catalog/catalog.types.ck)
125
125
  */
126
126
  export interface VocalMarkersInput {
127
127
  /** Nobody sings on this record, whatever its lyrics say */
@@ -134,7 +134,7 @@ export interface VocalMarkersInput {
134
134
  /**
135
135
  * Narrow a clear to one provider's answer, for the case where one source is wrong and the rest are
136
136
  * not. Absent clears every provider's.
137
- * generated from [ClearEnrichmentQuery](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L157)
137
+ * generated from [ClearEnrichmentQuery](../../../../../apps/api/data/contracts/catalog/catalog.types.ck)
138
138
  */
139
139
  export interface ClearEnrichmentQuery {
140
140
  provider?: string;
@@ -151,7 +151,7 @@ export interface ClearEnrichmentQuery {
151
151
  * One enum for both lists rather than two, because the alternative is a second near-identical
152
152
  * contract whose only content is which two keys it drops. A key the row cannot answer falls back to
153
153
  * name order rather than failing: an ordering nobody can serve is a page an operator cannot open.
154
- * generated from [CatalogSort](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L172)
154
+ * generated from [CatalogSort](../../../../../apps/api/data/contracts/catalog/catalog.types.ck)
155
155
  */
156
156
  export type CatalogSort = 'name' | 'albums' | 'tracks' | 'year' | 'rating';
157
157
  /**
@@ -162,7 +162,7 @@ export type CatalogSort = 'name' | 'albums' | 'tracks' | 'year' | 'rating';
162
162
  * unmeasured no trustworthy measurement, so no cue points and no level decided before air
163
163
  * benched every copy written off, which is the one state that means it CANNOT air
164
164
  * failing a fetch has failed and is backing off. Not benched yet, and often the state before it
165
- * generated from [TrackState](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L188)
165
+ * generated from [TrackState](../../../../../apps/api/data/contracts/catalog/catalog.types.ck)
166
166
  */
167
167
  export type TrackState = 'cached' | 'uncached' | 'unmeasured' | 'benched' | 'failing';
168
168
  /**
@@ -172,7 +172,7 @@ export type TrackState = 'cached' | 'uncached' | 'unmeasured' | 'benched' | 'fai
172
172
  * `state` is deliberately absent. It is three independent booleans rather than one column, so there
173
173
  * is no ordering of it an operator would agree with: a benched record and an unmeasured one are not
174
174
  * more or less than each other.
175
- * generated from [TrackSort](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L196)
175
+ * generated from [TrackSort](../../../../../apps/api/data/contracts/catalog/catalog.types.ck)
176
176
  */
177
177
  export type TrackSort = 'title' | 'artist' | 'album' | 'year' | 'duration' | 'rating';
178
178
  /**
@@ -182,7 +182,7 @@ export type TrackSort = 'title' | 'artist' | 'album' | 'year' | 'duration' | 'ra
182
182
  * [analysis-queue-ordering](https://github.com/robert-dean/deadair/discussions/5) necessary, and it was a psql query then. `total` is the
183
183
  * same number as `meta.total` when nothing is filtered, and is repeated here so the counts can be
184
184
  * read as N of M without reaching into the pager.
185
- * generated from [TrackStateCounts](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L213)
185
+ * generated from [TrackStateCounts](../../../../../apps/api/data/contracts/catalog/catalog.types.ck)
186
186
  */
187
187
  export interface TrackStateCounts {
188
188
  total: number;
@@ -203,7 +203,7 @@ export interface TrackStateCounts {
203
203
  export interface TrackStateCountsInput {
204
204
  }
205
205
  /**
206
- * generated from [EnrichmentExternalId](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L265)
206
+ * generated from [EnrichmentExternalId](../../../../../apps/api/data/contracts/catalog/catalog.types.ck)
207
207
  */
208
208
  export interface EnrichmentExternalId {
209
209
  /** e.g. `musicbrainz`, `wikidata` */
@@ -213,7 +213,7 @@ export interface EnrichmentExternalId {
213
213
  /**
214
214
  * Narrowed to http(s) by the host before it is stored, since the console renders these as
215
215
  * something a human clicks.
216
- * generated from [EnrichmentLink](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L272)
216
+ * generated from [EnrichmentLink](../../../../../apps/api/data/contracts/catalog/catalog.types.ck)
217
217
  */
218
218
  export interface EnrichmentLink {
219
219
  label: string;
@@ -223,7 +223,7 @@ export interface EnrichmentLink {
223
223
  * One thing the station believes, and the words it read that say so. Extracted by the host out of
224
224
  * an article a plugin handed over, rather than said by any plugin: `sourceUrl` is where a person
225
225
  * checks it and `sourceQuote` is the span that supports it, and neither is ever absent.
226
- * generated from [FactClaim](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L365)
226
+ * generated from [FactClaim](../../../../../apps/api/data/contracts/catalog/catalog.types.ck)
227
227
  */
228
228
  export interface FactClaim {
229
229
  id: string;
@@ -247,7 +247,7 @@ export declare function reviveFactClaim(raw: FactClaim): FactClaim;
247
247
  /**
248
248
  * Rate an artist, a record or a song. Ratings are absolute: a dislike anywhere above a track
249
249
  * excludes it, and nothing the station programmes may turn that off.
250
- * generated from [RateInput](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L13)
250
+ * generated from [RateInput](../../../../../apps/api/data/contracts/catalog/catalog.types.ck)
251
251
  */
252
252
  export interface RateInput {
253
253
  rating: Rating;
@@ -257,19 +257,19 @@ export interface RateInput {
257
257
  * only ingest cares about: `artist_key` is a match key, and a row with `merged_into_id` set is
258
258
  * never read out at all.
259
259
  *
260
- * `imageUrl` on both contracts below is one field with two spellings. An absolute URL is the
261
- * provider's own, still hotlinked because nothing has cached it yet; a relative `art/<uuid>` is
262
- * the station's copy, to be resolved against the API base the client already configures (the API
263
- * mounts at the root and does not know the `/api` prefix the edge adds). Prefer the local one by
264
- * doing nothing: the switch happens server-side as soon as the art cache pass has the bytes.
265
- * generated from [Artist](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L26)
260
+ * `imageUrl` on both contracts below is always a path under the API root, never a provider's URL:
261
+ * `art/<uuid>` for the station's cached copy, or `art/source/<token>` for one it has not cached
262
+ * yet, which the station fetches on first ask and serves as its own. Resolve either against the
263
+ * API base the client already configures (the API mounts at the root and does not know the `/api`
264
+ * prefix the edge adds). The switch from the second to the first happens server-side.
265
+ * generated from [Artist](../../../../../apps/api/data/contracts/catalog/catalog.types.ck)
266
266
  */
267
267
  export interface Artist {
268
268
  id: string;
269
269
  name: string;
270
270
  /** MusicBrainz artist id, absent until enrichment resolves one */
271
271
  mbid?: string;
272
- /** Absolute upstream URL, or an API-relative path to the local copy */
272
+ /** An API-relative path: the cached copy, or the station's proxy for an uncached one */
273
273
  imageUrl?: string;
274
274
  rating?: Rating;
275
275
  /** Unmerged albums credited to this artist */
@@ -281,12 +281,12 @@ export interface ArtistInput {
281
281
  name: string;
282
282
  /** MusicBrainz artist id, absent until enrichment resolves one */
283
283
  mbid?: string;
284
- /** Absolute upstream URL, or an API-relative path to the local copy */
284
+ /** An API-relative path: the cached copy, or the station's proxy for an uncached one */
285
285
  imageUrl?: string;
286
286
  rating?: Rating;
287
287
  }
288
288
  /**
289
- * generated from [Album](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L36)
289
+ * generated from [Album](../../../../../apps/api/data/contracts/catalog/catalog.types.ck)
290
290
  */
291
291
  export interface Album {
292
292
  id: string;
@@ -297,7 +297,7 @@ export interface Album {
297
297
  /** MusicBrainz release-group id, absent until enrichment resolves one */
298
298
  mbid?: string;
299
299
  year?: number;
300
- /** Absolute upstream URL, or an API-relative path to the local copy */
300
+ /** An API-relative path: the cached copy, or the station's proxy for an uncached one */
301
301
  imageUrl?: string;
302
302
  rating?: Rating;
303
303
  trackCount: number;
@@ -307,12 +307,12 @@ export interface AlbumInput {
307
307
  /** MusicBrainz release-group id, absent until enrichment resolves one */
308
308
  mbid?: string;
309
309
  year?: number;
310
- /** Absolute upstream URL, or an API-relative path to the local copy */
310
+ /** An API-relative path: the cached copy, or the station's proxy for an uncached one */
311
311
  imageUrl?: string;
312
312
  rating?: Rating;
313
313
  }
314
314
  /**
315
- * generated from [Track](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L48)
315
+ * generated from [Track](../../../../../apps/api/data/contracts/catalog/catalog.types.ck)
316
316
  */
317
317
  export interface Track {
318
318
  id: string;
@@ -322,7 +322,7 @@ export interface Track {
322
322
  /** Absent on a single ingested outside any release: `tracks.album_id` is nullable */
323
323
  albumId?: string;
324
324
  albumName?: string;
325
- /** The record's cover, in the two spellings `Album.imageUrl` has. Nothing hangs art off a recording */
325
+ /** The record's cover, as `Album.imageUrl` spells it. Nothing hangs art off a recording */
326
326
  albumImageUrl?: string;
327
327
  /** Display credit as written on the release ("X feat. Y"), not a join key */
328
328
  artists: string;
@@ -343,7 +343,7 @@ export interface TrackInput {
343
343
  /**
344
344
  * Pagination plus a name filter. Every list operation here takes it, so the console's search box
345
345
  * narrows server-side rather than filtering one page client-side and lying about the total.
346
- * generated from [CatalogQuery](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L176)
346
+ * generated from [CatalogQuery](../../../../../apps/api/data/contracts/catalog/catalog.types.ck)
347
347
  */
348
348
  export interface CatalogQuery extends Pagination {
349
349
  search?: string;
@@ -358,7 +358,7 @@ export interface CatalogQueryInput extends PaginationInput {
358
358
  * `1997`, `1997-06` or `1997-06-24` depending on what is actually known about the release, and the
359
359
  * SDK types it the same way. A `datetime` would reject the first two or invent a day and a time
360
360
  * for them, which is a precision the source never claimed.
361
- * generated from [TrackEnrichmentData](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L281)
361
+ * generated from [TrackEnrichmentData](../../../../../apps/api/data/contracts/catalog/catalog.types.ck)
362
362
  */
363
363
  export interface TrackEnrichmentData {
364
364
  artist?: string;
@@ -376,18 +376,20 @@ export interface TrackEnrichmentData {
376
376
  musicalKey?: string;
377
377
  label?: string;
378
378
  isrc?: string;
379
+ /** The provider's picture as the station serves it: `art/<id>` once cached, else the station's proxy `art/source/<token>`. Never the URL the plugin supplied */
379
380
  artworkUrl?: string;
380
381
  externalIds?: EnrichmentExternalId[];
381
382
  links?: EnrichmentLink[];
382
- /** What the plugin said that the SDK has no field for. Per provider only: the merged view drops it */
383
+ /** What the plugin said that the SDK has no field for. Per provider only: the merged view drops it. Never holds a URL: any string with one is dropped when read, along with the key or array element that held it */
383
384
  extra?: Record<string, unknown>;
384
385
  }
385
386
  /**
386
- * generated from [ArtistEnrichmentData](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L301)
387
+ * generated from [ArtistEnrichmentData](../../../../../apps/api/data/contracts/catalog/catalog.types.ck)
387
388
  */
388
389
  export interface ArtistEnrichmentData {
389
390
  name?: string;
390
391
  biography?: string;
392
+ /** The provider's picture as the station serves it: `art/<id>` once cached, else the station's proxy `art/source/<token>`. Never the URL the plugin supplied */
391
393
  imageUrl?: string;
392
394
  genres?: string[];
393
395
  facts?: string[];
@@ -396,7 +398,7 @@ export interface ArtistEnrichmentData {
396
398
  extra?: Record<string, unknown>;
397
399
  }
398
400
  /**
399
- * generated from [AlbumEnrichmentData](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L312)
401
+ * generated from [AlbumEnrichmentData](../../../../../apps/api/data/contracts/catalog/catalog.types.ck)
400
402
  */
401
403
  export interface AlbumEnrichmentData {
402
404
  name?: string;
@@ -408,6 +410,7 @@ export interface AlbumEnrichmentData {
408
410
  label?: string;
409
411
  genres?: string[];
410
412
  facts?: string[];
413
+ /** The provider's picture as the station serves it: `art/<id>` once cached, else the station's proxy `art/source/<token>`. Never the URL the plugin supplied */
411
414
  artworkUrl?: string;
412
415
  externalIds?: EnrichmentExternalId[];
413
416
  links?: EnrichmentLink[];
@@ -415,7 +418,7 @@ export interface AlbumEnrichmentData {
415
418
  }
416
419
  /**
417
420
  * One page of artists, with the totals the request was counted against
418
- * generated from [ArtistPage](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L245)
421
+ * generated from [ArtistPage](../../../../../apps/api/data/contracts/catalog/catalog.types.ck)
419
422
  */
420
423
  export interface ArtistPage {
421
424
  meta: Pagination;
@@ -427,7 +430,7 @@ export interface ArtistPageInput {
427
430
  }
428
431
  /**
429
432
  * One page of albums
430
- * generated from [AlbumPage](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L250)
433
+ * generated from [AlbumPage](../../../../../apps/api/data/contracts/catalog/catalog.types.ck)
431
434
  */
432
435
  export interface AlbumPage {
433
436
  meta: Pagination;
@@ -443,7 +446,7 @@ export interface AlbumPageInput {
443
446
  * The enrichment is deliberately NOT here. It has its own operation already, answering
444
447
  * `TrackEnrichmentDetail` with every provider's payload and the station's own sourced claims, and
445
448
  * the console draws it through the same panel the list uses. One enrichment shape rather than two.
446
- * generated from [TrackDetail](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L120)
449
+ * generated from [TrackDetail](../../../../../apps/api/data/contracts/catalog/catalog.types.ck)
447
450
  */
448
451
  export interface TrackDetail extends Track {
449
452
  bindings: TrackBinding[];
@@ -470,7 +473,7 @@ export declare function reviveTrackDetail(raw: TrackDetail): TrackDetail;
470
473
  * the query that was already running — and everything wider (which providers, how many bytes, why the
471
474
  * last fetch failed) is `TrackDetail`'s, one click away. A fourth would be the beginning of putting
472
475
  * the detail page in a table cell.
473
- * generated from [TrackRow](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L232)
476
+ * generated from [TrackRow](../../../../../apps/api/data/contracts/catalog/catalog.types.ck)
474
477
  */
475
478
  export interface TrackRow extends Track {
476
479
  /** The bytes are on this machine */
@@ -487,7 +490,7 @@ export interface TrackRowInput extends TrackInput {
487
490
  *
488
491
  * Its own contract rather than a field on `CatalogQuery`, because that one is shared with the artist
489
492
  * and album lists where none of these states means anything.
490
- * generated from [TrackQuery](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L202)
493
+ * generated from [TrackQuery](../../../../../apps/api/data/contracts/catalog/catalog.types.ck)
491
494
  */
492
495
  export interface TrackQuery extends Omit<CatalogQuery, 'sortBy'> {
493
496
  state?: TrackState;
@@ -501,7 +504,7 @@ export interface TrackQueryInput extends Omit<CatalogQueryInput, 'sortBy'> {
501
504
  * One provider's stored answer. `found: false` is a recorded miss, which is a fact rather than a
502
505
  * failure: the provider was asked, had nothing, and is not asked again until `expiresAt`. A provider
503
506
  * that could not be asked at all is `failed` instead, and the two never both hold.
504
- * generated from [TrackEnrichmentSource](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L329)
507
+ * generated from [TrackEnrichmentSource](../../../../../apps/api/data/contracts/catalog/catalog.types.ck)
505
508
  */
506
509
  export interface TrackEnrichmentSource {
507
510
  provider: string;
@@ -522,7 +525,7 @@ export interface TrackEnrichmentSourceInput {
522
525
  /** Rehydrates every wire-encoded scalar in a TrackEnrichmentSource into its runtime type. Mutates and returns `raw`. */
523
526
  export declare function reviveTrackEnrichmentSource(raw: TrackEnrichmentSource): TrackEnrichmentSource;
524
527
  /**
525
- * generated from [ArtistEnrichmentSource](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L340)
528
+ * generated from [ArtistEnrichmentSource](../../../../../apps/api/data/contracts/catalog/catalog.types.ck)
526
529
  */
527
530
  export interface ArtistEnrichmentSource {
528
531
  provider: string;
@@ -541,7 +544,7 @@ export interface ArtistEnrichmentSourceInput {
541
544
  /** Rehydrates every wire-encoded scalar in a ArtistEnrichmentSource into its runtime type. Mutates and returns `raw`. */
542
545
  export declare function reviveArtistEnrichmentSource(raw: ArtistEnrichmentSource): ArtistEnrichmentSource;
543
546
  /**
544
- * generated from [AlbumEnrichmentSource](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L351)
547
+ * generated from [AlbumEnrichmentSource](../../../../../apps/api/data/contracts/catalog/catalog.types.ck)
545
548
  */
546
549
  export interface AlbumEnrichmentSource {
547
550
  provider: string;
@@ -561,7 +564,7 @@ export interface AlbumEnrichmentSourceInput {
561
564
  export declare function reviveAlbumEnrichmentSource(raw: AlbumEnrichmentSource): AlbumEnrichmentSource;
562
565
  /**
563
566
  * One page of tracks, with what the station has of each and of the whole set
564
- * generated from [TrackPage](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L255)
567
+ * generated from [TrackPage](../../../../../apps/api/data/contracts/catalog/catalog.types.ck)
565
568
  */
566
569
  export interface TrackPage {
567
570
  meta: Pagination;
@@ -581,7 +584,7 @@ export interface TrackPageInput {
581
584
  * `claims` sits beside them rather than inside `merged`, because a claim is the host's own and not
582
585
  * any provider's. The articles they were read out of are deliberately NOT here: raw source prose is
583
586
  * stored and never sent.
584
- * generated from [TrackEnrichmentDetail](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L385)
587
+ * generated from [TrackEnrichmentDetail](../../../../../apps/api/data/contracts/catalog/catalog.types.ck)
585
588
  */
586
589
  export interface TrackEnrichmentDetail {
587
590
  trackId: string;
@@ -597,7 +600,7 @@ export interface TrackEnrichmentDetailInput {
597
600
  /** Rehydrates every wire-encoded scalar in a TrackEnrichmentDetail into its runtime type. Mutates and returns `raw`. */
598
601
  export declare function reviveTrackEnrichmentDetail(raw: TrackEnrichmentDetail): TrackEnrichmentDetail;
599
602
  /**
600
- * generated from [ArtistEnrichmentDetail](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L392)
603
+ * generated from [ArtistEnrichmentDetail](../../../../../apps/api/data/contracts/catalog/catalog.types.ck)
601
604
  */
602
605
  export interface ArtistEnrichmentDetail {
603
606
  artistId: string;
@@ -613,7 +616,7 @@ export interface ArtistEnrichmentDetailInput {
613
616
  /** Rehydrates every wire-encoded scalar in a ArtistEnrichmentDetail into its runtime type. Mutates and returns `raw`. */
614
617
  export declare function reviveArtistEnrichmentDetail(raw: ArtistEnrichmentDetail): ArtistEnrichmentDetail;
615
618
  /**
616
- * generated from [AlbumEnrichmentDetail](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L399)
619
+ * generated from [AlbumEnrichmentDetail](../../../../../apps/api/data/contracts/catalog/catalog.types.ck)
617
620
  */
618
621
  export interface AlbumEnrichmentDetail {
619
622
  albumId: string;