@oidcraft/drizzle 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Florian Chiș
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,34 @@
-# Temporary Holding Version
+# @oidcraft/drizzle
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+A [Drizzle](https://orm.drizzle.team) v1 storage adapter for `@oidcraft/provider`, on SQLite or Postgres.
+
+```sh
+bun add @oidcraft/drizzle @oidcraft/adapter drizzle-orm
+```
+
+```ts
+import { Database } from 'bun:sqlite'
+import { staticKeyStore } from '@oidcraft/adapter'
+import { drizzleAdapter, SQLITE_MIGRATIONS } from '@oidcraft/drizzle'
+import { createProvider } from '@oidcraft/provider'
+import { drizzle } from 'drizzle-orm/bun-sqlite'
+
+const sqlite = new Database('oidcraft.sqlite')
+for (const statement of SQLITE_MIGRATIONS.flatMap(migration => migration.statements)) sqlite.run(statement) // once, in your migration step
+const adapter = drizzleAdapter({ db: drizzle({ client: sqlite }), keys: staticKeyStore(keys) })
+const provider = createProvider({ issuer, adapter, interactionUrl })
+```
+
+On Postgres, pass `tables: postgresTables(schema?)` beside a Postgres `db`; the schema is where a realm's
+tables live.
+
+The schema ships as migrations, `SQLITE_MIGRATIONS` and `POSTGRES_MIGRATIONS` — the same tables as
+the other SQL adapters, so one database works with any of them — which you run with your own tooling
+before you deploy. The adapter never
+creates or alters a table at startup.
+
+It returns a `FullAdapter`, so it satisfies every `@oidcraft/provider` entry point: brokering, local
+accounts and realms included. It passes the shared suite in `@oidcraft/adapter/conformance`, on
+SQLite and Postgres.
+
+See the [storage guide](https://github.com/Fl0r14n/oidcraft/blob/main/apps/docs/guide/adapters.md).