NBT to NAST Converter

Converts NBT (Notion Block Tree) to NAST (Notion Abstract Syntax Tree).

Overview

This package provides a converter that transforms the Notion API-based NBT structure into a unified-like NAST structure that's easier to work with and convert to other formats like MDAST, HAST, etc.

Installation

npm install

Usage

As a Module

import { nbt2nast } from "./nbt2nast.js";
import type { NBTDocument } from "./types.js";

// Load your NBT document
const nbt: NBTDocument = /* [...] */;

// Convert to NAST
const nast = nbt2nast(nbt);

console.log(nast);

Running the Example

The example script reads the NBT input file (you will need to manually set it's name) from input/ directory and outputs the NAST to output/ directory with same file name. Run it with:

npm run example

Using the CLI Tool

Convert any NBT JSON file to NAST:

npm run convert -- path/to/input.json [path/to/output.json]

If you don't put any output path it will create a file with a .nast.json extension on the directory as the same input file.

Mapping (NBT → NAST)

Blocks

| NBT Type | NAST Type | Notes | |-----------|------------|-------| | heading_1/2/3 | heading | With depth: 1/2/3 | | bulleted_list_item | list (ordered: false) | Groups consecutive items | | numbered_list_item | list (ordered: true) | Groups consecutive items | | quote | blockquote | With children | | toggle | toggle | With first children being paragraph or heading | | equation | math | Block equation with meta: "block" | | divider | thematicBreak | Horizontal rule | | Rest of blocks | Same type as NBT| But some properties may be different

Inline

| NBT Annotation | NAST Type | |----------------|------------| | bold: true | strong | | italic: true | emphasis | | underline: true | underline | | strikethrough: true | delete | | code: true | inlineCode | | url: "..." | link | | Equation inline | inlineMath | | Mention | mention |

License

MIT