document-ir 0.5.4 → 0.6.0

package/dist/DocumentThinningTransformer.d.ts

@@ -1,5 +1,5 @@
 import { ArrayCollapseTransformer } from './ArrayCollapseTransformer.ts';
-import { BubbleNode, CardNode, ColumnsNode, DefinitionListNode, FigureImageNode, HighTechAlertNode, ImageNode, Node, NoteNode, QuoteNode, RedactedNode, StickerNode, VideoNode } from './types.ts';
+import { AdmonitionNode, BubbleNode, CardNode, ColumnsNode, DefinitionListNode, FigureImageNode, HighTechAlertNode, ImageNode, Node, NoteNode, QuoteNode, RedactedNode, StickerNode, VideoNode } from './types.ts';
 export declare class DocumentThinningTransformer extends ArrayCollapseTransformer {
     protected sticker(node: StickerNode): Promise<Node | null>;
     protected bubble(node: BubbleNode): Promise<Node | null>;
@@ -11,6 +11,7 @@ export declare class DocumentThinningTransformer extends ArrayCollapseTransforme
     protected video(node: VideoNode): Promise<Node | null>;
     protected definitionList(node: DefinitionListNode): Promise<Node | null>;
     protected redacted(_node: RedactedNode): Promise<Node | null>;
+    protected admonition(node: AdmonitionNode): Promise<Node | null>;
     protected note(node: NoteNode): Promise<Node | null>;
     protected card(node: CardNode): Promise<Node | null>;
 }

package/dist/IdentityTransformer.d.ts

