@terreno/mcp 0.24.0 → 0.26.0

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

@@ -1,260 +0,0 @@
-Fluent API for building Express applications with Terreno framework.
-
-TerrenoApp provides an alternative to `setupServer` using a registration
-pattern instead of callbacks. Build applications by registering model
-routers and plugins, then calling `start()` to begin listening.
-
-The middleware stack is configured in this order:
-1. CORS
-2. Custom middleware (via addMiddleware)
-3. JSON body parser
-4. Auth routes (/auth/login, /auth/signup, etc.)
-5. JWT authentication setup
-6. Request logging
-7. Sentry scopes
-8. OpenAPI middleware
-9. /auth/me routes
-10. GitHub OAuth routes (if enabled)
-11. Registered model routers and plugins
-12. 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
-
- - setupServer for the callback-based alternative
- - 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.20.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"` \| `"create"` \| `"list"` \| `"update"`
-
-### request
-
-`Request`
-
-### options
-
-[`ModelRouterOptions`](../interfaces/ModelRouterOptions.md)\<`T`\>
-
-## Returns
-
-`Promise`\<`Partial`\<`T`\> \| (`Partial`\<`T`\> \| `undefined`)[] \| `null` \| `undefined`\>

package/dist/docs/versioned/0.20.0/reference/generated/api/functions/getCurrentLogContext.md

@@ -1,5 +0,0 @@
-> **getCurrentLogContext**(): `Partial`\<[`RequestContext`](../interfaces/RequestContext.md)\>
-
-## Returns
-
-`Partial`\<[`RequestContext`](../interfaces/RequestContext.md)\>

package/dist/docs/versioned/0.20.0/reference/generated/api/functions/getCurrentRequestContext.md

@@ -1,5 +0,0 @@
-> **getCurrentRequestContext**(): [`RequestContext`](../interfaces/RequestContext.md) \| `undefined`
-
-## Returns
-
-[`RequestContext`](../interfaces/RequestContext.md) \| `undefined`

package/dist/docs/versioned/0.20.0/reference/generated/api/functions/getCurrentRequestContextAttributes.md

@@ -1,11 +0,0 @@
-> **getCurrentRequestContextAttributes**(`overrides?`): [`RequestContextAttributes`](../type-aliases/RequestContextAttributes.md)
-
-## Parameters
-
-### overrides?
-
-`Partial`\<[`RequestContext`](../interfaces/RequestContext.md)\> = `{}`
-
-## Returns
-
-[`RequestContextAttributes`](../type-aliases/RequestContextAttributes.md)

package/dist/docs/versioned/0.20.0/reference/generated/api/functions/logRequests.md

@@ -1,19 +0,0 @@
-> **logRequests**(`req`, `res`, `next`): `void`
-
-## Parameters
-
-### req
-
-`any`
-
-### res
-
-`any`
-
-### next
-
-`NextFunction`
-
-## Returns
-
-`void`

package/dist/docs/versioned/0.20.0/reference/generated/api/functions/matchesQuery.md

@@ -1,23 +0,0 @@
-> **matchesQuery**(`doc`, `query`): `boolean`
-
-Check if a document matches a MongoDB-style query in memory.
-
-## Parameters
-
-### doc
-
-`any`
-
-The document to test (plain object or Mongoose document)
-
-### query
-
-`Record`\<`string`, `any`\>
-
-MongoDB-style query object
-
-## Returns
-
-`boolean`
-
-true if the document matches all query conditions

package/dist/docs/versioned/0.20.0/reference/generated/api/functions/requestContextMiddleware.md

@@ -1,19 +0,0 @@
-> **requestContextMiddleware**(`req`, `res`, `next`): `void`
-
-## Parameters
-
-### req
-
-`Request`
-
-### res
-
-`Response`
-
-### next
-
-`NextFunction`
-
-## Returns
-
-`void`

package/dist/docs/versioned/0.20.0/reference/generated/api/functions/runWithRequestContext.md

