request-scope-api 1.0.16 → 1.0.18

package/README.md

@@ -16,16 +16,16 @@ npm install request-scope-api
 
 ```javascript
 import express from 'express';
-import request-scope-api from 'request-scope-api';
+import { setup } from 'request-scope-api';
 
 const app = express();
 
-app.use(request-scope-api({
+setup(app, {
   storage: {
     type: 'mongodb',
     uri: 'mongodb://localhost:27017/myapp'
   }
-}));
+});
 
 app.listen(3000);
 ```
@@ -34,20 +34,23 @@ app.listen(3000);
 
 ```javascript
 import express from 'express';
-import request-scope-api from 'request-scope-api';
+import { setup } from 'request-scope-api';
 
 const app = express();
 
-app.use(request-scope-api({
+setup(app, {
   storage: {
     type: 'mysql',
     host: 'localhost',
     port: 3306,
-    database: 'myapp',
-    username: 'user',
-    password: 'pass'
-  }
-}));
+    database: 'truck_match_live_leatest',
+    username: 'root',
+    password: ''
+  },
+  retentionDays: 30,
+  ignore: ['/health', '/favicon.ico'],
+  maskFields: ['password']
+});
 
 app.listen(3000);
 ```
@@ -56,11 +59,11 @@ app.listen(3000);
 
 ```javascript
 import express from 'express';
-import request-scope-api from 'request-scope-api';
+import { setup } from 'request-scope-api';
 
 const app = express();
 
-app.use(request-scope-api({
+setup(app, {
   storage: {
     type: 'postgresql',
     host: 'localhost',
@@ -69,123 +72,11 @@ app.use(request-scope-api({
     username: 'user',
     password: 'pass'
   }
-}));
+});
 
 app.listen(3000);
 ```
 
-## Dashboard
-
-Mount the dashboard at a specific path with optional authentication:
-
-```javascript
-import request-scope-api from 'request-scope-api';
-
-const app = express();
-
-// Capture middleware
-app.use(request-scope-api({
-  storage: {
-    type: 'mongodb',
-    uri: 'mongodb://localhost:27017/myapp'
-  }
-}));
-
-
-## Configuration
-
-### request-scope-apiConfig
-
-| Option | Type | Default | Description |
-|--------|------|---------|-------------|
-| `storage` | `StorageConfig` | **required** | Database storage configuration |
-| `retentionDays` | `number` | `30` | Number of days to retain records (1-365) |
-| `ignore` | `string[]` | `[]` | URL paths to skip (no capture) |
-| `maskFields` | `string[]` | `[]` | Additional field names to mask (merged with built-in defaults) |
-| `dashboard` | `DashboardConfig` | `undefined` | Dashboard configuration |
-
-### StorageConfig
-
-| Option | Type | Required For | Description |
-|--------|------|---------------|-------------|
-| `type` | `'mongodb' \| 'mysql' \| 'postgresql'` | All | Storage backend type |
-| `uri` | `string` | MongoDB | MongoDB connection URI |
-| `host` | `string` | MySQL, PostgreSQL | Database host |
-| `port` | `number` | MySQL, PostgreSQL | Database port |
-| `database` | `string` | MySQL, PostgreSQL | Database name |
-| `username` | `string` | MySQL, PostgreSQL | Database username |
-| `password` | `string` | MySQL, PostgreSQL | Database password |
-| `poolSize` | `number` | All | Connection pool size (default: 5) |
-| `ssl` | `boolean` | All | Enable SSL/TLS (default: false) |
-
-### DashboardConfig
-
-| Option | Type | Default | Description |
-|--------|------|---------|-------------|
-| `auth` | `AuthConfig` | `undefined` | Authentication configuration |
-| `mountPath` | `string` | `"/request-scope-api"` | Mount path for the dashboard |
-
-### AuthConfig
-
-| Option | Type | Description |
-|--------|------|-------------|
-| `username` | `string` | Basic auth username |
-| `password` | `string` | Basic auth password |
-
-## Database-Specific Setup
-
-### MongoDB
-
-- **URI Format**: `mongodb://[username:password@]host[:port][/database][?options]`
-- **Required Fields**: `uri`
-- **Optional**: `poolSize`, `ssl`
-
-Example:
-```javascript
-storage: {
-  type: 'mongodb',
-  uri: 'mongodb://user:pass@localhost:27017/myapp?authSource=admin'
-}
-```
-
-### MySQL
-
-- **Required Fields**: `host`, `port`, `database`, `username`, `password`
-- **Optional**: `poolSize`, `ssl`
-
-Example:
-```javascript
-storage: {
-  type: 'mysql',
-  host: 'localhost',
-  port: 3306,
-  database: 'myapp',
-  username: 'user',
-  password: 'pass',
-  poolSize: 10,
-  ssl: true
-}
-```
-
-### PostgreSQL
-
-- **Required Fields**: `host`, `port`, `database`, `username`, `password`
-- **Optional**: `poolSize`, `ssl`
-
-Example:
-```javascript
-storage: {
-  type: 'postgresql',
-  host: 'localhost',
-  port: 5432,
-  database: 'myapp',
-  username: 'user',
-  password: 'pass',
-  poolSize: 10,
-  ssl: true
-}
-```
-
 ## Features
 
 - **Zero Configuration**: Works out of the box with sensible defaults
