TypeScript type definitions and Bun runtime support for raphtory-js

[vyasraos]

Summary

As raphtory-js (WASM bindings) matures, it would be great to have first-class TypeScript and Bun support:

1. TypeScript type definitions — Ship .d.ts types alongside the WASM/JS bindings so TypeScript users get autocomplete, type checking, and documentation out of the box. wasm-bindgen can generate these via --typescript.

2. Bun runtime compatibility — Verify that the WASM module loads and runs correctly under Bun, which has native WASM support and is increasingly used as a Node alternative. This includes:

   • WebAssembly.instantiate / WebAssembly.compileStreaming compatibility
   • ESM import of the generated .wasm module
   • Any Node-specific APIs (e.g. fs, path) used in the JS glue code should have Bun equivalents or be abstracted

3. npm publishing — Related to Publish raphtory-js to npm #919 (closed), the package doesn't appear to be on npm yet. Publishing with TS types and documenting Bun compatibility would significantly lower the barrier for JS/TS users.

Motivation

TypeScript is the dominant language for JS-ecosystem projects, and Bun is gaining traction as a fast, batteries-included runtime. Supporting both would make Raphtory accessible to a much wider audience beyond Python and Rust.

Suggested approach

• Use wasm-bindgen --typescript to auto-generate .d.ts files
• Add a types field to package.json
• Add Bun to the test matrix (CI) alongside Node
• Publish to npm with proper exports map for ESM/CJS

[miratepuffin]

Hi @vyasraos,

Thanks for taking an interest in the project and raising this issue.

Raphtory-js is currently on the backburner whilst we work on the rust and python libraries which are the predominant ways our clients utilise our tools. When we get some free dev cycles or if we find we need to deploy raphtory directly a browser we shall certainly get back to raphtory-js and make it typescript compatible as it is what our UI is built within.

Are you currently planning to use it within any projects?