@terreno/mcp 57.20.0 → 58.0.0-beta.1

package/dist/docs/versioned/57.2.0/reference/generated/api/interfaces/OpenApiSchemaProperty.md

@@ -1,89 +0,0 @@
-Defines a property within an OpenAPI schema.
-
-This type represents the structure of individual properties in request bodies,
-response objects, and nested schemas. It supports primitive types, arrays,
-nested objects, and additional properties for map-like structures.
-
-## Example
-
-```typescript
-// Simple string property
-const nameProperty: OpenApiSchemaProperty = {
-  type: "string",
-  description: "User's full name",
-};
-
-// Array of objects
-const itemsProperty: OpenApiSchemaProperty = {
-  type: "array",
-  items: {
-    type: "object",
-    properties: {
-      id: {type: "string"},
-      value: {type: "number"},
-    },
-  },
-};
-
-// Object with additional properties (map/dictionary)
-const metadataProperty: OpenApiSchemaProperty = {
-  type: "object",
-  additionalProperties: {type: "string"},
-};
-```
-
-## Properties
-
-### additionalProperties?
-
-> `optional` **additionalProperties?**: `boolean` \| `OpenApiSchemaProperty`
-
-Schema for additional properties or boolean to allow/disallow them
-
-***
-
-### description?
-
-> `optional` **description?**: `string`
-
-Human-readable description of the property
-
-***
-
-### format?
-
-> `optional` **format?**: `string`
-
-Format hint for the type (e.g., "date-time", "email", "uri", "uuid")
-
-***
-
-### items?
-
-> `optional` **items?**: `OpenApiSchemaProperty`
-
-Schema for array items when type is "array"
-
-***
-
-### properties?
-
-> `optional` **properties?**: `Record`\<`string`, `OpenApiSchemaProperty`\>
-
-Nested properties when type is "object"
-
-***
-
-### required?
-
-> `optional` **required?**: `boolean`
-
-Whether this property is required in the parent object
-
-***
-
-### type
-
-> **type**: `string`
-
-The JSON Schema type (e.g., "string", "number", "boolean", "object", "array")

package/dist/docs/versioned/57.2.0/reference/generated/api/interfaces/OrganizationScopedUser.md

