@anievo-id/rbac-evolution-drizzle 0.8.0 → 1.0.0-rc.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +20 -142
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -1,18 +1,7 @@
1
1
  # @anievo-id/rbac-evolution-drizzle
2
2
 
3
- 📖 **[Documentation](https://creation.anievo.id/rbac-evolution/adapters/drizzle)**
4
-
5
- [Drizzle ORM](https://orm.drizzle.team) storage adapter for [rbac-evolution](https://github.com/AniEvo-ID/rbac-evolution) — roles & permissions for JS/TS, inspired by spatie/laravel-permission.
6
-
7
- Supported dialects:
8
-
9
- | Dialect | Entry point | Drivers |
10
- | ---------- | --------------------------------------------- | --------------------------------------------------------------- |
11
- | PostgreSQL | `@anievo-id/rbac-evolution-drizzle/pg` | node-postgres, postgres.js, Neon, Vercel Postgres, PGlite, ... |
12
- | SQLite | `@anievo-id/rbac-evolution-drizzle/sqlite` | libsql / Turso, better-sqlite3, Bun SQLite, Cloudflare D1, ... |
13
- | MySQL | `@anievo-id/rbac-evolution-drizzle/mysql` | mysql2, PlanetScale, TiDB Serverless, ... (MySQL 8, MariaDB) |
14
-
15
- Everything is also re-exported from the package root.
3
+ [Drizzle ORM](https://orm.drizzle.team) storage adapter for [RBAC Evolution](https://github.com/AniEvo-ID/rbac-evolution),
4
+ for PostgreSQL, SQLite and MySQL.
16
5
 
17
6
  ## Install
18
7
 
@@ -20,153 +9,42 @@ Everything is also re-exported from the package root.
20
9
  npm i @anievo-id/rbac-evolution @anievo-id/rbac-evolution-drizzle drizzle-orm
21
10
  ```
22
11
 
23
- ## Tables
24
-
25
- The schema mirrors spatie/laravel-permission:
26
-
27
- | Table | Columns |
28
- | ----------------------- | ------------------------------------------------------------------------------------------- |
29
- | `permissions` | `id` (auto-increment), `name`, `guard_name`, `created_at`, `updated_at` — unique `(name, guard_name)` |
30
- | `roles` | `id` (auto-increment), `name`, `guard_name`, `team_id`, `created_at`, `updated_at` — unique `(name, guard_name, team_id)` |
31
- | `role_has_permissions` | `role_id`, `permission_id` — composite PK |
32
- | `model_has_roles` | `role_id`, `subject_type`, `subject_id`, `team_id` — composite PK |
33
- | `model_has_permissions` | `permission_id`, `subject_type`, `subject_id`, `team_id` — composite PK |
34
-
35
- - `subject_type` / `subject_id` are `text` (MySQL: `varchar(191)`), so subjects may have numeric **or** string (UUID, cuid, ...) ids.
36
- - `team_id` is `text NOT NULL` (MySQL: `varchar(191)`); the empty string `''` means "global / no team" (this keeps composite primary keys
37
- possible). The adapter converts it back: `Role.teamId` is `null` for global roles and a **string** otherwise
38
- (`teamId: 1` is returned as `'1'`). Don't use `''` as a real team id.
39
- - `created_at` / `updated_at` (Drizzle: `createdAt` / `updatedAt`) are NOT NULL and default to the current time:
40
- `timestamp with time zone DEFAULT now()` on PostgreSQL, unix seconds (`integer`, `mode: 'timestamp'` → `Date`) on
41
- SQLite, `timestamp DEFAULT CURRENT_TIMESTAMP` on MySQL. The adapter never returns or updates them (roles/permissions are not renamed through the engine).
42
- - MySQL string columns are bounded `varchar`s (`name` / `guard_name` 255, the others 191) so every key fits InnoDB's
43
- 3072-byte index limit, with `COLLATE utf8mb4_bin` so comparisons are case-sensitive like on PostgreSQL / SQLite.
44
- - Link tables reference `roles` / `permissions` with `ON DELETE CASCADE`. The adapter also deletes links itself, so it
45
- works when foreign keys are disabled (SQLite's default).
46
-
47
- ## Schema setup
48
-
49
- ### With drizzle-kit
50
-
51
- Add the tables to your Drizzle schema file. drizzle-kit only discovers **top-level exports**, so destructure them:
12
+ ## Usage
52
13
 
53
14
  ```ts
54
- // db/schema.ts — PostgreSQL
15
+ // db/schema.ts: drizzle-kit only picks up top-level exports, so destructure the tables
55
16
  import { pgRbacSchema } from '@anievo-id/rbac-evolution-drizzle/pg'
56
17
 
57
18
  export const { permissions, roles, roleHasPermissions, modelHasRoles, modelHasPermissions } = pgRbacSchema()
58
-
59
- // ...your own tables
60
- ```
61
-
62
- ```ts
63
- // db/schema.ts — SQLite
64
- import { sqliteRbacSchema } from '@anievo-id/rbac-evolution-drizzle/sqlite'
65
-
66
- export const { permissions, roles, roleHasPermissions, modelHasRoles, modelHasPermissions } = sqliteRbacSchema()
67
19
  ```
68
20
 
69
21
  ```ts
70
- // db/schema.ts — MySQL
71
- import { mysqlRbacSchema } from '@anievo-id/rbac-evolution-drizzle/mysql'
72
-
73
- export const { permissions, roles, roleHasPermissions, modelHasRoles, modelHasPermissions } = mysqlRbacSchema()
74
- ```
75
-
76
- Then run `npx drizzle-kit generate` / `npx drizzle-kit migrate` (or `push`) as usual.
77
-
78
- **Table prefix** — avoid clashes with existing `roles` / `permissions` tables:
79
-
80
- ```ts
81
- export const rbacTables = pgRbacSchema({ prefix: 'rbac_' }) // rbac_permissions, rbac_roles, ...
82
- export const {
83
- permissions: rbacPermissions,
84
- roles: rbacRoles,
85
- roleHasPermissions: rbacRoleHasPermissions,
86
- modelHasRoles: rbacModelHasRoles,
87
- modelHasPermissions: rbacModelHasPermissions,
88
- } = rbacTables
89
- ```
90
-
91
- Pass the **same** schema object to the adapter (see below) when you use a prefix.
92
-
93
- ### Without drizzle-kit (plain SQL)
94
-
95
- Ready-to-run DDL ships with the package:
96
-
97
- - `node_modules/@anievo-id/rbac-evolution-drizzle/sql/pg.sql`
98
- - `node_modules/@anievo-id/rbac-evolution-drizzle/sql/sqlite.sql`
99
- - `node_modules/@anievo-id/rbac-evolution-drizzle/sql/mysql.sql`
100
-
101
- All use `CREATE ... IF NOT EXISTS`. For a prefix, prefix every table, constraint and index name in the file.
102
-
103
- ## Usage
104
-
105
- ### PostgreSQL
106
-
107
- ```ts
22
+ // lib/rbac.ts
108
23
  import { createRbac } from '@anievo-id/rbac-evolution'
109
24
  import { drizzlePgAdapter } from '@anievo-id/rbac-evolution-drizzle/pg'
110
25
  import { drizzle } from 'drizzle-orm/node-postgres'
111
26
 
112
- const db = drizzle(process.env.DATABASE_URL!)
113
-
114
- export const rbac = createRbac({ adapter: drizzlePgAdapter(db) })
27
+ export const rbac = createRbac({ adapter: drizzlePgAdapter(drizzle(process.env.DATABASE_URL!)) })
115
28
  ```
116
29
 
117
- ### SQLite
118
-
119
- ```ts
120
- import { createRbac } from '@anievo-id/rbac-evolution'
121
- import { drizzleSqliteAdapter } from '@anievo-id/rbac-evolution-drizzle/sqlite'
122
- import { drizzle } from 'drizzle-orm/libsql'
30
+ Then run `npx drizzle-kit generate` and `npx drizzle-kit migrate` as usual.
123
31
 
124
- const db = drizzle({ connection: { url: 'file:local.db' } })
125
-
126
- export const rbac = createRbac({ adapter: drizzleSqliteAdapter(db) })
127
- ```
32
+ | Dialect | Entry point | Schema / adapter |
33
+ | ---------- | ------------------------------------------ | ---------------------------------------------- |
34
+ | PostgreSQL | `@anievo-id/rbac-evolution-drizzle/pg` | `pgRbacSchema()` / `drizzlePgAdapter(db)` |
35
+ | SQLite | `@anievo-id/rbac-evolution-drizzle/sqlite` | `sqliteRbacSchema()` / `drizzleSqliteAdapter(db)` |
36
+ | MySQL | `@anievo-id/rbac-evolution-drizzle/mysql` | `mysqlRbacSchema()` / `drizzleMysqlAdapter(db)` |
128
37
 
129
- ### MySQL
130
-
131
- ```ts
132
- import { createRbac } from '@anievo-id/rbac-evolution'
133
- import { drizzleMysqlAdapter } from '@anievo-id/rbac-evolution-drizzle/mysql'
134
- import { drizzle } from 'drizzle-orm/mysql2'
135
-
136
- const db = drizzle(process.env.DATABASE_URL!)
137
-
138
- export const rbac = createRbac({ adapter: drizzleMysqlAdapter(db) })
139
- ```
140
-
141
- ### With a prefix / custom schema object
142
-
143
- ```ts
144
- import { rbacTables } from './db/schema' // pgRbacSchema({ prefix: 'rbac_' })
145
-
146
- const rbac = createRbac({ adapter: drizzlePgAdapter(db, rbacTables) })
147
- ```
148
-
149
- ### Then
150
-
151
- ```ts
152
- await rbac.createPermission('edit articles')
153
- await rbac.createRole('writer')
154
- await rbac.role('writer').givePermissionTo('edit articles')
155
-
156
- const user = rbac.for({ type: 'user', id: 1 })
157
- await user.assignRole('writer')
158
- await user.can('edit articles') // true
159
- ```
38
+ - Without drizzle-kit, run the plain SQL shipped in `sql/pg.sql`, `sql/sqlite.sql` or `sql/mysql.sql`.
39
+ - With a table prefix (`pgRbacSchema({ prefix: 'rbac_' })`), pass the same schema object to the adapter:
40
+ `drizzlePgAdapter(db, rbacTables)`.
41
+ - `team_id = ''` means "global". Don't use `''` as a real team id.
42
+ - MySQL string columns use `utf8mb4_bin`, so names compare case-sensitively. That collation ignores trailing spaces,
43
+ so the adapter re-checks every row it reads.
160
44
 
161
- ## Notes
45
+ ## Documentation
162
46
 
163
- - Role and permission ids are auto-increment integers and are returned as `number`.
164
- Subject ids returned by reverse lookups (`getSubjectIdsWithRoles` / `getSubjectIdsWithPermissions`) are strings.
165
- - `attach*` calls are idempotent (`INSERT ... ON CONFLICT DO NOTHING`; on MySQL a no-op `ON DUPLICATE KEY UPDATE`).
166
- - MySQL has no `INSERT ... RETURNING`; `createPermission` / `createRole` use Drizzle's `$returningId()`.
167
- - Deletes of roles/permissions run a few sequential statements (links first, then the row); they are not wrapped in a
168
- transaction. For atomic work, build a short-lived adapter on a transaction:
169
- `await db.transaction(async (tx) => { const adapter = drizzlePgAdapter(tx); /* ... */ })`.
47
+ https://creation.anievo.id/rbac-evolution/adapters/drizzle
170
48
 
171
49
  ## License
172
50
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@anievo-id/rbac-evolution-drizzle",
3
- "version": "0.8.0",
3
+ "version": "1.0.0-rc.0",
4
4
  "description": "Drizzle ORM storage adapter (PostgreSQL, SQLite & MySQL) for rbac-evolution.",
5
5
  "license": "MIT",
6
6
  "author": "AniEvo-ID (https://github.com/AniEvo-ID)",
@@ -84,10 +84,10 @@
84
84
  "access": "public"
85
85
  },
86
86
  "dependencies": {
87
- "@anievo-id/rbac-evolution": "^0.8.0"
87
+ "@anievo-id/rbac-evolution": "^1.0.0-rc.0"
88
88
  },
89
89
  "peerDependencies": {
90
- "drizzle-orm": ">=0.36"
90
+ "drizzle-orm": ">=0.38"
91
91
  },
92
92
  "devDependencies": {
93
93
  "@electric-sql/pglite": "^0.3.0",