@terreno/mcp 57.0.0 → 57.2.0

package/dist/docs/versioned/0.27.0/reference/generated/api/classes/TerrenoApp.md

@@ -1,262 +0,0 @@
-Fluent API for building Express applications with Terreno framework.
-
-TerrenoApp is the supported way to assemble the Terreno Express stack.
-Build applications by registering model routers and plugins (and/or
-`configureApp`), then calling `start()` to listen.
-
-The middleware stack is configured in this order:
-1. CORS
-2. Optional `beforeJsonSetup` (configure the app before JSON parsing)
-3. Custom middleware (via addMiddleware)
-4. JSON body parser
-5. Auth routes (/auth/login, /auth/signup, etc.)
-6. JWT authentication setup
-7. Request logging
-8. Sentry scopes
-9. OpenAPI middleware (including JSON `requestId` on object responses)
-10. GitHub OAuth routes (if enabled)
-11. Configuration app (if any)
-12. Registered model routers and plugins
-13. Optional `configureApp` callback
-14. /auth/me routes
-15. Error handling middleware
-
-## Examples
-
-```typescript
-// Basic usage with model routers
-const todoRouter = modelRouter("/todos", Todo, {
-  permissions: { list: [Permissions.IsAuthenticated], ... },
-});
-
-const app = new TerrenoApp({ userModel: User })
-  .register(todoRouter)
-  .register(new HealthApp())
-  .start();
-```
-
-```typescript
-// With custom middleware
-const app = new TerrenoApp({
-  userModel: User,
-  corsOrigin: ["https://app.example.com"],
-  loggingOptions: { logRequests: true },
-  githubAuth: {
-    clientId: process.env.GITHUB_CLIENT_ID!,
-    clientSecret: process.env.GITHUB_CLIENT_SECRET!,
-    callbackURL: process.env.GITHUB_CALLBACK_URL!,
-  },
-})
-  .addMiddleware((req, res, next) => {
-    res.setHeader("X-Custom-Header", "value");
-    next();
-  })
-  .register(todoRouter)
-  .register(userRouter)
-  .start();
-```
-
-## See
-
- - TerrenoPlugin for creating reusable plugins
- - modelRouter for creating CRUD route registrations
-
-## Constructors
-
-### Constructor
-
-> **new TerrenoApp**(`options`): `TerrenoApp`
-
-Create a new TerrenoApp builder.
-
-#### Parameters
-
-##### options
-
-[`TerrenoAppOptions`](../interfaces/TerrenoAppOptions.md)
-
-Application configuration options including user model and auth settings
-
-#### Returns
-
-`TerrenoApp`
-
-## Methods
-
-### addMiddleware()
-
-> **addMiddleware**(`fn`): `this`
-
-Add custom Express middleware to the application.
-
-Middleware is added BEFORE JSON body parsing and authentication setup,
-allowing you to modify incoming requests early in the middleware stack.
-
-#### Parameters
-
-##### fn
-
-`RequestHandler`\<`ParamsDictionary`, `any`, `any`, `ParsedQs`, `Record`\<`string`, `any`\>\> \| ((`app`) => `void`)
-
-Express middleware function or a function that configures the app
-
-#### Returns
-
-`this`
-
-This TerrenoApp instance for method chaining
-
-#### Example
-
-```typescript
-app.addMiddleware((req, res, next) => {
-  res.setHeader("X-Request-ID", req.id);
-  next();
-});
-```
-
-***
-
-### build()
-
-> **build**(): `Application`
-
-Build the Express application without starting the server.
-
-Configures the complete middleware stack including:
-- CORS, JSON parsing, authentication, logging, Sentry, OpenAPI
-- All registered model routers and plugins
-- Error handling middleware
-
-Use this method when you need the Express app instance for testing
-or custom server setup. For normal use, call `start()` instead.
-
-#### Returns
-
-`Application`
-
-Configured Express application instance
-
-#### Example
-
-```typescript
-const app = new TerrenoApp({ userModel: User })
-  .register(todoRouter)
-  .build();
-
-// Use app for testing with supertest
-await request(app).get("/todos").expect(200);
-```
-
-***
-
-### configure()
-
-> **configure**(`model`, `options?`): `this`
-
-Register a configuration model with the application.
-
-Adds configuration management endpoints that expose the model's schema
-as metadata, and provide GET/PATCH endpoints for reading and updating
-the singleton configuration document. Nested subschemas become separate
-sections in the admin UI.
-
-All configuration endpoints require admin authentication.
-
-#### Parameters
-
-##### model
-
-`Model`\<`any`, \{ \}, \{ \}, \{ \}, `any`, `any`\>
-
-Mongoose model with configurationPlugin applied
-
-##### options?
-
-`Omit`\<[`ConfigurationAppOptions`](../interfaces/ConfigurationAppOptions.md), `"model"`\>
-
-Optional configuration (basePath, fieldOverrides)
-
-#### Returns
-
-`this`
-
-This TerrenoApp instance for method chaining
-
-#### Example
-
-```typescript
-const app = new TerrenoApp({ userModel: User })
-  .configure(AppConfig)
-  .register(todoRouter)
-  .start();
-```
-
-***
-
-### register()
-
-> **register**(`registration`): `this`
-
-Register a model router or plugin with the application.
-
-Model routers are created with `modelRouter("/path", Model, options)` and
-provide CRUD endpoints. Plugins implement `TerrenoPlugin` interface and
-can register custom routes and middleware.
-
-Registrations are mounted in the order they are added.
-
-#### Parameters
-
-##### registration
-
-[`ModelRouterRegistration`](../interfaces/ModelRouterRegistration.md) \| [`TerrenoPlugin`](../interfaces/TerrenoPlugin.md)
-
-A ModelRouterRegistration from modelRouter() or a TerrenoPlugin instance
-
-#### Returns
-
-`this`
-
-This TerrenoApp instance for method chaining
-
-#### Example
-
-```typescript
-const todoRouter = modelRouter("/todos", Todo, options);
-const healthPlugin = new HealthApp({ path: "/health" });
-
-app.register(todoRouter).register(healthPlugin);
-```
-
-***
-
-### start()
-
-> **start**(): `Application`
-
-Build the Express application and start listening on the configured port.
-
-Calls `build()` to configure the application, then starts an HTTP server
-listening on the port specified by the `PORT` environment variable (default: 9000).
-If `skipListen` option is true, the app is built but the server is not started.
-
-#### Returns
-
-`Application`
-
-Configured Express application instance
-
-#### Throws
-
-Process exits with code 1 if the server fails to start
-
-#### Example
-
-```typescript
-// Start server on port 3000
-process.env.PORT = "3000";
-const app = new TerrenoApp({ userModel: User })
-  .register(todoRouter)
-  .start();
-```

