document-ir 0.0.13 → 0.0.15

package/esm/IdentityTransformer.d.ts

@@ -1,4 +1,4 @@
-import { ArrayNode, BlockNode, BlockQuoteNode, BoldNode, BreakNode, BubbleNode, CardNode, CenterNode, CodeNode, ColumnsNode, DateNode, DateTimeNode, DefinitionListNode, DefinitionNode, DefinitionReferenceNode, DocumentNode, EmbedNode, EmojiNode, FigureCaptionNode, FigureImageNode, FigureNode, FormattedTextNode, HeaderNode, HighTechAlertNode, HorizontalRuleNode, ImageNode, ItalicNode, LinkNode, ListNode, Node, NoteNode, ParagraphNode, QuoteNode, RedactedNode, RegionNode, ScriptNode, SecretNode, SmallerNode, SocialNode, StickerNode, StrikeThroughNode, SubTextNode, SuperTextNode, TableNode, TextNode, TimeNode, UnderlineNode, VideoNode, WarningNode } from "./types.js";
+import { ArrayNode, BlockNode, BlockQuoteNode, BoldNode, BreakNode, BubbleNode, CardNode, CenterNode, CodeNode, ColumnsNode, DateNode, DateTimeNode, DefinitionListNode, DefinitionNode, DefinitionReferenceNode, DocumentNode, EmbedNode, EmojiNode, FigureCaptionNode, FigureImageNode, FigureNode, FormattedTextNode, HeaderNode, HighTechAlertNode, HorizontalRuleNode, ImageNode, ItalicNode, LinkNode, ListNode, Node, NoteNode, ParagraphNode, QuoteNode, RedactedNode, RegionNode, ScriptNode, SecretNode, SmallerNode, SocialNode, StickerNode, StrikeThroughNode, SubTextNode, SuperTextNode, TableNode, TableOfContentsNode, TextNode, TimeNode, UnderlineNode, VideoNode, WarningNode } from "./types.js";
 export declare class IdentityTransformer {
     protected beforeBlock(): Promise<void>;
     protected afterBlock(): Promise<void>;
@@ -52,6 +52,7 @@ export declare class IdentityTransformer {
     protected datetime(node: DateTimeNode): Promise<Node | null>;
     protected subText(node: SubTextNode): Promise<Node | null>;
     protected superText(node: SuperTextNode): Promise<Node | null>;
+    protected toc(node: TableOfContentsNode): Promise<Node | null>;
     protected choose(node: Node): Promise<Node | null>;
     protected document(node: DocumentNode): Promise<DocumentNode>;
     transform(node: DocumentNode): Promise<DocumentNode>;

package/esm/IdentityTransformer.js

@@ -669,6 +669,32 @@ export class IdentityTransformer {
             content,
         };
     }
+    async toc(node) {
+        await this.beforeBlock();
+        const content = await this.chooseChildren(node.content);
+        const date = node.date && await this.choose(node.date);
+        await this.afterBlock();
+        await this.beforeBlock();
+        const mixedChildren = await this.chooseChildren(node.children);
+        await this.afterBlock();
+        const children = mixedChildren.filter((x) => x.type == "toc");
+        const result = {
+            type: "toc",
+            content,
+            children,
+        };
+        if (date &&
+            (date.type == "date" || date.type == "time" || date.type == "datetime")) {
+            result.date = date;
+        }
+        if (node.href) {
+            result.href = node.href;
+        }
+        if (node.hrefHtmlId) {
+            result.hrefHtmlId = node.hrefHtmlId;
+        }
+        return result;
+    }
     async choose(node) {
         if (!node || !node.type) {
             throw new Error(`Unexpected node, no type: ${JSON.stringify(node)}`);
@@ -772,6 +798,8 @@ export class IdentityTransformer {
                     return await this.superText(node);
                 case "sub":
                     return await this.subText(node);
+                case "toc":
+                    return await this.toc(node);
             }
         }
         catch (e) {
@@ -827,6 +855,9 @@ export class IdentityTransformer {
         if (node.hidden) {
             result.hidden = node.hidden;
         }
+        if (node.readingDifficultyMultiplier) {
+            result.readingDifficultyMultiplier = node.readingDifficultyMultiplier;
+        }
         return result;
     }
     async transform(node) {

package/esm/NodeVisitor.d.ts

@@ -1,4 +1,4 @@
-import { ArrayNode, BlockNode, BlockQuoteNode, BoldNode, BreakNode, BubbleNode, CardNode, CenterNode, CodeNode, ColumnsNode, DateNode, DateTimeNode, DefinitionListNode, DefinitionNode, DefinitionReferenceNode, DocumentNode, EmbedNode, EmojiNode, FigureCaptionNode, FigureImageNode, FigureNode, FormattedTextNode, HeaderNode, HighTechAlertNode, HorizontalRuleNode, ImageNode, ItalicNode, LinkNode, ListNode, Node, NoteNode, ParagraphNode, QuoteNode, RedactedNode, RegionNode, ScriptNode, SecretNode, SmallerNode, SocialNode, StickerNode, StrikeThroughNode, SubTextNode, SuperTextNode, TableNode, TextNode, TimeNode, UnderlineNode, VideoNode, WarningNode } from "./types.js";
+import { ArrayNode, BlockNode, BlockQuoteNode, BoldNode, BreakNode, BubbleNode, CardNode, CenterNode, CodeNode, ColumnsNode, DateNode, DateTimeNode, DefinitionListNode, DefinitionNode, DefinitionReferenceNode, DocumentNode, EmbedNode, EmojiNode, FigureCaptionNode, FigureImageNode, FigureNode, FormattedTextNode, HeaderNode, HighTechAlertNode, HorizontalRuleNode, ImageNode, ItalicNode, LinkNode, ListNode, Node, NoteNode, ParagraphNode, QuoteNode, RedactedNode, RegionNode, ScriptNode, SecretNode, SmallerNode, SocialNode, StickerNode, StrikeThroughNode, SubTextNode, SuperTextNode, TableNode, TableOfContentsNode, TextNode, TimeNode, UnderlineNode, VideoNode, WarningNode } from "./types.js";
 export declare class NodeVisitor {
     protected beforeBlock(): void;
     protected afterBlock(): void;
@@ -52,6 +52,7 @@ export declare class NodeVisitor {
     protected datetime(node: DateTimeNode): void;
     protected subText(node: SubTextNode): void;
     protected superText(node: SuperTextNode): void;
+    protected toc(node: TableOfContentsNode): void;
     protected choose(node: Node): void;
     protected document(node: DocumentNode): void;
     visit(node: DocumentNode | Node): void;

package/esm/NodeVisitor.js

@@ -271,6 +271,14 @@ export class NodeVisitor {
         this.chooseChildren(node.content);
         this.afterInline();
     }
+    toc(node) {
+        this.beforeBlock();
+        this.chooseChildren(node.content);
+        this.afterBlock();
+        this.beforeBlock();
+        this.chooseChildren(node.children);
+        this.afterBlock();
+    }
     choose(node) {
         if (!node || !node.type) {
             throw new Error(`Unexpected node, no type: ${JSON.stringify(node)}`);
@@ -374,6 +382,8 @@ export class NodeVisitor {
                     return this.subText(node);
                 case "super":
                     return this.superText(node);
+                case "toc":
+                    return this.toc(node);
             }
         }
         catch (e) {

package/esm/TextVisitor.d.ts

@@ -1,4 +1,4 @@
-import { DefinitionNode, DefinitionReferenceNode, EmojiNode, FigureImageNode, ImageNode, TextNode, VideoNode } from "./types.js";
+import { DefinitionNode, DefinitionReferenceNode, EmojiNode, FigureImageNode, ImageNode, TableOfContentsNode, TextNode, VideoNode } from "./types.js";
 import { NodeVisitor } from "./NodeVisitor.js";
 export declare class TextVisitor extends NodeVisitor {
     private textList;
@@ -10,5 +10,6 @@ export declare class TextVisitor extends NodeVisitor {
     protected figureImage(node: FigureImageNode): void;
     protected definitionReference(node: DefinitionReferenceNode): void;
     protected definition(node: DefinitionNode): void;
+    protected toc(node: TableOfContentsNode): void;
     getText(): string;
 }

package/esm/TextVisitor.js

@@ -40,6 +40,15 @@ export class TextVisitor extends NodeVisitor {
         this.textList.push("): ");
         this.chooseChildren(node.content);
     }
+    toc(node) {
+        if (node.date) {
+            this.choose(node.date);
+            this.textList.push(" ");
+        }
+        this.chooseChildren(node.content);
+        this.textList.push("\n");
+        this.chooseChildren(node.children);
+    }
     getText() {
         return this.textList.join("");
     }

package/esm/types.d.ts

@@ -313,7 +313,15 @@ export interface DateTimeNode {
     iso8601: string;
     content: Node[];
 }
-export type Node = ArrayNode | BlockNode | BlockQuoteNode | BoldNode | BreakNode | BubbleNode | CardNode | CenterNode | CodeNode | ColumnsNode | DefinitionNode | DefinitionListNode | DefinitionReferenceNode | EmbedNode | EmojiNode | FigureNode | FigureCaptionNode | FigureImageNode | FormattedTextNode | HeaderNode | HighTechAlertNode | HorizontalRuleNode | ImageNode | ItalicNode | LinkNode | ListNode | NoteNode | ParagraphNode | QuoteNode | RedactedNode | RegionNode | ScriptNode | SecretNode | SmallerNode | StickerNode | StrikeThroughNode | TextNode | TableNode | SocialNode | UnderlineNode | VideoNode | DateNode | TimeNode | DateTimeNode | SuperTextNode | SubTextNode | WarningNode;
+export interface TableOfContentsNode {
+    type: "toc";
+    date?: DateTimeNode | DateNode | TimeNode;
+    href?: string;
+    hrefHtmlId?: string;
+    content: Node[];
+    children: TableOfContentsNode[];
+}
+export type Node = ArrayNode | BlockNode | BlockQuoteNode | BoldNode | BreakNode | BubbleNode | CardNode | CenterNode | CodeNode | ColumnsNode | DefinitionNode | DefinitionListNode | DefinitionReferenceNode | EmbedNode | EmojiNode | FigureNode | FigureCaptionNode | FigureImageNode | FormattedTextNode | HeaderNode | HighTechAlertNode | HorizontalRuleNode | ImageNode | ItalicNode | LinkNode | ListNode | NoteNode | ParagraphNode | QuoteNode | RedactedNode | RegionNode | ScriptNode | SecretNode | SmallerNode | StickerNode | StrikeThroughNode | TextNode | TableNode | SocialNode | UnderlineNode | VideoNode | DateNode | TimeNode | DateTimeNode | SuperTextNode | SubTextNode | TableOfContentsNode | WarningNode;
 export interface DocumentMeta {
     hidden?: boolean;
     noindex?: boolean;
@@ -326,6 +334,7 @@ export interface DocumentMeta {
     date?: string;
     url: string;
     contentDigest?: string;
+    readingDifficultyMultiplier?: number;
 }
 export interface DocumentHierarchy {
     headerText: string;

package/package.json

@@ -2,7 +2,7 @@
   "module": "./esm/index.js",
   "main": "./script/index.js",
   "name": "document-ir",
-  "version": "0.0.13",
+  "version": "0.0.15",
   "description": "Intermediate representation and transformers for documents",
   "license": "MIT",
   "repository": {

package/script/IdentityTransformer.d.ts

@@ -1,4 +1,4 @@
-import { ArrayNode, BlockNode, BlockQuoteNode, BoldNode, BreakNode, BubbleNode, CardNode, CenterNode, CodeNode, ColumnsNode, DateNode, DateTimeNode, DefinitionListNode, DefinitionNode, DefinitionReferenceNode, DocumentNode, EmbedNode, EmojiNode, FigureCaptionNode, FigureImageNode, FigureNode, FormattedTextNode, HeaderNode, HighTechAlertNode, HorizontalRuleNode, ImageNode, ItalicNode, LinkNode, ListNode, Node, NoteNode, ParagraphNode, QuoteNode, RedactedNode, RegionNode, ScriptNode, SecretNode, SmallerNode, SocialNode, StickerNode, StrikeThroughNode, SubTextNode, SuperTextNode, TableNode, TextNode, TimeNode, UnderlineNode, VideoNode, WarningNode } from "./types.js";
+import { ArrayNode, BlockNode, BlockQuoteNode, BoldNode, BreakNode, BubbleNode, CardNode, CenterNode, CodeNode, ColumnsNode, DateNode, DateTimeNode, DefinitionListNode, DefinitionNode, DefinitionReferenceNode, DocumentNode, EmbedNode, EmojiNode, FigureCaptionNode, FigureImageNode, FigureNode, FormattedTextNode, HeaderNode, HighTechAlertNode, HorizontalRuleNode, ImageNode, ItalicNode, LinkNode, ListNode, Node, NoteNode, ParagraphNode, QuoteNode, RedactedNode, RegionNode, ScriptNode, SecretNode, SmallerNode, SocialNode, StickerNode, StrikeThroughNode, SubTextNode, SuperTextNode, TableNode, TableOfContentsNode, TextNode, TimeNode, UnderlineNode, VideoNode, WarningNode } from "./types.js";
 export declare class IdentityTransformer {
     protected beforeBlock(): Promise<void>;
     protected afterBlock(): Promise<void>;
@@ -52,6 +52,7 @@ export declare class IdentityTransformer {
     protected datetime(node: DateTimeNode): Promise<Node | null>;
     protected subText(node: SubTextNode): Promise<Node | null>;
     protected superText(node: SuperTextNode): Promise<Node | null>;
+    protected toc(node: TableOfContentsNode): Promise<Node | null>;
     protected choose(node: Node): Promise<Node | null>;
     protected document(node: DocumentNode): Promise<DocumentNode>;
     transform(node: DocumentNode): Promise<DocumentNode>;

package/script/IdentityTransformer.js

@@ -672,6 +672,32 @@ class IdentityTransformer {
             content,
         };
     }
+    async toc(node) {
+        await this.beforeBlock();
+        const content = await this.chooseChildren(node.content);
+        const date = node.date && await this.choose(node.date);
+        await this.afterBlock();
+        await this.beforeBlock();
+        const mixedChildren = await this.chooseChildren(node.children);
+        await this.afterBlock();
+        const children = mixedChildren.filter((x) => x.type == "toc");
+        const result = {
+            type: "toc",
+            content,
+            children,
+        };
+        if (date &&
+            (date.type == "date" || date.type == "time" || date.type == "datetime")) {
+            result.date = date;
+        }
+        if (node.href) {
+            result.href = node.href;
+        }
+        if (node.hrefHtmlId) {
+            result.hrefHtmlId = node.hrefHtmlId;
+        }
+        return result;
+    }
     async choose(node) {
         if (!node || !node.type) {
             throw new Error(`Unexpected node, no type: ${JSON.stringify(node)}`);
@@ -775,6 +801,8 @@ class IdentityTransformer {
                     return await this.superText(node);
                 case "sub":
                     return await this.subText(node);
+                case "toc":
+                    return await this.toc(node);
             }
         }
         catch (e) {
@@ -830,6 +858,9 @@ class IdentityTransformer {
         if (node.hidden) {
             result.hidden = node.hidden;
         }
+        if (node.readingDifficultyMultiplier) {
+            result.readingDifficultyMultiplier = node.readingDifficultyMultiplier;
+        }
         return result;
     }
     async transform(node) {

package/script/NodeVisitor.d.ts

@@ -1,4 +1,4 @@
-import { ArrayNode, BlockNode, BlockQuoteNode, BoldNode, BreakNode, BubbleNode, CardNode, CenterNode, CodeNode, ColumnsNode, DateNode, DateTimeNode, DefinitionListNode, DefinitionNode, DefinitionReferenceNode, DocumentNode, EmbedNode, EmojiNode, FigureCaptionNode, FigureImageNode, FigureNode, FormattedTextNode, HeaderNode, HighTechAlertNode, HorizontalRuleNode, ImageNode, ItalicNode, LinkNode, ListNode, Node, NoteNode, ParagraphNode, QuoteNode, RedactedNode, RegionNode, ScriptNode, SecretNode, SmallerNode, SocialNode, StickerNode, StrikeThroughNode, SubTextNode, SuperTextNode, TableNode, TextNode, TimeNode, UnderlineNode, VideoNode, WarningNode } from "./types.js";
+import { ArrayNode, BlockNode, BlockQuoteNode, BoldNode, BreakNode, BubbleNode, CardNode, CenterNode, CodeNode, ColumnsNode, DateNode, DateTimeNode, DefinitionListNode, DefinitionNode, DefinitionReferenceNode, DocumentNode, EmbedNode, EmojiNode, FigureCaptionNode, FigureImageNode, FigureNode, FormattedTextNode, HeaderNode, HighTechAlertNode, HorizontalRuleNode, ImageNode, ItalicNode, LinkNode, ListNode, Node, NoteNode, ParagraphNode, QuoteNode, RedactedNode, RegionNode, ScriptNode, SecretNode, SmallerNode, SocialNode, StickerNode, StrikeThroughNode, SubTextNode, SuperTextNode, TableNode, TableOfContentsNode, TextNode, TimeNode, UnderlineNode, VideoNode, WarningNode } from "./types.js";
 export declare class NodeVisitor {
     protected beforeBlock(): void;
     protected afterBlock(): void;
@@ -52,6 +52,7 @@ export declare class NodeVisitor {
     protected datetime(node: DateTimeNode): void;
     protected subText(node: SubTextNode): void;
     protected superText(node: SuperTextNode): void;
+    protected toc(node: TableOfContentsNode): void;
     protected choose(node: Node): void;
     protected document(node: DocumentNode): void;
     visit(node: DocumentNode | Node): void;

package/script/NodeVisitor.js

@@ -274,6 +274,14 @@ class NodeVisitor {
         this.chooseChildren(node.content);
         this.afterInline();
     }
+    toc(node) {
+        this.beforeBlock();
+        this.chooseChildren(node.content);
+        this.afterBlock();
+        this.beforeBlock();
+        this.chooseChildren(node.children);
+        this.afterBlock();
+    }
     choose(node) {
         if (!node || !node.type) {
             throw new Error(`Unexpected node, no type: ${JSON.stringify(node)}`);
@@ -377,6 +385,8 @@ class NodeVisitor {
                     return this.subText(node);
                 case "super":
                     return this.superText(node);
+                case "toc":
+                    return this.toc(node);
             }
         }
         catch (e) {

package/script/TextVisitor.d.ts

@@ -1,4 +1,4 @@
-import { DefinitionNode, DefinitionReferenceNode, EmojiNode, FigureImageNode, ImageNode, TextNode, VideoNode } from "./types.js";
+import { DefinitionNode, DefinitionReferenceNode, EmojiNode, FigureImageNode, ImageNode, TableOfContentsNode, TextNode, VideoNode } from "./types.js";
 import { NodeVisitor } from "./NodeVisitor.js";
 export declare class TextVisitor extends NodeVisitor {
     private textList;
@@ -10,5 +10,6 @@ export declare class TextVisitor extends NodeVisitor {
     protected figureImage(node: FigureImageNode): void;
     protected definitionReference(node: DefinitionReferenceNode): void;
     protected definition(node: DefinitionNode): void;
+    protected toc(node: TableOfContentsNode): void;
     getText(): string;
 }

package/script/TextVisitor.js

@@ -43,6 +43,15 @@ class TextVisitor extends NodeVisitor_js_1.NodeVisitor {
         this.textList.push("): ");
         this.chooseChildren(node.content);
     }
+    toc(node) {
+        if (node.date) {
+            this.choose(node.date);
+            this.textList.push(" ");
+        }
+        this.chooseChildren(node.content);
+        this.textList.push("\n");
+        this.chooseChildren(node.children);
+    }
     getText() {
         return this.textList.join("");
     }

package/script/types.d.ts

@@ -313,7 +313,15 @@ export interface DateTimeNode {
     iso8601: string;
     content: Node[];
 }
-export type Node = ArrayNode | BlockNode | BlockQuoteNode | BoldNode | BreakNode | BubbleNode | CardNode | CenterNode | CodeNode | ColumnsNode | DefinitionNode | DefinitionListNode | DefinitionReferenceNode | EmbedNode | EmojiNode | FigureNode | FigureCaptionNode | FigureImageNode | FormattedTextNode | HeaderNode | HighTechAlertNode | HorizontalRuleNode | ImageNode | ItalicNode | LinkNode | ListNode | NoteNode | ParagraphNode | QuoteNode | RedactedNode | RegionNode | ScriptNode | SecretNode | SmallerNode | StickerNode | StrikeThroughNode | TextNode | TableNode | SocialNode | UnderlineNode | VideoNode | DateNode | TimeNode | DateTimeNode | SuperTextNode | SubTextNode | WarningNode;
+export interface TableOfContentsNode {
+    type: "toc";
+    date?: DateTimeNode | DateNode | TimeNode;
+    href?: string;
+    hrefHtmlId?: string;
+    content: Node[];
+    children: TableOfContentsNode[];
+}
+export type Node = ArrayNode | BlockNode | BlockQuoteNode | BoldNode | BreakNode | BubbleNode | CardNode | CenterNode | CodeNode | ColumnsNode | DefinitionNode | DefinitionListNode | DefinitionReferenceNode | EmbedNode | EmojiNode | FigureNode | FigureCaptionNode | FigureImageNode | FormattedTextNode | HeaderNode | HighTechAlertNode | HorizontalRuleNode | ImageNode | ItalicNode | LinkNode | ListNode | NoteNode | ParagraphNode | QuoteNode | RedactedNode | RegionNode | ScriptNode | SecretNode | SmallerNode | StickerNode | StrikeThroughNode | TextNode | TableNode | SocialNode | UnderlineNode | VideoNode | DateNode | TimeNode | DateTimeNode | SuperTextNode | SubTextNode | TableOfContentsNode | WarningNode;
 export interface DocumentMeta {
     hidden?: boolean;
     noindex?: boolean;
@@ -326,6 +334,7 @@ export interface DocumentMeta {
     date?: string;
     url: string;
     contentDigest?: string;
+    readingDifficultyMultiplier?: number;
 }
 export interface DocumentHierarchy {
     headerText: string;