@terreno/mcp 0.21.0 → 0.22.1

package/src/docs/versioned/0.21.0/reference/generated/api/functions/modelRouter.md

@@ -0,0 +1,83 @@
+## Call Signature
+
+> **modelRouter**\<`T`\>(`path`, `model`, `options`): [`ModelRouterRegistration`](../interfaces/ModelRouterRegistration.md)
+
+Create a set of CRUD routes given a Mongoose model and configuration options.
+
+When called with a path as the first argument, returns a `ModelRouterRegistration` that can be
+passed to `TerrenoApp.register()`.
+
+### Type Parameters
+
+#### T
+
+`T`
+
+### Parameters
+
+#### path
+
+`string`
+
+#### model
+
+`Model`\<`T`\>
+
+#### options
+
+[`ModelRouterOptions`](../interfaces/ModelRouterOptions.md)\<`T`\>
+
+### Returns
+
+[`ModelRouterRegistration`](../interfaces/ModelRouterRegistration.md)
+
+### Example
+
+```ts
+// Traditional usage (returns express.Router):
+router.use("/todos", modelRouter(Todo, options));
+
+// Registration usage (returns ModelRouterRegistration):
+const todoRouter = modelRouter("/todos", Todo, options);
+app.register(todoRouter);
+```
+
+## Call Signature
+
+> **modelRouter**\<`T`\>(`model`, `options`): `Router`
+
+Create a set of CRUD routes given a Mongoose model and configuration options.
+
+When called with a path as the first argument, returns a `ModelRouterRegistration` that can be
+passed to `TerrenoApp.register()`.
+
+### Type Parameters
+
+#### T
+
+`T`
+
+### Parameters
+
+#### model
+
+`Model`\<`T`\>
+
+#### options
+
+[`ModelRouterOptions`](../interfaces/ModelRouterOptions.md)\<`T`\>
+
+### Returns
+
+`Router`
+
+### Example
+
+```ts
+// Traditional usage (returns express.Router):
+router.use("/todos", modelRouter(Todo, options));
+
+// Registration usage (returns ModelRouterRegistration):
+const todoRouter = modelRouter("/todos", Todo, options);
+app.register(todoRouter);
+```

package/src/docs/versioned/0.21.0/reference/generated/api/functions/mongooseErrorToAPIError.md

@@ -0,0 +1,13 @@
+> **mongooseErrorToAPIError**(`err`): [`APIError`](../classes/APIError.md) \| `null`
+
+Converts Mongoose validation/cast errors into client-friendly APIErrors.
+
+## Parameters
+
+### err
+
+`Error`
+
+## Returns
+
+[`APIError`](../classes/APIError.md) \| `null`

package/src/docs/versioned/0.21.0/reference/generated/api/functions/mountBetterAuthRoutes.md

@@ -0,0 +1,21 @@
+> **mountBetterAuthRoutes**(`app`, `auth`, `basePath?`): `void`
+
+Mounts Better Auth routes on the Express app.
+
+## Parameters
+
+### app
+
+`Application`
+
+### auth
+
+`Auth`
+
+### basePath?
+
+`string` = `"/api/auth"`
+
+## Returns
+
+`void`

package/src/docs/versioned/0.21.0/reference/generated/api/functions/openApiCompatMiddleware.md

@@ -0,0 +1,22 @@
+> **openApiCompatMiddleware**(`req`, `_res`, `next`): `void`
+
+Express middleware that patches the router stack before OpenAPI doc
+generation. Must be mounted before the openapi middleware.
+
+## Parameters
+
+### req
+
+`Request`
+
+### \_res
+
+`Response`
+
+### next
+
+`NextFunction`
+
+## Returns
+
+`void`

package/src/docs/versioned/0.21.0/reference/generated/api/functions/openApiEtagMiddleware.md

@@ -0,0 +1,23 @@
+> **openApiEtagMiddleware**(`req`, `res`, `next`): `void`
+
+Middleware to add ETag support for OpenAPI JSON endpoint.
+This middleware should be added before the @wesleytodd/openapi middleware
+to intercept requests to /openapi.json and add conditional request support.
+
+## Parameters
+
+### req
+
+`Request`
+
+### res
+
+`Response`
+
+### next
+
+`NextFunction`
+
+## Returns
+
+`void`

package/src/docs/versioned/0.21.0/reference/generated/api/functions/patchAppUse.md

