osu-stable-db 0.2.3 → 0.2.5

package/dist/index.d.mts

@@ -1,5 +1,69 @@
 import { C as UserPermissionFlags, S as UserPermission, _ as ScoreAdditionalModInfo, a as GameplayMode, b as ScoresDatabase, c as Grades, d as Mod, f as ModFlags, g as RankedStatuses, h as RankedStatus, i as DateTimeTicks, l as IntFloatPair, m as OsuDatabase, n as CollectionDatabase, o as GameplayModes, p as Mods, r as CollectionEntry, s as Grade, t as BeatmapEntry, u as MINIMUM_SUPPORTED_VERSION, v as ScoreEntry, w as UserPermissions, x as TimingPoint, y as ScoresBeatmapEntry } from "./types-DiZMN3fQ.mjs";
 
+//#region src/core/utils.d.ts
+declare const TICKS_PER_MILLISECOND = 10000n;
+declare const UNIX_EPOCH_DATE_TIME_TICKS = 621355968000000000n;
+declare const WINDOWS_FILE_TIME_EPOCH_DATE_TIME_TICKS = 504911232000000000n;
+/**
+ * Converts .NET DateTime ticks to Unix epoch milliseconds.
+ */
+declare function dateTimeTicksToUnixMilliseconds(ticks: DateTimeTicks): bigint;
+/**
+ * Converts Unix epoch milliseconds to .NET DateTime ticks.
+ */
+declare function unixMillisecondsToDateTimeTicks(milliseconds: bigint): DateTimeTicks;
+/**
+ * Converts .NET DateTime ticks to Windows FILETIME ticks.
+ *
+ * scores.db stores replay timestamps as .NET DateTime ticks, while replay
+ * filenames under Data/r use FILETIME ticks starting at 1601-01-01.
+ */
+declare function dateTimeTicksToWindowsFileTimeTicks(ticks: DateTimeTicks): bigint;
+/**
+ * Converts .NET DateTime ticks to a JavaScript Date.
+ *
+ * JavaScript Date has millisecond precision, so sub-millisecond tick precision
+ * is truncated during conversion.
+ */
+declare function dateTimeTicksToDate(ticks: DateTimeTicks): Date;
+/**
+ * Converts a JavaScript Date to .NET DateTime ticks.
+ *
+ * JavaScript Date has millisecond precision, so the resulting tick value will
+ * always have its sub-millisecond portion set to zero.
+ */
+declare function dateToDateTimeTicks(date: Date): DateTimeTicks;
+/**
+ * Tests whether all bits from a mod mask are present in the flags value.
+ */
+declare function hasMod(flags: ModFlags, mod: Mod): boolean;
+/**
+ * Tests whether any bit from a mod mask is present in the flags value.
+ */
+declare function hasAnyMod(flags: ModFlags, modMask: ModFlags): boolean;
+/**
+ * Combines multiple mods into a single bitmask.
+ */
+declare function combineMods(mods: Iterable<Mod>): ModFlags;
+/**
+ * Expands a mod bitmask into its individual mod values.
+ */
+declare function splitMods(flags: ModFlags): Mod[];
+/**
+ * Returns the relative Songs path for a beatmap entry.
+ */
+declare function getBeatmapRelativeOsuFilePath(beatmap: {
+  beatmapFolderName: string | null;
+  osuFileName: string | null;
+}): string;
+/**
+ * Returns the relative replay path for a score entry.
+ */
+declare function getScoreRelativeOsrFilePath(score: {
+  beatmapMd5Hash: string | null;
+  replayTimestamp: DateTimeTicks;
+}): string;
+//#endregion
 //#region src/db/collection.d.ts
 declare function readCollectionDatabase(input: ArrayBuffer | Uint8Array): CollectionDatabase;
 declare function writeCollectionDatabase(database: CollectionDatabase): Uint8Array;
@@ -9,23 +73,25 @@ declare function readOsuDatabase(input: ArrayBuffer | Uint8Array): OsuDatabase;
 declare function writeOsuDatabase(database: OsuDatabase): Uint8Array;
 //#endregion
 //#region src/db/query.d.ts
-interface BeatmapScoresGroupMatch {
-  beatmap: BeatmapEntry;
-  scores: ScoreEntry[];
-}
-interface BeatmapScoreMatch {
-  beatmap: BeatmapEntry;
-  score: ScoreEntry;
-}
 type BeatmapQuerySource = OsuDatabase | BeatmapEntry[];
 type ScoreQuerySource = ScoresDatabase | ScoresBeatmapEntry[];
