@rel-packages/osu-beatmap-parser 1.0.6 → 1.1.2

package/README.md

@@ -1,21 +1,11 @@
 ## osu-beatmap-parser
-
-.osu parser for nodejs used by [osu-stuff](https://github.com/mezleca/osu-stuff)
+native .osu beatmap parser used on [osu-stuff](https://github.com/mezleca/osu-stuff)
 
 ## installation
 
 ```bash
-npm install osu-beatmap-parser
-```
-
-## development
-
-```bash
-npm install
-npm run compile
+npm install @rel-packages/osu-beatmap-parser
 ```
 
-## TODO
-- [ ] native: handle "Storyboard" key
-- [ ] native: handle beatmap file version
-- [ ] native: handle lazer files (like, if we're trying to get AudioLocation from a lazer file, we will need to follow the hashed lazer path)
+## usage
+check [examples](https://github.com/mezleca/osu-beatmap-parser/tree/main/examples) for wasm / nodejs usage examples.

package/dist/index.d.ts

@@ -1,4 +1,7 @@
-import { OsuKey, OsuInput } from "./types";
+import { OsuKey, OsuInput, OsuFileFormat } from "./types/types";
 export declare const get_property: (data: Uint8Array, key: OsuKey) => string;
 export declare const get_properties: (input: Uint8Array | OsuInput, keys: OsuKey[]) => Record<string, string>;
-export { OsuKey, OsuInput };
+export declare const get_section: (data: Uint8Array, section: string) => string[];
+export declare const parse: (input: Uint8Array | OsuInput) => OsuFileFormat;
+export type { OsuKey, OsuInput, OsuFileFormat };
+export * from "./types/types";

package/dist/index.js

@@ -1,6 +1,20 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.get_properties = exports.get_property = void 0;
+exports.parse = exports.get_section = exports.get_properties = exports.get_property = void 0;
 const bindings_1 = require("./lib/bindings");
 const get_property = (data, key) => {
     return bindings_1.native.get_property(data, key);
@@ -15,3 +29,13 @@ const get_properties = (input, keys) => {
     return result;
 };
 exports.get_properties = get_properties;
+const get_section = (data, section) => {
+    return bindings_1.native.get_section(data, section);
+};
+exports.get_section = get_section;
+const parse = (input) => {
+    const data = input instanceof Uint8Array ? input : input.data;
+    return bindings_1.native.parse(data);
+};
+exports.parse = parse;
+__exportStar(require("./types/types"), exports);

package/dist/lib/bindings.d.ts

@@ -1 +1,3 @@
-export declare const native: any;
+import { INativeExporter } from "../types/types";
+declare const native: INativeExporter;
+export { native };

package/dist/lib/bindings.js

@@ -1,45 +1,10 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.native = void 0;
-const DEBUG = typeof process != "undefined" && process.env?.OSU_PARSER_DEBUG == "1";
-const log_debug = (...args) => {
-    if (DEBUG) {
-        console.log("[osu-beatmap-parser]", ...args);
-    }
-};
-const load_native_module = () => {
-    const fs = require("fs");
-    const path = require("path");
-    const platform = process.platform;
-    const arch = process.arch;
-    log_debug(`loading native module for ${platform}-${arch}`);
-    log_debug(`__dirname: ${__dirname}`);
-    const paths = [
-        // prebuilt binaries
-        path.join(__dirname, "..", "..", "prebuilds", `${platform}-${arch}`, "osu-beatmap-parser.node"),
-        path.join(__dirname, "..", "prebuilds", `${platform}-${arch}`, "osu-beatmap-parser.node"),
-        // local dev builds
-        path.join(__dirname, "..", "..", "build", "osu-beatmap-parser.node"),
-        path.join(__dirname, "..", "..", "build", "Release", "osu-beatmap-parser.node"),
-        path.join(__dirname, "..", "build", "osu-beatmap-parser.node"),
-        path.join(__dirname, "build", "osu-beatmap-parser.node"),
-    ];
-    for (const p of paths) {
-        const resolved = path.resolve(p);
-        const exists = fs.existsSync(resolved);
-        log_debug(`checking: ${resolved} -> ${exists ? "found" : "not found"}`);
-        if (exists) {
-            log_debug(`loading native module from: ${resolved}`);
-            return require(resolved);
-        }
-    }
-    log_debug("no native module found in any path");
-    return null;
-};
-exports.native = load_native_module();
-if (exports.native == null) {
-    const platform = process.platform;
-    const arch = process.arch;
-    throw new Error(`failed to load native module for ${platform}-${arch}. ` +
-        `Set OSU_PARSER_DEBUG=1 for more info.`);
-}
+const node_gyp_build_1 = __importDefault(require("node-gyp-build"));
+const path_1 = __importDefault(require("path"));
+const native = (0, node_gyp_build_1.default)(path_1.default.join(__dirname, "..", ".."));
+exports.native = native;

package/dist/lib/wasm-wrapper.d.ts

@@ -1,3 +1,6 @@
+import type { OsuFileFormat } from "../types/types";
 export declare const init_wasm: () => Promise<void>;
 export declare const get_property: (data: Uint8Array, key: string) => string;
 export declare const get_properties: (data: Uint8Array, keys: string[]) => Record<string, string>;
+export declare const get_section: (data: Uint8Array, section: string) => string[];
+export declare const parse: (data: Uint8Array) => OsuFileFormat;

package/dist/lib/wasm-wrapper.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.get_properties = exports.get_property = exports.init_wasm = void 0;
+exports.parse = exports.get_section = exports.get_properties = exports.get_property = exports.init_wasm = void 0;
 console.log("[parser] wrapper loaded");
 let wasm_instance = null;
 let init_promise = null;
@@ -54,11 +54,39 @@ const get_properties = (data, keys) => {
     }
 };
 exports.get_properties = get_properties;
+const get_section = (data, section) => {
+    if (wasm_instance == null)
+        throw new Error("wasm not initialized");
+    const buffer_ptr = wasm_instance._malloc(data.length);
+    wasm_instance.HEAPU8.set(data, buffer_ptr);
+    try {
+        return wasm_instance.get_section(buffer_ptr, data.length, section);
+    }
+    finally {
+        wasm_instance._free(buffer_ptr);
+    }
+};
+exports.get_section = get_section;
+const parse = (data) => {
+    if (wasm_instance == null)
+        throw new Error("wasm not initialized");
+    const buffer_ptr = wasm_instance._malloc(data.length);
+    wasm_instance.HEAPU8.set(data, buffer_ptr);
+    try {
+        return wasm_instance.parse(buffer_ptr, data.length);
+    }
+    finally {
+        wasm_instance._free(buffer_ptr);
+    }
+};
+exports.parse = parse;
 if (typeof window != "undefined") {
     window.beatmap_parser = {
         init_wasm: exports.init_wasm,
         get_property: exports.get_property,
         get_properties: exports.get_properties,
+        get_section: exports.get_section,
+        parse: exports.parse,
     };
     console.log(window.beatmap_parser);
     console.log("[parser] attached to window");

package/dist/types/types.d.ts

@@ -0,0 +1,135 @@
+export type OsuKey = "AudioFilename" | "AudioLeadIn" | "AudioHash" | "PreviewTime" | "Countdown" | "SampleSet" | "StackLeniency" | "Mode" | "LetterboxInBreaks" | "StoryFireInFront" | "UseSkinSprites" | "AlwaysShowPlayfield" | "OverlayPosition" | "SkinPreference" | "EpilepsyWarning" | "CountdownOffset" | "SpecialStyle" | "WidescreenStoryboard" | "SamplesMatchPlaybackRate" | "Bookmarks" | "DistanceSpacing" | "BeatDivisor" | "GridSize" | "TimelineZoom" | "Title" | "TitleUnicode" | "Artist" | "ArtistUnicode" | "Creator" | "Version" | "Source" | "Tags" | "BeatmapID" | "BeatmapSetID" | "HPDrainRate" | "CircleSize" | "OverallDifficulty" | "ApproachRate" | "SliderMultiplier" | "SliderTickRate" | "Background" | "Video" | "Storyboard";
+export interface OsuInput {
+    data: Uint8Array;
+    id?: string;
+}
+export interface GeneralSection {
+    AudioFilename: string;
+    AudioLeadIn: number;
+    AudioHash: string;
+    PreviewTime: number;
+    Countdown: number;
+    SampleSet: string;
+    StackLeniency: number;
+    Mode: number;
+    LetterboxInBreaks: number;
+    StoryFireInFront: number;
+    UseSkinSprites: number;
+    AlwaysShowPlayfield: number;
+    OverlayPosition: string;
+    SkinPreference: string;
+    EpilepsyWarning: number;
+    CountdownOffset: number;
+    SpecialStyle: number;
+    WidescreenStoryboard: number;
+    SamplesMatchPlaybackRate: number;
+}
+export interface EditorSection {
+    Bookmarks: number[];
+    DistanceSpacing: number;
+    BeatDivisor: number;
+    GridSize: number;
+    TimelineZoom: number;
+}
+export interface MetadataSection {
+    Title: string;
+    TitleUnicode: string;
+    Artist: string;
+    ArtistUnicode: string;
+    Creator: string;
+    Version: string;
+    Source: string;
+    Tags: string;
+    BeatmapID: number;
+    BeatmapSetID: number;
+}
+export interface DifficultySection {
+    HPDrainRate: number;
+    CircleSize: number;
+    OverallDifficulty: number;
+    ApproachRate: number;
+    SliderMultiplier: number;
+    SliderTickRate: number;
+}
+export interface EventBackground {
+    filename: string;
+    xOffset: number;
+    yOffset: number;
+}
+export interface EventVideo {
+    filename: string;
+    startTime: number;
+    xOffset: number;
+    yOffset: number;
+}
+export interface EventBreak {
+    startTime: number;
+    endTime: number;
+}
+export interface EventsSection {
+    background: EventBackground | null;
+    video: EventVideo | null;
+    breaks: EventBreak[];
+}
+export interface TimingPoint {
+    time: number;
+    beatLength: number;
+    meter: number;
+    sampleSet: number;
+    sampleIndex: number;
+    volume: number;
+    uninherited: number;
+    effects: number;
+}
+export interface ColourSection {
+    Combos: [number, number, number][];
+    SliderTrackOverride: [number, number, number] | null;
+    SliderBorder: [number, number, number] | null;
+}
+export interface HitSample {
+    normalSet: number;
+    additionSet: number;
+    index: number;
+    volume: number;
+    filename: string;
+}
+export interface CurvePoint {
+    x: number;
+    y: number;
+}
+export interface EdgeSet {
+    normalSet: number;
+    additionSet: number;
+}
+export interface HitObject {
+    x: number;
+    y: number;
+    time: number;
+    type: number;
+    hitSound: number;
+    hitSample: HitSample;
+    curveType: string;
+    curvePoints: CurvePoint[];
+    slides: number;
+    length: number;
+    edgeSounds: number[];
+    edgeSets: EdgeSet[];
+    endTime: number;
+}
+export interface OsuFileFormat {
+    version: number;
+    General: GeneralSection;
+    Editor: EditorSection;
+    Metadata: MetadataSection;
+    Difficulty: DifficultySection;
+    Events: EventsSection;
+    TimingPoints: TimingPoint[];
+    Colours: ColourSection;
+    HitObjects: HitObject[];
+}
+export interface INativeExporter {
+    get_property(data: Uint8Array, key: string): string;
+    get_properties(data: Uint8Array, keys: string[]): Record<string, string>;
+    get_section(data: Uint8Array, section: string): string[];
+    parse(data: Uint8Array): OsuFileFormat;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rel-packages/osu-beatmap-parser",
-  "version": "1.0.6",
+  "version": "1.1.2",
   "description": ".osu parser for nodejs",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -15,7 +15,7 @@
     "compile:tsc": "tsc",
     "build": "tsx scripts/build.ts all && npm run compile:tsc",
     "example:wasm": "bun run compile:wasm && bun x http-server . -p 8080 -c-1 -o /examples/wasm/",
-    "example:node": "bun run compile:node && bun run examples/node/index.ts"
+    "example:node": "bun run compile:native && bun run examples/node/index.ts"
   },
   "keywords": [
     "osu",
@@ -42,6 +42,8 @@
     "tsx": "^4.21.0",
     "typescript": "^5.9.3"
   },
-  "dependencies": {},
+  "dependencies": {
+    "node-gyp-build": "^4.8.4"
+  },
   "optionalDependencies": {}
 }

package/dist/types.d.ts

@@ -1,9 +0,0 @@
-export type OsuKey = "AudioFilename" | "AudioLeadIn" | "PreviewTime" | "Countdown" | "SampleSet" | "StackLeniency" | "Mode" | "LetterboxInBreaks" | "WidescreenStoryboard" | "Bookmarks" | "DistanceSpacing" | "BeatDivisor" | "GridSize" | "TimelineZoom" | "Title" | "TitleUnicode" | "Artist" | "ArtistUnicode" | "Creator" | "Version" | "Source" | "Tags" | "BeatmapID" | "BeatmapSetID" | "HPDrainRate" | "CircleSize" | "OverallDifficulty" | "ApproachRate" | "SliderMultiplier" | "SliderTickRate" | "Background" | "Video" | "Storyboard" | "Duration";
-export interface OsuInput {
-    data: Uint8Array;
-    id?: string;
-}
-export interface INativeExporter {
-    get_property(data: Uint8Array, key: string): string;
-    get_properties(data: Uint8Array, keys: string[]): Record<string, string>;
-}