@@ -0,0 +1,17 @@
+> **patchAppUse**(`app`): `void`
+
+Wraps an Express app's `use` method to record the mount path on each
+layer added to the router stack. This runs at setup time so that
+`patchRouterStack` can read the original path later.
+
+Must be called before any routes are registered.
+
+## Parameters
+
+### app
+
+`Application`
+
+## Returns
+
+`void`

package/src/docs/versioned/0.21.0/reference/generated/api/functions/permissionMiddleware.md

@@ -0,0 +1,21 @@
+> **permissionMiddleware**\<`T`\>(`model`, `options`): (`req`, `_res`, `next`) => `Promise`\<`void`\>
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### model
+
+`Model`\<`T`\>
+
+### options
+
+`Pick`\<[`ModelRouterOptions`](../interfaces/ModelRouterOptions.md)\<`T`\>, `"permissions"` \| `"populatePaths"`\>
+
+## Returns
+
+(`req`, `_res`, `next`) => `Promise`\<`void`\>

package/src/docs/versioned/0.21.0/reference/generated/api/functions/registerActionRoutes.md

@@ -0,0 +1,25 @@
+> **registerActionRoutes**\<`T`\>(`router`, `model`, `options`): `void`
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### router
+
+`Router`
+
+### model
+
+`Model`\<`T`\>
+
+### options
+
+`Partial`\<[`ModelRouterOptions`](../interfaces/ModelRouterOptions.md)\<`T`\>\>
+
+## Returns
+
+`void`

package/src/docs/versioned/0.21.0/reference/generated/api/functions/registerRealtime.md

@@ -0,0 +1,14 @@
+> **registerRealtime**(`entry`): `void`
+
+Register a model for real-time sync. Called automatically by modelRouter
+when the `realtime` option is provided.
+
+## Parameters
+
+### entry
+
+[`RealtimeRegistryEntry`](../interfaces/RealtimeRegistryEntry.md)
+
+## Returns
+
+`void`

package/src/docs/versioned/0.21.0/reference/generated/api/functions/removeAllSocketQueries.md

@@ -0,0 +1,13 @@
+> **removeAllSocketQueries**(`socketId`): `void`
+
+Remove all query subscriptions for a disconnected socket.
+
+## Parameters
+
+### socketId
+
+`string`
+
+## Returns
+
+`void`

package/src/docs/versioned/0.21.0/reference/generated/api/functions/removeQuerySubscription.md

@@ -0,0 +1,17 @@
+> **removeQuerySubscription**(`socketId`, `queryId`): `void`
+
+Remove a single query subscription for a socket.
+
+## Parameters
+
+### socketId
+
+`string`
+
+### queryId
+
+`string`
+
+## Returns
+
+`void`

package/src/docs/versioned/0.21.0/reference/generated/api/functions/requestContextMiddleware.md

@@ -0,0 +1,26 @@
+> **requestContextMiddleware**(`req`, `res`, `next`): `void`
+
+Express middleware that opens a correlation scope for the request. Mounted early by `TerrenoApp` /
+`setupServer`, it resolves a `requestId` (from request-id/correlation headers, Cloud Trace, or
+W3C `traceparent`, else a new UUID), captures any `jobId`/`sessionId`/trace fields, echoes
+`X-Request-ID` back to the client, and runs the remaining middleware inside the scope so all
+downstream logs are correlated. A later auth-aware pass ([updateRequestContextFromRequest](updateRequestContextFromRequest.md))
+fills in `userId`/`sessionId`.
+
+## Parameters
+
+### req
+
+`Request`
+
+### res
+
+`Response`
+
+### next
+
+`NextFunction`
+
+## Returns
+
+`void`

package/src/docs/versioned/0.21.0/reference/generated/api/functions/resetOpenApiValidatorConfig.md

@@ -0,0 +1,9 @@
+> **resetOpenApiValidatorConfig**(): `void`
+
+Reset the global validator configuration to defaults.
+Also resets `isConfigured` to false.
+Useful for testing.
+
+## Returns
+
+`void`

package/src/docs/versioned/0.21.0/reference/generated/api/functions/runActionPermissions.md

@@ -0,0 +1,33 @@
+> **runActionPermissions**\<`T`\>(`action`, `scope`, `model`, `req`, `doc?`): `Promise`\<`void`\>
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### action
+
+`BaseActionConfig`\<`unknown`, `unknown`, `unknown`\>
+
+### scope
+
+`ActionScope`
+
+### model
+
+`Model`\<`T`\>
+
+### req
+
+`Request`
+
+### doc?
+
+`T`
+
+## Returns
+
+`Promise`\<`void`\>

