@nast/nast2typst 0.2.0 → 0.3.0

package/dist/{index-CgBLzCnj.d.ts → index.d.ts}

@@ -1,112 +1,94 @@
-//#region src/types.d.ts
+//#region ../types/dist/nast.d.ts
+//#region src/nast.d.ts
+/**
+ * NAST (Notion Abstract Syntax Tree) Types
+ *
+ * NAST is a unified-like AST format for representing Notion content.
+ * It's designed to be easily converted to various output formats (Markdown, Typst, etc.)
+ */
+/**
+ * Root node of a NAST document
+ */
 interface NASTRoot {
-  type: "root";
+  type: 'root';
   children: NASTNode[];
   data: {
     pageId: string;
     title: string;
     icon?: {
-      type: "emoji" | "file" | "external";
+      type: 'emoji' | 'file' | 'external';
       value: string;
     };
     processedAt: string;
   };
 }
+/**
+ * Union of all NAST node types
+ */
 type NASTNode = NASTParagraph | NASTHeading | NASTText | NASTStrong | NASTEmphasis | NASTUnderline | NASTDelete | NASTInlineCode | NASTLink | NASTMention | NASTMath | NASTInlineMath | NASTCode | NASTBlockquote | NASTCallout | NASTToggle | NASTList | NASTListItem | NASTColumnList | NASTColumn | NASTImage | NASTThematicBreak | NASTTable | NASTTableRow | NASTTableCell | NASTChildPage | NASTVideo | NASTFile | NASTPDF | NASTBookmark | NASTEmbed;
+/**
+ * Paragraph block
+ */
 interface NASTParagraph {
-  type: "paragraph";
+  type: 'paragraph';
   children: NASTNode[];
   data?: {
     blockId?: string;
   };
 }
+/**
+ * Heading block (h1, h2, h3)
+ */
 interface NASTHeading {
-  type: "heading";
+  type: 'heading';
   depth: 1 | 2 | 3;
   children: NASTNode[];
+  /** Indicates if this heading is also a toggle (collapsible) */
   isToggleable?: boolean;
   data?: {
     blockId?: string;
   };
 }
