osu-play 1.0.7 → 1.2.0

package/package.json

@@ -1,44 +1,73 @@
 {
   "name": "osu-play",
-  "version": "1.0.7",
+  "version": "1.2.0",
   "description": "Play music from your osu!lazer beatmaps from the terminal.",
   "type": "module",
-  "main": "bin/osu-play.js",
-  "module": "index.ts",
-  "types": "dist/index.d.ts",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      },
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
   "files": [
-    "bin",
     "dist",
-    "src",
-    "index.ts",
-    "package.json",
     "README.md",
-    "tsconfig.json",
     "LICENSE"
   ],
   "bin": {
-    "osu-play": "./bin/osu-play.js"
+    "osu-play": "./dist/cli.cjs"
+  },
+  "sideEffects": false,
+  "packageManager": "bun@1.3.5",
+  "engines": {
+    "node": ">=20"
+  },
+  "trustedDependencies": [
+    "realm"
+  ],
+  "publishConfig": {
+    "access": "public"
   },
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "build": "tsup",
-    "start": "./bin/osu-play.js",
-    "dev:start": "tsc && ./bin/osu-play.js",
-    "clean": "rm -rf dist"
+    "setup": "bun install && bun run repair:realm",
+    "build": "bun run scripts/build.mjs",
+    "dev": "bun run build && node dist/cli.cjs",
+    "repair:realm": "bun run scripts/repair-realm.mjs",
+    "test": "bun run build && bun test",
+    "typecheck": "bun x tsc --project tsconfig.json --noEmit",
+    "lint": "eslint --config eslint.config.mjs src scripts test",
+    "package": "bun run build && bun pm pack --quiet",
+    "check": "bun run typecheck && bun run lint && bun run test && bun pm pack --dry-run && bun run scripts/run-with-local-tmp.mjs bun x publint && bun run scripts/run-with-local-tmp.mjs bun x attw --pack .",
+    "prepublishOnly": "bun run check"
   },
   "author": "KorigamiK",
   "license": "MIT",
   "devDependencies": {
-    "@types/node": "^20.8.9",
-    "@types/prompts": "^2.4.7",
-    "tsup": "^8.0.2",
-    "typescript": "^5.2.2"
+    "@arethetypeswrong/cli": "^0.18.2",
+    "@eslint/js": "^10.0.1",
+    "@types/node": "^25.5.0",
+    "@types/yargs": "^17.0.35",
+    "eslint": "^10.0.3",
+    "globals": "^17.4.0",
+    "publint": "^0.3.18",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.57.0"
   },
   "dependencies": {
-    "@types/yargs": "^17.0.32",
-    "prompts": "^2.4.2",
-    "realm": "^12.2.1",
-    "yargs": "^17.7.2"
+    "@mariozechner/pi-tui": "^0.58.4",
+    "realm": "^20.2.0",
+    "yargs": "^18.0.0"
   },
   "keywords": [
     "osu",
@@ -50,7 +79,7 @@
   ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/KorigamiK/osu-play"
+    "url": "git+https://github.com/KorigamiK/osu-play.git"
   },
   "bugs": "https://github.com/KorigamiK/osu-play/issues"
-}
+}

package/bin/osu-play.js

@@ -1,7 +0,0 @@
-#!/usr/bin/env node
-
-import { main } from "../dist/src/cli/main.js";
-
-await main();
-
-process.exit(0); // Realm doesn't exit on its own, see: realm-js#4535

package/index.ts

@@ -1 +0,0 @@
-export * from "./src/mod.js";

package/src/cli/main.ts

