refactor(ts): allow object types to exclude index signature

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

Author: unicornware

src/dtos/__tests__/exception.spec-d.ts

@@ -7,11 +7,16 @@ import type * as aggregate from '@flex-development/aggregate-error-ponyfill'
 import type {
   JsonifiableObject,
   Nilable,
+  ObjectPlain,
   OneOrMany
 } from '@flex-development/tutils'
 import type TestSubject from '../exception'
 
 describe('unit-d:dtos/ExceptionDTO', () => {
+  it('should allow T to exclude index signature', () => {
+    expectTypeOf<TestSubject<Error>>().toMatchTypeOf<TestSubject<ObjectPlain>>()
+  })
+
   it('should extend aggregate.Options<Cause>', () => {
     expectTypeOf<TestSubject>().toMatchTypeOf<aggregate.Options>()
   })

src/dtos/exception-http.ts

@@ -3,7 +3,11 @@
  * @module exceptions/dtos/HttpExceptionDTO
  */
 
-import type { JsonifiableObject, Nullable } from '@flex-development/tutils'
+import type {
+  JsonifiableObject,
+  Nullable,
+  ObjectPlain
+} from '@flex-development/tutils'
 import type ExceptionDTO from './exception'
 
 /**
@@ -16,8 +20,8 @@ import type ExceptionDTO from './exception'
  * @extends {ExceptionDTO<T,Cause>}
  */
 interface HttpExceptionDTO<
-  T extends JsonifiableObject = JsonifiableObject,
-  Cause extends JsonifiableObject = JsonifiableObject,
+  T extends ObjectPlain = JsonifiableObject,
+  Cause extends ObjectPlain = JsonifiableObject,
   Code extends Nullable<number | string> = string
 > extends ExceptionDTO<T, Cause, Code> {}
 

src/dtos/exception.ts

@@ -10,6 +10,7 @@ import type {
   JsonifiableObject,
   Nilable,
   Nullable,
+  ObjectPlain,
   ObjectUnknown,
   OneOrMany
 } from '@flex-development/tutils'
@@ -24,8 +25,8 @@ import type {
  * @extends {aggregate.Options<Cause>}
  */
 interface ExceptionDTO<
-  T extends JsonifiableObject = JsonifiableObject,
-  Cause extends JsonifiableObject = JsonifiableObject,
+  T extends ObjectPlain = JsonifiableObject,
+  Cause extends ObjectPlain = JsonifiableObject,
   Code extends Nullable<number | string> = string
 > extends aggregate.Options<Cause> {
   [key: string]:

src/exceptions/__tests__/base.exception.spec-d.ts

@@ -4,10 +4,14 @@
  */
 
 import type AggregateError from '@flex-development/aggregate-error-ponyfill'
-import type { JsonifiableObject } from '@flex-development/tutils'
+import type { JsonifiableObject, ObjectPlain } from '@flex-development/tutils'
 import type TestSubject from '../base.exception'
 
 describe('unit-d:exceptions/Exception', () => {
+  it('should allow T to exclude index signature', () => {
+    expectTypeOf<TestSubject<Error>>().toMatchTypeOf<TestSubject<ObjectPlain>>()
+  })
+
   it('should extend AggregateError<T, Cause & { code: Code }>', () => {
     expectTypeOf<TestSubject>().toMatchTypeOf<
       AggregateError<JsonifiableObject, JsonifiableObject & { code: string }>

src/exceptions/base.exception.ts

@@ -13,6 +13,7 @@ import {
   isString,
   type JsonifiableObject,
   type Nullable,
+  type ObjectPlain,
   type OneOrMany
 } from '@flex-development/tutils'
 import { get, set, shake } from 'radash'
@@ -29,9 +30,9 @@ import { get, set, shake } from 'radash'
  * @extends {AggregateError<T,Cause&{code:Code}>}
  */
 class Exception<
-  T extends JsonifiableObject = JsonifiableObject,
-  Data extends JsonifiableObject = JsonifiableObject,
-  Cause extends JsonifiableObject = JsonifiableObject,
+  T extends ObjectPlain = JsonifiableObject,
+  Data extends ObjectPlain = JsonifiableObject,
+  Cause extends ObjectPlain = JsonifiableObject,
   Code extends Nullable<number | string> = string
 > extends AggregateError<T, Cause & { code: Code }> {
   /**
@@ -137,9 +138,9 @@ class Exception<
    * {@linkcode Exception} instance
    */
   public static is<
-    T extends JsonifiableObject = JsonifiableObject,
-    Data extends JsonifiableObject = JsonifiableObject,
-    Cause extends JsonifiableObject = JsonifiableObject,
+    T extends ObjectPlain = JsonifiableObject,
+    Data extends ObjectPlain = JsonifiableObject,
+    Cause extends ObjectPlain = JsonifiableObject,
     Code extends Nullable<number | string> = string
   >(value: unknown): value is Exception<T, Data, Cause, Code> {
     return value instanceof Exception
@@ -161,9 +162,9 @@ class Exception<
    * {@linkcode ExceptionJSON} object
    */
   public static isJSON<
-    T extends JsonifiableObject = JsonifiableObject,
-    Data extends JsonifiableObject = JsonifiableObject,
-    Cause extends JsonifiableObject = JsonifiableObject,
+    T extends ObjectPlain = JsonifiableObject,
+    Data extends ObjectPlain = JsonifiableObject,
+    Cause extends ObjectPlain = JsonifiableObject,
     Code extends Nullable<number | string> = string
   >(value: unknown): value is ExceptionJSON<T, Data, Cause, Code> {
     /**

src/exceptions/http.exception.ts

@@ -10,6 +10,7 @@ import type { HttpExceptionJSON } from '#src/interfaces'
 import type {
   JsonifiableObject,
   Nullable,
+  ObjectPlain,
   OneOrMany
 } from '@flex-development/tutils'
 import { get, invert, set } from 'radash'
@@ -27,9 +28,9 @@ import Exception from './base.exception'
  * @extends {Exception<T,Data,Cause,Code>}
  */
 class HttpException<
-  T extends JsonifiableObject = JsonifiableObject,
-  Data extends JsonifiableObject = JsonifiableObject,
-  Cause extends JsonifiableObject = JsonifiableObject,
+  T extends ObjectPlain = JsonifiableObject,
+  Data extends ObjectPlain = JsonifiableObject,
+  Cause extends ObjectPlain = JsonifiableObject,
   Code extends Nullable<number | string> = string
 > extends Exception<T, Data, Cause, Code> {
   /**
@@ -112,9 +113,9 @@ class HttpException<
    * {@linkcode HttpException} instance
    */
   public static override is<
-    T extends JsonifiableObject = JsonifiableObject,
-    Data extends JsonifiableObject = JsonifiableObject,
-    Cause extends JsonifiableObject = JsonifiableObject,
+    T extends ObjectPlain = JsonifiableObject,
+    Data extends ObjectPlain = JsonifiableObject,
+    Cause extends ObjectPlain = JsonifiableObject,
     Code extends Nullable<number | string> = string
   >(value: unknown): value is HttpException<T, Data, Cause, Code> {
     return value instanceof HttpException
@@ -137,9 +138,9 @@ class HttpException<
    * `value` is {@linkcode HttpExceptionJSON} object
    */
   public static override isJSON<
-    T extends JsonifiableObject = JsonifiableObject,
-    Data extends JsonifiableObject = JsonifiableObject,
-    Cause extends JsonifiableObject = JsonifiableObject,
+    T extends ObjectPlain = JsonifiableObject,
+    Data extends ObjectPlain = JsonifiableObject,
+    Cause extends ObjectPlain = JsonifiableObject,
     Code extends Nullable<number | string> = string
   >(value: unknown): value is HttpExceptionJSON<T, Data, Cause, Code> {
     return (

src/interfaces/__tests__/exception-json.spec-d.ts

@@ -4,10 +4,14 @@
  */
 
 import type { Errors } from '#src/types'
-import type { JsonifiableObject } from '@flex-development/tutils'
+import type { JsonifiableObject, ObjectPlain } from '@flex-development/tutils'
 import type TestSubject from '../exception-json'
 
 describe('unit-d:interfaces/ExceptionJSON', () => {
+  it('should allow T to exclude index signature', () => {
+    expectTypeOf<TestSubject<Error>>().toMatchTypeOf<TestSubject<ObjectPlain>>()
+  })
+
   it('should match [cause: Readonly<Cause & { code: Code }>]', () => {
     expectTypeOf<TestSubject>()
       .toHaveProperty('cause')

src/interfaces/exception-json-http.ts

@@ -4,7 +4,11 @@
  */
 
 import type { ClassName, Status, StatusName } from '#src/enums'
-import type { JsonifiableObject, Nullable } from '@flex-development/tutils'
+import type {
+  JsonifiableObject,
+  Nullable,
+  ObjectPlain
+} from '@flex-development/tutils'
 import type ExceptionJSON from './exception-json'
 
 /**
@@ -18,9 +22,9 @@ import type ExceptionJSON from './exception-json'
  * @extends {ExceptionJSON<T,Data,Cause,Code>}
  */
 interface HttpExceptionJSON<
-  T extends JsonifiableObject = JsonifiableObject,
-  Data extends JsonifiableObject = JsonifiableObject,
-  Cause extends JsonifiableObject = JsonifiableObject,
+  T extends ObjectPlain = JsonifiableObject,
+  Data extends ObjectPlain = JsonifiableObject,
+  Cause extends ObjectPlain = JsonifiableObject,
   Code extends Nullable<number | string> = string
 > extends ExceptionJSON<T, Data, Cause, Code> {
   /**

src/interfaces/exception-json.ts

@@ -4,7 +4,11 @@
  */
 
 import type { Errors } from '#src/types'
-import type { JsonifiableObject, Nullable } from '@flex-development/tutils'
+import type {
+  JsonifiableObject,
+  Nullable,
+  ObjectPlain
+} from '@flex-development/tutils'
 
 /**
  * JSON representation of an `Exception`.
@@ -15,9 +19,9 @@ import type { JsonifiableObject, Nullable } from '@flex-development/tutils'
  * @template Code - Exception code type
  */
 interface ExceptionJSON<
-  T extends JsonifiableObject = JsonifiableObject,
-  Data extends JsonifiableObject = JsonifiableObject,
-  Cause extends JsonifiableObject = JsonifiableObject,
+  T extends ObjectPlain = JsonifiableObject,
+  Data extends ObjectPlain = JsonifiableObject,
+  Cause extends ObjectPlain = JsonifiableObject,
   Code extends Nullable<number | string> = string
 > {
   /**

src/types/__tests__/errors.spec-d.ts

@@ -3,10 +3,14 @@
  * @module exceptions/types/tests/unit-d/Errors
  */
 
-import type { JsonifiableObject } from '@flex-development/tutils'
+import type { JsonifiableObject, ObjectPlain } from '@flex-development/tutils'
 import type TestSubject from '../errors'
 
 describe('unit-d:types/Errors', () => {
+  it('should allow T to exclude index signature', () => {
+    expectTypeOf<TestSubject<Error>>().toMatchTypeOf<TestSubject<ObjectPlain>>()
+  })
+
   it('should equal T[]', () => {
     expectTypeOf<TestSubject>().toEqualTypeOf<JsonifiableObject[]>()
   })