osu-play 1.3.3 → 1.4.0

package/dist/core/api/catalog.d.ts

@@ -0,0 +1,61 @@
+export type CatalogBeatmapMetadata = {
+    Artist?: string | null;
+    ArtistUnicode?: string | null;
+    AudioFile?: string | null;
+    BackgroundFile?: string | null;
+    Title?: string | null;
+    TitleUnicode?: string | null;
+};
+export type CatalogBeatmap = {
+    Length?: number | null;
+    Metadata: CatalogBeatmapMetadata;
+};
+export type CatalogBeatmapSet = {
+    Beatmaps: Iterable<CatalogBeatmap>;
+    DeletePending?: boolean;
+    Files: Iterable<{
+        File?: {
+            Hash?: string | null;
+        } | null;
+        Filename?: string | null;
+    }>;
+    Hash?: string | null;
+    ID?: unknown;
+};
+export type CatalogMedia = {
+    fileName: string;
+    path: string;
+};
+export type CatalogSong = {
+    album: string;
+    albumId: string;
+    artist: string;
+    coverArt?: string;
+    duration?: number;
+    fileName: string;
+    id: string;
+    path: string;
+    title: string;
+    track: number;
+};
+export type CatalogAlbum = {
+    artist: string;
+    coverArt?: string;
+    id: string;
+    name: string;
+    songs: CatalogSong[];
+};
+export type CatalogArtist = {
+    coverArt?: string;
+    id: string;
+    name: string;
+};
+export type MusicCatalog = {
+    albums: CatalogAlbum[];
+    albumsById: Map<string, CatalogAlbum>;
+    artists: CatalogArtist[];
+    coversById: Map<string, CatalogMedia>;
+    songsById: Map<string, CatalogSong>;
+};
+export declare function emptyMusicCatalog(): MusicCatalog;
+export declare function buildMusicCatalog(beatmapSets: Iterable<CatalogBeatmapSet>, osuDataDir: string): MusicCatalog;

package/dist/core/api/server.d.ts

@@ -0,0 +1,13 @@
+import type { CatalogStore } from "../lazer/library.js";
+export type StartApiServerOptions = {
+    catalogStore: CatalogStore;
+    host?: string;
+    port?: number;
+};
+export type RunningApiServer = {
+    close(): Promise<void>;
+    host: string;
+    port: number;
+    url: string;
+};
+export declare function startApiServer(options: StartApiServerOptions): Promise<RunningApiServer>;

package/dist/core/cli/main.d.ts

@@ -1,19 +1,25 @@
 export declare function getArgs(): {
     [x: string]: unknown;
+    api: boolean;
+    apiPort: number;
     reload: boolean;
     exportPlaylist: string | undefined;
     osuDataDir: string;
     configDir: string | undefined;
     loop: boolean;
+    shuffle: boolean;
     _: (string | number)[];
     $0: string;
 } | Promise<{
     [x: string]: unknown;
+    api: boolean;
+    apiPort: number;
     reload: boolean;
     exportPlaylist: string | undefined;
     osuDataDir: string;
     configDir: string | undefined;
     loop: boolean;
+    shuffle: boolean;
     _: (string | number)[];
     $0: string;
 }>;

package/dist/core/lazer/library.d.ts

@@ -0,0 +1,17 @@
+import { type MusicCatalog } from "../api/catalog.js";
+import { type PlaylistTrack } from "../playlist/mod.js";
+export declare function loadPlaylistFromLazer(osuDataDir: string): Promise<PlaylistTrack[]>;
+export declare function loadMusicCatalogFromLazer(osuDataDir: string): Promise<MusicCatalog>;
+export declare function deleteBeatmapSetFromLazer(track: Pick<PlaylistTrack, "beatmapSetHash" | "beatmapSetId" | "title">, osuDataDir: string): Promise<void>;
+export type CatalogStore = {
+    getCatalog(): MusicCatalog;
+    refreshIfChanged(): Promise<MusicCatalog>;
+};
+type RefreshingCatalogStoreOptions = {
+    getSignature: () => Promise<string>;
+    loadCatalog: () => Promise<MusicCatalog>;
+    onRefreshError?: (error: unknown) => void;
+};
+export declare function createRefreshingCatalogStore(options: RefreshingCatalogStoreOptions): Promise<CatalogStore>;
+export declare function createLazerCatalogStore(osuDataDir: string, onRefreshError?: (error: unknown) => void): Promise<CatalogStore>;
+export {};

package/dist/core/player/session.d.ts

@@ -5,8 +5,10 @@ export declare function findTrackIndicesByQuery(playlist: PlaylistTrack[], query
 type PlaylistPlayerSessionOptions = {
     deleteTrack?: (track: PlaylistTrack) => Promise<void>;
     loop?: boolean;
+    random?: () => number;
     reloadPlaylist?: () => Promise<PlaylistTrack[]>;
     revealTrack?: (track: PlaylistTrack) => Promise<void>;
+    shuffle?: boolean;
 };
 export declare class PlaylistPlayerSession {
     private readonly backend;
@@ -16,10 +18,13 @@ export declare class PlaylistPlayerSession {
     private loop;
     private deleteTrack?;
     private playlist;
+    private readonly random;
     private readonly reloadPlaylist?;
     private readonly revealTrack?;
     private searchQuery;
     private selectedIndex;
+    private shuffle;
+    private shuffleOrder;
     private operationQueue;
     private readonly unsubscribeBackend;
     constructor(playlist: PlaylistTrack[], backend: PlayerBackend, options?: PlaylistPlayerSessionOptions);
@@ -34,8 +39,10 @@ export declare class PlaylistPlayerSession {
     selectEnd(): void;
     setSelectionIndex(index: number): void;
     toggleLoop(): void;
+    toggleShuffle(): void;
     appendSearchQuery(text: string): void;
     deleteSearchCharacter(): void;
+    deleteSearchWord(): void;
     clearSearch(): void;
     playSelected(): Promise<void>;
     playNext(): Promise<void>;
@@ -50,6 +57,7 @@ export declare class PlaylistPlayerSession {
     private emit;
     private playIndex;
     private getAdjacentIndex;
+    private resetShuffleOrder;
     private handleBackendEvent;
     private enqueueOperation;
     private syncSelectionToSearch;

package/dist/core/player/types.d.ts

@@ -40,6 +40,7 @@ export type PlaylistPlayerSnapshot = {
     playlist: PlaylistTrack[];
     searchQuery: string;
     selectedIndex: number;
+    shuffle: boolean;
     status: PlayerBackendStatus;
     timePositionSeconds: number | null;
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "osu-play",
-  "version": "1.3.3",
-  "description": "Play music from your osu!lazer beatmaps from the terminal.",
+  "version": "1.4.0",
+  "description": "Play and stream music from your osu!lazer beatmaps.",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
@@ -75,6 +75,9 @@
     "cli",
     "music",
     "game",
+    "subsonic",
+    "kopuz",
+    "music-server",
     "typescript"
   ],
   "repository": {