@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.
Files changed (155) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +109 -0
  3. package/dist/activity/activity.client.d.ts +12 -0
  4. package/dist/activity/activity.client.d.ts.map +1 -0
  5. package/dist/activity/types/activity.types.d.ts +60 -0
  6. package/dist/activity/types/activity.types.d.ts.map +1 -0
  7. package/dist/activity/types/index.d.ts +2 -0
  8. package/dist/activity/types/index.d.ts.map +1 -0
  9. package/dist/art/art.client.d.ts +21 -0
  10. package/dist/art/art.client.d.ts.map +1 -0
  11. package/dist/authentication/authentication.client.d.ts +33 -0
  12. package/dist/authentication/authentication.client.d.ts.map +1 -0
  13. package/dist/authentication/authentication.factor.client.d.ts +41 -0
  14. package/dist/authentication/authentication.factor.client.d.ts.map +1 -0
  15. package/dist/authentication/authentication.sessions.client.d.ts +20 -0
  16. package/dist/authentication/authentication.sessions.client.d.ts.map +1 -0
  17. package/dist/authentication/types/authentication.types.d.ts +846 -0
  18. package/dist/authentication/types/authentication.types.d.ts.map +1 -0
  19. package/dist/authentication/types/index.d.ts +3 -0
  20. package/dist/authentication/types/index.d.ts.map +1 -0
  21. package/dist/authentication/types/registration.types.d.ts +336 -0
  22. package/dist/authentication/types/registration.types.d.ts.map +1 -0
  23. package/dist/catalog/catalog.client.d.ts +96 -0
  24. package/dist/catalog/catalog.client.d.ts.map +1 -0
  25. package/dist/catalog/types/catalog.types.d.ts +593 -0
  26. package/dist/catalog/types/catalog.types.d.ts.map +1 -0
  27. package/dist/catalog/types/index.d.ts +2 -0
  28. package/dist/catalog/types/index.d.ts.map +1 -0
  29. package/dist/charts/charts.client.d.ts +17 -0
  30. package/dist/charts/charts.client.d.ts.map +1 -0
  31. package/dist/charts/types/charts.types.d.ts +54 -0
  32. package/dist/charts/types/charts.types.d.ts.map +1 -0
  33. package/dist/charts/types/index.d.ts +2 -0
  34. package/dist/charts/types/index.d.ts.map +1 -0
  35. package/dist/deadair.sdk.d.ts +49 -0
  36. package/dist/deadair.sdk.d.ts.map +1 -0
  37. package/dist/director/director.client.d.ts +98 -0
  38. package/dist/director/director.client.d.ts.map +1 -0
  39. package/dist/director/types/clock.types.d.ts +57 -0
  40. package/dist/director/types/clock.types.d.ts.map +1 -0
  41. package/dist/director/types/director.types.d.ts +212 -0
  42. package/dist/director/types/director.types.d.ts.map +1 -0
  43. package/dist/director/types/index.d.ts +3 -0
  44. package/dist/director/types/index.d.ts.map +1 -0
  45. package/dist/history/history.client.d.ts +12 -0
  46. package/dist/history/history.client.d.ts.map +1 -0
  47. package/dist/history/types/history.types.d.ts +44 -0
  48. package/dist/history/types/history.types.d.ts.map +1 -0
  49. package/dist/history/types/index.d.ts +2 -0
  50. package/dist/history/types/index.d.ts.map +1 -0
  51. package/dist/index.d.ts +49 -0
  52. package/dist/index.d.ts.map +1 -0
  53. package/dist/index.js +3509 -0
  54. package/dist/index.js.map +1 -0
  55. package/dist/news/news.client.d.ts +17 -0
  56. package/dist/news/news.client.d.ts.map +1 -0
  57. package/dist/news/types/index.d.ts +2 -0
  58. package/dist/news/types/index.d.ts.map +1 -0
  59. package/dist/news/types/news.types.d.ts +61 -0
  60. package/dist/news/types/news.types.d.ts.map +1 -0
  61. package/dist/nowplaying/nowplaying.client.d.ts +12 -0
  62. package/dist/nowplaying/nowplaying.client.d.ts.map +1 -0
  63. package/dist/nowplaying/types/index.d.ts +2 -0
  64. package/dist/nowplaying/types/index.d.ts.map +1 -0
  65. package/dist/nowplaying/types/nowplaying.types.d.ts +59 -0
  66. package/dist/nowplaying/types/nowplaying.types.d.ts.map +1 -0
  67. package/dist/onboarding/onboarding.client.d.ts +11 -0
  68. package/dist/onboarding/onboarding.client.d.ts.map +1 -0
  69. package/dist/onboarding/types/index.d.ts +2 -0
  70. package/dist/onboarding/types/index.d.ts.map +1 -0
  71. package/dist/onboarding/types/onboarding.types.d.ts +41 -0
  72. package/dist/onboarding/types/onboarding.types.d.ts.map +1 -0
  73. package/dist/personas/personas.client.d.ts +167 -0
  74. package/dist/personas/personas.client.d.ts.map +1 -0
  75. package/dist/personas/types/index.d.ts +2 -0
  76. package/dist/personas/types/index.d.ts.map +1 -0
  77. package/dist/personas/types/personas.types.d.ts +545 -0
  78. package/dist/personas/types/personas.types.d.ts.map +1 -0
  79. package/dist/playlists/playlists.client.d.ts +17 -0
  80. package/dist/playlists/playlists.client.d.ts.map +1 -0
  81. package/dist/playlists/types/index.d.ts +2 -0
  82. package/dist/playlists/types/index.d.ts.map +1 -0
  83. package/dist/playlists/types/playlists.types.d.ts +71 -0
  84. package/dist/playlists/types/playlists.types.d.ts.map +1 -0
  85. package/dist/playout/playout.client.d.ts +37 -0
  86. package/dist/playout/playout.client.d.ts.map +1 -0
  87. package/dist/playout/types/index.d.ts +2 -0
  88. package/dist/playout/types/index.d.ts.map +1 -0
  89. package/dist/playout/types/playout.types.d.ts +163 -0
  90. package/dist/playout/types/playout.types.d.ts.map +1 -0
  91. package/dist/plugins/plugins.client.d.ts +107 -0
  92. package/dist/plugins/plugins.client.d.ts.map +1 -0
  93. package/dist/plugins/types/index.d.ts +2 -0
  94. package/dist/plugins/types/index.d.ts.map +1 -0
  95. package/dist/plugins/types/plugins.types.d.ts +330 -0
  96. package/dist/plugins/types/plugins.types.d.ts.map +1 -0
  97. package/dist/productions/productions.client.d.ts +22 -0
  98. package/dist/productions/productions.client.d.ts.map +1 -0
  99. package/dist/productions/types/index.d.ts +2 -0
  100. package/dist/productions/types/index.d.ts.map +1 -0
  101. package/dist/productions/types/productions.types.d.ts +90 -0
  102. package/dist/productions/types/productions.types.d.ts.map +1 -0
  103. package/dist/render/render.client.d.ts +210 -0
  104. package/dist/render/render.client.d.ts.map +1 -0
  105. package/dist/render/types/index.d.ts +2 -0
  106. package/dist/render/types/index.d.ts.map +1 -0
  107. package/dist/render/types/render.types.d.ts +518 -0
  108. package/dist/render/types/render.types.d.ts.map +1 -0
  109. package/dist/schedule/schedule.client.d.ts +37 -0
  110. package/dist/schedule/schedule.client.d.ts.map +1 -0
  111. package/dist/schedule/types/index.d.ts +2 -0
  112. package/dist/schedule/types/index.d.ts.map +1 -0
  113. package/dist/schedule/types/schedule.types.d.ts +119 -0
  114. package/dist/schedule/types/schedule.types.d.ts.map +1 -0
  115. package/dist/sdk-options.d.ts +45 -0
  116. package/dist/sdk-options.d.ts.map +1 -0
  117. package/dist/settings/settings.client.d.ts +17 -0
  118. package/dist/settings/settings.client.d.ts.map +1 -0
  119. package/dist/settings/types/index.d.ts +2 -0
  120. package/dist/settings/types/index.d.ts.map +1 -0
  121. package/dist/settings/types/settings.types.d.ts +35 -0
  122. package/dist/settings/types/settings.types.d.ts.map +1 -0
  123. package/dist/shared/types/index.d.ts +2 -0
  124. package/dist/shared/types/index.d.ts.map +1 -0
  125. package/dist/shared/types/pagination.d.ts +34 -0
  126. package/dist/shared/types/pagination.d.ts.map +1 -0
  127. package/dist/station/station.client.d.ts +49 -0
  128. package/dist/station/station.client.d.ts.map +1 -0
  129. package/dist/station/types/index.d.ts +4 -0
  130. package/dist/station/types/index.d.ts.map +1 -0
  131. package/dist/station/types/logs.types.d.ts +73 -0
  132. package/dist/station/types/logs.types.d.ts.map +1 -0
  133. package/dist/station/types/station.types.d.ts +120 -0
  134. package/dist/station/types/station.types.d.ts.map +1 -0
  135. package/dist/station/types/traces.types.d.ts +91 -0
  136. package/dist/station/types/traces.types.d.ts.map +1 -0
  137. package/dist/storage/storage.client.d.ts +12 -0
  138. package/dist/storage/storage.client.d.ts.map +1 -0
  139. package/dist/storage/types/index.d.ts +2 -0
  140. package/dist/storage/types/index.d.ts.map +1 -0
  141. package/dist/storage/types/storage.types.d.ts +59 -0
  142. package/dist/storage/types/storage.types.d.ts.map +1 -0
  143. package/dist/stream/stream.client.d.ts +32 -0
  144. package/dist/stream/stream.client.d.ts.map +1 -0
  145. package/dist/stream/types/index.d.ts +2 -0
  146. package/dist/stream/types/index.d.ts.map +1 -0
  147. package/dist/stream/types/stream.types.d.ts +47 -0
  148. package/dist/stream/types/stream.types.d.ts.map +1 -0
  149. package/dist/topics/topics.client.d.ts +32 -0
  150. package/dist/topics/topics.client.d.ts.map +1 -0
  151. package/dist/topics/types/index.d.ts +2 -0
  152. package/dist/topics/types/index.d.ts.map +1 -0
  153. package/dist/topics/types/topics.types.d.ts +65 -0
  154. package/dist/topics/types/topics.types.d.ts.map +1 -0
  155. package/package.json +53 -0
