@terreno/mcp 0.21.0

package/src/docs/versioned/0.19.0/reference/generated/api/functions/checkPermissions.md

@@ -0,0 +1,29 @@
+> **checkPermissions**\<`T`\>(`method`, `permissions`, `user?`, `obj?`): `Promise`\<`boolean`\>
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### method
+
+[`RESTMethod`](../type-aliases/RESTMethod.md)
+
+### permissions
+
+[`PermissionMethod`](../type-aliases/PermissionMethod.md)\<`T`\>[]
+
+### user?
+
+[`User`](../interfaces/User.md)
+
+### obj?
+
+`T`
+
+## Returns
+
+`Promise`\<`boolean`\>

package/src/docs/versioned/0.19.0/reference/generated/api/functions/clearQueryStore.md

@@ -0,0 +1,7 @@
+> **clearQueryStore**(): `void`
+
+Clear all subscriptions (for testing).
+
+## Returns
+
+`void`

package/src/docs/versioned/0.19.0/reference/generated/api/functions/clearRealtimeRegistry.md

@@ -0,0 +1,7 @@
+> **clearRealtimeRegistry**(): `void`
+
+Clear the registry (for testing).
+
+## Returns
+
+`void`

package/src/docs/versioned/0.19.0/reference/generated/api/functions/computeQueryId.md

@@ -0,0 +1,18 @@
+> **computeQueryId**(`collection`, `query`): `string`
+
+Compute a deterministic queryId from collection and query on the server side.
+This prevents clients from hijacking other subscriptions by providing a colliding queryId.
+
+## Parameters
+
+### collection
+
+`string`
+
+### query
+
+`Record`\<`string`, `any`\>
+
+## Returns
+
+`string`

package/src/docs/versioned/0.19.0/reference/generated/api/functions/configurationPlugin.md

@@ -0,0 +1,37 @@
+> **configurationPlugin**(`schema`, `options?`): `void`
+
+Mongoose schema plugin that adds singleton configuration behavior.
+
+Adds:
+- Pre-save hook enforcing exactly one document
+- `getConfig()` static: fetches or creates the singleton (full doc or keyed value)
+- `updateConfig(updates)` static: patches the singleton
+- `getSecretFields()` static: returns metadata for fields with `secret: true`
+- `resolveSecrets(provider?)` static: fetches secret values, using the plugin provider by default
+
+Mark fields as secrets using schema path options:
+```typescript
+const configSchema = new Schema({
+  apiKey: {
+    type: String,
+    description: "Third-party API key",
+    secret: true,
+    secretName: "my-api-key",
+  },
+});
+configSchema.plugin(configurationPlugin, {secretProvider: new EnvSecretProvider()});
+```
+
+## Parameters
+
+### schema
+
+`Schema`
+
+### options?
+
+[`ConfigurationPluginOptions`](../interfaces/ConfigurationPluginOptions.md)
+
+## Returns
+
+`void`

package/src/docs/versioned/0.19.0/reference/generated/api/functions/configureOpenApiValidator.md

@@ -0,0 +1,28 @@
+> **configureOpenApiValidator**(`config?`): `void`
+
+Configure the global OpenAPI validator settings.
+Calling this function activates validation — middleware that was previously
+installed as a no-op will begin validating requests.
+
+## Parameters
+
+### config?
+
+`Partial`\<[`OpenApiValidatorConfig`](../interfaces/OpenApiValidatorConfig.md)\> = `{}`
+
+Configuration options to merge with existing config
+
+## Returns
+
+`void`
+
+## Example
+
+```typescript
+configureOpenApiValidator({
+  removeAdditional: true,
+  onAdditionalPropertiesRemoved: (props, req) => {
+    Sentry.captureMessage(`Stripped: ${props.join(", ")} on ${req.method} ${req.path}`);
+  },
+});
+```

package/src/docs/versioned/0.19.0/reference/generated/api/functions/createActionOpenApiMiddleware.md

