feat(content): FstNode, NodeMap

Signed-off-by: Lexus Drumgold <[email protected]>

Author: unicornware

src/content/__tests__/node.spec-d.mts

@@ -0,0 +1,32 @@
+/**
+ * @file Type Tests - node
+ * @module fst/content/tests/unit-d/node
+ */
+
+import type * as TestSubject from '#content/node'
+import type { AnyNode } from '@flex-development/fst'
+import type { Type } from '@flex-development/unist-util-types'
+
+describe('unit-d:content/node', () => {
+  describe('FstNode', () => {
+    it('should equal NodeMap[keyof NodeMap]', () => {
+      // Arrange
+      type K = keyof TestSubject.NodeMap
+      type Expect = TestSubject.NodeMap[K]
+
+      // Expect
+      expectTypeOf<TestSubject.FstNode>().toEqualTypeOf<Expect>()
+    })
+  })
+
+  describe('NodeMap', () => {
+    it('should register all fst nodes', () => {
+      // Arrange
+      type Subject = TestSubject.NodeMap[keyof TestSubject.NodeMap]
+
+      // Expect
+      expectTypeOf<Subject>().toEqualTypeOf<AnyNode>()
+      expectTypeOf<keyof TestSubject.NodeMap>().toEqualTypeOf<Type<AnyNode>>()
+    })
+  })
+})

src/content/index.mts

@@ -4,3 +4,4 @@
  */
 
 export type * from '#content/directory'
+export type * from '#content/node'

src/content/node.mts

@@ -0,0 +1,37 @@
+/**
+ * @file Content - node
+ * @module fst/content/node
+ */
+
+import type {
+  DirectoryContentMap,
+  Root
+} from '@flex-development/fst'
+
+/**
+ * Union of registered fst nodes.
+ *
+ * To register custom fst nodes, augment {@linkcode NodeMap}. They will be
+ * added to this union automatically.
+ */
+type FstNode = NodeMap[keyof NodeMap]
+
+/**
+ * Registry of fst nodes.
+ *
+ * This interface can be augmented to register custom nodes.
+ *
+ * @example
+ *  declare module '@flex-development/fst' {
+ *    interface NodeMap {
+ *      customNode: CustomNode
+ *    }
+ *  }
+ *
+ * @extends {DirectoryContentMap}
+ */
+interface NodeMap extends DirectoryContentMap {
+  root: Root
+}
+
+export type { FstNode, NodeMap }