fix: revert created/updated of BaseDBEntity to still be optional

NaturalCycles · Jan 21, 2024 · 1cdc9ba · 1cdc9ba
1 parent fcb1fac
commit 1cdc9ba
Show file tree

Hide file tree

Showing 8 changed files with 30 additions and 21 deletions.
diff --git a/src/json-schema/__snapshots__/jsonSchemaBuilder.test.ts.snap b/src/json-schema/__snapshots__/jsonSchemaBuilder.test.ts.snap
@@ -44,9 +44,7 @@ exports[`addressBMJsonSchema 1`] = `
     "address1",
     "city",
     "countryCode",
-    "created",
     "id",
-    "updated",
     "zip",
   ],
   "type": "object",
@@ -97,9 +95,7 @@ exports[`addressDBMJsonSchema 1`] = `
     "address1",
     "city",
     "countryCode",
-    "created",
     "id",
-    "updated",
     "zip",
   ],
   "type": "object",

diff --git a/src/json-schema/jsonSchemaBuilder.test.ts b/src/json-schema/jsonSchemaBuilder.test.ts
@@ -38,8 +38,8 @@ const addressDBMJsonSchema2 = baseDBEntityJsonSchema.extend(addressJsonSchema)
 const addressBMJsonSchema3 = addressJsonSchema.extend(
   jsonSchema.object<BaseDBEntity>({
     id: jsonSchema.string(),
-    created: jsonSchema.unixTimestamp2000(),
-    updated: jsonSchema.unixTimestamp2000(),
+    created: jsonSchema.unixTimestamp2000().optional(),
+    updated: jsonSchema.unixTimestamp2000().optional(),
   }),
 )
 

diff --git a/src/json-schema/jsonSchemaBuilder.ts b/src/json-schema/jsonSchemaBuilder.ts
@@ -374,7 +374,7 @@ export class JsonSchemaObjectBuilder<T extends AnyObject> extends JsonSchemaAnyB
       updated: { type: 'number', format: 'unixTimestamp2000' },
     })
 
-    return this.addRequired(['id', 'created', 'updated']) as any
+    return this.addRequired(['id']) as any
   }
 
   extend<T2 extends AnyObject>(s2: JsonSchemaObjectBuilder<T2>): JsonSchemaObjectBuilder<T & T2> {

diff --git a/src/json-schema/jsonSchemas.ts b/src/json-schema/jsonSchemas.ts
@@ -3,8 +3,8 @@ import { jsonSchema } from './jsonSchemaBuilder'
 
 export const baseDBEntityJsonSchema = jsonSchema.object<BaseDBEntity>({
   id: jsonSchema.string(),
-  created: jsonSchema.unixTimestamp2000(),
-  updated: jsonSchema.unixTimestamp2000(),
+  created: jsonSchema.unixTimestamp2000().optional(),
+  updated: jsonSchema.unixTimestamp2000().optional(),
 })
 
 // export const savedDBEntityJsonSchema = jsonSchema.object<SavedDBEntity>({

diff --git a/src/types.test.ts b/src/types.test.ts
@@ -8,6 +8,7 @@ import type {
   UnsavedId,
   AnyObject,
   MonthId,
+  Saved,
 } from './types'
 import {
   _noop,
@@ -66,6 +67,14 @@ test('saved/unsaved', () => {
   delete itemDBM.a
 
   expectTypeOf(itemDBM).toEqualTypeOf<{
+    id: string
+    created?: number
+    updated?: number
+    a?: number
+  }>()
+
+  const savedItemDBM = itemDBM as Saved<ItemDBM>
+  expectTypeOf(savedItemDBM).toEqualTypeOf<{
     id: string
     created: number
     updated: number
@@ -106,8 +115,8 @@ test('saved/unsaved', () => {
 
   expectTypeOf(unsavedItemId).toEqualTypeOf<{
     id?: string
-    created: number
-    updated: number
+    created?: number
+    updated?: number
     a?: number
   }>()
 })

diff --git a/src/types.ts b/src/types.ts
@@ -53,18 +53,25 @@ export type BaseDBEntity = {
   /**
    * unixTimestamp of when the entity was first created (in the DB).
    */
-  created: UnixTimestampNumber
+  created?: UnixTimestampNumber
 
   /**
    * unixTimestamp of when the entity was last updated (in the DB).
    */
-  updated: UnixTimestampNumber
+  updated?: UnixTimestampNumber
 }
 
-export type Saved<T> = T & BaseDBEntity
+export type Saved<T> = T & {
+  created: UnixTimestampNumber
+  updated: UnixTimestampNumber
+}
 
 export type Unsaved<T> = T extends AnyObject
-  ? Omit<T, 'id' | 'created' | 'updated'> & Partial<BaseDBEntity>
+  ? Omit<T, 'id' | 'created' | 'updated'> & {
+      id?: string
+      created?: UnixTimestampNumber
+      updated?: UnixTimestampNumber
+    }
   : T
 
 export type UnsavedId<T> = Omit<T, 'id'> & {

diff --git a/src/zod/zod.shared.schemas.ts b/src/zod/zod.shared.schemas.ts
@@ -94,8 +94,8 @@ export const zSlug = z
 export const zBaseDBEntity = z
   .object({
     id: z.string(),
-    created: zUnixTimestamp2000,
-    updated: zUnixTimestamp2000,
+    created: zUnixTimestamp2000.optional(),
+    updated: zUnixTimestamp2000.optional(),
   })
   .describe('BaseDBEntity')
 

diff --git a/src/zod/zod.test.ts b/src/zod/zod.test.ts
@@ -16,10 +16,7 @@ test('basic', () => {
 Input:
 {}
 
-3 issues:
-id: Required
-created: Required
-updated: Required"
+id: Required"
 `)
 
   expect(zSafeValidate(' a' as any, zBaseDBEntity).error!.message).toMatchInlineSnapshot(`