@@ -0,0 +1,35 @@
+> **createActionOpenApiMiddleware**\<`T`\>(`__namedParameters`): `RequestHandler`
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### \_\_namedParameters
+
+#### action
+
+`BaseActionConfig`\<`unknown`, `unknown`, `unknown`\>
+
+#### actionName
+
+`string`
+
+#### model
+
+`Model`\<`T`\>
+
+#### options
+
+`Partial`\<[`ModelRouterOptions`](../interfaces/ModelRouterOptions.md)\<`T`\>\>
+
+#### scope
+
+`ActionScope`
+
+## Returns
+
+`RequestHandler`

package/src/docs/versioned/0.19.0/reference/generated/api/functions/createBetterAuth.md

@@ -0,0 +1,13 @@
+> **createBetterAuth**(`options`): `Auth`
+
+Creates a Better Auth instance with MongoDB adapter.
+
+## Parameters
+
+### options
+
+[`CreateBetterAuthOptions`](../interfaces/CreateBetterAuthOptions.md)
+
+## Returns
+
+`Auth`

package/src/docs/versioned/0.19.0/reference/generated/api/functions/createBetterAuthSessionMiddleware.md

@@ -0,0 +1,18 @@
+> **createBetterAuthSessionMiddleware**(`auth`, `userModel?`): (`req`, `_res`, `next`) => `Promise`\<`void`\>
+
+Creates Express middleware that extracts the Better Auth session
+and populates req.user with the application User model.
+
+## Parameters
+
+### auth
+
+`Auth`
+
+### userModel?
+
+[`UserModel`](../interfaces/UserModel.md)
+
+## Returns
+
+(`req`, `_res`, `next`) => `Promise`\<`void`\>

package/src/docs/versioned/0.19.0/reference/generated/api/functions/createModelValidators.md

@@ -0,0 +1,74 @@
+> **createModelValidators**\<`T`\>(`model`, `options?`): `object`
+
+Creates validation middleware for use with modelRouter.
+Returns an object with middleware for each operation type.
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### model
+
+`Model`\<`T`\>
+
+The Mongoose model
+
+### options?
+
+[`ModelRouterValidationOptions`](../interfaces/ModelRouterValidationOptions.md)
+
+Configuration options
+
+## Returns
+
+`object`
+
+Object with create and update validation middleware
+
+### create
+
+> **create**: (`req`, `res`, `next`) => `void`
+
+#### Parameters
+
+##### req
+
+`Request`
+
+##### res
+
+`Response`
+
+##### next
+
+`NextFunction`
+
+#### Returns
+
+`void`
+
+### update
+
+> **update**: (`req`, `res`, `next`) => `void`
+
+#### Parameters
+
+##### req
+
+`Request`
+
+##### res
+
+`Response`
+
+##### next
+
+`NextFunction`
+
+#### Returns
+
+`void`

package/src/docs/versioned/0.19.0/reference/generated/api/functions/createOpenApiBuilder.md

@@ -0,0 +1,39 @@
+> **createOpenApiBuilder**(`options`): [`OpenApiMiddlewareBuilder`](../classes/OpenApiMiddlewareBuilder.md)
+
+Creates a new OpenAPI middleware builder.
+
+This is the recommended entry point for creating custom OpenAPI middleware.
+It returns a fluent builder that allows you to chain configuration methods.
+
+## Parameters
+
+### options
+
+`Partial`\<[`ModelRouterOptions`](../interfaces/ModelRouterOptions.md)\<`unknown`\>\>
+
+Router options containing the OpenAPI configuration
+
+## Returns
+
+[`OpenApiMiddlewareBuilder`](../classes/OpenApiMiddlewareBuilder.md)
+
+A new OpenApiMiddlewareBuilder instance
+
+## Example
+
+```typescript
+import {createOpenApiBuilder} from "./openApiBuilder";
+
+const statsMiddleware = createOpenApiBuilder(options)
+  .withTags(["analytics"])
+  .withSummary("Get usage statistics")
+  .withQueryParameter("startDate", {type: "string", format: "date"})
+  .withQueryParameter("endDate", {type: "string", format: "date"})
+  .withResponse<{totalUsers: number; activeUsers: number}>(200, {
+    totalUsers: {type: "number", description: "Total registered users"},
+    activeUsers: {type: "number", description: "Users active in period"},
+  })
+  .build();
+
+router.get("/analytics/stats", statsMiddleware, getStatsHandler);
+```

