@terreno/mcp 0.23.0 → 0.23.1

package/src/docs/versioned/0.23.0/reference/generated/api/classes/RealtimeApp.md

@@ -0,0 +1,112 @@
+TerrenoPlugin that provides real-time sync via Socket.io and MongoDB change streams.
+
+Attaches a Socket.io server to the HTTP server created by TerrenoApp.start(),
+sets up JWT authentication for socket connections, manages room subscriptions
+(model, document, and query rooms), and starts a change stream watcher that
+emits events to connected clients.
+
+## Subscription types
+
+- **Model rooms**: `subscribe:model` / `unsubscribe:model` — receive all events for a collection
+- **Document rooms**: `subscribe:document` / `unsubscribe:document` — receive events for a single document
+- **Query rooms**: `subscribe:query` / `unsubscribe:query` — receive events matching a MongoDB query
+
+## Example
+
+```typescript
+const app = new TerrenoApp({
+  userModel: User,
+  realtime: { debug: true },
+})
+  .register(todoRouter)   // todoRouter has realtime config
+  .start();
+```
+
+## Implements
+
+- [`TerrenoPlugin`](../interfaces/TerrenoPlugin.md)
+
+## Constructors
+
+### Constructor
+
+> **new RealtimeApp**(`config?`): `RealtimeApp`
+
+#### Parameters
+
+##### config?
+
+[`RealtimeAppOptions`](../interfaces/RealtimeAppOptions.md) = `{}`
+
+#### Returns
+
+`RealtimeApp`
+
+## Methods
+
+### close()
+
+> **close**(): `Promise`\<`void`\>
+
+Gracefully shut down the real-time server.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### getIo()
+
+> **getIo**(): `Server`\<`DefaultEventsMap`, `DefaultEventsMap`, `DefaultEventsMap`, `any`\> \| `null`
+
+Get the Socket.io server instance.
+
+#### Returns
+
+`Server`\<`DefaultEventsMap`, `DefaultEventsMap`, `DefaultEventsMap`, `any`\> \| `null`
+
+***
+
+### onServerCreated()
+
+> **onServerCreated**(`server`): `void`
+
+Called after the HTTP server is created. Sets up Socket.io, auth, rooms,
+and starts the change stream watcher.
+
+#### Parameters
+
+##### server
+
+`Server`
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`TerrenoPlugin`](../interfaces/TerrenoPlugin.md).[`onServerCreated`](../interfaces/TerrenoPlugin.md#onservercreated)
+
+***
+
+### register()
+
+> **register**(`app`): `void`
+
+Register routes and middleware. Adds a /realtime/health endpoint.
+
+#### Parameters
+
+##### app
+
+`Application`
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`TerrenoPlugin`](../interfaces/TerrenoPlugin.md).[`register`](../interfaces/TerrenoPlugin.md#register)

package/src/docs/versioned/0.23.0/reference/generated/api/classes/TaskCancelledError.md

@@ -0,0 +1,23 @@
+## Extends
+
+- `Error`
+
+## Constructors
+
+### Constructor
+
+> **new TaskCancelledError**(`taskId`): `TaskCancelledError`
+
+#### Parameters
+
+##### taskId
+
+`string`
+
+#### Returns
+
+`TaskCancelledError`
+
+#### Overrides
+
+`Error.constructor`

package/src/docs/versioned/0.23.0/reference/generated/api/classes/TerrenoApp.md

@@ -0,0 +1,262 @@
+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/src/docs/versioned/0.23.0/reference/generated/api/classes/VersionCheckPlugin.md

@@ -0,0 +1,43 @@
+TerrenoPlugin that adds a public GET /version-check endpoint for upgrade enforcement.
+Compares client build number against admin-configured thresholds per platform.
+
+## Implements
+
+- [`TerrenoPlugin`](../interfaces/TerrenoPlugin.md)
+
+## Constructors
+
+### Constructor
+
+> **new VersionCheckPlugin**(): `VersionCheckPlugin`
+
+#### Returns
+
+`VersionCheckPlugin`
+
+## Methods
+
+### register()
+
+> **register**(`app`): `void`
+
+Register routes and middleware with the Express application.
+
+Called during `TerrenoApp.build()` after core middleware has been
+configured but before error handling middleware is added.
+
+#### Parameters
+
+##### app
+
+`Application`
+
+The Express application instance to register with
+
+#### Returns
+
+`void`
+
+#### Implementation of
+
+[`TerrenoPlugin`](../interfaces/TerrenoPlugin.md).[`register`](../interfaces/TerrenoPlugin.md#register)

package/src/docs/versioned/0.23.0/reference/generated/api/functions/AdminOwnerTransformer.md

@@ -0,0 +1,47 @@
+> **AdminOwnerTransformer**\<`T`\>(`options`): [`TerrenoTransformer`](../interfaces/TerrenoTransformer.md)\<`T`\>
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### options
+
+#### adminReadFields?
+
+`string`[]
+
+#### adminWriteFields?
+
+`string`[]
+
+#### anonReadFields?
+
+`string`[]
+
+#### anonWriteFields?
+
+`string`[]
+
+#### authReadFields?
+
+`string`[]
+
+#### authWriteFields?
+
+`string`[]
+
+#### ownerReadFields?
+
+`string`[]
+
+#### ownerWriteFields?
+
+`string`[]
+
+## Returns
+
+[`TerrenoTransformer`](../interfaces/TerrenoTransformer.md)\<`T`\>

package/src/docs/versioned/0.23.0/reference/generated/api/functions/OwnerQueryFilter.md

@@ -0,0 +1,11 @@
+> **OwnerQueryFilter**(`user?`): \{ `ownerId`: `string`; \} \| `null`
+
+## Parameters
+
+### user?
+
+[`User`](../interfaces/User.md)
+
+## Returns
+
+\{ `ownerId`: `string`; \} \| `null`

package/src/docs/versioned/0.23.0/reference/generated/api/functions/addAuthRoutes.md

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

package/src/docs/versioned/0.23.0/reference/generated/api/functions/addGitHubAuthRoutes.md

@@ -0,0 +1,31 @@
+> **addGitHubAuthRoutes**(`app`, `userModel`, `githubOptions`, `authOptions?`): `void`
+
+Adds GitHub OAuth routes to the Express application.
+
+Routes added:
+- GET /auth/github - Initiates GitHub OAuth flow
+- GET /auth/github/callback - Handles GitHub OAuth callback
+- POST /auth/github/link - Links GitHub account to authenticated user (requires JWT auth)
+- DELETE /auth/github/unlink - Unlinks GitHub account from authenticated user (requires JWT auth)
+
+## Parameters
+
+### app
+
+`Application`
+
+### userModel
+
+[`UserModel`](../interfaces/UserModel.md)
+
+### githubOptions
+
+[`GitHubAuthOptions`](../interfaces/GitHubAuthOptions.md)
+
+### authOptions?
+
+[`AuthOptions`](../interfaces/AuthOptions.md)
+
+## Returns
+
+`void`

package/src/docs/versioned/0.23.0/reference/generated/api/functions/addMeRoutes.md

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

package/src/docs/versioned/0.23.0/reference/generated/api/functions/addPopulateToQuery.md

@@ -0,0 +1,15 @@
+> **addPopulateToQuery**(`builtQuery`, `populatePaths?`): `Query`\<`any`[], `any`, `Record`\<`string`, `never`\>, `any`, `"find"`, `Record`\<`string`, `never`\>\>
+
+## Parameters
+
+### builtQuery
+
+`Query`\<`any`[], `any`, `Record`\<`string`, `never`\>, `any`\>
+
+### populatePaths?
+
+[`PopulatePath`](../interfaces/PopulatePath.md)[]
+
+## Returns
+
+`Query`\<`any`[], `any`, `Record`\<`string`, `never`\>, `any`, `"find"`, `Record`\<`string`, `never`\>\>

package/src/docs/versioned/0.23.0/reference/generated/api/functions/addQuerySubscription.md

@@ -0,0 +1,26 @@
+> **addQuerySubscription**(`socketId`, `collection`, `query`, `queryId`): `void`
+
+Register a query subscription for a socket.
+The socket joins the `query:{queryId}` room (handled by the caller).
+
+## Parameters
+
+### socketId
+
+`string`
+
+### collection
+
+`string`
+
+### query
+
+`Record`\<`string`, `any`\>
+
+### queryId
+
+`string`
+
+## Returns
+
+`void`

package/src/docs/versioned/0.23.0/reference/generated/api/functions/apiErrorMiddleware.md

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

package/src/docs/versioned/0.23.0/reference/generated/api/functions/apiFallthroughErrorMiddleware.md

@@ -0,0 +1,26 @@
+> **apiFallthroughErrorMiddleware**(`err`, `_req`, `res`, `_next`): `void`
+
+Final Express error handler for unexpected errors. Always returns JSON so
+clients (e.g. RTK Query) can parse the response.
+
+## Parameters
+
+### err
+
+`Error`
+
+### \_req
+
+`Request`
+
+### res
+
+`Response`
+
+### \_next
+
+`NextFunction`
+
+## Returns
+
+`void`

package/src/docs/versioned/0.23.0/reference/generated/api/functions/apiUnauthorizedMiddleware.md

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

package/src/docs/versioned/0.23.0/reference/generated/api/functions/applyRequestContextToSentry.md

@@ -0,0 +1,11 @@
+> **applyRequestContextToSentry**(`context?`): `void`
+
+## Parameters
+
+### context?
+
+`Partial`\<[`RequestContext`](../interfaces/RequestContext.md)\> = `...`
+
+## Returns
+
+`void`