sqlite-zod-orm 3.5.2 → 3.6.0

package/dist/index.js

@@ -4714,7 +4714,13 @@ class _Database {
         upsert: (conditions, data) => this.upsert(entityName, data, conditions),
         delete: (id) => this.delete(entityName, id),
         select: (...cols) => this._createQueryBuilder(entityName, cols),
-        on: (callback, options2) => this._createOnStream(entityName, callback, options2?.interval),
+        on: (event, callback, options2) => {
+          if (event === "insert")
+            return this._createOnStream(entityName, callback, options2?.interval);
+          if (event === "change")
+            return this._createChangeStream(entityName, callback, options2?.interval);
+          throw new Error(`Unknown event type: '${event}'. Supported: 'insert', 'change'`);
+        },
         _tableName: entityName
       };
       this[key] = accessor;
@@ -4793,6 +4799,61 @@ class _Database {
       stopped = true;
     };
   }
+  _createChangeStream(entityName, callback, intervalOverride) {
+    const interval = intervalOverride ?? this.pollInterval;
+    const allRows = this.db.query(`SELECT * FROM "${entityName}" ORDER BY id ASC`).all();
+    let snapshot = new Map;
+    let snapshotEntities = new Map;
+    for (const row of allRows) {
+      snapshot.set(row.id, JSON.stringify(row));
+      snapshotEntities.set(row.id, row);
+    }
+    let lastRevision = this._getRevision(entityName);
+    let stopped = false;
+    const poll = async () => {
+      if (stopped)
+        return;
+      const currentRevision = this._getRevision(entityName);
+      if (currentRevision !== lastRevision) {
+        lastRevision = currentRevision;
+        const currentRows = this.db.query(`SELECT * FROM "${entityName}" ORDER BY id ASC`).all();
+        const currentMap = new Map;
+        const currentEntities = new Map;
+        for (const row of currentRows) {
+          currentMap.set(row.id, JSON.stringify(row));
+          currentEntities.set(row.id, row);
+        }
+        for (const [id, json] of currentMap) {
+          if (stopped)
+            return;
+          if (!snapshot.has(id)) {
+            const entity = this._attachMethods(entityName, transformFromStorage(currentEntities.get(id), this.schemas[entityName]));
+            await callback({ type: "insert", row: entity });
+          } else if (snapshot.get(id) !== json) {
+            const entity = this._attachMethods(entityName, transformFromStorage(currentEntities.get(id), this.schemas[entityName]));
+            const oldEntity = this._attachMethods(entityName, transformFromStorage(snapshotEntities.get(id), this.schemas[entityName]));
+            await callback({ type: "update", row: entity, oldRow: oldEntity });
+          }
+        }
+        for (const [id] of snapshot) {
+          if (stopped)
+            return;
+          if (!currentMap.has(id)) {
+            const oldEntity = this._attachMethods(entityName, transformFromStorage(snapshotEntities.get(id), this.schemas[entityName]));
+            await callback({ type: "delete", row: oldEntity, oldRow: oldEntity });
+          }
+        }
+        snapshot = currentMap;
+        snapshotEntities = currentEntities;
+      }
+      if (!stopped)
+        setTimeout(poll, interval);
+    };
+    setTimeout(poll, interval);
+    return () => {
+      stopped = true;
+    };
+  }
   insert(entityName, data) {
     const schema = this.schemas[entityName];
     const validatedData = asZodObject(schema).passthrough().parse(data);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sqlite-zod-orm",
-  "version": "3.5.2",
+  "version": "3.6.0",
   "description": "Type-safe SQLite ORM for Bun — Zod schemas, fluent queries, auto relationships, zero SQL",
   "type": "module",
   "main": "./dist/index.js",

package/src/database.ts

@@ -59,8 +59,11 @@ class _Database<Schemas extends SchemaMap> {
                 upsert: (conditions, data) => this.upsert(entityName, data, conditions),
                 delete: (id) => this.delete(entityName, id),
                 select: (...cols: string[]) => this._createQueryBuilder(entityName, cols),
-                on: (callback: (row: any) => void | Promise<void>, options?: { interval?: number }) =>
-                    this._createOnStream(entityName, callback, options?.interval),
+                on: (event: string, callback: (row: any) => void | Promise<void>, options?: { interval?: number }) => {
+                    if (event === 'insert') return this._createOnStream(entityName, callback, options?.interval);
+                    if (event === 'change') return this._createChangeStream(entityName, callback, options?.interval);
+                    throw new Error(`Unknown event type: '${event}'. Supported: 'insert', 'change'`);
+                },
                 _tableName: entityName,
             };
             (this as any)[key] = accessor;
@@ -201,6 +204,94 @@ class _Database<Schemas extends SchemaMap> {
         return () => { stopped = true; };
     }
 
+    /**
+     * Stream all mutations (insert / update / delete) as ChangeEvent objects.
+     *
+     * Maintains a full snapshot and diffs on each poll.
+     * Heavier than _createOnStream (which only tracks watermark), but catches all changes.
+     */
+    public _createChangeStream(
+        entityName: string,
+        callback: (event: any) => void | Promise<void>,
+        intervalOverride?: number,
+    ): () => void {
+        const interval = intervalOverride ?? this.pollInterval;
+
+        // Build initial snapshot: Map<id, serialized row>
+        const allRows = this.db.query(`SELECT * FROM "${entityName}" ORDER BY id ASC`).all() as any[];
+        let snapshot = new Map<number, string>();
+        let snapshotEntities = new Map<number, any>();
+        for (const row of allRows) {
+            snapshot.set(row.id, JSON.stringify(row));
+            snapshotEntities.set(row.id, row);
+        }
+
+        let lastRevision: string = this._getRevision(entityName);
+        let stopped = false;
+
+        const poll = async () => {
+            if (stopped) return;
+
+            const currentRevision = this._getRevision(entityName);
+            if (currentRevision !== lastRevision) {
+                lastRevision = currentRevision;
+
+                const currentRows = this.db.query(`SELECT * FROM "${entityName}" ORDER BY id ASC`).all() as any[];
+                const currentMap = new Map<number, string>();
+                const currentEntities = new Map<number, any>();
+                for (const row of currentRows) {
+                    currentMap.set(row.id, JSON.stringify(row));
+                    currentEntities.set(row.id, row);
+                }
+
+                // Detect inserts and updates
+                for (const [id, json] of currentMap) {
+                    if (stopped) return;
+                    if (!snapshot.has(id)) {
+                        // INSERT
+                        const entity = this._attachMethods(
+                            entityName,
+                            transformFromStorage(currentEntities.get(id), this.schemas[entityName]!)
+                        );
+                        await callback({ type: 'insert', row: entity });
+                    } else if (snapshot.get(id) !== json) {
+                        // UPDATE
+                        const entity = this._attachMethods(
+                            entityName,
+                            transformFromStorage(currentEntities.get(id), this.schemas[entityName]!)
+                        );
+                        const oldEntity = this._attachMethods(
+                            entityName,
+                            transformFromStorage(snapshotEntities.get(id), this.schemas[entityName]!)
+                        );
+                        await callback({ type: 'update', row: entity, oldRow: oldEntity });
+                    }
+                }
+
+                // Detect deletes
+                for (const [id] of snapshot) {
+                    if (stopped) return;
+                    if (!currentMap.has(id)) {
+                        const oldEntity = this._attachMethods(
+                            entityName,
+                            transformFromStorage(snapshotEntities.get(id), this.schemas[entityName]!)
+                        );
+                        await callback({ type: 'delete', row: oldEntity, oldRow: oldEntity });
+                    }
+                }
+
+                snapshot = currentMap;
+                snapshotEntities = currentEntities;
+            }
+
+            if (!stopped) setTimeout(poll, interval);
+        };
+
+        setTimeout(poll, interval);
+
+        return () => { stopped = true; };
+    }
+
     // ===========================================================================
     // CRUD
     // ===========================================================================

package/src/index.ts

@@ -7,7 +7,7 @@ export { Database } from './database';
 export type { DatabaseType } from './database';
 
 export type {
-    SchemaMap, DatabaseOptions, Relationship,
+    SchemaMap, DatabaseOptions, Relationship, ChangeEvent,
     EntityAccessor, TypedAccessors, AugmentedEntity, UpdateBuilder,
     InferSchema, EntityData, IndexDef,
     ProxyColumns, ColumnRef,

package/src/types.ts

@@ -45,6 +45,13 @@ export type Relationship = {
     foreignKey: string;
 };
 
+/** Change event emitted by .on('change', callback) */
+export type ChangeEvent<T = any> = {
+    type: 'insert' | 'update' | 'delete';
+    row: T;
+    oldRow?: T;   // present on 'update' and 'delete'
+};
+
 // =============================================================================
 // Type Helpers
 // =============================================================================
@@ -149,12 +156,18 @@ export type NavEntityAccessor<
     delete: (id: number) => void;
     select: (...cols: (keyof z.infer<S[Table & keyof S]> & string)[]) => QueryBuilder<NavEntity<S, R, Table>>;
     /**
-     * Stream new rows one at a time, in insertion order.
-     * Only emits rows inserted AFTER subscription starts.
+     * Listen for table events.
+     *
+     * `'insert'` — streams new rows one at a time, in insertion order.
+     * `'change'` — streams all mutations: { type: 'insert'|'update'|'delete', row, oldRow? }.
+     *
      * Callbacks are awaited — strict ordering guaranteed even with async handlers.
      * @returns Unsubscribe function.
      */
-    on: (callback: (row: NavEntity<S, R, Table>) => void | Promise<void>, options?: { interval?: number }) => () => void;
+    on: {
+        (event: 'insert', callback: (row: NavEntity<S, R, Table>) => void | Promise<void>, options?: { interval?: number }): () => void;
+        (event: 'change', callback: (event: ChangeEvent<NavEntity<S, R, Table>>) => void | Promise<void>, options?: { interval?: number }): () => void;
+    };
     _tableName: string;
     readonly _schema?: S[Table & keyof S];
 };
@@ -181,12 +194,18 @@ export type EntityAccessor<S extends z.ZodType<any>> = {
     delete: (id: number) => void;
     select: (...cols: (keyof InferSchema<S> & string)[]) => QueryBuilder<AugmentedEntity<S>>;
     /**
-     * Stream new rows one at a time, in insertion order.
-     * Only emits rows inserted AFTER subscription starts.
+     * Listen for table events.
+     *
+     * `'insert'` — streams new rows one at a time, in insertion order.
+     * `'change'` — streams all mutations: { type: 'insert'|'update'|'delete', row, oldRow? }.
+     *
      * Callbacks are awaited — strict ordering guaranteed even with async handlers.
      * @returns Unsubscribe function.
      */
-    on: (callback: (row: AugmentedEntity<S>) => void | Promise<void>, options?: { interval?: number }) => () => void;
+    on: {
+        (event: 'insert', callback: (row: AugmentedEntity<S>) => void | Promise<void>, options?: { interval?: number }): () => void;
+        (event: 'change', callback: (event: ChangeEvent<AugmentedEntity<S>>) => void | Promise<void>, options?: { interval?: number }): () => void;
+    };
     _tableName: string;
     readonly _schema?: S;
 };