@willwang-io/react-djot 0.1.5 → 0.1.6

package/dist/index.d.ts

@@ -2,6 +2,7 @@ import React from 'react';
 
 type DjotAttributes = Record<string, string>;
 interface DjotBaseNode {
+    autoAttributes?: DjotAttributes;
     attributes?: DjotAttributes;
     tag: string;
 }
@@ -9,13 +10,12 @@ interface DjotParentNode extends DjotBaseNode {
     children: DjotNode[];
 }
 interface DjotDocNode extends DjotParentNode {
-    autoReferences?: Record<string, unknown>;
+    autoReferences?: Record<string, DjotReferenceNode>;
     footnotes?: Record<string, DjotFootnoteNode>;
-    references?: Record<string, unknown>;
+    references?: Record<string, DjotReferenceNode>;
     tag: "doc";
 }
 interface DjotSectionNode extends DjotParentNode {
-    autoAttributes?: DjotAttributes;
     tag: "section";
 }
 interface DjotDivNode extends DjotParentNode {
@@ -55,6 +55,9 @@ interface DjotInsertNode extends DjotParentNode {
 interface DjotDeleteNode extends DjotParentNode {
     tag: "delete";
 }
+interface DjotSpanNode extends DjotParentNode {
+    tag: "span";
+}
 type DjotTableAlignment = "default" | "left" | "right" | "center" | (string & {});
 interface DjotTableNode extends DjotParentNode {
     tag: "table";
@@ -108,24 +111,78 @@ interface DjotCodeBlockNode extends DjotBaseNode {
     tag: "code_block";
     text: string;
 }
-interface DjotLinkNode extends DjotParentNode {
+interface DjotRawBlockNode extends DjotBaseNode {
+    format: string;
+    tag: "raw_block";
+    text: string;
+}
+interface DjotRawInlineNode extends DjotBaseNode {
+    format: string;
+    tag: "raw_inline";
+    text: string;
+}
+interface DjotSymbNode extends DjotBaseNode {
+    alias: string;
+    tag: "symb";
+}
+interface DjotUrlNode extends DjotBaseNode {
+    tag: "url";
+    text: string;
+}
+interface DjotEmailNode extends DjotBaseNode {
+    tag: "email";
+    text: string;
+}
+interface DjotReferenceNode extends DjotBaseNode {
     destination: string;
+    label: string;
+    tag: "reference";
+}
+interface DjotLinkNode extends DjotParentNode {
+    destination?: string;
+    reference?: string;
     tag: "link";
 }
 interface DjotImageNode extends DjotParentNode {
-    destination: string;
+    destination?: string;
+    reference?: string;
     tag: "image";
 }
 interface DjotBulletListNode extends DjotParentNode {
+    tight?: boolean;
     tag: "bullet_list";
 }
+type DjotOrderedListStyle = "1." | "1)" | "(1)" | "a." | "a)" | "(a)" | "A." | "A)" | "(A)" | "i." | "i)" | "(i)" | "I." | "I)" | "(I)" | (string & {});
 interface DjotOrderedListNode extends DjotParentNode {
     start?: number;
+    style?: DjotOrderedListStyle;
+    tight?: boolean;
     tag: "ordered_list";
 }
 interface DjotListItemNode extends DjotParentNode {
     tag: "list_item";
 }
+interface DjotDefinitionListNode extends DjotParentNode {
+    tag: "definition_list";
+}
+interface DjotDefinitionListItemNode extends DjotParentNode {
+    tag: "definition_list_item";
+}
+interface DjotTermNode extends DjotParentNode {
+    tag: "term";
+}
+interface DjotDefinitionNode extends DjotParentNode {
+    tag: "definition";
+}
+type DjotCheckboxStatus = "checked" | "unchecked";
+interface DjotTaskListNode extends DjotParentNode {
+    tag: "task_list";
+    tight?: boolean;
+}
+interface DjotTaskListItemNode extends DjotParentNode {
+    checkbox: DjotCheckboxStatus;
+    tag: "task_list_item";
+}
 interface DjotBlockquoteNode extends DjotParentNode {
     tag: "blockquote";
 }
@@ -149,7 +206,10 @@ interface DjotSoftBreakNode extends DjotBaseNode {
 interface DjotHardBreakNode extends DjotBaseNode {
     tag: "hard_break" | "hardbreak";
 }
-type DjotNode = DjotDocNode | DjotSectionNode | DjotDivNode | DjotParaNode | DjotHeadingNode | DjotEmphNode | DjotStrongNode | DjotMarkNode | DjotHighlightedNode | DjotSuperscriptNode | DjotSupeNode | DjotSubscriptNode | DjotInsertNode | DjotDeleteNode | DjotTableNode | DjotCaptionNode | DjotRowNode | DjotCellNode | DjotFootnoteReferenceNode | DjotFootnoteNode | DjotDoubleQuotedNode | DjotSingleQuotedNode | DjotSmartPunctuationNode | DjotInlineMathNode | DjotDisplayMathNode | DjotCodeNode | DjotCodeBlockNode | DjotLinkNode | DjotImageNode | DjotBulletListNode | DjotOrderedListNode | DjotListItemNode | DjotBlockquoteNode | DjotBlockQuoteNode | DjotThematicBreakNode | DjotStrNode | DjotVerbatimNode | DjotSoftBreakNode | DjotHardBreakNode;
+interface DjotNonBreakingSpaceNode extends DjotBaseNode {
+    tag: "non_breaking_space";
+}
+type DjotNode = DjotDocNode | DjotSectionNode | DjotDivNode | DjotParaNode | DjotHeadingNode | DjotEmphNode | DjotStrongNode | DjotMarkNode | DjotHighlightedNode | DjotSuperscriptNode | DjotSupeNode | DjotSubscriptNode | DjotInsertNode | DjotDeleteNode | DjotSpanNode | DjotTableNode | DjotCaptionNode | DjotRowNode | DjotCellNode | DjotFootnoteReferenceNode | DjotFootnoteNode | DjotDoubleQuotedNode | DjotSingleQuotedNode | DjotSmartPunctuationNode | DjotInlineMathNode | DjotDisplayMathNode | DjotCodeNode | DjotCodeBlockNode | DjotRawBlockNode | DjotRawInlineNode | DjotSymbNode | DjotUrlNode | DjotEmailNode | DjotLinkNode | DjotImageNode | DjotBulletListNode | DjotOrderedListNode | DjotListItemNode | DjotDefinitionListNode | DjotDefinitionListItemNode | DjotTermNode | DjotDefinitionNode | DjotTaskListNode | DjotTaskListItemNode | DjotBlockquoteNode | DjotBlockQuoteNode | DjotThematicBreakNode | DjotStrNode | DjotVerbatimNode | DjotNonBreakingSpaceNode | DjotSoftBreakNode | DjotHardBreakNode;
 type DjotNodeTag = DjotNode["tag"];
 type DjotNodeByTag<Tag extends DjotNodeTag> = Extract<DjotNode, {
     tag: Tag;
@@ -183,6 +243,7 @@ interface DjotComponentPropsMap {
     subscript: React.HTMLAttributes<HTMLElement> & DjotNodePropsBase<"subscript">;
     insert: React.HTMLAttributes<HTMLElement> & DjotNodePropsBase<"insert">;
     delete: React.HTMLAttributes<HTMLElement> & DjotNodePropsBase<"delete">;
+    span: React.HTMLAttributes<HTMLElement> & DjotNodePropsBase<"span">;
     table: React.TableHTMLAttributes<HTMLTableElement> & DjotNodePropsBase<"table">;
     caption: React.HTMLAttributes<HTMLTableCaptionElement> & DjotNodePropsBase<"caption">;
     row: React.HTMLAttributes<HTMLTableRowElement> & DjotNodePropsBase<"row"> & {
@@ -231,13 +292,50 @@ interface DjotComponentPropsMap {
         language?: string;
         value: string;
     };
+    raw_block: React.HTMLAttributes<HTMLElement> & DjotNodePropsBase<"raw_block"> & {
+        format: string;
+        value: string;
+    };
+    raw_inline: React.HTMLAttributes<HTMLElement> & DjotNodePropsBase<"raw_inline"> & {
+        format: string;
+        value: string;
+    };
+    symb: React.HTMLAttributes<HTMLElement> & DjotNodePropsBase<"symb"> & {
+        alias: string;
+        value: string;
+    };
+    url: React.AnchorHTMLAttributes<HTMLAnchorElement> & DjotNodePropsBase<"url"> & {
+        href: string;
+        value: string;
+    };
+    email: React.AnchorHTMLAttributes<HTMLAnchorElement> & DjotNodePropsBase<"email"> & {
+        href: string;
+        value: string;
+    };
     link: React.AnchorHTMLAttributes<HTMLAnchorElement> & DjotNodePropsBase<"link">;
     image: React.ImgHTMLAttributes<HTMLImageElement> & DjotNodePropsBase<"image"> & {
         alt?: string;
     };
-    bullet_list: React.HTMLAttributes<HTMLUListElement> & DjotNodePropsBase<"bullet_list">;
-    ordered_list: React.OlHTMLAttributes<HTMLOListElement> & DjotNodePropsBase<"ordered_list">;
-    list_item: React.LiHTMLAttributes<HTMLLIElement> & DjotNodePropsBase<"list_item">;
+    bullet_list: React.HTMLAttributes<HTMLUListElement> & DjotNodePropsBase<"bullet_list"> & {
+        tight?: boolean;
+    };
+    ordered_list: React.OlHTMLAttributes<HTMLOListElement> & DjotNodePropsBase<"ordered_list"> & {
+        tight?: boolean;
+    };
+    list_item: React.LiHTMLAttributes<HTMLLIElement> & DjotNodePropsBase<"list_item"> & {
+        tight?: boolean;
+    };
+    definition_list: React.HTMLAttributes<HTMLDListElement> & DjotNodePropsBase<"definition_list">;
+    definition_list_item: React.HTMLAttributes<HTMLElement> & DjotNodePropsBase<"definition_list_item">;
+    term: React.HTMLAttributes<HTMLElement> & DjotNodePropsBase<"term">;
+    definition: React.HTMLAttributes<HTMLElement> & DjotNodePropsBase<"definition">;
+    task_list: React.HTMLAttributes<HTMLUListElement> & DjotNodePropsBase<"task_list"> & {
+        tight?: boolean;
+    };
+    task_list_item: React.LiHTMLAttributes<HTMLLIElement> & DjotNodePropsBase<"task_list_item"> & {
+        checkbox: DjotCheckboxStatus;
+        tight?: boolean;
+    };
     blockquote: React.BlockquoteHTMLAttributes<HTMLQuoteElement> & Omit<DjotNodePropsBase<"blockquote">, "node"> & {
         node: DjotBlockquoteNode | DjotBlockQuoteNode;
     };
@@ -248,6 +346,9 @@ interface DjotComponentPropsMap {
     str: DjotNodePropsBase<"str"> & {
         value: string;
     };
+    non_breaking_space: DjotNodePropsBase<"non_breaking_space"> & {
+        value: string;
+    };
     soft_break: DjotNodePropsBase<"soft_break">;
     softbreak: DjotNodePropsBase<"softbreak">;
     hard_break: DjotNodePropsBase<"hard_break">;
@@ -256,24 +357,35 @@ interface DjotComponentPropsMap {
 type DjotComponents = Partial<{
     [K in keyof DjotComponentPropsMap]: React.ElementType<DjotComponentPropsMap[K]>;
 }>;
-interface DjotProps {
-    children?: string | null | undefined;
+interface DjotSharedProps {
     components?: DjotComponents | undefined;
 }
+type DjotProps = (DjotSharedProps & {
+    ast?: never;
+    children?: string | null | undefined;
+}) | (DjotSharedProps & {
+    ast: DjotNode;
+    children?: never;
+});
 
-declare function Djot({ children, components }: DjotProps): React.ReactElement | null;
+declare function compileDjot(source: string): DjotNode;
+declare function Djot(props: DjotProps): React.ReactElement | null;
 
-interface RenderNodeOptions {
-    components?: DjotComponents | undefined;
-    footnoteState?: FootnoteState | undefined;
-    key?: React.Key;
-}
 interface FootnoteState {
+    autoReferencesByLabel: Record<string, DjotReferenceNode>;
     firstRefIdByLabel: Map<string, string>;
     indexByLabel: Map<string, number>;
     order: string[];
+    referencesByLabel: Record<string, DjotReferenceNode>;
     refCountByLabel: Map<string, number>;
 }
+
+interface RenderNodeOptions {
+    components?: DjotComponents | undefined;
+    footnoteState?: FootnoteState | undefined;
+    key?: React.Key;
+    listTight?: boolean | undefined;
+}
 declare function renderNode(node: DjotNode, options?: RenderNodeOptions): React.ReactNode;
 
-export { Djot, type DjotComponentPropsMap, type DjotComponents, type DjotNode, type DjotNodeByTag, type DjotNodeTag, type DjotProps, Djot as default, renderNode };
+export { Djot, type DjotComponentPropsMap, type DjotComponents, type DjotNode, type DjotNodeByTag, type DjotNodeTag, type DjotProps, compileDjot, Djot as default, renderNode };