+type GeneratorYield<TGeneratorFactory extends (...args: never[]) => Generator> = TGeneratorFactory extends ((...args: never[]) => Generator<infer TValue, void, unknown>) ? TValue : never;
 declare function createBeatmapScoreQuery(beatmapsSource: BeatmapQuerySource, scoresSource: ScoreQuerySource): {
-  iterateBeatmapScoreGroups: () => Generator<BeatmapScoresGroupMatch>;
-  iterateBeatmapScores: () => Generator<BeatmapScoreMatch>;
+  iterateBeatmapScoreGroups: () => Generator<{
+    beatmap: BeatmapEntry;
+    scores: ScoreEntry[];
+  }, void, unknown>;
+  iterateBeatmapScores: () => Generator<{
+    beatmap: BeatmapEntry;
+    score: ScoreEntry;
+  }, void, unknown>;
 };
+type BeatmapScoreQuery = ReturnType<typeof createBeatmapScoreQuery>;
+type BeatmapScoresGroupMatch = GeneratorYield<BeatmapScoreQuery['iterateBeatmapScoreGroups']>;
+type BeatmapScoreMatch = GeneratorYield<BeatmapScoreQuery['iterateBeatmapScores']>;
 //#endregion
 //#region src/db/scores.d.ts
 declare function readScoresDatabase(input: ArrayBuffer | Uint8Array): ScoresDatabase;
 declare function writeScoresDatabase(database: ScoresDatabase): Uint8Array;
 //#endregion
-export { BeatmapEntry, BeatmapQuerySource, BeatmapScoreMatch, BeatmapScoresGroupMatch, CollectionDatabase, CollectionEntry, DateTimeTicks, GameplayMode, GameplayModes, Grade, Grades, IntFloatPair, MINIMUM_SUPPORTED_VERSION, Mod, ModFlags, Mods, OsuDatabase, RankedStatus, RankedStatuses, ScoreAdditionalModInfo, ScoreEntry, ScoreQuerySource, ScoresBeatmapEntry, ScoresDatabase, TimingPoint, UserPermission, UserPermissionFlags, UserPermissions, createBeatmapScoreQuery, readCollectionDatabase, readOsuDatabase, readScoresDatabase, writeCollectionDatabase, writeOsuDatabase, writeScoresDatabase };
+export { BeatmapEntry, BeatmapQuerySource, BeatmapScoreMatch, BeatmapScoreQuery, BeatmapScoresGroupMatch, CollectionDatabase, CollectionEntry, DateTimeTicks, GameplayMode, GameplayModes, Grade, Grades, IntFloatPair, MINIMUM_SUPPORTED_VERSION, Mod, ModFlags, Mods, OsuDatabase, RankedStatus, RankedStatuses, ScoreAdditionalModInfo, ScoreEntry, ScoreQuerySource, ScoresBeatmapEntry, ScoresDatabase, TICKS_PER_MILLISECOND, TimingPoint, UNIX_EPOCH_DATE_TIME_TICKS, UserPermission, UserPermissionFlags, UserPermissions, WINDOWS_FILE_TIME_EPOCH_DATE_TIME_TICKS, combineMods, createBeatmapScoreQuery, dateTimeTicksToDate, dateTimeTicksToUnixMilliseconds, dateTimeTicksToWindowsFileTimeTicks, dateToDateTimeTicks, getBeatmapRelativeOsuFilePath, getScoreRelativeOsrFilePath, hasAnyMod, hasMod, readCollectionDatabase, readOsuDatabase, readScoresDatabase, splitMods, unixMillisecondsToDateTimeTicks, writeCollectionDatabase, writeOsuDatabase, writeScoresDatabase };

package/dist/index.mjs

