@rocksky/sdk 0.1.0 → 0.2.0

package/src/http.ts

@@ -11,7 +11,7 @@ import {
 } from "./types";
 
 export type XrpcCallOptions = RequestOptions & {
-  params?: Record<string, unknown>;
+  params?: object;
   body?: unknown;
   requireAuth?: boolean;
 };
@@ -65,11 +65,11 @@ async function resolveAuth(
 }
 
 export function serializeParams(
-  params: Record<string, unknown> | undefined,
+  params: object | undefined,
 ): string {
   if (!params) return "";
   const usp = new URLSearchParams();
-  for (const [k, v] of Object.entries(params)) {
+  for (const [k, v] of Object.entries(params as Record<string, unknown>)) {
     if (v == null) continue;
     if (Array.isArray(v)) {
       for (const item of v) {

package/src/namespaces/_helpers.ts

@@ -5,7 +5,7 @@ export type Call = <T>(
   nsid: string,
   method: "GET" | "POST",
   opts?: {
-    params?: Record<string, unknown>;
+    params?: object;
     body?: unknown;
     requireAuth?: boolean;
   } & RequestOptions,

package/src/namespaces/actor.ts

@@ -1,16 +1,20 @@
-import type { Call } from "./_helpers";
+import type {
+  GetActorAlbumsParams,
+  GetActorArtistsParams,
+  GetActorCompatibilityParams,
+  GetActorLovedSongsParams,
+  GetActorNeighboursParams,
+  GetActorPlaylistsParams,
+  GetActorScrobblesParams,
+  GetActorSongsParams,
+  GetProfileParams,
+} from "../generated/types";
 import type { RequestOptions } from "../types";
+import type { Call } from "./_helpers";
 
-export type GetProfileParams = { did?: string };
-export type DidParam = { did: string };
-export type ActorPagedParams = DidParam & {
-  limit?: number;
-  offset?: number;
-};
-export type ActorRangeParams = ActorPagedParams & {
-  startDate?: string;
-  endDate?: string;
-};
+export type { GetProfileParams };
+export type ActorPagedParams = GetActorScrobblesParams;
+export type ActorRangeParams = GetActorAlbumsParams;
 
 export class ActorNamespace {
   constructor(private readonly call: Call) {}
@@ -22,21 +26,21 @@ export class ActorNamespace {
     });
   }
 
-  getActorAlbums<T = unknown>(params: ActorRangeParams, opts?: RequestOptions) {
+  getActorAlbums<T = unknown>(params: GetActorAlbumsParams, opts?: RequestOptions) {
     return this.call<T>("app.rocksky.actor.getActorAlbums", "GET", {
       params,
       ...opts,
     });
   }
 
-  getActorArtists<T = unknown>(params: ActorRangeParams, opts?: RequestOptions) {
+  getActorArtists<T = unknown>(params: GetActorArtistsParams, opts?: RequestOptions) {
     return this.call<T>("app.rocksky.actor.getActorArtists", "GET", {
       params,
       ...opts,
     });
   }
 
-  getActorSongs<T = unknown>(params: ActorRangeParams, opts?: RequestOptions) {
+  getActorSongs<T = unknown>(params: GetActorSongsParams, opts?: RequestOptions) {
     return this.call<T>("app.rocksky.actor.getActorSongs", "GET", {
       params,
       ...opts,
@@ -44,7 +48,7 @@ export class ActorNamespace {
   }
 
   getActorScrobbles<T = unknown>(
-    params: ActorPagedParams,
+    params: GetActorScrobblesParams,
     opts?: RequestOptions,
   ) {
     return this.call<T>("app.rocksky.actor.getActorScrobbles", "GET", {
@@ -54,7 +58,7 @@ export class ActorNamespace {
   }
 
   getActorLovedSongs<T = unknown>(
-    params: ActorPagedParams,
+    params: GetActorLovedSongsParams,
     opts?: RequestOptions,
   ) {
     return this.call<T>("app.rocksky.actor.getActorLovedSongs", "GET", {
@@ -64,7 +68,7 @@ export class ActorNamespace {
   }
 
   getActorPlaylists<T = unknown>(
-    params: ActorPagedParams,
+    params: GetActorPlaylistsParams,
     opts?: RequestOptions,
   ) {
     return this.call<T>("app.rocksky.actor.getActorPlaylists", "GET", {
@@ -73,14 +77,14 @@ export class ActorNamespace {
     });
   }
 
-  getActorNeighbours<T = unknown>(params: DidParam, opts?: RequestOptions) {
+  getActorNeighbours<T = unknown>(params: GetActorNeighboursParams, opts?: RequestOptions) {
     return this.call<T>("app.rocksky.actor.getActorNeighbours", "GET", {
       params,
       ...opts,
     });
   }
 
-  getActorCompatibility<T = unknown>(params: DidParam, opts?: RequestOptions) {
+  getActorCompatibility<T = unknown>(params: GetActorCompatibilityParams, opts?: RequestOptions) {
     return this.call<T>("app.rocksky.actor.getActorCompatibility", "GET", {
       params,
       ...opts,

package/src/namespaces/album.ts

@@ -1,17 +1,17 @@
-import type { Call } from "./_helpers";
+import type {
+  GetAlbumParams,
+  GetAlbumsParams,
+  GetAlbumTracksParams,
+} from "../generated/types";
 import type { RequestOptions } from "../types";
+import type { Call } from "./_helpers";
 
-export type UriParam = { uri: string };
-export type GetAlbumsParams = {
-  limit?: number;
-  offset?: number;
-  genre?: string;
-};
+export type { GetAlbumsParams };
 
 export class AlbumNamespace {
   constructor(private readonly call: Call) {}
 
-  getAlbum<T = unknown>(params: UriParam, opts?: RequestOptions) {
+  getAlbum<T = unknown>(params: GetAlbumParams, opts?: RequestOptions) {
     return this.call<T>("app.rocksky.album.getAlbum", "GET", {
       params,
       ...opts,
@@ -25,7 +25,7 @@ export class AlbumNamespace {
     });
   }
 
-  getAlbumTracks<T = unknown>(params: UriParam, opts?: RequestOptions) {
+  getAlbumTracks<T = unknown>(params: GetAlbumTracksParams, opts?: RequestOptions) {
     return this.call<T>("app.rocksky.album.getAlbumTracks", "GET", {
       params,
       ...opts,

package/src/namespaces/apikey.ts

@@ -1,14 +1,14 @@
-import type { Call } from "./_helpers";
+import type {
+  CreateApikeyInput,
+  GetApikeysParams,
+  RemoveApikeyParams,
+  UpdateApikeyInput,
+} from "../generated/types";
 import type { RequestOptions } from "../types";
+import type { Call } from "./_helpers";
 
-export type ListApikeysParams = { limit?: number; offset?: number };
-export type CreateApikeyInput = { name: string; description?: string };
-export type UpdateApikeyInput = {
-  id: string;
-  name: string;
-  description?: string;
-};
-export type RemoveApikeyParams = { id: string };
+export type { CreateApikeyInput, UpdateApikeyInput };
+export type ListApikeysParams = GetApikeysParams;
 
 export class ApikeyNamespace {
   constructor(private readonly call: Call) {}

package/src/namespaces/artist.ts

@@ -1,27 +1,21 @@
-import type { Call } from "./_helpers";
+import type {
+  GetArtistAlbumsParams,
+  GetArtistListenersParams,
+  GetArtistParams,
+  GetArtistRecentListenersParams,
+  GetArtistsParams,
+  GetArtistTracksParams,
+} from "../generated/types";
 import type { RequestOptions } from "../types";
+import type { Call } from "./_helpers";
 
-export type UriParam = { uri: string };
-export type ArtistListenersParams = UriParam & {
-  limit?: number;
-  offset?: number;
-};
-export type GetArtistsParams = {
-  limit?: number;
-  offset?: number;
-  names?: string;
-  genre?: string;
-};
-export type GetArtistTracksParams = {
-  uri?: string;
-  limit?: number;
-  offset?: number;
-};
+export type { GetArtistsParams, GetArtistTracksParams };
+export type ArtistListenersParams = GetArtistListenersParams;
 
 export class ArtistNamespace {
   constructor(private readonly call: Call) {}
 
-  getArtist<T = unknown>(params: UriParam, opts?: RequestOptions) {
+  getArtist<T = unknown>(params: GetArtistParams, opts?: RequestOptions) {
     return this.call<T>("app.rocksky.artist.getArtist", "GET", {
       params,
       ...opts,
@@ -35,7 +29,7 @@ export class ArtistNamespace {
     });
   }
 
-  getArtistAlbums<T = unknown>(params: UriParam, opts?: RequestOptions) {
+  getArtistAlbums<T = unknown>(params: GetArtistAlbumsParams, opts?: RequestOptions) {
     return this.call<T>("app.rocksky.artist.getArtistAlbums", "GET", {
       params,
       ...opts,
@@ -53,7 +47,7 @@ export class ArtistNamespace {
   }
 
   getArtistListeners<T = unknown>(
-    params: ArtistListenersParams,
+    params: GetArtistListenersParams,
     opts?: RequestOptions,
   ) {
     return this.call<T>("app.rocksky.artist.getArtistListeners", "GET", {
@@ -63,7 +57,7 @@ export class ArtistNamespace {
   }
 
   getArtistRecentListeners<T = unknown>(
-    params: ArtistListenersParams,
+    params: GetArtistRecentListenersParams,
     opts?: RequestOptions,
   ) {
     return this.call<T>("app.rocksky.artist.getArtistRecentListeners", "GET", {

package/src/namespaces/charts.ts

@@ -1,22 +1,13 @@
-import type { Call } from "./_helpers";
+import type {
+  GetScrobblesChartParams,
+  GetTopArtistsParams,
+  GetTopTracksParams,
+} from "../generated/types";
 import type { RequestOptions } from "../types";
+import type { Call } from "./_helpers";
 
-export type ScrobblesChartParams = {
-  did?: string;
-  artisturi?: string;
-  albumuri?: string;
-  songuri?: string;
-  genre?: string;
-  from?: string;
-  to?: string;
-};
-
-export type TopChartParams = {
-  limit?: number;
-  offset?: number;
-  startDate?: string;
-  endDate?: string;
-};
+export type ScrobblesChartParams = GetScrobblesChartParams;
+export type TopChartParams = GetTopArtistsParams;
 
 export class ChartsNamespace {
   constructor(private readonly call: Call) {}
@@ -31,14 +22,14 @@ export class ChartsNamespace {
     });
   }
 
-  getTopArtists<T = unknown>(params: TopChartParams = {}, opts?: RequestOptions) {
+  getTopArtists<T = unknown>(params: GetTopArtistsParams = {}, opts?: RequestOptions) {
     return this.call<T>("app.rocksky.charts.getTopArtists", "GET", {
       params,
       ...opts,
     });
   }
 
-  getTopTracks<T = unknown>(params: TopChartParams = {}, opts?: RequestOptions) {
+  getTopTracks<T = unknown>(params: GetTopTracksParams = {}, opts?: RequestOptions) {
     return this.call<T>("app.rocksky.charts.getTopTracks", "GET", {
       params,
       ...opts,

package/src/namespaces/dropbox.ts

@@ -1,11 +1,17 @@
-import type { Call } from "./_helpers";
+import type {
+  DownloadFileParams,
+  GetFilesParams,
+  GetMetadataParams,
+  GetTemporaryLinkParams,
+} from "../generated/types";
 import type { RequestOptions } from "../types";
+import type { Call } from "./_helpers";
 
 export class DropboxNamespace {
   constructor(private readonly call: Call) {}
 
   getFiles<T = unknown>(
-    params: { at?: string } = {},
+    params: GetFilesParams = {},
     opts?: RequestOptions,
   ) {
     return this.call<T>("app.rocksky.dropbox.getFiles", "GET", {
@@ -15,7 +21,7 @@ export class DropboxNamespace {
     });
   }
 
-  getMetadata<T = unknown>(params: { path: string }, opts?: RequestOptions) {
+  getMetadata<T = unknown>(params: GetMetadataParams, opts?: RequestOptions) {
     return this.call<T>("app.rocksky.dropbox.getMetadata", "GET", {
       params,
       requireAuth: true,
@@ -24,7 +30,7 @@ export class DropboxNamespace {
   }
 
   getTemporaryLink<T = unknown>(
-    params: { path: string },
+    params: GetTemporaryLinkParams,
     opts?: RequestOptions,
   ) {
     return this.call<T>("app.rocksky.dropbox.getTemporaryLink", "GET", {
@@ -35,7 +41,7 @@ export class DropboxNamespace {
   }
 
   downloadFile<T = unknown>(
-    params: { fileId: string },
+    params: DownloadFileParams,
     opts?: RequestOptions,
   ) {
     return this.call<T>("app.rocksky.dropbox.downloadFile", "GET", {

package/src/namespaces/feed.ts

@@ -1,12 +1,23 @@
-import type { Call } from "./_helpers";
+import type {
+  GetAlbumRecommendationsParams,
+  GetArtistRecommendationsParams,
+  GetFeedGeneratorParams,
+  GetFeedGeneratorsParams,
+  GetFeedParams,
+  GetFeedSkeletonParams,
+  GetRecommendationsParams,
+  GetStoriesParams,
+  SearchParams,
+} from "../generated/types";
 import type { RequestOptions } from "../types";
+import type { Call } from "./_helpers";
 
-export type RecommendParams = { did: string; limit?: number };
+export type RecommendParams = GetRecommendationsParams;
 
 export class FeedNamespace {
   constructor(private readonly call: Call) {}
 
-  search<T = unknown>(params: { query: string }, opts?: RequestOptions) {
+  search<T = unknown>(params: SearchParams, opts?: RequestOptions) {
     return this.call<T>("app.rocksky.feed.search", "GET", {
       params,
       ...opts,
@@ -14,7 +25,7 @@ export class FeedNamespace {
   }
 
   getFeed<T = unknown>(
-    params: { feed: string; limit?: number; cursor?: string },
+    params: GetFeedParams,
     opts?: RequestOptions,
   ) {
     return this.call<T>("app.rocksky.feed.getFeed", "GET", {
@@ -24,7 +35,7 @@ export class FeedNamespace {
   }
 
   getFeedGenerators<T = unknown>(
-    params: { size?: number } = {},
+    params: GetFeedGeneratorsParams = {},
     opts?: RequestOptions,
   ) {
     return this.call<T>("app.rocksky.feed.getFeedGenerators", "GET", {
@@ -34,7 +45,7 @@ export class FeedNamespace {
   }
 
   getFeedGenerator<T = unknown>(
-    params: { feed: string },
+    params: GetFeedGeneratorParams,
     opts?: RequestOptions,
   ) {
     return this.call<T>("app.rocksky.feed.getFeedGenerator", "GET", {
@@ -50,12 +61,7 @@ export class FeedNamespace {
   }
 
   getFeedSkeleton<T = unknown>(
-    params: {
-      feed: string;
-      limit?: number;
-      offset?: number;
-      cursor?: string;
-    },
+    params: GetFeedSkeletonParams,
     opts?: RequestOptions,
   ) {
     return this.call<T>("app.rocksky.feed.getFeedSkeleton", "GET", {
@@ -65,7 +71,7 @@ export class FeedNamespace {
   }
 
   getRecommendations<T = unknown>(
-    params: RecommendParams,
+    params: GetRecommendationsParams,
     opts?: RequestOptions,
   ) {
     return this.call<T>("app.rocksky.feed.getRecommendations", "GET", {
@@ -75,7 +81,7 @@ export class FeedNamespace {
   }
 
   getArtistRecommendations<T = unknown>(
-    params: RecommendParams,
+    params: GetArtistRecommendationsParams,
     opts?: RequestOptions,
   ) {
     return this.call<T>("app.rocksky.feed.getArtistRecommendations", "GET", {
@@ -85,7 +91,7 @@ export class FeedNamespace {
   }
 
   getAlbumRecommendations<T = unknown>(
-    params: RecommendParams,
+    params: GetAlbumRecommendationsParams,
     opts?: RequestOptions,
   ) {
     return this.call<T>("app.rocksky.feed.getAlbumRecommendations", "GET", {
@@ -95,7 +101,7 @@ export class FeedNamespace {
   }
 
   getStories<T = unknown>(
-    params: { size?: number } = {},
+    params: GetStoriesParams = {},
     opts?: RequestOptions,
   ) {
     return this.call<T>("app.rocksky.feed.getStories", "GET", {

package/src/namespaces/googledrive.ts

@@ -1,10 +1,15 @@
-import type { Call } from "./_helpers";
+import type {
+  DownloadFileParams,
+  GetFileParams,
+  GetFilesParams,
+} from "../generated/types";
 import type { RequestOptions } from "../types";
+import type { Call } from "./_helpers";
 
 export class GoogleDriveNamespace {
   constructor(private readonly call: Call) {}
 
-  getFile<T = unknown>(params: { fileId: string }, opts?: RequestOptions) {
+  getFile<T = unknown>(params: GetFileParams, opts?: RequestOptions) {
     return this.call<T>("app.rocksky.googledrive.getFile", "GET", {
       params,
       requireAuth: true,
@@ -13,7 +18,7 @@ export class GoogleDriveNamespace {
   }
 
   getFiles<T = unknown>(
-    params: { at?: string } = {},
+    params: GetFilesParams = {},
     opts?: RequestOptions,
   ) {
     return this.call<T>("app.rocksky.googledrive.getFiles", "GET", {
@@ -24,7 +29,7 @@ export class GoogleDriveNamespace {
   }
 
   downloadFile<T = unknown>(
-    params: { fileId: string },
+    params: DownloadFileParams,
     opts?: RequestOptions,
   ) {
     return this.call<T>("app.rocksky.googledrive.downloadFile", "GET", {

package/src/namespaces/graph.ts

@@ -1,22 +1,21 @@
-import type { Call } from "./_helpers";
+import type {
+  FollowAccountParams,
+  GetFollowersParams,
+  GetFollowsParams,
+  GetKnownFollowersParams,
+  UnfollowAccountParams,
+} from "../generated/types";
 import type { RequestOptions } from "../types";
+import type { Call } from "./_helpers";
 
-export type ActorParam = { actor: string };
-export type FollowListParams = ActorParam & {
-  limit?: number;
-  cursor?: string;
-  dids?: string[];
-};
-export type KnownFollowersParams = ActorParam & {
-  limit?: number;
-  cursor?: string;
-};
+export type FollowListParams = GetFollowersParams;
+export type KnownFollowersParams = GetKnownFollowersParams;
 
 export class GraphNamespace {
   constructor(private readonly call: Call) {}
 
   followAccount<T = unknown>(
-    params: { account: string },
+    params: FollowAccountParams,
     opts?: RequestOptions,
   ) {
     return this.call<T>("app.rocksky.graph.followAccount", "POST", {
@@ -27,7 +26,7 @@ export class GraphNamespace {
   }
 
   unfollowAccount<T = unknown>(
-    params: { account: string },
+    params: UnfollowAccountParams,
     opts?: RequestOptions,
   ) {
     return this.call<T>("app.rocksky.graph.unfollowAccount", "POST", {
@@ -37,14 +36,14 @@ export class GraphNamespace {
     });
   }
 
-  getFollowers<T = unknown>(params: FollowListParams, opts?: RequestOptions) {
+  getFollowers<T = unknown>(params: GetFollowersParams, opts?: RequestOptions) {
     return this.call<T>("app.rocksky.graph.getFollowers", "GET", {
       params,
       ...opts,
     });
   }
 
-  getFollows<T = unknown>(params: FollowListParams, opts?: RequestOptions) {
+  getFollows<T = unknown>(params: GetFollowsParams, opts?: RequestOptions) {
     return this.call<T>("app.rocksky.graph.getFollows", "GET", {
       params,
       ...opts,
@@ -52,7 +51,7 @@ export class GraphNamespace {
   }
 
   getKnownFollowers<T = unknown>(
-    params: KnownFollowersParams,
+    params: GetKnownFollowersParams,
     opts?: RequestOptions,
   ) {
     return this.call<T>("app.rocksky.graph.getKnownFollowers", "GET", {

package/src/namespaces/like.ts

@@ -1,12 +1,18 @@
-import type { Call } from "./_helpers";
+import type {
+  DislikeShoutInput,
+  DislikeSongInput,
+  LikeShoutInput,
+  LikeSongInput,
+} from "../generated/types";
 import type { RequestOptions } from "../types";
+import type { Call } from "./_helpers";
 
-export type LikeInput = { uri?: string };
+export type LikeInput = LikeSongInput;
 
 export class LikeNamespace {
   constructor(private readonly call: Call) {}
 
-  likeSong<T = unknown>(input: LikeInput = {}, opts?: RequestOptions) {
+  likeSong<T = unknown>(input: LikeSongInput = {}, opts?: RequestOptions) {
     return this.call<T>("app.rocksky.like.likeSong", "POST", {
       body: input,
       requireAuth: true,
@@ -14,7 +20,7 @@ export class LikeNamespace {
     });
   }
 
-  dislikeSong<T = unknown>(input: LikeInput = {}, opts?: RequestOptions) {
+  dislikeSong<T = unknown>(input: DislikeSongInput = {}, opts?: RequestOptions) {
     return this.call<T>("app.rocksky.like.dislikeSong", "POST", {
       body: input,
       requireAuth: true,
@@ -22,7 +28,7 @@ export class LikeNamespace {
     });
   }
 
-  likeShout<T = unknown>(input: LikeInput = {}, opts?: RequestOptions) {
+  likeShout<T = unknown>(input: LikeShoutInput = {}, opts?: RequestOptions) {
     return this.call<T>("app.rocksky.like.likeShout", "POST", {
       body: input,
       requireAuth: true,
@@ -30,7 +36,7 @@ export class LikeNamespace {
     });
   }
 
-  dislikeShout<T = unknown>(input: LikeInput = {}, opts?: RequestOptions) {
+  dislikeShout<T = unknown>(input: DislikeShoutInput = {}, opts?: RequestOptions) {
     return this.call<T>("app.rocksky.like.dislikeShout", "POST", {
       body: input,
       requireAuth: true,

package/src/namespaces/mirror.ts

@@ -1,12 +1,8 @@
-import type { Call } from "./_helpers";
+import type { PutMirrorSourceInput } from "../generated/types";
 import type { RequestOptions } from "../types";
+import type { Call } from "./_helpers";
 
-export type PutMirrorSourceInput = {
-  provider: string;
-  enabled?: boolean;
-  externalUsername?: string;
-  apiKey?: string;
-};
+export type { PutMirrorSourceInput };
 
 export class MirrorNamespace {
   constructor(private readonly call: Call) {}