package/src/docs/versioned/0.21.0/reference/generated/api/functions/runWithRequestContext.md

@@ -0,0 +1,38 @@
+> **runWithRequestContext**\<`T`\>(`context`, `callback`): `T`
+
+Runs `callback` inside a fresh correlation scope so every log line it emits shares the same
+identifiers — the manual equivalent of [requestContextMiddleware](requestContextMiddleware.md) for background jobs,
+cron tasks, scripts, queue consumers, etc. A `requestId` is generated when not supplied, and the
+context is mirrored to Sentry.
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### context
+
+`Partial`\<[`RequestContext`](../interfaces/RequestContext.md)\>
+
+### callback
+
+() => `T`
+
+## Returns
+
+`T`
+
+## Example
+
+```typescript
+import {createScopedLogger, runWithRequestContext} from "@terreno/api";
+
+await runWithRequestContext({jobId: "nightly-sync"}, async () => {
+  const log = createScopedLogger({prefix: "[NightlySync]"});
+  log.info("started"); // includes jobId + a generated requestId on every line
+  await sync();
+});
+```

package/src/docs/versioned/0.21.0/reference/generated/api/functions/runWithRequestContextAttributes.md

@@ -0,0 +1,25 @@
+> **runWithRequestContextAttributes**\<`T`\>(`attributes?`, `callback`): `T`
+
+Like [runWithRequestContext](runWithRequestContext.md), but seeds the scope from raw header attributes (for example
+those received on an incoming message or forwarded by another service). Parses Cloud Trace / W3C
+`traceparent` into `traceId`/`spanId` via [getRequestContextFromAttributes](getRequestContextFromAttributes.md).
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### attributes?
+
+`Record`\<`string`, `string` \| `undefined`\> = `{}`
+
+### callback
+
+() => `T`
+
+## Returns
+
+`T`

package/src/docs/versioned/0.21.0/reference/generated/api/functions/sendToGoogleChat.md

@@ -0,0 +1,25 @@
+> **sendToGoogleChat**(`messageText`, `__namedParameters?`): `Promise`\<`void`\>
+
+## Parameters
+
+### messageText
+
+`string`
+
+### \_\_namedParameters?
+
+#### channel?
+
+`string`
+
+#### env?
+
+`string`
+
+#### shouldThrow?
+
+`boolean` = `false`
+
+## Returns
+
+`Promise`\<`void`\>

package/src/docs/versioned/0.21.0/reference/generated/api/functions/sendToSlack.md

@@ -0,0 +1,29 @@
+> **sendToSlack**(`text`, `__namedParameters?`): `Promise`\<`void`\>
+
+## Parameters
+
+### text
+
+`string`
+
+### \_\_namedParameters?
+
+#### env?
+
+`string`
+
+#### shouldThrow?
+
+`boolean` = `false`
+
+#### slackChannel?
+
+`string`
+
+#### url?
+
+`string`
+
+## Returns
+
+`Promise`\<`void`\>

package/src/docs/versioned/0.21.0/reference/generated/api/functions/sendToZoom.md

@@ -0,0 +1,67 @@
+> **sendToZoom**(`message`, `options`): `Promise`\<`void`\>
+
+Sends a rich formatted message to a Zoom chat channel via webhook.
+
+## Parameters
+
+### message
+
+Message content with header, body, and optional subheader
+
+#### body
+
+`string`
+
+Body text content
+
+#### header
+
+`string`
+
+Main header text for the message
+
+#### subheader?
+
+`string`
+
+Optional subheader text displayed below the main header
+
+### options
+
+Configuration options
+
+#### channel
+
+`string`
+
+The Zoom channel to post to (defaults to "default")
+
+#### env?
+
+`string`
+
+Optional environment prefix (e.g., "stg", "prod") prepended to header
+
+#### shouldThrow?
+
+`boolean` = `false`
+
+If true, throws an APIError on failure; otherwise logs and continues
+
+## Returns
+
+`Promise`\<`void`\>
+
+## Remarks
+
+Requires ZOOM_CHAT_WEBHOOKS environment variable containing JSON with channel configurations:
+```json
+{
+  "default": {"channel": "webhook_url", "verificationToken": "token"},
+  "ops": {"channel": "webhook_url", "verificationToken": "token"}
+}
+```
+
+Falls back to "default" channel if specified channel not found.
+Logs errors to Sentry and logger when webhook is missing or request fails.
+Uses Zoom's rich message format (format=full) with structured header and body.

