Add query event type definitions (#5)

* Added binlog query event type definition

* Added changeset

* Try EventEmitter type declaration for Zongji class

* Only emit rotate events when the binlog file has actually changed.

* Revert rotate event, change. Rotate events should always be emited on listener startup.

* Added filter function support to include/exclude tables in a db schema based on the result of the function.

* Updated changeset

* Updated dev-packages github action to not run on pushes to main.

Author: Rentacookie

.changeset/five-otters-attack.md

@@ -0,0 +1,7 @@
+---
+'@powersync/mysql-zongji': minor
+---
+
+- Added type definitions for binlog query event
+- Added the ability to provide a table filter function for including/excluding binlog events
+- Updated Zongji class type definition

.github/workflows/dev-packages.yaml

@@ -4,6 +4,11 @@ name: Create Dev Release
 
 on:
   push:
+    branches:
+      - '**'
+      - '!main' # excludes main, this is handled by changesets
+    tags-ignore:
+      - '**'
 
 jobs:
   publish:

index.js

@@ -325,10 +325,14 @@ ZongJi.prototype._skipSchema = function (database, table) {
   let included =
     includes === undefined ||
     (database in includes &&
-      (includes[database] === true || (Array.isArray(includes[database]) && includes[database].indexOf(table) > -1)));
+      (includes[database] === true ||
+        (Array.isArray(includes[database]) && includes[database].indexOf(table) > -1) ||
+        (typeof includes[database] === 'function' && includes[database](table))));
   let excluded =
     database in excludes &&
-    (excludes[database] === true || (Array.isArray(excludes[database]) && excludes[database].indexOf(table) > -1));
+    (excludes[database] === true ||
+      (Array.isArray(excludes[database]) && excludes[database].indexOf(table) > -1) ||
+      (typeof excludes[database] === 'function' && excludes[database](table)));
 
   return excluded || !included;
 };

test/filtering.js

@@ -45,6 +45,17 @@ tap.test('Unit test', (test) => {
     test.end();
   });
 
+  test.test('FilterFunction includes', (test) => {
+    zongji._filters({
+      includeSchema: { db1: (table) => table === 'just_me' }
+    });
+    test.ok(!zongji._skipSchema('db1', 'just_me'));
+    test.ok(zongji._skipSchema('db2', 'anything_else'));
+    test.ok(zongji._skipSchema('db1', 'not_me'));
+
+    test.end();
+  });
+
   test.test((test) => {
     zongji._filters({
       excludeSchema: { db1: ['not_me'] }
@@ -57,6 +68,18 @@ tap.test('Unit test', (test) => {
     test.end();
   });
 
+  test.test('FilterFunction excludes', (test) => {
+    zongji._filters({
+      excludeSchema: { db1: (table) => table === 'not_me' }
+    });
+
+    test.ok(!zongji._skipSchema('db1', 'anything_else'));
+    test.ok(!zongji._skipSchema('db2', 'anything_else'));
+    test.ok(zongji._skipSchema('db1', 'not_me'));
+
+    test.end();
+  });
+
   test.test((test) => {
     zongji._filters({
       excludeEvents: ['rotate']
@@ -79,7 +102,7 @@ tap.test('Unit test', (test) => {
   test.end();
 });
 
-tap.test('Exclue all the schema', (test) => {
+tap.test('Exclude all the schema', (test) => {
   const zongji = new ZongJi(settings.connection);
 
   const eventLog = [];

types/index.d.ts

@@ -1,4 +1,5 @@
 import { Socket } from 'net';
+import { EventEmitter } from 'events';
 
 /**
  *  The types described here were added on an adhoc basis based on requirements in the Powersync Service.
@@ -20,10 +21,11 @@ export type ZongjiOptions = {
 
 /**
  *  Record specifying a database and specific tables. ie. ['MyDatabase']: ['table1', 'table2']
- *  Alternatively specifying true will include all tables in the database.
+ *  OR a filter function that returns true for tables that should be included
+ *  OR specifying true will include all tables in the database.
  */
 interface DatabaseFilter {
-  [databaseName: string]: string[] | true;
+  [databaseName: string]: string[] | true | ((table: string) => boolean);
 }
 
 export type StartOptions = {
@@ -153,13 +155,22 @@ export type BinLogTableMapEvent = BaseBinLogEvent & {
   columnTypes: number[];
 };
 
+export type BinLogQueryEvent = BaseBinLogEvent & {
+  query: string;
+  executionTime: number;
+  errorCode: number;
+  schema: string;
+  statusVars: string;
+};
+
 export type BinLogEvent =
   | BinLogRotationEvent
   | BinLogGTIDLogEvent
   | BinLogXidEvent
   | BinLogRowEvent
   | BinLogRowUpdateEvent
-  | BinLogTableMapEvent;
+  | BinLogTableMapEvent
+  | BinLogQueryEvent;
 
 // @vlasky/mysql Connection
 export interface MySQLConnection {
@@ -168,7 +179,7 @@ export interface MySQLConnection {
   query(sql: string, callback: (error: any, results: any, fields: any) => void): void;
 }
 
-export declare class ZongJi {
+export declare class ZongJi extends EventEmitter {
   stopped: boolean;
   connection: MySQLConnection;
   constructor(options: ZongjiOptions);
@@ -177,6 +188,4 @@ export declare class ZongJi {
   stop(): void;
   pause(): void;
   resume(): void;
-
-  on(type: 'binlog' | string, callback: (event: BinLogEvent) => void): void;
 }