Merge pull request #951 from objectstack-ai/copilot/migrate-driver-sql-plugin

Author: hotlong

CHANGELOG.md

@@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+- **`@objectstack/driver-sql` plugin** — Migrated the Knex-based SQL driver from `@objectql/driver-sql`
+  into `packages/plugins/driver-sql/`. The driver implements the standard `DriverInterface` from
+  `@objectstack/core` and imports types from `@objectstack/spec/data`. Supports PostgreSQL, MySQL,
+  and SQLite (via `better-sqlite3`). Includes schema sync, introspection, aggregation, window
+  functions, transactions, and full CRUD with both QueryAST and legacy filter format support.
+  All 72 unit tests pass against in-memory SQLite.
+
 ### Changed
 - **Migrate API layer to Hono + Vercel Node adapter** — Replaced the vestigial Next.js-style
   `api/[...path].ts` catch-all with a proper `api/index.ts` Hono entrypoint using `handle(app)`

package.json

@@ -52,6 +52,14 @@
   "pnpm": {
     "overrides": {
       "minimatch@<10.2.1": "10.2.1"
-    }
+    },
+    "ignoredBuiltDependencies": [
+      "@nestjs/core",
+      "@prisma/engines",
+      "@vscode/vsce-sign",
+      "keytar",
+      "prisma",
+      "yarn"
+    ]
   }
 }

packages/plugins/driver-sql/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@objectstack/driver-sql",
+  "version": "3.2.9",
+  "license": "Apache-2.0",
+  "description": "SQL Driver for ObjectStack - Supports PostgreSQL, MySQL, SQLite via Knex",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "scripts": {
+    "build": "tsup --config ../../../tsup.config.ts",
+    "dev": "tsc -w",
+    "test": "vitest run"
+  },
+  "dependencies": {
+    "@objectstack/core": "workspace:*",
+    "@objectstack/spec": "workspace:*",
+    "knex": "^3.1.0",
+    "nanoid": "^3.3.11"
+  },
+  "devDependencies": {
+    "@types/node": "^25.5.0",
+    "better-sqlite3": "^11.9.1",
+    "typescript": "^5.0.0",
+    "vitest": "^4.1.0"
+  }
+}

packages/plugins/driver-sql/src/index.ts

@@ -0,0 +1,30 @@
+// Copyright (c) 2025 ObjectStack. Licensed under the Apache-2.0 license.
+
+import { SqlDriver } from './sql-driver.js';
+
+export { SqlDriver };
+export type {
+  SqlDriverConfig,
+  IntrospectedSchema,
+  IntrospectedTable,
+  IntrospectedColumn,
+  IntrospectedForeignKey,
+} from './sql-driver.js';
+
+export default {
+  id: 'com.objectstack.driver.sql',
+  version: '1.0.0',
+
+  onEnable: async (context: any) => {
+    const { logger, config, drivers } = context;
+    logger.info('[SQL Driver] Initializing...');
+
+    if (drivers) {
+      const driver = new SqlDriver(config);
+      drivers.register(driver);
+      logger.info(`[SQL Driver] Registered driver: ${driver.name}`);
+    } else {
+      logger.warn('[SQL Driver] No driver registry found in context.');
+    }
+  },
+};