@@ -211,10 +102,10 @@ request-scope-api automatically masks sensitive fields in request headers, reque
 Add custom fields to mask via the `maskFields` configuration:
 
 ```javascript
-app.use(request-scope-api({
+setup(app, {
   storage: { /* ... */ },
   maskFields: ['creditCard', 'ssn', 'apiKey']
-}));
+});
 ```
 
 ## Ignoring Paths
@@ -222,10 +113,10 @@ app.use(request-scope-api({
 Skip capture for specific URL paths:
 
 ```javascript
-app.use(request-scope-api({
+setup(app, {
   storage: { /* ... */ },
   ignore: ['/health', '/metrics', '/favicon.ico']
-}));
+});
 ```
 
 ## Error Handling
@@ -233,9 +124,9 @@ app.use(request-scope-api({
 To capture error data, use the provided error middleware:
 
 ```javascript
-import request-scope-api, { errorHandler } from 'request-scope-api';
+import { setup, errorHandler } from 'request-scope-api';
 
-app.use(request-scope-api({ /* ... */ }));
+setup(app, { /* ... */ });
 app.use(errorHandler);
 
 // Your routes
@@ -247,29 +138,3 @@ app.get('/api/users', async (req, res, next) => {
   }
 });
 ```
-
-## API Endpoints
-
-The dashboard provides the following API endpoints:
-
-- `GET /api/records` - List records with filtering, sorting, and pagination
-- `GET /api/records/:id` - Get a single record by ID
-
-### Query Parameters (GET /api/records)
-
-| Parameter | Type | Description |
-|-----------|------|-------------|
-| `search` | `string` | Case-insensitive substring match on URL |
-| `startDate` | `string` | ISO 8601 timestamp (inclusive lower bound) |
-| `endDate` | `string` | ISO 8601 timestamp (inclusive upper bound) |
-| `statusCodeGroup` | `string` | Status code group: `2xx`, `3xx`, `4xx`, `5xx` |
-| `statusCode` | `number` | Exact status code match |
-| `method` | `string` | Exact HTTP method match (case-insensitive) |
-| `sortBy` | `string` | Sort field: `timestamp`, `responseTime`, `statusCode` |
-| `sortOrder` | `string` | Sort order: `asc`, `desc` |
-| `page` | `number` | Page number (default: 1) |
-| `pageSize` | `number` | Page size (default: 25) |
-
-## License
-
-MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "request-scope-api",
-  "version": "1.0.16",
+  "version": "1.0.18",
   "description": "Zero-friction API request observability for Express.js applications",
   "keywords": [
     "express",