@terreno/mcp 0.22.2 → 0.23.1

package/dist/docs/versioned/0.23.0/reference/generated/api/functions/isAPIError.md

@@ -0,0 +1,11 @@
+> **isAPIError**(`error`): `error is APIError`
+
+## Parameters
+
+### error
+
+`unknown`
+
+## Returns
+
+`error is APIError`

package/dist/docs/versioned/0.23.0/reference/generated/api/functions/isDeletedPlugin.md

@@ -0,0 +1,15 @@
+> **isDeletedPlugin**(`schema`, `defaultValue?`): `void`
+
+## Parameters
+
+### schema
+
+`Schema`\<`any`, `any`, `any`, `any`\>
+
+### defaultValue?
+
+`boolean` = `false`
+
+## Returns
+
+`void`

package/dist/docs/versioned/0.23.0/reference/generated/api/functions/isDisabledPlugin.md

@@ -0,0 +1,15 @@
+> **isDisabledPlugin**(`schema`, `defaultValue?`): `void`
+
+## Parameters
+
+### schema
+
+`Schema`\<`any`, `any`, `any`, `any`\>
+
+### defaultValue?
+
+`boolean` = `false`
+
+## Returns
+
+`void`

package/dist/docs/versioned/0.23.0/reference/generated/api/functions/isOpenApiValidatorConfigured.md

@@ -0,0 +1,8 @@
+> **isOpenApiValidatorConfigured**(): `boolean`
+
+Check whether `configureOpenApiValidator()` has been called.
+Validation middleware is a no-op when this returns false.
+
+## Returns
+
+`boolean`

package/dist/docs/versioned/0.23.0/reference/generated/api/functions/isValidObjectId.md

@@ -0,0 +1,11 @@
+> **isValidObjectId**(`id`): `boolean`
+
+## Parameters
+
+### id
+
+`string`
+
+## Returns
+
+`boolean`

package/dist/docs/versioned/0.23.0/reference/generated/api/functions/jsonResponseRequestIdMiddleware.md

@@ -0,0 +1,24 @@
+> **jsonResponseRequestIdMiddleware**(`req`, `res`, `next`): `void`
+
+TerrenoApp middleware: augments `res.json` so plain-object payloads include
+`requestId` for client correlation. Skips OpenAPI tooling GET JSON routes
+(`/openapi.json`, `/openapi/components/...json`, `/openapi/validate`) so
+machine-consumed payloads stay valid. Does not wrap arrays or primitives.
+
+## Parameters
+
+### req
+
+`Request`
+
+### res
+
+`Response`
+
+### next
+
+`NextFunction`
+
+## Returns
+
+`void`

package/dist/docs/versioned/0.23.0/reference/generated/api/functions/logRequests.md

@@ -0,0 +1,19 @@
+> **logRequests**(`req`, `res`, `next`): `void`
+
+## Parameters
+
+### req
+
+`any`
+
+### res
+
+`any`
+
+### next
+
+`NextFunction`
+
+## Returns
+
+`void`

package/dist/docs/versioned/0.23.0/reference/generated/api/functions/matchesQuery.md

@@ -0,0 +1,23 @@
+> **matchesQuery**(`doc`, `query`): `boolean`
+
+Check if a document matches a MongoDB-style query in memory.
+
+## Parameters
+
+### doc
+
+`Record`\<`string`, `unknown`\>
+
+The document to test (plain object or Mongoose document)
+
+### query
+
+`Record`\<`string`, `unknown`\>
+
+MongoDB-style query object
+
+## Returns
+
+`boolean`
+
+true if the document matches all query conditions

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