@@ -1,156 +0,0 @@
-import path from "node:path";
-import { existsSync, writeFileSync } from "node:fs";
-
-import Realm from "realm";
-import prompts from "prompts";
-import { BeatmapSet } from "../realm/schema/mod.js";
-import { getConfigDir, getDataDir, getRealmDBPath } from "../utils/mod.js";
-import { getLazerDB, getNamedFileHash, hashedFilePath } from "../realm/mod.js";
-
-import yargs from "yargs/yargs";
-import { hideBin } from "yargs/helpers";
-import util from "node:util";
-import { execFile } from "node:child_process";
-
-const execFilePromise = util.promisify(execFile);
-
-export function getArgs() {
-  const argv = yargs(hideBin(process.argv))
-    .usage("Play music from your osu!lazer beatmaps from the terminal\nUsage: $0 [options]")
-    .options({
-      reload: {
-        type: "boolean",
-        default: false,
-        alias: "r",
-        describe: "Reload lazer database",
-      },
-      exportPlaylist: {
-        type: "string",
-        describe: "Export playlist to a file",
-      },
-      osuDataDir: {
-        type: "string",
-        default: path.join(getDataDir() || ".", "osu"),
-        alias: "d",
-        describe: "Osu!lazer data directory",
-      },
-      configDir: {
-        type: "string",
-        default: path.join(getConfigDir() || ".", "osu-play"),
-        alias: "c",
-        describe: "Config directory",
-      },
-      loop: {
-        type: "boolean",
-        default: false,
-        alias: "l",
-        describe: "Loop the playlist on end",
-      },
-      help: {
-        type: "boolean",
-        alias: "h",
-        describe: "Show help",
-      }
-    }).argv;
-  return argv;
-}
-
-export async function main() {
-  const argv = await getArgs();
-  console.log("[INFO] osu!play");
-
-  let reload = false;
-  let osuDataDir = argv.osuDataDir;
-
-  if (argv.reload) {
-    console.log("[INFO] Reloading lazer database");
-    reload = true;
-  }
-
-  if (argv.osuDataDir !== getDataDir()) {
-    console.log(`[INFO] Using osu!lazer data directory: ${ argv.osuDataDir }`);
-  }
-
-  const realmDBPath = getRealmDBPath(argv.configDir, { reload, osuDataDir });
-
-  if (realmDBPath == null) {
-    console.log("[ERROR] Realm DB not found");
-    process.exit(1);
-  }
-
-  const currentSchema = Realm.schemaVersion(realmDBPath);
-  console.log(`currentSchema: ${ currentSchema }`);
-
-  Realm.flags.ALLOW_CLEAR_TEST_STATE = true;
-
-  const realm: Realm = await getLazerDB(realmDBPath);
-
-  const beatmapSets = realm.objects(BeatmapSet);
-
-  const songSet = new Set<string>();
-  const uniqueBeatmaps: {
-    title: string;
-    path: string | null;
-  }[] = [];
-
-  for (const beatmapSet of beatmapSets) {
-    for (const beatmap of beatmapSet.Beatmaps) {
-      const fileName = beatmap.Metadata.AudioFile;
-      const hash = getNamedFileHash(fileName ?? "", beatmapSet);
-      if (!hash) continue;
-      if (songSet.has(hash)) continue;
-      songSet.add(hash);
-      const meta = beatmap.Metadata;
-      const path = hashedFilePath(hash);
-      const title = `${ meta.Title } : ${ meta.Artist } - ${ meta.TitleUnicode } : ${ meta.ArtistUnicode }`;
-      uniqueBeatmaps.push({ title, path });
-    }
-  }
-
-  console.log(`beatmap songs: ${ beatmapSets.length }`);
-
-  if (argv.exportPlaylist) {
-    console.log(`[INFO] Exporting playlist to ${ argv.exportPlaylist }`);
-    const playlist = uniqueBeatmaps.map((mp) => mp.path).join("\n");
-    writeFileSync(argv.exportPlaylist, playlist);
-    console.log(`[INFO] Done. Use something like \`mpv --playlist=${ argv.exportPlaylist }\` to play the playlist`);
-    return;
-  }
-
-  let selectedBeatmap: number = (
-    await prompts({
-      type: "autocomplete",
-      name: "beatmap",
-      message: "Which map do you want to play:",
-      choices: uniqueBeatmaps.map((mp, index) => ({
-        title: mp.title,
-        value: index,
-      })),
-    })
-  ).beatmap;
-  console.log(`Selected: ${ selectedBeatmap }`);
-
-  let i = selectedBeatmap
-
-  for (; i < uniqueBeatmaps.length; ++i) {
-    const beatmap = uniqueBeatmaps[i];
-    console.log(`Map : ${ beatmap.title }`);
-    if (beatmap.path && existsSync(beatmap.path)) {
-      console.log(`Playing ${ beatmap.title }`);
-      await execFilePromise('exo-open', [beatmap.path]);
-    } else {
-      console.log(`File does not exist: ${ beatmap.path }`);
-    }
-    if (i < uniqueBeatmaps.length - 1) {
-      // Wait 1 second between
-      await new Promise((resolve) => setTimeout(resolve, 1000));
-    } else if (argv.loop) {
-      console.log('[INFO] Looping playlist');
-      i = 0;
-    } else {
-      console.log('[INFO] Done. Use --loop to loop the playlist');
-    }
-  }
-
-  realm.close();
-}

