wip: all types

Author: agoose77

src/abbreviations.ts

@@ -0,0 +1,7 @@
+import type { Parent, PhrasingContent } from 'mdast';
+
+export interface Abbreviation extends Parent {
+  type: 'abbreviation';
+  children: PhrasingContent[];
+  title?: string;
+}

src/admonitions.ts

@@ -0,0 +1,26 @@
+import type { Parent, PhrasingContent } from 'mdast';
+import type { FlowContent } from './flow';
+
+export interface AdmonitionTitle extends Parent {
+  type: 'admonitionTitle';
+  children: PhrasingContent[];
+}
+
+export type AdmonitionKind =
+  | 'attention'
+  | 'caution'
+  | 'danger'
+  | 'error'
+  | 'hint'
+  | 'important'
+  | 'note'
+  | 'seealso'
+  | 'tip'
+  | 'warning';
+
+export interface Admonition extends Parent {
+  type: 'admonition';
+  kind?: AdmonitionKind;
+  class?: string;
+  children: (FlowContent | AdmonitionTitle)[];
+}

src/comments.ts

@@ -0,0 +1,5 @@
+import type { Literal } from 'mdast';
+
+export interface Comment extends Literal {
+  type: 'comment';
+}

src/directives.ts

@@ -0,0 +1,11 @@
+import type { Parent, Literal, PhrasingContent } from 'mdast';
+import type { FlowContent } from './flow';
+
+export interface Directive extends Parent, Literal {
+  type: 'mystDirective';
+  name: string;
+  args?: string;
+  options?: Record<string, any>;
+  value: string;
+  children: (FlowContent | PhrasingContent)[];
+}

src/enumerated.ts

@@ -0,0 +1,4 @@
+export interface Enumerated {
+  enumerated: boolean;
+  enumerator: string;
+}

src/flow.ts

@@ -1,4 +1,10 @@
 import type { Blockquote, Code, Heading, Html, List, ThematicBreak, RootContent } from 'mdast';
+import type { Math } from './math';
+import type { Admonition } from './admonitions';
+import type { Comment } from './comments';
+import type { Directive } from './directives';
+import type { Target } from './references';
+
 export interface FlowContentMap {
   blockQuote: Blockquote;
   code: Code;
@@ -7,6 +13,11 @@ export interface FlowContentMap {
   list: List;
   thematicBreak: ThematicBreak;
   rootContent: RootContent;
+  math: Math;
+  comment: Comment;
+  directive: Directive;
+  admonition: Admonition;
+  mystTarget: Target;
 }
 
 export type FlowContent = FlowContentMap[keyof FlowContentMap];

src/index.ts

@@ -1,31 +1,58 @@
-//import type { InlineMath } from './math';
 import type { Role } from './roles';
 import type { BlockBreak, Block } from './blocks';
+import type { AdmonitionTitle, Admonition } from './admonitions';
+import type { Abbreviation } from './abbreviations';
+import type { Comment } from './comments';
+import type { InlineMath, Math } from './math';
+import type { Directive } from './directives';
+import type { CrossReference, Target } from './references';
+import type { Subscript, Superscript, Underline } from './styles';
 
 declare module 'mdast' {
-  interface Node {
-    // Referencing semantics
-    identifier?: string;
+  // Extend Association to include HTML ID
+  interface Association {
     html_id?: string;
   }
 
+  // All nodes are referenceable now
+  interface Node extends Partial<Association> {}
+
   interface PhrasingContentMap {
-    // Extend MDAST to use our types
-    //inlineMath: InlineMath;
+    inlineMath: InlineMath;
     mystRole: Role;
-    //subscriptStatic: SubscriptStatic;
-    //superscriptStatic: SuperscriptStatic;
-    //underlineStatic: UnderlineStatic;
+    subscript: Subscript;
+    superscript: Superscript;
+    underline: Underline;
+    crossReference: CrossReference;
+    abbreviation: Abbreviation;
   }
 
   interface RootContentMap {
     mystRole: Role;
     block: Block;
     blockBreak: BlockBreak;
+    admonition: Admonition;
+    admonitionTitle: AdmonitionTitle;
+    abbreviation: Abbreviation;
+    comment: Comment;
+    mystDirective: Directive;
+    math: Math;
+    inlineMath: InlineMath;
+    subscript: Subscript;
+    superscript: Superscript;
+    underline: Underline;
+    crossReference: CrossReference;
+    mystTarget: Target;
   }
 }
 
 export type * from 'mdast';
 export type * from './roles';
 export type * from './blocks';
-export type * from './flow';
+export type * from './admonitions';
+export type * from './abbreviations';
+export type * from './comments';
+export type * from './math';
+export type * from './directives';
+export type * from './references';
+export type * from './styles';

src/math.ts

@@ -0,0 +1,9 @@
+import type { Association, Literal } from 'mdast';
+import type { Enumerated } from './enumerated';
+
+export interface Math extends Partial<Association>, Partial<Enumerated>, Literal {
+  type: 'math';
+}
+export interface InlineMath extends Literal {
+  type: 'inlineMath';
+}

src/references.ts

@@ -0,0 +1,12 @@
+import type { Association, Parent, PhrasingContent, Node } from 'mdast';
+
+export interface Target extends Node {
+  type: 'mystTarget';
+  label?: string;
+}
+
+export interface CrossReference extends Association, Pick<Parent, 'children'> {
+  type: 'crossReference';
+  kind?: 'eq' | 'numref' | 'ref';
+  children: PhrasingContent[];
+}

src/styles.ts

@@ -0,0 +1,16 @@
+import type { Parent, PhrasingContent } from 'mdast';
+
+export interface Subscript extends Parent {
+  type: 'subscript';
+  children: PhrasingContent[];
+}
+
+export interface Superscript extends Parent {
+  type: 'superscript';
+  children: PhrasingContent[];
+}
+
+export interface Underline extends Parent {
+  type: 'underline';
+  children: PhrasingContent[];
+}