feat: BaseDBEntity now has all fields required (id/created/updated)

Same as what SavedDBEntity was before.

src/json-schema/__snapshots__/jsonSchemaBuilder.test.ts.snap

@@ -44,6 +44,9 @@ exports[`addressBMJsonSchema 1`] = `
     "address1",
     "city",
     "countryCode",
+    "created",
+    "id",
+    "updated",
     "zip",
   ],
   "type": "object",
@@ -94,6 +97,9 @@ exports[`addressDBMJsonSchema 1`] = `
     "address1",
     "city",
     "countryCode",
+    "created",
+    "id",
+    "updated",
     "zip",
   ],
   "type": "object",

src/json-schema/jsonSchemaBuilder.test.ts

@@ -37,9 +37,9 @@ const addressDBMJsonSchema2 = baseDBEntityJsonSchema.extend(addressJsonSchema)
 // alternative 2
 const addressBMJsonSchema3 = addressJsonSchema.extend(
   jsonSchema.object<BaseDBEntity>({
-    id: jsonSchema.string().optional(),
-    created: jsonSchema.unixTimestamp2000().optional(),
-    updated: jsonSchema.unixTimestamp2000().optional(),
+    id: jsonSchema.string(),
+    created: jsonSchema.unixTimestamp2000(),
+    updated: jsonSchema.unixTimestamp2000(),
   }),
 )
 

src/json-schema/jsonSchemaBuilder.ts

@@ -5,7 +5,6 @@ import type {
   JsonSchemaArray,
   JsonSchemaOneOf,
   JsonSchemaTuple,
-  SavedDBEntity,
   AnyObject,
 } from '../index'
 import { mergeJsonSchemaObjects, _deepCopy, _sortObject } from '../index'
@@ -375,11 +374,7 @@ export class JsonSchemaObjectBuilder<T extends AnyObject> extends JsonSchemaAnyB
       updated: { type: 'number', format: 'unixTimestamp2000' },
     })
 
