@terreno/mcp 0.22.2 → 0.23.1

package/dist/docs/versioned/0.23.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.23.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.23.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.23.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.23.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.23.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.23.0/reference/generated/api/interfaces/ScriptArgDef.md

@@ -0,0 +1,60 @@
+Optional declaration for a single script argument. Declarations are purely
+advisory: they drive validation, type coercion, default values, and help text
+but a script can still read any argument the caller supplied. This keeps
+argument handling flexible — declare the args you care about, ignore the rest.
+
+## Properties
+
+### aliases?
+
+> `optional` **aliases?**: `string`[]
+
+Alternate names accepted on the CLI (e.g. ["l"] enables `-l`).
+
+***
+
+### default?
+
+> `optional` **default?**: [`ScriptArgValue`](../type-aliases/ScriptArgValue.md)
+
+Default applied when the argument is not provided.
+
+***
+
+### description
+
+> **description**: `string`
+
+Human-readable description shown in CLI help and the admin UI.
+
+***
+
+### example?
+
+> `optional` **example?**: `string`
+
+Example value shown in help text.
+
+***
+
+### name
+
+> **name**: `string`
+
+Canonical name (used as `--name` on the CLI and as the key in the args map).
+
+***
+
+### required?
+
+> `optional` **required?**: `boolean`
+
+When true, parsing fails if the argument is missing.
+
+***
+
+### type?
+
+> `optional` **type?**: `"string"` \| `"number"` \| `"boolean"`
+
+Type used for coercion and validation. Defaults to "string".

package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/ScriptArgs.md

@@ -0,0 +1,121 @@
+Typed, ergonomic accessor over the parsed arguments passed to a script. Scripts
+read values via the typed getters; `raw` and `positional` expose everything for
+advanced cases.
+
+## Properties
+
+### getBoolean
+
+> **getBoolean**: (`name`, `fallback?`) => `boolean`
+
+Read a boolean value ("true"/"1"/"yes"/"on" are truthy).
+
+#### Parameters
+
+##### name
+
+`string`
+
+##### fallback?
+
+`boolean`
+
+#### Returns
+
+`boolean`
+
+***
+
+### getNumber
+
+> **getNumber**: (`name`, `fallback?`) => `number` \| `undefined`
+
+Read a numeric value (coerces strings; returns fallback when missing/NaN).
+
+#### Parameters
+
+##### name
+
+`string`
+
+##### fallback?
+
+`number`
+
+#### Returns
+
+`number` \| `undefined`
+
+***
+
+### getString
+
+> **getString**: (`name`, `fallback?`) => `string` \| `undefined`
+
+Read a string value (coerces numbers/booleans; first element of arrays).
+
+#### Parameters
+
+##### name
+
+`string`
+
+##### fallback?
+
+`string`
+
+#### Returns
+
+`string` \| `undefined`
+
+***
+
+### getStringArray
+
+> **getStringArray**: (`name`) => `string`[]
+
+Read a string array (single values become a one-element array).
+
+#### Parameters
+
+##### name
+
+`string`
+
+#### Returns
+
+`string`[]
+
+***
+
+### has
+
+> **has**: (`name`) => `boolean`
+
+Whether a named argument was supplied (or has a default).
+
+#### Parameters
+
+##### name
+
+`string`
+
+#### Returns
+
+`boolean`
+
+***
+
+### positional
+
+> **positional**: `string`[]
+
+Positional (non-flag) arguments, in order.
+
+***
+
+### raw
+
+> **raw**: `Record`\<`string`, [`ScriptArgValue`](../type-aliases/ScriptArgValue.md)\>
+
+All named values keyed by canonical name.

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

@@ -0,0 +1,67 @@
+## Properties
+
+### addLog
+
+> **addLog**: (`level`, `message`) => `Promise`\<`void`\>
+
+Add a log entry to the task.
+
+#### Parameters
+
+##### level
+
+`"error"` \| `"info"` \| `"warn"`
+
+##### message
+
+`string`
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### args
+
+> **args**: [`ScriptArgs`](ScriptArgs.md)
+
+Arguments supplied to this run (from the CLI, HTTP body, or admin UI).
+
+***
+
+### 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.23.0/reference/generated/api/interfaces/ScriptResult.md

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

package/dist/docs/versioned/0.23.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.