package/src/docs/versioned/0.19.0/reference/generated/api/functions/createRouter.md

@@ -0,0 +1,19 @@
+> **createRouter**(`rootPath`, `addRoutes`, `middleware?`): (`string` \| `Router` \| `RequestHandler`\<`ParamsDictionary`, `any`, `any`, `ParsedQs`, `Record`\<`string`, `any`\>\>)[]
+
+## Parameters
+
+### rootPath
+
+`string`
+
+### addRoutes
+
+[`AddRoutes`](../type-aliases/AddRoutes.md)
+
+### middleware?
+
+`RequestHandler`\<`ParamsDictionary`, `any`, `any`, `ParsedQs`, `Record`\<`string`, `any`\>\>[] = `[]`
+
+## Returns
+
+(`string` \| `Router` \| `RequestHandler`\<`ParamsDictionary`, `any`, `any`, `ParsedQs`, `Record`\<`string`, `any`\>\>)[]

package/src/docs/versioned/0.19.0/reference/generated/api/functions/createRouterWithAuth.md

@@ -0,0 +1,19 @@
+> **createRouterWithAuth**(`rootPath`, `addRoutes`, `middleware?`): (`string` \| `Router` \| `RequestHandler`\<`ParamsDictionary`, `any`, `any`, `ParsedQs`, `Record`\<`string`, `any`\>\>)[]
+
+## Parameters
+
+### rootPath
+
+`string`
+
+### addRoutes
+
+(`router`) => `void`
+
+### middleware?
+
+`RequestHandler`\<`ParamsDictionary`, `any`, `any`, `ParsedQs`, `Record`\<`string`, `any`\>\>[] = `[]`
+
+## Returns
+
+(`string` \| `Router` \| `RequestHandler`\<`ParamsDictionary`, `any`, `any`, `ParsedQs`, `Record`\<`string`, `any`\>\>)[]

package/src/docs/versioned/0.19.0/reference/generated/api/functions/createValidator.md

@@ -0,0 +1,29 @@
+> **createValidator**(`options`): (`req`, `res`, `next`) => `void`
+
+Creates a combined validation middleware for both body and query parameters.
+
+## Parameters
+
+### options
+
+[`CreateValidatorOptions`](../interfaces/CreateValidatorOptions.md)
+
+Configuration for what to validate
+
+## Returns
+
+Express middleware function
+
+(`req`, `res`, `next`) => `void`
+
+## Example
+
+```typescript
+router.post("/search", [
+  openApiMiddleware,
+  createValidator({
+    body: {query: {type: "string", required: true}},
+    query: {limit: {type: "number"}},
+  }),
+], handler);
+```

package/src/docs/versioned/0.19.0/reference/generated/api/functions/createdUpdatedPlugin.md

@@ -0,0 +1,11 @@
+> **createdUpdatedPlugin**(`schema`): `void`
+
+## Parameters
+
+### schema
+
+`Schema`\<`any`, `any`, `any`, `any`\>
+
+## Returns
+
+`void`

package/src/docs/versioned/0.19.0/reference/generated/api/functions/cronjob.md

@@ -0,0 +1,19 @@
+> **cronjob**(`name`, `schedule`, `callback`): `void`
+
+## Parameters
+
+### name
+
+`string`
+
+### schedule
+
+`string`
+
+### callback
+
+() => `void`
+
+## Returns
+
+`void`

package/src/docs/versioned/0.19.0/reference/generated/api/functions/defaultResponseHandler.md

