@terreno/mcp 0.21.0 → 0.22.1

package/dist/docs/versioned/0.21.0/reference/generated/api/interfaces/RealtimeEvent.md

@@ -0,0 +1,57 @@
+A real-time sync event emitted to clients via WebSocket.
+
+## Properties
+
+### collection
+
+> **collection**: `string`
+
+Route path used as tag type (e.g. "todos")
+
+***
+
+### data?
+
+> `optional` **data?**: `any`
+
+Serialized document data (omitted for hard deletes)
+
+***
+
+### id
+
+> **id**: `string`
+
+Document ID
+
+***
+
+### method
+
+> **method**: `"delete"` \| `"create"` \| `"update"`
+
+The CRUD method that triggered this event
+
+***
+
+### model
+
+> **model**: `string`
+
+Mongoose model name (e.g. "Todo")
+
+***
+
+### timestamp
+
+> **timestamp**: `number`
+
+Epoch milliseconds when the event was generated
+
+***
+
+### updatedFields?
+
+> `optional` **updatedFields?**: `string`[]
+
+Fields that were updated (for update events from change streams)

package/dist/docs/versioned/0.21.0/reference/generated/api/interfaces/RealtimeRegistryEntry.md

@@ -0,0 +1,41 @@
+A registered model with real-time sync configuration.
+
+## Properties
+
+### collectionName
+
+> **collectionName**: `string`
+
+Collection name in MongoDB (e.g. "todos")
+
+***
+
+### config
+
+> **config**: [`RealtimeConfig`](RealtimeConfig.md)
+
+Real-time configuration from modelRouter options
+
+***
+
+### modelName
+
+> **modelName**: `string`
+
+Mongoose model name (e.g. "Todo")
+
+***
+
+### options
+
+> **options**: [`ModelRouterOptions`](ModelRouterOptions.md)\<`any`\>
+
+Full modelRouter options (for responseHandler, permissions, etc.).
+
+***
+
+### routePath
+
+> **routePath**: `string`
+
+Route path (e.g. "/todos")

package/dist/docs/versioned/0.21.0/reference/generated/api/interfaces/RealtimeSocketLike.md

@@ -0,0 +1,94 @@
+Minimal shape this module requires from a Socket.io socket. Lets tests pass a
+mock without standing up a real server.
+
+## Extends
+
+- `SocketWithDecodedToken`
+
+## Properties
+
+### decodedToken?
+
+> `optional` **decodedToken?**: `DecodedRealtimeToken`
+
+#### Inherited from
+
+`SocketWithDecodedToken.decodedToken`
+
+***
+
+### emit
+
+> **emit**: (`event`, `payload`) => `void`
+
+#### Parameters
+
+##### event
+
+`string`
+
+##### payload
+
+`unknown`
+
+#### Returns
+
+`void`
+
+***
+
+### id
+
+> **id**: `string`
+
+***
+
+### join
+
+> **join**: (`room`) => `void` \| `Promise`\<`void`\>
+
+#### Parameters
+
+##### room
+
+`string`
+
+#### Returns
+
+`void` \| `Promise`\<`void`\>
+
+***
+
+### leave
+
+> **leave**: (`room`) => `void` \| `Promise`\<`void`\>
+
+#### Parameters
+
+##### room
+
+`string`
+
+#### Returns
+
+`void` \| `Promise`\<`void`\>
+
+***
+
+### on
+
+> **on**: (`event`, `handler`) => `void`
+
+#### Parameters
+
+##### event
+
+`string`
+
+##### handler
+
+(...`args`) => `any`
+
+#### Returns
+
+`void`

package/dist/docs/versioned/0.21.0/reference/generated/api/interfaces/RequestBodyValidatorOptions.md

@@ -0,0 +1,71 @@
+Options for the request body validator middleware.
+
+## Properties
+
+### enabled?
+
+> `optional` **enabled?**: `boolean`
+
+Override the global validateRequests setting for this specific route.
+
+***
+
+### excludeFields?
+
+> `optional` **excludeFields?**: `string`[]
+
+Fields to exclude from validation (e.g. fields set by preCreate hooks).
+Excluded fields are removed from both the schema properties and the required array.
+
+***
+
+### onAdditionalPropertiesRemoved?
+
+> `optional` **onAdditionalPropertiesRemoved?**: (`removedProperties`, `req`) => `void`
+
+Callback fired when additional properties are removed.
+Overrides the global onAdditionalPropertiesRemoved for this route.
+
+#### Parameters
+
+##### removedProperties
+
+`string`[]
+
+##### req
+
+`Request`
+
+#### Returns
+
+`void`
+
+***
+
+### onError?
+
+> `optional` **onError?**: (`errors`, `req`) => `void`
+
+Custom error handler for this specific route.
+
+#### Parameters
+
+##### errors
+
+`ErrorObject`\<`string`, `Record`\<`string`, `any`\>, `unknown`\>[]
+
+##### req
+
+`Request`
+
+#### Returns
+
+`void`
+
+***
+
+### required?
+
+> `optional` **required?**: `string`[]
+
+List of required field names.