@@ -1,2 +1,2 @@
-import { a as readOsuDatabase, c as writeCollectionDatabase, d as MINIMUM_SUPPORTED_VERSION, f as Mods, i as createBeatmapScoreQuery, l as GameplayModes, m as UserPermissions, n as writeScoresDatabase, o as writeOsuDatabase, p as RankedStatuses, s as readCollectionDatabase, t as readScoresDatabase, u as Grades } from "./scores-CW2CUXZ-.mjs";
-export { GameplayModes, Grades, MINIMUM_SUPPORTED_VERSION, Mods, RankedStatuses, UserPermissions, createBeatmapScoreQuery, readCollectionDatabase, readOsuDatabase, readScoresDatabase, writeCollectionDatabase, writeOsuDatabase, writeScoresDatabase };
+import { C as Grades, D as UserPermissions, E as RankedStatuses, S as GameplayModes, T as Mods, _ as getScoreRelativeOsrFilePath, a as writeOsuDatabase, b as splitMods, c as TICKS_PER_MILLISECOND, d as combineMods, f as dateTimeTicksToDate, g as getBeatmapRelativeOsuFilePath, h as dateToDateTimeTicks, i as readOsuDatabase, l as UNIX_EPOCH_DATE_TIME_TICKS, m as dateTimeTicksToWindowsFileTimeTicks, n as writeScoresDatabase, o as readCollectionDatabase, p as dateTimeTicksToUnixMilliseconds, r as createBeatmapScoreQuery, s as writeCollectionDatabase, t as readScoresDatabase, u as WINDOWS_FILE_TIME_EPOCH_DATE_TIME_TICKS, v as hasAnyMod, w as MINIMUM_SUPPORTED_VERSION, x as unixMillisecondsToDateTimeTicks, y as hasMod } from "./scores-Be-LBsWn.mjs";
+export { GameplayModes, Grades, MINIMUM_SUPPORTED_VERSION, Mods, RankedStatuses, TICKS_PER_MILLISECOND, UNIX_EPOCH_DATE_TIME_TICKS, UserPermissions, WINDOWS_FILE_TIME_EPOCH_DATE_TIME_TICKS, combineMods, createBeatmapScoreQuery, dateTimeTicksToDate, dateTimeTicksToUnixMilliseconds, dateTimeTicksToWindowsFileTimeTicks, dateToDateTimeTicks, getBeatmapRelativeOsuFilePath, getScoreRelativeOsrFilePath, hasAnyMod, hasMod, readCollectionDatabase, readOsuDatabase, readScoresDatabase, splitMods, unixMillisecondsToDateTimeTicks, writeCollectionDatabase, writeOsuDatabase, writeScoresDatabase };

package/dist/node.d.mts

@@ -3,6 +3,7 @@ import { _ as ScoreAdditionalModInfo, a as GameplayMode, b as ScoresDatabase, f
 //#region src/node.d.ts
 type DatabaseFilePath = string | URL;
 declare const OSU_STABLE_DIR_ENV_VAR = "OSU_STABLE_DIR";
+type GeneratorYield<TGeneratorFactory extends (...args: never[]) => Generator> = TGeneratorFactory extends ((...args: never[]) => Generator<infer TValue, void, unknown>) ? TValue : never;
 declare function getConfiguredOsuFolderPath(): string | null;
 declare function getConfiguredOsuFolder(): OsuFolder | null;
 declare function readOsuDatabaseFile(path: DatabaseFilePath): Promise<OsuDatabase>;
@@ -193,5 +194,8 @@ declare class OsuFolder {
   getOsuFilePath(beatmap: BeatmapEntry): string;
   getOsrFilePath(score: ScoreEntry): string;
 }
+type BeatmapScoreQuery = ReturnType<OsuFolder['createBeatmapScoreQuery']>;
+type BeatmapScoresGroupMatch = GeneratorYield<BeatmapScoreQuery['iterateBeatmapScoreGroups']>;
+type BeatmapScoreMatch = GeneratorYield<BeatmapScoreQuery['iterateBeatmapScores']>;
 //#endregion
-export { DatabaseFilePath, OSU_STABLE_DIR_ENV_VAR, OsuFolder, getConfiguredOsuFolder, getConfiguredOsuFolderPath, readCollectionDatabaseFile, readOsuDatabaseFile, readScoresDatabaseFile, writeCollectionDatabaseFile, writeOsuDatabaseFile, writeScoresDatabaseFile };
+export { BeatmapScoreMatch, BeatmapScoreQuery, BeatmapScoresGroupMatch, DatabaseFilePath, OSU_STABLE_DIR_ENV_VAR, OsuFolder, getConfiguredOsuFolder, getConfiguredOsuFolderPath, readCollectionDatabaseFile, readOsuDatabaseFile, readScoresDatabaseFile, writeCollectionDatabaseFile, writeOsuDatabaseFile, writeScoresDatabaseFile };

package/dist/node.mjs

@@ -1,4 +1,4 @@
-import { a as readOsuDatabase, c as writeCollectionDatabase, i as createBeatmapScoreQuery, n as writeScoresDatabase, o as writeOsuDatabase, r as dateTimeTicksToWindowsFileTimeTicks, s as readCollectionDatabase, t as readScoresDatabase } from "./scores-CW2CUXZ-.mjs";
+import { _ as getScoreRelativeOsrFilePath, a as writeOsuDatabase, g as getBeatmapRelativeOsuFilePath, i as readOsuDatabase, n as writeScoresDatabase, o as readCollectionDatabase, r as createBeatmapScoreQuery, s as writeCollectionDatabase, t as readScoresDatabase } from "./scores-Be-LBsWn.mjs";
 import { readFile, writeFile } from "node:fs/promises";
 import { join } from "node:path";
 //#region src/node.ts
@@ -91,12 +91,10 @@ var OsuFolder = class {
 		};
 	}
 	getOsuFilePath(beatmap) {
-		if (beatmap.beatmapFolderName === null || beatmap.osuFileName === null) throw new Error("Beatmap entry is missing beatmapFolderName or osuFileName");
-		return join(this.folderPath, "Songs", beatmap.beatmapFolderName, beatmap.osuFileName);
+		return join(this.folderPath, getBeatmapRelativeOsuFilePath(beatmap));
 	}
 	getOsrFilePath(score) {
-		if (score.beatmapMd5Hash === null) throw new Error("Score entry is missing beatmapMd5Hash");
-		return join(this.folderPath, "Data", "r", `${score.beatmapMd5Hash}-${dateTimeTicksToWindowsFileTimeTicks(score.replayTimestamp)}.osr`);
+		return join(this.folderPath, getScoreRelativeOsrFilePath(score));
 	}
 };
 //#endregion