-    return this
-  }
-
-  savedDBEntity(): JsonSchemaObjectBuilder<T & SavedDBEntity> {
-    return this.baseDBEntity().addRequired(['id', 'created', 'updated']) as any
+    return this.addRequired(['id', 'created', 'updated']) as any
   }
 
   extend<T2 extends AnyObject>(s2: JsonSchemaObjectBuilder<T2>): JsonSchemaObjectBuilder<T & T2> {

src/json-schema/jsonSchemas.ts

@@ -1,14 +1,14 @@
-import type { BaseDBEntity, SavedDBEntity } from '../types'
+import type { BaseDBEntity } from '../types'
 import { jsonSchema } from './jsonSchemaBuilder'
 
 export const baseDBEntityJsonSchema = jsonSchema.object<BaseDBEntity>({
-  id: jsonSchema.string().optional(),
-  created: jsonSchema.unixTimestamp2000().optional(),
-  updated: jsonSchema.unixTimestamp2000().optional(),
-})
-
-export const savedDBEntityJsonSchema = jsonSchema.object<SavedDBEntity>({
   id: jsonSchema.string(),
   created: jsonSchema.unixTimestamp2000(),
   updated: jsonSchema.unixTimestamp2000(),
 })
+
+// export const savedDBEntityJsonSchema = jsonSchema.object<SavedDBEntity>({
+//   id: jsonSchema.string(),
+//   created: jsonSchema.unixTimestamp2000(),
+//   updated: jsonSchema.unixTimestamp2000(),
+// })

src/types.test.ts

@@ -4,7 +4,6 @@ import type {
   Reviver,
   StringMap,
   BaseDBEntity,
-  Saved,
   Unsaved,
   UnsavedId,
   AnyObject,
@@ -29,7 +28,7 @@ interface Item extends BaseDBEntity {
   a?: number
 }
 
-interface ItemDBM extends Saved<Item> {}
+interface ItemDBM extends Item {}
 
 const _ym: MonthId = '2021-01'
 
@@ -44,7 +43,7 @@ test('saved/unsaved', () => {
     a: number
   }>()
 
-  const item: Item = {}
+  const item = {} as Unsaved<Item>
   delete item.a
   delete item.id
   delete item.created
@@ -177,7 +176,7 @@ test('_typeCast', () => {
 })
 
 test('_objectAssign', () => {
-  const item: Item = {}
+  const item = {} as Item
 
   // No TypeScript error here
   Object.assign(item, {

src/types.ts

@@ -47,7 +47,7 @@ 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 = {
+export type BaseDBEntity = {
   id: string
 
   /**
@@ -61,31 +61,10 @@ export type SavedDBEntity = {
   updated: UnixTimestampNumber
 }
 
-/**
- * Base interface for any Entity that can be saved to DB.
- * This interface fits when entity was NOT YET saved to DB,
- * hence `id`, `created` and `updated` fields CAN BE undefined (yet).
- * 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?: string
-
-  /**
-   * unixTimestamp of when the entity was first created (in the DB).
-   */
-  created?: UnixTimestampNumber
-
-  /**
-   * unixTimestamp of when the entity was last updated (in the DB).
-   */
-  updated?: UnixTimestampNumber
-}
-
-export type Saved<T> = T & SavedDBEntity
+export type Saved<T> = T & BaseDBEntity
 
 export type Unsaved<T> = T extends AnyObject
-  ? Omit<T, 'id' | 'created' | 'updated'> & BaseDBEntity
+  ? Omit<T, 'id' | 'created' | 'updated'> & Partial<BaseDBEntity>
   : T
 
 export type UnsavedId<T> = Omit<T, 'id'> & {

src/zod/zod.shared.schemas.ts

@@ -93,10 +93,10 @@ export const zSlug = z
 
 export const zBaseDBEntity = z
   .object({
-    id: z.string().optional(),
-    created: zUnixTimestamp2000.optional(),
-    updated: zUnixTimestamp2000.optional(),
+    id: z.string(),
+    created: zUnixTimestamp2000,
+    updated: zUnixTimestamp2000,
   })
   .describe('BaseDBEntity')
 
-export const zSavedDBEntity = zBaseDBEntity.required().describe('SavedDBEntity')
+// export const zSavedDBEntity = zBaseDBEntity.required().describe('SavedDBEntity')

src/zod/zod.test.ts

@@ -1,26 +1,26 @@
 import { _expectedError } from '../error/try'
-import { zBaseDBEntity, zEmail, zIsoDateString, zSavedDBEntity } from './zod.shared.schemas'
+import { zBaseDBEntity, zEmail, zIsoDateString } from './zod.shared.schemas'
 import { ZodValidationError, zSafeValidate, zValidate } from './zod.util'
 
 test('basic', () => {
-  const err = _expectedError(() => zValidate({} as any, zSavedDBEntity), ZodValidationError)
+  const err = _expectedError(() => zValidate({} as any, zBaseDBEntity), ZodValidationError)
   expect(err).toBeInstanceOf(Error)
   expect(err).toBeInstanceOf(ZodValidationError)
   expect(err.name).toBe('ZodError')
   expect(err.annotate()).toBe(err.message)
   expect(err.toString()).toBe(err.message)
-  expect(err.stack!.split('\n')[0]).toMatchInlineSnapshot(`"ZodError: Invalid SavedDBEntity"`)
+  expect(err.stack!.split('\n')[0]).toMatchInlineSnapshot(`"ZodError: Invalid BaseDBEntity"`)
   expect(err.message).toMatchInlineSnapshot(`
-    "Invalid SavedDBEntity
+"Invalid BaseDBEntity
 
-    Input:
-    {}
+Input:
+{}
 
-    3 issues:
-    id: Required
-    created: Required
-    updated: Required"
-  `)
+3 issues:
+id: Required
+created: Required
+updated: Required"
+`)
 
   expect(zSafeValidate(' a' as any, zBaseDBEntity).error!.message).toMatchInlineSnapshot(`
     "Invalid BaseDBEntity