text-doc-ir 0.0.11 → 0.0.12

package/esm/deps.d.ts

@@ -1,2 +1,2 @@
 export { NodeVisitor } from "document-ir";
-export type { BlockQuoteNode, BreakNode, BubbleNode, CardNode, CenterNode, ColumnsNode, DefinitionNode, DefinitionReferenceNode, DocumentNode, EmbedNode, EmojiNode, FigureImageNode, FormattedTextNode, HeaderNode, HighTechAlertNode, HorizontalRuleNode, ImageNode, LinkNode, ListNode, Node, NoteNode, ParagraphNode, QuoteNode, StickerNode, StrikeThroughNode, TextNode, VideoNode, WarningNode, } from "document-ir";
+export type { BlockQuoteNode, BreakNode, BubbleNode, CardNode, CenterNode, ColumnsNode, DefinitionNode, DefinitionReferenceNode, DocumentNode, EmbedNode, EmojiNode, FigureImageNode, FormattedTextNode, HeaderNode, HighTechAlertNode, HorizontalRuleNode, ImageNode, LinkNode, ListNode, Node, NoteNode, ParagraphNode, QuoteNode, StickerNode, StrikeThroughNode, TableOfContentsNode, TextNode, VideoNode, WarningNode, } from "document-ir";

package/esm/main.d.ts

@@ -1,4 +1,4 @@
-import { BlockQuoteNode, BreakNode, BubbleNode, CardNode, CenterNode, ColumnsNode, DefinitionNode, DefinitionReferenceNode, DocumentNode, EmbedNode, EmojiNode, FigureImageNode, FormattedTextNode, HeaderNode, HighTechAlertNode, HorizontalRuleNode, ImageNode, LinkNode, ListNode, NodeVisitor, NoteNode, ParagraphNode, QuoteNode, StickerNode, StrikeThroughNode, TextNode, VideoNode, WarningNode } from "./deps.js";
+import { BlockQuoteNode, BreakNode, BubbleNode, CardNode, CenterNode, ColumnsNode, DefinitionNode, DefinitionReferenceNode, DocumentNode, EmbedNode, EmojiNode, FigureImageNode, FormattedTextNode, HeaderNode, HighTechAlertNode, HorizontalRuleNode, ImageNode, LinkNode, ListNode, NodeVisitor, NoteNode, ParagraphNode, QuoteNode, StickerNode, StrikeThroughNode, TableOfContentsNode, TextNode, VideoNode, WarningNode } from "./deps.js";
 export declare class FixedWidthTextVisitor extends NodeVisitor {
     private width;
     private lines;
@@ -10,6 +10,7 @@ export declare class FixedWidthTextVisitor extends NodeVisitor {
     private state;
     constructor(width: number);
     private setState;
+    private restoreState;
     protected text(node: TextNode): void;
     protected formattedText(node: FormattedTextNode): void;
     protected horizontalRule(node: HorizontalRuleNode): void;
@@ -36,6 +37,7 @@ export declare class FixedWidthTextVisitor extends NodeVisitor {
     protected card(node: CardNode): void;
     protected definitionReference(node: DefinitionReferenceNode): void;
     protected definition(node: DefinitionNode): void;
+    protected toc(node: TableOfContentsNode): void;
     protected document(node: DocumentNode): void;
     private counterToDepth;
     private pushBlockContentBegin;

package/esm/main.js

@@ -66,11 +66,16 @@ export class FixedWidthTextVisitor extends NodeVisitor {
             linksReverse: new Map(),
             linkCount: 0,
             numericDepth: 0,
+            tocDepth: 0,
         };
     }
     setState(state) {
         this.state = state;
     }
+    restoreState(parent) {
+        parent.state.imageCount = this.state.imageCount;
+        parent.state.linkCount = this.state.linkCount;
+    }
     text(node) {
         this.pushText(node.text);
     }
@@ -133,6 +138,7 @@ export class FixedWidthTextVisitor extends NodeVisitor {
                         }
                     }
                 }
+                visitor.restoreState(this);
             }
         }
         else {
@@ -149,6 +155,7 @@ export class FixedWidthTextVisitor extends NodeVisitor {
                         this.lines.push("     " + lines[i]);
                     }
                 }