@@ -0,0 +1,17 @@
1
+ import type { SdkFetch } from '../sdk-options.js';
2
+ import type { NewsPage, NewsQuery, StationFeedList } from './types/news.types.js';
3
+ export declare class NewsClient {
4
+ private fetch;
5
+ constructor(fetch: SdkFetch);
6
+ /**
7
+ * @name List feeds
8
+ * @description Every feed every installed news plugin currently offers
9
+ */
10
+ listFeeds(): Promise<StationFeedList>;
11
+ /**
12
+ * @name Read news
13
+ * @description Published entries, newest first
14
+ */
15
+ readNews(query?: NewsQuery): Promise<NewsPage>;
16
+ }
17
+ //# sourceMappingURL=news.client.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"news.client.d.ts","sourceRoot":"","sources":["../../src/news/news.client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAElD,OAAO,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAElF,qBAAa,UAAU;IACP,OAAO,CAAC,KAAK;gBAAL,KAAK,EAAE,QAAQ;IAEnC;;;OAGG;IACG,SAAS,IAAI,OAAO,CAAC,eAAe,CAAC;IAK3C;;;OAGG;IACG,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,GAAG,OAAO,CAAC,QAAQ,CAAC;CAOvD"}
@@ -0,0 +1,2 @@
1
+ export * from './news.types.js';
2
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/news/types/index.ts"],"names":[],"mappings":"AACA,cAAc,iBAAiB,CAAC"}
@@ -0,0 +1,61 @@
1
+ /**
2
+ * A feed one installed plugin offers
3
+ * generated from [StationFeed](../../../../../apps/api/data/contracts/news/news.types.ck#L7)
4
+ */
5
+ export interface StationFeed {
6
+ /** Unique across the station: the plugin's own id for the feed, qualified with the plugin that offered it. Two services both calling something `world` stay distinct */
7
+ id: string;
8
+ pluginId: string;
9
+ name: string;
10
+ /** Broad subject, in the publisher's own word for it */
11
+ category?: string;
12
+ /** ISO 639-1, when the plugin knows */
13
+ language?: string;
14
+ description?: string;
15
+ }
16
+ /**
17
+ * One published entry
18
+ * generated from [NewsStory](../../../../../apps/api/data/contracts/news/news.types.ck#L20)
19
+ */
20
+ export interface NewsStory {
21
+ /** Stable for the same entry across calls, which is what lets a reader tell an arrival from something it has already seen */
22
+ id: string;
23
+ /** Qualified, matching `StationFeed.id` */
24
+ feedId: string;
25
+ feedName: string;
26
+ title: string;
27
+ /** The publisher's own teaser, as plain text. Never markup: this is written to be read out */
28
+ summary?: string;
29
+ /** The story itself, as the publisher's own paragraphs. Absent when the plugin could not read one, which is ordinary: an entry that links to audio, or a page nothing could be extracted from */
30
+ content?: string;
31
+ url?: string;
32
+ /** ISO-8601 */
33
+ publishedAt?: string;
34
+ categories?: string[];
35
+ }
36
+ /**
37
+ * generated from [NewsQuery](../../../../../apps/api/data/contracts/news/news.types.ck#L32)
38
+ */
39
+ export interface NewsQuery {
40
+ /** One feed, or absent for every feed the station can see, merged newest first */
41
+ feedId?: string;
42
+ limit?: number;
43
+ /** Only entries published after this ISO-8601 instant */
44
+ since?: string;
45
+ /** Answer with headlines and teasers alone, skipping the story behind each one. A story is read from the publisher's own page, which is by far the slowest thing this route does, so a caller that will not use `content` should say so */
46
+ headlinesOnly?: boolean;
47
+ }
48
+ /**
49
+ * generated from [StationFeedList](../../../../../apps/api/data/contracts/news/news.types.ck#L16)
50
+ */
51
+ export interface StationFeedList {
52
+ feeds: StationFeed[];
53
+ }
54
+ /**
55
+ * generated from [NewsPage](../../../../../apps/api/data/contracts/news/news.types.ck#L39)
56
+ */
57
+ export interface NewsPage {
58
+ /** Newest first. Empty when nothing could be read, which is deliberately not an error: the news is something the station may talk about, never something it needs to air */
59
+ stories: NewsStory[];
60
+ }
61
+ //# sourceMappingURL=news.types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"news.types.d.ts","sourceRoot":"","sources":["../../../src/news/types/news.types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,WAAW;IACxB,wKAAwK;IACxK,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,wDAAwD;IACxD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,uCAAuC;IACvC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,SAAS;IACtB,6HAA6H;IAC7H,EAAE,EAAE,MAAM,CAAC;IACX,2CAA2C;IAC3C,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,8FAA8F;IAC9F,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,iMAAiM;IACjM,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,eAAe;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACtB,kFAAkF;IAClF,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,yDAAyD;IACzD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,2OAA2O;IAC3O,aAAa,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B,KAAK,EAAE,WAAW,EAAE,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACrB,4KAA4K;IAC5K,OAAO,EAAE,SAAS,EAAE,CAAC;CACxB"}
@@ -0,0 +1,12 @@
1
+ import type { SdkFetch } from '../sdk-options.js';
2
+ import type { NowPlaying } from './types/nowplaying.types.js';
3
+ export declare class NowplayingClient {
4
+ private fetch;
5
+ constructor(fetch: SdkFetch);
6
+ /**
7
+ * @name Get now playing
8
+ * @description What is on air right now. Answers 200 with `onAir: false` when the station is quiet, so a device polling this treats silence as an answer rather than an error
9
+ */
10
+ getNowPlaying(): Promise<NowPlaying>;
11
+ }
12
+ //# sourceMappingURL=nowplaying.client.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"nowplaying.client.d.ts","sourceRoot":"","sources":["../../src/nowplaying/nowplaying.client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAElD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AAE9D,qBAAa,gBAAgB;IACb,OAAO,CAAC,KAAK;gBAAL,KAAK,EAAE,QAAQ;IAEnC;;;OAGG;IACG,aAAa,IAAI,OAAO,CAAC,UAAU,CAAC;CAI7C"}
@@ -0,0 +1,2 @@
1
+ export * from './nowplaying.types.js';
2
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/nowplaying/types/index.ts"],"names":[],"mappings":"AACA,cAAc,uBAAuB,CAAC"}
@@ -0,0 +1,59 @@
1
+ /**
2
+ * What a listener is hearing right now: a record, or the station talking
3
+ * generated from [NowPlayingTrack](../../../../../apps/api/data/contracts/nowplaying/nowplaying.types.ck#L7)
4
+ */
5
+ export interface NowPlayingTrack {
6
+ /** `record` is music. `break` is the station speaking on its own between two records (an ident, a bulletin, a talk break), with `artist` empty and `title` the break's own label. A presenter talking over the start of a record is not a break: the record is what is on air, and it stays `record`. Absent means `record`, which is all a station older than this field ever reported */
7
+ kind?: 'record' | 'break';
8
+ title: string;
9
+ /** Comma-joined, as a display line rather than a list: this is what a player or a device shows, not something to iterate. Empty for a `break` */
10
+ artist: string;
11
+ album?: string;
12
+ /** The station's own cached cover where there is one, the provider's URL otherwise. Relative values are paths under the API root */
13
+ artworkUrl?: string;
14
+ durationMs?: number;
15
+ /** Unix epoch millis, as observed when the player reported the track started */
16
+ startedAt: number;
17
+ /** Absent when the decoder cannot say. It leads the listener by the encoder and client buffers, so it is a display value and not a schedule */
18
+ remainingMs?: number;
19
+ }
20
+ /**
21
+ * One way to listen to this station right now
22
+ * generated from [NowPlayingMount](../../../../../apps/api/data/contracts/nowplaying/nowplaying.types.ck#L18)
23
+ */
24
+ export interface NowPlayingMount {
25
+ /** `hls` is the master playlist rather than an Icecast mount, which is why this enum has an arm `PlayoutMount` does not */
26
+ format: 'mp3' | 'opus' | 'aac' | 'flac' | 'hls';
27
+ /** Same-origin path, leading slash included. A path and not a URL: the station is reached through whatever edge served this answer, never at the address the app itself uses */
28
+ path: string;
29
+ /** Absent for FLAC, which is lossless and has no rate to set, and for HLS, whose rate is the AAC variant's */
30
+ bitrateKbps?: number;
31
+ }
32
+ /**
33
+ * The programme on air, as a listener would be told it
34
+ * generated from [NowPlayingShow](../../../../../apps/api/data/contracts/nowplaying/nowplaying.types.ck#L24)
35
+ */
36
+ export interface NowPlayingShow {
37
+ /** What this broadcast is called. It changes the moment the station changes programme, which can be one record before the new programme's first record is heard: a changeover never cuts a listener off mid-record */
38
+ name: string;
39
+ /** Who is presenting, by the name they go by on air. Absent when there is no name to give: no persona on air with one, and no station-wide presenter name set. Never the persona's console label */
40
+ host?: string;
41
+ }
42
+ /**
43
+ * What the station is playing, for anything that wants to display it
44
+ * generated from [NowPlaying](../../../../../apps/api/data/contracts/nowplaying/nowplaying.types.ck#L29)
45
+ */
46
+ export interface NowPlaying {
47
+ /** The station's on-air name */
48
+ station: string;
49
+ /** False means the station is not broadcasting. `track` is absent in that case, which is an ordinary state and not an error */
50
+ onAir: boolean;
51
+ /** How many people are listening right now. Public because it says only what Icecast's own status document already says to anyone who asks, and a station page should not need a session to show it */
52
+ listeners: number;
53
+ /** Every way to listen, MP3 first. Never empty: MP3 has no switch. A format the operator has not switched on is ABSENT rather than present and disabled, because a client asking this wants the mounts that are actually there — and a client that had to find out by connecting to each one would put an audience-gated station on air to do it */
54
+ mounts: NowPlayingMount[];
55
+ /** Present whenever `track` is and the station has said what programme it belongs to. Absent off air, and while a station warming up has nothing airing yet */
56
+ show?: NowPlayingShow;
57
+ track?: NowPlayingTrack;
58
+ }
59
+ //# sourceMappingURL=nowplaying.types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"nowplaying.types.d.ts","sourceRoot":"","sources":["../../../src/nowplaying/types/nowplaying.types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC5B,2XAA2X;IAC3X,IAAI,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,iJAAiJ;IACjJ,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,oIAAoI;IACpI,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,gFAAgF;IAChF,SAAS,EAAE,MAAM,CAAC;IAClB,+IAA+I;IAC/I,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC5B,2HAA2H;IAC3H,MAAM,EAAE,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,CAAC;IAChD,gLAAgL;IAChL,IAAI,EAAE,MAAM,CAAC;IACb,8GAA8G;IAC9G,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC3B,sNAAsN;IACtN,IAAI,EAAE,MAAM,CAAC;IACb,oMAAoM;IACpM,IAAI,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACvB,gCAAgC;IAChC,OAAO,EAAE,MAAM,CAAC;IAChB,+HAA+H;IAC/H,KAAK,EAAE,OAAO,CAAC;IACf,uMAAuM;IACvM,SAAS,EAAE,MAAM,CAAC;IAClB,oVAAoV;IACpV,MAAM,EAAE,eAAe,EAAE,CAAC;IAC1B,+JAA+J;IAC/J,IAAI,CAAC,EAAE,cAAc,CAAC;IACtB,KAAK,CAAC,EAAE,eAAe,CAAC;CAC3B"}
@@ -0,0 +1,11 @@
1
+ import type { SdkFetch } from '../sdk-options.js';
2
+ import type { OnboardingRequirement, OnboardingRequirementInput } from './types/onboarding.types.js';
3
+ export declare class OnboardingClient {
4
+ private fetch;
5
+ constructor(fetch: SdkFetch);
6
+ /** @name Get Onboarding Requirements */
7
+ getOnboardingRequirements(): Promise<OnboardingRequirement[]>;
8
+ /** @name Submit Onboarding Requirement */
9
+ submitOnboardingRequirement(body: OnboardingRequirementInput): Promise<OnboardingRequirement[]>;
10
+ }
11
+ //# sourceMappingURL=onboarding.client.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"onboarding.client.d.ts","sourceRoot":"","sources":["../../src/onboarding/onboarding.client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAElD,OAAO,KAAK,EAAE,qBAAqB,EAAE,0BAA0B,EAAE,MAAM,6BAA6B,CAAC;AAErG,qBAAa,gBAAgB;IACb,OAAO,CAAC,KAAK;gBAAL,KAAK,EAAE,QAAQ;IAEnC,wCAAwC;IAClC,yBAAyB,IAAI,OAAO,CAAC,qBAAqB,EAAE,CAAC;IAKnE,0CAA0C;IACpC,2BAA2B,CAAC,IAAI,EAAE,0BAA0B,GAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC;CAQxG"}
@@ -0,0 +1,2 @@
1
+ export * from './onboarding.types.js';
2
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/onboarding/types/index.ts"],"names":[],"mappings":"AACA,cAAc,uBAAuB,CAAC"}
@@ -0,0 +1,41 @@
1
+ /**
2
+ * generated from [OnboardingRequirementKey](../../../../../apps/api/data/contracts/onboarding/onboarding.types.ck#L7)
3
+ */
4
+ export type OnboardingRequirementKey = 'admin.account';
5
+ /**
6
+ * A single onboarding requirement
7
+ * generated from [CoreOnboardingRequirement](../../../../../apps/api/data/contracts/onboarding/onboarding.types.ck#L9)
8
+ */
9
+ export interface CoreOnboardingRequirement {
10
+ /** The key of the requirement */
11
+ key: OnboardingRequirementKey;
12
+ /** Human-readable label for the onboarding checklist */
13
+ title: string;
14
+ /** Optional longer explanation */
15
+ description?: string;
16
+ /** Whether the requirement is optional for onboarding */
17
+ optional: boolean;
18
+ }
19
+ export interface CoreOnboardingRequirementInput {
20
+ /** The key of the requirement */
21
+ key: OnboardingRequirementKey;
22
+ }
23
+ /**
24
+ * generated from [AdminAccountOnboardingRequirement](../../../../../apps/api/data/contracts/onboarding/onboarding.types.ck#L16)
25
+ */
26
+ export interface AdminAccountOnboardingRequirement extends Omit<CoreOnboardingRequirement, 'key'> {
27
+ key: 'admin.account';
28
+ }
29
+ export interface AdminAccountOnboardingRequirementInput extends Omit<CoreOnboardingRequirementInput, 'key'> {
30
+ key: 'admin.account';
31
+ value: {
32
+ email: string;
33
+ password: string;
34
+ };
35
+ }
36
+ /**
37
+ * generated from [OnboardingRequirement](../../../../../apps/api/data/contracts/onboarding/onboarding.types.ck#L24)
38
+ */
39
+ export type OnboardingRequirement = AdminAccountOnboardingRequirement;
40
+ export type OnboardingRequirementInput = AdminAccountOnboardingRequirementInput;
41
+ //# sourceMappingURL=onboarding.types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"onboarding.types.d.ts","sourceRoot":"","sources":["../../../src/onboarding/types/onboarding.types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,eAAe,CAAC;AAEvD;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACtC,iCAAiC;IACjC,GAAG,EAAE,wBAAwB,CAAC;IAC9B,wDAAwD;IACxD,KAAK,EAAE,MAAM,CAAC;IACd,kCAAkC;IAClC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,yDAAyD;IACzD,QAAQ,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,8BAA8B;IAC3C,iCAAiC;IACjC,GAAG,EAAE,wBAAwB,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,iCAAkC,SAAQ,IAAI,CAAC,yBAAyB,EAAE,KAAK,CAAC;IAC7F,GAAG,EAAE,eAAe,CAAC;CACxB;AAED,MAAM,WAAW,sCAAuC,SAAQ,IAAI,CAAC,8BAA8B,EAAE,KAAK,CAAC;IACvG,GAAG,EAAE,eAAe,CAAC;IACrB,KAAK,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC;CAC9C;AAED;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,iCAAiC,CAAC;AACtE,MAAM,MAAM,0BAA0B,GAAG,sCAAsC,CAAC"}
@@ -0,0 +1,167 @@
1
+ import type { SdkFetch } from '../sdk-options.js';
2
+ import type { GeneratedPersona, PersonaAudition, PersonaAuditionList, PersonaAuditionRequest, PersonaAuditionSummary, PersonaFile, PersonaImportPlan, PersonaImportResult, PersonaInput, PersonaList, PersonaNoteList, PersonaNoteState, PersonaNoteWrite, PersonaRehearsal, PersonaRequest, PersonaStoryDetailWrite, PersonaStoryList, PersonaStoryState, PersonaStoryWrite } from './types/personas.types.js';
3
+ export declare class PersonasClient {
4
+ private fetch;
5
+ constructor(fetch: SdkFetch);
6
+ /**
7
+ * @name List persona auditions
8
+ * @description Every audition of this character, newest first, without their breaks
9
+ */
10
+ listPersonaAuditions(id: string): Promise<PersonaAuditionList>;
11
+ /**
12
+ * @name Start persona audition
13
+ * @description Asks the station to put this character through a playlist. It is queued, not written
14
+ */
15
+ startPersonaAudition(id: string, body: PersonaAuditionRequest): Promise<PersonaAudition>;
16
+ /**
17
+ * @name Get persona audition
18
+ * @description One audition with every break it has written so far, in order
19
+ */
20
+ getPersonaAudition(id: string, auditionId: string): Promise<PersonaAudition>;
21
+ /**
22
+ * @name Cancel persona audition
23
+ * @description Stops an audition where it stands, keeping the breaks it has already written
24
+ */
25
+ cancelPersonaAudition(id: string, auditionId: string): Promise<PersonaAuditionSummary>;
26
+ /**
27
+ * @name List personas
28
+ * @description Every persona this station has, oldest first
29
+ */
30
+ listPersonas(): Promise<PersonaList>;
31
+ /**
32
+ * @name Create persona
33
+ * @description Writes a new persona. It is not put on air by creating it
34
+ */
35
+ createPersona(body: PersonaInput): Promise<PersonaList>;
36
+ /**
37
+ * @name Generate persona
38
+ * @description Turns a description of a character into a whole persona, checked against its own sample lines and handed back unsaved
39
+ */
40
+ generatePersona(body: PersonaRequest): Promise<GeneratedPersona>;
41
+ /**
42
+ * @name Restore station personas
43
+ * @description Writes back whichever of the station's own personas this station is missing, touching nothing it already has and putting nothing on air
44
+ */
45
+ restoreStationPersonas(): Promise<PersonaList>;
46
+ /**
47
+ * @name Export personas
48
+ * @description Every character this station holds, as one file
49
+ */
50
+ exportPersonas(): Promise<{
51
+ data: PersonaFile;
52
+ headers: {
53
+ contentDisposition?: string;
54
+ };
55
+ }>;
56
+ /**
57
+ * @name Export persona
58
+ * @description One character, its sheet and its stories, as a file
59
+ */
60
+ exportPersona(id: string): Promise<{
61
+ data: PersonaFile;
62
+ headers: {
63
+ contentDisposition?: string;
64
+ };
65
+ }>;
66
+ /**
67
+ * @name Preview persona import
68
+ * @description Reads a file and reports what importing it would create, rewrite and skip. Writes nothing
69
+ */
70
+ previewPersonaImport(body: PersonaFile): Promise<PersonaImportPlan>;
71
+ /**
72
+ * @name Import personas
73
+ * @description Writes a file into this station, merging by key, and answers with what it did
74
+ */
75
+ importPersonas(body: PersonaFile): Promise<PersonaImportResult>;
76
+ /**
77
+ * @name Update persona
78
+ * @description Rewrites one persona. An edit to the one on air is heard on the next break
79
+ */
80
+ updatePersona(id: string, body: PersonaInput): Promise<PersonaList>;
81
+ /**
82
+ * @name Delete persona
83
+ * @description Removes a persona, including the one on air, which leaves the station with none
84
+ */
85
+ deletePersona(id: string): Promise<PersonaList>;
86
+ /**
87
+ * @name Put persona on air
88
+ * @description Puts this persona on air and takes the previous one off
89
+ */
90
+ putPersonaOnAir(id: string): Promise<PersonaList>;
91
+ /**
92
+ * @name List persona notes
93
+ * @description Everything this character has accumulated, oldest first, in every state
94
+ */
95
+ listPersonaNotes(id: string): Promise<PersonaNoteList>;
96
+ /**
97
+ * @name Write persona note
98
+ * @description Writes a note by hand. An operator's own note is active from the moment it exists; only the distil pass proposes
99
+ */
100
+ writePersonaNote(id: string, body: PersonaNoteWrite): Promise<PersonaNoteList>;
101
+ /**
102
+ * @name Update persona note
103
+ * @description Rewrites one note's words, whoever wrote it. Editing what the station proposed is most of the point of the panel
104
+ */
105
+ updatePersonaNote(id: string, noteId: string, body: PersonaNoteWrite): Promise<PersonaNoteList>;
106
+ /**
107
+ * @name Delete persona note
108
+ * @description Removes a note outright. Turning down a PROPOSAL is a state rather than this, or the next pass writes it again
109
+ */
110
+ deletePersonaNote(id: string, noteId: string): Promise<PersonaNoteList>;
111
+ /**
112
+ * @name Set persona note state
113
+ * @description Accepts a proposal, turns one down, or rests an active note. Mirrors the lexicon's own state route
114
+ */
115
+ setPersonaNoteState(id: string, noteId: string, body: PersonaNoteState): Promise<PersonaNoteList>;
116
+ /**
117
+ * @name List persona stories
118
+ * @description Every story this character holds, oldest first, in every state
119
+ */
120
+ listPersonaStories(id: string): Promise<PersonaStoryList>;
121
+ /**
122
+ * @name Write persona story
123
+ * @description Writes a story by hand. An operator's own is tellable from the moment it exists; only the enrichment pass proposes
124
+ */
125
+ writePersonaStory(id: string, body: PersonaStoryWrite): Promise<PersonaStoryList>;
126
+ /**
127
+ * @name Update persona story
128
+ * @description Rewrites one story's handle and telling, whoever wrote it
129
+ */
130
+ updatePersonaStory(id: string, storyId: string, body: PersonaStoryWrite): Promise<PersonaStoryList>;
131
+ /**
132
+ * @name Delete persona story
133
+ * @description Removes a story outright, details and all. Turning down a PROPOSAL is a state rather than this, or the next pass writes it again
134
+ */
135
+ deletePersonaStory(id: string, storyId: string): Promise<PersonaStoryList>;
136
+ /**
137
+ * @name Set persona story state
138
+ * @description Accepts a proposal, turns one down, or takes a story out of the rotation without losing it
139
+ */
140
+ setPersonaStoryState(id: string, storyId: string, body: PersonaStoryState): Promise<PersonaStoryList>;
141
+ /**
142
+ * @name Add persona story detail
143
+ * @description Adds one thing to a story that already exists
144
+ */
145
+ addPersonaStoryDetail(id: string, storyId: string, body: PersonaStoryDetailWrite): Promise<PersonaStoryList>;
146
+ /**
147
+ * @name Update persona story detail
148
+ * @description Rewrites one detail's words
149
+ */
150
+ updatePersonaStoryDetail(id: string, storyId: string, detailId: string, body: PersonaStoryDetailWrite): Promise<PersonaStoryList>;
151
+ /**
152
+ * @name Delete persona story detail
153
+ * @description Removes one detail, leaving the story it was hung on alone
154
+ */
155
+ deletePersonaStoryDetail(id: string, storyId: string, detailId: string): Promise<PersonaStoryList>;
156
+ /**
157
+ * @name Set persona story detail state
158
+ * @description Accepts a proposed detail or turns it down, which has to outlive the pass that proposed it
159
+ */
160
+ setPersonaStoryDetailState(id: string, storyId: string, detailId: string, body: PersonaStoryState): Promise<PersonaStoryList>;
161
+ /**
162
+ * @name Rehearse persona
163
+ * @description Writes a talk break under this persona against two fixed invented records, and answers with every writer that was asked
164
+ */
165
+ rehearsePersona(id: string): Promise<PersonaRehearsal>;
166
+ }
167
+ //# sourceMappingURL=personas.client.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"personas.client.d.ts","sourceRoot":"","sources":["../../src/personas/personas.client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAElD,OAAO,KAAK,EACR,gBAAgB,EAChB,eAAe,EACf,mBAAmB,EACnB,sBAAsB,EACtB,sBAAsB,EACtB,WAAW,EACX,iBAAiB,EACjB,mBAAmB,EACnB,YAAY,EACZ,WAAW,EACX,eAAe,EACf,gBAAgB,EAChB,gBAAgB,EAChB,gBAAgB,EAChB,cAAc,EACd,uBAAuB,EACvB,gBAAgB,EAChB,iBAAiB,EACjB,iBAAiB,EACpB,MAAM,2BAA2B,CAAC;AAEnC,qBAAa,cAAc;IACX,OAAO,CAAC,KAAK;gBAAL,KAAK,EAAE,QAAQ;IAEnC;;;OAGG;IACG,oBAAoB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAKpE;;;OAGG;IACG,oBAAoB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,sBAAsB,GAAG,OAAO,CAAC,eAAe,CAAC;IAS9F;;;OAGG;IACG,kBAAkB,CAAC,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IAKlF;;;OAGG;IACG,qBAAqB,CAAC,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAK5F;;;OAGG;IACG,YAAY,IAAI,OAAO,CAAC,WAAW,CAAC;IAK1C;;;OAGG;IACG,aAAa,CAAC,IAAI,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC;IAS7D;;;OAGG;IACG,eAAe,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAStE;;;OAGG;IACG,sBAAsB,IAAI,OAAO,CAAC,WAAW,CAAC;IAKpD;;;OAGG;IACG,cAAc,IAAI,OAAO,CAAC;QAAE,IAAI,EAAE,WAAW,CAAC;QAAC,OAAO,EAAE;YAAE,kBAAkB,CAAC,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,CAAC;IAMhG;;;OAGG;IACG,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC;QAAE,IAAI,EAAE,WAAW,CAAC;QAAC,OAAO,EAAE;YAAE,kBAAkB,CAAC,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,CAAC;IAMzG;;;OAGG;IACG,oBAAoB,CAAC,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,iBAAiB,CAAC;IASzE;;;OAGG;IACG,cAAc,CAAC,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,mBAAmB,CAAC;IASrE;;;OAGG;IACG,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,YAAY,GAAG,OAAO,CAAC,WAAW,CAAC;IASzE;;;OAGG;IACG,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAKrD;;;OAGG;IACG,eAAe,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;IAKvD;;;OAGG;IACG,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IAK5D;;;OAGG;IACG,gBAAgB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,GAAG,OAAO,CAAC,eAAe,CAAC;IASpF;;;OAGG;IACG,iBAAiB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,GAAG,OAAO,CAAC,eAAe,CAAC;IASrG;;;OAGG;IACG,iBAAiB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IAK7E;;;OAGG;IACG,mBAAmB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,GAAG,OAAO,CAAC,eAAe,CAAC;IASvG;;;OAGG;IACG,kBAAkB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAK/D;;;OAGG;IACG,iBAAiB,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IASvF;;;OAGG;IACG,kBAAkB,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IASzG;;;OAGG;IACG,kBAAkB,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAKhF;;;OAGG;IACG,oBAAoB,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAS3G;;;OAGG;IACG,qBAAqB,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,uBAAuB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IASlH;;;OAGG;IACG,wBAAwB,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,uBAAuB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAYvI;;;OAGG;IACG,wBAAwB,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAQxG;;;OAGG;IACG,0BAA0B,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAYnI;;;OAGG;IACG,eAAe,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;CAI/D"}
@@ -0,0 +1,2 @@
1
+ export * from './personas.types.js';
2
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/personas/types/index.ts"],"names":[],"mappings":"AACA,cAAc,qBAAqB,CAAC"}