package/dist/docs/versioned/0.27.0/reference/generated/api/functions/addMeRoutes.md

@@ -1,19 +0,0 @@
-> **addMeRoutes**(`app`, `userModel`, `_authOptions?`): `void`
-
-## Parameters
-
-### app
-
-`Application`
-
-### userModel
-
-[`UserModel`](../interfaces/UserModel.md)
-
-### \_authOptions?
-
-[`AuthOptions`](../interfaces/AuthOptions.md)
-
-## Returns
-
-`void`

package/dist/docs/versioned/0.27.0/reference/generated/api/functions/apiUnauthorizedMiddleware.md

@@ -1,23 +0,0 @@
-> **apiUnauthorizedMiddleware**(`err`, `_req`, `res`, `next`): `void`
-
-## Parameters
-
-### err
-
-`Error`
-
-### \_req
-
-`Request`
-
-### res
-
-`Response`
-
-### next
-
-`NextFunction`
-
-## Returns
-
-`void`

package/dist/docs/versioned/0.27.0/reference/generated/api/functions/defaultResponseHandler.md

@@ -1,32 +0,0 @@
-> **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"` \| `"list"` \| `"create"` \| `"update"`
-
-### request
-
-`Request`
-
-### options
-
-[`ModelRouterOptions`](../interfaces/ModelRouterOptions.md)\<`T`\>
-
-## Returns
-
-`Promise`\<`Partial`\<`T`\> \| (`Partial`\<`T`\> \| `undefined`)[] \| `null` \| `undefined`\>