package/src/mod.ts

@@ -1,2 +0,0 @@
-export * as utils from "./utils/mod.js";
-export * as lazer from "./realm/mod.js";

package/src/realm/mod.ts

@@ -1,54 +0,0 @@
-import Realm from "realm";
-import path from "node:path";
-import { getDataDir } from "../utils/mod.js";
-import {
-  Beatmap,
-  BeatmapMetadata,
-  BeatmapSet,
-  RealmFile,
-  RealmNamedFileUsage,
-  RealmUser,
-} from "./schema/mod.js";
-
-export const getLazerDB = async (realmDBPath: string) => {
-  const realm = await Realm.open({
-    schema: [
-      BeatmapSet,
-      RealmFile,
-      RealmNamedFileUsage,
-      Beatmap,
-      BeatmapMetadata,
-      RealmUser,
-    ],
-    path: realmDBPath,
-    schemaVersion: 41,
-    onMigration: (oldRealm, newRealm) => {
-      console.log(
-        `[onMigration]: Migrating ${oldRealm.path} - ${oldRealm.schemaVersion} -> ${newRealm.path} - ${newRealm.schemaVersion}`,
-      );
-    },
-  });
-
-  return realm;
-};
-
-export const hashedFilePath = (hash: string) => {
-  const dataDir = getDataDir();
-  if (!dataDir) return null;
-  return path.join(
-    dataDir,
-    "osu",
-    "files",
-    hash.slice(0, 1),
-    hash.slice(0, 2),
-    hash,
-  );
-};
-
-export const getNamedFileHash = (fileName: string, beatmapSet: BeatmapSet) => {
-  const files = beatmapSet.Files;
-  for (const file of files) {
-    if (file.Filename == fileName) return file.File.Hash;
-  }
-  return undefined;
-};

package/src/realm/schema/beatmap.ts

@@ -1,85 +0,0 @@
-import Realm from "realm";
-import type { ObjectSchema } from "realm";
-import { BeatmapMetadata } from "./beatmapMetadata.js";
-
-export class Beatmap extends Realm.Object<Beatmap> {
-  ID!: string;
-  DifficultyName?: string;
-  Ruleset!: any;
-  Difficulty!: any;
-  Metadata!: BeatmapMetadata;
-  UserSettings!: any;
-  BeatmapSet!: any;
-  Status!: number;
-  OnlineID!: number;
-  Length!: number;
-  BPM!: number;
-  Hash?: string;
-  StarRating!: number;
-  MD5Hash?: string;
-  OnlineMD5Hash?: string;
-  LastLocalUpdate?: Date;
-  LastOnlineUpdate?: Date;
-  Hidden!: boolean;
-  AudioLeadIn!: number;
-  StackLeniency!: number;
-  SpecialStyle!: boolean;
-  LetterboxInBreaks!: boolean;
-  WidescreenStoryboard!: boolean;
-  EpilepsyWarning!: boolean;
-  SamplesMatchPlaybackRate!: boolean;
-  LastPlayed?: Date;
-  DistanceSpacing!: number;
-  BeatDivisor!: number;
-  GridSize!: number;
-  TimelineZoom!: number;
-  EditorTimestamp?: number;
-  CountdownOffset!: number;
-
-  static schema: ObjectSchema = {
-    name: "Beatmap",
-    primaryKey: "ID",
-    properties: {
-      ID: { type: "uuid", default: "" },
-      DifficultyName: { type: "string", default: "", optional: true },
-      // Ruleset: { type: "object", objectType: "Ruleset", default: null },
-      // Difficulty: { type: "object", objectType: "BeatmapDifficulty", default: null },
-      Metadata: {
-        type: "object",
-        objectType: "BeatmapMetadata",
-        default: null,
-      },
-      // UserSettings: { type: "object", objectType: "BeatmapUserSettings", default: null },
-      BeatmapSet: { type: "object", objectType: "BeatmapSet", default: null },
-      Status: { type: "int", default: -3 },
-      OnlineID: { type: "int", default: -1 },
-      Length: { type: "double", default: 0 },
-      BPM: { type: "double", default: 0 },
-      Hash: { type: "string", default: "", optional: true },
-      StarRating: { type: "double", default: -1 },
-      MD5Hash: { type: "string", default: "", optional: true },
-      OnlineMD5Hash: {
-        type: "string",
-        default: "",
-        optional: true,
-      },
-      LastLocalUpdate: { type: "date", optional: true },
-      LastOnlineUpdate: { type: "date", optional: true },
-      Hidden: { type: "bool", default: false },
-      AudioLeadIn: { type: "double", default: 0 },
-      StackLeniency: { type: "float", default: 0.7 },
-      SpecialStyle: { type: "bool", default: false },
-      LetterboxInBreaks: { type: "bool", default: false },
-      WidescreenStoryboard: { type: "bool", default: false },
-      EpilepsyWarning: { type: "bool", default: false },
-      SamplesMatchPlaybackRate: { type: "bool", default: false },
-      LastPlayed: { type: "date", optional: true },
-      DistanceSpacing: { type: "double", default: 0 },
-      BeatDivisor: { type: "int", default: 0 },
-      GridSize: { type: "int", default: 0 },
-      TimelineZoom: { type: "double", default: 0 },
-      EditorTimestamp: { type: "double", optional: true },
-      CountdownOffset: { type: "int", default: 0 },
-    },
-  };
-}

