@deadair/sdk 0.50.1 → 0.51.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.
Files changed (47) 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 +31 -17
  12. package/dist/director/types/director.types.d.ts.map +1 -1
  13. package/dist/director/types/rules.types.d.ts +5 -5
  14. package/dist/history/types/history.types.d.ts +3 -3
  15. package/dist/index.js +57 -1
  16. package/dist/index.js.map +1 -1
  17. package/dist/languages/types/languages.types.d.ts +4 -4
  18. package/dist/messaging/types/messaging.types.d.ts +3 -3
  19. package/dist/narrations/types/narrations.types.d.ts +5 -5
  20. package/dist/news/types/news.types.d.ts +5 -5
  21. package/dist/nowplaying/types/nowplaying.types.d.ts +5 -5
  22. package/dist/nowplaying/types/nowplaying.types.d.ts.map +1 -1
  23. package/dist/oauth/types/oauth.types.d.ts +17 -17
  24. package/dist/onboarding/types/onboarding.types.d.ts +4 -4
  25. package/dist/outputs/types/outputs.types.d.ts +7 -7
  26. package/dist/personas/types/personas.types.d.ts +40 -40
  27. package/dist/playlists/types/playlists.types.d.ts +7 -7
  28. package/dist/playlists/types/station.playlists.types.d.ts +13 -13
  29. package/dist/playout/types/playout.types.d.ts +16 -16
  30. package/dist/playout/types/playout.types.d.ts.map +1 -1
  31. package/dist/plugins/plugins.client.d.ts +1 -1
  32. package/dist/plugins/types/plugins.types.d.ts +33 -33
  33. package/dist/podcasts/types/podcasts.types.d.ts +8 -8
  34. package/dist/productions/types/productions.types.d.ts +4 -4
  35. package/dist/render/types/render.types.d.ts +38 -38
  36. package/dist/requests/types/requests.types.d.ts +9 -9
  37. package/dist/schedule/types/schedule.types.d.ts +16 -8
  38. package/dist/schedule/types/schedule.types.d.ts.map +1 -1
  39. package/dist/settings/types/settings.types.d.ts +6 -6
  40. package/dist/shared/types/pagination.d.ts +2 -2
  41. package/dist/station/types/logs.types.d.ts +6 -6
  42. package/dist/station/types/station.types.d.ts +10 -10
  43. package/dist/station/types/traces.types.d.ts +6 -6
  44. package/dist/storage/types/storage.types.d.ts +3 -3
  45. package/dist/stream/types/stream.types.d.ts +4 -4
  46. package/dist/topics/types/topics.types.d.ts +5 -5
  47. package/package.json +2 -2
@@ -7,7 +7,7 @@ import { DateTime } from 'luxon';
7
7
  * every one of those facts was already stored — the fetch error on `track_audio.last_error`, the
8
8
  * provider's refusal on `track_sources.playable` — and reachable only by finding the record and
9
9
  * hovering a cell on its page. This is that fact travelling with the row that counted it.
