@rel-packages/osu-beatmap-parser 1.0.7 → 1.4.0

package/README.md

@@ -1,21 +1,13 @@
 ## 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
+npm install @rel-packages/osu-beatmap-parser
 ```
 
-## development
+## usage
 
-```bash
-npm install
-npm run compile
-```
-
-## 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)
+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,14 @@
-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 type { OsuKey, OsuInput };
+export declare const get_section: (data: Uint8Array, section: string) => string[];
+export declare const parse: (input: Uint8Array | OsuInput) => OsuFileFormat;
+declare const parser: {
+    get_property: (data: Uint8Array, key: OsuKey) => string;
+    get_properties: (input: Uint8Array | OsuInput, keys: OsuKey[]) => Record<string, string>;
+    get_section: (data: Uint8Array, section: string) => string[];
+    parse: (input: Uint8Array | OsuInput) => OsuFileFormat;
+};
+export type { OsuKey, OsuInput, OsuFileFormat };
+export * from "./types/types";
+export default parser;

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,20 @@ 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;
+const parser = {
+    get_property: exports.get_property,
+    get_properties: exports.get_properties,
+    get_section: exports.get_section,
+    parse: exports.parse
+};
+__exportStar(require("./types/types"), exports);
+exports.default = parser;

package/dist/lib/bindings.d.ts

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

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

@@ -0,0 +1,2 @@
+import { init_wasm, get_property, get_properties, get_section, parse, set_wasm_factory, is_wasm_ready, init_wasm_from_url } from "./wasm-wrapper";
+export { init_wasm, get_property, get_properties, get_section, parse, set_wasm_factory, is_wasm_ready, init_wasm_from_url, };

package/dist/lib/wasm-browser.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.init_wasm_from_url = exports.is_wasm_ready = exports.set_wasm_factory = exports.parse = exports.get_section = exports.get_properties = exports.get_property = exports.init_wasm = void 0;
+const wasm_wrapper_1 = require("./wasm-wrapper");
+Object.defineProperty(exports, "init_wasm", { enumerable: true, get: function () { return wasm_wrapper_1.init_wasm; } });
+Object.defineProperty(exports, "get_property", { enumerable: true, get: function () { return wasm_wrapper_1.get_property; } });
+Object.defineProperty(exports, "get_properties", { enumerable: true, get: function () { return wasm_wrapper_1.get_properties; } });
+Object.defineProperty(exports, "get_section", { enumerable: true, get: function () { return wasm_wrapper_1.get_section; } });
+Object.defineProperty(exports, "parse", { enumerable: true, get: function () { return wasm_wrapper_1.parse; } });
+Object.defineProperty(exports, "set_wasm_factory", { enumerable: true, get: function () { return wasm_wrapper_1.set_wasm_factory; } });
+Object.defineProperty(exports, "is_wasm_ready", { enumerable: true, get: function () { return wasm_wrapper_1.is_wasm_ready; } });
+Object.defineProperty(exports, "init_wasm_from_url", { enumerable: true, get: function () { return wasm_wrapper_1.init_wasm_from_url; } });
+const api = {
+    init_wasm: wasm_wrapper_1.init_wasm,
+    get_property: wasm_wrapper_1.get_property,
+    get_properties: wasm_wrapper_1.get_properties,
+    get_section: wasm_wrapper_1.get_section,
+    parse: wasm_wrapper_1.parse,
+    set_wasm_factory: wasm_wrapper_1.set_wasm_factory,
+    is_wasm_ready: wasm_wrapper_1.is_wasm_ready,
+    init_wasm_from_url: wasm_wrapper_1.init_wasm_from_url,
+};
+globalThis.beatmap_parser = api;

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

@@ -1,3 +1,16 @@
-export declare const init_wasm: () => Promise<void>;
+import type { OsuFileFormat } from "../types/types";
+type wasm_init_options = {
+    factory?: (module_config?: Record<string, unknown>) => any;
+    script_url?: string;
+    global_name?: string;
+    module_config?: Record<string, unknown>;
+};
+export declare const set_wasm_factory: (factory: (module_config?: Record<string, unknown>) => any, global_name?: string) => void;
+export declare const is_wasm_ready: () => boolean;
+export declare const init_wasm: (options?: wasm_init_options) => Promise<void>;
+export declare const init_wasm_from_url: (script_url: string, module_config?: Record<string, unknown>, global_name?: string) => 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;
+export {};

package/dist/lib/wasm-wrapper.js

@@ -1,33 +1,78 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.get_properties = exports.get_property = exports.init_wasm = void 0;
-console.log("[parser] wrapper loaded");
+exports.parse = exports.get_section = exports.get_properties = exports.get_property = exports.init_wasm_from_url = exports.init_wasm = exports.is_wasm_ready = exports.set_wasm_factory = void 0;
 let wasm_instance = null;
 let init_promise = null;
-const get_factory = () => {
-    return globalThis.create_osu_parser;
+let wasm_factory = null;
+let wasm_global_name = "create_osu_parser";
+const script_loaders = new Map();
+const get_global_name = (options) => {
+    return options.global_name || wasm_global_name;
 };
-const init_wasm = async () => {
+const load_script = (script_url) => {
+    const existing = script_loaders.get(script_url);
+    if (existing)
+        return existing;
+    const loader = new Promise((resolve, reject) => {
+        if (typeof document == "undefined") {
+            reject(new Error("script loading requires a browser environment"));
+            return;
+        }
+        const script = document.createElement("script");
+        script.src = script_url;
+        script.async = true;
+        script.onload = () => resolve();
+        script.onerror = () => reject(new Error(`failed to load wasm script: ${script_url}`));
+        document.head.appendChild(script);
+    });
+    script_loaders.set(script_url, loader);
+    return loader;
+};
+const resolve_factory = async (options) => {
+    if (options.factory)
+        return options.factory;
+    if (wasm_factory)
+        return wasm_factory;
+    if (options.script_url) {
+        await load_script(options.script_url);
+    }
+    const global_name = get_global_name(options);
+    return globalThis[global_name];
+};
+const set_wasm_factory = (factory, global_name) => {
+    wasm_factory = factory;
+    if (global_name) {
+        wasm_global_name = global_name;
+    }
+};
+exports.set_wasm_factory = set_wasm_factory;
+const is_wasm_ready = () => {
+    return wasm_instance != null;
+};
+exports.is_wasm_ready = is_wasm_ready;
+const init_wasm = async (options = {}) => {
     if (wasm_instance)
         return;
     if (init_promise)
         return init_promise;
     init_promise = (async () => {
-        const factory = get_factory();
-        if (typeof factory !== "function") {
-            throw new Error("create_osu_parser not found in global scope");
-        }
-        try {
-            wasm_instance = await factory();
-        }
-        catch (e) {
-            console.error(e);
-            throw e;
+        const factory = await resolve_factory(options);
+        if (typeof factory != "function") {
+            const global_name = get_global_name(options);
+            throw new Error(`wasm factory not found: ${global_name}`);
         }
+        wasm_instance = await factory(options.module_config);
     })();
-    return init_promise;
+    return init_promise.catch((err) => {
+        init_promise = null;
+        throw err;
+    });
 };
 exports.init_wasm = init_wasm;
+const init_wasm_from_url = async (script_url, module_config = {}, global_name) => {
+    return (0, exports.init_wasm)({ script_url, module_config, global_name });
+};
+exports.init_wasm_from_url = init_wasm_from_url;
 const get_property = (data, key) => {
     if (wasm_instance == null)
         throw new Error("wasm not initialized");
@@ -54,12 +99,29 @@ const get_properties = (data, keys) => {
     }
 };
 exports.get_properties = get_properties;
-if (typeof window != "undefined") {
-    window.beatmap_parser = {
-        init_wasm: exports.init_wasm,
-        get_property: exports.get_property,
-        get_properties: exports.get_properties,
-    };
-    console.log(window.beatmap_parser);
-    console.log("[parser] attached to window");
-}
+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;

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,49 +1,55 @@
 {
-  "name": "@rel-packages/osu-beatmap-parser",
-  "version": "1.0.7",
-  "description": ".osu parser for nodejs",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "homepage": "https://github.com/mezleca/osu-beatmap-parser",
-  "scripts": {
-    "update:patch": "npm version patch && git push --follow-tags",
-    "update:minor": "npm version minor && git push --follow-tags",
-    "update:major": "npm version major && git push --follow-tags",
-    "prepublishOnly": "npm run compile:tsc && mkdir -p lib",
-    "compile:native": "tsx scripts/build.ts native",
-    "compile:wasm": "tsx scripts/build.ts wasm",
-    "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:native && bun run examples/node/index.ts"
-  },
-  "keywords": [
-    "osu",
-    "beatmap",
-    "parser",
-    "native"
-  ],
-  "author": "",
-  "license": "ISC",
-  "repository": {
-    "url": "https://github.com/mezleca/osu-beatmap-parser.git"
-  },
-  "type": "commonjs",
-  "files": [
-    "dist/",
-    "prebuilds/",
-    "README.md"
-  ],
-  "devDependencies": {
-    "@types/bindings": "^1.5.5",
-    "@types/node": "^24.10.1",
-    "cmake-js": "^7.4.0",
-    "node-addon-api": "^8.5.0",
-    "tsx": "^4.21.0",
-    "typescript": "^5.9.3"
-  },
-  "dependencies": {
-    "node-gyp-build": "^4.8.4"
-  },
-  "optionalDependencies": {}
+    "name": "@rel-packages/osu-beatmap-parser",
+    "version": "1.4.0",
+    "description": ".osu parser for nodejs",
+    "main": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "homepage": "https://github.com/mezleca/osu-beatmap-parser",
+    "scripts": {
+        "update:patch": "npm version patch && git push --follow-tags",
+        "update:minor": "npm version minor && git push --follow-tags",
+        "update:major": "npm version major && git push --follow-tags",
+        "prepublishOnly": "npm run compile:tsc && mkdir -p lib",
+        "compile:native": "bun scripts/build.ts native",
+        "compile:wasm": "bun scripts/build.ts wasm",
+        "compile:tsc": "tsc",
+        "format": "prettier --write . --ignore-unknown",
+        "pretest": "bun run format",
+        "test": "bun test",
+        "prebuild": "bun run format",
+        "build": "bun 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:native && bun run examples/node/index.ts"
+    },
+    "keywords": [
+        "osu",
+        "beatmap",
+        "parser",
+        "native"
+    ],
+    "author": "",
+    "license": "ISC",
+    "repository": {
+        "url": "https://github.com/mezleca/osu-beatmap-parser.git"
+    },
+    "type": "commonjs",
+    "files": [
+        "dist/",
+        "prebuilds/",
+        "README.md"
+    ],
+    "devDependencies": {
+        "@rel-packages/osu-beatmap-parser": "^1.1.2",
+        "@types/bindings": "^1.5.5",
+        "@types/node": "^24.10.4",
+        "cmake-js": "^7.4.0",
+        "node-addon-api": "^8.5.0",
+        "prettier": "^3.6.2",
+        "prettier-plugin-svelte": "^3.4.1",
+        "tsx": "^4.21.0",
+        "typescript": "^5.9.3"
+    },
+    "dependencies": {
+        "node-gyp-build": "^4.8.4"
+    }
 }

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>;
-}