@r4ai/typst-ast-node 0.0.0 → 0.2.0

package/README.md

@@ -0,0 +1,118 @@
+# typst-ast
+
+A WebAssembly library that parses [Typst](https://typst.app/) source code and returns its AST as a JSON-serializable object. Built with Rust and [`typst-syntax`](https://crates.io/crates/typst-syntax), distributed as npm packages via `wasm-pack`.
+
+## Packages
+
+| Package                                                                      | Target        |
+| ---------------------------------------------------------------------------- | ------------- |
+| [`@r4ai/typst-ast-web`](https://www.npmjs.com/package/@r4ai/typst-ast-web)   | Web (ESM, Browser) |
+| [`@r4ai/typst-ast-node`](https://www.npmjs.com/package/@r4ai/typst-ast-node) | Node.js       |
+
+## Usage
+
+### Browser
+
+```ts
+import init, { parse } from "@r4ai/typst-ast-web";
+
+await init();
+
+const result = parse("= Hello\n\nThis is *typst*.", { mode: "markup" });
+console.log(result);
+// {
+//   root: { kind: "Markup", range: [0, 26], text: null, children: [...] },
+//   errors: []
+// }
+```
+
+### Node.js
+
+```ts
+import { parse } from "@r4ai/typst-ast-node";
+
+const result = parse("#let x = 1 + 2", { mode: "code" });
+console.log(result);
+```
+
+### API
+
+#### `parse(text, options?)`
+
+Parses Typst source text and returns the AST.
+
+**Parameters**
+
+- `text: string` — Typst source code to parse
+- `options.mode?: "markup" | "code" | "math"` — Parse mode (default: `"markup"`)
+
+**Return value**
+
+```ts
+type ParseResult = {
+  root: Node;
+  errors: ParseError[];
+};
+
+type Node = {
+  kind: string; // SyntaxKind variant name (e.g. "Markup", "Heading", "Strong")
+  range: [number, number]; // [start, end] byte offsets
+  text: string | null; // leaf node text, null for inner nodes
+  children: Node[];
+};
+
+type ParseError = {
+  message: string;
+  range: [number, number];
+};
+```
+
+## Development
+
+### Prerequisites
+
+- Rust (stable) with `wasm32-unknown-unknown` target
+- Node.js 24
+- pnpm 10
+- [`wasm-pack`](https://rustwasm.github.io/wasm-pack/)
+
+### Commands
+
+```sh
+# Install Node.js and pnpm via mise
+mise install
+
+# Install JS dependencies
+pnpm install
+
+# Build WASM packages (outputs to dist/web and dist/node)
+pnpm run build:lib
+
+# Lint
+cargo fmt --check
+cargo clippy -- -D warnings
+pnpm run check
+```
+
+### Release
+
+```sh
+# Bump version and create a release commit + tag
+bash scripts/release.sh 1.2.3
+```
+
+## Examples
+
+### React app
+
+A React-based example app is located at [`examples/app`](./examples/app).
+
+```sh
+cd examples/app
+pnpm install
+pnpm dev
+```
+
+## License
+
+MIT

package/package.json

@@ -3,8 +3,12 @@
   "collaborators": [
     "r4ai"
   ],
-  "version": "0.0.0",
+  "version": "0.2.0",
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/r4ai/typst-ast"
+  },
   "files": [
     "typst_ast_bg.wasm",
     "typst_ast.js",

package/typst_ast.d.ts

@@ -1,6 +1,33 @@
 /* tslint:disable */
 /* eslint-disable */
+export interface SyntaxNode {
+    kind: string;
+    range: [number, number];
+    text?: string;
+    children: SyntaxNode[];
+}
+
+export interface ParseError {
+    message: string;
+    range: [number, number];
+}
+
+export interface ParseResult {
+    root: SyntaxNode;
+    errors: ParseError[];
+}
+
+export type ParseMode = "markup" | "code" | "math";
+
+export interface ParseOptions {
+    mode?: ParseMode;
+}
+
+export declare function parse(
+text: string,
+options?: ParseOptions,
+): ParseResult;
+
 
-export function parse(text: string, options: any): any;
 
 export function start(): void;