package/dist/docs/versioned/0.21.0/reference/generated/api/interfaces/RequestContext.md

@@ -0,0 +1,59 @@
+Correlation fields stored in AsyncLocalStorage for the lifetime of a request or job. Every log
+line emitted inside the scope is enriched with these. `requestId` is the only required field; the
+rest are populated when headers, trace context, or auth supply them.
+
+## Properties
+
+### jobId?
+
+> `optional` **jobId?**: `string`
+
+Background job identifier (from `x-job-id` or set via [runWithRequestContext](../functions/runWithRequestContext.md)).
+
+***
+
+### requestId
+
+> **requestId**: `string`
+
+Stable id shared by all log lines for one request/job; echoed to clients as `X-Request-ID`.
+
+***
+
+### sessionId?
+
+> `optional` **sessionId?**: `string`
+
+Auth session id, resolved from the JWT/Better Auth session or `x-session-id`.
+
+***
+
+### spanId?
+
+> `optional` **spanId?**: `string`
+
+Distributed-tracing span id, parsed from Cloud Trace or W3C `traceparent`.
+
+***
+
+### traceId?
+
+> `optional` **traceId?**: `string`
+
+Distributed-tracing trace id, parsed from Cloud Trace or W3C `traceparent`.
+
+***
+
+### traceSampled?
+
+> `optional` **traceSampled?**: `boolean`
+
+Whether the trace is sampled, per the incoming trace headers.
+
+***
+
+### userId?
+
+> `optional` **userId?**: `string`
+
+Authenticated user id, populated after auth middleware runs.

package/dist/docs/versioned/0.21.0/reference/generated/api/interfaces/ScopedLogger.md

@@ -0,0 +1,100 @@
+Logger-shaped object returned by [createScopedLogger](../functions/createScopedLogger.md) and [createFeatureFlaggedLogger](../functions/createFeatureFlaggedLogger.md).
+Method signatures match the global [logger](../variables/logger.md) so the three are interchangeable at call sites.
+
+## Properties
+
+### catch
+
+> **catch**: (`e`) => `void`
+
+Log a caught exception. Suitable as a promise handler: `promise.catch(log.catch)`.
+
+#### Parameters
+
+##### e
+
+`unknown`
+
+#### Returns
+
+`void`
+
+***
+
+### debug
+
+> **debug**: (`msg`, ...`args`) => `void`
+
+#### Parameters
+
+##### msg
+
+`string`
+
+##### args
+
+...`unknown`[]
+
+#### Returns
+
+`void`
+
+***
+
+### error
+
+> **error**: (`msg`, ...`args`) => `void`
+
+#### Parameters
+
+##### msg
+
+`string`
+
+##### args
+
+...`unknown`[]
+
+#### Returns
+
+`void`
+
+***
+
+### info
+
+> **info**: (`msg`, ...`args`) => `void`
+
+#### Parameters
+
+##### msg
+
+`string`
+
+##### args
+
+...`unknown`[]
+
+#### Returns
+
+`void`
+
+***
+
+### warn
+
+> **warn**: (`msg`, ...`args`) => `void`
+
+#### Parameters
+
+##### msg
+
+`string`
+
+##### args
+
+...`unknown`[]
+
+#### Returns
+
+`void`

package/dist/docs/versioned/0.21.0/reference/generated/api/interfaces/ScriptContext.md

@@ -0,0 +1,59 @@
+## Properties
+
+### addLog
+
+> **addLog**: (`level`, `message`) => `Promise`\<`void`\>
+
+Add a log entry to the task.
+
+#### Parameters
+
+##### level
+
+`"error"` \| `"info"` \| `"warn"`
+
+##### message
+
+`string`
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### checkCancellation
+
+> **checkCancellation**: () => `Promise`\<`void`\>
+
+Check if the task has been cancelled. Throws TaskCancelledError if so.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### updateProgress
+
+> **updateProgress**: (`percentage`, `stage?`, `message?`) => `Promise`\<`void`\>
+
+Update progress on the task.
+
+#### Parameters
+
+##### percentage
+
+`number`
+
+##### stage?
+
+`string`
+
+##### message?
+
+`string`
+
+#### Returns
+
+`Promise`\<`void`\>

package/dist/docs/versioned/0.21.0/reference/generated/api/interfaces/ScriptResult.md

@@ -0,0 +1,11 @@
+## Properties
+
+### results
+
+> **results**: `string`[]
+
+***
+
+### success
+
+> **success**: `boolean`

package/dist/docs/versioned/0.21.0/reference/generated/api/interfaces/SecretFieldMeta.md

