@deadair/sdk 0.7.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/LICENSE +21 -0
- package/README.md +109 -0
- package/dist/activity/activity.client.d.ts +12 -0
- package/dist/activity/activity.client.d.ts.map +1 -0
- package/dist/activity/types/activity.types.d.ts +60 -0
- package/dist/activity/types/activity.types.d.ts.map +1 -0
- package/dist/activity/types/index.d.ts +2 -0
- package/dist/activity/types/index.d.ts.map +1 -0
- package/dist/art/art.client.d.ts +21 -0
- package/dist/art/art.client.d.ts.map +1 -0
- package/dist/authentication/authentication.client.d.ts +33 -0
- package/dist/authentication/authentication.client.d.ts.map +1 -0
- package/dist/authentication/authentication.factor.client.d.ts +41 -0
- package/dist/authentication/authentication.factor.client.d.ts.map +1 -0
- package/dist/authentication/authentication.sessions.client.d.ts +20 -0
- package/dist/authentication/authentication.sessions.client.d.ts.map +1 -0
- package/dist/authentication/types/authentication.types.d.ts +846 -0
- package/dist/authentication/types/authentication.types.d.ts.map +1 -0
- package/dist/authentication/types/index.d.ts +3 -0
- package/dist/authentication/types/index.d.ts.map +1 -0
- package/dist/authentication/types/registration.types.d.ts +336 -0
- package/dist/authentication/types/registration.types.d.ts.map +1 -0
- package/dist/catalog/catalog.client.d.ts +96 -0
- package/dist/catalog/catalog.client.d.ts.map +1 -0
- package/dist/catalog/types/catalog.types.d.ts +593 -0
- package/dist/catalog/types/catalog.types.d.ts.map +1 -0
- package/dist/catalog/types/index.d.ts +2 -0
- package/dist/catalog/types/index.d.ts.map +1 -0
- package/dist/charts/charts.client.d.ts +17 -0
- package/dist/charts/charts.client.d.ts.map +1 -0
- package/dist/charts/types/charts.types.d.ts +54 -0
- package/dist/charts/types/charts.types.d.ts.map +1 -0
- package/dist/charts/types/index.d.ts +2 -0
- package/dist/charts/types/index.d.ts.map +1 -0
- package/dist/deadair.sdk.d.ts +49 -0
- package/dist/deadair.sdk.d.ts.map +1 -0
- package/dist/director/director.client.d.ts +98 -0
- package/dist/director/director.client.d.ts.map +1 -0
- package/dist/director/types/clock.types.d.ts +57 -0
- package/dist/director/types/clock.types.d.ts.map +1 -0
- package/dist/director/types/director.types.d.ts +212 -0
- package/dist/director/types/director.types.d.ts.map +1 -0
- package/dist/director/types/index.d.ts +3 -0
- package/dist/director/types/index.d.ts.map +1 -0
- package/dist/history/history.client.d.ts +12 -0
- package/dist/history/history.client.d.ts.map +1 -0
- package/dist/history/types/history.types.d.ts +44 -0
- package/dist/history/types/history.types.d.ts.map +1 -0
- package/dist/history/types/index.d.ts +2 -0
- package/dist/history/types/index.d.ts.map +1 -0
- package/dist/index.d.ts +49 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +3509 -0
- package/dist/index.js.map +1 -0
- package/dist/news/news.client.d.ts +17 -0
- package/dist/news/news.client.d.ts.map +1 -0
- package/dist/news/types/index.d.ts +2 -0
- package/dist/news/types/index.d.ts.map +1 -0
- package/dist/news/types/news.types.d.ts +61 -0
- package/dist/news/types/news.types.d.ts.map +1 -0
- package/dist/nowplaying/nowplaying.client.d.ts +12 -0
- package/dist/nowplaying/nowplaying.client.d.ts.map +1 -0
- package/dist/nowplaying/types/index.d.ts +2 -0
- package/dist/nowplaying/types/index.d.ts.map +1 -0
- package/dist/nowplaying/types/nowplaying.types.d.ts +59 -0
- package/dist/nowplaying/types/nowplaying.types.d.ts.map +1 -0
- package/dist/onboarding/onboarding.client.d.ts +11 -0
- package/dist/onboarding/onboarding.client.d.ts.map +1 -0
- package/dist/onboarding/types/index.d.ts +2 -0
- package/dist/onboarding/types/index.d.ts.map +1 -0
- package/dist/onboarding/types/onboarding.types.d.ts +41 -0
- package/dist/onboarding/types/onboarding.types.d.ts.map +1 -0
- package/dist/personas/personas.client.d.ts +167 -0
- package/dist/personas/personas.client.d.ts.map +1 -0
- package/dist/personas/types/index.d.ts +2 -0
- package/dist/personas/types/index.d.ts.map +1 -0
- package/dist/personas/types/personas.types.d.ts +545 -0
- package/dist/personas/types/personas.types.d.ts.map +1 -0
- package/dist/playlists/playlists.client.d.ts +17 -0
- package/dist/playlists/playlists.client.d.ts.map +1 -0
- package/dist/playlists/types/index.d.ts +2 -0
- package/dist/playlists/types/index.d.ts.map +1 -0
- package/dist/playlists/types/playlists.types.d.ts +71 -0
- package/dist/playlists/types/playlists.types.d.ts.map +1 -0
- package/dist/playout/playout.client.d.ts +37 -0
- package/dist/playout/playout.client.d.ts.map +1 -0
- package/dist/playout/types/index.d.ts +2 -0
- package/dist/playout/types/index.d.ts.map +1 -0
- package/dist/playout/types/playout.types.d.ts +163 -0
- package/dist/playout/types/playout.types.d.ts.map +1 -0
- package/dist/plugins/plugins.client.d.ts +107 -0
- package/dist/plugins/plugins.client.d.ts.map +1 -0
- package/dist/plugins/types/index.d.ts +2 -0
- package/dist/plugins/types/index.d.ts.map +1 -0
- package/dist/plugins/types/plugins.types.d.ts +330 -0
- package/dist/plugins/types/plugins.types.d.ts.map +1 -0
- package/dist/productions/productions.client.d.ts +22 -0
- package/dist/productions/productions.client.d.ts.map +1 -0
- package/dist/productions/types/index.d.ts +2 -0
- package/dist/productions/types/index.d.ts.map +1 -0
- package/dist/productions/types/productions.types.d.ts +90 -0
- package/dist/productions/types/productions.types.d.ts.map +1 -0
- package/dist/render/render.client.d.ts +210 -0
- package/dist/render/render.client.d.ts.map +1 -0
- package/dist/render/types/index.d.ts +2 -0
- package/dist/render/types/index.d.ts.map +1 -0
- package/dist/render/types/render.types.d.ts +518 -0
- package/dist/render/types/render.types.d.ts.map +1 -0
- package/dist/schedule/schedule.client.d.ts +37 -0
- package/dist/schedule/schedule.client.d.ts.map +1 -0
- package/dist/schedule/types/index.d.ts +2 -0
- package/dist/schedule/types/index.d.ts.map +1 -0
- package/dist/schedule/types/schedule.types.d.ts +119 -0
- package/dist/schedule/types/schedule.types.d.ts.map +1 -0
- package/dist/sdk-options.d.ts +45 -0
- package/dist/sdk-options.d.ts.map +1 -0
- package/dist/settings/settings.client.d.ts +17 -0
- package/dist/settings/settings.client.d.ts.map +1 -0
- package/dist/settings/types/index.d.ts +2 -0
- package/dist/settings/types/index.d.ts.map +1 -0
- package/dist/settings/types/settings.types.d.ts +35 -0
- package/dist/settings/types/settings.types.d.ts.map +1 -0
- package/dist/shared/types/index.d.ts +2 -0
- package/dist/shared/types/index.d.ts.map +1 -0
- package/dist/shared/types/pagination.d.ts +34 -0
- package/dist/shared/types/pagination.d.ts.map +1 -0
- package/dist/station/station.client.d.ts +49 -0
- package/dist/station/station.client.d.ts.map +1 -0
- package/dist/station/types/index.d.ts +4 -0
- package/dist/station/types/index.d.ts.map +1 -0
- package/dist/station/types/logs.types.d.ts +73 -0
- package/dist/station/types/logs.types.d.ts.map +1 -0
- package/dist/station/types/station.types.d.ts +120 -0
- package/dist/station/types/station.types.d.ts.map +1 -0
- package/dist/station/types/traces.types.d.ts +91 -0
- package/dist/station/types/traces.types.d.ts.map +1 -0
- package/dist/storage/storage.client.d.ts +12 -0
- package/dist/storage/storage.client.d.ts.map +1 -0
- package/dist/storage/types/index.d.ts +2 -0
- package/dist/storage/types/index.d.ts.map +1 -0
- package/dist/storage/types/storage.types.d.ts +59 -0
- package/dist/storage/types/storage.types.d.ts.map +1 -0
- package/dist/stream/stream.client.d.ts +32 -0
- package/dist/stream/stream.client.d.ts.map +1 -0
- package/dist/stream/types/index.d.ts +2 -0
- package/dist/stream/types/index.d.ts.map +1 -0
- package/dist/stream/types/stream.types.d.ts +47 -0
- package/dist/stream/types/stream.types.d.ts.map +1 -0
- package/dist/topics/topics.client.d.ts +32 -0
- package/dist/topics/topics.client.d.ts.map +1 -0
- package/dist/topics/types/index.d.ts +2 -0
- package/dist/topics/types/index.d.ts.map +1 -0
- package/dist/topics/types/topics.types.d.ts +65 -0
- package/dist/topics/types/topics.types.d.ts.map +1 -0
- package/package.json +53 -0
|
@@ -0,0 +1,593 @@
|
|
|
1
|
+
import { DateTime } from 'luxon';
|
|
2
|
+
import type { Pagination } from '../../shared/types/pagination.js';
|
|
3
|
+
import type { PaginationInput } from '../../shared/types/pagination.js';
|
|
4
|
+
/**
|
|
5
|
+
* What the station has been told about a record. `neutral` is the absence of an opinion rather than
|
|
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)
|
|
8
|
+
*/
|
|
9
|
+
export type Rating = 'liked' | 'neutral' | 'disliked';
|
|
10
|
+
/**
|
|
11
|
+
* One provider's copy of a record, with whatever the station holds of it.
|
|
12
|
+
*
|
|
13
|
+
* PER BINDING and never per track, which is the rule the whole page is built on: one canonical
|
|
14
|
+
* record may bind to several copies inside one provider, those copies are different files with
|
|
15
|
+
* different loudness and different cue points, and the one that airs is the one that was resolved.
|
|
16
|
+
* Collapsing them would make "clear the audio" ambiguous about which file it took.
|
|
17
|
+
*
|
|
18
|
+
* The failure columns are here rather than hidden because that is the question this page exists to
|
|
19
|
+
* answer. A row with `attempts` and no `fetchedAt` is a remembered failure, and `lastError` with
|
|
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)
|
|
22
|
+
*/
|
|
23
|
+
export interface TrackBinding {
|
|
24
|
+
/** `track_sources.id`, which is also what the audio URL carries */
|
|
25
|
+
sourceId: string;
|
|
26
|
+
pluginId: string;
|
|
27
|
+
externalId: string;
|
|
28
|
+
/** False when the provider still knows the record but will not serve it here */
|
|
29
|
+
playable: boolean;
|
|
30
|
+
/** When the station gave up on this copy. Cleared by the next sync that sees it again */
|
|
31
|
+
missingAt?: DateTime;
|
|
32
|
+
/** `sync` if a playlist walk saw it, `discovered` if something looked it up */
|
|
33
|
+
origin: string;
|
|
34
|
+
bitrate?: number;
|
|
35
|
+
format?: string;
|
|
36
|
+
lastSeenAt?: DateTime;
|
|
37
|
+
/** What the station holds of this copy, absent when nothing has ever fetched it. */
|
|
38
|
+
byteSize?: number;
|
|
39
|
+
fetchedAt?: DateTime;
|
|
40
|
+
lastServedAt?: DateTime;
|
|
41
|
+
/** CONSECUTIVE failures. Reset by a fetch that works */
|
|
42
|
+
attempts: number;
|
|
43
|
+
lastError?: string;
|
|
44
|
+
nextAttemptAt?: DateTime;
|
|
45
|
+
}
|
|
46
|
+
export interface TrackBindingInput {
|
|
47
|
+
}
|
|
48
|
+
/** Rehydrates every wire-encoded scalar in a TrackBinding into its runtime type. Mutates and returns `raw`. */
|
|
49
|
+
export declare function reviveTrackBinding(raw: TrackBinding): TrackBinding;
|
|
50
|
+
/**
|
|
51
|
+
* What the measurement sidecar made of a record.
|
|
52
|
+
*
|
|
53
|
+
* `complete` is NOT `analyzedAt`, and the two are separate fields for a reason `0005_music.sql`
|
|
54
|
+
* argues at length: a measurement of a truncated download is confident and wrong, so every reader in
|
|
55
|
+
* the app filters on `complete` and a page that showed only a date would be reporting a record as
|
|
56
|
+
* measured that nothing will use the measurement of.
|
|
57
|
+
* generated from [TrackAnalysis](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L98)
|
|
58
|
+
*/
|
|
59
|
+
export interface TrackAnalysis {
|
|
60
|
+
schemaVersion: number;
|
|
61
|
+
complete: boolean;
|
|
62
|
+
/** The measuring thing itself, which is not the plugin adapting it */
|
|
63
|
+
analyzer?: string;
|
|
64
|
+
analyzerPluginId?: string;
|
|
65
|
+
analyzedAt?: DateTime;
|
|
66
|
+
failedAt?: DateTime;
|
|
67
|
+
failureReason?: string;
|
|
68
|
+
}
|
|
69
|
+
export interface TrackAnalysisInput {
|
|
70
|
+
}
|
|
71
|
+
/** Rehydrates every wire-encoded scalar in a TrackAnalysis into its runtime type. Mutates and returns `raw`. */
|
|
72
|
+
export declare function reviveTrackAnalysis(raw: TrackAnalysis): TrackAnalysis;
|
|
73
|
+
/**
|
|
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)
|
|
76
|
+
*/
|
|
77
|
+
export interface TrackPlay {
|
|
78
|
+
airedAt: DateTime;
|
|
79
|
+
broadcastId?: string;
|
|
80
|
+
/** What put it in the running order */
|
|
81
|
+
source: string;
|
|
82
|
+
}
|
|
83
|
+
export interface TrackPlayInput {
|
|
84
|
+
}
|
|
85
|
+
/** Rehydrates every wire-encoded scalar in a TrackPlay into its runtime type. Mutates and returns `raw`. */
|
|
86
|
+
export declare function reviveTrackPlay(raw: TrackPlay): TrackPlay;
|
|
87
|
+
/**
|
|
88
|
+
* What a clear actually did.
|
|
89
|
+
*
|
|
90
|
+
* A count rather than a bare 204, because the interesting answers are the small ones: clearing the
|
|
91
|
+
* audio of a record with three copies and being told `1` is the station saying two of them were
|
|
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)
|
|
94
|
+
*/
|
|
95
|
+
export interface TrackClearResult {
|
|
96
|
+
trackId: string;
|
|
97
|
+
/** Rows this affected. Zero is an ordinary answer, not a failure */
|
|
98
|
+
cleared: number;
|
|
99
|
+
/** What happened, in the words the console shows */
|
|
100
|
+
detail: string;
|
|
101
|
+
}
|
|
102
|
+
export interface TrackClearResultInput {
|
|
103
|
+
}
|
|
104
|
+
/**
|
|
105
|
+
* Narrow a clear to one provider's answer, for the case where one source is wrong and the rest are
|
|
106
|
+
* not. Absent clears every provider's.
|
|
107
|
+
* generated from [ClearEnrichmentQuery](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L140)
|
|
108
|
+
*/
|
|
109
|
+
export interface ClearEnrichmentQuery {
|
|
110
|
+
provider?: string;
|
|
111
|
+
}
|
|
112
|
+
/**
|
|
113
|
+
* What an artist or album list is ordered BY, where `Pagination.sort` says only which direction.
|
|
114
|
+
*
|
|
115
|
+
* name the default, and the only key every row here has
|
|
116
|
+
* albums how many records the station holds of them. Artists only
|
|
117
|
+
* tracks how many songs. Artists only
|
|
118
|
+
* year when the record came out. Albums only
|
|
119
|
+
* rating the operator's own opinion
|
|
120
|
+
*
|
|
121
|
+
* One enum for both lists rather than two, because the alternative is a second near-identical
|
|
122
|
+
* contract whose only content is which two keys it drops. A key the row cannot answer falls back to
|
|
123
|
+
* name order rather than failing: an ordering nobody can serve is a page an operator cannot open.
|
|
124
|
+
* generated from [CatalogSort](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L155)
|
|
125
|
+
*/
|
|
126
|
+
export type CatalogSort = 'name' | 'albums' | 'tracks' | 'year' | 'rating';
|
|
127
|
+
/**
|
|
128
|
+
* Which records to show, by what the station has of them rather than by what they are.
|
|
129
|
+
*
|
|
130
|
+
* cached the audio is on this machine, so it can be committed to the running order now
|
|
131
|
+
* uncached it is not, which for most of a library is ordinary rather than wrong
|
|
132
|
+
* unmeasured no trustworthy measurement, so no cue points and no level decided before air
|
|
133
|
+
* benched every copy written off, which is the one state that means it CANNOT air
|
|
134
|
+
* failing a fetch has failed and is backing off. Not benched yet, and often the state before it
|
|
135
|
+
* generated from [TrackState](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L171)
|
|
136
|
+
*/
|
|
137
|
+
export type TrackState = 'cached' | 'uncached' | 'unmeasured' | 'benched' | 'failing';
|
|
138
|
+
/**
|
|
139
|
+
* What a track list is ordered BY. Its own enum for `TrackQuery`'s own reason: none of these keys
|
|
140
|
+
* means anything about an artist, and `name` is spelled `title` on a song.
|
|
141
|
+
*
|
|
142
|
+
* `state` is deliberately absent. It is three independent booleans rather than one column, so there
|
|
143
|
+
* is no ordering of it an operator would agree with: a benched record and an unmeasured one are not
|
|
144
|
+
* more or less than each other.
|
|
145
|
+
* generated from [TrackSort](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L179)
|
|
146
|
+
*/
|
|
147
|
+
export type TrackSort = 'title' | 'artist' | 'album' | 'year' | 'duration' | 'rating';
|
|
148
|
+
/**
|
|
149
|
+
* How much of the library is in each state, over the whole filtered set rather than this page.
|
|
150
|
+
*
|
|
151
|
+
* The aggregate is what an operator reads first — "13 of 581 measured" is the sentence that made
|
|
152
|
+
* [analysis-queue-ordering](https://github.com/robert-dean/deadair/discussions/5) necessary, and it was a psql query then. `total` is the
|
|
153
|
+
* same number as `meta.total` when nothing is filtered, and is repeated here so the counts can be
|
|
154
|
+
* read as N of M without reaching into the pager.
|
|
155
|
+
* generated from [TrackStateCounts](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L196)
|
|
156
|
+
*/
|
|
157
|
+
export interface TrackStateCounts {
|
|
158
|
+
total: number;
|
|
159
|
+
cached: number;
|
|
160
|
+
measured: number;
|
|
161
|
+
enriched: number;
|
|
162
|
+
benched: number;
|
|
163
|
+
failing: number;
|
|
164
|
+
}
|
|
165
|
+
export interface TrackStateCountsInput {
|
|
166
|
+
}
|
|
167
|
+
/**
|
|
168
|
+
* generated from [EnrichmentExternalId](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L244)
|
|
169
|
+
*/
|
|
170
|
+
export interface EnrichmentExternalId {
|
|
171
|
+
/** e.g. `musicbrainz`, `wikidata` */
|
|
172
|
+
source: string;
|
|
173
|
+
id: string;
|
|
174
|
+
}
|
|
175
|
+
/**
|
|
176
|
+
* Narrowed to http(s) by the host before it is stored, since the console renders these as
|
|
177
|
+
* something a human clicks.
|
|
178
|
+
* generated from [EnrichmentLink](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L251)
|
|
179
|
+
*/
|
|
180
|
+
export interface EnrichmentLink {
|
|
181
|
+
label: string;
|
|
182
|
+
url: string;
|
|
183
|
+
}
|
|
184
|
+
/**
|
|
185
|
+
* One thing the station believes, and the words it read that say so. Extracted by the host out of
|
|
186
|
+
* an article a plugin handed over, rather than said by any plugin: `sourceUrl` is where a person
|
|
187
|
+
* checks it and `sourceQuote` is the span that supports it, and neither is ever absent.
|
|
188
|
+
* generated from [FactClaim](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L344)
|
|
189
|
+
*/
|
|
190
|
+
export interface FactClaim {
|
|
191
|
+
id: string;
|
|
192
|
+
/** One sentence, as the DJ would say it */
|
|
193
|
+
claim: string;
|
|
194
|
+
category: string;
|
|
195
|
+
/** `lead` for the article's own opening, `model` for what a model found */
|
|
196
|
+
source: string;
|
|
197
|
+
sourceProvider: string;
|
|
198
|
+
sourceUrl: string;
|
|
199
|
+
sourceQuote: string;
|
|
200
|
+
confidence?: number;
|
|
201
|
+
model?: string;
|
|
202
|
+
/** Absent means never said on air */
|
|
203
|
+
lastUsedAt?: DateTime;
|
|
204
|
+
}
|
|
205
|
+
export interface FactClaimInput {
|
|
206
|
+
}
|
|
207
|
+
/** Rehydrates every wire-encoded scalar in a FactClaim into its runtime type. Mutates and returns `raw`. */
|
|
208
|
+
export declare function reviveFactClaim(raw: FactClaim): FactClaim;
|
|
209
|
+
/**
|
|
210
|
+
* Rate an artist, a record or a song. Ratings are absolute: a dislike anywhere above a track
|
|
211
|
+
* excludes it, and nothing the station programmes may turn that off.
|
|
212
|
+
* generated from [RateInput](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L13)
|
|
213
|
+
*/
|
|
214
|
+
export interface RateInput {
|
|
215
|
+
rating: Rating;
|
|
216
|
+
}
|
|
217
|
+
/**
|
|
218
|
+
* The canonical work, not a binding to a provider. `deadair.artists` minus the columns that
|
|
219
|
+
* only ingest cares about: `artist_key` is a match key, and a row with `merged_into_id` set is
|
|
220
|
+
* never read out at all.
|
|
221
|
+
*
|
|
222
|
+
* `imageUrl` on both contracts below is one field with two spellings. An absolute URL is the
|
|
223
|
+
* provider's own, still hotlinked because nothing has cached it yet; a relative `art/<uuid>` is
|
|
224
|
+
* the station's copy, to be resolved against the API base the client already configures (the API
|
|
225
|
+
* mounts at the root and does not know the `/api` prefix the edge adds). Prefer the local one by
|
|
226
|
+
* doing nothing: the switch happens server-side as soon as the art cache pass has the bytes.
|
|
227
|
+
* generated from [Artist](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L26)
|
|
228
|
+
*/
|
|
229
|
+
export interface Artist {
|
|
230
|
+
id: string;
|
|
231
|
+
name: string;
|
|
232
|
+
/** MusicBrainz artist id, absent until enrichment resolves one */
|
|
233
|
+
mbid?: string;
|
|
234
|
+
/** Absolute upstream URL, or an API-relative path to the local copy */
|
|
235
|
+
imageUrl?: string;
|
|
236
|
+
rating?: Rating;
|
|
237
|
+
/** Unmerged albums credited to this artist */
|
|
238
|
+
albumCount: number;
|
|
239
|
+
/** Unmerged tracks credited to this artist */
|
|
240
|
+
trackCount: number;
|
|
241
|
+
}
|
|
242
|
+
export interface ArtistInput {
|
|
243
|
+
name: string;
|
|
244
|
+
/** MusicBrainz artist id, absent until enrichment resolves one */
|
|
245
|
+
mbid?: string;
|
|
246
|
+
/** Absolute upstream URL, or an API-relative path to the local copy */
|
|
247
|
+
imageUrl?: string;
|
|
248
|
+
rating?: Rating;
|
|
249
|
+
}
|
|
250
|
+
/**
|
|
251
|
+
* generated from [Album](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L36)
|
|
252
|
+
*/
|
|
253
|
+
export interface Album {
|
|
254
|
+
id: string;
|
|
255
|
+
name: string;
|
|
256
|
+
artistId: string;
|
|
257
|
+
/** Joined, so a list renders without a second request per row */
|
|
258
|
+
artistName: string;
|
|
259
|
+
/** MusicBrainz release-group id, absent until enrichment resolves one */
|
|
260
|
+
mbid?: string;
|
|
261
|
+
year?: number;
|
|
262
|
+
/** Absolute upstream URL, or an API-relative path to the local copy */
|
|
263
|
+
imageUrl?: string;
|
|
264
|
+
rating?: Rating;
|
|
265
|
+
trackCount: number;
|
|
266
|
+
}
|
|
267
|
+
export interface AlbumInput {
|
|
268
|
+
name: string;
|
|
269
|
+
/** MusicBrainz release-group id, absent until enrichment resolves one */
|
|
270
|
+
mbid?: string;
|
|
271
|
+
year?: number;
|
|
272
|
+
/** Absolute upstream URL, or an API-relative path to the local copy */
|
|
273
|
+
imageUrl?: string;
|
|
274
|
+
rating?: Rating;
|
|
275
|
+
}
|
|
276
|
+
/**
|
|
277
|
+
* generated from [Track](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L48)
|
|
278
|
+
*/
|
|
279
|
+
export interface Track {
|
|
280
|
+
id: string;
|
|
281
|
+
title: string;
|
|
282
|
+
artistId: string;
|
|
283
|
+
artistName: string;
|
|
284
|
+
/** Absent on a single ingested outside any release: `tracks.album_id` is nullable */
|
|
285
|
+
albumId?: string;
|
|
286
|
+
albumName?: string;
|
|
287
|
+
/** The record's cover, in the two spellings `Album.imageUrl` has. Nothing hangs art off a recording */
|
|
288
|
+
albumImageUrl?: string;
|
|
289
|
+
/** Display credit as written on the release ("X feat. Y"), not a join key */
|
|
290
|
+
artists: string;
|
|
291
|
+
genre?: string;
|
|
292
|
+
year?: number;
|
|
293
|
+
durationMs?: number;
|
|
294
|
+
rating?: Rating;
|
|
295
|
+
}
|
|
296
|
+
export interface TrackInput {
|
|
297
|
+
title: string;
|
|
298
|
+
/** Display credit as written on the release ("X feat. Y"), not a join key */
|
|
299
|
+
artists: string;
|
|
300
|
+
genre?: string;
|
|
301
|
+
year?: number;
|
|
302
|
+
durationMs?: number;
|
|
303
|
+
rating?: Rating;
|
|
304
|
+
}
|
|
305
|
+
/**
|
|
306
|
+
* Pagination plus a name filter. Every list operation here takes it, so the console's search box
|
|
307
|
+
* narrows server-side rather than filtering one page client-side and lying about the total.
|
|
308
|
+
* generated from [CatalogQuery](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L159)
|
|
309
|
+
*/
|
|
310
|
+
export interface CatalogQuery extends Pagination {
|
|
311
|
+
search?: string;
|
|
312
|
+
sortBy?: CatalogSort;
|
|
313
|
+
}
|
|
314
|
+
export interface CatalogQueryInput extends PaginationInput {
|
|
315
|
+
search?: string;
|
|
316
|
+
sortBy?: CatalogSort;
|
|
317
|
+
}
|
|
318
|
+
/**
|
|
319
|
+
* `releaseDate` is a string and not `datetime` because it is a partial date: MusicBrainz answers
|
|
320
|
+
* `1997`, `1997-06` or `1997-06-24` depending on what is actually known about the release, and the
|
|
321
|
+
* SDK types it the same way. A `datetime` would reject the first two or invent a day and a time
|
|
322
|
+
* for them, which is a precision the source never claimed.
|
|
323
|
+
* generated from [TrackEnrichmentData](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L260)
|
|
324
|
+
*/
|
|
325
|
+
export interface TrackEnrichmentData {
|
|
326
|
+
artist?: string;
|
|
327
|
+
title?: string;
|
|
328
|
+
album?: string;
|
|
329
|
+
year?: number;
|
|
330
|
+
releaseDate?: string;
|
|
331
|
+
genres?: string[];
|
|
332
|
+
moods?: string[];
|
|
333
|
+
biography?: string;
|
|
334
|
+
/** Short lines, each independently speakable */
|
|
335
|
+
facts?: string[];
|
|
336
|
+
/** Not an integer: a tempo a source measured rather than declared is fractional */
|
|
337
|
+
bpm?: number;
|
|
338
|
+
musicalKey?: string;
|
|
339
|
+
label?: string;
|
|
340
|
+
isrc?: string;
|
|
341
|
+
artworkUrl?: string;
|
|
342
|
+
externalIds?: EnrichmentExternalId[];
|
|
343
|
+
links?: EnrichmentLink[];
|
|
344
|
+
/** What the plugin said that the SDK has no field for. Per provider only: the merged view drops it */
|
|
345
|
+
extra?: Record<string, unknown>;
|
|
346
|
+
}
|
|
347
|
+
/**
|
|
348
|
+
* generated from [ArtistEnrichmentData](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L280)
|
|
349
|
+
*/
|
|
350
|
+
export interface ArtistEnrichmentData {
|
|
351
|
+
name?: string;
|
|
352
|
+
biography?: string;
|
|
353
|
+
imageUrl?: string;
|
|
354
|
+
genres?: string[];
|
|
355
|
+
facts?: string[];
|
|
356
|
+
externalIds?: EnrichmentExternalId[];
|
|
357
|
+
links?: EnrichmentLink[];
|
|
358
|
+
extra?: Record<string, unknown>;
|
|
359
|
+
}
|
|
360
|
+
/**
|
|
361
|
+
* generated from [AlbumEnrichmentData](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L291)
|
|
362
|
+
*/
|
|
363
|
+
export interface AlbumEnrichmentData {
|
|
364
|
+
name?: string;
|
|
365
|
+
/** The record's own credit, which is not always the track's */
|
|
366
|
+
artist?: string;
|
|
367
|
+
year?: number;
|
|
368
|
+
/** Partial, exactly as on TrackEnrichmentData */
|
|
369
|
+
releaseDate?: string;
|
|
370
|
+
label?: string;
|
|
371
|
+
genres?: string[];
|
|
372
|
+
facts?: string[];
|
|
373
|
+
artworkUrl?: string;
|
|
374
|
+
externalIds?: EnrichmentExternalId[];
|
|
375
|
+
links?: EnrichmentLink[];
|
|
376
|
+
extra?: Record<string, unknown>;
|
|
377
|
+
}
|
|
378
|
+
/**
|
|
379
|
+
* One page of artists, with the totals the request was counted against
|
|
380
|
+
* generated from [ArtistPage](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L224)
|
|
381
|
+
*/
|
|
382
|
+
export interface ArtistPage {
|
|
383
|
+
meta: Pagination;
|
|
384
|
+
data: Artist[];
|
|
385
|
+
}
|
|
386
|
+
export interface ArtistPageInput {
|
|
387
|
+
meta: PaginationInput;
|
|
388
|
+
data: ArtistInput[];
|
|
389
|
+
}
|
|
390
|
+
/**
|
|
391
|
+
* One page of albums
|
|
392
|
+
* generated from [AlbumPage](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L229)
|
|
393
|
+
*/
|
|
394
|
+
export interface AlbumPage {
|
|
395
|
+
meta: Pagination;
|
|
396
|
+
data: Album[];
|
|
397
|
+
}
|
|
398
|
+
export interface AlbumPageInput {
|
|
399
|
+
meta: PaginationInput;
|
|
400
|
+
data: AlbumInput[];
|
|
401
|
+
}
|
|
402
|
+
/**
|
|
403
|
+
* Everything one record has accumulated, in one read.
|
|
404
|
+
*
|
|
405
|
+
* The enrichment is deliberately NOT here. It has its own operation already, answering
|
|
406
|
+
* `TrackEnrichmentDetail` with every provider's payload and the station's own sourced claims, and
|
|
407
|
+
* the console draws it through the same panel the list uses. One enrichment shape rather than two.
|
|
408
|
+
* generated from [TrackDetail](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L120)
|
|
409
|
+
*/
|
|
410
|
+
export interface TrackDetail extends Track {
|
|
411
|
+
bindings: TrackBinding[];
|
|
412
|
+
/** Absent for a record the walk has not reached */
|
|
413
|
+
analysis?: TrackAnalysis;
|
|
414
|
+
/** The most recent airings, newest first */
|
|
415
|
+
plays: TrackPlay[];
|
|
416
|
+
/** How many times in all, which the list above is only the head of */
|
|
417
|
+
playCount: number;
|
|
418
|
+
}
|
|
419
|
+
export interface TrackDetailInput extends TrackInput {
|
|
420
|
+
bindings: TrackBindingInput[];
|
|
421
|
+
/** Absent for a record the walk has not reached */
|
|
422
|
+
analysis?: TrackAnalysisInput;
|
|
423
|
+
/** The most recent airings, newest first */
|
|
424
|
+
plays: TrackPlayInput[];
|
|
425
|
+
}
|
|
426
|
+
/** Rehydrates every wire-encoded scalar in a TrackDetail into its runtime type. Mutates and returns `raw`. */
|
|
427
|
+
export declare function reviveTrackDetail(raw: TrackDetail): TrackDetail;
|
|
428
|
+
/**
|
|
429
|
+
* A track as a LIST shows it: the record, plus three facts about what the station has of it.
|
|
430
|
+
*
|
|
431
|
+
* Three booleans and no more, deliberately. They are what a row can afford — one `exists` each, off
|
|
432
|
+
* the query that was already running — and everything wider (which providers, how many bytes, why the
|
|
433
|
+
* last fetch failed) is `TrackDetail`'s, one click away. A fourth would be the beginning of putting
|
|
434
|
+
* the detail page in a table cell.
|
|
435
|
+
* generated from [TrackRow](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L211)
|
|
436
|
+
*/
|
|
437
|
+
export interface TrackRow extends Track {
|
|
438
|
+
/** The bytes are on this machine */
|
|
439
|
+
hasAudio: boolean;
|
|
440
|
+
/** Measured, COMPLETE, and at a schema version the station still trusts */
|
|
441
|
+
measured: boolean;
|
|
442
|
+
/** At least one provider has answered about it */
|
|
443
|
+
enriched: boolean;
|
|
444
|
+
}
|
|
445
|
+
export interface TrackRowInput extends TrackInput {
|
|
446
|
+
}
|
|
447
|
+
/**
|
|
448
|
+
* A track list, narrowed by what the station has of each record as well as by name.
|
|
449
|
+
*
|
|
450
|
+
* Its own contract rather than a field on `CatalogQuery`, because that one is shared with the artist
|
|
451
|
+
* and album lists where none of these states means anything.
|
|
452
|
+
* generated from [TrackQuery](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L185)
|
|
453
|
+
*/
|
|
454
|
+
export interface TrackQuery extends Omit<CatalogQuery, 'sortBy'> {
|
|
455
|
+
state?: TrackState;
|
|
456
|
+
sortBy?: TrackSort;
|
|
457
|
+
}
|
|
458
|
+
export interface TrackQueryInput extends Omit<CatalogQueryInput, 'sortBy'> {
|
|
459
|
+
state?: TrackState;
|
|
460
|
+
sortBy?: TrackSort;
|
|
461
|
+
}
|
|
462
|
+
/**
|
|
463
|
+
* One provider's stored answer. `found: false` is a recorded miss, which is a fact rather than a
|
|
464
|
+
* failure: the provider was asked, had nothing, and is not asked again until `expiresAt`. A provider
|
|
465
|
+
* that could not be asked at all is `failed` instead, and the two never both hold.
|
|
466
|
+
* generated from [TrackEnrichmentSource](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L308)
|
|
467
|
+
*/
|
|
468
|
+
export interface TrackEnrichmentSource {
|
|
469
|
+
provider: string;
|
|
470
|
+
/** The id it was fetched under. Provenance, not identity */
|
|
471
|
+
providerRef?: string;
|
|
472
|
+
fetchedAt: DateTime;
|
|
473
|
+
expiresAt?: DateTime;
|
|
474
|
+
/** Past its TTL, so the next pass will ask again */
|
|
475
|
+
stale: boolean;
|
|
476
|
+
found: boolean;
|
|
477
|
+
/** The last attempt errored, so `expiresAt` is a backoff rather than a TTL */
|
|
478
|
+
failed: boolean;
|
|
479
|
+
data: TrackEnrichmentData;
|
|
480
|
+
}
|
|
481
|
+
export interface TrackEnrichmentSourceInput {
|
|
482
|
+
data: TrackEnrichmentData;
|
|
483
|
+
}
|
|
484
|
+
/** Rehydrates every wire-encoded scalar in a TrackEnrichmentSource into its runtime type. Mutates and returns `raw`. */
|
|
485
|
+
export declare function reviveTrackEnrichmentSource(raw: TrackEnrichmentSource): TrackEnrichmentSource;
|
|
486
|
+
/**
|
|
487
|
+
* generated from [ArtistEnrichmentSource](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L319)
|
|
488
|
+
*/
|
|
489
|
+
export interface ArtistEnrichmentSource {
|
|
490
|
+
provider: string;
|
|
491
|
+
providerRef?: string;
|
|
492
|
+
fetchedAt: DateTime;
|
|
493
|
+
expiresAt?: DateTime;
|
|
494
|
+
stale: boolean;
|
|
495
|
+
found: boolean;
|
|
496
|
+
/** The last attempt errored, so `expiresAt` is a backoff rather than a TTL */
|
|
497
|
+
failed: boolean;
|
|
498
|
+
data: ArtistEnrichmentData;
|
|
499
|
+
}
|
|
500
|
+
export interface ArtistEnrichmentSourceInput {
|
|
501
|
+
data: ArtistEnrichmentData;
|
|
502
|
+
}
|
|
503
|
+
/** Rehydrates every wire-encoded scalar in a ArtistEnrichmentSource into its runtime type. Mutates and returns `raw`. */
|
|
504
|
+
export declare function reviveArtistEnrichmentSource(raw: ArtistEnrichmentSource): ArtistEnrichmentSource;
|
|
505
|
+
/**
|
|
506
|
+
* generated from [AlbumEnrichmentSource](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L330)
|
|
507
|
+
*/
|
|
508
|
+
export interface AlbumEnrichmentSource {
|
|
509
|
+
provider: string;
|
|
510
|
+
providerRef?: string;
|
|
511
|
+
fetchedAt: DateTime;
|
|
512
|
+
expiresAt?: DateTime;
|
|
513
|
+
stale: boolean;
|
|
514
|
+
found: boolean;
|
|
515
|
+
/** The last attempt errored, so `expiresAt` is a backoff rather than a TTL */
|
|
516
|
+
failed: boolean;
|
|
517
|
+
data: AlbumEnrichmentData;
|
|
518
|
+
}
|
|
519
|
+
export interface AlbumEnrichmentSourceInput {
|
|
520
|
+
data: AlbumEnrichmentData;
|
|
521
|
+
}
|
|
522
|
+
/** Rehydrates every wire-encoded scalar in a AlbumEnrichmentSource into its runtime type. Mutates and returns `raw`. */
|
|
523
|
+
export declare function reviveAlbumEnrichmentSource(raw: AlbumEnrichmentSource): AlbumEnrichmentSource;
|
|
524
|
+
/**
|
|
525
|
+
* One page of tracks, with what the station has of each and of the whole set
|
|
526
|
+
* generated from [TrackPage](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L234)
|
|
527
|
+
*/
|
|
528
|
+
export interface TrackPage {
|
|
529
|
+
meta: Pagination;
|
|
530
|
+
data: TrackRow[];
|
|
531
|
+
states: TrackStateCounts;
|
|
532
|
+
}
|
|
533
|
+
export interface TrackPageInput {
|
|
534
|
+
meta: PaginationInput;
|
|
535
|
+
data: TrackRowInput[];
|
|
536
|
+
states: TrackStateCountsInput;
|
|
537
|
+
}
|
|
538
|
+
/**
|
|
539
|
+
* Every provider's answer, plus the same merge the promotion step used, so the console and the
|
|
540
|
+
* canonical columns cannot tell different stories. `sources` is empty on a row the walk has not
|
|
541
|
+
* reached yet.
|
|
542
|
+
*
|
|
543
|
+
* `claims` sits beside them rather than inside `merged`, because a claim is the host's own and not
|
|
544
|
+
* any provider's. The articles they were read out of are deliberately NOT here: raw source prose is
|
|
545
|
+
* stored and never sent.
|
|
546
|
+
* generated from [TrackEnrichmentDetail](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L364)
|
|
547
|
+
*/
|
|
548
|
+
export interface TrackEnrichmentDetail {
|
|
549
|
+
trackId: string;
|
|
550
|
+
merged: TrackEnrichmentData;
|
|
551
|
+
sources: TrackEnrichmentSource[];
|
|
552
|
+
claims: FactClaim[];
|
|
553
|
+
}
|
|
554
|
+
export interface TrackEnrichmentDetailInput {
|
|
555
|
+
merged: TrackEnrichmentData;
|
|
556
|
+
sources: TrackEnrichmentSourceInput[];
|
|
557
|
+
claims: FactClaimInput[];
|
|
558
|
+
}
|
|
559
|
+
/** Rehydrates every wire-encoded scalar in a TrackEnrichmentDetail into its runtime type. Mutates and returns `raw`. */
|
|
560
|
+
export declare function reviveTrackEnrichmentDetail(raw: TrackEnrichmentDetail): TrackEnrichmentDetail;
|
|
561
|
+
/**
|
|
562
|
+
* generated from [ArtistEnrichmentDetail](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L371)
|
|
563
|
+
*/
|
|
564
|
+
export interface ArtistEnrichmentDetail {
|
|
565
|
+
artistId: string;
|
|
566
|
+
merged: ArtistEnrichmentData;
|
|
567
|
+
sources: ArtistEnrichmentSource[];
|
|
568
|
+
claims: FactClaim[];
|
|
569
|
+
}
|
|
570
|
+
export interface ArtistEnrichmentDetailInput {
|
|
571
|
+
merged: ArtistEnrichmentData;
|
|
572
|
+
sources: ArtistEnrichmentSourceInput[];
|
|
573
|
+
claims: FactClaimInput[];
|
|
574
|
+
}
|
|
575
|
+
/** Rehydrates every wire-encoded scalar in a ArtistEnrichmentDetail into its runtime type. Mutates and returns `raw`. */
|
|
576
|
+
export declare function reviveArtistEnrichmentDetail(raw: ArtistEnrichmentDetail): ArtistEnrichmentDetail;
|
|
577
|
+
/**
|
|
578
|
+
* generated from [AlbumEnrichmentDetail](../../../../../apps/api/data/contracts/catalog/catalog.types.ck#L378)
|
|
579
|
+
*/
|
|
580
|
+
export interface AlbumEnrichmentDetail {
|
|
581
|
+
albumId: string;
|
|
582
|
+
merged: AlbumEnrichmentData;
|
|
583
|
+
sources: AlbumEnrichmentSource[];
|
|
584
|
+
claims: FactClaim[];
|
|
585
|
+
}
|
|
586
|
+
export interface AlbumEnrichmentDetailInput {
|
|
587
|
+
merged: AlbumEnrichmentData;
|
|
588
|
+
sources: AlbumEnrichmentSourceInput[];
|
|
589
|
+
claims: FactClaimInput[];
|
|
590
|
+
}
|
|
591
|
+
/** Rehydrates every wire-encoded scalar in a AlbumEnrichmentDetail into its runtime type. Mutates and returns `raw`. */
|
|
592
|
+
export declare function reviveAlbumEnrichmentDetail(raw: AlbumEnrichmentDetail): AlbumEnrichmentDetail;
|
|
593
|
+
//# sourceMappingURL=catalog.types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"catalog.types.d.ts","sourceRoot":"","sources":["../../../src/catalog/types/catalog.types.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AACjC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kCAAkC,CAAC;AACnE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAC;AAYxE;;;;GAIG;AACH,MAAM,MAAM,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,UAAU,CAAC;AAEtD;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,YAAY;IACzB,mEAAmE;IACnE,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,gFAAgF;IAChF,QAAQ,EAAE,OAAO,CAAC;IAClB,yFAAyF;IACzF,SAAS,CAAC,EAAE,QAAQ,CAAC;IACrB,+EAA+E;IAC/E,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,QAAQ,CAAC;IACtB,oFAAoF;IACpF,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,QAAQ,CAAC;IACrB,YAAY,CAAC,EAAE,QAAQ,CAAC;IACxB,wDAAwD;IACxD,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,QAAQ,CAAC;CAC5B;AAED,MAAM,WAAW,iBAAiB;CAAG;AAErC,+GAA+G;AAC/G,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,YAAY,GAAG,YAAY,CAkBlE;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,aAAa;IAC1B,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,OAAO,CAAC;IAClB,sEAAsE;IACtE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,UAAU,CAAC,EAAE,QAAQ,CAAC;IACtB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,kBAAkB;CAAG;AAEtC,gHAAgH;AAChH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,aAAa,GAAG,aAAa,CASrE;AAED;;;GAGG;AACH,MAAM,WAAW,SAAS;IACtB,OAAO,EAAE,QAAQ,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,uCAAuC;IACvC,MAAM,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,cAAc;CAAG;AAElC,4GAA4G;AAC5G,wBAAgB,eAAe,CAAC,GAAG,EAAE,SAAS,GAAG,SAAS,CAIzD;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,gBAAgB;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,oEAAoE;IACpE,OAAO,EAAE,MAAM,CAAC;IAChB,oDAAoD;IACpD,MAAM,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,qBAAqB;CAAG;AAEzC;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACjC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,MAAM,GAAG,QAAQ,CAAC;AAE3E;;;;;;;;;GASG;AACH,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,UAAU,GAAG,YAAY,GAAG,SAAS,GAAG,SAAS,CAAC;AAEtF;;;;;;;;GAQG;AACH,MAAM,MAAM,SAAS,GAAG,OAAO,GAAG,QAAQ,GAAG,OAAO,GAAG,MAAM,GAAG,UAAU,GAAG,QAAQ,CAAC;AAEtF;;;;;;;;GAQG;AACH,MAAM,WAAW,gBAAgB;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,qBAAqB;CAAG;AAEzC;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACjC,qCAAqC;IACrC,MAAM,EAAE,MAAM,CAAC;IACf,EAAE,EAAE,MAAM,CAAC;CACd;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;CACf;AAED;;;;;GAKG;AACH,MAAM,WAAW,SAAS;IACtB,EAAE,EAAE,MAAM,CAAC;IACX,2CAA2C;IAC3C,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,2EAA2E;IAC3E,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,MAAM,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,qCAAqC;IACrC,UAAU,CAAC,EAAE,QAAQ,CAAC;CACzB;AAED,MAAM,WAAW,cAAc;CAAG;AAElC,4GAA4G;AAC5G,wBAAgB,eAAe,CAAC,GAAG,EAAE,SAAS,GAAG,SAAS,CAMzD;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACtB,MAAM,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,MAAM;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,kEAAkE;IAClE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,uEAAuE;IACvE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,8CAA8C;IAC9C,UAAU,EAAE,MAAM,CAAC;IACnB,8CAA8C;IAC9C,UAAU,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,WAAW;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,kEAAkE;IAClE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,uEAAuE;IACvE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,KAAK;IAClB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,iEAAiE;IACjE,UAAU,EAAE,MAAM,CAAC;IACnB,yEAAyE;IACzE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,uEAAuE;IACvE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,UAAU;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,yEAAyE;IACzE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,uEAAuE;IACvE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,KAAK;IAClB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,qFAAqF;IACrF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,uGAAuG;IACvG,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,6EAA6E;IAC7E,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,UAAU;IACvB,KAAK,EAAE,MAAM,CAAC;IACd,6EAA6E;IAC7E,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAa,SAAQ,UAAU;IAC5C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,WAAW,CAAC;CACxB;AAED,MAAM,WAAW,iBAAkB,SAAQ,eAAe;IACtD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,WAAW,CAAC;CACxB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,mBAAmB;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gDAAgD;IAChD,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,mFAAmF;IACnF,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,oBAAoB,EAAE,CAAC;IACrC,KAAK,CAAC,EAAE,cAAc,EAAE,CAAC;IACzB,sGAAsG;IACtG,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,WAAW,CAAC,EAAE,oBAAoB,EAAE,CAAC;IACrC,KAAK,CAAC,EAAE,cAAc,EAAE,CAAC;IACzB,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,+DAA+D;IAC/D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,iDAAiD;IACjD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IACjB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,oBAAoB,EAAE,CAAC;IACrC,KAAK,CAAC,EAAE,cAAc,EAAE,CAAC;IACzB,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACnC;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACvB,IAAI,EAAE,UAAU,CAAC;IACjB,IAAI,EAAE,MAAM,EAAE,CAAC;CAClB;AAED,MAAM,WAAW,eAAe;IAC5B,IAAI,EAAE,eAAe,CAAC;IACtB,IAAI,EAAE,WAAW,EAAE,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,WAAW,SAAS;IACtB,IAAI,EAAE,UAAU,CAAC;IACjB,IAAI,EAAE,KAAK,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,cAAc;IAC3B,IAAI,EAAE,eAAe,CAAC;IACtB,IAAI,EAAE,UAAU,EAAE,CAAC;CACtB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,WAAY,SAAQ,KAAK;IACtC,QAAQ,EAAE,YAAY,EAAE,CAAC;IACzB,mDAAmD;IACnD,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB,4CAA4C;IAC5C,KAAK,EAAE,SAAS,EAAE,CAAC;IACnB,sEAAsE;IACtE,SAAS,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAChD,QAAQ,EAAE,iBAAiB,EAAE,CAAC;IAC9B,mDAAmD;IACnD,QAAQ,CAAC,EAAE,kBAAkB,CAAC;IAC9B,4CAA4C;IAC5C,KAAK,EAAE,cAAc,EAAE,CAAC;CAC3B;AAED,8GAA8G;AAC9G,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,WAAW,GAAG,WAAW,CAkB/D;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,QAAS,SAAQ,KAAK;IACnC,oCAAoC;IACpC,QAAQ,EAAE,OAAO,CAAC;IAClB,2EAA2E;IAC3E,QAAQ,EAAE,OAAO,CAAC;IAClB,kDAAkD;IAClD,QAAQ,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,aAAc,SAAQ,UAAU;CAAG;AAEpD;;;;;;GAMG;AACH,MAAM,WAAW,UAAW,SAAQ,IAAI,CAAC,YAAY,EAAE,QAAQ,CAAC;IAC5D,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB,MAAM,CAAC,EAAE,SAAS,CAAC;CACtB;AAED,MAAM,WAAW,eAAgB,SAAQ,IAAI,CAAC,iBAAiB,EAAE,QAAQ,CAAC;IACtE,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB,MAAM,CAAC,EAAE,SAAS,CAAC;CACtB;AAED;;;;;GAKG;AACH,MAAM,WAAW,qBAAqB;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,4DAA4D;IAC5D,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,QAAQ,CAAC;IACpB,SAAS,CAAC,EAAE,QAAQ,CAAC;IACrB,oDAAoD;IACpD,KAAK,EAAE,OAAO,CAAC;IACf,KAAK,EAAE,OAAO,CAAC;IACf,8EAA8E;IAC9E,MAAM,EAAE,OAAO,CAAC;IAChB,IAAI,EAAE,mBAAmB,CAAC;CAC7B;AAED,MAAM,WAAW,0BAA0B;IACvC,IAAI,EAAE,mBAAmB,CAAC;CAC7B;AAED,wHAAwH;AACxH,wBAAgB,2BAA2B,CAAC,GAAG,EAAE,qBAAqB,GAAG,qBAAqB,CAO7F;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACnC,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,QAAQ,CAAC;IACpB,SAAS,CAAC,EAAE,QAAQ,CAAC;IACrB,KAAK,EAAE,OAAO,CAAC;IACf,KAAK,EAAE,OAAO,CAAC;IACf,8EAA8E;IAC9E,MAAM,EAAE,OAAO,CAAC;IAChB,IAAI,EAAE,oBAAoB,CAAC;CAC9B;AAED,MAAM,WAAW,2BAA2B;IACxC,IAAI,EAAE,oBAAoB,CAAC;CAC9B;AAED,yHAAyH;AACzH,wBAAgB,4BAA4B,CAAC,GAAG,EAAE,sBAAsB,GAAG,sBAAsB,CAOhG;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,QAAQ,CAAC;IACpB,SAAS,CAAC,EAAE,QAAQ,CAAC;IACrB,KAAK,EAAE,OAAO,CAAC;IACf,KAAK,EAAE,OAAO,CAAC;IACf,8EAA8E;IAC9E,MAAM,EAAE,OAAO,CAAC;IAChB,IAAI,EAAE,mBAAmB,CAAC;CAC7B;AAED,MAAM,WAAW,0BAA0B;IACvC,IAAI,EAAE,mBAAmB,CAAC;CAC7B;AAED,wHAAwH;AACxH,wBAAgB,2BAA2B,CAAC,GAAG,EAAE,qBAAqB,GAAG,qBAAqB,CAO7F;AAED;;;GAGG;AACH,MAAM,WAAW,SAAS;IACtB,IAAI,EAAE,UAAU,CAAC;IACjB,IAAI,EAAE,QAAQ,EAAE,CAAC;IACjB,MAAM,EAAE,gBAAgB,CAAC;CAC5B;AAED,MAAM,WAAW,cAAc;IAC3B,IAAI,EAAE,eAAe,CAAC;IACtB,IAAI,EAAE,aAAa,EAAE,CAAC;IACtB,MAAM,EAAE,qBAAqB,CAAC;CACjC;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,qBAAqB;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,mBAAmB,CAAC;IAC5B,OAAO,EAAE,qBAAqB,EAAE,CAAC;IACjC,MAAM,EAAE,SAAS,EAAE,CAAC;CACvB;AAED,MAAM,WAAW,0BAA0B;IACvC,MAAM,EAAE,mBAAmB,CAAC;IAC5B,OAAO,EAAE,0BAA0B,EAAE,CAAC;IACtC,MAAM,EAAE,cAAc,EAAE,CAAC;CAC5B;AAED,wHAAwH;AACxH,wBAAgB,2BAA2B,CAAC,GAAG,EAAE,qBAAqB,GAAG,qBAAqB,CAe7F;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACnC,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,oBAAoB,CAAC;IAC7B,OAAO,EAAE,sBAAsB,EAAE,CAAC;IAClC,MAAM,EAAE,SAAS,EAAE,CAAC;CACvB;AAED,MAAM,WAAW,2BAA2B;IACxC,MAAM,EAAE,oBAAoB,CAAC;IAC7B,OAAO,EAAE,2BAA2B,EAAE,CAAC;IACvC,MAAM,EAAE,cAAc,EAAE,CAAC;CAC5B;AAED,yHAAyH;AACzH,wBAAgB,4BAA4B,CAAC,GAAG,EAAE,sBAAsB,GAAG,sBAAsB,CAehG;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAClC,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,mBAAmB,CAAC;IAC5B,OAAO,EAAE,qBAAqB,EAAE,CAAC;IACjC,MAAM,EAAE,SAAS,EAAE,CAAC;CACvB;AAED,MAAM,WAAW,0BAA0B;IACvC,MAAM,EAAE,mBAAmB,CAAC;IAC5B,OAAO,EAAE,0BAA0B,EAAE,CAAC;IACtC,MAAM,EAAE,cAAc,EAAE,CAAC;CAC5B;AAED,wHAAwH;AACxH,wBAAgB,2BAA2B,CAAC,GAAG,EAAE,qBAAqB,GAAG,qBAAqB,CAe7F"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/catalog/types/index.ts"],"names":[],"mappings":"AACA,cAAc,oBAAoB,CAAC"}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import type { SdkFetch } from '../sdk-options.js';
|
|
2
|
+
import type { ChartPage, ChartQuery, StationChartList } from './types/charts.types.js';
|
|
3
|
+
export declare class ChartsClient {
|
|
4
|
+
private fetch;
|
|
5
|
+
constructor(fetch: SdkFetch);
|
|
6
|
+
/**
|
|
7
|
+
* @name List charts
|
|
8
|
+
* @description Every chart every installed chart plugin currently offers
|
|
9
|
+
*/
|
|
10
|
+
listCharts(): Promise<StationChartList>;
|
|
11
|
+
/**
|
|
12
|
+
* @name Read chart
|
|
13
|
+
* @description One chart's records, ranked
|
|
14
|
+
*/
|
|
15
|
+
readChart(id: string, query?: ChartQuery): Promise<ChartPage>;
|
|
16
|
+
}
|
|
17
|
+
//# sourceMappingURL=charts.client.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"charts.client.d.ts","sourceRoot":"","sources":["../../src/charts/charts.client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAElD,OAAO,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAEvF,qBAAa,YAAY;IACT,OAAO,CAAC,KAAK;gBAAL,KAAK,EAAE,QAAQ;IAEnC;;;OAGG;IACG,UAAU,IAAI,OAAO,CAAC,gBAAgB,CAAC;IAK7C;;;OAGG;IACG,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,SAAS,CAAC;CAOtE"}
|