package/src/docs/versioned/0.21.0/reference/generated/api/functions/sentryAppVersionMiddleware.md

@@ -0,0 +1,26 @@
+> **sentryAppVersionMiddleware**(`req`, `_res`, `next`): `void`
+
+Express middleware that captures the app version from the request header
+and adds it as a tag to the current Sentry scope.
+
+This allows filtering Sentry errors by app version.
+
+Expected header: `App-Version`
+
+## Parameters
+
+### req
+
+`Request`
+
+### \_res
+
+`Response`
+
+### next
+
+`NextFunction`
+
+## Returns
+
+`void`

package/src/docs/versioned/0.21.0/reference/generated/api/functions/serialize.md

@@ -0,0 +1,25 @@
+> **serialize**\<`T`\>(`req`, `options`, `data`): `Partial`\<`T`\> \| (`Partial`\<`T`\> \| `undefined`)[] \| `undefined`
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### req
+
+`Request`
+
+### options
+
+[`ModelRouterOptions`](../interfaces/ModelRouterOptions.md)\<`T`\>
+
+### data
+
+`Document`\<`unknown`, `unknown`, `unknown`, `Record`\<`string`, `any`\>, \{ \}\> & `T` \| `Document`\<`unknown`, `unknown`, `unknown`, `Record`\<`string`, `any`\>, \{ \}\> & `T`[]
+
+## Returns
+
+`Partial`\<`T`\> \| (`Partial`\<`T`\> \| `undefined`)[] \| `undefined`

package/src/docs/versioned/0.21.0/reference/generated/api/functions/setRequestContext.md

@@ -0,0 +1,11 @@
+> **setRequestContext**(`updates`): `void`
+
+## Parameters
+
+### updates
+
+`Partial`\<[`RequestContext`](../interfaces/RequestContext.md)\>
+
+## Returns
+
+`void`

package/src/docs/versioned/0.21.0/reference/generated/api/functions/setupAuth.md

@@ -0,0 +1,15 @@
+> **setupAuth**(`app`, `userModel`): `void`
+
+## Parameters
+
+### app
+
+`Application`
+
+### userModel
+
+[`UserModel`](../interfaces/UserModel.md)
+
+## Returns
+
+`void`

package/src/docs/versioned/0.21.0/reference/generated/api/functions/setupBetterAuthUserSync.md

@@ -0,0 +1,21 @@
+> **setupBetterAuthUserSync**(`_auth`, `_userModel`): `void`
+
+Sets up Better Auth user sync hooks.
+This ensures users created/updated in Better Auth are synced to the application User model.
+
+Note: Better Auth doesn't have built-in event hooks, so we rely on the session middleware
+to create users on first session access.
+
+## Parameters
+
+### \_auth
+
+`Auth`
+
+### \_userModel
+
+[`UserModel`](../interfaces/UserModel.md)
+
+## Returns
+
+`void`

package/src/docs/versioned/0.21.0/reference/generated/api/functions/setupEnvironment.md

@@ -0,0 +1,5 @@
+> **setupEnvironment**(): `void`
+
+## Returns
+
+`void`

package/src/docs/versioned/0.21.0/reference/generated/api/functions/setupGitHubAuth.md

@@ -0,0 +1,22 @@
+> **setupGitHubAuth**(`_app`, `userModel`, `githubOptions`): `void`
+
+Sets up GitHub OAuth authentication strategy.
+Call this after setupAuth() in your server initialization.
+
+## Parameters
+
+### \_app
+
+`Application`
+
+### userModel
+
+[`UserModel`](../interfaces/UserModel.md)
+
+### githubOptions
+
+[`GitHubAuthOptions`](../interfaces/GitHubAuthOptions.md)
+
+## Returns
+
+`void`

package/src/docs/versioned/0.21.0/reference/generated/api/functions/setupLogging.md

@@ -0,0 +1,11 @@
+> **setupLogging**(`options?`): `void`
+
+## Parameters
+
+### options?
+
+[`LoggingOptions`](../interfaces/LoggingOptions.md)
+
+## Returns
+
+`void`