@terreno/mcp 0.23.0 → 0.23.1

package/src/docs/versioned/0.23.0/reference/feature-flags.md

@@ -0,0 +1,304 @@
+# @terreno/feature-flags
+
+Feature flags and A/B testing plugin for `@terreno/api`. Provides a Mongoose model, admin CRUD endpoints, user-facing evaluation, and deterministic hashing for gradual rollouts and variant assignment.
+
+## Install
+
+```bash
+bun add @terreno/feature-flags
+```
+
+Peer dependency: `mongoose >= 8.0.0`.
+
+## Quick Start
+
+### Backend
+
+Register `FeatureFlagsApp` as a `TerrenoPlugin` and add the pre-configured admin model config to your `AdminApp`:
+
+```typescript
+import {TerrenoApp} from "@terreno/api";
+import {AdminApp} from "@terreno/admin-backend";
+import {FeatureFlagsApp, featureFlagAdminConfig} from "@terreno/feature-flags";
+import {User} from "./models/user";
+
+const segments = {
+  "pro-users": (user) => user.plan === "pro",
+  "beta-testers": (user) => user.betaTester === true,
+};
+
+new TerrenoApp({userModel: User})
+  .register(new FeatureFlagsApp({segments}))
+  .register(
+    new AdminApp({
+      models: [featureFlagAdminConfig],
+    })
+  )
+  .start();
+```
+
+`featureFlagAdminConfig` is a ready-to-use admin model config that sets up the display name, list fields, route path, and model reference — no manual configuration needed. Downstream consumers can import it directly and pass it to `AdminApp`.
+
+### Frontend
+
+Use the `useFeatureFlags` hook from `@terreno/rtk` to evaluate flags for the current user:
+
+```typescript
+import {useFeatureFlags} from "@terreno/rtk";
+import {terrenoApi} from "@/store/sdk";
+
+const MyComponent = () => {
+  const {getFlag, getVariant, isLoading} = useFeatureFlags(terrenoApi);
+
+  if (isLoading) return <Spinner />;
+
+  const showNewFeature = getFlag("new-feature"); // boolean
+  const variant = getVariant("checkout-experiment"); // string | null
+
+  return showNewFeature ? <NewFeature /> : <OldFeature />;
+};
+```
+
+New code can also use OpenFeature React hooks (`useBooleanFlagValue`, `useStringFlagValue`, `FeatureFlag`, …) after wiring `useTerrenoFeatureFlags` and `<OpenFeatureProvider domain="feature-flags">` — see `@terreno/rtk` and [how-to: add feature flags](../how-to/add-feature-flags.md).
+
+## OpenFeature integration
+
+`FeatureFlagsApp` registers an OpenFeature **server** provider (`MongoFeatureFlagProvider`) on a dedicated domain (default `"feature-flags"`) so the global default provider is unchanged. The authenticated bulk endpoint **`GET {basePath}/flagConfiguration`** returns a `FlagConfiguration`-compatible map (suitable for `TypedInMemoryProvider` on the client). The legacy **`GET {basePath}/evaluate`** response shape is unchanged but is **deprecated**: responses include `Deprecation: true` and a `Sunset` HTTP-date header (~90 days). Prefer `useTerrenoFeatureFlags` / `useFeatureFlags` from `@terreno/rtk`, or migrate direct HTTP callers to `/flagConfiguration`.
+
+### `defaultVariant` on `FeatureFlag`
+
+Stored OpenFeature default variant key: for boolean flags `"on"` or `"off"`; for variant flags one of `variants[].key`. On save, if omitted, the schema sets boolean → `"off"` and variant → first variant key. `/flagConfiguration` builds each entry’s `defaultVariant` and `variants` from the **resolved** value for the current user (so client-side OpenFeature reads the correct branch without re-running targeting).
+
+### `MongoFeatureFlagProvider`
+
+Server-side OpenFeature `Provider` that resolves flags via `findOneOrNone` and existing `evaluateFlag()` logic. Unsupported evaluation types: **`resolveNumberEvaluation` / `resolveObjectEvaluation` always return `FLAG_NOT_FOUND`** with the caller’s default.
+
+### Type-safe flag keys (optional)
+
+Consumers may augment `@openfeature/core` with `BooleanFlagKey` / `StringFlagKey` unions. Those types are **compile-time hints only**; keys created in the admin UI can drift until types are updated.
+
+### Live updates (optional)
+
+Pass `liveUpdates: { socketIoServer: io | () => io }` to broadcast on Mongoose change streams. **Requires MongoDB as a replica set** (single-node replset is fine). Emits a socket event (default `featureFlagsChanged`, payload `{ key }`) and `PROVIDER_CONFIGURATION_CHANGED` on the server provider. All authenticated subscribers receive the same event name; payload is only the flag key (same keys are already exposed per user via `/flagConfiguration`).
+
+## Exports
+
+### Classes
+
+| Export | Description |
+|--------|-------------|
+| `FeatureFlagsApp` | `TerrenoPlugin` that registers admin CRUD, `/flagConfiguration`, and `/evaluate` |
+| `MongoFeatureFlagProvider` | OpenFeature server `Provider` backed by Mongo evaluation |
+
+### Models
+
+| Export | Description |
+|--------|-------------|
+| `FeatureFlag` | Mongoose model for feature flag documents |
+
+### Constants
+
+| Export | Description |
+|--------|-------------|
+| `featureFlagAdminConfig` | Pre-configured `AdminModelConfig` for use with `AdminApp` |
+
+### Functions
+
+| Export | Description |
+|--------|-------------|
+| `buildFlagDefinition` | Build one `FlagDefinition` for `/flagConfiguration` |
+| `effectiveDefaultVariantForFlag` | Resolve `defaultVariant` including legacy docs |
+| `evaluateFlag` | Evaluate a single flag for a user |
+| `evaluateAllFlags` | Evaluate all enabled, non-archived flags for a user |
+| `deterministicHash` | Hash a string to 0–99 for consistent assignment |
+
+### Types
+
+| Export | Description |
+|--------|-------------|
+| `FeatureFlagDocument` | Mongoose document type for a feature flag |
+| `FeatureFlagModel` | Mongoose model type with custom statics |
+| `FeatureFlagRule` | Targeting rule shape (field-based or segment-based) |
+| `FeatureFlagVariant` | Variant key + weight for A/B tests |
+| `FeatureFlagType` | `"boolean" \| "variant"` |
+| `FeatureFlagsOptions` | Constructor options for `FeatureFlagsApp` |
+| `SegmentFunction` | `(user: unknown) => boolean` |
+| `EvaluationResult` | `Record<string, boolean \| string \| null>` |
+| `FlagDefinition` | One flag entry for `/flagConfiguration` |
+| `FlagConfigurationResponse` | `{ data: Record<string, FlagDefinition> }` |
+| `FeatureFlagsLiveUpdatesOptions` | Socket.io + optional custom event name |
+| `FeatureFlagsSocketEmitter` | Minimal `emit` shape for live updates |
+
+## FeatureFlagsApp Options
+
+```typescript
+interface FeatureFlagsOptions {
+  basePath?: string;                                // Default: "/feature-flags"
+  segments?: Record<string, SegmentFunction>;       // Named segment functions
+  permissions?: ModelRouterOptions["permissions"];   // Override default IsAdmin on CRUD
+  segmentsPermission?: (user: unknown) => boolean;  // Override admin check on /segments
+  liveUpdates?: FeatureFlagsLiveUpdatesOptions;     // Optional: change stream → socket.io
+  openFeatureDomain?: string;                       // Default: "feature-flags"
+}
+```
+
+## Generated Routes
+
+All routes are mounted under the configured `basePath` (default: `/feature-flags`).
+
+### Admin Routes (default: `IsAdmin`)
+
+| Method | Path | Description |
+|--------|------|-------------|
+| `POST` | `{basePath}/flags/` | Create a feature flag |
+| `GET` | `{basePath}/flags/` | List flags (paginated, sortable) |
+| `GET` | `{basePath}/flags/:id` | Get a single flag |
+| `PATCH` | `{basePath}/flags/:id` | Update a flag |
+| `DELETE` | `{basePath}/flags/:id` | Soft-delete a flag |
+| `GET` | `{basePath}/segments` | List registered segment names |
+
+### User Routes (`IsAuthenticated`)
+
+| Method | Path | Description |
+|--------|------|-------------|
+| `GET` | `{basePath}/flagConfiguration` | OpenFeature static configuration for enabled, non-archived flags (authenticated) |
+| `GET` | `{basePath}/evaluate` | **Deprecated** — legacy `Record<key, boolean \| string \| null>` for the current user |
+
+### Response Shapes
+
+**`GET /feature-flags/flagConfiguration`** (enabled flags only; disabled/archived keys are omitted):
+
+```json
+{
+  "data": {
+    "todo-summary-card": {
+      "variants": {"off": false, "on": true},
+      "defaultVariant": "on",
+      "disabled": false
+    },
+    "profile-layout": {
+      "variants": {"compact": "compact", "detailed": "detailed"},
+      "defaultVariant": "compact",
+      "disabled": false
+    }
+  }
+}
+```
+
+**`GET /feature-flags/evaluate`** (deprecated headers on response):
+
+```json
+{
+  "data": {
+    "new-checkout-flow": true,
+    "checkout-experiment": "variant-a",
+    "dark-mode": false
+  }
+}
+```
+
+**`GET /feature-flags/segments`**:
+```json
+{
+  "data": ["pro-users", "beta-testers"]
+}
+```
+
+## Flag Types
+
+### Boolean Flags (`type: "boolean"`)
+
+Return `true` or `false`. Use `rolloutPercentage` for gradual rollouts.
+
+- `enabled: false` → always `false`
+- `enabled: true`, no matching rules → deterministic hash compared against `rolloutPercentage`
+- Matching rule → returns the rule's `enabled` value
+
+### Variant Flags (`type: "variant"`)
+
+Return a string variant key. Use the `variants` array with weighted distribution.
+
+- `enabled: false` → returns `null`
+- `enabled: true`, no matching rules → deterministic hash mapped to variant by cumulative weights
+- Matching rule → returns the rule's `variant` value
+
+## Targeting Rules
+
+Rules are evaluated in order — first match wins. Each rule is either field-based or segment-based.
+
+### Field Rules
+
+Match against a user field with an operator:
+
+```json
+{
+  "field": "email",
+  "operator": "contains",
+  "value": "@mycompany.com",
+  "enabled": true
+}
+```
+
+Supported operators: `eq`, `neq`, `in`, `nin`, `gt`, `lt`, `contains`. Dot notation is supported for nested fields (e.g. `address.zip`).
+
+### Segment Rules
+
+Match against a named segment function registered at startup:
+
+```json
+{
+  "segment": "pro-users",
+  "enabled": true
+}
+```
+
+## Admin Integration
+
+The `featureFlagAdminConfig` export provides everything `AdminApp` needs:
+
+```typescript
+import {featureFlagAdminConfig} from "@terreno/feature-flags";
+
+// Use directly in AdminApp
+new AdminApp({
+  models: [featureFlagAdminConfig, ...otherModels],
+});
+```
+
+This is equivalent to manually configuring:
+
+```typescript
+import {FeatureFlag} from "@terreno/feature-flags";
+
+{
+  displayName: "Feature Flags",
+  listFields: ["key", "name", "type", "enabled", "archived", "defaultVariant", "created"],
+  model: FeatureFlag,
+  routePath: "/feature-flags",
+}
+```
+
+The admin panel auto-generates forms from the FeatureFlag model schema, including fields for rules, variants, rollout percentage, and archiving.
+
+## Segments
+
+Segments are named functions that classify users. Register them when constructing `FeatureFlagsApp`:
+
+```typescript
+const segments = {
+  "admin-users": (user) => user.admin === true,
+  "oauth-users": (user) => Boolean(user.oauthProvider),
+  "high-usage": (user) => user.totalActions > 1000,
+  "internal-team": (user) => user.email?.endsWith("@mycompany.com"),
+};
+
+new FeatureFlagsApp({segments});
+```
+
+Segment names can be referenced in flag rules via the admin UI.
+
+## Environment Variables
+
+| Variable | Description | Default |
+|----------|-------------|---------|
+| `FEATURE_FLAGS_DEBUG` | Set to `"false"` to disable evaluation debug logs | Enabled |

