te.js 2.1.0 → 2.1.2

package/docs/configuration.md

@@ -1,275 +1,275 @@
-# Configuration
-
-Tejas provides a flexible configuration system that merges settings from multiple sources.
-
-## Configuration Sources
-
-Settings are loaded from three sources. Later sources override earlier ones:
-
-1. **`tejas.config.json`** — file in your project root (lowest priority)
-2. **Environment variables** — from `.env` or system environment
-3. **Constructor options** — passed to `new Tejas({...})` (highest priority)
-
-All configuration keys are normalized: nested objects are flattened with underscores and uppercased. For example, `log.http_requests` becomes the environment variable `LOG_HTTP_REQUESTS`.
-
-## Quick Start
-
-The simplest way to configure Tejas is with a `tejas.config.json` file:
-
-```json
-{
-  "port": 3000,
-  "dir": {
-    "targets": "targets"
-  },
-  "log": {
-    "http_requests": true,
-    "exceptions": true
-  }
-}
-```
-
-Or pass options directly to the constructor:
-
-```javascript
-import Tejas from 'te.js';
-
-const app = new Tejas({
-  port: 3000,
-  log: { http_requests: true }
-});
-
-app.takeoff();
-```
-
-## Complete Configuration Reference
-
-### Core
-
-| Config Key | Env Variable | Type | Default | Description |
-|------------|-------------|------|---------|-------------|
-| `entry` | `ENTRY` | string | *(auto-resolved)* | Entry file for `tejas fly`. Falls back to `package.json` `main`, then `index.js` / `app.js` / `server.js` |
-| `port` | `PORT` | number | `1403` | Server port |
-| `dir.targets` | `DIR_TARGETS` | string | `"targets"` | Directory containing `.target.js` files for auto-discovery |
-
-### Logging
-
-| Config Key | Env Variable | Type | Default | Description |
-|------------|-------------|------|---------|-------------|
-| `log.http_requests` | `LOG_HTTP_REQUESTS` | boolean | `false` | Log incoming HTTP requests (method, path, status, time) |
-| `log.exceptions` | `LOG_EXCEPTIONS` | boolean | `false` | Log unhandled exceptions and errors |
-
-### Request Body
-
-| Config Key | Env Variable | Type | Default | Description |
-|------------|-------------|------|---------|-------------|
-| `body.max_size` | `BODY_MAX_SIZE` | number | `10485760` (10 MB) | Maximum request body size in bytes. Requests exceeding this receive a 413 error |
-| `body.timeout` | `BODY_TIMEOUT` | number | `30000` (30 s) | Body parsing timeout in milliseconds. Requests exceeding this receive a 408 error |
-
-### LLM configuration (feature as parent, LLM inside each feature)
-
-Tejas uses a **feature-as-parent** pattern: each feature that needs an LLM has its own `*.llm` block (`docs.llm` for auto-documentation, `errors.llm` for LLM-inferred errors). **Inheritance from `LLM_*`:** unset feature-specific values fall back to `LLM_BASE_URL`, `LLM_API_KEY`, and `LLM_MODEL`. One set of `LLM_*` env vars can serve both features when you don't override with `DOCS_LLM_*` or `ERRORS_LLM_*`. You can also use different LLMs per feature (e.g. a lighter model for errors, a stronger one for docs).
-
-### Auto-Documentation
-
-These options configure the `tejas generate:docs` CLI command and the auto-documentation system. The **`docs.llm`** block is the LLM configuration for this feature. See [Auto-Documentation](./auto-docs.md) for full details.
-
-| Config Key | Env Variable | Type | Default | Description |
-|------------|-------------|------|---------|-------------|
-| `docs.dirTargets` | `DOCS_DIR_TARGETS` | string | `"targets"` | Target directory for doc generation (can differ from `dir.targets`) |
-| `docs.output` | — | string | `"./openapi.json"` | Output path for the generated OpenAPI spec |
-| `docs.title` | — | string | `"API"` | API title in the OpenAPI `info` block |
-| `docs.version` | — | string | `"1.0.0"` | API version in the OpenAPI `info` block |
-| `docs.description` | — | string | `""` | API description |
-| `docs.level` | — | number | `1` | LLM enhancement level (1–3). Higher = better docs, more tokens |
-| `docs.llm.baseURL` | `DOCS_LLM_BASE_URL` or `LLM_BASE_URL` | string | `"https://api.openai.com/v1"` | LLM provider endpoint for auto-docs |
-| `docs.llm.apiKey` | `DOCS_LLM_API_KEY` or `LLM_API_KEY` | string | — | LLM provider API key for auto-docs |
-| `docs.llm.model` | `DOCS_LLM_MODEL` or `LLM_MODEL` | string | `"gpt-4o-mini"` | LLM model for auto-docs |
-| `docs.overviewPath` | — | string | `"./API_OVERVIEW.md"` | Path for the generated overview page (level 3 only) |
-| `docs.productionBranch` | `DOCS_PRODUCTION_BRANCH` | string | `"main"` | Git branch that triggers `docs:on-push` |
-
-### Error handling (LLM-inferred errors)
-
-When [LLM-inferred error codes and messages](./error-handling.md#llm-inferred-errors) are enabled, the **`errors.llm`** block configures the LLM used for inferring status code and message when you call `ammo.throw()` without explicit code or message. Unset values fall back to `LLM_BASE_URL`, `LLM_API_KEY`, `LLM_MODEL`. You can also enable (and optionally set connection options) by calling **`app.withLLMErrors(config?)`** before `takeoff()` — e.g. `app.withLLMErrors()` to use env/config for baseURL, apiKey, model, or `app.withLLMErrors({ baseURL, apiKey, model, messageType })` to override in code.
-
-| Config Key | Env Variable | Type | Default | Description |
-|------------|-------------|------|---------|-------------|
-| `errors.llm.enabled` | `ERRORS_LLM_ENABLED` or `LLM_*` (for connection) | boolean | `false` | Enable LLM-inferred error code and message for `ammo.throw()` |
-| `errors.llm.baseURL` | `ERRORS_LLM_BASE_URL` or `LLM_BASE_URL` | string | `"https://api.openai.com/v1"` | LLM provider endpoint for error inference |
-| `errors.llm.apiKey` | `ERRORS_LLM_API_KEY` or `LLM_API_KEY` | string | — | LLM provider API key for error inference |
-| `errors.llm.model` | `ERRORS_LLM_MODEL` or `LLM_MODEL` | string | `"gpt-4o-mini"` | LLM model for error inference |
-| `errors.llm.messageType` | `ERRORS_LLM_MESSAGE_TYPE` or `LLM_MESSAGE_TYPE` | `"endUser"` \| `"developer"` | `"endUser"` | Default tone for LLM-generated message: `endUser` (safe for clients) or `developer` (technical detail). Overridable per `ammo.throw()` call. |
-
-When enabled, the same behaviour applies whether you call `ammo.throw()` or the framework calls it when it catches an error — one mechanism, no separate config.
-
-## Configuration File
-
-Create a `tejas.config.json` in your project root:
-
-```json
-{
-  "entry": "app.js",
-  "port": 3000,
-  "dir": {
-    "targets": "targets"
-  },
-  "log": {
-    "http_requests": true,
-    "exceptions": true
-  },
-  "body": {
-    "max_size": 5242880,
-    "timeout": 15000
-  },
-  "docs": {
-    "output": "./openapi.json",
-    "title": "My API",
-    "version": "1.0.0",
-    "level": 2,
-    "productionBranch": "main",
-    "llm": {
-      "baseURL": "https://api.openai.com/v1",
-      "model": "gpt-4o-mini"
-    }
-  },
-  "errors": {
-    "llm": {
-      "enabled": true,
-      "baseURL": "https://api.openai.com/v1",
-      "model": "gpt-4o-mini",
-      "messageType": "endUser"
-    }
-  }
-}
-```
-
-## Environment Variables
-
-Create a `.env` file in your project root. Tejas uses [tej-env](https://www.npmjs.com/package/tej-env) to load it automatically:
-
-```bash
-# Server
-PORT=3000
-
-# Logging
-LOG_HTTP_REQUESTS=true
-LOG_EXCEPTIONS=true
-
-# Body limits
-BODY_MAX_SIZE=5242880
-BODY_TIMEOUT=15000
-
-# Target directory
-DIR_TARGETS=targets
-
-# LLM — shared fallback for docs.llm and errors.llm when feature-specific vars are unset
-LLM_BASE_URL=https://api.openai.com/v1
-LLM_API_KEY=sk-...
-LLM_MODEL=gpt-4o-mini
-
-# Optional: override per feature (docs.llm)
-# DOCS_LLM_BASE_URL=...
-# DOCS_LLM_API_KEY=...
-# DOCS_LLM_MODEL=...
-
-# Optional: override for error-inference (errors.llm)
-# ERRORS_LLM_ENABLED=true
-# ERRORS_LLM_BASE_URL=...
-# ERRORS_LLM_API_KEY=...
-# ERRORS_LLM_MODEL=...
-# ERRORS_LLM_MESSAGE_TYPE=endUser   # or "developer" for technical messages
-```
-
-## Constructor Options
-
-Pass an object to `new Tejas()` using the same nested structure as `tejas.config.json`:
-
-```javascript
-import Tejas from 'te.js';
-
-const app = new Tejas({
-  port: 3000,
-  log: {
-    http_requests: true,
-    exceptions: true
-  },
-  body: {
-    max_size: 10 * 1024 * 1024,
-    timeout: 30000
-  }
-});
-```
-
-Constructor options have the highest priority and override both the config file and environment variables.
-
-## How Merging Works
-
-All configuration is flattened into a single-level object with uppercased keys:
-
-```javascript
-// tejas.config.json
-{ "log": { "http_requests": true } }
-
-// Becomes accessible as:
-env('LOG_HTTP_REQUESTS') // true
-```
-
-The merge order is: config file values, then env vars override those, then constructor options override everything.
-
-## Accessing Configuration at Runtime
-
-Use the `env()` function from `tej-env` to read any configuration value:
-
-```javascript
-import { env } from 'tej-env';
-
-target.register('/info', (ammo) => {
-  ammo.fire({
-    port: env('PORT'),
-    maxBodySize: env('BODY_MAX_SIZE')
-  });
-});
-```
-
-## Auto-Registration
-
-Tejas automatically discovers and imports all files ending in `.target.js` from the configured `dir.targets` directory (recursively, including subdirectories):
-
-```
-targets/
-├── user.target.js      --> Auto-loaded
-├── auth.target.js      --> Auto-loaded
-├── utils.js            --> Ignored (wrong suffix)
-└── api/
-    └── v1.target.js    --> Auto-loaded
-```
-
-To change the targets directory:
-
-```json
-{
-  "dir": {
-    "targets": "src/routes"
-  }
-}
-```
-
-## Database Configuration
-
-Database connections are configured via `takeoff()` options, not through the config file:
-
-```javascript
-app.takeoff({
-  withRedis: { url: 'redis://localhost:6379' },
-  withMongo: { uri: 'mongodb://localhost:27017/myapp' }
-});
-```
-
-See [Database Integration](./database.md) for details.
-
-## Next Steps
-
-- [Getting Started](./getting-started.md) — Build your first Tejas application
-- [Routing](./routing.md) — Define routes and endpoints
-- [Auto-Documentation](./auto-docs.md) — Generate OpenAPI docs from your code
-- [CLI Reference](./cli.md) — `tejas fly` and doc generation commands
+# Configuration
+
+Tejas provides a flexible configuration system that merges settings from multiple sources.
+
+## Configuration Sources
+
+Settings are loaded from three sources. Later sources override earlier ones:
+
+1. **`tejas.config.json`** — file in your project root (lowest priority)
+2. **Environment variables** — from `.env` or system environment
+3. **Constructor options** — passed to `new Tejas({...})` (highest priority)
+
+All configuration keys are normalized: nested objects are flattened with underscores and uppercased. For example, `log.http_requests` becomes the environment variable `LOG_HTTP_REQUESTS`.
+
+## Quick Start
+
+The simplest way to configure Tejas is with a `tejas.config.json` file:
+
+```json
+{
+  "port": 3000,
+  "dir": {
+    "targets": "targets"
+  },
+  "log": {
+    "http_requests": true,
+    "exceptions": true
+  }
+}
+```
+
+Or pass options directly to the constructor:
+
+```javascript
+import Tejas from 'te.js';
+
+const app = new Tejas({
+  port: 3000,
+  log: { http_requests: true }
+});
+
+app.takeoff();
+```
+
+## Complete Configuration Reference
+
+### Core
+
+| Config Key | Env Variable | Type | Default | Description |
+|------------|-------------|------|---------|-------------|
+| `entry` | `ENTRY` | string | *(auto-resolved)* | Entry file for `tejas fly`. Falls back to `package.json` `main`, then `index.js` / `app.js` / `server.js` |
+| `port` | `PORT` | number | `1403` | Server port |
+| `dir.targets` | `DIR_TARGETS` | string | `"targets"` | Directory containing `.target.js` files for auto-discovery |
+
+### Logging
+
+| Config Key | Env Variable | Type | Default | Description |
+|------------|-------------|------|---------|-------------|
+| `log.http_requests` | `LOG_HTTP_REQUESTS` | boolean | `false` | Log incoming HTTP requests (method, path, status, time) |
+| `log.exceptions` | `LOG_EXCEPTIONS` | boolean | `false` | Log unhandled exceptions and errors |
+
+### Request Body
+
+| Config Key | Env Variable | Type | Default | Description |
+|------------|-------------|------|---------|-------------|
+| `body.max_size` | `BODY_MAX_SIZE` | number | `10485760` (10 MB) | Maximum request body size in bytes. Requests exceeding this receive a 413 error |
+| `body.timeout` | `BODY_TIMEOUT` | number | `30000` (30 s) | Body parsing timeout in milliseconds. Requests exceeding this receive a 408 error |
+
+### LLM configuration (feature as parent, LLM inside each feature)
+
+Tejas uses a **feature-as-parent** pattern: each feature that needs an LLM has its own `*.llm` block (`docs.llm` for auto-documentation, `errors.llm` for LLM-inferred errors). **Inheritance from `LLM_*`:** unset feature-specific values fall back to `LLM_BASE_URL`, `LLM_API_KEY`, and `LLM_MODEL`. One set of `LLM_*` env vars can serve both features when you don't override with `DOCS_LLM_*` or `ERRORS_LLM_*`. You can also use different LLMs per feature (e.g. a lighter model for errors, a stronger one for docs).
+
+### Auto-Documentation
+
+These options configure the `tejas generate:docs` CLI command and the auto-documentation system. The **`docs.llm`** block is the LLM configuration for this feature. See [Auto-Documentation](./auto-docs.md) for full details.
+
+| Config Key | Env Variable | Type | Default | Description |
+|------------|-------------|------|---------|-------------|
+| `docs.dirTargets` | `DOCS_DIR_TARGETS` | string | `"targets"` | Target directory for doc generation (can differ from `dir.targets`) |
+| `docs.output` | — | string | `"./openapi.json"` | Output path for the generated OpenAPI spec |
+| `docs.title` | — | string | `"API"` | API title in the OpenAPI `info` block |
+| `docs.version` | — | string | `"1.0.0"` | API version in the OpenAPI `info` block |
+| `docs.description` | — | string | `""` | API description |
+| `docs.level` | — | number | `1` | LLM enhancement level (1–3). Higher = better docs, more tokens |
+| `docs.llm.baseURL` | `DOCS_LLM_BASE_URL` or `LLM_BASE_URL` | string | `"https://api.openai.com/v1"` | LLM provider endpoint for auto-docs |
+| `docs.llm.apiKey` | `DOCS_LLM_API_KEY` or `LLM_API_KEY` | string | — | LLM provider API key for auto-docs |
+| `docs.llm.model` | `DOCS_LLM_MODEL` or `LLM_MODEL` | string | `"gpt-4o-mini"` | LLM model for auto-docs |
+| `docs.overviewPath` | — | string | `"./API_OVERVIEW.md"` | Path for the generated overview page (level 3 only) |
+| `docs.productionBranch` | `DOCS_PRODUCTION_BRANCH` | string | `"main"` | Git branch that triggers `docs:on-push` |
+
+### Error handling (LLM-inferred errors)
+
+When [LLM-inferred error codes and messages](./error-handling.md#llm-inferred-errors) are enabled, the **`errors.llm`** block configures the LLM used for inferring status code and message when you call `ammo.throw()` without explicit code or message. Unset values fall back to `LLM_BASE_URL`, `LLM_API_KEY`, `LLM_MODEL`. You can also enable (and optionally set connection options) by calling **`app.withLLMErrors(config?)`** before `takeoff()` — e.g. `app.withLLMErrors()` to use env/config for baseURL, apiKey, model, or `app.withLLMErrors({ baseURL, apiKey, model, messageType })` to override in code.
+
+| Config Key | Env Variable | Type | Default | Description |
+|------------|-------------|------|---------|-------------|
+| `errors.llm.enabled` | `ERRORS_LLM_ENABLED` or `LLM_*` (for connection) | boolean | `false` | Enable LLM-inferred error code and message for `ammo.throw()` |
+| `errors.llm.baseURL` | `ERRORS_LLM_BASE_URL` or `LLM_BASE_URL` | string | `"https://api.openai.com/v1"` | LLM provider endpoint for error inference |
+| `errors.llm.apiKey` | `ERRORS_LLM_API_KEY` or `LLM_API_KEY` | string | — | LLM provider API key for error inference |
+| `errors.llm.model` | `ERRORS_LLM_MODEL` or `LLM_MODEL` | string | `"gpt-4o-mini"` | LLM model for error inference |
+| `errors.llm.messageType` | `ERRORS_LLM_MESSAGE_TYPE` or `LLM_MESSAGE_TYPE` | `"endUser"` \| `"developer"` | `"endUser"` | Default tone for LLM-generated message: `endUser` (safe for clients) or `developer` (technical detail). Overridable per `ammo.throw()` call. |
+
+When enabled, the same behaviour applies whether you call `ammo.throw()` or the framework calls it when it catches an error — one mechanism, no separate config.
+
+## Configuration File
+
+Create a `tejas.config.json` in your project root:
+
+```json
+{
+  "entry": "app.js",
+  "port": 3000,
+  "dir": {
+    "targets": "targets"
+  },
+  "log": {
+    "http_requests": true,
+    "exceptions": true
+  },
+  "body": {
+    "max_size": 5242880,
+    "timeout": 15000
+  },
+  "docs": {
+    "output": "./openapi.json",
+    "title": "My API",
+    "version": "1.0.0",
+    "level": 2,
+    "productionBranch": "main",
+    "llm": {
+      "baseURL": "https://api.openai.com/v1",
+      "model": "gpt-4o-mini"
+    }
+  },
+  "errors": {
+    "llm": {
+      "enabled": true,
+      "baseURL": "https://api.openai.com/v1",
+      "model": "gpt-4o-mini",
+      "messageType": "endUser"
+    }
+  }
+}
+```
+
+## Environment Variables
+
+Create a `.env` file in your project root. Tejas uses [tej-env](https://www.npmjs.com/package/tej-env) to load it automatically:
+
+```bash
+# Server
+PORT=3000
+
+# Logging
+LOG_HTTP_REQUESTS=true
+LOG_EXCEPTIONS=true
+
+# Body limits
+BODY_MAX_SIZE=5242880
+BODY_TIMEOUT=15000
+
+# Target directory
+DIR_TARGETS=targets
+
+# LLM — shared fallback for docs.llm and errors.llm when feature-specific vars are unset
+LLM_BASE_URL=https://api.openai.com/v1
+LLM_API_KEY=sk-...
+LLM_MODEL=gpt-4o-mini
+
+# Optional: override per feature (docs.llm)
+# DOCS_LLM_BASE_URL=...
+# DOCS_LLM_API_KEY=...
+# DOCS_LLM_MODEL=...
+
+# Optional: override for error-inference (errors.llm)
+# ERRORS_LLM_ENABLED=true
+# ERRORS_LLM_BASE_URL=...
+# ERRORS_LLM_API_KEY=...
+# ERRORS_LLM_MODEL=...
+# ERRORS_LLM_MESSAGE_TYPE=endUser   # or "developer" for technical messages
+```
+
+## Constructor Options
+
+Pass an object to `new Tejas()` using the same nested structure as `tejas.config.json`:
+
+```javascript
+import Tejas from 'te.js';
+
+const app = new Tejas({
+  port: 3000,
+  log: {
+    http_requests: true,
+    exceptions: true
+  },
+  body: {
+    max_size: 10 * 1024 * 1024,
+    timeout: 30000
+  }
+});
+```
+
+Constructor options have the highest priority and override both the config file and environment variables.
+
+## How Merging Works
+
+All configuration is flattened into a single-level object with uppercased keys:
+
+```javascript
+// tejas.config.json
+{ "log": { "http_requests": true } }
+
+// Becomes accessible as:
+env('LOG_HTTP_REQUESTS') // true
+```
+
+The merge order is: config file values, then env vars override those, then constructor options override everything.
+
+## Accessing Configuration at Runtime
+
+Use the `env()` function from `tej-env` to read any configuration value:
+
+```javascript
+import { env } from 'tej-env';
+
+target.register('/info', (ammo) => {
+  ammo.fire({
+    port: env('PORT'),
+    maxBodySize: env('BODY_MAX_SIZE')
+  });
+});
+```
+
+## Auto-Registration
+
+Tejas automatically discovers and imports all files ending in `.target.js` from the configured `dir.targets` directory (recursively, including subdirectories):
+
+```
+targets/
+├── user.target.js      --> Auto-loaded
+├── auth.target.js      --> Auto-loaded
+├── utils.js            --> Ignored (wrong suffix)
+└── api/
+    └── v1.target.js    --> Auto-loaded
+```
+
+To change the targets directory:
+
+```json
+{
+  "dir": {
+    "targets": "src/routes"
+  }
+}
+```
+
+## Database Configuration
+
+Database connections are configured via `takeoff()` options, not through the config file:
+
+```javascript
+app.takeoff({
+  withRedis: { url: 'redis://localhost:6379' },
+  withMongo: { uri: 'mongodb://localhost:27017/myapp' }
+});
+```
+
+See [Database Integration](./database.md) for details.
+
+## Next Steps
+
+- [Getting Started](./getting-started.md) — Build your first Tejas application
+- [Routing](./routing.md) — Define routes and endpoints
+- [Auto-Documentation](./auto-docs.md) — Generate OpenAPI docs from your code
+- [CLI Reference](./cli.md) — `tejas fly` and doc generation commands