@terreno/mcp 0.25.0 → 0.27.0

package/src/docs/versioned/0.25.0/reference/generated/api/functions/parseScriptArgs.md

@@ -0,0 +1,35 @@
+> **parseScriptArgs**(`tokens`, `defs?`): `object`
+
+Parse CLI-style tokens into a [ScriptArgs](../interfaces/ScriptArgs.md) accessor. Supports a flexible set
+of conventions so callers and scripts do not need to agree on a rigid format:
+
+- `--name=value` and `--name value`
+- `--flag` (boolean true) and `--no-flag` (boolean false)
+- short aliases `-x` (treated like `--x`)
+- repeated flags collapse into a string array
+- bare tokens become positional arguments
+
+When [declarations](../interfaces/ScriptArgDef.md) are supplied, values are coerced to the
+declared type, defaults are applied, and required args are validated.
+
+## Parameters
+
+### tokens
+
+`string`[]
+
+### defs?
+
+[`ScriptArgDef`](../interfaces/ScriptArgDef.md)[] = `[]`
+
+## Returns
+
+`object`
+
+### args
+
+> **args**: [`ScriptArgs`](../interfaces/ScriptArgs.md)
+
+### errors
+
+> **errors**: `string`[]

package/src/docs/versioned/0.25.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.25.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.25.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.25.0/reference/generated/api/functions/withApiErrorHandling.md

@@ -0,0 +1,31 @@
+> **withApiErrorHandling**\<`T`\>(`fn`, `options`): `Promise`\<`T`\>
+
+Wraps an external API call with standardized error handling: failures are normalized
+via normalizeApiError, passed through the optional redactError hook, logged exactly
+once, and rethrown.
+
+In "raw" mode (default) the wrapper logs the normalized shape via the injected logger
+and rethrows the original error. In "apiError" mode the wrapper throws a terreno
+APIError — whose constructor already logs — so the wrapper itself stays silent to
+preserve the log-once contract. The APIError title is stable per JSONAPI convention;
+per-occurrence text goes in `detail`, built from the (redacted) normalized messages.
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### fn
+
+() => `Promise`\<`T`\>
+
+### options
+
+[`WithApiErrorHandlingOptions`](../interfaces/WithApiErrorHandlingOptions.md)
+
+## Returns
+
+`Promise`\<`T`\>

package/src/docs/versioned/0.25.0/reference/generated/api/interfaces/AuthenticatedClient.md

@@ -0,0 +1,15 @@
+## Properties
+
+### axios
+
+> **axios**: `AxiosInstance`
+
+***
+
+### invalidateToken
+
+> **invalidateToken**: () => `void`
+
+#### Returns
+
+`void`

package/src/docs/versioned/0.25.0/reference/generated/api/interfaces/CreateAuthenticatedClientOptions.md

@@ -0,0 +1,45 @@
+## Properties
+
+### apiName?
+
+> `optional` **apiName?**: `string`
+
+***
+
+### auth
+
+> **auth**: [`AuthStrategy`](../type-aliases/AuthStrategy.md)
+
+***
+
+### baseURL
+
+> **baseURL**: `string`
+
+***
+
+### logger?
+
+> `optional` **logger?**: [`HttpClientLogger`](HttpClientLogger.md)
+
+***
+
+### redactError?
+
+> `optional` **redactError?**: (`normalized`) => [`NormalizedApiError`](NormalizedApiError.md)
+
+#### Parameters
+
+##### normalized
+
+[`NormalizedApiError`](NormalizedApiError.md)
+
+#### Returns
+
+[`NormalizedApiError`](NormalizedApiError.md)
+
+***
+
+### retry?
+
+> `optional` **retry?**: `Partial`\<[`RetryPolicy`](RetryPolicy.md)\>

package/src/docs/versioned/0.25.0/reference/generated/api/interfaces/CreateFeatureFlaggedLoggerOptions.md

@@ -0,0 +1,29 @@
+## Properties
+
+### gateCatch?
+
+> `optional` **gateCatch?**: `boolean`
+
+When false (default), `catch` always forwards to `target` so `promise.catch(log.catch)` still
+records errors when the flag is off. Set true to gate `catch` the same as other levels.
+
+***
+
+### isEnabled
+
+> **isEnabled**: () => `boolean`
+
+When this returns true, log calls are forwarded to `target`. Invoked on every call so flags
+can flip without process restart (env, database-backed flags, `@terreno/feature-flags`, etc.).
+
+#### Returns
+
+`boolean`
+
+***
+
+### target?
+
+> `optional` **target?**: [`ScopedLogger`](ScopedLogger.md)
+
+Defaults to global `logger`; pass `createScopedLogger({...})` for gated diagnostic blocks.

package/src/docs/versioned/0.25.0/reference/generated/api/interfaces/CreateScopedLoggerOptions.md

