@shaferllc/keel 0.66.0 → 0.68.0

package/llms.txt

@@ -0,0 +1,116 @@
+# Keel
+
+> The house framework for Node.js — a service container, providers, routing, JSX views, and a code-generating console.
+
+Keel is a small, legible MVC framework for Node.js: a real service container,
+service providers, dot-notation config, expressive routing, models, a queue, and
+a code-generating console. Hono powers the HTTP layer; everything above it is Keel's.
+Userland imports everything from `@shaferllc/keel/core`.
+
+## Docs
+
+- [Building Keel apps with AI](https://github.com/shaferllc/keel/blob/main/docs/ai.md): Keel is built to be written with an AI agent.
+- [Architecture](https://github.com/shaferllc/keel/blob/main/docs/architecture.md): Keel is small on purpose. This page maps the pieces and traces a request from socket to response. Nothing here is magic — every layer is a short, readable file in src/core/, and this guide is mostly a reading order for it.
+- [Authentication](https://github.com/shaferllc/keel/blob/main/docs/authentication.md): Session-based auth built on the pieces you already have: sessions hold the login, hashing checks passwords.
+- [Authorization](https://github.com/shaferllc/keel/blob/main/docs/authorization.md): Where authentication answers who you are, authorization answers what you're allowed to do.
+- [Broadcasting](https://github.com/shaferllc/keel/blob/main/docs/broadcasting.md): Push events to clients in real time over named channels.
+- [Service Broker](https://github.com/shaferllc/keel/blob/main/docs/broker.md): Structure an application as services that talk to each other by name instead of by import.
+- [Cache](https://github.com/shaferllc/keel/blob/main/docs/cache.md): A small cache with TTLs and the remember pattern.
+- [Configuration](https://github.com/shaferllc/keel/blob/main/docs/configuration.md): Keel loads configuration from two sources: environment variables (.env) and config files (config/.ts).
+- [The Console](https://github.com/shaferllc/keel/blob/main/docs/console.md): Keel ships with a console for running the server and generating code.
+- [The Service Container](https://github.com/shaferllc/keel/blob/main/docs/container.md): The container is the backbone of Keel. Every service — config, the router, controllers, and anything you write — is registered in it and resolved out of it. It is the single registry every service resolves out of.
+- [Controllers](https://github.com/shaferllc/keel/blob/main/docs/controllers.md): Controllers are plain classes in app/Controllers/.
+- [CORS](https://github.com/shaferllc/keel/blob/main/docs/cors.md): Cross-Origin Resource Sharing lets browsers on other origins call your API.
+- [Database](https://github.com/shaferllc/keel/blob/main/docs/database.md): Keel ships a small, driver-agnostic query builder.
+- [Debugging](https://github.com/shaferllc/keel/blob/main/docs/debugging.md): Two helpers for the moments you'd otherwise reach for console.log.
+- [Request Decorators](https://github.com/shaferllc/keel/blob/main/docs/decorators.md): Attach named, computed values to the current request — request.user, request.tenant, request.locale — resolved lazily and memoized for the life of the request.
+- [Errors & Exceptions](https://github.com/shaferllc/keel/blob/main/docs/errors.md): Throw an exception anywhere — a handler, middleware, or a service deep in the container — and Keel's HTTP kernel turns it into the right response.
+- [Events](https://github.com/shaferllc/keel/blob/main/docs/events.md): A tiny event emitter for decoupling — fire an event in one place, handle it in another.
+- [Factories & Seeders](https://github.com/shaferllc/keel/blob/main/docs/factories.md): Populate the database with realistic fixtures for tests and demos.
+- [Getting Started](https://github.com/shaferllc/keel/blob/main/docs/getting-started.md): Keel is a house framework for Node.js — a small, legible MVC layer over Hono.
+- [Hashing & Encryption](https://github.com/shaferllc/keel/blob/main/docs/hashing.md): Password hashing and value encryption, both built on the Web Crypto API — so they run identically on Node and the edge, with no native bindings (no bcrypt to compile).
+- [Health Checks](https://github.com/shaferllc/keel/blob/main/docs/health.md): Two endpoints, answering the two questions an orchestrator — Kubernetes, Fly, Railway, a load balancer — actually asks:
+- [Helpers](https://github.com/shaferllc/keel/blob/main/docs/helpers.md): Keel gives you a handful of global helper functions so you can reach the running application from anywhere — a route handler, a model, a plain function — without threading a container reference through every call.
+- [Built on Hono](https://github.com/shaferllc/keel/blob/main/docs/hono.md): Keel's HTTP layer is Hono — an ultrafast, web-standard router that runs on Node, Cloudflare Workers, Deno, Bun, and more.
+- [Lifecycle Hooks](https://github.com/shaferllc/keel/blob/main/docs/hooks.md): Tap into the application lifecycle — run code once the app is ready, clean up on shutdown, and observe route registration.
+- [Inertia](https://github.com/shaferllc/keel/blob/main/docs/inertia.md): Keel ships a server-side Inertia.js adapter.
+- [Locks](https://github.com/shaferllc/keel/blob/main/docs/locks.md): "Only one of you may do this at a time" — across processes, across nodes.
+- [Logger](https://github.com/shaferllc/keel/blob/main/docs/logger.md): A small leveled logger. It writes structured JSON by default — one line per event, ready for log aggregators — and pretty single-line output in debug. Reach it with the global logger() helper.
+- [Mail](https://github.com/shaferllc/keel/blob/main/docs/mail.md): Send email through a pluggable transport. Compose a message with a fluent builder and dispatch it — the API mirrors the database layer (setMailer / mail() are to mail what setConnection / db() are to the database). The core imports no SDK: the built-in transports use fetch, console, or memory, so it runs on Node and the edge.
+- [Middleware](https://github.com/shaferllc/keel/blob/main/docs/middleware.md): Middleware wraps every request, running code before and after your route handler.
+- [Migrations](https://github.com/shaferllc/keel/blob/main/docs/migrations.md): Version your database schema. A migration is a { name, up, down } object; a fluent schema builder describes tables, and the migrator runs them against your connection, tracking what's applied. The SQL is dialect-aware (sqlite / mysql / postgres) and the core imports no driver.
+- [Models](https://github.com/shaferllc/keel/blob/main/docs/models.md): Model is a tiny active-record layer over the query builder.
+- [Notifications](https://github.com/shaferllc/keel/blob/main/docs/notifications.md): Send a message to a recipient over one or more channels — mail, database, or your own — inline or through the queue.
+- [Service Providers](https://github.com/shaferllc/keel/blob/main/docs/providers.md): Service providers are the central place to configure your application.
+- [Queues & Jobs](https://github.com/shaferllc/keel/blob/main/docs/queues.md): Move slow work — sending mail, calling an API, processing an upload — off the request path.
+- [Rate Limiting](https://github.com/shaferllc/keel/blob/main/docs/rate-limiting.md): rateLimiter() is a middleware that caps how many requests a client can make in a window.
+- [Redis](https://github.com/shaferllc/keel/blob/main/docs/redis.md): A Redis integration built on a small pluggable driver — like the database and mail layers, the core imports no client, so it runs on Node and on the edge.
+- [Request & Response](https://github.com/shaferllc/keel/blob/main/docs/request-response.md): Beyond the terse param() / json() shortcuts, the request and response accessors give you the full input/output surface — no context threading.
+- [Routing](https://github.com/shaferllc/keel/blob/main/docs/routing.md): Routes live in routes/web.ts. The default export receives the Router and registers routes on it. The HTTP kernel later compiles them onto Hono.
+- [Task Scheduling](https://github.com/shaferllc/keel/blob/main/docs/scheduling.md): Declare recurring work with a fluent cadence, then let a single cron trigger drive it — a code-defined scheduler, edge-first.
+- [Securing SSR apps](https://github.com/shaferllc/keel/blob/main/docs/security.md): Two middlewares harden server-rendered apps: securityHeaders() sets the defensive HTTP headers browsers act on, and csrf() blocks cross-site form submissions.
+- [Sessions](https://github.com/shaferllc/keel/blob/main/docs/sessions.md): Keel ships a cookie-backed session store. There's no external service to run, so it works the same on Node and on the edge. Session data lives in an HTTP-only cookie: the middleware reads it before your handler runs and writes it back afterward.
+- [Social authentication](https://github.com/shaferllc/keel/blob/main/docs/social-auth.md): "Sign in with GitHub / Google / Discord" — OAuth 2.0, without an SDK.
+- [Static Files](https://github.com/shaferllc/keel/blob/main/docs/static-files.md): serveStatic() serves files from a directory (default public/) before your routes run.
+- [Storage](https://github.com/shaferllc/keel/blob/main/docs/storage.md): File storage over a pluggable disk — like the database and mail layers, the core imports no filesystem or SDK, so it runs on Node and the edge.
+- [Templates](https://github.com/shaferllc/keel/blob/main/docs/templates.md): A string templating engine in the spirit of AdonisJS Edge — {{ }} interpolation and @-prefixed tags for logic, includes, layouts, and components.
+- [Testing](https://github.com/shaferllc/keel/blob/main/docs/testing.md): Test your app by injecting requests — no server, no port, no network — and asserting on the response.
+- [Transformers](https://github.com/shaferllc/keel/blob/main/docs/transformers.md): A model knows the database; a transformer knows the API.
+- [URL Builder](https://github.com/shaferllc/keel/blob/main/docs/url-builder.md): Generate URLs from named routes so paths live in one place.
+- [Validation](https://github.com/shaferllc/keel/blob/main/docs/validation.md): validate() parses request input against a schema and returns typed data.
+- [Views](https://github.com/shaferllc/keel/blob/main/docs/views.md): Keel renders HTML with Hono JSX — type-safe components that run identically on Node and on Cloudflare Workers (no filesystem templating, so it ports anywhere).
+- [Vite](https://github.com/shaferllc/keel/blob/main/docs/vite.md): Wire a modern frontend build — bundling, hashed filenames, hot module reload — to Keel's server-rendered HTML, the way modern full-stack frameworks do.
+
+## Examples
+
+Every topic has a runnable, type-checked example:
+
+- [Authentication example](https://github.com/shaferllc/keel/blob/main/docs/examples/authentication.ts)
+- [Authorization example](https://github.com/shaferllc/keel/blob/main/docs/examples/authorization.ts)
+- [Broadcasting example](https://github.com/shaferllc/keel/blob/main/docs/examples/broadcasting.ts)
+- [Service Broker example](https://github.com/shaferllc/keel/blob/main/docs/examples/broker.ts)
+- [Cache example](https://github.com/shaferllc/keel/blob/main/docs/examples/cache.ts)
+- [Configuration example](https://github.com/shaferllc/keel/blob/main/docs/examples/configuration.ts)
+- [The Service Container example](https://github.com/shaferllc/keel/blob/main/docs/examples/container.ts)
+- [Controllers example](https://github.com/shaferllc/keel/blob/main/docs/examples/controllers.ts)
+- [Database example](https://github.com/shaferllc/keel/blob/main/docs/examples/database.ts)
+- [Debugging example](https://github.com/shaferllc/keel/blob/main/docs/examples/debugging.ts)
+- [Request Decorators example](https://github.com/shaferllc/keel/blob/main/docs/examples/decorators.ts)
+- [Errors & Exceptions example](https://github.com/shaferllc/keel/blob/main/docs/examples/errors.ts)
+- [Events example](https://github.com/shaferllc/keel/blob/main/docs/examples/events.ts)
+- [Factories & Seeders example](https://github.com/shaferllc/keel/blob/main/docs/examples/factories.ts)
+- [Hashing & Encryption example](https://github.com/shaferllc/keel/blob/main/docs/examples/hashing.ts)
+- [Health Checks example](https://github.com/shaferllc/keel/blob/main/docs/examples/health.ts)
+- [Helpers example](https://github.com/shaferllc/keel/blob/main/docs/examples/helpers.ts)
+- [Lifecycle Hooks example](https://github.com/shaferllc/keel/blob/main/docs/examples/hooks.ts)
+- [Inertia example](https://github.com/shaferllc/keel/blob/main/docs/examples/inertia.ts)
+- [Locks example](https://github.com/shaferllc/keel/blob/main/docs/examples/locks.ts)
+- [Logger example](https://github.com/shaferllc/keel/blob/main/docs/examples/logger.ts)
+- [Mail example](https://github.com/shaferllc/keel/blob/main/docs/examples/mail.ts)
+- [Middleware example](https://github.com/shaferllc/keel/blob/main/docs/examples/middleware.ts)
+- [Migrations example](https://github.com/shaferllc/keel/blob/main/docs/examples/migrations.ts)
+- [Models example](https://github.com/shaferllc/keel/blob/main/docs/examples/models.ts)
+- [Notifications example](https://github.com/shaferllc/keel/blob/main/docs/examples/notification.ts)
+- [Service Providers example](https://github.com/shaferllc/keel/blob/main/docs/examples/providers.ts)
+- [Queues & Jobs example](https://github.com/shaferllc/keel/blob/main/docs/examples/queues.ts)
+- [Rate Limiting example](https://github.com/shaferllc/keel/blob/main/docs/examples/rate-limiting.ts)
+- [Redis example](https://github.com/shaferllc/keel/blob/main/docs/examples/redis.ts)
+- [Request & Response example](https://github.com/shaferllc/keel/blob/main/docs/examples/request-response.ts)
+- [Routing example](https://github.com/shaferllc/keel/blob/main/docs/examples/routing.ts)
+- [Task Scheduling example](https://github.com/shaferllc/keel/blob/main/docs/examples/scheduling.ts)
+- [Sessions example](https://github.com/shaferllc/keel/blob/main/docs/examples/sessions.ts)
+- [Static Files example](https://github.com/shaferllc/keel/blob/main/docs/examples/static-files.ts)
+- [Storage example](https://github.com/shaferllc/keel/blob/main/docs/examples/storage.ts)
+- [Templates example](https://github.com/shaferllc/keel/blob/main/docs/examples/templates.ts)
+- [Testing example](https://github.com/shaferllc/keel/blob/main/docs/examples/testing.ts)
+- [Transformers example](https://github.com/shaferllc/keel/blob/main/docs/examples/transformers.ts)
+- [URL Builder example](https://github.com/shaferllc/keel/blob/main/docs/examples/url-builder.ts)
+- [Validation example](https://github.com/shaferllc/keel/blob/main/docs/examples/validation.ts)
+- [Views example](https://github.com/shaferllc/keel/blob/main/docs/examples/views.tsx)
+- [Vite example](https://github.com/shaferllc/keel/blob/main/docs/examples/vite.ts)
+
+## Optional
+
+- [Full text of all docs](https://github.com/shaferllc/keel/blob/main/llms-full.txt): every guide concatenated into one file
+- [AGENTS.md](https://github.com/shaferllc/keel/blob/main/AGENTS.md): conventions and workflow for AI agents editing a Keel app
+- [README](https://github.com/shaferllc/keel/blob/main/README.md): project overview

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shaferllc/keel",
-  "version": "0.66.0",
+  "version": "0.68.0",
   "type": "module",
   "description": "The house framework for Node.js — a service container, providers, routing, JSX views, and a code-generating console.",
   "license": "MIT",
@@ -18,7 +18,11 @@
     "service-container",
     "web-framework",
     "edge",
-    "cloudflare-workers"
+    "cloudflare-workers",
+    "mcp",
+    "model-context-protocol",
+    "ai",
+    "llms-txt"
   ],
   "exports": {
     "./core": {
@@ -40,10 +44,22 @@
     "./db/libsql": {
       "types": "./dist/db/libsql.d.ts",
       "import": "./dist/db/libsql.js"
+    },
+    "./mcp": {
+      "types": "./dist/mcp/server.d.ts",
+      "import": "./dist/mcp/server.js"
     }
   },
+  "bin": {
+    "keel-mcp": "./bin/keel-mcp.mjs"
+  },
   "files": [
-    "dist"
+    "dist",
+    "bin/keel-mcp.mjs",
+    "docs",
+    "AGENTS.md",
+    "llms.txt",
+    "llms-full.txt"
   ],
   "publishConfig": {
     "access": "public"
@@ -52,18 +68,22 @@
     "keel": "tsx bin/keel.ts",
     "serve": "tsx bin/keel.ts serve",
     "dev": "tsx watch bin/keel.ts serve",
+    "mcp": "tsx bin/keel-mcp.ts",
     "typecheck": "tsc --noEmit",
     "typecheck:docs": "npm run build && tsc -p tsconfig.docs.json",
     "test": "node --import tsx --test tests/*.test.ts",
     "test:coverage": "node --import tsx --test --experimental-test-coverage --test-coverage-exclude='tests/**' tests/*.test.ts",
-    "build": "rm -rf dist && tsc -p tsconfig.build.json",
+    "build:ai": "tsx scripts/build-ai.ts",
+    "build": "npm run build:ai && rm -rf dist && tsc -p tsconfig.build.json",
     "dev:client": "vite",
     "build:client": "vite build",
     "prepare": "npm run build"
   },
   "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.29.0",
     "dotenv": "^16.4.7",
-    "hono": "^4.6.14"
+    "hono": "^4.6.14",
+    "zod": "^4.4.3"
   },
   "peerDependencies": {
     "vite": "^5 || ^6 || ^7"
@@ -79,7 +99,6 @@
     "commander": "^12.1.0",
     "tsx": "^4.19.2",
     "typescript": "^5.7.2",
-    "vite": "^6.4.3",
-    "zod": "^4.4.3"
+    "vite": "^6.4.3"
   }
 }