@@ -0,0 +1,29 @@
+Metadata for a secret field discovered by the configuration plugin.
+
+## Properties
+
+### path
+
+> **path**: `string`
+
+***
+
+### secretName
+
+> **secretName**: `string`
+
+***
+
+### secretProvider?
+
+> `optional` **secretProvider?**: `string`
+
+***
+
+### version?
+
+> `optional` **version?**: `string`
+
+Optional secret version to pin resolution to. When omitted the provider
+resolves the latest version. Discovered from the `secretVersion` schema
+path option.

package/dist/docs/versioned/0.21.0/reference/generated/api/interfaces/SecretProvider.md

@@ -0,0 +1,35 @@
+Interface for adapters that resolve secret values from external providers.
+
+## Properties
+
+### name
+
+> **name**: `string`
+
+## Methods
+
+### getSecret()
+
+> **getSecret**(`secretName`, `version?`): `Promise`\<`string` \| `null`\>
+
+Resolve a secret value by name. Returns `null` when the secret is not found.
+
+#### Parameters
+
+##### secretName
+
+`string`
+
+The secret identifier (short name or provider-specific path).
+
+##### version?
+
+`string`
+
+Optional version to pin resolution to. Providers that do not
+  support versioning (e.g. environment variables) ignore this parameter. When
+  omitted, the latest version is resolved.
+
+#### Returns
+
+`Promise`\<`string` \| `null`\>

package/dist/docs/versioned/0.21.0/reference/generated/api/interfaces/SyncConsentsOptions.md

@@ -0,0 +1,15 @@
+## Properties
+
+### deactivateRemoved?
+
+> `optional` **deactivateRemoved?**: `boolean`
+
+Deactivate database forms whose slugs are not in the definitions. Default: false
+
+***
+
+### dryRun?
+
+> `optional` **dryRun?**: `boolean`
+
+If true, log what would change without writing to the database. Default: false

package/dist/docs/versioned/0.21.0/reference/generated/api/interfaces/SyncConsentsResult.md

@@ -0,0 +1,23 @@
+## Properties
+
+### created
+
+> **created**: `string`[]
+
+***
+
+### deactivated
+
+> **deactivated**: `string`[]
+
+***
+
+### unchanged
+
+> **unchanged**: `string`[]
+
+***
+
+### updated
+
+> **updated**: `string`[]

package/dist/docs/versioned/0.21.0/reference/generated/api/interfaces/TerrenoAppOptions.md

@@ -0,0 +1,112 @@
+Configuration options for TerrenoApp.
+
+## Properties
+
+### arrayLimit?
+
+> `optional` **arrayLimit?**: `number`
+
+Maximum number of array items in query parameters (default: 200)
+
+***
+
+### authOptions?
+
+> `optional` **authOptions?**: [`AuthOptions`](AuthOptions.md)
+
+Authentication configuration options
+
+***
+
+### beforeJsonSetup?
+
+> `optional` **beforeJsonSetup?**: (`app`) => `void`
+
+Runs after CORS and before the `addMiddleware` chain and JSON body parsing.
+Use to attach early middleware via `app.use(...)` before JSON parsing.
+
+#### Parameters
+
+##### app
+
+`Application`
+
+#### Returns
+
+`void`
+
+***
+
+### configureApp?
+
+> `optional` **configureApp?**: [`AddRoutes`](../type-aliases/AddRoutes.md)
+
+Invoked after registered plugins/model routers and before `/auth/me`.
+Receives the Express app and OpenAPI bundle for `modelRouter` / `createOpenApiBuilder` wiring.
+
+***
+
+### corsOrigin?
+
+> `optional` **corsOrigin?**: `CorsOrigin`
+
+CORS origin configuration (default: "*")
+
+***
+
+### githubAuth?
+
+> `optional` **githubAuth?**: [`GitHubAuthOptions`](GitHubAuthOptions.md)
+
+GitHub OAuth configuration (enables GitHub authentication if provided)
+
+***
+
+### loggingOptions?
+
+> `optional` **loggingOptions?**: [`LoggingOptions`](LoggingOptions.md)
+
+Logging configuration options
+
+***
+
+### logRequests?
+
+> `optional` **logRequests?**: `boolean`
+
+Whether to log all incoming requests (default: true)
+
+***
+
+### realtime?
+
+> `optional` **realtime?**: `boolean` \| [`RealtimeAppOptions`](RealtimeAppOptions.md)
+
+Real-time sync configuration. When provided, Socket.io and MongoDB change streams
+are set up automatically — no need to register RealtimeApp as a separate plugin.
+
+Set to `true` for defaults, or pass a RealtimeAppOptions object for full control.
+
+***
+
+### sentryOptions?
+
+> `optional` **sentryOptions?**: `BunOptions`
+
+Sentry configuration options
+
+***
+
+### skipListen?
+
+> `optional` **skipListen?**: `boolean`
+
+Skip calling app.listen() in start() method (useful for testing)
+
+***
+
+### userModel
+
+> **userModel**: [`UserModel`](UserModel.md)
+
+Mongoose User model with passport-local-mongoose plugin