@terreno/mcp 0.24.0 → 0.26.0

package/dist/docs/versioned/0.25.0/reference/environment-variables.md

@@ -0,0 +1,386 @@
+# Environment Variables Reference
+
+Comprehensive guide to environment variables used across Terreno packages and example applications.
+
+## Table of Contents
+
+- [@terreno/api (Backend)](#terrenoapi-backend)
+- [@terreno/rtk (Frontend State)](#terrenortk-frontend-state)
+- [@terreno/ui (Components)](#terrenoui-components)
+- [Example Backend](#example-backend)
+- [Example Frontend](#example-frontend)
+
+---
+
+## @terreno/api (Backend)
+
+Environment variables used by the `@terreno/api` package.
+
+### Authentication
+
+| Variable | Required | Default | Description |
+|----------|----------|---------|-------------|
+| `AUTH_PROVIDER` | ❌ | `jwt` | Authentication provider: `"jwt"` or `"better-auth"` |
+| `TOKEN_SECRET` | ✅ (if JWT) | - | Secret key for signing JWT access tokens |
+| `TOKEN_ISSUER` | ✅ (if JWT) | - | JWT issuer claim (e.g., `your-app.com`) |
+| `REFRESH_TOKEN_SECRET` | ✅ (if JWT) | - | Secret key for signing refresh tokens |
+| `SESSION_SECRET` | ✅ (if JWT) | - | Express session secret |
+| `TOKEN_EXPIRES_IN` | ❌ | `15m` | Access token expiration (e.g., `1h`, `30m`) |
+| `REFRESH_TOKEN_EXPIRES_IN` | ❌ | `30d` | Refresh token expiration (e.g., `7d`, `90d`) |
+| `SIGNUP_DISABLED` | ❌ | `false` | Disable user registration (invite-only mode) |
+
+### Better Auth (Optional)
+
+| Variable | Required | Default | Description |
+|----------|----------|---------|-------------|
+| `BETTER_AUTH_SECRET` | ✅ (if Better Auth) | - | Secret key for Better Auth session encryption |
+| `BETTER_AUTH_URL` | ✅ (if Better Auth) | - | Base URL for Better Auth server (e.g., `https://api.example.com`) |
+| `GOOGLE_CLIENT_ID` | ❌ | - | Google OAuth client ID |
+| `GOOGLE_CLIENT_SECRET` | ❌ | - | Google OAuth client secret |
+| `APPLE_CLIENT_ID` | ❌ | - | Apple Sign In service ID |
+| `APPLE_CLIENT_SECRET` | ❌ | - | Apple Sign In private key |
+
+### GitHub OAuth (Optional)
+
+| Variable | Required | Default | Description |
+|----------|----------|---------|-------------|
+| `GITHUB_CLIENT_ID` | ❌ | - | GitHub OAuth application client ID |
+| `GITHUB_CLIENT_SECRET` | ❌ | - | GitHub OAuth application client secret |
+| `GITHUB_CALLBACK_URL` | ❌ | - | OAuth callback URL (e.g., `https://api.example.com/auth/github/callback`) |
+
+### Server Configuration
+
+| Variable | Required | Default | Description |
+|----------|----------|---------|-------------|
+| `PORT` | ❌ | `3000` | HTTP server port |
+| `NODE_ENV` | ❌ | `development` | Node environment (`development`, `production`, `test`) |
+| `MONGO_URI` | ❌ | `mongodb://localhost:27017` | MongoDB connection string |
+| `ENABLE_SWAGGER` | ❌ | `false` | Enable Swagger UI at `/swagger` endpoint |
+
+### Logging & Monitoring
+
+| Variable | Required | Default | Description |
+|----------|----------|---------|-------------|
+| `SENTRY_DSN` | ❌ | - | Sentry DSN for error tracking |
+| `USE_SENTRY_LOGGING` | ❌ | `false` | Send logs to Sentry |
+| `LOG_REQUESTS` | ❌ | `false` | Log all HTTP requests |
+| `LOG_SLOW_REQUESTS` | ❌ | `false` | Log requests exceeding threshold |
+| `SLOW_REQUEST_THRESHOLD_MS` | ❌ | `5000` | Milliseconds to consider a request "slow" |
+| `SLOW_DB_QUERY_THRESHOLD_MS` | ❌ | `100` | Milliseconds to consider a DB query "slow" |
+
+### Webhooks & Notifications (Optional)
+
+| Variable | Required | Default | Description |
+|----------|----------|---------|-------------|
+| `SLACK_WEBHOOKS` | ❌ | - | JSON object mapping names to Slack webhook URLs<br/>Example: `{"default": "https://hooks.slack.com/..."}` |
+| `GOOGLE_CHAT_WEBHOOKS` | ❌ | - | JSON object mapping names to Google Chat webhook URLs<br/>Example: `{"default": "https://chat.googleapis.com/..."}` |
+| `ZOOM_WEBHOOK` | ❌ | - | Zoom webhook URL for notifications |
+
+### Google Cloud Platform (Optional)
+
+| Variable | Required | Default | Description |
+|----------|----------|---------|-------------|
+| `GCP_PROJECT` | ❌ | - | Google Cloud project ID |
+| `GCP_LOCATION` | ❌ | - | GCP region (e.g., `us-central1`) |
+| `GCP_SERVICE_ACCOUNT_EMAIL` | ❌ | - | Service account email for authentication |
+| `GCP_TASKS_NOTIFICATIONS_QUEUE` | ❌ | - | Cloud Tasks queue name for notifications |
+| `GCP_TASK_PROCESSOR_QUEUE` | ❌ | - | Cloud Tasks queue name for background tasks |
+
+### Caching & Performance
+
+| Variable | Required | Default | Description |
+|----------|----------|---------|-------------|
+| `VALKEY_URL` | ❌ | - | Redis/Valkey connection URL (e.g., `redis://localhost:6379`) |
+
+### Other APIs
+
+| Variable | Required | Default | Description |
+|----------|----------|---------|-------------|
+| `GEMINI_API_KEY` | ❌ | - | Google Gemini API key for AI features |
+
+### Example .env File
+
+``````bash
+# Authentication Provider
+AUTH_PROVIDER=jwt  # or "better-auth"
+
+# Required for JWT authentication
+TOKEN_SECRET=your-secret-key-change-this-in-production
+TOKEN_ISSUER=your-app.com
+REFRESH_TOKEN_SECRET=your-refresh-secret-change-this-too
+SESSION_SECRET=your-session-secret-change-this-also
+
+# Required for Better Auth (if AUTH_PROVIDER=better-auth)
+# BETTER_AUTH_SECRET=your-better-auth-secret-min-32-chars
+# BETTER_AUTH_URL=http://localhost:4000
+
+# Optional - Social OAuth (Better Auth)
+# GOOGLE_CLIENT_ID=your-google-client-id
+# GOOGLE_CLIENT_SECRET=your-google-client-secret
+# GITHUB_CLIENT_ID=your-github-client-id
+# GITHUB_CLIENT_SECRET=your-github-client-secret
+
+# Database
+MONGO_URI=mongodb://localhost:27017/your-app
+
+# Optional - Common in development
+PORT=3000
+NODE_ENV=development
+ENABLE_SWAGGER=true
+LOG_REQUESTS=true
+
+# Optional - Production monitoring
+SENTRY_DSN=https://your-sentry-dsn@sentry.io/project-id
+USE_SENTRY_LOGGING=true
+``````
+
+---
+
+## @terreno/rtk (Frontend State)
+
+Environment variables used by the `@terreno/rtk` package and frontend applications.
+
+### Base URL Configuration
+
+The base URL is resolved in priority order:
+
+1. `Constants.expoConfig?.extra?.BASE_URL` (production/staging builds)
+2. `process.env.EXPO_PUBLIC_API_URL` (development web)
+3. `Constants.expoConfig?.hostUri` + the dev API port (dev simulator/device)
+4. `http://localhost:<dev API port>` (fallback)
+
+The dev API port defaults to `4000` and is overridable per app via `EXPO_PUBLIC_DEV_API_PORT`
+or `expoConfig.extra.DEV_API_PORT` (for example `3000` or `9000`).
+
+| Variable | Required | Default | Description |
+|----------|----------|---------|-------------|
+| `EXPO_PUBLIC_API_URL` | ❌ | Auto-detected | Backend API base URL<br/>Web: `http://localhost:4000`<br/>Simulator: Auto-detected via `hostUri`<br/>Device: Use your computer's local IP |
+| `EXPO_PUBLIC_DEV_API_PORT` | ❌ | 4000 | Local dev API port for host/localhost resolution (also settable via `extra.DEV_API_PORT`) |
+
+### Debug Flags
+
+| Variable | Required | Default | Description |
+|----------|----------|---------|-------------|
+| `AUTH_DEBUG` | ❌ | `false` | Enable authentication debug logging |
+| `WEBSOCKETS_DEBUG` | ❌ | `false` | Enable WebSocket debug logging |
+
+### Example app.json Configuration
+
+``````json
+{
+  "expo": {
+    "extra": {
+      "BASE_URL": "https://api.example.com",
+      "AUTH_DEBUG": "false",
+      "WEBSOCKETS_DEBUG": "false"
+    }
+  }
+}
+``````
+
+### Example .env for Web Development
+
+``````bash
+# Backend API URL
+EXPO_PUBLIC_API_URL=http://localhost:4000
+``````
+
+---
+
+## @terreno/ui (Components)
+
+The `@terreno/ui` package **does not require environment variables**. All configuration is done at runtime via the `TerrenoProvider` component.
+
+### Runtime Configuration
+
+``````typescript
+import {TerrenoProvider} from "@terreno/ui";
+
+<TerrenoProvider
+  initialTheme={{
+    primitives: {
+      primary500: "#0066CC",
+      accent500: "#FF6B35",
+    }
+  }}
+>
+  <App />
+</TerrenoProvider>
+``````
+
+---
+
+## Example Backend
+
+Environment variables specific to the example backend application (not part of @terreno/api).
+
+### Application Configuration
+
+| Variable | Required | Default | Description |
+|----------|----------|---------|-------------|
+| `APP_ENV` | ❌ | `development` | Application environment (`development`, `staging`, `production`) |
+| `BACKEND_SERVICE` | ❌ | `all` | Service type to run: `api`, `websockets`, `tasks`, or `all` |
+| `API_URL` | ❌ | - | API service URL (for microservice architecture) |
+| `TASKS_URL` | ❌ | - | Tasks service URL (for microservice architecture) |
+| `FLOURISH_SERVICE` | ❌ | `flourish-backend` | Service name for OpenTelemetry tracing |
+
+### WebSockets
+
+| Variable | Required | Default | Description |
+|----------|----------|---------|-------------|
+| `WEBSOCKET_PORT` | ❌ | Same as `PORT` | WebSocket server port (if separate from HTTP) |
+| `FRONTEND_URL` | ❌ | Auto-detected | Frontend URL for CORS (e.g., `http://localhost:8082`) |
+
+### Pull Request Environments
+
+| Variable | Required | Default | Description |
+|----------|----------|---------|-------------|
+| `PR_NUMBER` | ❌ | - | Pull request number (set by CI/CD) |
+| `PR_SERVICE_URL` | ❌ | - | Cloud Run service URL base for PR environments |
+
+### Performance Monitoring
+
+| Variable | Required | Default | Description |
+|----------|----------|---------|-------------|
+| `MEMORY_SAMPLE_INTERVAL_MS` | ❌ | `60000` | Interval for memory usage sampling |
+| `TRACE_SAMPLING_RATE` | ❌ | `0.1` | OpenTelemetry trace sampling rate (0.0-1.0) |
+
+### Testing
+
+| Variable | Required | Default | Description |
+|----------|----------|---------|-------------|
+| `TEST_MONGO_URI` | ❌ | `mongodb://localhost:27017/test` | MongoDB URI for tests |
+| `CRON_SECRET_KEY` | ❌ | - | Secret key for testing cron endpoints |
+
+### Configuration Model System
+
+The example backend uses a **Configuration model** with a priority system:
+
+**Priority (highest to lowest)**:
+1. Runtime override via `Configuration.set()`
+2. Database cache (persisted values)
+3. Environment variable
+4. Default value
+
+``````typescript
+// Get configuration value
+const pageSize = await Configuration.get("DEFAULT_PAGE_SIZE"); // Returns 20
+
+// Set configuration value (persists to database)
+await Configuration.set("DEFAULT_PAGE_SIZE", 50);
+
+// Register new configuration
+Configuration.register("FEATURE_FLAG", {
+  defaultValue: false,
+  envVar: "FEATURE_FLAG",
+  description: "Enable new feature",
+  type: "boolean",
+});
+``````
+
+See [Configuration System](../explanation/configuration-system.md) for details.
+
+---
+
+## Example Frontend
+
+Environment variables specific to the example frontend application.
+
+### SDK Generation
+
+| Variable | Required | Default | Description |
+|----------|----------|---------|-------------|
+| `OPENAPI_URL` | ❌ | `http://localhost:4000/openapi.json` | Backend OpenAPI spec URL for SDK generation |
+
+Used by `bun run sdk` to fetch the OpenAPI specification and generate RTK Query hooks.
+
+### Development
+
+| Variable | Required | Default | Description |
+|----------|----------|---------|-------------|
+| `EXPO_PUBLIC_API_URL` | ❌ | Auto-detected | Backend API URL (see [@terreno/rtk](#terrenortk-frontend-state)) |
+
+### Example .env File
+
+``````bash
+# Backend API (optional - auto-detected if not set)
+EXPO_PUBLIC_API_URL=http://localhost:4000
+
+# SDK generation (optional)
+OPENAPI_URL=http://localhost:4000/openapi.json
+``````
+
+---
+
+## Best Practices
+
+### Security
+
+1. **Never commit `.env` files** - Add to `.gitignore`
+2. **Use strong secrets** - Generate with `openssl rand -base64 32`
+3. **Rotate secrets regularly** - Especially `TOKEN_SECRET` and `REFRESH_TOKEN_SECRET`
+4. **Different secrets per environment** - Don't reuse production secrets in development
+
+### Development
+
+1. **Use `.env.example`** - Check into version control with placeholder values
+2. **Document all variables** - Include description and default values
+3. **Validate required variables** - Fail fast if missing critical config
+4. **Auto-detect when possible** - Like `@terreno/rtk` does for `BASE_URL`
+
+### Production
+
+1. **Use environment variables** - Not hardcoded values or `.env` files
+2. **Set via platform** - Railway, Heroku, Cloud Run, etc.
+3. **Enable monitoring** - Set `SENTRY_DSN` and `USE_SENTRY_LOGGING`
+4. **Reduce logging** - Set `LOG_REQUESTS=false` to reduce noise
+
+---
+
+## Troubleshooting
+
+### "TOKEN_SECRET is not set"
+
+**Problem**: Required authentication variables missing.
+
+**Solution**: 
+```bash
+cp .env.example .env
+# Edit .env and set all required variables
+```
+
+### "Cannot connect to MongoDB"
+
+**Problem**: `MONGO_URI` incorrect or MongoDB not running.
+
+**Solutions**:
+- Ensure MongoDB is running: `docker run -d -p 27017:27017 mongo`
+- Check `MONGO_URI` in `.env`
+- Test connection: `mongosh mongodb://localhost:27017`
+
+### "Network request failed" (Frontend)
+
+**Problem**: Frontend can't reach backend.
+
+**Solutions**:
+- Ensure backend is running
+- Check `EXPO_PUBLIC_API_URL` matches backend port
+- For physical devices: Use your computer's local IP, not `localhost`
+- Verify CORS settings allow frontend origin
+
+### "Invalid token"
+
+**Problem**: Token secrets mismatch between frontend/backend.
+
+**Solution**: Ensure `TOKEN_SECRET` and `REFRESH_TOKEN_SECRET` are identical across deployments if using shared authentication.
+
+---
+
+## Related Documentation
+
+- [Getting Started Tutorial](../tutorials/getting-started.md)
+- [@terreno/api Reference](./api.md)
+- [@terreno/rtk Reference](./rtk.md)
+- [Configuration System](../explanation/configuration-system.md)
+- [Example Backend README](../../example-backend/README.md)
+- [Example Frontend README](../../example-frontend/README.md)

package/dist/docs/versioned/0.25.0/reference/generated/api/README.md

@@ -0,0 +1,294 @@
+## Classes
+
+- [APIError](classes/APIError.md)
+- [BetterAuthApp](classes/BetterAuthApp.md)
+- [CachingSecretProvider](classes/CachingSecretProvider.md)
+- [CompositeSecretProvider](classes/CompositeSecretProvider.md)
+- [ConfigurationApp](classes/ConfigurationApp.md)
+- [ConsentApp](classes/ConsentApp.md)
+- [DateOnly](classes/DateOnly.md)
+- [EnvSecretProvider](classes/EnvSecretProvider.md)
+- [GcpSecretProvider](classes/GcpSecretProvider.md)
+- [OpenApiMiddlewareBuilder](classes/OpenApiMiddlewareBuilder.md)
+- [RealtimeApp](classes/RealtimeApp.md)
+- [TaskCancelledError](classes/TaskCancelledError.md)
+- [TerrenoApp](classes/TerrenoApp.md)
+- [VersionCheckPlugin](classes/VersionCheckPlugin.md)
+
+## Interfaces
+
+- [ActionContext](interfaces/ActionContext.md)
+- [APIErrorConstructor](interfaces/APIErrorConstructor.md)
+- [AsyncHandlerOptions](interfaces/AsyncHandlerOptions.md)
+- [AuthenticatedClient](interfaces/AuthenticatedClient.md)
+- [AuthOptions](interfaces/AuthOptions.md)
+- [BackgroundTaskDocument](interfaces/BackgroundTaskDocument.md)
+- [BackgroundTaskMethods](interfaces/BackgroundTaskMethods.md)
+- [BackgroundTaskModel](interfaces/BackgroundTaskModel.md)
+- [BackgroundTaskStatics](interfaces/BackgroundTaskStatics.md)
+- [BaseUser](interfaces/BaseUser.md)
+- [BetterAuthAppOptions](interfaces/BetterAuthAppOptions.md)
+- [BetterAuthConfig](interfaces/BetterAuthConfig.md)
+- [BetterAuthOAuthProvider](interfaces/BetterAuthOAuthProvider.md)
+- [BetterAuthSession](interfaces/BetterAuthSession.md)
+- [BetterAuthSessionData](interfaces/BetterAuthSessionData.md)
+- [BetterAuthUser](interfaces/BetterAuthUser.md)
+- [CachingSecretProviderOptions](interfaces/CachingSecretProviderOptions.md)
+- [ChangeStreamConfig](interfaces/ChangeStreamConfig.md)
+- [CollectionActionConfig](interfaces/CollectionActionConfig.md)
+- [ConfigRegistration](interfaces/ConfigRegistration.md)
+- [ConfigurationAppOptions](interfaces/ConfigurationAppOptions.md)
+- [ConfigurationMetaResponse](interfaces/ConfigurationMetaResponse.md)
+- [ConfigurationModel](interfaces/ConfigurationModel.md)
+- [ConfigurationPermissions](interfaces/ConfigurationPermissions.md)
+- [ConfigurationPluginOptions](interfaces/ConfigurationPluginOptions.md)
+- [ConfigurationStatics](interfaces/ConfigurationStatics.md)
+- [ConsentAppOptions](interfaces/ConsentAppOptions.md)
+- [ConsentFormCheckbox](interfaces/ConsentFormCheckbox.md)
+- [ConsentFormDefinition](interfaces/ConsentFormDefinition.md)
+- [ConsentFormDocument](interfaces/ConsentFormDocument.md)
+- [ConsentFormModel](interfaces/ConsentFormModel.md)
+- [ConsentFormStatics](interfaces/ConsentFormStatics.md)
+- [ConsentResponseDocument](interfaces/ConsentResponseDocument.md)
+- [ConsentResponseMethods](interfaces/ConsentResponseMethods.md)
+- [ConsentResponseModel](interfaces/ConsentResponseModel.md)
+- [ConsentResponseStatics](interfaces/ConsentResponseStatics.md)
+- [CreateAuthenticatedClientOptions](interfaces/CreateAuthenticatedClientOptions.md)
+- [CreateBetterAuthOptions](interfaces/CreateBetterAuthOptions.md)
+- [CreatedDeleted](interfaces/CreatedDeleted.md)
+- [CreateFeatureFlaggedLoggerOptions](interfaces/CreateFeatureFlaggedLoggerOptions.md)
+- [CreateScopedLoggerOptions](interfaces/CreateScopedLoggerOptions.md)
+- [CreateValidatorOptions](interfaces/CreateValidatorOptions.md)
+- [DocumentSubscription](interfaces/DocumentSubscription.md)
+- [FindExactlyOnePlugin](interfaces/FindExactlyOnePlugin.md)
+- [FindOneOrNonePlugin](interfaces/FindOneOrNonePlugin.md)
+- [GcpSecretProviderOptions](interfaces/GcpSecretProviderOptions.md)
+- [GenerateTokensOptions](interfaces/GenerateTokensOptions.md)
+- [GitHubAuthOptions](interfaces/GitHubAuthOptions.md)
+- [GitHubUserFields](interfaces/GitHubUserFields.md)
+- [HasUpsert](interfaces/HasUpsert.md)
+- [HttpClientLogger](interfaces/HttpClientLogger.md)
+- [InstanceActionConfig](interfaces/InstanceActionConfig.md)
+- [IsDeleted](interfaces/IsDeleted.md)
+- [JSONArray](interfaces/JSONArray.md)
+- [JSONObject](interfaces/JSONObject.md)
+- [JwtSessionPayload](interfaces/JwtSessionPayload.md)
+- [LogContextFields](interfaces/LogContextFields.md)
+- [LoggingOptions](interfaces/LoggingOptions.md)
+- [ModelRouterOptions](interfaces/ModelRouterOptions.md)
+- [ModelRouterRegistration](interfaces/ModelRouterRegistration.md)
+- [ModelRouterValidationOptions](interfaces/ModelRouterValidationOptions.md)
+- [MongoClientLike](interfaces/MongoClientLike.md)
+- [NormalizedApiError](interfaces/NormalizedApiError.md)
+- [OpenApiBuildResult](interfaces/OpenApiBuildResult.md)
+- [OpenApiMiddleware](interfaces/OpenApiMiddleware.md)
+- [OpenApiParameter](interfaces/OpenApiParameter.md)
+- [OpenApiResponse](interfaces/OpenApiResponse.md)
+- [OpenApiSchema](interfaces/OpenApiSchema.md)
+- [OpenApiSchemaProperty](interfaces/OpenApiSchemaProperty.md)
+- [OpenApiValidatorConfig](interfaces/OpenApiValidatorConfig.md)
+- [PopulatePath](interfaces/PopulatePath.md)
+- [QuerySubscription](interfaces/QuerySubscription.md)
+- [QueryValidatorOptions](interfaces/QueryValidatorOptions.md)
+- [RealtimeAppOptions](interfaces/RealtimeAppOptions.md)
+- [RealtimeConfig](interfaces/RealtimeConfig.md)
+- [RealtimeEvent](interfaces/RealtimeEvent.md)
+- [RealtimeRegistryEntry](interfaces/RealtimeRegistryEntry.md)
+- [RealtimeSocketLike](interfaces/RealtimeSocketLike.md)
+- [RequestBodyValidatorOptions](interfaces/RequestBodyValidatorOptions.md)
+- [RequestContext](interfaces/RequestContext.md)
+- [RESTPermissions](interfaces/RESTPermissions.md)
+- [RetryPolicy](interfaces/RetryPolicy.md)
+- [ScopedLogger](interfaces/ScopedLogger.md)
+- [ScriptArgDef](interfaces/ScriptArgDef.md)
+- [ScriptArgs](interfaces/ScriptArgs.md)
+- [ScriptContext](interfaces/ScriptContext.md)
+- [ScriptResult](interfaces/ScriptResult.md)
+- [SecretFieldMeta](interfaces/SecretFieldMeta.md)
+- [SecretProvider](interfaces/SecretProvider.md)
+- [SyncConsentsOptions](interfaces/SyncConsentsOptions.md)
+- [SyncConsentsResult](interfaces/SyncConsentsResult.md)
+- [TerrenoAppOptions](interfaces/TerrenoAppOptions.md)
+- [TerrenoPlugin](interfaces/TerrenoPlugin.md)
+- [TerrenoRequestLogEntry](interfaces/TerrenoRequestLogEntry.md)
+- [TerrenoTransformer](interfaces/TerrenoTransformer.md)
+- [User](interfaces/User.md)
+- [UserModel](interfaces/UserModel.md)
+- [VersionCheckResponse](interfaces/VersionCheckResponse.md)
+- [VersionConfigDocument](interfaces/VersionConfigDocument.md)
+- [VersionConfigModel](interfaces/VersionConfigModel.md)
+- [WithApiErrorHandlingOptions](interfaces/WithApiErrorHandlingOptions.md)
+- [WrapScriptOptions](interfaces/WrapScriptOptions.md)
+
+## Type Aliases
+
+- [AddRoutes](type-aliases/AddRoutes.md)
+- [ApiErrorClassification](type-aliases/ApiErrorClassification.md)
+- [AuthProvider](type-aliases/AuthProvider.md)
+- [AuthStrategy](type-aliases/AuthStrategy.md)
+- [BetterAuthInstance](type-aliases/BetterAuthInstance.md)
+- [ConfigType](type-aliases/ConfigType.md)
+- [ConfigurationPostUpdateHook](type-aliases/ConfigurationPostUpdateHook.md)
+- [ConfigurationPreUpdateHook](type-aliases/ConfigurationPreUpdateHook.md)
+- [ConsentFormMethods](type-aliases/ConsentFormMethods.md)
+- [ConsentFormType](type-aliases/ConsentFormType.md)
+- [DeepPartial](type-aliases/DeepPartial.md)
+- [GooseRESTOptions](type-aliases/GooseRESTOptions.md)
+- [JSONPrimitive](type-aliases/JSONPrimitive.md)
+- [JSONValue](type-aliases/JSONValue.md)
+- [Paths](type-aliases/Paths.md)
+- [PathValue](type-aliases/PathValue.md)
+- [PermissionMethod](type-aliases/PermissionMethod.md)
+- [RequestContextAttributes](type-aliases/RequestContextAttributes.md)
+- [RESTMethod](type-aliases/RESTMethod.md)
+- [ScriptArgValue](type-aliases/ScriptArgValue.md)
+- [ScriptRunner](type-aliases/ScriptRunner.md)
+- [VersionCheckStatus](type-aliases/VersionCheckStatus.md)
+
+## Variables
+
+- [ACTION\_NAME\_PATTERN](variables/ACTION_NAME_PATTERN.md)
+- [BackgroundTask](variables/BackgroundTask.md)
+- [Config](variables/Config.md)
+- [ConsentForm](variables/ConsentForm.md)
+- [ConsentResponse](variables/ConsentResponse.md)
+- [consentResponsePopulatePaths](variables/consentResponsePopulatePaths.md)
+- [gooseRestRouter](variables/gooseRestRouter.md)
+- [logger](variables/logger.md)
+- [MAX\_DOCUMENT\_SUBSCRIPTIONS](variables/MAX_DOCUMENT_SUBSCRIPTIONS.md)
+- [MAX\_MODEL\_SUBSCRIPTIONS](variables/MAX_MODEL_SUBSCRIPTIONS.md)
+- [MAX\_QUERY\_SUBSCRIPTIONS](variables/MAX_QUERY_SUBSCRIPTIONS.md)
+- [Permissions](variables/Permissions.md)
+- [REQUEST\_CONTEXT\_ATTRIBUTE\_NAMES](variables/REQUEST_CONTEXT_ATTRIBUTE_NAMES.md)
+- [VersionConfig](variables/VersionConfig.md)
+- [winstonLogger](variables/winstonLogger.md)
+
+## Functions
+
+- [addAuthRoutes](functions/addAuthRoutes.md)
+- [addGitHubAuthRoutes](functions/addGitHubAuthRoutes.md)
+- [addMeRoutes](functions/addMeRoutes.md)
+- [addPopulateToQuery](functions/addPopulateToQuery.md)
+- [addQuerySubscription](functions/addQuerySubscription.md)
+- [AdminOwnerTransformer](functions/AdminOwnerTransformer.md)
+- [apiErrorMiddleware](functions/apiErrorMiddleware.md)
+- [apiFallthroughErrorMiddleware](functions/apiFallthroughErrorMiddleware.md)
+- [apiUnauthorizedMiddleware](functions/apiUnauthorizedMiddleware.md)
+- [applyRequestContextToSentry](functions/applyRequestContextToSentry.md)
+- [assertNoActionCollisions](functions/assertNoActionCollisions.md)
+- [asyncHandler](functions/asyncHandler.md)
+- [authenticateMiddleware](functions/authenticateMiddleware.md)
+- [baseUserPlugin](functions/baseUserPlugin.md)
+- [buildQuerySchemaFromFields](functions/buildQuerySchemaFromFields.md)
+- [checkModelsStrict](functions/checkModelsStrict.md)
+- [checkPermissions](functions/checkPermissions.md)
+- [clearQueryStore](functions/clearQueryStore.md)
+- [clearRealtimeRegistry](functions/clearRealtimeRegistry.md)
+- [computeQueryId](functions/computeQueryId.md)
+- [configurationPlugin](functions/configurationPlugin.md)
+- [configureOpenApiValidator](functions/configureOpenApiValidator.md)
+- [createActionOpenApiMiddleware](functions/createActionOpenApiMiddleware.md)
+- [createAuthenticatedClient](functions/createAuthenticatedClient.md)
+- [createBetterAuth](functions/createBetterAuth.md)
+- [createBetterAuthSessionMiddleware](functions/createBetterAuthSessionMiddleware.md)
+- [createdUpdatedPlugin](functions/createdUpdatedPlugin.md)
+- [createFeatureFlaggedLogger](functions/createFeatureFlaggedLogger.md)
+- [createModelValidators](functions/createModelValidators.md)
+- [createOpenApiBuilder](functions/createOpenApiBuilder.md)
+- [createRouter](functions/createRouter.md)
+- [createRouterWithAuth](functions/createRouterWithAuth.md)
+- [createScopedLogger](functions/createScopedLogger.md)
+- [createScriptArgs](functions/createScriptArgs.md)
+- [createValidator](functions/createValidator.md)
+- [cronjob](functions/cronjob.md)
+- [defaultResponseHandler](functions/defaultResponseHandler.md)
+- [defineCollectionAction](functions/defineCollectionAction.md)
+- [defineInstanceAction](functions/defineInstanceAction.md)
+- [envConfigurationPlugin](functions/envConfigurationPlugin.md)
+- [errorMessage](functions/errorMessage.md)
+- [errorsPlugin](functions/errorsPlugin.md)
+- [errorStack](functions/errorStack.md)
+- [findExactlyOne](functions/findExactlyOne.md)
+- [findOneOrNone](functions/findOneOrNone.md)
+- [findOneOrNoneFor](functions/findOneOrNoneFor.md)
+- [findRegistryEntryByCollection](functions/findRegistryEntryByCollection.md)
+- [findRegistryEntryByRoutePath](functions/findRegistryEntryByRoutePath.md)
+- [firebaseJWTPlugin](functions/firebaseJWTPlugin.md)
+- [fixMixedFields](functions/fixMixedFields.md)
+- [flattenToDotPaths](functions/flattenToDotPaths.md)
+- [formatLogContextSuffix](functions/formatLogContextSuffix.md)
+- [generateTokens](functions/generateTokens.md)
+- [getAPIErrorBody](functions/getAPIErrorBody.md)
+- [getBetterAuthSession](functions/getBetterAuthSession.md)
+- [getCurrentLogContext](functions/getCurrentLogContext.md)
+- [getCurrentRequestContext](functions/getCurrentRequestContext.md)
+- [getCurrentRequestContextAttributes](functions/getCurrentRequestContextAttributes.md)
+- [getDisableExternalErrorTracking](functions/getDisableExternalErrorTracking.md)
+- [getMongoClientFromMongoose](functions/getMongoClientFromMongoose.md)
+- [getOpenApiSpecForModel](functions/getOpenApiSpecForModel.md)
+- [getOpenApiValidatorConfig](functions/getOpenApiValidatorConfig.md)
+- [getQuerySubscriptionsForCollection](functions/getQuerySubscriptionsForCollection.md)
+- [getRealtimeRegistry](functions/getRealtimeRegistry.md)
+- [getRequestContextFromAttributes](functions/getRequestContextFromAttributes.md)
+- [getSchemaFromModel](functions/getSchemaFromModel.md)
+- [getSessionIdFromJwtPayload](functions/getSessionIdFromJwtPayload.md)
+- [githubUserPlugin](functions/githubUserPlugin.md)
+- [hasBetterAuthSession](functions/hasBetterAuthSession.md)
+- [installRealtimeSocketHandlers](functions/installRealtimeSocketHandlers.md)
+- [isAPIError](functions/isAPIError.md)
+- [isDeletedPlugin](functions/isDeletedPlugin.md)
+- [isDisabledPlugin](functions/isDisabledPlugin.md)
+- [isOpenApiValidatorConfigured](functions/isOpenApiValidatorConfigured.md)
+- [isValidObjectId](functions/isValidObjectId.md)
+- [jsonResponseRequestIdMiddleware](functions/jsonResponseRequestIdMiddleware.md)
+- [logRequests](functions/logRequests.md)
+- [markRetryUnsafe](functions/markRetryUnsafe.md)
+- [matchesQuery](functions/matchesQuery.md)
+- [modelRouter](functions/modelRouter.md)
+- [mongooseErrorToAPIError](functions/mongooseErrorToAPIError.md)
+- [mountBetterAuthRoutes](functions/mountBetterAuthRoutes.md)
+- [normalizeApiError](functions/normalizeApiError.md)
+- [openApiCompatMiddleware](functions/openApiCompatMiddleware.md)
+- [openApiEtagMiddleware](functions/openApiEtagMiddleware.md)
+- [OwnerQueryFilter](functions/OwnerQueryFilter.md)
+- [parseScriptArgs](functions/parseScriptArgs.md)
+- [patchAppUse](functions/patchAppUse.md)
+- [permissionMiddleware](functions/permissionMiddleware.md)
+- [registerActionRoutes](functions/registerActionRoutes.md)
+- [registerRealtime](functions/registerRealtime.md)
+- [removeAllSocketQueries](functions/removeAllSocketQueries.md)
+- [removeQuerySubscription](functions/removeQuerySubscription.md)
+- [requestContextMiddleware](functions/requestContextMiddleware.md)
+- [resetOpenApiValidatorConfig](functions/resetOpenApiValidatorConfig.md)
+- [runActionPermissions](functions/runActionPermissions.md)
+- [runWithRequestContext](functions/runWithRequestContext.md)
+- [runWithRequestContextAttributes](functions/runWithRequestContextAttributes.md)
+- [sendToGoogleChat](functions/sendToGoogleChat.md)
+- [sendToSlack](functions/sendToSlack.md)
+- [sendToZoom](functions/sendToZoom.md)
+- [sentryAppVersionMiddleware](functions/sentryAppVersionMiddleware.md)
+- [serialize](functions/serialize.md)
+- [setRequestContext](functions/setRequestContext.md)
+- [setupAuth](functions/setupAuth.md)
+- [setupBetterAuthUserSync](functions/setupBetterAuthUserSync.md)
+- [setupEnvironment](functions/setupEnvironment.md)
+- [setupGitHubAuth](functions/setupGitHubAuth.md)
+- [setupLogging](functions/setupLogging.md)
+- [signupUser](functions/signupUser.md)
+- [startChangeStreamWatcher](functions/startChangeStreamWatcher.md)
+- [stopChangeStreamWatcher](functions/stopChangeStreamWatcher.md)
+- [syncBetterAuthUser](functions/syncBetterAuthUser.md)
+- [syncConsents](functions/syncConsents.md)
+- [timeout](functions/timeout.md)
+- [transform](functions/transform.md)
+- [unpopulate](functions/unpopulate.md)
+- [updateRequestContextFromRequest](functions/updateRequestContextFromRequest.md)
+- [upsertPlugin](functions/upsertPlugin.md)
+- [validateActionRequest](functions/validateActionRequest.md)
+- [validateModelRequestBody](functions/validateModelRequestBody.md)
+- [validateQueryParams](functions/validateQueryParams.md)
+- [validateRequestBody](functions/validateRequestBody.md)
+- [validateResponseData](functions/validateResponseData.md)
+- [withApiErrorHandling](functions/withApiErrorHandling.md)
+- [wrapActionResponse](functions/wrapActionResponse.md)
+- [wrapScript](functions/wrapScript.md)