+                visitor.restoreState(this);
             }
         }
         this.pushBlockContentEnd();
@@ -175,6 +182,7 @@ export class FixedWidthTextVisitor extends NodeVisitor {
             columns.push(lines);
             maxLines = Math.max(maxLines, lines.length);
             consumedWidth += width;
+            visitor.restoreState(this);
         }
         this.pushBlockContentBegin();
         for (let i = 0; i < maxLines; i++) {
@@ -338,6 +346,7 @@ export class FixedWidthTextVisitor extends NodeVisitor {
             this.lines[Math.max(0, this.lines.length - 1)] =
                 " ".repeat(Math.floor((this.width - line.length) / 2)) + line;
         }
+        visitor.restoreState(this);
         this.pushBlockContentEnd();
     }
     warning(node) {
@@ -352,6 +361,7 @@ export class FixedWidthTextVisitor extends NodeVisitor {
             this.pushEndOfLineIfAnyContent();
             this.lines[Math.max(0, this.lines.length - 1)] = "| " + line;
         }
+        visitor.restoreState(this);
         this.pushBlockContentEnd();
     }
     highTechAlert(node) {
@@ -376,6 +386,7 @@ export class FixedWidthTextVisitor extends NodeVisitor {
             this.pushLine();
             this.pushText("|" + "-".repeat(this.width - 2) + "|");
         }
+        centerVisitor.restoreState(this);
         const contentVisitor = new FixedWidthTextVisitor(this.width - 4);
         contentVisitor.setState({ ...this.state, numericDepth: 0 });
         contentVisitor.visit({
@@ -391,6 +402,7 @@ export class FixedWidthTextVisitor extends NodeVisitor {
         this.pushText("\\");
         this.pushText("-".repeat(this.width - 2));
         this.pushText("/");
+        contentVisitor.restoreState(this);
         this.pushBlockContentEnd();
     }
     blockQuote(node) {
@@ -405,6 +417,7 @@ export class FixedWidthTextVisitor extends NodeVisitor {
             this.pushEndOfLineIfAnyContent();
             this.lines[Math.max(0, this.lines.length - 1)] = "> " + line;
         }
+        visitor.restoreState(this);
         this.pushBlockContentEnd();
     }
     quote(node) {
@@ -424,6 +437,7 @@ export class FixedWidthTextVisitor extends NodeVisitor {
             this.pushEndOfLineIfAnyContent();
             this.lines[Math.max(0, this.lines.length - 1)] = "> " + line;
         }
+        visitor.restoreState(this);
         this.pushBlockContentEnd();
     }
     bubble(node) {
@@ -446,6 +460,7 @@ export class FixedWidthTextVisitor extends NodeVisitor {
                     " ".repeat(this.width - 2 - line.length) + line + " |";
             }
         }
+        visitor.restoreState(this);
         this.pushBlockContentEnd();
     }
     sticker(node) {
@@ -497,6 +512,7 @@ export class FixedWidthTextVisitor extends NodeVisitor {
         this.pushText("\\");
         this.pushText("-".repeat(this.width - 2));
         this.pushText("/");
+        visitor.restoreState(this);
         this.pushBlockContentEnd();
     }
     card(node) {
@@ -534,6 +550,7 @@ export class FixedWidthTextVisitor extends NodeVisitor {
                 this.pushLine();
                 this.pushText("|" + "-".repeat(this.width - 2) + "|");
             }
+            centerVisitor.restoreState(this);
         }
         const contentVisitor = new FixedWidthTextVisitor(this.width - 4);
         contentVisitor.setState({ ...this.state, numericDepth: 0 });
@@ -585,6 +602,7 @@ export class FixedWidthTextVisitor extends NodeVisitor {
         this.pushText("\\");
         this.pushText("-".repeat(this.width - 2));
         this.pushText("/");
+        contentVisitor.restoreState(this);
         this.pushBlockContentEnd();
     }
     definitionReference(node) {
@@ -612,8 +630,89 @@ export class FixedWidthTextVisitor extends NodeVisitor {
             this.pushEndOfLineIfAnyContent();
             this.lines[Math.max(0, this.lines.length - 1)] = "  " + line;
         }
+        visitor.restoreState(this);
         this.pushBlockContentEnd();
     }
+    toc(node) {
+        if (this.state.tocDepth > 0) {
+            const visitor = new FixedWidthTextVisitor(this.width - 3);
+            visitor.setState({ ...this.state, tocDepth: this.state.tocDepth + 1 });
+            if (node.date) {
+                visitor.choose(node.date);
+                visitor.pushText(" ");
+            }
+            visitor.chooseChildren(node.content);
+            if (node.href && !node.href.startsWith("#")) {
+                visitor.link({
+                    type: "link",
+                    url: node.href,
+                    content: [],
+                });
+                visitor.spaceLazy = true;
+            }
+            let counter = 0;
+            for (const line of visitor.getLines()) {
+                this.pushEndOfLineIfAnyContent();
+                // First line gets a bullet point
+                if (counter == 0) {
+                    this.lines[Math.max(0, this.lines.length - 1)] = "* " + line;
+                }
+                else {
+                    this.lines[Math.max(0, this.lines.length - 1)] = "  " + line;
+                }
+                counter++;
+            }
+            visitor.restoreState(this);
+            visitor.visit({
+                type: "array",
+                content: node.children,
+            });
+            for (const line of visitor.getLines()) {
+                this.pushEndOfLineIfAnyContent();
+                this.lines[Math.max(0, this.lines.length - 1)] = " " + line;
+            }
+            visitor.restoreState(this);
+        }
+        else {
+            const visitor = new FixedWidthTextVisitor(this.width - 4);
+            visitor.setState({ ...this.state, tocDepth: this.state.tocDepth + 1 });
+            if (node.date) {
+                visitor.choose(node.date);
+                visitor.pushText(" ");
+            }
+            visitor.chooseChildren(node.content);
+            if (node.href && !node.href.startsWith("#")) {
+                visitor.link({
+                    type: "link",
+                    url: node.href,
+                    content: [],
+                });
+                visitor.spaceLazy = true;
+            }
+            visitor.pushLine();
+            visitor.visit({
+                type: "array",
+                content: node.children,
+            });
+            const tocLen = " Table of contents ".length;
+            const lines = visitor.getLines();
+            const maxLength = lines.reduce((prev, next) => Math.max(prev, next.length + 1), tocLen + 2);
+            const left = Math.floor((maxLength - tocLen) / 2) + 1;
+            const right = maxLength - tocLen - left + 1;
+            this.pushBlockContentBegin();
+            this.lines[Math.max(0, this.lines.length - 1)] = "/" + "-".repeat(left) +
+                " Table of contents " + "-".repeat(right) + "\\";
+            for (const line of visitor.getLines()) {
+                this.pushEndOfLineIfAnyContent();
+                this.lines[Math.max(0, this.lines.length - 1)] = "| " + line +
+                    " ".repeat(maxLength - line.length) + "|";
+            }
+            this.lines[Math.max(0, this.lines.length - 1)] = "\\" +
+                "-".repeat(maxLength + 1) + "/";
+            visitor.restoreState(this);
+            this.pushBlockContentEnd();
+        }
+    }
     document(node) {
         this.pushBlockContentBegin();
         let date;
@@ -642,8 +741,9 @@ export class FixedWidthTextVisitor extends NodeVisitor {
         super.document(node);
         this.horizontalRule({ type: "horizontal-rule" });
         if (this.state.linkCount > 0) {
-            const length = Math.max(7, `[L${this.state.linkCount}]: `.length);
-            for (let i = 1; i <= this.state.linkCount; i++) {
+            const max = this.state.linkCount;
+            const length = Math.max(7, `[L${max}]: `.length);
+            for (let i = 1; i <= max; i++) {
                 const label = `[L${i}]: `;
                 const visitor = new FixedWidthTextVisitor(this.width - length);
                 visitor.text({

package/package.json

@@ -2,7 +2,7 @@
   "module": "./esm/main.js",
   "main": "./script/main.js",
   "name": "text-doc-ir",
-  "version": "0.0.11",
+  "version": "0.0.12",
   "description": "Transforms a document intermediate representation into plain text with formatting",
   "license": "MIT",
   "repository": {
@@ -19,7 +19,7 @@
     }
   },
   "dependencies": {
-    "document-ir": "0.0.14"
+    "document-ir": "0.0.15"
   },
   "devDependencies": {
     "@types/node": "^18.11.9"

package/script/deps.d.ts

@@ -1,2 +1,2 @@
 export { NodeVisitor } from "document-ir";
-export type { BlockQuoteNode, BreakNode, BubbleNode, CardNode, CenterNode, ColumnsNode, DefinitionNode, DefinitionReferenceNode, DocumentNode, EmbedNode, EmojiNode, FigureImageNode, FormattedTextNode, HeaderNode, HighTechAlertNode, HorizontalRuleNode, ImageNode, LinkNode, ListNode, Node, NoteNode, ParagraphNode, QuoteNode, StickerNode, StrikeThroughNode, TextNode, VideoNode, WarningNode, } from "document-ir";
+export type { BlockQuoteNode, BreakNode, BubbleNode, CardNode, CenterNode, ColumnsNode, DefinitionNode, DefinitionReferenceNode, DocumentNode, EmbedNode, EmojiNode, FigureImageNode, FormattedTextNode, HeaderNode, HighTechAlertNode, HorizontalRuleNode, ImageNode, LinkNode, ListNode, Node, NoteNode, ParagraphNode, QuoteNode, StickerNode, StrikeThroughNode, TableOfContentsNode, TextNode, VideoNode, WarningNode, } from "document-ir";

package/script/main.d.ts

@@ -1,4 +1,4 @@
-import { BlockQuoteNode, BreakNode, BubbleNode, CardNode, CenterNode, ColumnsNode, DefinitionNode, DefinitionReferenceNode, DocumentNode, EmbedNode, EmojiNode, FigureImageNode, FormattedTextNode, HeaderNode, HighTechAlertNode, HorizontalRuleNode, ImageNode, LinkNode, ListNode, NodeVisitor, NoteNode, ParagraphNode, QuoteNode, StickerNode, StrikeThroughNode, TextNode, VideoNode, WarningNode } from "./deps.js";
+import { BlockQuoteNode, BreakNode, BubbleNode, CardNode, CenterNode, ColumnsNode, DefinitionNode, DefinitionReferenceNode, DocumentNode, EmbedNode, EmojiNode, FigureImageNode, FormattedTextNode, HeaderNode, HighTechAlertNode, HorizontalRuleNode, ImageNode, LinkNode, ListNode, NodeVisitor, NoteNode, ParagraphNode, QuoteNode, StickerNode, StrikeThroughNode, TableOfContentsNode, TextNode, VideoNode, WarningNode } from "./deps.js";
 export declare class FixedWidthTextVisitor extends NodeVisitor {
     private width;
     private lines;
@@ -10,6 +10,7 @@ export declare class FixedWidthTextVisitor extends NodeVisitor {
     private state;
     constructor(width: number);
     private setState;
+    private restoreState;
     protected text(node: TextNode): void;
     protected formattedText(node: FormattedTextNode): void;
     protected horizontalRule(node: HorizontalRuleNode): void;
@@ -36,6 +37,7 @@ export declare class FixedWidthTextVisitor extends NodeVisitor {
     protected card(node: CardNode): void;
     protected definitionReference(node: DefinitionReferenceNode): void;
     protected definition(node: DefinitionNode): void;
+    protected toc(node: TableOfContentsNode): void;
     protected document(node: DocumentNode): void;
     private counterToDepth;
     private pushBlockContentBegin;

package/script/main.js

@@ -69,11 +69,16 @@ class FixedWidthTextVisitor extends deps_js_1.NodeVisitor {
             linksReverse: new Map(),
             linkCount: 0,
             numericDepth: 0,
+            tocDepth: 0,
         };
     }
     setState(state) {
         this.state = state;
     }
+    restoreState(parent) {
+        parent.state.imageCount = this.state.imageCount;
+        parent.state.linkCount = this.state.linkCount;
+    }
     text(node) {
         this.pushText(node.text);
     }
@@ -136,6 +141,7 @@ class FixedWidthTextVisitor extends deps_js_1.NodeVisitor {
                         }
                     }
                 }
+                visitor.restoreState(this);
             }
         }
         else {
@@ -152,6 +158,7 @@ class FixedWidthTextVisitor extends deps_js_1.NodeVisitor {
                         this.lines.push("     " + lines[i]);
                     }
                 }
+                visitor.restoreState(this);
             }
         }
         this.pushBlockContentEnd();
@@ -178,6 +185,7 @@ class FixedWidthTextVisitor extends deps_js_1.NodeVisitor {
             columns.push(lines);
             maxLines = Math.max(maxLines, lines.length);
             consumedWidth += width;
+            visitor.restoreState(this);
         }
         this.pushBlockContentBegin();
         for (let i = 0; i < maxLines; i++) {
@@ -341,6 +349,7 @@ class FixedWidthTextVisitor extends deps_js_1.NodeVisitor {
             this.lines[Math.max(0, this.lines.length - 1)] =
                 " ".repeat(Math.floor((this.width - line.length) / 2)) + line;
         }
+        visitor.restoreState(this);
         this.pushBlockContentEnd();
     }
     warning(node) {
@@ -355,6 +364,7 @@ class FixedWidthTextVisitor extends deps_js_1.NodeVisitor {
             this.pushEndOfLineIfAnyContent();
             this.lines[Math.max(0, this.lines.length - 1)] = "| " + line;
         }
+        visitor.restoreState(this);
         this.pushBlockContentEnd();
     }
     highTechAlert(node) {
@@ -379,6 +389,7 @@ class FixedWidthTextVisitor extends deps_js_1.NodeVisitor {
             this.pushLine();
             this.pushText("|" + "-".repeat(this.width - 2) + "|");
         }
+        centerVisitor.restoreState(this);
         const contentVisitor = new FixedWidthTextVisitor(this.width - 4);
         contentVisitor.setState({ ...this.state, numericDepth: 0 });
         contentVisitor.visit({
@@ -394,6 +405,7 @@ class FixedWidthTextVisitor extends deps_js_1.NodeVisitor {
         this.pushText("\\");
         this.pushText("-".repeat(this.width - 2));
         this.pushText("/");
+        contentVisitor.restoreState(this);
         this.pushBlockContentEnd();
     }
     blockQuote(node) {
@@ -408,6 +420,7 @@ class FixedWidthTextVisitor extends deps_js_1.NodeVisitor {
             this.pushEndOfLineIfAnyContent();
             this.lines[Math.max(0, this.lines.length - 1)] = "> " + line;
         }
+        visitor.restoreState(this);
         this.pushBlockContentEnd();
     }
     quote(node) {
@@ -427,6 +440,7 @@ class FixedWidthTextVisitor extends deps_js_1.NodeVisitor {
             this.pushEndOfLineIfAnyContent();
             this.lines[Math.max(0, this.lines.length - 1)] = "> " + line;
         }
+        visitor.restoreState(this);
         this.pushBlockContentEnd();
     }
     bubble(node) {
@@ -449,6 +463,7 @@ class FixedWidthTextVisitor extends deps_js_1.NodeVisitor {
                     " ".repeat(this.width - 2 - line.length) + line + " |";
             }
         }
+        visitor.restoreState(this);
         this.pushBlockContentEnd();
     }
     sticker(node) {
@@ -500,6 +515,7 @@ class FixedWidthTextVisitor extends deps_js_1.NodeVisitor {
         this.pushText("\\");
         this.pushText("-".repeat(this.width - 2));
         this.pushText("/");
+        visitor.restoreState(this);
         this.pushBlockContentEnd();
     }
     card(node) {
@@ -537,6 +553,7 @@ class FixedWidthTextVisitor extends deps_js_1.NodeVisitor {
                 this.pushLine();
                 this.pushText("|" + "-".repeat(this.width - 2) + "|");
             }
+            centerVisitor.restoreState(this);
         }
         const contentVisitor = new FixedWidthTextVisitor(this.width - 4);
         contentVisitor.setState({ ...this.state, numericDepth: 0 });
@@ -588,6 +605,7 @@ class FixedWidthTextVisitor extends deps_js_1.NodeVisitor {
         this.pushText("\\");
         this.pushText("-".repeat(this.width - 2));
         this.pushText("/");
+        contentVisitor.restoreState(this);
         this.pushBlockContentEnd();
     }
     definitionReference(node) {
@@ -615,8 +633,89 @@ class FixedWidthTextVisitor extends deps_js_1.NodeVisitor {
             this.pushEndOfLineIfAnyContent();
             this.lines[Math.max(0, this.lines.length - 1)] = "  " + line;
         }
+        visitor.restoreState(this);
         this.pushBlockContentEnd();
     }
+    toc(node) {
+        if (this.state.tocDepth > 0) {
+            const visitor = new FixedWidthTextVisitor(this.width - 3);
+            visitor.setState({ ...this.state, tocDepth: this.state.tocDepth + 1 });
+            if (node.date) {
+                visitor.choose(node.date);
+                visitor.pushText(" ");
+            }
+            visitor.chooseChildren(node.content);
+            if (node.href && !node.href.startsWith("#")) {
+                visitor.link({
+                    type: "link",
+                    url: node.href,
+                    content: [],
+                });
+                visitor.spaceLazy = true;
+            }
+            let counter = 0;
+            for (const line of visitor.getLines()) {
+                this.pushEndOfLineIfAnyContent();
+                // First line gets a bullet point
+                if (counter == 0) {
+                    this.lines[Math.max(0, this.lines.length - 1)] = "* " + line;
+                }
+                else {
+                    this.lines[Math.max(0, this.lines.length - 1)] = "  " + line;
+                }
+                counter++;
+            }
+            visitor.restoreState(this);
+            visitor.visit({
+                type: "array",
+                content: node.children,
+            });
+            for (const line of visitor.getLines()) {
+                this.pushEndOfLineIfAnyContent();
+                this.lines[Math.max(0, this.lines.length - 1)] = " " + line;
+            }
+            visitor.restoreState(this);
+        }
+        else {
+            const visitor = new FixedWidthTextVisitor(this.width - 4);
+            visitor.setState({ ...this.state, tocDepth: this.state.tocDepth + 1 });
+            if (node.date) {
+                visitor.choose(node.date);
+                visitor.pushText(" ");
+            }
+            visitor.chooseChildren(node.content);
+            if (node.href && !node.href.startsWith("#")) {
+                visitor.link({
+                    type: "link",
+                    url: node.href,
+                    content: [],
+                });
+                visitor.spaceLazy = true;
+            }
+            visitor.pushLine();
+            visitor.visit({
+                type: "array",
+                content: node.children,
+            });
+            const tocLen = " Table of contents ".length;
+            const lines = visitor.getLines();
+            const maxLength = lines.reduce((prev, next) => Math.max(prev, next.length + 1), tocLen + 2);
+            const left = Math.floor((maxLength - tocLen) / 2) + 1;
+            const right = maxLength - tocLen - left + 1;
+            this.pushBlockContentBegin();
+            this.lines[Math.max(0, this.lines.length - 1)] = "/" + "-".repeat(left) +
+                " Table of contents " + "-".repeat(right) + "\\";
+            for (const line of visitor.getLines()) {
+                this.pushEndOfLineIfAnyContent();
+                this.lines[Math.max(0, this.lines.length - 1)] = "| " + line +
+                    " ".repeat(maxLength - line.length) + "|";
+            }
+            this.lines[Math.max(0, this.lines.length - 1)] = "\\" +
+                "-".repeat(maxLength + 1) + "/";
+            visitor.restoreState(this);
+            this.pushBlockContentEnd();
+        }
+    }
     document(node) {
         this.pushBlockContentBegin();
         let date;
@@ -645,8 +744,9 @@ class FixedWidthTextVisitor extends deps_js_1.NodeVisitor {
         super.document(node);
         this.horizontalRule({ type: "horizontal-rule" });
         if (this.state.linkCount > 0) {
-            const length = Math.max(7, `[L${this.state.linkCount}]: `.length);
-            for (let i = 1; i <= this.state.linkCount; i++) {
+            const max = this.state.linkCount;
+            const length = Math.max(7, `[L${max}]: `.length);
+            for (let i = 1; i <= max; i++) {
                 const label = `[L${i}]: `;
                 const visitor = new FixedWidthTextVisitor(this.width - length);
                 visitor.text({