@rocksky/sdk 0.7.2 → 0.8.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/dist/agent.d.ts +8 -5
- package/dist/agent.d.ts.map +1 -1
- package/dist/client.d.ts +43 -34
- package/dist/client.d.ts.map +1 -1
- package/dist/generated/types.d.ts +119 -4
- package/dist/generated/types.d.ts.map +1 -1
- package/dist/index.js +265 -6610
- package/package.json +2 -2
- package/src/agent.ts +17 -6
- package/src/client.ts +99 -34
- package/src/generated/types.ts +129 -6
package/dist/agent.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { PasswordSession } from "@atcute/password-session";
|
|
2
|
-
import type { AlbumRecord, ArtistRecord, ActorTrackView, ScrobbleRecord, SongRecord } from "./generated/types.js";
|
|
2
|
+
import type { AlbumRecord, ArtistRecord, ActorTrackView, ScrobbleRecord, ShoutGif, SongRecord } from "./generated/types.js";
|
|
3
3
|
import type { IndexStats, RockskyIndex } from "./dedup.js";
|
|
4
4
|
import { type JetstreamOptions } from "./jetstream.js";
|
|
5
5
|
/** Input for {@link Agent.scrobble} (createdAt defaults to now). */
|
|
@@ -100,10 +100,13 @@ export declare class Agent {
|
|
|
100
100
|
like(uri: string, cid: string): Promise<string>;
|
|
101
101
|
/** Follow an account by DID. Returns the follow URI. */
|
|
102
102
|
follow(did: string): Promise<string>;
|
|
103
|
-
/** Post a shout on a subject. Returns the shout URI.
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
103
|
+
/** Post a shout on a subject. Returns the shout URI. Pass at least one of
|
|
104
|
+
* `message` / `gif` — `message` may be omitted when a GIF/sticker/clip is
|
|
105
|
+
* attached. */
|
|
106
|
+
shout(subjectUri: string, subjectCid: string, message?: string, gif?: ShoutGif): Promise<string>;
|
|
107
|
+
/** Reply to a shout, with a parent strong-ref. Pass at least one of `message`
|
|
108
|
+
* / `gif` — `message` may be omitted when a GIF/sticker/clip is attached. */
|
|
109
|
+
replyShout(subjectUri: string, subjectCid: string, parentUri: string, parentCid: string, message?: string, gif?: ShoutGif): Promise<string>;
|
|
107
110
|
/** Upsert the actor's now-playing status singleton (rkey "self"). */
|
|
108
111
|
setNowPlaying(track: ActorTrackView): Promise<string>;
|
|
109
112
|
/** Delete the actor's now-playing status singleton. */
|
package/dist/agent.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"agent.d.ts","sourceRoot":"","sources":["../src/agent.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAG3D,OAAO,KAAK,EACV,WAAW,EACX,YAAY,EACZ,cAAc,EACd,cAAc,EACd,UAAU,EACX,MAAM,sBAAsB,CAAC;AAC9B,OAAO,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC3D,OAAO,EAAgB,KAAK,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AA+BrE,oEAAoE;AACpE,MAAM,MAAM,aAAa,GAAG,IAAI,CAAC,cAAc,EAAE,WAAW,CAAC,GAAG;IAAE,SAAS,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AACvF,wFAAwF;AACxF,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,mCAAmC;IACnC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,oDAAoD;IACpD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,gCAAgC;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,gDAAgD;IAChD,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AACD,0CAA0C;AAC1C,MAAM,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,EAAE,WAAW,CAAC,GAAG;IAAE,SAAS,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAC/E,0EAA0E;AAC1E,MAAM,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,EAAE,WAAW,CAAC,GAAG;IAAE,SAAS,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AACjF,4CAA4C;AAC5C,MAAM,MAAM,WAAW,GAAG,IAAI,CAAC,YAAY,EAAE,WAAW,CAAC,GAAG;IAAE,SAAS,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAEnF;;;;GAIG;AACH,qBAAa,KAAK;IAId,OAAO,CAAC,GAAG;IACX,QAAQ,CAAC,GAAG,EAAE,MAAM;IACpB,QAAQ,CAAC,OAAO,EAAE,eAAe;IACjC,OAAO,CAAC,GAAG;IANb,OAAO,CAAC,GAAG,CAAC,CAAe;IAE3B,OAAO;IAOP;;;OAGG;WACU,KAAK,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAUxE,qFAAqF;IACrF,QAAQ,CAAC,GAAG,EAAE,YAAY,GAAG,IAAI;IAIjC;;;;OAIG;IACG,QAAQ,IAAI,OAAO,CAAC,UAAU,CAAC;IASrC;;;;OAIG;IACH,oBAAoB,CAAC,IAAI,GAAE,gBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;YAKlD,MAAM;YAQN,SAAS;IAQvB,4CAA4C;IACtC,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAO7D;;;;;;;OAOG;IACG,QAAQ,CAAC,GAAG,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC;IAiBnD;;;;;;;OAOG;YACW,uBAAuB;IA2BrC;;;;gFAI4E;IACtE,aAAa,CAAC,KAAK,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAsCjF,0DAA0D;IACpD,UAAU,CAAC,GAAG,EAAE,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC;IAWjD,gFAAgF;IAC1E,WAAW,CAAC,GAAG,EAAE,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC;IAWnD,oDAAoD;IAC9C,YAAY,CAAC,GAAG,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC;IAWrD,2EAA2E;IAC3E,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAI/C,wDAAwD;IACxD,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAIpC
|
|
1
|
+
{"version":3,"file":"agent.d.ts","sourceRoot":"","sources":["../src/agent.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAG3D,OAAO,KAAK,EACV,WAAW,EACX,YAAY,EACZ,cAAc,EACd,cAAc,EACd,QAAQ,EACR,UAAU,EACX,MAAM,sBAAsB,CAAC;AAC9B,OAAO,KAAK,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC3D,OAAO,EAAgB,KAAK,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AA+BrE,oEAAoE;AACpE,MAAM,MAAM,aAAa,GAAG,IAAI,CAAC,cAAc,EAAE,WAAW,CAAC,GAAG;IAAE,SAAS,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AACvF,wFAAwF;AACxF,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,mCAAmC;IACnC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,oDAAoD;IACpD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,gCAAgC;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,gDAAgD;IAChD,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AACD,0CAA0C;AAC1C,MAAM,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,EAAE,WAAW,CAAC,GAAG;IAAE,SAAS,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAC/E,0EAA0E;AAC1E,MAAM,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,EAAE,WAAW,CAAC,GAAG;IAAE,SAAS,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AACjF,4CAA4C;AAC5C,MAAM,MAAM,WAAW,GAAG,IAAI,CAAC,YAAY,EAAE,WAAW,CAAC,GAAG;IAAE,SAAS,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAEnF;;;;GAIG;AACH,qBAAa,KAAK;IAId,OAAO,CAAC,GAAG;IACX,QAAQ,CAAC,GAAG,EAAE,MAAM;IACpB,QAAQ,CAAC,OAAO,EAAE,eAAe;IACjC,OAAO,CAAC,GAAG;IANb,OAAO,CAAC,GAAG,CAAC,CAAe;IAE3B,OAAO;IAOP;;;OAGG;WACU,KAAK,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAUxE,qFAAqF;IACrF,QAAQ,CAAC,GAAG,EAAE,YAAY,GAAG,IAAI;IAIjC;;;;OAIG;IACG,QAAQ,IAAI,OAAO,CAAC,UAAU,CAAC;IASrC;;;;OAIG;IACH,oBAAoB,CAAC,IAAI,GAAE,gBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;YAKlD,MAAM;YAQN,SAAS;IAQvB,4CAA4C;IACtC,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAO7D;;;;;;;OAOG;IACG,QAAQ,CAAC,GAAG,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC;IAiBnD;;;;;;;OAOG;YACW,uBAAuB;IA2BrC;;;;gFAI4E;IACtE,aAAa,CAAC,KAAK,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAsCjF,0DAA0D;IACpD,UAAU,CAAC,GAAG,EAAE,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC;IAWjD,gFAAgF;IAC1E,WAAW,CAAC,GAAG,EAAE,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC;IAWnD,oDAAoD;IAC9C,YAAY,CAAC,GAAG,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC;IAWrD,2EAA2E;IAC3E,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAI/C,wDAAwD;IACxD,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAIpC;;mBAEe;IACf,KAAK,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC;IAShG;iFAC6E;IAC7E,UAAU,CACR,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,EACjB,OAAO,CAAC,EAAE,MAAM,EAChB,GAAG,CAAC,EAAE,QAAQ,GACb,OAAO,CAAC,MAAM,CAAC;IAUlB,qEAAqE;IACrE,aAAa,CAAC,KAAK,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC;IAIrD,uDAAuD;IACvD,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC;CAGjC"}
|
package/dist/client.d.ts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { RockskyLibrary } from "./library.js";
|
|
2
|
-
import type { ActorProfileViewBasic, ActorProfileViewDetailed, AlbumViewBasic, ArtistViewBasic, FeedSearchResultsView, ScrobbleViewBasic, SongViewBasic, StatsGlobalStatsView } from "./generated/types.js";
|
|
2
|
+
import type { ActorProfileViewBasic, ActorProfileViewDetailed, AlbumViewBasic, AlbumViewDetailed, ArtistViewBasic, ArtistViewDetailed, ChartsView, FeedGeneratorsView, FeedRecommendationsView, FeedRecommendedAlbumsView, FeedRecommendedArtistsView, FeedSearchResultsView, FeedStoriesView, FeedView, GetActorCompatibilityOutput, GetActorNeighboursOutput, GetActorPlaylistsOutput, GetAlbumShoutsOutput, GetApikeysOutput, GetArtistListenersOutput, GetArtistRecentListenersOutput, GetArtistShoutsOutput, GetFeedGeneratorOutput, GetMirrorSourcesOutput, GetProfileShoutsOutput, GetShoutRepliesOutput, GetSongRecentListenersOutput, GetTrackShoutsOutput, GetUnreadCountOutput, ListNotificationsOutput, PlayerCurrentlyPlayingViewDetailed, PlayerPlaybackQueueViewDetailed, PlaylistGetPlaylistsOutput, PlaylistViewDetailed, RockboxSettingsView, ScrobbleViewBasic, SongViewBasic, SongViewDetailed, StatsGlobalStatsView, StatsView, StatsWrappedView, UpdateSeenOutput } from "./generated/types.js";
|
|
3
3
|
/**
|
|
4
4
|
* A typed date window for the `top*` charts. Build one with the {@link Interval}
|
|
5
5
|
* factories; `range` bounds are RFC-3339 datetimes.
|
|
@@ -94,33 +94,33 @@ export declare class RockskyClient {
|
|
|
94
94
|
/** Platform-wide totals. */
|
|
95
95
|
globalStats(): Promise<StatsGlobalStatsView>;
|
|
96
96
|
/** A feed by its at:// URI (paginate via `cursor`). */
|
|
97
|
-
feed(feed: string, limit?: number, cursor?: string): Promise<
|
|
97
|
+
feed(feed: string, limit?: number, cursor?: string): Promise<FeedView>;
|
|
98
98
|
/** A single album with its tracklist. */
|
|
99
|
-
album(uri: string): Promise<
|
|
99
|
+
album(uri: string): Promise<AlbumViewDetailed>;
|
|
100
100
|
/** A single artist with detail. */
|
|
101
|
-
artist(uri: string): Promise<
|
|
101
|
+
artist(uri: string): Promise<ArtistViewDetailed>;
|
|
102
102
|
/** Resolve full canonical metadata for a bare title + artist
|
|
103
103
|
* (`app.rocksky.song.matchSong`); optionally anchor with `mbId` / `isrc`. */
|
|
104
|
-
matchSong(title: string, artist: string, mbId?: string, isrc?: string): Promise<
|
|
104
|
+
matchSong(title: string, artist: string, mbId?: string, isrc?: string): Promise<SongViewDetailed>;
|
|
105
105
|
/** A single song by at:// `uri` (or by `mbid` / `isrc` / `spotifyId`). */
|
|
106
106
|
song(opts: {
|
|
107
107
|
uri?: string;
|
|
108
108
|
mbid?: string;
|
|
109
109
|
isrc?: string;
|
|
110
110
|
spotifyId?: string;
|
|
111
|
-
}): Promise<
|
|
111
|
+
}): Promise<SongViewDetailed>;
|
|
112
112
|
/** An actor's playlists. */
|
|
113
|
-
actorPlaylists(actor: string, limit?: number, offset?: number): Promise<
|
|
113
|
+
actorPlaylists(actor: string, limit?: number, offset?: number): Promise<GetActorPlaylistsOutput>;
|
|
114
114
|
/** Actors with similar taste to `actor`. */
|
|
115
|
-
neighbours(actor: string): Promise<
|
|
115
|
+
neighbours(actor: string): Promise<GetActorNeighboursOutput>;
|
|
116
116
|
/** Music compatibility between the viewer and `actor` (auth). */
|
|
117
|
-
compatibility(actor: string): Promise<
|
|
117
|
+
compatibility(actor: string): Promise<GetActorCompatibilityOutput>;
|
|
118
118
|
/** An artist's all-time listeners. */
|
|
119
|
-
artistListeners(uri: string, limit?: number, offset?: number): Promise<
|
|
119
|
+
artistListeners(uri: string, limit?: number, offset?: number): Promise<GetArtistListenersOutput>;
|
|
120
120
|
/** An artist's recent listeners. */
|
|
121
|
-
artistRecentListeners(uri: string, limit?: number, offset?: number): Promise<
|
|
121
|
+
artistRecentListeners(uri: string, limit?: number, offset?: number): Promise<GetArtistRecentListenersOutput>;
|
|
122
122
|
/** A song's recent listeners. */
|
|
123
|
-
songRecentListeners(uri: string, limit?: number, offset?: number): Promise<
|
|
123
|
+
songRecentListeners(uri: string, limit?: number, offset?: number): Promise<GetSongRecentListenersOutput>;
|
|
124
124
|
/** A scrobble time-series chart. Scope with any of `did` / `artisturi` /
|
|
125
125
|
* `albumuri` / `songuri` / `genre` and bound with `from` / `to`. */
|
|
126
126
|
scrobblesChart(opts: {
|
|
@@ -131,48 +131,57 @@ export declare class RockskyClient {
|
|
|
131
131
|
genre?: string;
|
|
132
132
|
from?: string;
|
|
133
133
|
to?: string;
|
|
134
|
-
}): Promise<
|
|
134
|
+
}): Promise<ChartsView>;
|
|
135
135
|
/** List the available feed generators. */
|
|
136
|
-
feedGenerators(size?: number): Promise<
|
|
136
|
+
feedGenerators(size?: number): Promise<FeedGeneratorsView>;
|
|
137
137
|
/** A single feed generator's record. */
|
|
138
|
-
feedGenerator(feed: string): Promise<
|
|
138
|
+
feedGenerator(feed: string): Promise<GetFeedGeneratorOutput>;
|
|
139
139
|
/** The stories row. */
|
|
140
|
-
stories(size?: number, feed?: string, following?: boolean): Promise<
|
|
140
|
+
stories(size?: number, feed?: string, following?: boolean): Promise<FeedStoriesView>;
|
|
141
141
|
/** Track recommendations for `actor`. */
|
|
142
|
-
recommendations(actor: string, limit?: number): Promise<
|
|
142
|
+
recommendations(actor: string, limit?: number): Promise<FeedRecommendationsView>;
|
|
143
143
|
/** Artist recommendations for `actor`. */
|
|
144
|
-
artistRecommendations(actor: string, limit?: number): Promise<
|
|
144
|
+
artistRecommendations(actor: string, limit?: number): Promise<FeedRecommendedArtistsView>;
|
|
145
145
|
/** Album recommendations for `actor`. */
|
|
146
|
-
albumRecommendations(actor: string, limit?: number): Promise<
|
|
146
|
+
albumRecommendations(actor: string, limit?: number): Promise<FeedRecommendedAlbumsView>;
|
|
147
147
|
/** An actor's aggregate stats. */
|
|
148
|
-
stats(actor: string): Promise<
|
|
148
|
+
stats(actor: string): Promise<StatsView>;
|
|
149
149
|
/** An actor's year-in-review. */
|
|
150
|
-
wrapped(actor: string, year?: number): Promise<
|
|
150
|
+
wrapped(actor: string, year?: number): Promise<StatsWrappedView>;
|
|
151
151
|
/** The viewer's configured scrobble mirror sources (auth). */
|
|
152
|
-
mirrorSources(): Promise<
|
|
152
|
+
mirrorSources(): Promise<GetMirrorSourcesOutput>;
|
|
153
153
|
/** What `actor` is playing now. */
|
|
154
|
-
currentlyPlaying(playerId?: string, actor?: string): Promise<
|
|
154
|
+
currentlyPlaying(playerId?: string, actor?: string): Promise<PlayerCurrentlyPlayingViewDetailed>;
|
|
155
155
|
/** A player's playback queue. */
|
|
156
|
-
playbackQueue(playerId: string): Promise<
|
|
156
|
+
playbackQueue(playerId: string): Promise<PlayerPlaybackQueueViewDetailed>;
|
|
157
157
|
/** What `actor` is playing now on Spotify. */
|
|
158
|
-
spotifyCurrentlyPlaying(actor: string): Promise<
|
|
158
|
+
spotifyCurrentlyPlaying(actor: string): Promise<PlayerCurrentlyPlayingViewDetailed>;
|
|
159
159
|
/** The playlist catalog. */
|
|
160
|
-
playlists(limit?: number, offset?: number): Promise<
|
|
160
|
+
playlists(limit?: number, offset?: number): Promise<PlaylistGetPlaylistsOutput>;
|
|
161
161
|
/** A single playlist with its items. */
|
|
162
|
-
playlist(uri: string): Promise<
|
|
162
|
+
playlist(uri: string): Promise<PlaylistViewDetailed>;
|
|
163
163
|
/** Shouts on an album. */
|
|
164
|
-
albumShouts(uri: string, limit?: number, offset?: number): Promise<
|
|
164
|
+
albumShouts(uri: string, limit?: number, offset?: number): Promise<GetAlbumShoutsOutput>;
|
|
165
165
|
/** Shouts on an artist. */
|
|
166
|
-
artistShouts(uri: string, limit?: number, offset?: number): Promise<
|
|
166
|
+
artistShouts(uri: string, limit?: number, offset?: number): Promise<GetArtistShoutsOutput>;
|
|
167
167
|
/** Shouts on a profile. */
|
|
168
|
-
profileShouts(actor: string, limit?: number, offset?: number): Promise<
|
|
168
|
+
profileShouts(actor: string, limit?: number, offset?: number): Promise<GetProfileShoutsOutput>;
|
|
169
169
|
/** Shouts on a track. */
|
|
170
|
-
trackShouts(uri: string): Promise<
|
|
170
|
+
trackShouts(uri: string): Promise<GetTrackShoutsOutput>;
|
|
171
171
|
/** Replies to a shout. */
|
|
172
|
-
shoutReplies(uri: string, limit?: number, offset?: number): Promise<
|
|
172
|
+
shoutReplies(uri: string, limit?: number, offset?: number): Promise<GetShoutRepliesOutput>;
|
|
173
173
|
/** An actor's Rockbox EQ / audio settings. */
|
|
174
|
-
audioSettings(actor: string): Promise<
|
|
174
|
+
audioSettings(actor: string): Promise<RockboxSettingsView>;
|
|
175
175
|
/** The viewer's API keys (auth). */
|
|
176
|
-
apikeys(limit?: number, offset?: number): Promise<
|
|
176
|
+
apikeys(limit?: number, offset?: number): Promise<GetApikeysOutput>;
|
|
177
|
+
/** The authenticated viewer's unread-notification count. */
|
|
178
|
+
unreadCount(): Promise<GetUnreadCountOutput>;
|
|
179
|
+
/** The authenticated viewer's notifications, most recent first. `limit`
|
|
180
|
+
* defaults to 30 server-side; paginate via `cursor`. */
|
|
181
|
+
notifications(limit?: number, cursor?: string): Promise<ListNotificationsOutput>;
|
|
182
|
+
/** Mark notifications as viewed. Pass the notification `ids` to mark, or omit
|
|
183
|
+
* to mark **all** of the viewer's notifications. Returns the number remaining
|
|
184
|
+
* unread. */
|
|
185
|
+
updateSeen(ids?: string[]): Promise<UpdateSeenOutput>;
|
|
177
186
|
}
|
|
178
187
|
//# sourceMappingURL=client.d.ts.map
|
package/dist/client.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,KAAK,EACV,qBAAqB,EACrB,wBAAwB,EACxB,cAAc,EACd,eAAe,EACf,qBAAqB,
|
|
1
|
+
{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,KAAK,EACV,qBAAqB,EACrB,wBAAwB,EACxB,cAAc,EACd,iBAAiB,EACjB,eAAe,EACf,kBAAkB,EAClB,UAAU,EACV,kBAAkB,EAClB,uBAAuB,EACvB,yBAAyB,EACzB,0BAA0B,EAC1B,qBAAqB,EACrB,eAAe,EACf,QAAQ,EAGR,2BAA2B,EAC3B,wBAAwB,EACxB,uBAAuB,EAEvB,oBAAoB,EACpB,gBAAgB,EAChB,wBAAwB,EACxB,8BAA8B,EAC9B,qBAAqB,EACrB,sBAAsB,EACtB,sBAAsB,EACtB,sBAAsB,EACtB,qBAAqB,EACrB,4BAA4B,EAC5B,oBAAoB,EACpB,oBAAoB,EACpB,uBAAuB,EACvB,kCAAkC,EAClC,+BAA+B,EAC/B,0BAA0B,EAC1B,oBAAoB,EACpB,mBAAmB,EACnB,iBAAiB,EACjB,aAAa,EACb,gBAAgB,EAChB,oBAAoB,EACpB,SAAS,EACT,gBAAgB,EAChB,gBAAgB,EACjB,MAAM,sBAAsB,CAAC;AAE9B;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAWD,oFAAoF;AACpF,eAAO,MAAM,QAAQ;IACnB,sCAAsC;mBACzB,YAAY;IACzB,oCAAoC;kBACtB,MAAM,KAAG,YAAY;IACnC,qCAAqC;mBACtB,MAAM,KAAG,YAAY;IACpC,sCAAsC;oBACtB,MAAM,KAAG,YAAY;IACrC,qCAAqC;mBACtB,MAAM,KAAG,YAAY;IACpC,gDAAgD;mBACjC,IAAI,OAAO,IAAI,KAAG,YAAY;CAI9C,CAAC;AAEF,mDAAmD;AACnD,eAAO,MAAM,eAAe,4BAA4B,CAAC;AAEzD,wEAAwE;AACxE,qBAAa,aAAa;IACxB,OAAO,CAAC,GAAG,CAAS;IACpB,OAAO,CAAC,KAAK,CAAC,CAAS;IAEvB;;;;;OAKG;gBACS,OAAO,GAAE,MAAwB,EAAE,KAAK,CAAC,EAAE,MAAM;IAc7D;;;;OAIG;IACH,OAAO,IAAI,cAAc;YASX,KAAK;IAUnB,+DAA+D;IAC/D,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAIzD,0CAA0C;IACpC,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,SAAK,EAAE,MAAM,SAAI,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;IASpF;gFAC4E;IAC5E,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,GAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAIzE,oCAAoC;IAC9B,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,SAAK,EAAE,MAAM,SAAI,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAS5E,sCAAsC;IAChC,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,SAAK,EAAE,MAAM,SAAI,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAQjF,qCAAqC;IAC/B,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,SAAK,EAAE,MAAM,SAAI,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;IAS9E,sCAAsC;IAChC,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,SAAK,EAAE,MAAM,SAAI,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAShF,qDAAqD;IACrD,SAAS,CAAC,KAAK,SAAK,EAAE,MAAM,SAAI,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAI3D,sDAAsD;IACtD,UAAU,CAAC,KAAK,SAAK,EAAE,MAAM,SAAI,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAI9D,8DAA8D;IACxD,iBAAiB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,YAAY,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IASxG,+DAA+D;IACzD,kBAAkB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,YAAY,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAS3G,yDAAyD;IACnD,aAAa,CAAC,KAAK,SAAK,EAAE,MAAM,SAAI,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;IAStF,0DAA0D;IACpD,cAAc,CAAC,KAAK,SAAK,EAAE,MAAM,SAAI,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IASxF,wDAAwD;IAClD,YAAY,CAAC,KAAK,SAAK,EAAE,MAAM,SAAI,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IASpF,+CAA+C;IACzC,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAKxD,8CAA8C;IACxC,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;IAK1D,kDAAkD;IAC5C,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,SAAK,EAAE,MAAM,SAAI,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IASjF;oDACgD;IAC1C,YAAY,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,SAAS,UAAQ,EAAE,KAAK,SAAK,EAAE,MAAM,SAAI,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAUzG,0CAA0C;IAC1C,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAIjD,oCAAoC;IAC9B,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,SAAK,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC;IAS3F,wCAAwC;IAClC,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,SAAK,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC;IAS7F,yDAAyD;IACnD,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,SAAK,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,EAAE,CAAC;IAQlG,yEAAyE;IACzE,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAIrD,4BAA4B;IAC5B,WAAW,IAAI,OAAO,CAAC,oBAAoB,CAAC;IAM5C,uDAAuD;IACvD,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,SAAK,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAGlE,yCAAyC;IACzC,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAG9C,mCAAmC;IACnC,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAGhD;iFAC6E;IAC7E,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAGjG,0EAA0E;IAC1E,IAAI,CAAC,IAAI,EAAE;QACT,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAG7B,4BAA4B;IAC5B,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,SAAK,EAAE,MAAM,SAAI,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAGvF,4CAA4C;IAC5C,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAG5D,iEAAiE;IACjE,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,2BAA2B,CAAC;IAGlE,sCAAsC;IACtC,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,SAAK,EAAE,MAAM,SAAI,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAGvF,oCAAoC;IACpC,qBAAqB,CACnB,GAAG,EAAE,MAAM,EACX,KAAK,SAAK,EACV,MAAM,SAAI,GACT,OAAO,CAAC,8BAA8B,CAAC;IAG1C,iCAAiC;IACjC,mBAAmB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,SAAK,EAAE,MAAM,SAAI,GAAG,OAAO,CAAC,4BAA4B,CAAC;IAG/F;wEACoE;IACpE,cAAc,CAAC,IAAI,EAAE;QACnB,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,EAAE,CAAC,EAAE,MAAM,CAAC;KACb,GAAG,OAAO,CAAC,UAAU,CAAC;IAGvB,0CAA0C;IAC1C,cAAc,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAG1D,wCAAwC;IACxC,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAG5D,uBAAuB;IACvB,OAAO,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,eAAe,CAAC;IAGpF,yCAAyC;IACzC,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAGhF,0CAA0C;IAC1C,qBAAqB,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,0BAA0B,CAAC;IAGzF,yCAAyC;IACzC,oBAAoB,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,yBAAyB,CAAC;IAGvF,kCAAkC;IAClC,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAGxC,iCAAiC;IACjC,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAGhE,8DAA8D;IAC9D,aAAa,IAAI,OAAO,CAAC,sBAAsB,CAAC;IAGhD,mCAAmC;IACnC,gBAAgB,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,kCAAkC,CAAC;IAGhG,iCAAiC;IACjC,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,+BAA+B,CAAC;IAGzE,8CAA8C;IAC9C,uBAAuB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,kCAAkC,CAAC;IAGnF,4BAA4B;IAC5B,SAAS,CAAC,KAAK,SAAK,EAAE,MAAM,SAAI,GAAG,OAAO,CAAC,0BAA0B,CAAC;IAGtE,wCAAwC;IACxC,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAGpD,0BAA0B;IAC1B,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,SAAK,EAAE,MAAM,SAAI,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAG/E,2BAA2B;IAC3B,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,SAAK,EAAE,MAAM,SAAI,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAGjF,2BAA2B;IAC3B,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,SAAK,EAAE,MAAM,SAAI,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAGrF,yBAAyB;IACzB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAGvD,0BAA0B;IAC1B,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,SAAK,EAAE,MAAM,SAAI,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAGjF,8CAA8C;IAC9C,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAG1D,oCAAoC;IACpC,OAAO,CAAC,KAAK,SAAK,EAAE,MAAM,SAAI,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAM1D,4DAA4D;IAC5D,WAAW,IAAI,OAAO,CAAC,oBAAoB,CAAC;IAG5C;4DACwD;IACxD,aAAa,CAAC,KAAK,SAAK,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAG5E;;iBAEa;IACP,UAAU,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,gBAAgB,CAAC;CAO5D"}
|
|
@@ -94,6 +94,8 @@ export interface ActorTrackView {
|
|
|
94
94
|
source?: string;
|
|
95
95
|
/** MusicBrainz recording ID, if available. */
|
|
96
96
|
recordingMbId?: string;
|
|
97
|
+
/** The track's position within its album, if known (>= 1). */
|
|
98
|
+
trackNumber?: number;
|
|
97
99
|
}
|
|
98
100
|
export interface AddDirectoryToQueueParams {
|
|
99
101
|
playerId?: string;
|
|
@@ -451,8 +453,6 @@ export interface DescribeFeedGeneratorOutput {
|
|
|
451
453
|
/** List of feed URIs generated by this feed generator. */
|
|
452
454
|
feeds?: FeedUriView[];
|
|
453
455
|
}
|
|
454
|
-
export interface DescribeFeedGeneratorParams {
|
|
455
|
-
}
|
|
456
456
|
export interface DislikeShoutInput {
|
|
457
457
|
/** The unique identifier of the shout to dislike */
|
|
458
458
|
uri?: AtUri;
|
|
@@ -1189,6 +1189,10 @@ export interface GetTrackShoutsParams {
|
|
|
1189
1189
|
/** The URI of the track to retrieve shouts for */
|
|
1190
1190
|
uri: AtUri;
|
|
1191
1191
|
}
|
|
1192
|
+
export interface GetUnreadCountOutput {
|
|
1193
|
+
/** The number of unread notifications. */
|
|
1194
|
+
count: number;
|
|
1195
|
+
}
|
|
1192
1196
|
export interface GetUserOutput {
|
|
1193
1197
|
}
|
|
1194
1198
|
export interface GetUserParams {
|
|
@@ -1310,6 +1314,17 @@ export interface LikeSongInput {
|
|
|
1310
1314
|
/** The unique identifier of the song to like */
|
|
1311
1315
|
uri?: AtUri;
|
|
1312
1316
|
}
|
|
1317
|
+
export interface ListNotificationsOutput {
|
|
1318
|
+
notifications: NotificationView[];
|
|
1319
|
+
/** The number of unread notifications. */
|
|
1320
|
+
unreadCount: number;
|
|
1321
|
+
/** A cursor value to pass to subsequent calls to get the next page of results. */
|
|
1322
|
+
cursor?: string;
|
|
1323
|
+
}
|
|
1324
|
+
export interface ListNotificationsParams {
|
|
1325
|
+
limit?: number;
|
|
1326
|
+
cursor?: string;
|
|
1327
|
+
}
|
|
1313
1328
|
export interface MatchSongParams {
|
|
1314
1329
|
/** The title of the song to retrieve */
|
|
1315
1330
|
title: string;
|
|
@@ -1334,6 +1349,36 @@ export interface MirrorSourceView {
|
|
|
1334
1349
|
/** Watermark — scrobbles from the external service older than this are skipped. */
|
|
1335
1350
|
lastScrobbleSeenAt?: DateTime;
|
|
1336
1351
|
}
|
|
1352
|
+
/** The user who triggered a notification. */
|
|
1353
|
+
export interface NotificationActor {
|
|
1354
|
+
/** The unique identifier of the actor. */
|
|
1355
|
+
id?: string;
|
|
1356
|
+
/** The decentralized identifier of the actor. */
|
|
1357
|
+
did?: Did;
|
|
1358
|
+
/** The handle of the actor. */
|
|
1359
|
+
handle?: AtIdentifier;
|
|
1360
|
+
/** The display name of the actor. */
|
|
1361
|
+
displayName?: string;
|
|
1362
|
+
/** The URL of the actor's avatar image. */
|
|
1363
|
+
avatar?: Uri;
|
|
1364
|
+
}
|
|
1365
|
+
export interface NotificationView {
|
|
1366
|
+
/** The unique identifier of the notification. */
|
|
1367
|
+
id: string;
|
|
1368
|
+
/** The notification type: like_scrobble, follow, comment_scrobble, comment_profile, reply, or react_comment. */
|
|
1369
|
+
type: string;
|
|
1370
|
+
/** Whether the notification has been viewed. */
|
|
1371
|
+
read: boolean;
|
|
1372
|
+
/** When the notification was created. */
|
|
1373
|
+
createdAt: DateTime;
|
|
1374
|
+
/** The at-uri of the subject the notification relates to. */
|
|
1375
|
+
subjectUri?: string;
|
|
1376
|
+
/** The id of the related shout, if any. */
|
|
1377
|
+
shoutId?: string;
|
|
1378
|
+
/** The content of the related shout, if any. */
|
|
1379
|
+
shoutContent?: string;
|
|
1380
|
+
actor?: NotificationActor;
|
|
1381
|
+
}
|
|
1337
1382
|
export interface PingOutput {
|
|
1338
1383
|
}
|
|
1339
1384
|
export interface PingParams {
|
|
@@ -1821,13 +1866,39 @@ export interface ShoutAuthor {
|
|
|
1821
1866
|
/** The URL of the author's avatar image. */
|
|
1822
1867
|
avatar?: Uri;
|
|
1823
1868
|
}
|
|
1869
|
+
/** A GIF, sticker, or clip embedded in a shout. `url` may point at an image (GIF/WebP) or a video (MP4); the client decides how to render it from the file extension. */
|
|
1870
|
+
export interface ShoutGif {
|
|
1871
|
+
/** Direct URL of the animated GIF/MP4. */
|
|
1872
|
+
url: Uri;
|
|
1873
|
+
/** Smaller still/preview image URL. */
|
|
1874
|
+
previewUrl?: Uri;
|
|
1875
|
+
/** Alternative text describing the media. */
|
|
1876
|
+
alt?: string;
|
|
1877
|
+
/** The intrinsic width of the media in pixels. */
|
|
1878
|
+
width?: number;
|
|
1879
|
+
/** The intrinsic height of the media in pixels. */
|
|
1880
|
+
height?: number;
|
|
1881
|
+
}
|
|
1882
|
+
/** A mention of another actor within the shout message, anchored to a UTF-8 byte range in the message. */
|
|
1883
|
+
export interface ShoutMention {
|
|
1884
|
+
/** The DID of the mentioned actor. */
|
|
1885
|
+
did: Did;
|
|
1886
|
+
/** Inclusive UTF-8 byte offset of the mention start. */
|
|
1887
|
+
byteStart: number;
|
|
1888
|
+
/** Exclusive UTF-8 byte offset of the mention end. */
|
|
1889
|
+
byteEnd: number;
|
|
1890
|
+
}
|
|
1824
1891
|
export interface ShoutRecord {
|
|
1825
|
-
/** The message of the shout. */
|
|
1826
|
-
message
|
|
1892
|
+
/** The message of the shout. Optional when a gif/sticker/clip is attached. */
|
|
1893
|
+
message?: string;
|
|
1827
1894
|
/** The date when the shout was created. */
|
|
1828
1895
|
createdAt: DateTime;
|
|
1829
1896
|
parent?: StrongRef;
|
|
1830
1897
|
subject: StrongRef;
|
|
1898
|
+
/** An attached GIF, sticker, or clip (e.g. from KLIPY). */
|
|
1899
|
+
gif?: ShoutGif;
|
|
1900
|
+
/** Mentions of other actors within the message, anchored to UTF-8 byte ranges. */
|
|
1901
|
+
facets?: ShoutMention[];
|
|
1831
1902
|
}
|
|
1832
1903
|
export interface ShoutView {
|
|
1833
1904
|
/** The unique identifier of the shout. */
|
|
@@ -1840,6 +1911,10 @@ export interface ShoutView {
|
|
|
1840
1911
|
createdAt?: DateTime;
|
|
1841
1912
|
/** The author of the shout. */
|
|
1842
1913
|
author?: ShoutAuthor;
|
|
1914
|
+
/** An attached GIF, sticker, or clip. */
|
|
1915
|
+
gif?: ShoutGif;
|
|
1916
|
+
/** Mentions of other actors within the message, anchored to UTF-8 byte ranges. */
|
|
1917
|
+
facets?: ShoutMention[];
|
|
1843
1918
|
}
|
|
1844
1919
|
export interface SongFirstScrobbleView {
|
|
1845
1920
|
/** The handle of the user who first scrobbled this song. */
|
|
@@ -1859,6 +1934,33 @@ export interface SongGetSongParams {
|
|
|
1859
1934
|
/** The Spotify track ID of the song to retrieve (resolved internally to the Spotify track URL) */
|
|
1860
1935
|
spotifyId?: string;
|
|
1861
1936
|
}
|
|
1937
|
+
/** A ranked candidate match for a song from an external metadata provider. */
|
|
1938
|
+
export interface SongMatchView {
|
|
1939
|
+
/** The provider's numeric identifier for the matched track. */
|
|
1940
|
+
id?: number;
|
|
1941
|
+
/** The title of the matched track. */
|
|
1942
|
+
title?: string;
|
|
1943
|
+
/** The artist of the matched track. */
|
|
1944
|
+
artist?: string;
|
|
1945
|
+
/** The album of the matched track. */
|
|
1946
|
+
album?: string;
|
|
1947
|
+
/** The URL of the matched track's album art image. */
|
|
1948
|
+
albumArt?: Uri;
|
|
1949
|
+
/** The International Standard Recording Code (ISRC) of the matched track. */
|
|
1950
|
+
isrc?: string;
|
|
1951
|
+
/** The duration of the matched track in milliseconds. */
|
|
1952
|
+
durationMs?: number;
|
|
1953
|
+
/** A URL to the matched track on the provider. */
|
|
1954
|
+
link?: Uri;
|
|
1955
|
+
/** A URL to a short audio preview of the matched track. */
|
|
1956
|
+
preview?: Uri;
|
|
1957
|
+
/** The provider's popularity rank for the matched track. */
|
|
1958
|
+
rank?: number;
|
|
1959
|
+
/** Whether the matched track has explicit lyrics. */
|
|
1960
|
+
explicit?: boolean;
|
|
1961
|
+
/** Match confidence score in the range 0-100 (higher is better). */
|
|
1962
|
+
score?: number;
|
|
1963
|
+
}
|
|
1862
1964
|
export interface SongRecentListenerView {
|
|
1863
1965
|
/** The unique identifier of the listener. */
|
|
1864
1966
|
id?: string;
|
|
@@ -2009,6 +2111,8 @@ export interface SongViewDetailed {
|
|
|
2009
2111
|
artists?: ArtistViewBasic[];
|
|
2010
2112
|
/** The first scrobble of this song on Rocksky. */
|
|
2011
2113
|
firstScrobble?: SongFirstScrobbleView;
|
|
2114
|
+
/** Ranked list of candidate matches from external metadata providers (e.g. Deezer). Additive field returned by matchSong; may be empty. */
|
|
2115
|
+
matches?: SongMatchView[];
|
|
2012
2116
|
}
|
|
2013
2117
|
export interface SpotifyGetCurrentlyPlayingParams {
|
|
2014
2118
|
/** Handle or DID of the actor to retrieve the currently playing track for. If not provided, defaults to the current user. */
|
|
@@ -2239,6 +2343,14 @@ export interface UpdatePlaylistInput {
|
|
|
2239
2343
|
}
|
|
2240
2344
|
export interface UpdatePlaylistOutput {
|
|
2241
2345
|
}
|
|
2346
|
+
export interface UpdateSeenInput {
|
|
2347
|
+
/** The ids of the notifications to mark as viewed. Omit to mark all. */
|
|
2348
|
+
ids?: string[];
|
|
2349
|
+
}
|
|
2350
|
+
export interface UpdateSeenOutput {
|
|
2351
|
+
/** The number of unread notifications remaining. */
|
|
2352
|
+
unreadCount: number;
|
|
2353
|
+
}
|
|
2242
2354
|
/**
|
|
2243
2355
|
* Map of every XRPC method (NSID) to the type of its response body.
|
|
2244
2356
|
* Endpoints with no output map to `void`. Used by the SDK to type method
|
|
@@ -2340,6 +2452,9 @@ export interface Endpoints {
|
|
|
2340
2452
|
"app.rocksky.like.likeSong": SongViewDetailed;
|
|
2341
2453
|
"app.rocksky.mirror.getMirrorSources": GetMirrorSourcesOutput;
|
|
2342
2454
|
"app.rocksky.mirror.putMirrorSource": MirrorSourceView;
|
|
2455
|
+
"app.rocksky.notification.getUnreadCount": GetUnreadCountOutput;
|
|
2456
|
+
"app.rocksky.notification.listNotifications": ListNotificationsOutput;
|
|
2457
|
+
"app.rocksky.notification.updateSeen": UpdateSeenOutput;
|
|
2343
2458
|
"app.rocksky.player.addDirectoryToQueue": void;
|
|
2344
2459
|
"app.rocksky.player.addItemsToQueue": void;
|
|
2345
2460
|
"app.rocksky.player.getCurrentlyPlaying": PlayerCurrentlyPlayingViewDetailed;
|