@@ -0,0 +1,32 @@
+> **defaultResponseHandler**\<`T`\>(`doc`, `method`, `request`, `options`): `Promise`\<`Partial`\<`T`\> \| (`Partial`\<`T`\> \| `undefined`)[] \| `null` \| `undefined`\>
+
+Default response handler for modelRouter. Calls toObject on each doc and returns the result,
+using transformers.serializer if provided.
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### doc
+
+`Document`\<`unknown`, `unknown`, `unknown`, `Record`\<`string`, `any`\>, \{ \}\> & `T` \| `Document`\<`unknown`, `unknown`, `unknown`, `Record`\<`string`, `any`\>, \{ \}\> & `T`[] \| `null`
+
+### method
+
+`"read"` \| `"create"` \| `"list"` \| `"update"`
+
+### request
+
+`Request`
+
+### options
+
+[`ModelRouterOptions`](../interfaces/ModelRouterOptions.md)\<`T`\>
+
+## Returns
+
+`Promise`\<`Partial`\<`T`\> \| (`Partial`\<`T`\> \| `undefined`)[] \| `null` \| `undefined`\>

package/src/docs/versioned/0.19.0/reference/generated/api/functions/defineCollectionAction.md

@@ -0,0 +1,25 @@
+> **defineCollectionAction**\<`TBody`, `TQuery`, `TResponse`\>(`config`): [`CollectionActionConfig`](../interfaces/CollectionActionConfig.md)\<`TBody`, `TQuery`, `TResponse`\>
+
+## Type Parameters
+
+### TBody
+
+`TBody` = `unknown`
+
+### TQuery
+
+`TQuery` = `unknown`
+
+### TResponse
+
+`TResponse` = `unknown`
+
+## Parameters
+
+### config
+
+[`CollectionActionConfig`](../interfaces/CollectionActionConfig.md)\<`TBody`, `TQuery`, `TResponse`\>
+
+## Returns
+
+[`CollectionActionConfig`](../interfaces/CollectionActionConfig.md)\<`TBody`, `TQuery`, `TResponse`\>

package/src/docs/versioned/0.19.0/reference/generated/api/functions/defineInstanceAction.md

@@ -0,0 +1,29 @@
+> **defineInstanceAction**\<`TDoc`, `TBody`, `TQuery`, `TResponse`\>(`config`): [`InstanceActionConfig`](../interfaces/InstanceActionConfig.md)\<`TDoc`, `TBody`, `TQuery`, `TResponse`\>
+
+## Type Parameters
+
+### TDoc
+
+`TDoc`
+
+### TBody
+
+`TBody` = `unknown`
+
+### TQuery
+
+`TQuery` = `unknown`
+
+### TResponse
+
+`TResponse` = `unknown`
+
+## Parameters
+
+### config
+
+[`InstanceActionConfig`](../interfaces/InstanceActionConfig.md)\<`TDoc`, `TBody`, `TQuery`, `TResponse`\>
+
+## Returns
+
+[`InstanceActionConfig`](../interfaces/InstanceActionConfig.md)\<`TDoc`, `TBody`, `TQuery`, `TResponse`\>

package/src/docs/versioned/0.19.0/reference/generated/api/functions/envConfigurationPlugin.md

@@ -0,0 +1,11 @@
+> **envConfigurationPlugin**(`schema`): `void`
+
+## Parameters
+
+### schema
+
+`Schema`\<`any`, `any`, `any`, `any`\>
+
+## Returns
+
+`void`

package/src/docs/versioned/0.19.0/reference/generated/api/functions/errorMessage.md

@@ -0,0 +1,13 @@
+> **errorMessage**(`error`): `string`
+
+Extract a human-readable message from an unknown error.
+
+## Parameters
+
+### error
+
+`unknown`
+
+## Returns
+
+`string`

package/src/docs/versioned/0.19.0/reference/generated/api/functions/errorStack.md

@@ -0,0 +1,13 @@
+> **errorStack**(`error`): `string`
+
+Extract a stack trace string from an unknown error.
+
+## Parameters
+
+### error
+
+`unknown`
+
+## Returns
+
+`string`

package/src/docs/versioned/0.19.0/reference/generated/api/functions/errorsPlugin.md