@@ -1,56 +0,0 @@
-A user that may belong to one or more organizations (tenants). Backends that use tenant-scoped
-models add an `organizationIds` array to their user model; this interface lets the shared
-permission/query-filter helpers read it without every consumer casting by hand.
-
-## Extends
-
-- [`User`](User.md)
-
-## Properties
-
-### \_id
-
-> **\_id**: `string` \| `ObjectId`
-
-#### Inherited from
-
-[`User`](User.md).[`_id`](User.md#_id)
-
-***
-
-### admin
-
-> **admin**: `boolean`
-
-#### Inherited from
-
-[`User`](User.md).[`admin`](User.md#admin)
-
-***
-
-### id
-
-> **id**: `string`
-
-#### Inherited from
-
-[`User`](User.md).[`id`](User.md#id)
-
-***
-
-### isAnonymous?
-
-> `optional` **isAnonymous?**: `boolean`
-
-We support anonymous users, which do not yet have login information.
-This can be helpful for pre-signup users.
-
-#### Inherited from
-
-[`User`](User.md).[`isAnonymous`](User.md#isanonymous)
-
-***
-
-### organizationIds?
-
-> `optional` **organizationIds?**: `string`[]

package/dist/docs/versioned/57.2.0/reference/generated/api/interfaces/PermissionSource.md

@@ -1,41 +0,0 @@
-## Properties
-
-### getGrants
-
-> **getGrants**: (`args`) => `Promise`\<[`PermissionSourceGrants`](PermissionSourceGrants.md) \| `null`\>
-
-#### Parameters
-
-##### args
-
-###### user
-
-[`User`](User.md)
-
-#### Returns
-
-`Promise`\<[`PermissionSourceGrants`](PermissionSourceGrants.md) \| `null`\>
-
-***
-
-### name
-
-> **name**: `string`
-
-***
-
-### staleMaxAgeMs?
-
-> `optional` **staleMaxAgeMs?**: `number`
-
-***
-
-### staleOnFailure?
-
-> `optional` **staleOnFailure?**: [`StaleOnFailurePolicy`](../type-aliases/StaleOnFailurePolicy.md)
-
-***
-
-### ttlMs?
-
-> `optional` **ttlMs?**: `number`

package/dist/docs/versioned/57.2.0/reference/generated/api/interfaces/RbacRoleDocument.md

@@ -1,59 +0,0 @@
-## Properties
-
-### \_id
-
-> **\_id**: `ObjectId`
-
-***
-
-### created
-
-> **created**: `Date`
-
-***
-
-### description?
-
-> `optional` **description?**: `string`
-
-***
-
-### displayName
-
-> **displayName**: `string`
-
-***
-
-### excludesRoles
-
-> **excludesRoles**: `string`[]
-
-***
-
-### isLocked
-
-> **isLocked**: `boolean`
-
-***
-
-### isSealed
-
-> **isSealed**: `boolean`
-
-***
-
-### name
-
-> **name**: `string`
-
-***
-
-### permissions
-
-> **permissions**: [`PermissionSet`](../type-aliases/PermissionSet.md)
-
-***
-
-### updated
-
-> **updated**: `Date`

package/dist/docs/versioned/57.2.0/reference/generated/api/interfaces/RealtimeAppOptions.md

@@ -1,163 +0,0 @@
-Options for the RealtimeApp plugin.
-
-## Properties
-
-### adapter?
-
-> `optional` **adapter?**: `"none"` \| `"redis"`
-
-Socket.io adapter for multi-instance deployments.
-- 'none': single-instance mode, no adapter (default)
-- 'redis': use Redis adapter (requires redisUrl or VALKEY_URL env var)
-
-For MongoDB adapter or custom adapters, configure the Socket.io instance
-directly via getIo() after server creation.
-
-***
-
-### betterAuth?
-
-> `optional` **betterAuth?**: [`BetterAuthSocketOptions`](BetterAuthSocketOptions.md)
-
-Enables the Better Auth session validator for socket authentication, tried after the
-legacy JWT validator. Pass the instance returned by `createBetterAuth` (and optionally
-the app user model so `decodedToken.id`/`admin` match the REST identity).
-
-***
-
-### changeStream?
-
-> `optional` **changeStream?**: [`ChangeStreamConfig`](ChangeStreamConfig.md)
-
-Change stream watcher configuration
-
-***
-
-### cors?
-
-> `optional` **cors?**: `object`
-
-CORS configuration for Socket.io
-
-#### methods?
-
-> `optional` **methods?**: `string`[]
-
-#### origin
-
-> **origin**: `string` \| `string`[]
-
-***
-
-### debug?
-
-> `optional` **debug?**: `boolean`
-
-Enable debug logging
-
-***
-
-### redisUrl?
-
-> `optional` **redisUrl?**: `string`
-
-Redis URL for the Redis adapter
-
-***
-
-### sessionRevalidationIntervalMs?
-
-> `optional` **sessionRevalidationIntervalMs?**: `number`
-
-Interval in ms for the periodic socket session re-validation sweep (D1): re-checks
-JWT expiry / Better Auth session validity and the user's `disabled` flag for every
-connected socket, disconnecting (`sync:auth-expired` then `disconnect(true)`) any
-socket that fails. Also refreshes `socket.data.fullUser` (D2) and re-resolves sync
-stream membership, leaving rooms for streams no longer held (D4). Default 60_000ms;
-set to 0 to disable the sweep entirely (e.g. in tests).
-
-***
-
-### SocketServer?
-
-> `optional` **SocketServer?**: *typeof* `Server`
-
-Test seam: Socket.IO server constructor. Defaults to `socket.io`'s `Server`.
-Prefer this over `mock.module("socket.io")` — bun's module mocks are process-wide
-and break later files that need a real Socket.IO server (sync integration, etc.).
-
-***
-
-### startChangeStreamWatcher?
-
-> `optional` **startChangeStreamWatcher?**: (`io`, `config`, `debug`) => `void`
-
-Test seam: change-stream watcher starter. Defaults to the real
-`startChangeStreamWatcher`. Same rationale as [SocketServer](#socketserver) — avoid
-process-wide `mock.module` of `./changeStreamWatcher`.
-
-Start watching MongoDB change streams and emitting real-time events.
-
-Task 9.16: the stream is supervised — an `error`/`close`/`end` schedules a re-open with
-exponential backoff, resuming from the last seen token. Call
-[stopChangeStreamWatcher](../functions/stopChangeStreamWatcher.md) to end supervision.
-
-#### Parameters
-
-##### io
-
-`Server`
-
-##### config?
-
-[`ChangeStreamConfig`](ChangeStreamConfig.md) = `{}`
-
-##### debug?
-
-`boolean` = `false`
-
-#### Returns
-
-`void`
-
-***
-
-### sync?
-
-> `optional` **sync?**: [`SyncAppOptions`](SyncAppOptions.md)
-
-Explicit SyncAppOptions override for the sync socket handlers. Normally omitted —
-the options registered by the SyncApp plugin are used automatically.
-
-***
-
-### tokenIssuer?
-
-> `optional` **tokenIssuer?**: `string`
-
-JWT issuer required for socket authentication (default: process.env.TOKEN_ISSUER),
-for parity with the HTTP JWT path's `jwt.verify(token, secret, {issuer})` (D1).
-Omit (and leave `TOKEN_ISSUER` unset) to skip the issuer check.
-
-***
-
-### tokenSecret?
-
-> `optional` **tokenSecret?**: `string`
-
-JWT secret for socket authentication (default: process.env.TOKEN_SECRET)
-
-***
-
-### userModel?
-
-> `optional` **userModel?**: [`UserModel`](UserModel.md)
-
-The application's Mongoose user model. When provided, the full user document is
-loaded once at handshake (by the decoded token's id) and cached on
-`socket.data.fullUser`, then refreshed by the periodic session re-validation sweep
-(D1). Authorization for realtime/sync subscriptions and mutations uses this full
-document instead of the synthetic `{_id, admin, id}` shape derived from the token
-alone — required for any permission check or `getUserScopes` resolver that reads
-fields beyond `admin` (e.g. `organizationIds` for tenant-scoped sync). Without it,
-socket-side authorization falls back to the synthetic shape (pre-D2 behavior).

package/dist/docs/versioned/57.2.0/reference/generated/api/interfaces/RealtimeConfig.md

@@ -1,44 +0,0 @@
-Configuration for real-time sync on a modelRouter.
-Determines which CRUD methods emit WebSocket events and how they are routed.
-
-## Properties
-
-### methods
-
-> **methods**: (`"delete"` \| `"create"` \| `"update"`)[]
-
-Which CRUD methods should emit real-time sync events
-
-***
-
-### realtimeResponseHandler?
-
-> `optional` **realtimeResponseHandler?**: (`doc`, `method`) => `unknown`
-
-Custom serializer for real-time events. Falls back to the modelRouter responseHandler.
-
-#### Parameters
-
-##### doc
-
-`Record`\<`string`, `unknown`\>
-
-##### method
-
-`string`
-
-#### Returns
-
-`unknown`
-
-***
-
-### roomStrategy
-
-> **roomStrategy**: `"model"` \| `"owner"` \| `"broadcast"` \| ((`doc`, `method`, `req`) => `string`[])
-
-Strategy for determining which Socket.io rooms receive events.
-- 'owner': emit to `user:{doc.ownerId}` room
-- 'model': emit to `model:{modelName}` room (clients must subscribe)
-- 'broadcast': emit to all authenticated sockets
-- function: custom room resolver returning room name(s)

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

@@ -1,57 +0,0 @@
-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?**: `unknown`
-
-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/57.2.0/reference/generated/api/interfaces/RealtimeRegistryEntry.md

@@ -1,42 +0,0 @@
-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)\<`unknown`\>
-
-Full modelRouter options (for responseHandler, permissions, etc.), erased to
-`unknown` since the registry holds entries for every model.
-
-***
-
-### routePath
-
-> **routePath**: `string`
-
-Route path (e.g. "/todos")

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

@@ -1,71 +0,0 @@
-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/57.2.0/reference/generated/api/interfaces/RequestContext.md

@@ -1,59 +0,0 @@
-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.