feat(nodes): Root

Signed-off-by: Lexus Drumgold <unicornware@flexdevelopment.llc>

src/nodes/__tests__/root.spec-d.ts

@@ -0,0 +1,55 @@
+/**
+ * @file Type Tests - Root
+ * @module esast/nodes/tests/unit-d/Root
+ */
+
+import type {
+  Data,
+  EcmaVersion,
+  Parent,
+  RootChild,
+  SourceMode
+} from '@flex-development/esast'
+import type { Nilable, Optional } from '@flex-development/tutils'
+import type * as TestSubject from '../root'
+
+describe('unit-d:nodes/Root', () => {
+  type Subject = TestSubject.default
+  type SubjectData = TestSubject.RootData
+
+  it('should extend Parent', () => {
+    expectTypeOf<Subject>().toMatchTypeOf<Parent>()
+  })
+
+  it('should match [children: RootChild[]]', () => {
+    expectTypeOf<Subject>()
+      .toHaveProperty('children')
+      .toEqualTypeOf<RootChild[]>()
+  })
+
+  it('should match [data?: Optional<RootData>]', () => {
+    expectTypeOf<Subject>()
+      .toHaveProperty('data')
+      .toEqualTypeOf<Optional<SubjectData>>()
+  })
+
+  it('should match [mode: SourceMode]', () => {
+    expectTypeOf<Subject>().toHaveProperty('mode').toEqualTypeOf<SourceMode>()
+  })
+
+  it('should match [type: "root"]', () => {
+    expectTypeOf<Subject>().toHaveProperty('type').toEqualTypeOf<'root'>()
+  })
+
+  describe('RootData', () => {
+    it('should extend Data', () => {
+      expectTypeOf<SubjectData>().toMatchTypeOf<Data>()
+    })
+
+    it('should match [ecmaVersion?: Nilable<EcmaVersion>]', () => {
+      expectTypeOf<SubjectData>()
+        .toHaveProperty('ecmaVersion')
+        .toEqualTypeOf<Nilable<EcmaVersion>>()
+    })
+  })
+})

src/nodes/index.ts

@@ -151,6 +151,7 @@ export type {
 } from './pattern-object'
 export type { default as Property, PropertyData } from './property'
 export type { default as MetaProperty, MetaPropertyData } from './property-meta'
+export type { default as Root, RootData } from './root'
 export type {
   default as BlockStatement,
   BlockStatementData

src/nodes/root.ts

@@ -0,0 +1,68 @@
+/**
+ * @file Nodes - Root
+ * @module esast/nodes/Root
+ */
+
+import type {
+  Data,
+  EcmaVersion,
+  Parent,
+  RootChild,
+  SourceMode
+} from '@flex-development/esast'
+import type { Nilable, Optional } from '@flex-development/tutils'
+
+/**
+ * Info associated with documents.
+ *
+ * @see {@linkcode Data}
+ *
+ * @extends {Data}
+ */
+interface RootData extends Data {
+  /**
+   * ECMAScript version of source document.
+   *
+   * @see {@linkcode EcmaVersion}
+   */
+  ecmaVersion?: Nilable<EcmaVersion>
+}
+
+/**
+ * A document fragment or whole document.
+ *
+ * Should be used as the root of a tree; must not be used as a child.
+ *
+ * @see {@linkcode Parent}
+ *
+ * @extends {Parent}
+ */
+interface Root extends Parent {
+  /**
+   * List of children.
+   *
+   * @see {@linkcode RootChild}
+   */
+  children: RootChild[]
+
+  /**
+   * Data associated with esast root.
+   *
+   * @see {@linkcode RootData}
+   */
+  data?: Optional<RootData>
+
+  /**
+   * Mode source document was parsed in.
+   *
+   * @see {@linkcode SourceMode}
+   */
+  mode: SourceMode
+
+  /**
+   * Node type.
+   */
+  type: 'root'
+}
+
+export type { RootData, Root as default }