package/src/realm/schema/beatmapMetadata.ts

@@ -1,33 +0,0 @@
-import Realm from "realm";
-import type { ObjectSchema } from "realm";
-import { RealmUser } from "./realmUser.js";
-
-export class BeatmapMetadata extends Realm.Object<BeatmapMetadata> {
-  Title?: string;
-  TitleUnicode?: string;
-  Artist?: string;
-  ArtistUnicode?: string;
-  Author?: RealmUser;
-  Source?: string;
-  Tags?: string;
-  PreviewTime?: number;
-  AudioFile?: string;
-  BackgroundFile?: string;
-
-  static schema: ObjectSchema = {
-    name: "BeatmapMetadata",
-    properties: {
-      Title: { type: "string", default: "", optional: true },
-      TitleUnicode: { type: "string", default: "", optional: true },
-      Artist: { type: "string", default: "", optional: true },
-      ArtistUnicode: { type: "string", default: "", optional: true },
-      Author: { type: "object", objectType: "RealmUser", default: null },
-      Source: { type: "string", default: "", optional: true },
-      Tags: { type: "string", default: "", optional: true },
-      PreviewTime: { type: "int", default: 0 },
-      AudioFile: { type: "string", default: "", optional: true },
-      BackgroundFile: { type: "string", default: "", optional: true },
-    },
-  };
-}
-

package/src/realm/schema/beatmapSet.ts

@@ -1,36 +0,0 @@
-import Realm from "realm";
-import type { ObjectSchema } from "realm";
-import { Beatmap } from "./beatmap.js";
-import { RealmNamedFileUsage } from "./realmNamedFileUsage.js";
-
-export class BeatmapSet extends Realm.Object<BeatmapSet> {
-  ID!: string;
-  OnlineID!: number;
-  DateAdded!: Date;
-  DateSubmitted?: Date;
-  DateRanked?: Date;
-  Beatmaps!: Array<Beatmap>;
-  Files!: Array<RealmNamedFileUsage>;
-  Status!: number;
-  DeletePending!: boolean;
-  Hash?: string;
-  Protected!: boolean;
-
-  static schema: ObjectSchema = {
-    name: "BeatmapSet",
-    primaryKey: "ID",
-    properties: {
-      ID: { type: "uuid", default: "" },
-      OnlineID: { type: "int", default: -1 },
-      DateAdded: { type: "date" },
-      DateSubmitted: { type: "date", optional: true },
-      DateRanked: { type: "date", optional: true },
-      Beatmaps: { type: "list", objectType: "Beatmap", default: [] },
-      Files: { type: "list", objectType: "RealmNamedFileUsage", default: [] },
-      Status: { type: "int", default: -3 },
-      DeletePending: { type: "bool", default: false },
-      Hash: { type: "string", default: "", optional: true },
-      Protected: { type: "bool", default: false },
-    },
-  };
-}