package/dist/{scores-CW2CUXZ-.mjs → scores-Be-LBsWn.mjs}

@@ -98,6 +98,93 @@ const Mods = {
 	Mirror: 1073741824
 };
 //#endregion
+//#region src/core/utils.ts
+const TICKS_PER_MILLISECOND = 10000n;
+const UNIX_EPOCH_DATE_TIME_TICKS = 621355968000000000n;
+const WINDOWS_FILE_TIME_EPOCH_DATE_TIME_TICKS = 504911232000000000n;
+const orderedMods = Object.values(Mods).filter((value) => value !== Mods.None);
+/**
+* Converts .NET DateTime ticks to Unix epoch milliseconds.
+*/
+function dateTimeTicksToUnixMilliseconds(ticks) {
+	return (ticks - UNIX_EPOCH_DATE_TIME_TICKS) / TICKS_PER_MILLISECOND;
+}
+/**
+* Converts Unix epoch milliseconds to .NET DateTime ticks.
+*/
+function unixMillisecondsToDateTimeTicks(milliseconds) {
+	return milliseconds * TICKS_PER_MILLISECOND + UNIX_EPOCH_DATE_TIME_TICKS;
+}
+/**
+* Converts .NET DateTime ticks to Windows FILETIME ticks.
+*
+* scores.db stores replay timestamps as .NET DateTime ticks, while replay
+* filenames under Data/r use FILETIME ticks starting at 1601-01-01.
+*/
+function dateTimeTicksToWindowsFileTimeTicks(ticks) {
+	return ticks - WINDOWS_FILE_TIME_EPOCH_DATE_TIME_TICKS;
+}
+/**
+* Converts .NET DateTime ticks to a JavaScript Date.
+*
+* JavaScript Date has millisecond precision, so sub-millisecond tick precision
+* is truncated during conversion.
+*/
+function dateTimeTicksToDate(ticks) {
+	return new Date(Number(dateTimeTicksToUnixMilliseconds(ticks)));
+}
+/**
+* Converts a JavaScript Date to .NET DateTime ticks.
+*
+* JavaScript Date has millisecond precision, so the resulting tick value will
+* always have its sub-millisecond portion set to zero.
+*/
+function dateToDateTimeTicks(date) {
+	return unixMillisecondsToDateTimeTicks(BigInt(date.getTime()));
+}
+/**
+* Tests whether all bits from a mod mask are present in the flags value.
+*/
+function hasMod(flags, mod) {
+	return (flags & mod) === mod;
+}
+/**
+* Tests whether any bit from a mod mask is present in the flags value.
+*/
+function hasAnyMod(flags, modMask) {
+	return (flags & modMask) !== 0;
+}
+/**
+* Combines multiple mods into a single bitmask.
+*/
+function combineMods(mods) {
+	let flags = Mods.None;
+	for (const mod of mods) flags |= mod;
+	return flags;
+}
+/**
+* Expands a mod bitmask into its individual mod values.
+*/
+function splitMods(flags) {
+	const result = [];
+	for (const mod of orderedMods) if (hasMod(flags, mod)) result.push(mod);
+	return result;
+}
+/**
+* Returns the relative Songs path for a beatmap entry.
+*/
+function getBeatmapRelativeOsuFilePath(beatmap) {
+	if (beatmap.beatmapFolderName === null || beatmap.osuFileName === null) throw new Error("Beatmap entry is missing beatmapFolderName or osuFileName");
+	return `Songs/${beatmap.beatmapFolderName}/${beatmap.osuFileName}`;
+}
+/**
+* Returns the relative replay path for a score entry.
+*/
+function getScoreRelativeOsrFilePath(score) {
+	if (score.beatmapMd5Hash === null) throw new Error("Score entry is missing beatmapMd5Hash");
+	return `Data/r/${score.beatmapMd5Hash}-${dateTimeTicksToWindowsFileTimeTicks(score.replayTimestamp)}.osr`;
+}
+//#endregion
 //#region src/core/binary.ts
 var BinaryReader$1 = class extends BinaryReader {
 	readDateTimeTicks() {
@@ -387,25 +474,6 @@ function createBeatmapScoreQuery(beatmapsSource, scoresSource) {
 	};
 }
 //#endregion
-//#region src/core/utils.ts
-const WINDOWS_FILE_TIME_EPOCH_DATE_TIME_TICKS = 504911232000000000n;
-Object.values(Mods).filter((value) => value !== Mods.None);
-/**
-* Converts .NET DateTime ticks to Windows FILETIME ticks.
-*
-* scores.db stores replay timestamps as .NET DateTime ticks, while replay
-* filenames under Data/r use FILETIME ticks starting at 1601-01-01.
-*/
-function dateTimeTicksToWindowsFileTimeTicks(ticks) {
-	return ticks - WINDOWS_FILE_TIME_EPOCH_DATE_TIME_TICKS;
-}
-/**
-* Tests whether all bits from a mod mask are present in the flags value.
-*/
-function hasMod(flags, mod) {
-	return (flags & mod) === mod;
-}
-//#endregion
 //#region src/db/scores.ts
 function readScoreAdditionalModInfo(reader) {
 	return { targetPracticeAccuracy: reader.readDouble() };
@@ -512,4 +580,4 @@ function writeScoresDatabase(database) {
 	return writer.toUint8Array();
 }
 //#endregion
-export { readOsuDatabase as a, writeCollectionDatabase as c, MINIMUM_SUPPORTED_VERSION as d, Mods as f, createBeatmapScoreQuery as i, GameplayModes as l, UserPermissions as m, writeScoresDatabase as n, writeOsuDatabase as o, RankedStatuses as p, dateTimeTicksToWindowsFileTimeTicks as r, readCollectionDatabase as s, readScoresDatabase as t, Grades as u };
+export { Grades as C, UserPermissions as D, RankedStatuses as E, GameplayModes as S, Mods as T, getScoreRelativeOsrFilePath as _, writeOsuDatabase as a, splitMods as b, TICKS_PER_MILLISECOND as c, combineMods as d, dateTimeTicksToDate as f, getBeatmapRelativeOsuFilePath as g, dateToDateTimeTicks as h, readOsuDatabase as i, UNIX_EPOCH_DATE_TIME_TICKS as l, dateTimeTicksToWindowsFileTimeTicks as m, writeScoresDatabase as n, readCollectionDatabase as o, dateTimeTicksToUnixMilliseconds as p, createBeatmapScoreQuery as r, writeCollectionDatabase as s, readScoresDatabase as t, WINDOWS_FILE_TIME_EPOCH_DATE_TIME_TICKS as u, hasAnyMod as v, MINIMUM_SUPPORTED_VERSION as w, unixMillisecondsToDateTimeTicks as x, hasMod as y };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "osu-stable-db",
   "type": "module",
-  "version": "0.2.3",
+  "version": "0.2.5",
   "description": "TypeScript reader and writer for osu!stable database files.",
   "author": "zzzzv",
   "license": "MIT",