@terreno/mcp 0.23.1 → 0.25.0

package/src/docs/versioned/0.24.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/src/docs/versioned/0.24.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/src/docs/versioned/0.24.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/src/docs/versioned/0.24.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/src/docs/versioned/0.24.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/src/docs/versioned/0.24.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/src/docs/versioned/0.24.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/src/docs/versioned/0.24.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

package/src/docs/versioned/0.24.0/reference/generated/api/interfaces/TerrenoRequestLogEntry.md

@@ -0,0 +1,13 @@
+Always attached to Winston metadata while a request/job ALS scope is active.
+
+## Properties
+
+### requestId
+
+> **requestId**: `string`
+
+***
+
+### userId
+
+> **userId**: `string` \| `null`

package/src/docs/versioned/0.24.0/reference/generated/api/type-aliases/AuthProvider.md

@@ -0,0 +1,5 @@
+> **AuthProvider** = `"jwt"` \| `"better-auth"`
+
+Auth provider selection for TerrenoApp.
+- "jwt": Traditional JWT/Passport authentication (default)
+- "better-auth": Better Auth with OAuth support

package/src/docs/versioned/0.24.0/reference/generated/api/type-aliases/ConfigurationPostUpdateHook.md

@@ -0,0 +1,24 @@
+> **ConfigurationPostUpdateHook** = (`config`, `prevValue`, `req`) => `void` \| `Promise`\<`void`\>
+
+Hook invoked after a configuration update is applied. Receives the updated
+configuration and the previous value (both with secret values redacted) plus
+the request, enabling audit logging of who changed what. Secret values are
+never included.
+
+## Parameters
+
+### config
+
+`Record`\<`string`, `unknown`\>
+
+### prevValue
+
+`Record`\<`string`, `unknown`\>
+
+### req
+
+`express.Request`
+
+## Returns
+
+`void` \| `Promise`\<`void`\>

package/src/docs/versioned/0.24.0/reference/generated/api/type-aliases/ConfigurationPreUpdateHook.md

@@ -0,0 +1,20 @@
+> **ConfigurationPreUpdateHook** = (`body`, `req`) => `Record`\<`string`, `unknown`\> \| `Promise`\<`Record`\<`string`, `unknown`\>\>
+
+Hook invoked before a configuration update is applied. Receives the incoming
+(already system-field- and secret-field-stripped) body and the request, and
+returns the body to apply. Use it to validate or normalize input. Throw an
+[APIError](../classes/APIError.md) to reject the update.
+
+## Parameters
+
+### body
+
+`Record`\<`string`, `unknown`\>
+
+### req
+
+`express.Request`
+
+## Returns
+
+`Record`\<`string`, `unknown`\> \| `Promise`\<`Record`\<`string`, `unknown`\>\>

package/src/docs/versioned/0.24.0/reference/generated/api/type-aliases/ScriptArgValue.md

@@ -0,0 +1,3 @@
+> **ScriptArgValue** = `string` \| `number` \| `boolean` \| `string`[]
+
+A single parsed argument value. Repeated flags collapse into a string array.

package/src/docs/versioned/0.24.0/reference/generated/api/variables/REQUEST_CONTEXT_ATTRIBUTE_NAMES.md

@@ -0,0 +1,39 @@
+> `const` **REQUEST\_CONTEXT\_ATTRIBUTE\_NAMES**: `object`
+
+Canonical HTTP header names for each correlation field. Use these to propagate context to
+downstream services (pair with [getCurrentRequestContextAttributes](../functions/getCurrentRequestContextAttributes.md)) or to read it from an
+incoming request (pair with [getRequestContextFromAttributes](../functions/getRequestContextFromAttributes.md)).
+
+## Type Declaration
+
+### jobId
+
+> `readonly` **jobId**: `"x-job-id"` = `JOB_ID_HEADER`
+
+### requestId
+
+> `readonly` **requestId**: `"x-request-id"` = `"x-request-id"`
+
+### sessionId
+
+> `readonly` **sessionId**: `"x-session-id"` = `SESSION_ID_HEADER`
+
+### spanId
+
+> `readonly` **spanId**: `"x-span-id"` = `SPAN_ID_HEADER`
+
+### traceId
+
+> `readonly` **traceId**: `"x-trace-id"` = `TRACE_ID_HEADER`
+
+### traceParent
+
+> `readonly` **traceParent**: `"traceparent"` = `TRACE_PARENT_HEADER`
+
+### traceSampled
+
+> `readonly` **traceSampled**: `"x-trace-sampled"` = `TRACE_SAMPLED_HEADER`
+
+### userId
+
+> `readonly` **userId**: `"x-user-id"` = `USER_ID_HEADER`

package/src/docs/versioned/0.24.0/reference/generated/api/variables/consentResponsePopulatePaths.md

@@ -0,0 +1,3 @@
+> `const` **consentResponsePopulatePaths**: [`PopulatePath`](../interfaces/PopulatePath.md)[]
+
+Shared populate config for consent response list/read endpoints.