@@ -1,21 +0,0 @@
-> **runWithRequestContext**\<`T`\>(`context`, `callback`): `T`
-
-## Type Parameters
-
-### T
-
-`T`
-
-## Parameters
-
-### context
-
-`Partial`\<[`RequestContext`](../interfaces/RequestContext.md)\>
-
-### callback
-
-() => `T`
-
-## Returns
-
-`T`

package/dist/docs/versioned/0.20.0/reference/generated/api/functions/runWithRequestContextAttributes.md

@@ -1,21 +0,0 @@
-> **runWithRequestContextAttributes**\<`T`\>(`attributes?`, `callback`): `T`
-
-## Type Parameters
-
-### T
-
-`T`
-
-## Parameters
-
-### attributes?
-
-`Record`\<`string`, `string` \| `undefined`\> = `{}`
-
-### callback
-
-() => `T`
-
-## Returns
-
-`T`

package/dist/docs/versioned/0.20.0/reference/generated/api/functions/setupServer.md

@@ -1,11 +0,0 @@
-> **setupServer**(`options`): `Application`
-
-## Parameters
-
-### options
-
-[`SetupServerOptions`](../interfaces/SetupServerOptions.md)
-
-## Returns
-
-`Application`

package/dist/docs/versioned/0.20.0/reference/generated/api/interfaces/GitHubAuthOptions.md

@@ -1,74 +0,0 @@
-Options for configuring GitHub OAuth authentication
-
-## Properties
-
-### allowAccountLinking?
-
-> `optional` **allowAccountLinking?**: `boolean`
-
-Whether to allow linking GitHub to existing accounts.
-If true, authenticated users can link their GitHub account.
-Defaults to true.
-
-***
-
-### callbackURL
-
-> **callbackURL**: `string`
-
-Callback URL for GitHub OAuth (e.g., https://yourapp.com/auth/github/callback)
-
-***
-
-### clientId
-
-> **clientId**: `string`
-
-GitHub OAuth Client ID
-
-***
-
-### clientSecret
-
-> **clientSecret**: `string`
-
-GitHub OAuth Client Secret
-
-***
-
-### findOrCreateUser?
-
-> `optional` **findOrCreateUser?**: (`profile`, `accessToken`, `refreshToken`, `existingUser?`) => `Promise`\<`any`\>
-
-Custom function to handle user creation or lookup from GitHub profile.
-If not provided, a default implementation will be used.
-
-#### Parameters
-
-##### profile
-
-`Profile`
-
-##### accessToken
-
-`string`
-
-##### refreshToken
-
-`string`
-
-##### existingUser?
-
-`any`
-
-#### Returns
-
-`Promise`\<`any`\>
-
-***
-
-### scope?
-
-> `optional` **scope?**: `string`[]
-
-OAuth scopes to request from GitHub. Defaults to ["user:email"]

package/dist/docs/versioned/0.20.0/reference/generated/api/interfaces/LoggingOptions.md

@@ -1,65 +0,0 @@
-## Properties
-
-### disableConsoleColors?
-
-> `optional` **disableConsoleColors?**: `boolean`
-
-***
-
-### disableConsoleLogging?
-
-> `optional` **disableConsoleLogging?**: `boolean`
-
-***
-
-### disableFileLogging?
-
-> `optional` **disableFileLogging?**: `boolean`
-
-***
-
-### level?
-
-> `optional` **level?**: `"error"` \| `"debug"` \| `"info"` \| `"warn"`
-
-***
-
-### logDirectory?
-
-> `optional` **logDirectory?**: `string`
-
-***
-
-### logRequests?
-
-> `optional` **logRequests?**: `boolean`
-
-***
-
-### logSlowRequests?
-
-> `optional` **logSlowRequests?**: `boolean`
-
-***
-
-### logSlowRequestsReadMs?
-
-> `optional` **logSlowRequestsReadMs?**: `number`
-
-***
-
-### logSlowRequestsWriteMs?
-
-> `optional` **logSlowRequestsWriteMs?**: `number`
-
-***
-
-### showConsoleTimestamps?
-
-> `optional` **showConsoleTimestamps?**: `boolean`
-
-***
-
-### transports?
-
-> `optional` **transports?**: `TransportStream`[]