sqlite-zod-orm 3.9.0 → 3.11.0

package/src/types.ts

@@ -19,7 +19,6 @@ export const asZodObject = (s: z.ZodType<any>) => s as unknown as z.ZodObject<an
 /** Index definition: single column or composite columns */
 export type IndexDef = string | string[];
 
-/** Options for the Database constructor */
 export type DatabaseOptions<R extends RelationsConfig = RelationsConfig> = {
     indexes?: Record<string, IndexDef[]>;
     /**
@@ -42,6 +41,24 @@ export type DatabaseOptions<R extends RelationsConfig = RelationsConfig> = {
      * `.on()` will throw. Default: `true`.
      */
     reactive?: boolean;
+    /**
+     * Auto-add `createdAt` and `updatedAt` TEXT columns to every table.
+     * `createdAt` is set on insert, `updatedAt` on insert + update.
+     * Default: `false`.
+     */
+    timestamps?: boolean;
+    /**
+     * Enable soft deletes. Adds a `deletedAt` TEXT column to every table.
+     * `delete()` sets `deletedAt` instead of removing the row.
+     * Use `.withTrashed()` on queries to include soft-deleted rows.
+     * Default: `false`.
+     */
+    softDeletes?: boolean;
+    /**
+     * Log every SQL query to the console. Useful for debugging.
+     * Default: `false`.
+     */
+    debug?: boolean;
 };
 
 export type Relationship = {
@@ -144,6 +161,12 @@ export type UpdateBuilder<T> = {
     exec: () => number;
 };
 
+/** Fluent delete builder */
+export type DeleteBuilder<T> = {
+    where: (conditions: Record<string, any>) => DeleteBuilder<T>;
+    exec: () => number;
+};
+
 /** Nav-aware entity accessor for a specific table */
 export type NavEntityAccessor<
     S extends SchemaMap,
@@ -155,7 +178,7 @@ export type NavEntityAccessor<
     update: ((id: number, data: Partial<Omit<z.input<S[Table & keyof S]>, 'id'>>) => NavEntity<S, R, Table> | null)
     & ((data: Partial<Omit<z.input<S[Table & keyof S]>, 'id'>>) => UpdateBuilder<NavEntity<S, R, Table>>);
     upsert: (conditions?: Partial<z.infer<S[Table & keyof S]>>, data?: Partial<z.infer<S[Table & keyof S]>>) => NavEntity<S, R, Table>;
-    delete: (id: number) => void;
+    delete: ((id: number) => void) & (() => DeleteBuilder<NavEntity<S, R, Table>>);
     select: (...cols: (keyof z.infer<S[Table & keyof S]> & string)[]) => QueryBuilder<NavEntity<S, R, Table>>;
     on: ((event: 'insert' | 'update', callback: (row: NavEntity<S, R, Table>) => void | Promise<void>) => () => void) &
     ((event: 'delete', callback: (row: { id: number }) => void | Promise<void>) => () => void);
@@ -185,7 +208,7 @@ export type EntityAccessor<S extends z.ZodType<any>> = {
     insertMany: (rows: EntityData<S>[]) => AugmentedEntity<S>[];
     update: ((id: number, data: Partial<EntityData<S>>) => AugmentedEntity<S> | null) & ((data: Partial<EntityData<S>>) => UpdateBuilder<AugmentedEntity<S>>);
     upsert: (conditions?: Partial<InferSchema<S>>, data?: Partial<InferSchema<S>>) => AugmentedEntity<S>;
-    delete: (id: number) => void;
+    delete: ((id: number) => void) & (() => DeleteBuilder<AugmentedEntity<S>>);
     select: (...cols: (keyof InferSchema<S> & string)[]) => QueryBuilder<AugmentedEntity<S>>;
     on: ((event: 'insert' | 'update', callback: (row: AugmentedEntity<S>) => void | Promise<void>) => () => void) &
     ((event: 'delete', callback: (row: { id: number }) => void | Promise<void>) => () => void);