@byline/db-mysql 4.9.0 → 4.10.0

package/README.md

@@ -1,25 +1,15 @@
 # @byline/db-mysql
 
-> **Status: preliminary.** This adapter is published so it can be evaluated and
-> exercised, not because MySQL is a fully supported Byline backend yet. The
-> storage layer is complete and proven — it passes the entire shared
-> `@byline/db-conformance` behavioural suite, the same suite `@byline/db-postgres`
-> passes, with identical results. Search is also implemented; the remaining
-> limitations are in tooling and breadth of environment coverage:
+> **Status: generally available.** The storage adapter passes the same
+> `@byline/db-conformance` suite as `@byline/db-postgres`,
+> `@byline/search-mysql` supplies the matching search provider, and
+> `@byline/cli` can provision and scaffold a MySQL installation.
 >
-> - **Search is available.** `@byline/search-mysql` implements the same
->   provider contract and conformance suite as the built-in PostgreSQL search
->   driver. It owns an independent, disposable migration stream.
-> - **No CLI support.** `byline init` scaffolds a Postgres installation; wiring
->   MySQL is a manual edit to your `server.config.ts`.
-> - **Narrower CI coverage than Postgres.** Continuous integration pins MySQL 8.0
->   — the engine floor — so nothing yet exercises 9.x automatically, and no leg
->   runs under a non-UTC timezone. Tracked in
->   [#55](https://github.com/Byline-CMS/bylinecms.dev/issues/55).
->
-> Treat it as suitable for evaluation, prototypes, and controlled installations.
-> The criteria for general availability are tracked in
-> [#58](https://github.com/Byline-CMS/bylinecms.dev/issues/58).
+> Continuous integration pins MySQL 8.0 to exercise the supported engine floor.
+> Both adapter conformance suites also run under a non-UTC timezone
+> (`Asia/Kathmandu`) so calendar-date handling cannot silently depend on the
+> host timezone. MySQL 9.x remains covered by local development with
+> `mysql/docker-compose.yml`, which runs `mysql:latest`.
 
 MySQL adapter for Byline CMS — Drizzle schema, migrations, and the storage /
 queries / commands implementation behind `IDbAdapter`. It is Byline's second
@@ -40,6 +30,20 @@ workflow, and content translation as first-class concerns.
 
 ## Install
 
+For a new Byline installation, let the CLI select the package, environment
+variable, baseline, and server configuration together:
+
+```sh
+npx @byline/cli@latest init --database mysql
+```
+
+The generated application uses `@byline/db-mysql`,
+`@byline/db-mysql/admin`, and
+`BYLINE_DB_MYSQL_CONNECTION_STRING`. If you include the example collections,
+it also installs and registers `@byline/search-mysql`.
+
+For a hand-wired application:
+
 ```sh
 pnpm add @byline/db-mysql
 ```
@@ -80,10 +84,9 @@ const core = await initBylineCore({
 })
 ```
 
-This mirrors how `apps/webapp/byline/server.config.ts` wires `@byline/db-postgres` today —
-swap `pgAdapter` / `@byline/db-postgres/admin` for `mysqlAdapter` /
-`@byline/db-mysql/admin` and the rest of an existing Byline server config is unchanged,
-because both adapters implement the same `IDbAdapter` and `AdminStore` contracts.
+This is the wiring generated by `byline init --database mysql`. Both database
+adapters implement the same `IDbAdapter` and `AdminStore` contracts, so the
+rest of the server configuration is adapter-independent.
 
 `connectionString` is the **only** connection input `mysqlAdapter` takes, and
 it must be a `mysql://` URL — mysql2 parses connection URLs natively (`uri`
@@ -234,17 +237,12 @@ uses parser-safe portable terms, weighted MySQL `FULLTEXT` indexes, and analyzer
 fingerprints. Its package README documents migrations, capabilities, and the
 clear-and-rebuild procedure.
 
-## Not yet shipped
-
-- **CLI support.** `byline init` scaffolds a Postgres installation. Adding MySQL
-  to an existing project is a manual edit to `byline/server.config.ts` — swap
-  `pgAdapter` for `mysqlAdapter`, swap the `@byline/db-postgres/admin` import for
-  `@byline/db-mysql/admin`, and swap `postgresSearch` for `mysqlSearch`. Both
-  search packages expose the same `migrate(pool)` shape.
-- **A MySQL storage-benchmark target.** The design spec flags view
-  materialisation (the `ROW_NUMBER()` window inside a derived table, used
-  by both current-version views) as a question to answer before this
-  adapter's GA — Postgres's own benchmark sweep
+## Current boundaries
+
+- **A MySQL storage-benchmark target (non-blocking).** The design spec flags
+  view materialisation (the `ROW_NUMBER()` window inside a derived table,
+  used by both current-version views) as useful performance-characterisation
+  work. It is not a release gate. PostgreSQL's own benchmark sweep
   ([`docs/03-architecture/01-document-storage.md`](https://github.com/Byline-CMS/bylinecms.dev/blob/develop/docs/03-architecture/01-document-storage.md#indicative-benchmarks))
   has no MySQL counterpart yet. Tracked in
   [issue #53](https://github.com/Byline-CMS/bylinecms.dev/issues/53).

package/dist/lib/boot-check.js

@@ -11,6 +11,9 @@
  * `initBylineCore()` boot rather than surfacing as an obscure SQL error the
  * first time the storage layer emits a LATERAL join (Task 10+).
  */
+// Keep this adapter floor synchronized with the pre-install check in
+// `packages/cli/src/lib/database/mysql.ts`; the CLI contract test compares
+// the two constants without adding a runtime dependency on this package.
 const MIN = { major: 8, minor: 0, patch: 14 };
 const unsupportedEngineError = (reported) => new Error(`@byline/db-mysql requires MySQL ${MIN.major}.${MIN.minor}.${MIN.patch}+ (LATERAL joins); server reports ${reported}. MariaDB is not supported.`);
 /**

package/package.json

@@ -2,7 +2,7 @@
   "name": "@byline/db-mysql",
   "private": false,
   "license": "MPL-2.0",
-  "version": "4.9.0",
+  "version": "4.10.0",
   "engines": {
     "node": ">=20.9.0"
   },
@@ -50,8 +50,8 @@
     "drizzle-orm": "^0.45.2",
     "mysql2": "^3.23.1",
     "uuid": "^14.0.1",
-    "@byline/admin": "4.9.0",
-    "@byline/core": "4.9.0"
+    "@byline/admin": "4.10.0",
+    "@byline/core": "4.10.0"
   },
   "devDependencies": {
     "@biomejs/biome": "2.5.4",
@@ -65,9 +65,9 @@
     "tsx": "^4.23.1",
     "typescript": "^7.0.2",
     "vitest": "^4.1.10",
-    "@byline/db-conformance": "0.0.3",
-    "@byline/client": "4.9.0",
-    "@byline/auth": "4.9.0"
+    "@byline/auth": "4.10.0",
+    "@byline/db-conformance": "0.0.4",
+    "@byline/client": "4.10.0"
   },
   "publishConfig": {
     "access": "public",