@terreno/mcp 0.23.0 → 0.24.0

package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/OpenApiMiddleware.md

@@ -0,0 +1,98 @@
+Interface for the vendored @wesleytodd/openapi Express middleware.
+Provides methods for building OpenAPI documentation from Express routes.
+
+> **OpenApiMiddleware**(`req`, `res`, `next`): `void`
+
+The middleware itself is callable as Express middleware.
+
+## Parameters
+
+### req
+
+`Request`
+
+### res
+
+`Response`
+
+### next
+
+`NextFunction`
+
+## Returns
+
+`void`
+
+## Properties
+
+### component
+
+> **component**: (`type`, `name?`, `description?`) => `Record`\<`string`, `unknown`\> \| `OpenApiMiddleware` \| \{ `$ref`: `string`; \} \| `undefined`
+
+Register or retrieve an OpenAPI component definition (schemas, responses, parameters, etc).
+
+#### Parameters
+
+##### type
+
+`string`
+
+##### name?
+
+`string`
+
+##### description?
+
+`Record`\<`string`, `unknown`\>
+
+#### Returns
+
+`Record`\<`string`, `unknown`\> \| `OpenApiMiddleware` \| \{ `$ref`: `string`; \} \| `undefined`
+
+***
+
+### document
+
+> **document**: `Record`\<`string`, `unknown`\>
+
+The generated OpenAPI document
+
+***
+
+### path
+
+> **path**: (`schema?`) => `RequestHandler`
+
+Register a path-level OpenAPI schema, returning an Express middleware that attaches the schema to the route.
+
+#### Parameters
+
+##### schema?
+
+`Record`\<`string`, `unknown`\>
+
+#### Returns
+
+`RequestHandler`
+
+***
+
+### schema
+
+> **schema**: (`name?`, `description?`) => `Record`\<`string`, `unknown`\> \| `OpenApiMiddleware` \| \{ `$ref`: `string`; \} \| `undefined`
+
+Shorthand for component("schemas", ...)
+
+#### Parameters
+
+##### name?
+
+`string`
+
+##### description?
+
+`Record`\<`string`, `unknown`\>
+
+#### Returns
+
+`Record`\<`string`, `unknown`\> \| `OpenApiMiddleware` \| \{ `$ref`: `string`; \} \| `undefined`

package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/OpenApiParameter.md

@@ -0,0 +1,66 @@
+Defines a parameter in an OpenAPI operation.
+
+Parameters can be passed via query string, path segments, or headers.
+Path parameters are always required by OpenAPI specification.
+
+## Example
+
+```typescript
+// Query parameter
+const limitParam: OpenApiParameter = {
+  in: "query",
+  name: "limit",
+  required: false,
+  schema: {type: "number"},
+  description: "Maximum number of results",
+};
+
+// Path parameter
+const idParam: OpenApiParameter = {
+  in: "path",
+  name: "id",
+  required: true,
+  schema: {type: "string"},
+  description: "Resource identifier",
+};
+```
+
+## Properties
+
+### description?
+
+> `optional` **description?**: `string`
+
+Human-readable description of the parameter
+
+***
+
+### in
+
+> **in**: `"header"` \| `"path"` \| `"query"`
+
+Location of the parameter
+
+***
+
+### name
+
+> **name**: `string`
+
+Name of the parameter
+
+***
+
+### required?
+
+> `optional` **required?**: `boolean`
+
+Whether the parameter is required (path params are always required)
+
+***
+
+### schema
+
+> **schema**: [`OpenApiSchemaProperty`](OpenApiSchemaProperty.md)
+
+Schema defining the parameter's type and format

package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/OpenApiResponse.md

@@ -0,0 +1,43 @@
+Defines a response in an OpenAPI operation.
+
+Responses include a description and optionally content with a schema
+for the response body.
+
+## Example
+
+```typescript
+const successResponse: OpenApiResponse = {
+  description: "Successfully retrieved user",
+  content: {
+    "application/json": {
+      schema: {
+        type: "object",
+        properties: {
+          id: {type: "string"},
+          name: {type: "string"},
+        },
+      },
+    },
+  },
+};
+```
+
+## Properties
+
+### content?
+
+> `optional` **content?**: `object`
+
+Content definitions keyed by media type
+
+#### Index Signature
+
+\[`mediaType`: `string`\]: `object`
+
+***
+
+### description
+
+> **description**: `string`
+
+Human-readable description of the response

package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/OpenApiSchema.md

@@ -0,0 +1,62 @@
+Defines the top-level schema for request bodies and responses.
+
+This type represents complete object schemas used in OpenAPI operations,
+typically for request bodies and response content.
+
+## Example
+
+```typescript
+const userSchema: OpenApiSchema = {
+  type: "object",
+  properties: {
+    id: {type: "string"},
+    name: {type: "string"},
+    email: {type: "string", format: "email"},
+  },
+  required: ["id", "name"],
+};
+```
+
+## Indexable
+
+> \[`key`: `string`\]: `unknown`
+
+## Properties
+
+### additionalProperties?
+
+> `optional` **additionalProperties?**: `boolean` \| [`OpenApiSchemaProperty`](OpenApiSchemaProperty.md)
+
+Schema for additional properties or boolean to allow/disallow them
+
+***
+
+### items?
+
+> `optional` **items?**: [`OpenApiSchemaProperty`](OpenApiSchemaProperty.md)
+
+Schema for array items when type is "array"
+
+***
+
+### properties?
+
+> `optional` **properties?**: `Record`\<`string`, [`OpenApiSchemaProperty`](OpenApiSchemaProperty.md)\>
+
+Property definitions for object types
+
+***
+
+### required?
+
+> `optional` **required?**: `string`[]
+
+List of required property names
+
+***
+
+### type
+
+> **type**: `string`
+
+The JSON Schema type (typically "object" or "array")

