@rocksky/sdk 0.1.0 → 0.2.0

package/src/namespaces/player.ts

@@ -1,13 +1,24 @@
-import type { Call } from "./_helpers";
+import type {
+  AddDirectoryToQueueParams,
+  AddItemsToQueueParams,
+  GetCurrentlyPlayingParams,
+  GetPlaybackQueueParams,
+  NextParams,
+  PauseParams,
+  PlayDirectoryParams,
+  PlayFileParams,
+  PlayParams,
+  PreviousParams,
+  SeekParams,
+} from "../generated/types";
 import type { RequestOptions } from "../types";
-
-type PlayerId = { playerId?: string };
+import type { Call } from "./_helpers";
 
 export class PlayerNamespace {
   constructor(private readonly call: Call) {}
 
   getCurrentlyPlaying<T = unknown>(
-    params: PlayerId & { actor?: string } = {},
+    params: GetCurrentlyPlayingParams = {},
     opts?: RequestOptions,
   ) {
     return this.call<T>("app.rocksky.player.getCurrentlyPlaying", "GET", {
@@ -17,7 +28,7 @@ export class PlayerNamespace {
   }
 
   getPlaybackQueue<T = unknown>(
-    params: PlayerId = {},
+    params: GetPlaybackQueueParams = {},
     opts?: RequestOptions,
   ) {
     return this.call<T>("app.rocksky.player.getPlaybackQueue", "GET", {
@@ -26,7 +37,7 @@ export class PlayerNamespace {
     });
   }
 
-  play<T = unknown>(params: PlayerId = {}, opts?: RequestOptions) {
+  play<T = unknown>(params: PlayParams = {}, opts?: RequestOptions) {
     return this.call<T>("app.rocksky.player.play", "POST", {
       params,
       requireAuth: true,
@@ -34,7 +45,7 @@ export class PlayerNamespace {
     });
   }
 
-  pause<T = unknown>(params: PlayerId = {}, opts?: RequestOptions) {
+  pause<T = unknown>(params: PauseParams = {}, opts?: RequestOptions) {
     return this.call<T>("app.rocksky.player.pause", "POST", {
       params,
       requireAuth: true,
@@ -42,7 +53,7 @@ export class PlayerNamespace {
     });
   }
 
-  next<T = unknown>(params: PlayerId = {}, opts?: RequestOptions) {
+  next<T = unknown>(params: NextParams = {}, opts?: RequestOptions) {
     return this.call<T>("app.rocksky.player.next", "POST", {
       params,
       requireAuth: true,
@@ -50,7 +61,7 @@ export class PlayerNamespace {
     });
   }
 
-  previous<T = unknown>(params: PlayerId = {}, opts?: RequestOptions) {
+  previous<T = unknown>(params: PreviousParams = {}, opts?: RequestOptions) {
     return this.call<T>("app.rocksky.player.previous", "POST", {
       params,
       requireAuth: true,
@@ -59,7 +70,7 @@ export class PlayerNamespace {
   }
 
   seek<T = unknown>(
-    params: PlayerId & { position: number },
+    params: SeekParams,
     opts?: RequestOptions,
   ) {
     return this.call<T>("app.rocksky.player.seek", "POST", {
@@ -70,7 +81,7 @@ export class PlayerNamespace {
   }
 
   playFile<T = unknown>(
-    params: PlayerId & { fileId: string },
+    params: PlayFileParams,
     opts?: RequestOptions,
   ) {
     return this.call<T>("app.rocksky.player.playFile", "POST", {
@@ -81,12 +92,7 @@ export class PlayerNamespace {
   }
 
   playDirectory<T = unknown>(
-    params: PlayerId & {
-      directoryId: string;
-      shuffle?: boolean;
-      recurse?: boolean;
-      position?: number;
-    },
+    params: PlayDirectoryParams,
     opts?: RequestOptions,
   ) {
     return this.call<T>("app.rocksky.player.playDirectory", "POST", {
@@ -97,11 +103,7 @@ export class PlayerNamespace {
   }
 
   addItemsToQueue<T = unknown>(
-    params: PlayerId & {
-      items: string[];
-      position?: number;
-      shuffle?: boolean;
-    },
+    params: AddItemsToQueueParams,
     opts?: RequestOptions,
   ) {
     return this.call<T>("app.rocksky.player.addItemsToQueue", "POST", {
@@ -112,11 +114,7 @@ export class PlayerNamespace {
   }
 
   addDirectoryToQueue<T = unknown>(
-    params: PlayerId & {
-      directory: string;
-      position?: number;
-      shuffle?: boolean;
-    },
+    params: AddDirectoryToQueueParams,
     opts?: RequestOptions,
   ) {
     return this.call<T>("app.rocksky.player.addDirectoryToQueue", "POST", {

package/src/namespaces/playlist.ts

@@ -1,11 +1,21 @@
-import type { Call } from "./_helpers";
+import type {
+  CreatePlaylistParams,
+  GetPlaylistParams,
+  GetPlaylistsParams,
+  InsertDirectoryParams,
+  InsertFilesParams,
+  RemovePlaylistParams,
+  RemoveTrackParams,
+  StartPlaylistParams,
+} from "../generated/types";
 import type { RequestOptions } from "../types";
+import type { Call } from "./_helpers";
 
 export class PlaylistNamespace {
   constructor(private readonly call: Call) {}
 
   getPlaylists<T = unknown>(
-    params: { limit?: number; offset?: number } = {},
+    params: GetPlaylistsParams = {},
     opts?: RequestOptions,
   ) {
     return this.call<T>("app.rocksky.playlist.getPlaylists", "GET", {
@@ -14,7 +24,7 @@ export class PlaylistNamespace {
     });
   }
 
-  getPlaylist<T = unknown>(params: { uri: string }, opts?: RequestOptions) {
+  getPlaylist<T = unknown>(params: GetPlaylistParams, opts?: RequestOptions) {
     return this.call<T>("app.rocksky.playlist.getPlaylist", "GET", {
       params,
       ...opts,
@@ -22,7 +32,7 @@ export class PlaylistNamespace {
   }
 
   createPlaylist<T = unknown>(
-    params: { name: string; description?: string },
+    params: CreatePlaylistParams,
     opts?: RequestOptions,
   ) {
     return this.call<T>("app.rocksky.playlist.createPlaylist", "POST", {
@@ -32,7 +42,7 @@ export class PlaylistNamespace {
     });
   }
 
-  removePlaylist<T = unknown>(params: { uri: string }, opts?: RequestOptions) {
+  removePlaylist<T = unknown>(params: RemovePlaylistParams, opts?: RequestOptions) {
     return this.call<T>("app.rocksky.playlist.removePlaylist", "POST", {
       params,
       requireAuth: true,
@@ -41,7 +51,7 @@ export class PlaylistNamespace {
   }
 
   startPlaylist<T = unknown>(
-    params: { uri: string; shuffle?: boolean; position?: number },
+    params: StartPlaylistParams,
     opts?: RequestOptions,
   ) {
     return this.call<T>("app.rocksky.playlist.startPlaylist", "POST", {
@@ -52,7 +62,7 @@ export class PlaylistNamespace {
   }
 
   insertDirectory<T = unknown>(
-    params: { uri: string; directory: string; position?: number },
+    params: InsertDirectoryParams,
     opts?: RequestOptions,
   ) {
     return this.call<T>("app.rocksky.playlist.insertDirectory", "POST", {
@@ -63,7 +73,7 @@ export class PlaylistNamespace {
   }
 
   insertFiles<T = unknown>(
-    params: { uri: string; files: string[]; position?: number },
+    params: InsertFilesParams,
     opts?: RequestOptions,
   ) {
     return this.call<T>("app.rocksky.playlist.insertFiles", "POST", {
@@ -74,7 +84,7 @@ export class PlaylistNamespace {
   }
 
   removeTrack<T = unknown>(
-    params: { uri: string; position: number },
+    params: RemoveTrackParams,
     opts?: RequestOptions,
   ) {
     return this.call<T>("app.rocksky.playlist.removeTrack", "POST", {

package/src/namespaces/scrobble.ts

@@ -1,38 +1,12 @@
-import type { Call } from "./_helpers";
+import type {
+  CreateScrobbleInput,
+  GetScrobbleParams,
+  GetScrobblesParams,
+} from "../generated/types";
 import type { RequestOptions } from "../types";
+import type { Call } from "./_helpers";
 
-export type CreateScrobbleInput = {
-  title: string;
-  artist: string;
-  album?: string;
-  duration?: number;
-  mbId?: string;
-  isrc?: string;
-  albumArt?: string;
-  trackNumber?: number;
-  releaseDate?: string;
-  year?: number;
-  discNumber?: number;
-  lyrics?: string;
-  composer?: string;
-  copyrightMessage?: string;
-  label?: string;
-  artistPicture?: string;
-  spotifyLink?: string;
-  lastfmLink?: string;
-  tidalLink?: string;
-  appleMusicLink?: string;
-  youtubeLink?: string;
-  deezerLink?: string;
-  timestamp?: number;
-};
-
-export type GetScrobblesParams = {
-  did?: string;
-  following?: boolean;
-  limit?: number;
-  offset?: number;
-};
+export type { CreateScrobbleInput, GetScrobblesParams };
 
 export class ScrobbleNamespace {
   constructor(private readonly call: Call) {}
@@ -48,7 +22,7 @@ export class ScrobbleNamespace {
     });
   }
 
-  getScrobble<T = unknown>(params: { uri: string }, opts?: RequestOptions) {
+  getScrobble<T = unknown>(params: GetScrobbleParams, opts?: RequestOptions) {
     return this.call<T>("app.rocksky.scrobble.getScrobble", "GET", {
       params,
       ...opts,

package/src/namespaces/shout.ts

@@ -1,13 +1,22 @@
-import type { Call } from "./_helpers";
+import type {
+  CreateShoutInput,
+  GetAlbumShoutsParams,
+  GetArtistShoutsParams,
+  GetProfileShoutsParams,
+  GetShoutRepliesParams,
+  GetTrackShoutsParams,
+  RemoveShoutParams,
+  ReplyShoutInput,
+  ReportShoutInput,
+} from "../generated/types";
 import type { RequestOptions } from "../types";
-
-type UriPage = { uri: string; limit?: number; offset?: number };
+import type { Call } from "./_helpers";
 
 export class ShoutNamespace {
   constructor(private readonly call: Call) {}
 
   createShout<T = unknown>(
-    input: { message?: string } = {},
+    input: CreateShoutInput = {},
     opts?: RequestOptions,
   ) {
     return this.call<T>("app.rocksky.shout.createShout", "POST", {
@@ -18,7 +27,7 @@ export class ShoutNamespace {
   }
 
   replyShout<T = unknown>(
-    input: { shoutId: string; message: string },
+    input: ReplyShoutInput,
     opts?: RequestOptions,
   ) {
     return this.call<T>("app.rocksky.shout.replyShout", "POST", {
@@ -29,7 +38,7 @@ export class ShoutNamespace {
   }
 
   reportShout<T = unknown>(
-    input: { shoutId: string; reason?: string },
+    input: ReportShoutInput,
     opts?: RequestOptions,
   ) {
     return this.call<T>("app.rocksky.shout.reportShout", "POST", {
@@ -39,7 +48,7 @@ export class ShoutNamespace {
     });
   }
 
-  removeShout<T = unknown>(params: { id: string }, opts?: RequestOptions) {
+  removeShout<T = unknown>(params: RemoveShoutParams, opts?: RequestOptions) {
     return this.call<T>("app.rocksky.shout.removeShout", "POST", {
       params,
       requireAuth: true,
@@ -47,7 +56,7 @@ export class ShoutNamespace {
     });
   }
 
-  getShoutReplies<T = unknown>(params: UriPage, opts?: RequestOptions) {
+  getShoutReplies<T = unknown>(params: GetShoutRepliesParams, opts?: RequestOptions) {
     return this.call<T>("app.rocksky.shout.getShoutReplies", "GET", {
       params,
       ...opts,
@@ -55,7 +64,7 @@ export class ShoutNamespace {
   }
 
   getProfileShouts<T = unknown>(
-    params: { did: string; limit?: number; offset?: number },
+    params: GetProfileShoutsParams,
     opts?: RequestOptions,
   ) {
     return this.call<T>("app.rocksky.shout.getProfileShouts", "GET", {
@@ -65,7 +74,7 @@ export class ShoutNamespace {
   }
 
   getTrackShouts<T = unknown>(
-    params: { uri: string },
+    params: GetTrackShoutsParams,
     opts?: RequestOptions,
   ) {
     return this.call<T>("app.rocksky.shout.getTrackShouts", "GET", {
@@ -74,14 +83,14 @@ export class ShoutNamespace {
     });
   }
 
-  getArtistShouts<T = unknown>(params: UriPage, opts?: RequestOptions) {
+  getArtistShouts<T = unknown>(params: GetArtistShoutsParams, opts?: RequestOptions) {
     return this.call<T>("app.rocksky.shout.getArtistShouts", "GET", {
       params,
       ...opts,
     });
   }
 
-  getAlbumShouts<T = unknown>(params: UriPage, opts?: RequestOptions) {
+  getAlbumShouts<T = unknown>(params: GetAlbumShoutsParams, opts?: RequestOptions) {
     return this.call<T>("app.rocksky.shout.getAlbumShouts", "GET", {
       params,
       ...opts,

package/src/namespaces/song.ts

@@ -1,40 +1,19 @@
-import type { Call } from "./_helpers";
+import type {
+  CreateSongInput,
+  GetSongParams,
+  GetSongRecentListenersParams,
+  GetSongsParams,
+  MatchSongParams,
+} from "../generated/types";
 import type { RequestOptions } from "../types";
+import type { Call } from "./_helpers";
 
-export type GetSongParams = {
-  uri?: string;
-  mbid?: string;
-  isrc?: string;
-  spotifyId?: string;
-};
-
-export type GetSongsParams = GetSongParams & {
-  limit?: number;
-  offset?: number;
-  genre?: string;
-};
-
-export type MatchSongParams = {
-  title: string;
-  artist: string;
-  mbId?: string;
-  isrc?: string;
-};
-
-export type CreateSongInput = {
-  title: string;
-  artist: string;
-  albumArtist: string;
-  album: string;
-  duration?: number;
-  mbId?: string;
-  isrc?: string;
-  albumArt?: string;
-  trackNumber?: number;
-  releaseDate?: string;
-  year?: number;
-  discNumber?: number;
-  lyrics?: string;
+export type {
+  CreateSongInput,
+  GetSongParams,
+  GetSongRecentListenersParams,
+  GetSongsParams,
+  MatchSongParams,
 };
 
 export class SongNamespace {
@@ -55,7 +34,7 @@ export class SongNamespace {
   }
 
   getSongRecentListeners<T = unknown>(
-    params: { uri: string; limit?: number; offset?: number },
+    params: GetSongRecentListenersParams,
     opts?: RequestOptions,
   ) {
     return this.call<T>("app.rocksky.song.getSongRecentListeners", "GET", {

package/src/namespaces/spotify.ts

@@ -1,11 +1,15 @@
-import type { Call } from "./_helpers";
+import type {
+  GetCurrentlyPlayingParams,
+  SeekParams,
+} from "../generated/types";
 import type { RequestOptions } from "../types";
+import type { Call } from "./_helpers";
 
 export class SpotifyNamespace {
   constructor(private readonly call: Call) {}
 
   getCurrentlyPlaying<T = unknown>(
-    params: { actor?: string } = {},
+    params: GetCurrentlyPlayingParams = {},
     opts?: RequestOptions,
   ) {
     return this.call<T>("app.rocksky.spotify.getCurrentlyPlaying", "GET", {
@@ -42,7 +46,7 @@ export class SpotifyNamespace {
     });
   }
 
-  seek<T = unknown>(params: { position: number }, opts?: RequestOptions) {
+  seek<T = unknown>(params: SeekParams, opts?: RequestOptions) {
     return this.call<T>("app.rocksky.spotify.seek", "POST", {
       params,
       requireAuth: true,

package/src/namespaces/stats.ts

@@ -1,10 +1,14 @@
-import type { Call } from "./_helpers";
+import type {
+  GetStatsParams,
+  GetWrappedParams,
+} from "../generated/types";
 import type { RequestOptions } from "../types";
+import type { Call } from "./_helpers";
 
 export class StatsNamespace {
   constructor(private readonly call: Call) {}
 
-  getStats<T = unknown>(params: { did: string }, opts?: RequestOptions) {
+  getStats<T = unknown>(params: GetStatsParams, opts?: RequestOptions) {
     return this.call<T>("app.rocksky.stats.getStats", "GET", {
       params,
       ...opts,
@@ -12,7 +16,7 @@ export class StatsNamespace {
   }
 
   getWrapped<T = unknown>(
-    params: { did: string; year?: number },
+    params: GetWrappedParams,
     opts?: RequestOptions,
   ) {
     return this.call<T>("app.rocksky.stats.getWrapped", "GET", {