package/src/realm/schema/realmFile.ts

@@ -1,15 +0,0 @@
-import Realm from "realm";
-import type { ObjectSchema } from "realm";
-
-export class RealmFile extends Realm.Object<RealmFile> {
-  Hash?: string;
-
-  static schema: ObjectSchema = {
-    name: "File",
-    primaryKey: "Hash",
-    properties: {
-      Hash: { type: "string", default: "", optional: true },
-    },
-  };
-}
-

package/src/realm/schema/realmNamedFileUsage.ts

@@ -1,19 +0,0 @@
-import Realm from "realm";
-import type { ObjectSchema } from "realm";
-import { RealmFile } from "./realmFile.js";
-
-export class RealmNamedFileUsage extends Realm.Object<RealmNamedFileUsage> {
-  File!: RealmFile;
-  Filename?: string;
-
-  static embedded = true;
-
-  static schema: ObjectSchema = {
-    name: "RealmNamedFileUsage",
-    embedded: true,
-    properties: {
-      File: "File",
-      Filename: { type: "string", optional: true },
-    },
-  };
-}

package/src/realm/schema/realmUser.ts

@@ -1,21 +0,0 @@
-import Realm from "realm";
-import type { ObjectSchema } from "realm";
-
-export class RealmUser extends Realm.Object<RealmUser> {
-  OnlineID!: number;
-  Username?: string;
-  CountryCode?: string;
-
-  static embedded = true;
-
-  static schema: ObjectSchema = {
-    name: "RealmUser",
-    embedded: true,
-    properties: {
-      OnlineID: { type: "int", default: 1 },
-      Username: { type: "string", default: "", optional: true },
-      CountryCode: { type: "string", optional: true },
-    },
-  };
-}
-

package/src/utils/mod.ts

@@ -1,77 +0,0 @@
-import path from "node:path";
-import { copyFileSync, existsSync, mkdirSync } from "node:fs";
-
-export function getDataDir(): string | undefined {
-  switch (process.platform) {
-    case "linux":
-    case "openbsd":
-    case "freebsd": {
-      const xdg = process.env["XDG_DATA_HOME"];
-      if (xdg) return xdg;
-      const home = process.env["HOME"];
-      if (home) return path.join(home, ".local", "share");
-      break;
-    }
-
-    case "darwin": {
-      const home = process.env["HOME"];
-      if (home) return path.join(home, "Library", "Application Support");
-      break;
-    }
-
-    case "win32":
-      return process.env["LOCALAPPDATA"] ?? undefined;
-  }
-
-  return undefined;
-}
-
-export function getConfigDir(): string | undefined {
-  switch (process.platform) {
-    case "openbsd":
-    case "freebsd":
-    case "linux": {
-      const xdg = process.env["XDG_CONFIG_HOME"];
-      if (xdg) return xdg;
-      const home = process.env["HOME"];
-      if (home) return path.join(home, ".config");
-      break;
-    }
-
-    case "darwin": {
-      const home = process.env["HOME"];
-      if (home) return path.join(home, "Library", "Preferences");
-      break;
-    }
-
-    case "win32":
-      return process.env["APPDATA"] ?? undefined;
-  }
-
-  return undefined;
-}
-
-/**
- * Get Realm for the app, import to the config if it doesn't exist
- */
-export function getRealmDBPath(
-  appConfigDir: string,
-  options: {
-    osuDataDir: string;
-    reload: boolean;
-  } = { reload: false, osuDataDir: getDataDir() || "." },
-) {
-  const localDBPath = path.join(appConfigDir, "client.realm");
-  if (!options.reload && existsSync(localDBPath)) return localDBPath;
-
-  const osuDBPath = path.join(options.osuDataDir, "client.realm");
-  if (existsSync(osuDBPath)) {
-    console.log( `[getRealmDBPath]: ${osuDBPath} is being imported from osu!lazer to ${localDBPath}`);
-    mkdirSync(appConfigDir, { recursive: true });
-    copyFileSync(osuDBPath, localDBPath );
-    return localDBPath;
-  } else {
-    console.log(`[getRealmDBPath]: ${osuDBPath} not found`);
-    return null;
-  }
-}