mythik-server 0.1.3 → 0.1.4

package/README.md

@@ -30,6 +30,21 @@ wired in.
 npm install mythik-server
 ```
 
+Install the SQL driver for your selected database explicitly:
+
+```bash
+npm install pg              # PostgreSQL
+npm install mysql2          # MySQL
+npm install mssql           # SQL Server
+npm install better-sqlite3  # SQLite
+```
+
+SQLite uses the native `better-sqlite3` adapter. If npm prints warnings
+from that adapter's transitive native-build helpers, the warning belongs
+to the SQLite adapter install path, not to `mythik-server` itself.
+Missing SQL adapter errors include the package name and install command
+for the selected dialect.
+
 `mythik` is included as a dependency — no separate install required.
 
 ## When to install this
@@ -50,18 +65,18 @@ below for what it actually checks.
 
 ## What you get
 
-- **`createServer({ spec, database })`** — main bootstrap. Reads an
-  ApiSpec, opens the database connection, registers all declared
-  endpoints, and exposes a `start(port)` method.
-
-- **Dialect-aware SQL runtime** — generated CRUD, catalogs,
-  pagination, auth provider queries, and scope filters compile through
-  the selected database driver. Supported dialects are SQL Server,
-  PostgreSQL, MySQL, and SQLite.
-
-- **Endpoint patterns** — your ApiSpec declares each endpoint as one
-  of four shapes; the server wires the route, validates inputs,
-  enforces auth, and applies RLS automatically:
+- **`createServer({ spec, database })`** — main bootstrap. Reads an
+  ApiSpec, opens the database connection, registers all declared
+  endpoints, and exposes a `start(port)` method.
+
+- **Dialect-aware SQL runtime** — generated CRUD, catalogs,
+  pagination, auth provider queries, and scope filters compile through
+  the selected database driver. Supported dialects are SQL Server,
+  PostgreSQL, MySQL, and SQLite.
+
+- **Endpoint patterns** — your ApiSpec declares each endpoint as one
+  of four shapes; the server wires the route, validates inputs,
+  enforces auth, and applies RLS automatically:
   - `query` — read with parameters
   - `handler` — custom business logic with an escape hatch
   - `crud` — create / read / update / delete a table row
@@ -84,36 +99,36 @@ below for what it actually checks.
 ```ts
 import { createServer } from 'mythik-server';
 
-const server = createServer({
-  spec: './api-spec.json',
-  database: {
-    type: 'postgres',
-    connectionString: process.env.DATABASE_URL!,
-  },
-});
-
-await server.start(3010);
-```
-
-`./api-spec.json` is a Mythik ApiSpec describing endpoints, auth
-policy, catalogs, and CRUD shape. See `ai-context.md` (bundled in the
-`mythik` package) for the ApiSpec schema and patterns.
-
-For local demos and tests, SQLite is a one-file option:
-
-```ts
-const server = createServer({
-  spec: './api-spec.json',
-  database: { type: 'sqlite', filename: './mythik.db' },
-});
-```
-
-Set `spec.dialect` in the ApiSpec to match the server database when
-Mythik should generate CRUD/catalog/pagination/scope SQL for that
-dialect. Custom SQL remains dialect-native; Mythik compiles named
-params (`@name`) but does not translate a SQL Server query into
-PostgreSQL/MySQL/SQLite SQL at runtime. MySQL generated upsert SQL
-targets MySQL 8.0.19+.
+const server = createServer({
+  spec: './api-spec.json',
+  database: {
+    type: 'postgres',
+    connectionString: process.env.DATABASE_URL!,
+  },
+});
+
+await server.start(3010);
+```
+
+`./api-spec.json` is a Mythik ApiSpec describing endpoints, auth
+policy, catalogs, and CRUD shape. See `ai-context.md` (bundled in the
+`mythik` package) for the ApiSpec schema and patterns.
+
+For local demos and tests, SQLite is a one-file option:
+
+```ts
+const server = createServer({
+  spec: './api-spec.json',
+  database: { type: 'sqlite', filename: './mythik.db' },
+});
+```
+
+Set `spec.dialect` in the ApiSpec to match the server database when
+Mythik should generate CRUD/catalog/pagination/scope SQL for that
+dialect. Custom SQL remains dialect-native; Mythik compiles named
+params (`@name`) but does not translate a SQL Server query into
+PostgreSQL/MySQL/SQLite SQL at runtime. MySQL generated upsert SQL
+targets MySQL 8.0.19+.
 
 ## ApiSpec philosophy
 
@@ -176,12 +191,19 @@ to detect; in Mythik both `roleAccess` (frontend) and `policies`
 - [`mythik-react`](https://github.com/mldixdev/mythik/tree/main/packages/react#readme) — the frontend consuming this API
 - [`mythik-cli`](https://github.com/mldixdev/mythik/tree/main/packages/cli#readme) — author and cross-validate ApiSpecs (the AI-first surface)
 
-## Status
-
+## Status
+
 Public release line. Use with `mythik contract` to cross-check
 frontend specs against backend endpoints before deployment. APIs are
 documented for real-world feedback as the framework evolves.
-
-## License
-
-Apache-2.0.
+
+## Releases
+
+Release notes and patch details are published in the
+[CHANGELOG](https://github.com/mldixdev/mythik/blob/main/CHANGELOG.md)
+and on
+[GitHub Releases](https://github.com/mldixdev/mythik/releases).
+
+## License
+
+Apache-2.0.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mythik-server",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "description": "Declarative REST runtime for Mythik ApiSpec contracts, auth, RBAC, catalogs, and CRUD endpoints.",
   "license": "Apache-2.0",
   "type": "module",
@@ -41,7 +41,7 @@
     "cors": "^2.8.5",
     "express": "^4.21.2",
     "jsonwebtoken": "^9.0.3",
-    "mythik": "0.1.3"
+    "mythik": "0.1.4"
   },
   "devDependencies": {
     "@types/bcryptjs": "^3.0.0",