feat(content): PrimitiveMap, Primitive

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

.commitlintrc.ts

@@ -20,6 +20,7 @@ const config: UserConfig = {
   rules: {
     'scope-enum': [Severity.Error, 'always', scopes([
       'chore',
+      'content',
       'data',
       'nodes',
       'spec'

src/content/__tests__/primitive.spec-d.ts

@@ -0,0 +1,61 @@
+/**
+ * @file Type Tests - primitive
+ * @module esast/content/tests/unit-d/primitive
+ */
+
+import type {
+  BigIntLiteral,
+  BooleanLiteral,
+  NullLiteral,
+  NumberLiteral,
+  StringLiteral,
+  UndefinedLiteral
+} from '@flex-development/esast'
+import type * as TestSubject from '../primitive'
+
+describe('unit-d:content/primitive', () => {
+  describe('Primitive', () => {
+    it('should equal PrimitiveMap[keyof PrimitiveMap]', () => {
+      expectTypeOf<TestSubject.Primitive>()
+        .toEqualTypeOf<TestSubject.PrimitiveMap[keyof TestSubject.PrimitiveMap]>
+    })
+  })
+
+  describe('PrimitiveMap', () => {
+    it('should match [bigint: BigIntLiteral]', () => {
+      expectTypeOf<TestSubject.PrimitiveMap>()
+        .toHaveProperty('bigint')
+        .toEqualTypeOf<BigIntLiteral>
+    })
+
+    it('should match [boolean: BooleanLiteral]', () => {
+      expectTypeOf<TestSubject.PrimitiveMap>()
+        .toHaveProperty('boolean')
+        .toEqualTypeOf<BooleanLiteral>
+    })
+
+    it('should match [null: NullLiteral]', () => {
+      expectTypeOf<TestSubject.PrimitiveMap>()
+        .toHaveProperty('null')
+        .toEqualTypeOf<NullLiteral>
+    })
+
+    it('should match [number: NumberLiteral]', () => {
+      expectTypeOf<TestSubject.PrimitiveMap>()
+        .toHaveProperty('number')
+        .toEqualTypeOf<NumberLiteral>
+    })
+
+    it('should match [string: StringLiteral]', () => {
+      expectTypeOf<TestSubject.PrimitiveMap>()
+        .toHaveProperty('string')
+        .toEqualTypeOf<StringLiteral>
+    })
+
+    it('should match [undefined: UndefinedLiteral]', () => {
+      expectTypeOf<TestSubject.PrimitiveMap>()
+        .toHaveProperty('undefined')
+        .toEqualTypeOf<UndefinedLiteral>
+    })
+  })
+})

src/content/index.ts

@@ -0,0 +1,6 @@
+/**
+ * @file Entry Point - Content Model
+ * @module esast/content
+ */
+
+export type * from './primitive'

src/content/primitive.ts

@@ -0,0 +1,45 @@
+/**
+ * @file Content - primitive
+ * @module esast/content/primitive
+ */
+
+import type {
+  BigIntLiteral,
+  BooleanLiteral,
+  NullLiteral,
+  NumberLiteral,
+  StringLiteral,
+  UndefinedLiteral
+} from '@flex-development/esast'
+
+/**
+ * Union of registered esast nodes that can occur where a primitive value is
+ * expected.
+ *
+ * To register custom esast nodes, augment {@linkcode PrimitiveMap}. They will
+ * be added to this union automatically.
+ */
+type Primitive = PrimitiveMap[keyof PrimitiveMap]
+
+/**
+ * Registry of nodes that can occur where a {@linkcode Primitive} is expected.
+ *
+ * This interface can be augmented to register custom node types.
+ *
+ * @example
+ *  declare module '@flex-development/docast' {
+ *    interface PrimitiveMap {
+ *      custom: CustomPrimitive
+ *    }
+ *  }
+ */
+interface PrimitiveMap {
+  bigint: BigIntLiteral
+  boolean: BooleanLiteral
+  null: NullLiteral
+  number: NumberLiteral
+  string: StringLiteral
+  undefined: UndefinedLiteral
+}
+
+export type { Primitive, PrimitiveMap }

src/index.ts

@@ -3,6 +3,7 @@
  * @module esast
  */
 
+export type * from './content'
 export type * from './data'
 export type * from './nodes'
 export type * from './types'