@vperms/sql-adapter
v0.0.6
Published
Dialect-agnostic SQL adapter base for VeguiPerms.
Maintainers
Readme
VeguiPerms SQL Adapter
@vperms/sql-adapter is the dialect-agnostic SQL base for VeguiPerms. It maps
subjects and grants to flat records while a driver handles database operations.
SQL guide · API reference · GitHub
Install
npm install @vperms/sql-adapter vpermsUse your driver
import { VeguiPermsSqlAdapter, type SqlAdapterDriver } from "@vperms/sql-adapter";
import { createVPerms } from "vperms";
export async function createPermissions(driver: SqlAdapterDriver) {
const adapter = new VeguiPermsSqlAdapter(driver);
await adapter.migrate(); // explicitly delegates schema setup to the driver
return createVPerms({ adapter });
}Implement SqlAdapterDriver to persist SubjectRecord and GrantRecord rows.
The service owns validation, inheritance and permission evaluation; the driver
only handles persistence. See the guide for the complete contract.
For ready-made SQLite, MySQL and Postgres drivers, use VeguiPerms Drizzle Adapter.
Build and coverage badges describe the whole VeguiPerms repository. License: MIT.
