feat: BaseDBEntity.id only supports string now

Previously it had a generic ID type that could be string or number. This change is a step towards simplification. A trade-off towards simplicity, against flexibility.
NaturalCycles · Dec 28, 2023 · 2d57433 · 2d57433
1 parent 9f3249b
commit 2d57433
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 29 deletions.
diff --git a/src/json-schema/jsonSchemaBuilder.ts b/src/json-schema/jsonSchemaBuilder.ts
@@ -368,22 +368,18 @@ export class JsonSchemaObjectBuilder<T extends AnyObject> extends JsonSchemaAnyB
     return this
   }
 
-  baseDBEntity<ID extends string | number = string>(
-    idType = 'string',
-  ): JsonSchemaObjectBuilder<T & BaseDBEntity<ID>> {
+  baseDBEntity(): JsonSchemaObjectBuilder<T & BaseDBEntity> {
     Object.assign(this.schema.properties, {
-      id: { type: idType },
+      id: { type: 'string' },
       created: { type: 'number', format: 'unixTimestamp2000' },
       updated: { type: 'number', format: 'unixTimestamp2000' },
     })
 
     return this
   }
 
-  savedDBEntity<ID extends string | number = string>(
-    idType = 'string',
-  ): JsonSchemaObjectBuilder<T & SavedDBEntity<ID>> {
-    return this.baseDBEntity(idType).addRequired(['id', 'created', 'updated']) as any
+  savedDBEntity(): JsonSchemaObjectBuilder<T & SavedDBEntity> {
+    return this.baseDBEntity().addRequired(['id', 'created', 'updated']) as any
   }
 
   extend<T2 extends AnyObject>(s2: JsonSchemaObjectBuilder<T2>): JsonSchemaObjectBuilder<T & T2> {

diff --git a/src/types.test.ts b/src/types.test.ts
@@ -25,7 +25,7 @@ import {
 } from './types'
 import type { AppError } from '.'
 
-interface Item extends BaseDBEntity<number> {
+interface Item extends BaseDBEntity {
   a?: number
 }
 
@@ -52,13 +52,13 @@ test('saved/unsaved', () => {
 
   expectTypeOf(item).toEqualTypeOf<{
     a?: number
-    id?: number
+    id?: string
     created?: number
     updated?: number
   }>()
 
   const itemDBM: ItemDBM = {
-    id: 5, // should only allow number, but not string
+    id: '5', // should only allow string, but not number
     created: 1,
     updated: 1,
     a: 5,
@@ -67,7 +67,7 @@ test('saved/unsaved', () => {
   delete itemDBM.a
 
   expectTypeOf(itemDBM).toEqualTypeOf<{
-    id: number
+    id: string
     created: number
     updated: number
     a?: number
@@ -81,7 +81,7 @@ test('saved/unsaved', () => {
 
   expectTypeOf(unsavedItem).toEqualTypeOf<{
     a?: number
-    id?: number
+    id?: string
     created?: number
     updated?: number
   }>()
@@ -97,7 +97,7 @@ test('saved/unsaved', () => {
 
   expectTypeOf(unsavedItemDBM).toEqualTypeOf<{
     a?: number
-    id?: number
+    id?: string
     created?: number
     updated?: number
   }>()
@@ -106,7 +106,7 @@ test('saved/unsaved', () => {
   delete unsavedItemId.id
 
   expectTypeOf(unsavedItemId).toEqualTypeOf<{
-    id?: number
+    id?: string
     created: number
     updated: number
     a?: number

diff --git a/src/types.ts b/src/types.ts
@@ -25,26 +25,23 @@ export type CreatedUpdated = {
   updated: number
 }
 
-export interface CreatedUpdatedId<ID extends string | number = string | number>
-  extends CreatedUpdated {
-  id: ID
+export interface CreatedUpdatedId extends CreatedUpdated {
+  id: string
 }
 
 // eslint-disable-next-line @typescript-eslint/consistent-type-definitions
-export type ObjectWithId<ID extends string | number = string | number> = {
-  id: ID
+export type ObjectWithId = {
+  id: string
 }
 
-export interface AnyObjectWithId<ID extends string | number = string | number>
-  extends AnyObject,
-    ObjectWithId<ID> {}
+export interface AnyObjectWithId extends AnyObject, ObjectWithId {}
 
 /**
  * Base interface for any Entity that was saved to DB.
  */
 // eslint-disable-next-line @typescript-eslint/consistent-type-definitions
-export type SavedDBEntity<ID extends string | number = string> = {
-  id: ID
+export type SavedDBEntity = {
+  id: string
 
   /**
    * unixTimestamp of when the entity was first created (in the DB).
@@ -64,8 +61,8 @@ export type SavedDBEntity<ID extends string | number = string> = {
  * When it's known to be saved - `SavedDBEntity` interface can be used instead.
  */
 // eslint-disable-next-line @typescript-eslint/consistent-type-definitions
-export type BaseDBEntity<ID extends string | number = string> = {
-  id?: ID
+export type BaseDBEntity = {
+  id?: string
 
   /**
    * unixTimestamp of when the entity was first created (in the DB).
@@ -79,11 +76,11 @@ export type BaseDBEntity<ID extends string | number = string> = {
 }
 
 export type Saved<T extends Partial<ObjectWithId>> = T extends AnyObject
-  ? Omit<T, 'id' | 'created' | 'updated'> & SavedDBEntity<NonNullable<T['id']>>
+  ? Omit<T, 'id' | 'created' | 'updated'> & SavedDBEntity
   : T
 
 export type Unsaved<T extends Partial<ObjectWithId>> = T extends AnyObject
-  ? Omit<T, 'id' | 'created' | 'updated'> & BaseDBEntity<NonNullable<T['id']>>
+  ? Omit<T, 'id' | 'created' | 'updated'> & BaseDBEntity
   : T
 
 export type UnsavedId<T extends Partial<ObjectWithId>> = Omit<T, 'id'> & {