package/dist/docs/versioned/0.27.0/reference/generated/api/functions/envConfigurationPlugin.md

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

package/dist/docs/versioned/0.27.0/reference/generated/api/functions/findOneOrNoneFor.md

@@ -1,37 +0,0 @@
-> **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/dist/docs/versioned/0.27.0/reference/generated/api/functions/fixMixedFields.md

@@ -1,21 +0,0 @@
-> **fixMixedFields**(`schema`, `properties`): `void`
-
-## Parameters
-
-### schema
-
-`Schema`\<`any`, `Model`\<`any`, `any`, `any`, `any`, `any`, `any`\>, \{ \}, \{ \}, \{ \}, \{ \}, `DefaultSchemaOptions`, \{\[`key`: `number`\]: `unknown`;
-\[`key`: `symbol`\]: `unknown`;
-\[`key`: `string`\]: `unknown`; \}, `Document`\<`unknown`, \{ \}, `FlatRecord`\<\{\[`key`: `number`\]: `unknown`;
-\[`key`: `symbol`\]: `unknown`;
-\[`key`: `string`\]: `unknown`; \}\>, \{ \}, `DefaultSchemaOptions`\> & `FlatRecord`\<\{\[`key`: `number`\]: `unknown`;
-\[`key`: `symbol`\]: `unknown`;
-\[`key`: `string`\]: `unknown`; \}\> & `Required`\<\{ \}\> & `object`\> \| `null`
-
-### properties
-
-`Record`\<`string`, `unknown`\> \| `Record`\<`string`, `OpenApiSchemaNode`\> \| `null`
-
-## Returns
-
-`void`

package/dist/docs/versioned/0.27.0/reference/generated/api/functions/getAPIErrorBody.md

@@ -1,11 +0,0 @@
-> **getAPIErrorBody**(`error`): `Record`\<`string`, `unknown`\>
-
-## Parameters
-
-### error
-
-[`APIError`](../classes/APIError.md)
-
-## Returns
-
-`Record`\<`string`, `unknown`\>

package/dist/docs/versioned/0.27.0/reference/generated/api/functions/modelRouter.md

@@ -1,83 +0,0 @@
-## 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.27.0/reference/generated/api/functions/runActionPermissions.md

@@ -1,33 +0,0 @@
-> **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.27.0/reference/generated/api/functions/startChangeStreamWatcher.md

@@ -1,21 +0,0 @@
-> **startChangeStreamWatcher**(`io`, `config?`, `debug?`): `void`
-
-Start watching MongoDB change streams and emitting real-time events.
-
-## Parameters
-
-### io
-
-`Server`
-
-### config?
-
-[`ChangeStreamConfig`](../interfaces/ChangeStreamConfig.md) = `{}`
-
-### debug?
-
-`boolean` = `false`
-
-## Returns
-
-`void`

package/dist/docs/versioned/0.27.0/reference/generated/api/functions/stopChangeStreamWatcher.md

@@ -1,7 +0,0 @@
-> **stopChangeStreamWatcher**(): `Promise`\<`void`\>
-
-Stop the change stream watcher.
-
-## Returns
-
-`Promise`\<`void`\>

package/dist/docs/versioned/0.27.0/reference/generated/api/functions/syncBetterAuthUser.md

@@ -1,19 +0,0 @@
-> **syncBetterAuthUser**(`userModel`, `betterAuthUser`, `oauthProvider?`): `Promise`\<`any`\>
-
-## Parameters
-
-### userModel
-
-[`UserModel`](../interfaces/UserModel.md)
-
-### betterAuthUser
-
-[`BetterAuthUser`](../interfaces/BetterAuthUser.md)
-
-### oauthProvider?
-
-`string`
-
-## Returns
-
-`Promise`\<`any`\>

package/dist/docs/versioned/0.27.0/reference/generated/api/functions/withApiErrorHandling.md

@@ -1,31 +0,0 @@
-> **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`\>