Added typescript types declarations

Bumped node version to 22

Author: Rentacookie

.github/workflows/dev-packages.yaml

@@ -17,7 +17,7 @@ jobs:
         uses: actions/setup-node@v4
         with:
           node-version-file: '.nvmrc'
-      - uses: pnpm/action-setup@v2
+      - uses: pnpm/action-setup@v4
         name: Install pnpm
         with:
           version: 9

.github/workflows/test.yml

@@ -26,16 +26,14 @@ jobs:
           -e MYSQL_ROOT_PASSWORD=my_password \
           -p 3306:3306 \
           -d mysql:${{ matrix.mysql-version }} \
-          --server-id=1 \
-          --log-bin=/var/lib/mysql/mysql-bin.log \
-          --binlog-format=row
+          --log-bin=/var/lib/mysql/mysql-bin.log
 
       - name: Setup NodeJS
         uses: actions/setup-node@v4
         with:
           node-version-file: '.nvmrc'
 
-      - uses: pnpm/action-setup@v2
+      - uses: pnpm/action-setup@v4
         name: Install pnpm
         with:
           version: 9

.nvmrc

@@ -1 +1 @@
-v20.12.2
+v22.14.0

package.json

@@ -11,6 +11,7 @@
   },
   "scripts": {
     "release": "pnpm changeset publish",
+    "build": "cd types && tsc -b",
     "test": "tap run --disable-coverage --allow-incomplete-coverage -- --sequential test/suites.js",
     "format": "prettier --write ."
   },

pnpm-lock.yaml

@@ -1,4 +1,3 @@
 packages:
-  - './'
-  # exclude packages that are inside test directories
-  - '!test/*'
+  - 'lib'
+  - 'types'

pnpm-workspace.yaml

@@ -0,0 +1,129 @@
+import { Socket } from 'net';
+
+export type ZongjiOptions = {
+  host: string;
+  user: string;
+  password: string;
+  dateStrings?: boolean;
+  timeZone?: string;
+};
+
+interface DatabaseFilter {
+  [databaseName: string]: string[] | true;
+}
+
+export type StartOptions = {
+  includeEvents?: string[];
+  excludeEvents?: string[];
+  /**
+   *  Describe which databases and tables to include (Only for row events). Use database names as the key and pass an array of table names or true (for the entire database).
+   *  Example: { 'my_database': ['allow_table', 'another_table'], 'another_db': true }
+   */
+  includeSchema?: DatabaseFilter;
+  /**
+   *  Object describing which databases and tables to exclude (Same format as includeSchema)
+   *  Example: { 'other_db': ['disallowed_table'], 'ex_db': true }
+   */
+  excludeSchema?: DatabaseFilter;
+  /**
+   * BinLog position filename to start reading events from
+   */
+  filename?: string;
+  /**
+   * BinLog position offset to start reading events from in file specified
+   */
+  position?: number;
+
+  /**
+   *  Unique server ID for this replication client.
+   */
+  serverId?: number;
+};
+
+export type ColumnSchema = {
+  COLUMN_NAME: string;
+  COLLATION_NAME: string;
+  CHARACTER_SET_NAME: string;
+  COLUMN_COMMENT: string;
+  COLUMN_TYPE: string;
+};
+
+export type ColumnDefinition = {
+  name: string;
+  charset: string;
+  type: number;
+  metadata: Record<string, any>;
+};
+
+export type TableMapEntry = {
+  columnSchemas: ColumnSchema[];
+  parentSchema: string;
+  tableName: string;
+  columns: ColumnDefinition[];
+};
+
+export type BaseBinLogEvent = {
+  timestamp: number;
+  getEventName(): string;
+
+  /**
+   * Next position in BinLog file to read from after
+   * this event.
+   */
+  nextPosition: number;
+  /**
+   * Size of this event
+   */
+  size: number;
+  flags: number;
+  useChecksum: boolean;
+};
+
+export type BinLogRotationEvent = BaseBinLogEvent & {
+  binlogName: string;
+  position: number;
+};
+
+export type BinLogGTIDLogEvent = BaseBinLogEvent & {
+  serverId: Buffer;
+  transactionRange: number;
+};
+
+export type BinLogXidEvent = BaseBinLogEvent & {
+  xid: number;
+};
+
+export type BinLogMutationEvent = BaseBinLogEvent & {
+  tableId: number;
+  numberOfColumns: number;
+  tableMap: Record<string, TableMapEntry>;
+  rows: Record<string, any>[];
+};
+
+export type BinLogUpdateEvent = Omit<BinLogMutationEvent, 'rows'> & {
+  rows: {
+    before: Record<string, any>;
+    after: Record<string, any>;
+  }[];
+};
+
+export type BinLogEvent = BinLogRotationEvent | BinLogGTIDLogEvent | BinLogXidEvent | BinLogMutationEvent;
+
+// @vlasky/mysql Connection
+export interface MySQLConnection {
+  _socket?: Socket;
+  /** There are other forms of this method as well - this is the most basic one. */
+  query(sql: string, callback: (error: any, results: any, fields: any) => void): void;
+}
+
+export default class ZongJi {
+  connection: MySQLConnection;
+  constructor(options: ZongjiOptions);
+
+  start(options: StartOptions): void;
+  stop(): void;
+  pause(): void;
+  resume(): void;
+
+  on(type: 'binlog' | string, callback: (event: BinLogEvent) => void);
+}

types/index.d.ts

@@ -0,0 +1,13 @@
+{
+  "name": "@powersync/types-mysql-zongji",
+  "version": "0.0.1",
+  "description": "Types package for Powersync MySQL ZongJi",
+  "main": "",
+  "types": "index.d.ts",
+  "scripts": {
+    "build": "tsc -b"
+  },
+  "devDependencies": {
+    "typescript": "^5.8.3"
+  }
+}

types/package.json

@@ -0,0 +1,13 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "strict": true,
+    "declaration": true,
+    "emitDeclarationOnly": true,
+    "skipLibCheck": true,
+    "esModuleInterop": true
+  },
+  "include": ["index.d.ts"]
+}