-interface NASTText {
-  type: "text";
-  value: string;
-  data?: {
-    color?: string;
-    backgroundColor?: string;
-  };
-}
-interface NASTStrong {
-  type: "strong";
-  children: NASTNode[];
-}
-interface NASTEmphasis {
-  type: "emphasis";
-  children: NASTNode[];
-}
-interface NASTUnderline {
-  type: "underline";
-  children: NASTNode[];
-}
-interface NASTDelete {
-  type: "delete";
-  children: NASTNode[];
-}
-interface NASTInlineCode {
-  type: "inlineCode";
-  value: string;
-}
-interface NASTLink {
-  type: "link";
-  url: string;
-  children: NASTNode[];
-  data?: {
-    title?: string;
-    iconUrl?: string;
-    description?: string;
-    provider?: string;
-    thumbnailUrl?: string;
-  };
-}
-interface NASTMention {
-  type: "mention";
-  mentionType: "user" | "date" | "page" | "database";
-  value: string;
-  data: unknown;
-}
-interface NASTMath {
-  type: "math";
+/**
+ * Code block with syntax highlighting
+ */
+interface NASTCode {
+  type: 'code';
+  lang: string;
   value: string;
   data?: {
+    caption?: NASTNode[];
     blockId?: string;
   };
 }
-interface NASTInlineMath {
-  type: "inlineMath";
-  value: string;
-}
-interface NASTCode {
-  type: "code";
-  lang: string;
+/**
+ * Block math equation
+ */
+interface NASTMath {
+  type: 'math';
   value: string;
   data?: {
-    caption?: NASTNode[];
     blockId?: string;
   };
 }
+/**
+ * Blockquote
+ */
 interface NASTBlockquote {
-  type: "blockquote";
+  type: 'blockquote';
   children: NASTNode[];
   data?: {
     blockId?: string;
   };
 }
+/**
+ * Callout block (with icon and color)
+ */
 interface NASTCallout {
-  type: "callout";
+  type: 'callout';
   data: {
     icon: {
-      type: "emoji";
+      type: 'emoji';
       value: string;
     } | null;
     color: string;
@@ -114,61 +96,72 @@ interface NASTCallout {
   };
   children: NASTNode[];
 }
+/**
+ * Toggle block (collapsible content)
+ */
 interface NASTToggle {
-  type: "toggle";
+  type: 'toggle';
   children: NASTNode[];
   data?: {
     blockId?: string;
   };
 }
+/**
+ * Thematic break / divider
+ */
+interface NASTThematicBreak {
+  type: 'thematicBreak';
+  data?: {
+    blockId?: string;
+  };
+}
+/**
+ * List (ordered or unordered)
+ */
 interface NASTList {
-  type: "list";
+  type: 'list';
   ordered: boolean;
   children: NASTListItem[];
 }
+/**
+ * List item (can be a checklist item if checked is defined)
+ */
 interface NASTListItem {
-  type: "listItem";
+  type: 'listItem';
+  /** undefined = not a checklist, true/false = checked state */
+  checked?: boolean;
   children: NASTNode[];
-  checked?: boolean | undefined;
   data?: {
     blockId?: string;
   };
 }
+/**
+ * Column list (container for columns)
+ */
 interface NASTColumnList {
-  type: "columnList";
+  type: 'columnList';
   children: NASTColumn[];
   data?: {
     blockId?: string;
   };
 }
+/**
+ * Column within a column list
+ */
 interface NASTColumn {
-  type: "column";
+  type: 'column';
+  /** Width ratio (0.5 = 50%, matches NBT format) */
   widthRatio: number;
   children: NASTNode[];
   data?: {
     blockId?: string;
   };
 }
-interface NASTImage {
-  type: "image";
-  url: string;
-  title: string | null | undefined;
-  alt: string | null | undefined;
-  data: {
-    fileType: "file" | "external";
-    expiryTime?: string;
-    caption?: NASTNode[];
-    blockId?: string;
-  };
-}
-interface NASTThematicBreak {
-  type: "thematicBreak";
-  data?: {
-    blockId?: string;
-  };
-}
+/**
+ * Table
+ */
 interface NASTTable {
-  type: "table";
+  type: 'table';
   hasColumnHeader: boolean;
   hasRowHeader: boolean;
   children: NASTTableRow[];
@@ -176,69 +169,186 @@ interface NASTTable {
     blockId?: string;
   };
 }
+/**
+ * Table row
+ */
 interface NASTTableRow {
-  type: "tableRow";
+  type: 'tableRow';
   children: NASTTableCell[];
 }
+/**
+ * Table cell
+ */
 interface NASTTableCell {
-  type: "tableCell";
+  type: 'tableCell';
   children: NASTNode[];
 }
-interface NASTChildPage {
-  type: "childPage";
-  title: string;
-  pageId: string;
+/**
+ * Plain text
+ */
+interface NASTText {
+  type: 'text';
+  value: string;
   data?: {
+    color?: string;
+    backgroundColor?: string;
+  };
+}
+/**
+ * Bold text
+ */
+interface NASTStrong {
+  type: 'strong';
+  children: NASTNode[];
+}
+/**
+ * Italic text
+ */
+interface NASTEmphasis {
+  type: 'emphasis';
+  children: NASTNode[];
+}
+/**
+ * Underlined text
+ */
+interface NASTUnderline {
+  type: 'underline';
+  children: NASTNode[];
+}
+/**
+ * Strikethrough text
+ */
+interface NASTDelete {
+  type: 'delete';
+  children: NASTNode[];
+}
+/**
+ * Inline code
+ */
+interface NASTInlineCode {
+  type: 'inlineCode';
+  value: string;
+}
+/**
+ * Inline math equation
+ */
+interface NASTInlineMath {
+  type: 'inlineMath';
+  value: string;
+}
+/**
+ * Link
+ */
+interface NASTLink {
+  type: 'link';
+  url: string;
+  children: NASTNode[];
+  data?: {
+    title?: string;
+    iconUrl?: string;
+    description?: string;
+    provider?: string;
+    thumbnailUrl?: string;
+  };
+}
+/**
+ * Mention (@user, date, page, database)
+ */
+interface NASTMention {
+  type: 'mention';
+  mentionType: 'user' | 'date' | 'page' | 'database';
+  value: string;
+  data: unknown;
+}
+/**
+ * Image
+ */
+interface NASTImage {
+  type: 'image';
+  url: string;
+  title: string | null | undefined;
+  alt: string | null | undefined;
+  data: {
+    fileType: 'file' | 'external';
+    expiryTime?: string;
+    caption?: NASTNode[];
     blockId?: string;
   };
 }
+/**
+ * Video
+ */
 interface NASTVideo {
-  type: "video";
+  type: 'video';
   url: string;
   data: {
-    fileType: "file" | "external";
+    fileType: 'file' | 'external';
     expiryTime?: string;
     caption?: NASTNode[];
     blockId?: string;
   };
 }
+/**
+ * File attachment
+ */
 interface NASTFile {
-  type: "file";
+  type: 'file';
   url: string;
   name: string;
   data: {
-    fileType: "file" | "external";
+    fileType: 'file' | 'external';
     expiryTime?: string;
     caption?: NASTNode[];
     blockId?: string;
   };
 }
+/**
+ * PDF embed
+ */
 interface NASTPDF {
-  type: "pdf";
+  type: 'pdf';
   url: string;
   data: {
-    fileType: "file" | "external";
+    fileType: 'file' | 'external';
     expiryTime?: string;
     caption?: NASTNode[];
     blockId?: string;
   };
 }
+/**
+ * Bookmark (link with preview)
+ */
 interface NASTBookmark {
-  type: "bookmark";
+  type: 'bookmark';
   url: string;
   data?: {
     caption?: NASTNode[];
     blockId?: string;
   };
 }
+/**
+ * Generic embed
+ */
 interface NASTEmbed {
-  type: "embed";
+  type: 'embed';
   url: string;
   data?: {
     caption?: NASTNode[];
     blockId?: string;
   };
 }
+/**
+ * Child page reference
+ */
+interface NASTChildPage {
+  type: 'childPage';
+  title: string;
+  pageId: string;
+  data?: {
+    blockId?: string;
+  };
+}
+//#endregion
 //#endregion
 //#region src/index.d.ts
 /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@nast/nast2typst",
   "type": "module",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Converts NAST (unified-like Notion Abstract Syntax Tree) to Typst markup language.",
   "keywords": [
     "notion",
@@ -31,13 +31,14 @@
   },
   "main": "./dist/index.js",
   "module": "./dist/index.js",
-  "types": "./dist/index-CgBLzCnj.d.ts",
+  "types": "./dist/index.d.ts",
   "files": [
     "dist",
     "README.md"
   ],
   "dependencies": {
-    "tex2typst": "^0.5.6"
+    "tex2typst": "^0.5.6",
+    "@nast/types": "0.1.0"
   },
   "scripts": {
     "build": "tsdown",