10
- * generated from [AttentionEvidence](../../../../../apps/api/data/contracts/station/station.types.ck#L14)
10
+ * generated from [AttentionEvidence](../../../../../apps/api/data/contracts/station/station.types.ck)
11
11
  */
12
12
  export interface AttentionEvidence {
13
13
  /** The thing itself, as an operator would name it: a record's title and who made it */
@@ -27,7 +27,7 @@ export interface AttentionEvidence {
27
27
  *
28
28
  * `lastBeat` is absent until a loop finishes its first pass, which is why `startedAt` is there: from
29
29
  * the two of them a reader can tell a loop that has never completed anything from one that stopped.
30
- * generated from [StationHeartbeat](../../../../../apps/api/data/contracts/station/station.types.ck#L46)
30
+ * generated from [StationHeartbeat](../../../../../apps/api/data/contracts/station/station.types.ck)
31
31
  */
32
32
  export interface StationHeartbeat {
33
33
  name: string;
@@ -45,7 +45,7 @@ export declare function reviveStationHeartbeat(raw: StationHeartbeat): StationHe
45
45
  *
46
46
  * The counts `/catalog/tracks` already answers with, lifted out of a page of rows: a check-up wants
47
47
  * the sentence "13 of 581 measured" without asking for thirteen tracks to get it.
48
- * generated from [StationBacklog](../../../../../apps/api/data/contracts/station/station.types.ck#L56)
48
+ * generated from [StationBacklog](../../../../../apps/api/data/contracts/station/station.types.ck)
49
49
  */
50
50
  export interface StationBacklog {
51
51
  total: number;
@@ -60,7 +60,7 @@ export interface StationBacklogInput {
60
60
  * The model is shared by every break, every programme refill and every production, one generation at
61
61
  * a time, so a slot held for far longer than any generation takes is the station's ability to speak
62
62
  * stuck behind one answer. Nothing else exposes it.
63
- * generated from [StationModelHolder](../../../../../apps/api/data/contracts/station/station.types.ck#L67)
63
+ * generated from [StationModelHolder](../../../../../apps/api/data/contracts/station/station.types.ck)
64
64
  */
65
65
  export interface StationModelHolder {
66
66
  /** Whose work it is: `breaking` and `air` have a deadline, `background` (a refill, a production) does not, `preview` is an operator trying something */
@@ -76,7 +76,7 @@ export interface StationModelHolderInput {
76
76
  export declare function reviveStationModelHolder(raw: StationModelHolder): StationModelHolder;
77
77
  /**
78
78
  * One release of the station, in the words its changelog entry used
79
- * generated from [StationRelease](../../../../../apps/api/data/contracts/station/station.types.ck#L108)
79
+ * generated from [StationRelease](../../../../../apps/api/data/contracts/station/station.types.ck)
80
80
  */
81
81
  export interface StationRelease {
82
82
  /** The release, as its tag names it without the leading `v` */
@@ -94,7 +94,7 @@ export interface StationReleaseInput {
94
94
  export declare function reviveStationRelease(raw: StationRelease): StationRelease;
95
95
  /**
96
96
  * One thing that wants the operator's attention, or the fact that nothing does
97
- * generated from [AttentionItem](../../../../../apps/api/data/contracts/station/station.types.ck#L21)
97
+ * generated from [AttentionItem](../../../../../apps/api/data/contracts/station/station.types.ck)
98
98
  */
99
99
  export interface AttentionItem {
100
100
  /** What this is, as a stable key: `silence`, `benchedCopies`, `noPersona`. The console groups and counts on it rather than on the sentence */
@@ -116,7 +116,7 @@ export interface AttentionItem {
116
116
  }
117
117
  /**
118
118
  * The model slot and its queue
119
- * generated from [StationModel](../../../../../apps/api/data/contracts/station/station.types.ck#L74)
119
+ * generated from [StationModel](../../../../../apps/api/data/contracts/station/station.types.ck)
120
120
  */
121
121
  export interface StationModel {
122
122
  /** Callers queued behind whoever holds the slot */
@@ -130,7 +130,7 @@ export interface StationModelInput {
130
130
  export declare function reviveStationModel(raw: StationModel): StationModel;
131
131
  /**
132
132
  * What this build is, and what changed in it
133
- * generated from [StationReleases](../../../../../apps/api/data/contracts/station/station.types.ck#L116)
133
+ * generated from [StationReleases](../../../../../apps/api/data/contracts/station/station.types.ck)
134
134
  */
135
135
  export interface StationReleases {
136
136
  /** The newest release this build contains, read off the changelog it was built with. Present on a build that follows `main` too, where `version` on the check-up is absent: every build carries the entry of the last release merged before it. Absent only when the build carries no changelog to read */
@@ -150,7 +150,7 @@ export interface StationReleasesInput {
150
150
  export declare function reviveStationReleases(raw: StationReleases): StationReleases;
151
151
  /**
152
152
  * Everything wrong or waiting, worst first
153
- * generated from [StationAttention](../../../../../apps/api/data/contracts/station/station.types.ck#L33)
153
+ * generated from [StationAttention](../../../../../apps/api/data/contracts/station/station.types.ck)
154
154
  */
155
155
  export interface StationAttention {
156
156
  items: AttentionItem[];
@@ -175,7 +175,7 @@ export interface StationAttention {
175
175
  * `operation(internal)`, deliberately, so it generates no SDK method and the console cannot call it
176
176
  * — which would leave "which build is this" answerable only from a shell, the one thing carrying it
177
177
  * here exists to fix.
178
- * generated from [StationCheckup](../../../../../apps/api/data/contracts/station/station.types.ck#L98)
178
+ * generated from [StationCheckup](../../../../../apps/api/data/contracts/station/station.types.ck)
179
179
  */
180
180
  export interface StationCheckup {
181
181
  /** When this reading was taken, so a stale page cannot pass itself off as now */
@@ -3,12 +3,12 @@ import { DateTime } from 'luxon';
3
3
  * Whether a call produced what it was asked for. Two values on purpose: every finer distinction —
4
4
  * timed out, was preempted, came back empty — is a fact the caller knew and the recorder did not, so
5
5
  * it lives in `detail` where it can be named
6
- * generated from [TraceOutcome](../../../../../apps/api/data/contracts/station/traces.types.ck#L10)
6
+ * generated from [TraceOutcome](../../../../../apps/api/data/contracts/station/traces.types.ck)
7
7
  */
8
8
  export type TraceOutcome = 'ok' | 'failed';
9
9
  /**
10
10
  * One decision, folded: a job execution or a request
11
- * generated from [TraceDecision](../../../../../apps/api/data/contracts/station/traces.types.ck#L22)
11
+ * generated from [TraceDecision](../../../../../apps/api/data/contracts/station/traces.types.ck)
12
12
  */
13
13
  export interface TraceDecision {
14
14
  /** The job id or the request id. Already the station's correlation id, never generated for this */
@@ -30,7 +30,7 @@ export interface TraceDecision {
30
30
  export declare function reviveTraceDecision(raw: TraceDecision): TraceDecision;
31
31
  /**
32
32
  * Which slice of the kept window to read
33
- * generated from [TracesQuery](../../../../../apps/api/data/contracts/station/traces.types.ck#L32)
33
+ * generated from [TracesQuery](../../../../../apps/api/data/contracts/station/traces.types.ck)
34
34
  */
35
35
  export interface TracesQuery {
36
36
  limit?: number;
@@ -41,7 +41,7 @@ export interface TracesQuery {
41
41
  }
42
42
  /**
43
43
  * One call inside a decision, and what it cost
44
- * generated from [TraceSpan](../../../../../apps/api/data/contracts/station/traces.types.ck#L12)
44
+ * generated from [TraceSpan](../../../../../apps/api/data/contracts/station/traces.types.ck)
45
45
  */
46
46
  export interface TraceSpan {
47
47
  /** When the call ended, which is when its cost was known */
@@ -61,7 +61,7 @@ export interface TraceSpan {
61
61
  /** Rehydrates every wire-encoded scalar in a TraceSpan into its runtime type. Mutates and returns `raw`. */
62
62
  export declare function reviveTraceSpan(raw: TraceSpan): TraceSpan;
63
63
  /**
64
- * generated from [TracesPage](../../../../../apps/api/data/contracts/station/traces.types.ck#L38)
64
+ * generated from [TracesPage](../../../../../apps/api/data/contracts/station/traces.types.ck)
65
65
  */
66
66
  export interface TracesPage {
67
67
  /** Newest first */
@@ -75,7 +75,7 @@ export interface TracesPage {
75
75
  export declare function reviveTracesPage(raw: TracesPage): TracesPage;
76
76
  /**
77
77
  * One decision, its calls, and the decisions on either side of it
78
- * generated from [TraceDetail](../../../../../apps/api/data/contracts/station/traces.types.ck#L44)
78
+ * generated from [TraceDetail](../../../../../apps/api/data/contracts/station/traces.types.ck)
79
79
  */
80
80
  export interface TraceDetail {
81
81
  decision: TraceDecision;
@@ -1,7 +1,7 @@
1
1
  import { DateTime } from 'luxon';
2
2
  /**
3
3
  * Which store, as a stable id the console can key off rather than a name it renders.
4
- * generated from [StorageStoreId](../../../../../apps/api/data/contracts/storage/storage.types.ck#L8)
4
+ * generated from [StorageStoreId](../../../../../apps/api/data/contracts/storage/storage.types.ck)
5
5
  */
6
6
  export type StorageStoreId = 'tracks' | 'art' | 'segments' | 'voices';
7
7
  /**
@@ -11,7 +11,7 @@ export type StorageStoreId = 'tracks' | 'art' | 'segments' | 'voices';
11
11
  * in two directions and each direction means something different — a file nothing claims is what a
12
12
  * crash between writing bytes and writing a row leaves behind, and a row whose file is gone is what
13
13
  * an operator emptying a directory leaves. Reporting one number would hide both.
14
- * generated from [StorageStore](../../../../../apps/api/data/contracts/storage/storage.types.ck#L16)
14
+ * generated from [StorageStore](../../../../../apps/api/data/contracts/storage/storage.types.ck)
15
15
  */
16
16
  export interface StorageStore {
17
17
  id: StorageStoreId;
@@ -43,7 +43,7 @@ export interface StorageStoreInput {
43
43
  * `readAt` is not decoration: the figures come from walking directories, which is real I/O on a
44
44
  * station holding tens of thousands of files, so the answer is cached for a short while and this is
45
45
  * what stops a page mistaking it for live.
46
- * generated from [StorageReport](../../../../../apps/api/data/contracts/storage/storage.types.ck#L35)
46
+ * generated from [StorageReport](../../../../../apps/api/data/contracts/storage/storage.types.ck)
47
47
  */
48
48
  export interface StorageReport {
49
49
  readAt: DateTime;
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  * What the station's track fetcher holds by way of a Spotify login
3
- * generated from [FetcherAuthorization](../../../../../apps/api/data/contracts/stream/stream.types.ck#L8)
3
+ * generated from [FetcherAuthorization](../../../../../apps/api/data/contracts/stream/stream.types.ck)
4
4
  */
5
5
  export interface FetcherAuthorization {
6
6
  /** Whether the fetcher answered at all. False makes every field below a default rather than a reading, so a fetcher that is merely down is never reported as one that was never authorized */
@@ -20,7 +20,7 @@ export interface FetcherAuthorization {
20
20
  }
21
21
  /**
22
22
  * An authorization to open in a browser
23
- * generated from [FetcherAuthorizationStart](../../../../../apps/api/data/contracts/stream/stream.types.ck#L19)
23
+ * generated from [FetcherAuthorizationStart](../../../../../apps/api/data/contracts/stream/stream.types.ck)
24
24
  */
25
25
  export interface FetcherAuthorizationStart {
26
26
  /** The Spotify consent page, to be opened by the operator */
@@ -30,7 +30,7 @@ export interface FetcherAuthorizationStart {
30
30
  }
31
31
  /**
32
32
  * The callback the browser could not deliver, handed over by the operator instead
33
- * generated from [FetcherAuthorizationInput](../../../../../apps/api/data/contracts/stream/stream.types.ck#L25)
33
+ * generated from [FetcherAuthorizationInput](../../../../../apps/api/data/contracts/stream/stream.types.ck)
34
34
  */
35
35
  export interface FetcherAuthorizationInput {
36
36
  /** The address the browser ended up at, pasted whole. Taken apart by the fetcher rather than here, because two readings of one address is one of them being wrong eventually */
@@ -38,7 +38,7 @@ export interface FetcherAuthorizationInput {
38
38
  }
39
39
  /**
40
40
  * Which account the station now fetches as
41
- * generated from [FetcherAuthorizationFinished](../../../../../apps/api/data/contracts/stream/stream.types.ck#L30)
41
+ * generated from [FetcherAuthorizationFinished](../../../../../apps/api/data/contracts/stream/stream.types.ck)
42
42
  */
43
43
  export interface FetcherAuthorizationFinished {
44
44
  /** The Spotify account that was authorized. Reported because an operator with two accounts in two browser profiles wants to know which one this station now is */
@@ -1,7 +1,7 @@
1
1
  import type { ConfigFieldDescriptor } from '../../plugins/types/plugins.types.js';
2
2
  /**
3
3
  * What a break can be about: a news category, and later a weather location. The operator's own vocabulary, per sort of break
4
- * generated from [Topic](../../../../../apps/api/data/contracts/topics/topics.types.ck#L8)
4
+ * generated from [Topic](../../../../../apps/api/data/contracts/topics/topics.types.ck)
5
5
  */
6
6
  export interface Topic {
7
7
  id: string;
@@ -30,7 +30,7 @@ export interface TopicInput {
30
30
  }
31
31
  /**
32
32
  * A sort of break that has subjects at all, and how one of its subjects is edited. `ConfigFieldDescriptor` is the plugins area's, shared for the reason a station setting shares it: one form component renders them all
33
- * generated from [TopicKindDescriptor](../../../../../apps/api/data/contracts/topics/topics.types.ck#L22)
33
+ * generated from [TopicKindDescriptor](../../../../../apps/api/data/contracts/topics/topics.types.ck)
34
34
  */
35
35
  export interface TopicKindDescriptor {
36
36
  kind: string;
@@ -41,14 +41,14 @@ export interface TopicKindDescriptor {
41
41
  fields: ConfigFieldDescriptor[];
42
42
  }
43
43
  /**
44
- * generated from [TopicQuery](../../../../../apps/api/data/contracts/topics/topics.types.ck#L34)
44
+ * generated from [TopicQuery](../../../../../apps/api/data/contracts/topics/topics.types.ck)
45
45
  */
46
46
  export interface TopicQuery {
47
47
  /** One sort of break, or absent for every subject this station has named */
48
48
  kind?: string;
49
49
  }
50
50
  /**
51
- * generated from [TopicList](../../../../../apps/api/data/contracts/topics/topics.types.ck#L17)
51
+ * generated from [TopicList](../../../../../apps/api/data/contracts/topics/topics.types.ck)
52
52
  */
53
53
  export interface TopicList {
54
54
  topics: Topic[];
@@ -57,7 +57,7 @@ export interface TopicListInput {
57
57
  topics: TopicInput[];
58
58
  }
59
59
  /**
60
- * generated from [TopicKindList](../../../../../apps/api/data/contracts/topics/topics.types.ck#L30)
60
+ * generated from [TopicKindList](../../../../../apps/api/data/contracts/topics/topics.types.ck)
61
61
  */
62
62
  export interface TopicKindList {
63
63
  kinds: TopicKindDescriptor[];
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@deadair/sdk",
3
- "version": "0.50.1",
3
+ "version": "0.51.0",
4
4
  "description": "A typed client for the deadair station's HTTP API, generated from the same contracts the station serves.",
5
5
  "keywords": [
6
6
  "deadair",
@@ -33,7 +33,7 @@
33
33
  "LICENSE"
34
34
  ],
35
35
  "dependencies": {
36
- "@types/luxon": "^3.7.3",
36
+ "@types/luxon": "^3.7.6",
37
37
  "luxon": "^3.7.2"
38
38
  },
39
39
  "devDependencies": {