package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/OpenApiSchemaProperty.md

@@ -0,0 +1,89 @@
+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/src/docs/versioned/0.23.0/reference/generated/api/interfaces/OpenApiValidatorConfig.md

@@ -0,0 +1,94 @@
+Global configuration for OpenAPI validation.
+This can be set at server startup to control validation behavior.
+
+## Properties
+
+### coerceTypes?
+
+> `optional` **coerceTypes?**: `boolean`
+
+Whether to coerce types (e.g., string "123" to number 123).
+Default: true
+
+***
+
+### logValidationErrors?
+
+> `optional` **logValidationErrors?**: `boolean`
+
+Log validation errors for debugging.
+Default: true
+
+***
+
+### onAdditionalPropertiesRemoved?
+
+> `optional` **onAdditionalPropertiesRemoved?**: (`removedProperties`, `req`) => `void`
+
+Callback fired when additional properties are removed from a request body.
+Only fires when `removeAdditional: true` and extra properties are present.
+Receives the list of removed property names and the request.
+
+#### Parameters
+
+##### removedProperties
+
+`string`[]
+
+##### req
+
+`Request`
+
+#### Returns
+
+`void`
+
+***
+
+### onValidationError?
+
+> `optional` **onValidationError?**: (`errors`, `req`) => `void`
+
+Custom error handler for validation failures.
+If not provided, throws an APIError with status 400.
+
+#### Parameters
+
+##### errors
+
+`ErrorObject`\<`string`, `Record`\<`string`, `any`\>, `unknown`\>[]
+
+##### req
+
+`Request`
+
+#### Returns
+
+`void`
+
+***
+
+### removeAdditional?
+
+> `optional` **removeAdditional?**: `boolean`
+
+Whether to remove additional properties not in the schema.
+Default: true
+
+***
+
+### validateRequests?
+
+> `optional` **validateRequests?**: `boolean`
+
+Enable or disable request body validation.
+Default: true (when configureOpenApiValidator is called)
+
+***
+
+### validateResponses?
+
+> `optional` **validateResponses?**: `boolean`
+
+Enable or disable response validation.
+Default: false (response validation has performance overhead)

package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/PopulatePath.md

@@ -0,0 +1,17 @@
+## Properties
+
+### fields?
+
+> `optional` **fields?**: `string`[]
+
+***
+
+### openApiComponent?
+
+> `optional` **openApiComponent?**: `string`
+
+***
+
+### path
+
+> **path**: `string`

package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/QuerySubscription.md

@@ -0,0 +1,25 @@
+Payload sent by the client to subscribe to a query-filtered list.
+
+## Properties
+
+### collection
+
+> **collection**: `string`
+
+Collection tag (e.g. "todos")
+
+***
+
+### query
+
+> **query**: `Record`\<`string`, `unknown`\>
+
+MongoDB-style query filter (e.g. {completed: false})
+
+***
+
+### queryId?
+
+> `optional` **queryId?**: `string`
+
+Client-provided queryId (ignored — server computes a canonical ID)

package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/QueryValidatorOptions.md

@@ -0,0 +1,31 @@
+Options for the query parameter validator middleware.
+
+## Properties
+
+### enabled?
+
+> `optional` **enabled?**: `boolean`
+
+Override the global validateRequests setting for this specific route.
+
+***
+
+### 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`

package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/RESTPermissions.md

@@ -0,0 +1,35 @@
+## Type Parameters
+
+### T
+
+`T`
+
+## Properties
+
+### create
+
+> **create**: [`PermissionMethod`](../type-aliases/PermissionMethod.md)\<`T`\>[]
+
+***
+
+### delete
+
+> **delete**: [`PermissionMethod`](../type-aliases/PermissionMethod.md)\<`T`\>[]
+
+***
+
+### list
+
+> **list**: [`PermissionMethod`](../type-aliases/PermissionMethod.md)\<`T`\>[]
+
+***
+
+### read
+
+> **read**: [`PermissionMethod`](../type-aliases/PermissionMethod.md)\<`T`\>[]
+
+***
+
+### update
+
+> **update**: [`PermissionMethod`](../type-aliases/PermissionMethod.md)\<`T`\>[]

package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/RealtimeAppOptions.md

@@ -0,0 +1,62 @@
+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.
+
+***
+
+### 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
+
+***
+
+### tokenSecret?
+
+> `optional` **tokenSecret?**: `string`
+
+JWT secret for socket authentication (default: process.env.TOKEN_SECRET)

package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/RealtimeConfig.md

@@ -0,0 +1,44 @@
+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)