@@ -0,0 +1,11 @@
+> **errorsPlugin**(`schema`): `void`
+
+## Parameters
+
+### schema
+
+`Schema`
+
+## Returns
+
+`void`

package/src/docs/versioned/0.19.0/reference/generated/api/functions/findExactlyOne.md

@@ -0,0 +1,25 @@
+> **findExactlyOne**\<`T`\>(`schema`): `void`
+
+This adds a static method `Model.findExactlyOne` to the schema. This or findOneOrNone should replace `Model.findOne`
+in most instances.
+`Model.findOne` should only be used with a unique index, but that's not apparent from the docs. Otherwise you can wind
+up with a random document that matches the query. The returns the one matching document, or throws an exception if
+multiple or none are found.
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### schema
+
+`Schema`\<`T`\>
+
+Mongoose Schema
+
+## Returns
+
+`void`

package/src/docs/versioned/0.19.0/reference/generated/api/functions/findOneOrNone.md

@@ -0,0 +1,24 @@
+> **findOneOrNone**\<`T`\>(`schema`): `void`
+
+This adds a static method `Model.findOneOrNone` to the schema. This should replace `Model.findOne` in most instances.
+`Model.findOne` should only be used with a unique index, but that's not apparent from the docs. Otherwise you can wind
+up with a random document that matches the query. The returns either null if no document matches, the actual
+document, or throws an exception if multiple are found.
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### schema
+
+`Schema`\<`T`\>
+
+Mongoose Schema
+
+## Returns
+
+`void`

package/src/docs/versioned/0.19.0/reference/generated/api/functions/findOneOrNoneFor.md

@@ -0,0 +1,37 @@
+> **findOneOrNoneFor**\<`T`\>(`model`, `query`, `errorArgs?`): `Promise`\<`Document`\<`ObjectId`, `any`, `any`, `Record`\<`string`, `any`\>, \{ \}\> & `T` \| `null`\>
+
+Helper that performs a `findOneOrNone` lookup against any Mongoose model. Returns the matching
+document, `null` if none match, or throws if more than one matches. If the model's schema has
+the [findOneOrNone](findOneOrNone.md) plugin applied, the plugin static is used; otherwise the lookup is
+performed directly via `model.find(...)`. Prefer this helper from framework code where the
+consumer's model may or may not have the plugin installed.
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### model
+
+`Model`\<`T`\>
+
+Mongoose Model
+
+### query
+
+`FilterQuery`\<`T`\>
+
+Mongoose query object
+
+### errorArgs?
+
+`Partial`\<[`APIErrorConstructor`](../interfaces/APIErrorConstructor.md)\>
+
+Optional overrides for the thrown [APIError](../classes/APIError.md) when multiple match
+
+## Returns
+
+`Promise`\<`Document`\<`ObjectId`, `any`, `any`, `Record`\<`string`, `any`\>, \{ \}\> & `T` \| `null`\>

package/src/docs/versioned/0.19.0/reference/generated/api/functions/findRegistryEntryByCollection.md

@@ -0,0 +1,13 @@
+> **findRegistryEntryByCollection**(`collectionName`): [`RealtimeRegistryEntry`](../interfaces/RealtimeRegistryEntry.md) \| `undefined`
+
+Find a registry entry by MongoDB collection name.
+
+## Parameters
+
+### collectionName
+
+`string`
+
+## Returns
+
+[`RealtimeRegistryEntry`](../interfaces/RealtimeRegistryEntry.md) \| `undefined`

package/src/docs/versioned/0.19.0/reference/generated/api/functions/findRegistryEntryByRoutePath.md

@@ -0,0 +1,13 @@
+> **findRegistryEntryByRoutePath**(`collection`): [`RealtimeRegistryEntry`](../interfaces/RealtimeRegistryEntry.md) \| `undefined`
+
+Find a registry entry by route path / collection tag (e.g. "todos").
+
+## Parameters
+
+### collection
+
+`string`
+
+## Returns
+
+[`RealtimeRegistryEntry`](../interfaces/RealtimeRegistryEntry.md) \| `undefined`