@@ -0,0 +1,18 @@
+## Properties
+
+### labels?
+
+> `optional` **labels?**: `Record`\<`string`, `string` \| `number` \| `boolean` \| `undefined`\>
+
+Workflow-specific dimensions merged into Winston metadata as `terrenoLabels` (plain-text
+suffix and structured jsonPayload on cloud transports). Avoid keys that collide with
+request context or scoped metadata: requestId, jobId, sessionId, userId, traceId, spanId,
+terrenoLogPrefix, terrenoRequestLog, terrenoLabels.
+
+***
+
+### prefix?
+
+> `optional` **prefix?**: `string`
+
+Short, stable token prepended to every message (for grep and log Explorer text search).

package/src/docs/versioned/0.25.0/reference/generated/api/interfaces/GitHubAuthOptions.md

@@ -0,0 +1,74 @@
+Options for configuring GitHub OAuth authentication
+
+## Properties
+
+### allowAccountLinking?
+
+> `optional` **allowAccountLinking?**: `boolean`
+
+Whether to allow linking GitHub to existing accounts.
+If true, authenticated users can link their GitHub account.
+Defaults to true.
+
+***
+
+### callbackURL
+
+> **callbackURL**: `string`
+
+Callback URL for GitHub OAuth (e.g., https://yourapp.com/auth/github/callback)
+
+***
+
+### clientId
+
+> **clientId**: `string`
+
+GitHub OAuth Client ID
+
+***
+
+### clientSecret
+
+> **clientSecret**: `string`
+
+GitHub OAuth Client Secret
+
+***
+
+### findOrCreateUser?
+
+> `optional` **findOrCreateUser?**: (`profile`, `accessToken`, `refreshToken`, `existingUser?`) => `Promise`\<`unknown`\>
+
+Custom function to handle user creation or lookup from GitHub profile.
+If not provided, a default implementation will be used.
+
+#### Parameters
+
+##### profile
+
+`Profile`
+
+##### accessToken
+
+`string`
+
+##### refreshToken
+
+`string`
+
+##### existingUser?
+
+`Record`\<`string`, `unknown`\>
+
+#### Returns
+
+`Promise`\<`unknown`\>
+
+***
+
+### scope?
+
+> `optional` **scope?**: `string`[]
+
+OAuth scopes to request from GitHub. Defaults to ["user:email"]

package/src/docs/versioned/0.25.0/reference/generated/api/interfaces/HttpClientLogger.md

@@ -0,0 +1,62 @@
+Minimal logging surface used by the HTTP client utilities so consumers (and tests)
+can inject their own logger. Defaults to the terreno logger.
+
+## Properties
+
+### debug
+
+> **debug**: (`msg`, ...`args`) => `void`
+
+#### Parameters
+
+##### msg
+
+`string`
+
+##### args
+
+...`unknown`[]
+
+#### Returns
+
+`void`
+
+***
+
+### error
+
+> **error**: (`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.25.0/reference/generated/api/interfaces/LogContextFields.md

@@ -0,0 +1,41 @@
+## Properties
+
+### jobId?
+
+> `optional` **jobId?**: `string`
+
+***
+
+### requestId?
+
+> `optional` **requestId?**: `string`
+
+***
+
+### sessionId?
+
+> `optional` **sessionId?**: `string`
+
+***
+
+### terrenoLabels?
+
+> `optional` **terrenoLabels?**: `Record`\<`string`, `string`\>
+
+***
+
+### terrenoLogPrefix?
+
+> `optional` **terrenoLogPrefix?**: `string`
+
+***
+
+### traceId?
+
+> `optional` **traceId?**: `string`
+
+***
+
+### userId?
+
+> `optional` **userId?**: `string`

package/src/docs/versioned/0.25.0/reference/generated/api/interfaces/LoggingOptions.md

@@ -0,0 +1,73 @@
+## Properties
+
+### disableConsoleColors?
+
+> `optional` **disableConsoleColors?**: `boolean`
+
+***
+
+### disableConsoleLogging?
+
+> `optional` **disableConsoleLogging?**: `boolean`
+
+***
+
+### disableFileLogging?
+
+> `optional` **disableFileLogging?**: `boolean`
+
+***
+
+### disableTerrenoDevJsonlLog?
+
+> `optional` **disableTerrenoDevJsonlLog?**: `boolean`
+
+When true, skips the dev JSONL file under `.terreno/logs/app.log`.
+
+***
+
+### level?
+
+> `optional` **level?**: `"error"` \| `"debug"` \| `"info"` \| `"warn"`
+
+***
+
+### logDirectory?
+
+> `optional` **logDirectory?**: `string`
+
+***
+
+### logRequests?
+
+> `optional` **logRequests?**: `boolean`
+
+***
+
+### logSlowRequests?
+
+> `optional` **logSlowRequests?**: `boolean`
+
+***
+
+### logSlowRequestsReadMs?
+
+> `optional` **logSlowRequestsReadMs?**: `number`
+
+***
+
+### logSlowRequestsWriteMs?
+
+> `optional` **logSlowRequestsWriteMs?**: `number`
+
+***
+
+### showConsoleTimestamps?
+
+> `optional` **showConsoleTimestamps?**: `boolean`
+
+***
+
+### transports?
+
+> `optional` **transports?**: `TransportStream`[]