@rocksky/sdk 0.4.0 → 0.6.0

package/README.md

@@ -32,12 +32,53 @@ const uri = await agent.scrobble({
 
 ## API
 
-**Reads — `RockskyClient`**: `profile`, `scrobbles`, `songs`, `albums`,
-`artists`, `topTracks`, `topArtists`, `search`, `globalStats`.
+**Reads — `RockskyClient`**: the client now covers the whole `app.rocksky.*`
+read surface. Typed methods include `profile`, `scrobbles`, `songs`, `albums`,
+`artists`, `topTracks`, `topArtists`, `search`, `globalStats`, `lovedSongs`,
+`catalogAlbums`, `catalogArtists`, `catalogSongs`, `albumTracks`, `artistAlbums`,
+`artistTracks`, `scrobbleFeed`, `scrobble` (single by uri), `follows`,
+`followers`, `knownFollowers`. Raw (`unknown`-returning) detail/long-tail
+methods cover the rest: `album`, `artist`, `song`, `feed`, `playlists`,
+`playlist`, `stats`, `wrapped`, `scrobblesChart`, `recommendations`,
+`neighbours`, shouts, and more.
+
+Every named method is sugar over the universal escape hatch **`rk.get(nsid,
+params)`**, which calls ANY read query by nsid and returns `unknown`.
+
+**Typed date-window charts**: `topTracksInterval(limit, offset, interval)` and
+`topArtistsInterval(...)` take a `DateInterval` built with the `Interval`
+factories — `Interval.allTime()`, `Interval.lastDays(n)`, `Interval.lastWeeks(n)`,
+`Interval.lastMonths(n)`, `Interval.lastYears(n)`, `Interval.range(start, end)`.
+`topTracks` / `topArtists` remain all-time shorthands.
 
-**Writes — `Agent`**: `scrobble`, `createSong`/`createAlbum`/`createArtist`,
-`like`, `follow`, `shout`/`replyShout`, `setNowPlaying`/`clearNowPlaying`,
-`delete`. Records are the generated types from `./generated/types`.
+```ts
+import { RockskyClient, Interval } from "@rocksky/sdk";
+
+const rk = new RockskyClient();
+const monthly = await rk.topTracksInterval(10, 0, Interval.lastMonths(1));
+
+// Resolve a bare title + artist into full canonical metadata.
+const song = await rk.matchSong("Chaser", "Calibro 35");
+```
+
+**`matchSong(title, artist, mbId?, isrc?)`**: resolves a bare title + artist into
+full canonical metadata (album, artwork, duration, MBID, ISRC, links).
+
+**Auth-gated reads**: pass an optional bearer access token —
+`new RockskyClient(appview, token)` — and it is sent as
+`Authorization: Bearer <token>`.
+
+**Writes — `Agent`**: two scrobble paths. `scrobble(rec)` writes full metadata
+you already have; `scrobbleMatch(input, appview?)` takes a `ScrobbleMatchInput`
+object (`{ title, artist, album?, mbId?, isrc?, timestamp? }` — title/artist
+required; `album` overrides the resolved album, `mbId`/`isrc` are match anchors,
+`timestamp` is a scrobbled-at Unix-seconds time; the optional `appview` overrides
+the AppView used for matching) and resolves full metadata via `matchSong` first,
+then writes — e.g. `agent.scrobbleMatch({ title: "Chaser", artist: "Calibro 35" })`.
+Plus
+`createSong`/`createAlbum`/`createArtist`, `like`, `follow`,
+`shout`/`replyShout`, `setNowPlaying`/`clearNowPlaying`, `delete`. Records are the
+generated types from `./generated/types`.
 
 **Identity hashes**: `songHash`, `albumHash`, `artistHash` — lowercase-hex
 SHA-256, identical to the server and every other Rocksky SDK.

package/dist/agent.d.ts

@@ -6,6 +6,19 @@ import { type JetstreamOptions } from "./jetstream.js";
 export type ScrobbleInput = Omit<ScrobbleRecord, "createdAt"> & {
     createdAt?: string;
 };
+/** Input for {@link Agent.scrobbleMatch} — `title`/`artist` required, rest optional. */
+export interface ScrobbleMatchInput {
+    title: string;
+    artist: string;
+    /** Overrides the matched album. */
+    album?: string;
+    /** MusicBrainz recording id — anchors the match. */
+    mbId?: string;
+    /** ISRC — anchors the match. */
+    isrc?: string;
+    /** Scrobbled-at Unix seconds; omitted = now. */
+    timestamp?: number;
+}
 /** Input for {@link Agent.createSong}. */
 export type SongInput = Omit<SongRecord, "createdAt"> & {
     createdAt?: string;
@@ -55,6 +68,11 @@ export declare class Agent {
     delete(collection: string, rkey: string): Promise<void>;
     /** Scrobble a play (app.rocksky.scrobble). createdAt defaults to now. */
     scrobble(rec: ScrobbleInput): Promise<string>;
+    /** Scrobble from just a title + artist (album optional, plus optional
+     * `mbId`/`isrc` anchors): resolve full metadata via `matchSong`, then write.
+     * Matching uses the public AppView unless `appview` is given; an empty match
+     * falls back to a minimal record. */
+    scrobbleMatch(input: ScrobbleMatchInput, appview?: string): Promise<string>;
     /** Create a canonical track record (app.rocksky.song). */
     createSong(rec: SongInput): Promise<string>;
     /** Create an album record (app.rocksky.album). `artist` is the album artist. */

package/dist/agent.d.ts.map

@@ -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,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;IAMxE,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,yEAAyE;IACnE,QAAQ,CAAC,GAAG,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC;IAenD,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,wDAAwD;IACxD,KAAK,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAI/E,kDAAkD;IAClD,UAAU,CACR,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,MAAM,CAAC;IASlB,qEAAqE;IACrE,aAAa,CAAC,KAAK,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC;IAIrD,uDAAuD;IACvD,eAAe,IAAI,OAAO,CAAC,IAAI,CAAC;CAGjC"}
+{"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;IAMxE,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,yEAAyE;IACnE,QAAQ,CAAC,GAAG,EAAE,aAAa,GAAG,OAAO,CAAC,MAAM,CAAC;IAenD;;;yCAGqC;IAC/B,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,wDAAwD;IACxD,KAAK,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAI/E,kDAAkD;IAClD,UAAU,CACR,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,GACd,OAAO,CAAC,MAAM,CAAC;IASlB,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

@@ -1,29 +1,170 @@
-import type { ActorProfileViewDetailed, AlbumViewBasic, ArtistViewBasic, FeedSearchResultsView, ScrobbleViewBasic, SongViewBasic, StatsGlobalStatsView } from "./generated/types.js";
+import type { ActorProfileViewBasic, ActorProfileViewDetailed, AlbumViewBasic, ArtistViewBasic, FeedSearchResultsView, ScrobbleViewBasic, SongViewBasic, StatsGlobalStatsView } from "./generated/types.js";
+/**
+ * A typed date window for the `top*` charts. Build one with the {@link Interval}
+ * factories; `range` bounds are RFC-3339 datetimes.
+ */
+export interface DateInterval {
+    startDate?: string;
+    endDate?: string;
+}
+/** Factories for {@link DateInterval} windows used by the `top*Interval` charts. */
+export declare const Interval: {
+    /** No bounds — the all-time chart. */
+    allTime: () => DateInterval;
+    /** The last `n` days ending now. */
+    lastDays: (n: number) => DateInterval;
+    /** The last `n` weeks ending now. */
+    lastWeeks: (n: number) => DateInterval;
+    /** The last `n` months ending now. */
+    lastMonths: (n: number) => DateInterval;
+    /** The last `n` years ending now. */
+    lastYears: (n: number) => DateInterval;
+    /** An explicit closed `[start, end]` window. */
+    range: (start: Date, end: Date) => DateInterval;
+};
 /** The default public Rocksky AppView base URL. */
 export declare const DEFAULT_APPVIEW = "https://api.rocksky.app";
 /** Unauthenticated read client over the public Rocksky AppView XRPC. */
 export declare class RockskyClient {
     private rpc;
-    /** Build a read client against an AppView base URL (defaults to {@link DEFAULT_APPVIEW}). */
-    constructor(appview?: string);
+    /**
+     * Build a read client against an AppView base URL (defaults to
+     * {@link DEFAULT_APPVIEW}). Pass `token` to send it as
+     * `Authorization: Bearer <token>` on every read — needed only for auth-gated
+     * queries.
+     */
+    constructor(appview?: string, token?: string);
     private query;
     /** An actor's detailed profile. `actor` is a handle or DID. */
     profile(actor: string): Promise<ActorProfileViewDetailed>;
     /** An actor's scrobbles, newest first. */
     scrobbles(actor: string, limit?: number, offset?: number): Promise<ScrobbleViewBasic[]>;
+    /** Call any AppView read query by nsid; returns the raw JSON response. Every
+     * method here is sugar over this — use it for queries without a wrapper. */
+    get(nsid: string, params?: Record<string, unknown>): Promise<unknown>;
     /** An actor's most-played songs. */
     songs(actor: string, limit?: number, offset?: number): Promise<SongViewBasic[]>;
+    /** An actor's loved (liked) songs. */
+    lovedSongs(actor: string, limit?: number, offset?: number): Promise<SongViewBasic[]>;
     /** An actor's most-played albums. */
     albums(actor: string, limit?: number, offset?: number): Promise<AlbumViewBasic[]>;
     /** An actor's most-played artists. */
     artists(actor: string, limit?: number, offset?: number): Promise<ArtistViewBasic[]>;
-    /** The platform-wide top tracks chart. */
+    /** The platform-wide top tracks chart (all-time). */
     topTracks(limit?: number, offset?: number): Promise<SongViewBasic[]>;
-    /** The platform-wide top artists chart. */
+    /** The platform-wide top artists chart (all-time). */
     topArtists(limit?: number, offset?: number): Promise<ArtistViewBasic[]>;
+    /** The top tracks chart over a typed {@link DateInterval}. */
+    topTracksInterval(limit: number, offset: number, interval: DateInterval): Promise<SongViewBasic[]>;
+    /** The top artists chart over a typed {@link DateInterval}. */
+    topArtistsInterval(limit: number, offset: number, interval: DateInterval): Promise<ArtistViewBasic[]>;
+    /** The album catalog, optionally filtered by `genre`. */
+    catalogAlbums(limit?: number, offset?: number, genre?: string): Promise<AlbumViewBasic[]>;
+    /** The artist catalog, optionally filtered by `genre`. */
+    catalogArtists(limit?: number, offset?: number, genre?: string): Promise<ArtistViewBasic[]>;
+    /** The song catalog, optionally filtered by `genre`. */
+    catalogSongs(limit?: number, offset?: number, genre?: string): Promise<SongViewBasic[]>;
+    /** An album's tracklist by album at:// URI. */
+    albumTracks(uri: string): Promise<SongViewBasic[]>;
+    /** An artist's albums by artist at:// URI. */
+    artistAlbums(uri: string): Promise<AlbumViewBasic[]>;
+    /** An artist's top tracks by artist at:// URI. */
+    artistTracks(uri: string, limit?: number, offset?: number): Promise<SongViewBasic[]>;
+    /** A social/global scrobbles feed. Pass `did` to scope to an actor and
+     * `following = true` for their follow graph. */
+    scrobbleFeed(did?: string, following?: boolean, limit?: number, offset?: number): Promise<ScrobbleViewBasic[]>;
+    /** A single scrobble by its at:// URI. */
+    scrobble(uri: string): Promise<ScrobbleViewBasic>;
+    /** The accounts `actor` follows. */
+    follows(actor: string, limit?: number, cursor?: string): Promise<ActorProfileViewBasic[]>;
+    /** The accounts that follow `actor`. */
+    followers(actor: string, limit?: number, cursor?: string): Promise<ActorProfileViewBasic[]>;
+    /** Followers of `actor` that the viewer also follows. */
+    knownFollowers(actor: string, limit?: number, cursor?: string): Promise<ActorProfileViewBasic[]>;
     /** Full-text search across songs, albums, artists, playlists, actors. */
     search(query: string): Promise<FeedSearchResultsView>;
     /** Platform-wide totals. */
     globalStats(): Promise<StatsGlobalStatsView>;
+    /** A feed by its at:// URI (paginate via `cursor`). */
+    feed(feed: string, limit?: number, cursor?: string): Promise<unknown>;
+    /** A single album with its tracklist. */
+    album(uri: string): Promise<unknown>;
+    /** A single artist with detail. */
+    artist(uri: string): Promise<unknown>;
+    /** Resolve full canonical metadata for a bare title + artist
+     * (`app.rocksky.song.matchSong`); optionally anchor with `mbId` / `isrc`. */
+    matchSong(title: string, artist: string, mbId?: string, isrc?: string): Promise<unknown>;
+    /** A single song by at:// `uri` (or by `mbid` / `isrc` / `spotifyId`). */
+    song(opts: {
+        uri?: string;
+        mbid?: string;
+        isrc?: string;
+        spotifyId?: string;
+    }): Promise<unknown>;
+    /** An actor's playlists. */
+    actorPlaylists(actor: string, limit?: number, offset?: number): Promise<unknown>;
+    /** Actors with similar taste to `actor`. */
+    neighbours(actor: string): Promise<unknown>;
+    /** Music compatibility between the viewer and `actor` (auth). */
+    compatibility(actor: string): Promise<unknown>;
+    /** An artist's all-time listeners. */
+    artistListeners(uri: string, limit?: number, offset?: number): Promise<unknown>;
+    /** An artist's recent listeners. */
+    artistRecentListeners(uri: string, limit?: number, offset?: number): Promise<unknown>;
+    /** A song's recent listeners. */
+    songRecentListeners(uri: string, limit?: number, offset?: number): Promise<unknown>;
+    /** A scrobble time-series chart. Scope with any of `did` / `artisturi` /
+     * `albumuri` / `songuri` / `genre` and bound with `from` / `to`. */
+    scrobblesChart(opts: {
+        did?: string;
+        artisturi?: string;
+        albumuri?: string;
+        songuri?: string;
+        genre?: string;
+        from?: string;
+        to?: string;
+    }): Promise<unknown>;
+    /** List the available feed generators. */
+    feedGenerators(size?: number): Promise<unknown>;
+    /** A single feed generator's record. */
+    feedGenerator(feed: string): Promise<unknown>;
+    /** The stories row. */
+    stories(size?: number, feed?: string, following?: boolean): Promise<unknown>;
+    /** Track recommendations for `actor`. */
+    recommendations(actor: string, limit?: number): Promise<unknown>;
+    /** Artist recommendations for `actor`. */
+    artistRecommendations(actor: string, limit?: number): Promise<unknown>;
+    /** Album recommendations for `actor`. */
+    albumRecommendations(actor: string, limit?: number): Promise<unknown>;
+    /** An actor's aggregate stats. */
+    stats(actor: string): Promise<unknown>;
+    /** An actor's year-in-review. */
+    wrapped(actor: string, year?: number): Promise<unknown>;
+    /** The viewer's configured scrobble mirror sources (auth). */
+    mirrorSources(): Promise<unknown>;
+    /** What `actor` is playing now. */
+    currentlyPlaying(playerId?: string, actor?: string): Promise<unknown>;
+    /** A player's playback queue. */
+    playbackQueue(playerId: string): Promise<unknown>;
+    /** What `actor` is playing now on Spotify. */
+    spotifyCurrentlyPlaying(actor: string): Promise<unknown>;
+    /** The playlist catalog. */
+    playlists(limit?: number, offset?: number): Promise<unknown>;
+    /** A single playlist with its items. */
+    playlist(uri: string): Promise<unknown>;
+    /** Shouts on an album. */
+    albumShouts(uri: string, limit?: number, offset?: number): Promise<unknown>;
+    /** Shouts on an artist. */
+    artistShouts(uri: string, limit?: number, offset?: number): Promise<unknown>;
+    /** Shouts on a profile. */
+    profileShouts(actor: string, limit?: number, offset?: number): Promise<unknown>;
+    /** Shouts on a track. */
+    trackShouts(uri: string): Promise<unknown>;
+    /** Replies to a shout. */
+    shoutReplies(uri: string, limit?: number, offset?: number): Promise<unknown>;
+    /** An actor's Rockbox EQ / audio settings. */
+    audioSettings(actor: string): Promise<unknown>;
+    /** The viewer's API keys (auth). */
+    apikeys(limit?: number, offset?: number): Promise<unknown>;
 }
 //# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,wBAAwB,EACxB,cAAc,EACd,eAAe,EACf,qBAAqB,EAOrB,iBAAiB,EACjB,aAAa,EACb,oBAAoB,EACrB,MAAM,sBAAsB,CAAC;AAE9B,mDAAmD;AACnD,eAAO,MAAM,eAAe,4BAA4B,CAAC;AAEzD,wEAAwE;AACxE,qBAAa,aAAa;IACxB,OAAO,CAAC,GAAG,CAAS;IAEpB,6FAA6F;gBACjF,OAAO,GAAE,MAAwB;YAI/B,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,oCAAoC;IAC9B,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,SAAK,EAAE,MAAM,SAAI,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAS5E,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,0CAA0C;IACpC,SAAS,CAAC,KAAK,SAAK,EAAE,MAAM,SAAI,GAAG,OAAO,CAAC,aAAa,EAAE,CAAC;IAKjE,2CAA2C;IACrC,UAAU,CAAC,KAAK,SAAK,EAAE,MAAM,SAAI,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC;IAKpE,yEAAyE;IACzE,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAIrD,4BAA4B;IAC5B,WAAW,IAAI,OAAO,CAAC,oBAAoB,CAAC;CAG7C"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,qBAAqB,EACrB,wBAAwB,EACxB,cAAc,EACd,eAAe,EACf,qBAAqB,EAIrB,iBAAiB,EACjB,aAAa,EACb,oBAAoB,EACrB,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;IAEpB;;;;;OAKG;gBACS,OAAO,GAAE,MAAwB,EAAE,KAAK,CAAC,EAAE,MAAM;YAa/C,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,OAAO,CAAC;IAGjE,yCAAyC;IACzC,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAGpC,mCAAmC;IACnC,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAGrC;iFAC6E;IAC7E,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAGxF,0EAA0E;IAC1E,IAAI,CAAC,IAAI,EAAE;QAAE,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,SAAS,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,OAAO,CAAC;IAGhG,4BAA4B;IAC5B,cAAc,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,SAAK,EAAE,MAAM,SAAI,GAAG,OAAO,CAAC,OAAO,CAAC;IAGvE,4CAA4C;IAC5C,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAG3C,iEAAiE;IACjE,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAG9C,sCAAsC;IACtC,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,SAAK,EAAE,MAAM,SAAI,GAAG,OAAO,CAAC,OAAO,CAAC;IAGtE,oCAAoC;IACpC,qBAAqB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,SAAK,EAAE,MAAM,SAAI,GAAG,OAAO,CAAC,OAAO,CAAC;IAG5E,iCAAiC;IACjC,mBAAmB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,SAAK,EAAE,MAAM,SAAI,GAAG,OAAO,CAAC,OAAO,CAAC;IAG1E;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,OAAO,CAAC;IAGpB,0CAA0C;IAC1C,cAAc,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAG/C,wCAAwC;IACxC,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAG7C,uBAAuB;IACvB,OAAO,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAG5E,yCAAyC;IACzC,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAGhE,0CAA0C;IAC1C,qBAAqB,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAGtE,yCAAyC;IACzC,oBAAoB,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAGrE,kCAAkC;IAClC,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAGtC,iCAAiC;IACjC,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAGvD,8DAA8D;IAC9D,aAAa,IAAI,OAAO,CAAC,OAAO,CAAC;IAGjC,mCAAmC;IACnC,gBAAgB,CAAC,QAAQ,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAGrE,iCAAiC;IACjC,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAGjD,8CAA8C;IAC9C,uBAAuB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAGxD,4BAA4B;IAC5B,SAAS,CAAC,KAAK,SAAK,EAAE,MAAM,SAAI,GAAG,OAAO,CAAC,OAAO,CAAC;IAGnD,wCAAwC;IACxC,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAGvC,0BAA0B;IAC1B,WAAW,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,SAAK,EAAE,MAAM,SAAI,GAAG,OAAO,CAAC,OAAO,CAAC;IAGlE,2BAA2B;IAC3B,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,SAAK,EAAE,MAAM,SAAI,GAAG,OAAO,CAAC,OAAO,CAAC;IAGnE,2BAA2B;IAC3B,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,SAAK,EAAE,MAAM,SAAI,GAAG,OAAO,CAAC,OAAO,CAAC;IAGtE,yBAAyB;IACzB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAG1C,0BAA0B;IAC1B,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,SAAK,EAAE,MAAM,SAAI,GAAG,OAAO,CAAC,OAAO,CAAC;IAGnE,8CAA8C;IAC9C,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAG9C,oCAAoC;IACpC,OAAO,CAAC,KAAK,SAAK,EAAE,MAAM,SAAI,GAAG,OAAO,CAAC,OAAO,CAAC;CAGlD"}

package/dist/index.d.ts

@@ -8,8 +8,9 @@
  * ({@link Agent.syncRepo}) and kept live off the Jetstream firehose
  * ({@link Agent.hydrateFromJetstream}).
  */
-export { RockskyClient, DEFAULT_APPVIEW } from "./client.js";
-export { Agent, type ScrobbleInput, type SongInput, type AlbumInput, type ArtistInput } from "./agent.js";
+export { RockskyClient, DEFAULT_APPVIEW, Interval } from "./client.js";
+export type { DateInterval } from "./client.js";
+export { Agent, type ScrobbleInput, type ScrobbleMatchInput, type SongInput, type AlbumInput, type ArtistInput, } from "./agent.js";
 export { RockskyIndex, totalIndexed, type IndexStats } from "./dedup.js";
 export { runJetstream, DEFAULT_JETSTREAM_SERVERS, type JetstreamOptions } from "./jetstream.js";
 export { songHash, albumHash, artistHash } from "./hash.js";

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAC7D,OAAO,EAAE,KAAK,EAAE,KAAK,aAAa,EAAE,KAAK,SAAS,EAAE,KAAK,UAAU,EAAE,KAAK,WAAW,EAAE,MAAM,YAAY,CAAC;AAC1G,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,KAAK,UAAU,EAAE,MAAM,YAAY,CAAC;AACzE,OAAO,EAAE,YAAY,EAAE,yBAAyB,EAAE,KAAK,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAChG,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,mBAAmB,sBAAsB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvE,YAAY,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAChD,OAAO,EACL,KAAK,EACL,KAAK,aAAa,EAClB,KAAK,kBAAkB,EACvB,KAAK,SAAS,EACd,KAAK,UAAU,EACf,KAAK,WAAW,GACjB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,YAAY,EAAE,YAAY,EAAE,KAAK,UAAU,EAAE,MAAM,YAAY,CAAC;AACzE,OAAO,EAAE,YAAY,EAAE,yBAAyB,EAAE,KAAK,gBAAgB,EAAE,MAAM,gBAAgB,CAAC;AAChG,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAC5D,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAC3C,mBAAmB,sBAAsB,CAAC"}