package/src/docs/versioned/0.23.0/reference/generated/README.md

@@ -0,0 +1,17 @@
+---
+title: Generated API reference
+description: TypeDoc-generated package API references for Terreno packages.
+---
+
+# Generated API reference
+
+These pages are generated at docs site build time via TypeDoc. Hand-written overviews remain in the sibling reference docs.
+
+## @terreno/api
+
+Generated API reference lives in [`generated/api/`](./generated/api/README.md).
+
+## @terreno/rtk
+
+Generated API reference lives in [`generated/rtk/`](./generated/rtk/README.md).
+

package/src/docs/versioned/0.23.0/reference/generated/api/README.md

@@ -0,0 +1,282 @@
+## 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)
+- [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)
+- [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)
+- [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)
+- [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)
+- [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)
+- [WrapScriptOptions](interfaces/WrapScriptOptions.md)
+
+## Type Aliases
+
+- [AddRoutes](type-aliases/AddRoutes.md)
+- [AuthProvider](type-aliases/AuthProvider.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)
+- [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)
+- [matchesQuery](functions/matchesQuery.md)
+- [modelRouter](functions/modelRouter.md)
+- [mongooseErrorToAPIError](functions/mongooseErrorToAPIError.md)
+- [mountBetterAuthRoutes](functions/mountBetterAuthRoutes.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)
+- [wrapActionResponse](functions/wrapActionResponse.md)
+- [wrapScript](functions/wrapScript.md)