@@ -1,4 +1,4 @@
-import { AccordionGroupNode, AccordionTabNode, ArrayNode, BadgeNode, BlockNode, BlockQuoteNode, BoldNode, BreakNode, BubbleNode, CardNode, CenterNode, CodeNode, CodeBlockNode, CodeGroupNode, CodeGroupTabNode, ColumnsNode, DateNode, DateTimeNode, DefinitionListNode, DefinitionNode, DefinitionReferenceNode, DocumentNode, EmbedNode, EmojiNode, FigureCaptionNode, FigureImageNode, FigureNode, FootnoteNode, FootnoteDisplayNode, FormattedTextNode, HeaderNode, HighTechAlertNode, HorizontalRuleNode, ImageNode, ItalicNode, LinkNode, ListNode, Node, NoteNode, PillNode, TimeRangeNode, ParagraphNode, QuoteNode, RedactedNode, RegionNode, ScriptNode, SecretNode, StyleNode, SmallerNode, SocialNode, StandardNode, StickerNode, StrikeThroughNode, SubTextNode, SuperTextNode, TableNode, TableOfContentsNode, TextNode, TimeNode, UnderlineNode, VideoNode, WarningNode } from './types.ts';
+import { AccordionGroupNode, AccordionTabNode, AdmonitionNode, ArrayNode, BadgeNode, BlockNode, BlockQuoteNode, BoldNode, BreakNode, BubbleNode, CardNode, CenterNode, CodeNode, CodeBlockNode, CodeGroupNode, CodeGroupTabNode, ColumnsNode, DateNode, DateTimeNode, DefinitionListNode, DefinitionNode, DefinitionReferenceNode, DocumentNode, EmbedNode, EmojiNode, FigureCaptionNode, FigureImageNode, FigureNode, FootnoteNode, FootnoteDisplayNode, FormattedTextNode, HeaderNode, HighTechAlertNode, HorizontalRuleNode, ImageNode, ItalicNode, LinkNode, ListNode, Node, NoteNode, PillNode, TimeRangeNode, ParagraphNode, QuoteNode, RedactedNode, RegionNode, ScriptNode, SecretNode, StyleNode, SmallerNode, SocialNode, StandardNode, StickerNode, StrikeThroughNode, SubTextNode, SuperTextNode, TableNode, TableOfContentsNode, TextNode, TimeNode, UnderlineNode, VideoNode, WarningNode } from './types.ts';
 export declare class IdentityTransformer {
     protected beforeBlock(): Promise<void>;
     protected afterBlock(): Promise<void>;
@@ -36,6 +36,7 @@ export declare class IdentityTransformer {
     protected image(node: ImageNode): Promise<Node | null>;
     protected italic(node: ItalicNode): Promise<Node | null>;
     protected link(node: LinkNode): Promise<Node | null>;
+    protected admonition(node: AdmonitionNode): Promise<Node | null>;
     protected array(node: ArrayNode): Promise<Node | null>;
     protected note(node: NoteNode): Promise<Node | null>;
     protected list(node: ListNode): Promise<Node | null>;

package/dist/NodeVisitor.d.ts

@@ -1,4 +1,4 @@
-import { AccordionGroupNode, AccordionTabNode, ArrayNode, BadgeNode, BlockNode, BlockQuoteNode, BoldNode, BreakNode, BubbleNode, CardNode, CenterNode, CodeNode, CodeBlockNode, CodeGroupNode, CodeGroupTabNode, ColumnsNode, PillNode, StyleNode, DateNode, DateTimeNode, DefinitionListNode, DefinitionNode, DefinitionReferenceNode, DocumentNode, EmbedNode, EmojiNode, FigureCaptionNode, FigureImageNode, FigureNode, FootnoteNode, FootnoteDisplayNode, FormattedTextNode, HeaderNode, HighTechAlertNode, HorizontalRuleNode, ImageNode, ItalicNode, LinkNode, ListNode, Node, NoteNode, TimeRangeNode, ParagraphNode, QuoteNode, RedactedNode, RegionNode, ScriptNode, SecretNode, SmallerNode, SocialNode, StandardNode, StickerNode, StrikeThroughNode, SubTextNode, SuperTextNode, TableNode, TableOfContentsNode, TextNode, TimeNode, UnderlineNode, VideoNode, WarningNode } from './types.ts';
+import { AccordionGroupNode, AccordionTabNode, AdmonitionNode, ArrayNode, BadgeNode, BlockNode, BlockQuoteNode, BoldNode, BreakNode, BubbleNode, CardNode, CenterNode, CodeNode, CodeBlockNode, CodeGroupNode, CodeGroupTabNode, ColumnsNode, PillNode, StyleNode, DateNode, DateTimeNode, DefinitionListNode, DefinitionNode, DefinitionReferenceNode, DocumentNode, EmbedNode, EmojiNode, FigureCaptionNode, FigureImageNode, FigureNode, FootnoteNode, FootnoteDisplayNode, FormattedTextNode, HeaderNode, HighTechAlertNode, HorizontalRuleNode, ImageNode, ItalicNode, LinkNode, ListNode, Node, NoteNode, TimeRangeNode, ParagraphNode, QuoteNode, RedactedNode, RegionNode, ScriptNode, SecretNode, SmallerNode, SocialNode, StandardNode, StickerNode, StrikeThroughNode, SubTextNode, SuperTextNode, TableNode, TableOfContentsNode, TextNode, TimeNode, UnderlineNode, VideoNode, WarningNode } from './types.ts';
 export declare class NodeVisitor {
     protected beforeBlock(): void;
     protected afterBlock(): void;
@@ -38,6 +38,7 @@ export declare class NodeVisitor {
     protected image(_node: ImageNode): void;
     protected italic(node: ItalicNode): void;
     protected link(node: LinkNode): void;
+    protected admonition(node: AdmonitionNode): void;
     protected array(node: ArrayNode): void;
     protected note(node: NoteNode): void;
     protected list(node: ListNode): void;

package/dist/index.js

@@ -1,5 +1,5 @@
-var y = Object.defineProperty;
-var k = (c, t, e) => t in c ? y(c, t, { enumerable: !0, configurable: !0, writable: !0, value: e }) : c[t] = e;
+var d = Object.defineProperty;
+var k = (c, t, e) => t in c ? d(c, t, { enumerable: !0, configurable: !0, writable: !0, value: e }) : c[t] = e;
 var h = (c, t, e) => k(c, typeof t != "symbol" ? t + "" : t, e);
 class u {
   async beforeBlock() {
@@ -338,6 +338,18 @@ class u {
     };
     return t.id != null && (i.id = t.id), t.title && (i.title = t.title), t.target && (i.target = t.target), t.userGeneratedContent && (i.userGeneratedContent = t.userGeneratedContent), t.noReferrer && (i.noReferrer = t.noReferrer), t.noFollow && (i.noFollow = t.noFollow), t.noOpener && (i.noOpener = t.noOpener), i;
   }
+  async admonition(t) {
+    await this.beforeBlock();
+    const e = await this.chooseChildren(t.content);
+    let i;
+    t.title && (i = await this.chooseChildren(t.title)), await this.afterBlock();
+    const s = {
+      type: "admonition",
+      admonitionType: t.admonitionType,
+      content: e
+    };
+    return i && (s.title = i), t.collapsable != null && (s.collapsable = t.collapsable), t.collapsed != null && (s.collapsed = t.collapsed), t.inline != null && (s.inline = t.inline), t.id != null && (s.id = t.id), s;
+  }
   async array(t) {
     const e = {
       type: "array",
@@ -767,6 +779,8 @@ class u {
           return await this.link(t);
         case "accordion-group":
           return await this.accordionGroup(t);
+        case "admonition":
+          return await this.admonition(t);
         case "array":
           return await this.array(t);
         case "note":
@@ -1133,6 +1147,9 @@ class w {
   link(t) {
     this.beforeInline(), this.chooseChildren(t.content), this.afterInline();
   }
+  admonition(t) {
+    this.beforeBlock(), t.title && this.chooseChildren(t.title), this.chooseChildren(t.content), this.afterBlock();
+  }
   array(t) {
     this.chooseChildren(t.content);
   }
@@ -1245,6 +1262,8 @@ class w {
           return this.codeGroup(t);
         case "accordion-group":
           return this.accordionGroup(t);
+        case "admonition":
+          return this.admonition(t);
         case "pill":
           return this.pill(t);
         case "style":
@@ -1533,6 +1552,18 @@ class C extends g {
   async redacted(t) {
     return null;
   }
+  async admonition(t) {
+    if (t.content.length == 0)
+      return null;
+    const e = await this.chooseChildren(t.content);
+    return e ? {
+      type: "paragraph",
+      content: [
+        { type: "text", text: `${t.admonitionType.charAt(0).toUpperCase() + t.admonitionType.slice(1)}: ` },
+        ...e
+      ]
+    } : null;
+  }
   async note(t) {
     if (t.content.length == 0)
       return null;
@@ -1608,7 +1639,7 @@ class x extends w {
     return this.countText(), this.count;
   }
 }
-function d(c) {
+function y(c) {
   const t = {
     headerText: c.header,
     headerId: c.headerId,
@@ -1620,7 +1651,7 @@ function d(c) {
     e.visit(i);
   t.words = e.getCount(), t.totalWords = t.words;
   for (const i of c.children) {
-    const s = d(i);
+    const s = y(i);
     t.children.push(s), t.totalWords += s.totalWords;
   }
   return t;
@@ -1660,7 +1691,7 @@ class _ extends u {
     const a = {
       ...t
     };
-    return a.hierarchy = d(r), a;
+    return a.hierarchy = y(r), a;
   }
 }
 export {

package/dist/types.d.ts

@@ -1,6 +1,16 @@
 export interface NodeIdentity {
     id?: string;
 }
+export type AdmonitionType = "note" | "tip" | "info" | "warning" | "danger";
+export interface AdmonitionNode extends NodeIdentity {
+    type: "admonition";
+    admonitionType: AdmonitionType;
+    content: Node[];
+    title?: Node[];
+    collapsable?: boolean;
+    collapsed?: boolean;
+    inline?: boolean;
+}
 export interface ArrayNode extends NodeIdentity {
     type: "array";
     content: Node[];
@@ -397,7 +407,7 @@ export interface TableOfContentsNode extends NodeIdentity {
     content: Node[];
     children: TableOfContentsNode[];
 }
-export type Node = AccordionGroupNode | ArrayNode | BadgeNode | BlockNode | BlockQuoteNode | BoldNode | BreakNode | BubbleNode | CardNode | CenterNode | CodeNode | CodeBlockNode | CodeGroupNode | ColumnsNode | DefinitionNode | DefinitionListNode | DefinitionReferenceNode | EmbedNode | EmojiNode | FigureNode | FigureCaptionNode | FigureImageNode | FootnoteNode | FootnoteDisplayNode | FormattedTextNode | HeaderNode | HighTechAlertNode | HorizontalRuleNode | ImageNode | ItalicNode | LinkNode | ListNode | NoteNode | ParagraphNode | PillNode | QuoteNode | RedactedNode | RegionNode | ScriptNode | SecretNode | StyleNode | SmallerNode | StickerNode | StrikeThroughNode | TextNode | TableNode | SocialNode | UnderlineNode | VideoNode | DateNode | TimeNode | DateTimeNode | SuperTextNode | SubTextNode | TableOfContentsNode | TimeRangeNode | StandardNode | WarningNode;
+export type Node = AccordionGroupNode | AdmonitionNode | ArrayNode | BadgeNode | BlockNode | BlockQuoteNode | BoldNode | BreakNode | BubbleNode | CardNode | CenterNode | CodeNode | CodeBlockNode | CodeGroupNode | ColumnsNode | DefinitionNode | DefinitionListNode | DefinitionReferenceNode | EmbedNode | EmojiNode | FigureNode | FigureCaptionNode | FigureImageNode | FootnoteNode | FootnoteDisplayNode | FormattedTextNode | HeaderNode | HighTechAlertNode | HorizontalRuleNode | ImageNode | ItalicNode | LinkNode | ListNode | NoteNode | ParagraphNode | PillNode | QuoteNode | RedactedNode | RegionNode | ScriptNode | SecretNode | StyleNode | SmallerNode | StickerNode | StrikeThroughNode | TextNode | TableNode | SocialNode | UnderlineNode | VideoNode | DateNode | TimeNode | DateTimeNode | SuperTextNode | SubTextNode | TableOfContentsNode | TimeRangeNode | StandardNode | WarningNode;
 export interface DocumentMeta {
     hidden?: boolean;
     noindex?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "document-ir",
-  "version": "0.5.4",
+  "version": "0.6.0",
   "type": "module",
   "license": "MIT",
   "main": "./dist/index.js",