@terreno/mcp 0.28.0 → 0.29.0

package/src/docs/versioned/0.28.0/reference/components/custom-select-field.mdx

@@ -0,0 +1,37 @@
+---
+title: "Custom Select Field"
+description: "Displays a list of options using the browser’s native select and includes a custom option that renders a text field when selected and allows user to input value not included in predefined options."
+sidebar_label: "Custom Select Field"
+slug: /reference/components/custom-select-field
+---
+
+import ComponentDemo from '@site/src/components/ComponentDemo';
+
+# Custom Select Field
+
+Displays a list of options using the browser’s native select and includes a custom option that renders a text field when selected and allows user to input value not included in predefined options.
+
+**Package:** `@terreno/ui`  
+**Categories:** Component  
+**Props interface:** `CustomSelectFieldProps`  
+**Story source:** [`demo/stories/CustomSelectField.stories.tsx`](https://github.com/flourishhealth/terreno/blob/master/demo/stories/CustomSelectField.stories.tsx)
+
+## Live demo
+
+<ComponentDemo name="Custom Select Field" />
+
+## Props
+
+| Prop | Type | Required | Description |
+| --- | --- | --- | --- |
+| `onChange` | `reflection` | Yes | The function to call when the custom select field value changes. |
+| `options` | `array` | Yes | The options available for selection in the select field. Each option should have a label and a value. |
+| `value` | `union` | Yes | The current value of the custom select field. |
+| `disabled` | `boolean` |  | If true, the select field will be disabled. |
+| `disableSearch` | `boolean` |  | When true, hides the type-to-filter search UI. Search is enabled by default. |
+| `errorText` | `string` |  | The error text to display if there is an error. |
+| `helperText` | `string` |  | The helper text to display below the select field. |
+| `placeholder` | `string` |  | The placeholder text to display when no option is selected. |
+| `testID` | `string` |  | Root test id for the primary interactive element or container. |
+| `testIDs` | `FieldTestIDs` |  |  |
+| `title` | `string` |  | The title of the custom select field. |

package/src/docs/versioned/0.28.0/reference/components/iconbutton.mdx

@@ -0,0 +1,44 @@
+---
+title: "IconButton"
+description: "Icon buttons allow users to take actions and make choices with a single tap."
+sidebar_label: "IconButton"
+slug: /reference/components/iconbutton
+---
+
+import ComponentDemo from '@site/src/components/ComponentDemo';
+
+# IconButton
+
+Icon buttons allow users to take actions and make choices with a single tap.
+
+**Package:** `@terreno/ui`  
+**Categories:** Component  
+**Props interface:** `IconButtonProps`  
+**Story source:** [`demo/stories/IconButton.stories.tsx`](https://github.com/flourishhealth/terreno/blob/master/demo/stories/IconButton.stories.tsx)
+
+## Live demo
+
+<ComponentDemo name="IconButton" />
+
+## Props
+
+| Prop | Type | Required | Description |
+| --- | --- | --- | --- |
+| `accessibilityLabel` | `string` | Yes | The accessibility label attribute identifies the user interface element. It should be a very brief description of the element, such as "Add", "Play", "Deleted", etc. |
+| `iconName` | `IconName` | Yes | The name of the icon to display in the button. |
+| `onClick` | `reflection` | Yes | The function to call when the button is clicked. |
+| `accessibilityHint` | `string` |  | The accessibility hint describes the results of performing an action on a control or view. It should be a very brief description of the result of interacting with the button. |
+| `confirmationHeading` | `string` |  | The heading of the confirmation modal. |
+| `confirmationText` | `string` |  | The text content of the confirmation modal. |
+| `disabled` | `boolean` |  | If true, the button will be disabled. |
+| `indicator` | `union` |  | Show a small indicator icon in the lower right corner of the button. |
+| `indicatorText` | `union` |  | The text or number to display in the indicator. If not provided, the indicator will be a solid circle. |
+| `loading` | `boolean` |  | If true, a loading spinner will be shown in the button. |
+| `size` | `union` |  | The size of the button. |
+| `state` | `union` |  | Controls the button's interaction state. Use Default for standard button appearance and Active to indicate a selected or currently engaged state. |
+| `testID` | `string` |  | Root test id for the primary interactive element or container. |
+| `tooltipIdealPosition` | `TooltipPosition` |  | The ideal position of the tooltip. |
+| `tooltipIncludeArrow` | `boolean` |  | Include an arrow in the tooltip. Pointing to the button. |
+| `tooltipText` | `string` |  | The text content of the tooltip. |
+| `variant` | `union` |  | The variant of the button, which determines its style. |
+| `withConfirmation` | `boolean` |  | If true, a confirmation modal will be shown before the onClick action. |

package/src/docs/versioned/0.28.0/reference/components/select-field.mdx

@@ -0,0 +1,26 @@
+---
+title: "Select field"
+description: "Displays a list of options. Uses a custom dropdown with optional search on web and native (centered modal on Android)."
+sidebar_label: "Select field"
+slug: /reference/components/select-field
+---
+
+import ComponentDemo from '@site/src/components/ComponentDemo';
+
+# Select field
+
+Displays a list of options. Uses a custom dropdown with optional search on web and native (centered modal on Android).
+
+**Package:** `@terreno/ui`  
+**Categories:** Component  
+**Props interface:** `SelectFieldProps`  
+**Story source:** [`demo/stories/Selectfield.stories.tsx`](https://github.com/flourishhealth/terreno/blob/master/demo/stories/Selectfield.stories.tsx)
+
+## Live demo
+
+<ComponentDemo name="Select field" />
+
+## Props
+
+_No documented props were extracted from TypeDoc._
+

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

@@ -0,0 +1,304 @@
+## Classes
+
+- [APIError](classes/APIError.md)
+- [BadRequestError](classes/BadRequestError.md)
+- [BetterAuthApp](classes/BetterAuthApp.md)
+- [CachingSecretProvider](classes/CachingSecretProvider.md)
+- [CompositeSecretProvider](classes/CompositeSecretProvider.md)
+- [ConfigurationApp](classes/ConfigurationApp.md)
+- [ConflictError](classes/ConflictError.md)
+- [ConsentApp](classes/ConsentApp.md)
+- [DateOnly](classes/DateOnly.md)
+- [EnvSecretProvider](classes/EnvSecretProvider.md)
+- [ForbiddenError](classes/ForbiddenError.md)
+- [GcpSecretProvider](classes/GcpSecretProvider.md)
+- [InternalServerError](classes/InternalServerError.md)
+- [NotFoundError](classes/NotFoundError.md)
+- [OpenApiMiddlewareBuilder](classes/OpenApiMiddlewareBuilder.md)
+- [RealtimeApp](classes/RealtimeApp.md)
+- [TaskCancelledError](classes/TaskCancelledError.md)
+- [TerrenoApp](classes/TerrenoApp.md)
+- [UnauthorizedError](classes/UnauthorizedError.md)
+- [ValidationError](classes/ValidationError.md)
+- [VersionCheckPlugin](classes/VersionCheckPlugin.md)
+
+## Interfaces
+
+- [ActionContext](interfaces/ActionContext.md)
+- [APIErrorBody](interfaces/APIErrorBody.md)
+- [APIErrorOptions](interfaces/APIErrorOptions.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)
+- [~~APIErrorConstructor~~](type-aliases/APIErrorConstructor.md)
+- [APIErrorSubclassOptions](type-aliases/APIErrorSubclassOptions.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)

package/src/docs/versioned/0.28.0/reference/generated/api/classes/APIError.md

@@ -0,0 +1,144 @@
+APIError is a simple way to throw an error in an API route and control what is shown and the
+HTTP code displayed. It follows the JSONAPI spec to standardize the fields,
+allowing the UI to show more consistent, better error messages.
+
+It uses the standard `Error` fields the way external tools (e.g. Sentry) expect:
+- `message` is exactly `title` — a stable, human-readable summary of the problem type.
+- `name` is the error type, derived from the subclass name, `code`, or `status`
+  (e.g. a 404 becomes "NotFoundError").
+- `cause` holds the wrapped original error, so linked exceptions keep their own stack.
+
+```ts
+ throw new APIError({
+   title: "Only an admin can update that!",
+   status: 403,
+   code: "update-admin-error",
+   detail: "You must be an admin to change that field"
+ });
+```
+
+## Extends
+
+- `Error`
+
+## Extended by
+
+- [`BadRequestError`](BadRequestError.md)
+- [`UnauthorizedError`](UnauthorizedError.md)
+- [`ForbiddenError`](ForbiddenError.md)
+- [`NotFoundError`](NotFoundError.md)
+- [`ConflictError`](ConflictError.md)
+- [`ValidationError`](ValidationError.md)
+- [`InternalServerError`](InternalServerError.md)
+
+## Constructors
+
+### Constructor
+
+> **new APIError**(`options`): `APIError`
+
+#### Parameters
+
+##### options
+
+[`APIErrorOptions`](../interfaces/APIErrorOptions.md)
+
+#### Returns
+
+`APIError`
+
+#### Overrides
+
+`Error.constructor`
+
+## Properties
+
+### code
+
+> **code**: `string` \| `undefined`
+
+***
+
+### detail
+
+> **detail**: `string` \| `undefined`
+
+***
+
+### disableExternalErrorTracking?
+
+> `optional` **disableExternalErrorTracking?**: `boolean`
+
+***
+
+### id
+
+> **id**: `string` \| `undefined`
+
+***
+
+### isTerrenoAPIError
+
+> `readonly` **isTerrenoAPIError**: `true` = `true`
+
+***
+
+### links
+
+> **links**: \{ `about?`: `string`; `type?`: `string`; \} \| `undefined`
+
+***
+
+### meta
+
+> **meta**: \{\[`id`: `string`\]: `unknown`; \} \| `undefined`
+
+***
+
+### source
+
+> **source**: \{ `header?`: `string`; `parameter?`: `string`; `pointer?`: `string`; \} \| `undefined`
+
+***
+
+### status
+
+> **status**: `number`
+
+## Accessors
+
+### error
+
+#### Get Signature
+
+> **get** **error**(): `unknown`
+
+##### Deprecated
+
+Use the standard `cause` field instead.
+
+##### Returns
+
+`unknown`
+
+***
+
+### title
+
+#### Get Signature
+
+> **get** **title**(): `string`
+
+##### Returns
+
+`string`
+
+## Methods
+
+### toJSON()
+
+> **toJSON**(): [`APIErrorBody`](../interfaces/APIErrorBody.md)
+
+#### Returns
+
+[`APIErrorBody`](../interfaces/APIErrorBody.md)