@terreno/mcp 0.23.0 → 0.24.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (1015) hide show
  1. package/dist/docs/versioned/0.23.0/README.md +29 -0
  2. package/dist/docs/versioned/0.23.0/explanation/README.md +13 -0
  3. package/dist/docs/versioned/0.23.0/explanation/ai-workflows.md +270 -0
  4. package/dist/docs/versioned/0.23.0/explanation/authentication.md +438 -0
  5. package/dist/docs/versioned/0.23.0/explanation/configuration-system.md +428 -0
  6. package/dist/docs/versioned/0.23.0/explanation/dependency-management.md +192 -0
  7. package/dist/docs/versioned/0.23.0/explanation/gcp-hosting-architecture.md +319 -0
  8. package/dist/docs/versioned/0.23.0/explanation/model-router-actions.md +156 -0
  9. package/dist/docs/versioned/0.23.0/explanation/modular-api-design.md +228 -0
  10. package/dist/docs/versioned/0.23.0/how-to/README.md +20 -0
  11. package/dist/docs/versioned/0.23.0/how-to/add-feature-flags.md +115 -0
  12. package/dist/docs/versioned/0.23.0/how-to/add-github-oauth.md +316 -0
  13. package/dist/docs/versioned/0.23.0/how-to/configure-better-auth.md +296 -0
  14. package/dist/docs/versioned/0.23.0/how-to/create-a-model.md +165 -0
  15. package/dist/docs/versioned/0.23.0/how-to/deploy-to-gcp.md +244 -0
  16. package/dist/docs/versioned/0.23.0/how-to/upgrade-banner.md +172 -0
  17. package/dist/docs/versioned/0.23.0/how-to/websocket-integration.md +416 -0
  18. package/dist/docs/versioned/0.23.0/implementationPlans/IP_TEMPLATE.md +47 -0
  19. package/dist/docs/versioned/0.23.0/implementationPlans/ModularAPI.md +844 -0
  20. package/dist/docs/versioned/0.23.0/implementationPlans/PLAN_INDEX.md +21 -0
  21. package/dist/docs/versioned/0.23.0/implementationPlans/README.md +42 -0
  22. package/dist/docs/versioned/0.23.0/implementationPlans/admin-improvements.md +577 -0
  23. package/dist/docs/versioned/0.23.0/implementationPlans/admin-only-research.md +258 -0
  24. package/dist/docs/versioned/0.23.0/implementationPlans/admin-only.md +616 -0
  25. package/dist/docs/versioned/0.23.0/implementationPlans/admin-script-runner.md +107 -0
  26. package/dist/docs/versioned/0.23.0/implementationPlans/admin-ui-v2-django-parity.md +204 -0
  27. package/dist/docs/versioned/0.23.0/implementationPlans/consent-forms.md +417 -0
  28. package/dist/docs/versioned/0.23.0/implementationPlans/design-blend-skill.md +188 -0
  29. package/dist/docs/versioned/0.23.0/implementationPlans/docs-site-and-versioning.md +138 -0
  30. package/dist/docs/versioned/0.23.0/implementationPlans/feature-flags-openfeature.md +545 -0
  31. package/dist/docs/versioned/0.23.0/implementationPlans/feature-flags.md +310 -0
  32. package/dist/docs/versioned/0.23.0/implementationPlans/mcp-boost-parity.md +246 -0
  33. package/dist/docs/versioned/0.23.0/implementationPlans/model-router-actions.md +639 -0
  34. package/dist/docs/versioned/0.23.0/implementationPlans/model-router-mcp.md +186 -0
  35. package/dist/docs/versioned/0.23.0/implementationPlans/offline-mode.md +311 -0
  36. package/dist/docs/versioned/0.23.0/implementationPlans/syncdb-local-first.md +591 -0
  37. package/dist/docs/versioned/0.23.0/implementationPlans/terreno-langfuse-integration.md +145 -0
  38. package/dist/docs/versioned/0.23.0/implementationPlans/upgrade-banner.md +275 -0
  39. package/dist/docs/versioned/0.23.0/reference/README.md +22 -0
  40. package/dist/docs/versioned/0.23.0/reference/admin-backend.md +122 -0
  41. package/dist/docs/versioned/0.23.0/reference/admin-frontend.md +205 -0
  42. package/dist/docs/versioned/0.23.0/reference/api-health.md +81 -0
  43. package/dist/docs/versioned/0.23.0/reference/api.md +1205 -0
  44. package/dist/docs/versioned/0.23.0/reference/components/README.mdx +65 -0
  45. package/dist/docs/versioned/0.23.0/reference/components/accordion.mdx +37 -0
  46. package/dist/docs/versioned/0.23.0/reference/components/addressfield.mdx +26 -0
  47. package/dist/docs/versioned/0.23.0/reference/components/ai-suggestion-box.mdx +26 -0
  48. package/dist/docs/versioned/0.23.0/reference/components/avatar.mdx +35 -0
  49. package/dist/docs/versioned/0.23.0/reference/components/badge.mdx +38 -0
  50. package/dist/docs/versioned/0.23.0/reference/components/banner.mdx +26 -0
  51. package/dist/docs/versioned/0.23.0/reference/components/boolean-field.mdx +36 -0
  52. package/dist/docs/versioned/0.23.0/reference/components/box.mdx +26 -0
  53. package/dist/docs/versioned/0.23.0/reference/components/button.mdx +44 -0
  54. package/dist/docs/versioned/0.23.0/reference/components/card.mdx +26 -0
  55. package/dist/docs/versioned/0.23.0/reference/components/checkbox.mdx +30 -0
  56. package/dist/docs/versioned/0.23.0/reference/components/consentformscreen.mdx +26 -0
  57. package/dist/docs/versioned/0.23.0/reference/components/custom-select-field.mdx +36 -0
  58. package/dist/docs/versioned/0.23.0/reference/components/datatable.mdx +44 -0
  59. package/dist/docs/versioned/0.23.0/reference/components/date-time-field.mdx +49 -0
  60. package/dist/docs/versioned/0.23.0/reference/components/email-field.mdx +43 -0
  61. package/dist/docs/versioned/0.23.0/reference/components/emoji-selector.mdx +26 -0
  62. package/dist/docs/versioned/0.23.0/reference/components/field.mdx +26 -0
  63. package/dist/docs/versioned/0.23.0/reference/components/height-field.mdx +45 -0
  64. package/dist/docs/versioned/0.23.0/reference/components/icon.mdx +31 -0
  65. package/dist/docs/versioned/0.23.0/reference/components/iconbutton.mdx +42 -0
  66. package/dist/docs/versioned/0.23.0/reference/components/inner-modal-content.mdx +41 -0
  67. package/dist/docs/versioned/0.23.0/reference/components/markdown-editor-field.mdx +50 -0
  68. package/dist/docs/versioned/0.23.0/reference/components/markdownview.mdx +37 -0
  69. package/dist/docs/versioned/0.23.0/reference/components/multiselect-field.mdx +36 -0
  70. package/dist/docs/versioned/0.23.0/reference/components/number-field.mdx +46 -0
  71. package/dist/docs/versioned/0.23.0/reference/components/page.mdx +46 -0
  72. package/dist/docs/versioned/0.23.0/reference/components/pagination.mdx +30 -0
  73. package/dist/docs/versioned/0.23.0/reference/components/password-field.mdx +26 -0
  74. package/dist/docs/versioned/0.23.0/reference/components/phone-number-field.mdx +44 -0
  75. package/dist/docs/versioned/0.23.0/reference/components/radio-field.mdx +31 -0
  76. package/dist/docs/versioned/0.23.0/reference/components/sectiondivider.mdx +26 -0
  77. package/dist/docs/versioned/0.23.0/reference/components/segmented-control.mdx +34 -0
  78. package/dist/docs/versioned/0.23.0/reference/components/select-field.mdx +26 -0
  79. package/dist/docs/versioned/0.23.0/reference/components/selectbadge.mdx +35 -0
  80. package/dist/docs/versioned/0.23.0/reference/components/side-drawer.mdx +34 -0
  81. package/dist/docs/versioned/0.23.0/reference/components/sidebar-navigation-non-expo.mdx +35 -0
  82. package/dist/docs/versioned/0.23.0/reference/components/signature-field.mdx +35 -0
  83. package/dist/docs/versioned/0.23.0/reference/components/slider.mdx +43 -0
  84. package/dist/docs/versioned/0.23.0/reference/components/spinner.mdx +29 -0
  85. package/dist/docs/versioned/0.23.0/reference/components/table-badge.mdx +32 -0
  86. package/dist/docs/versioned/0.23.0/reference/components/table-boolean.mdx +29 -0
  87. package/dist/docs/versioned/0.23.0/reference/components/table-date.mdx +30 -0
  88. package/dist/docs/versioned/0.23.0/reference/components/table-icon-button.mdx +28 -0
  89. package/dist/docs/versioned/0.23.0/reference/components/table-number.mdx +30 -0
  90. package/dist/docs/versioned/0.23.0/reference/components/table-text.mdx +30 -0
  91. package/dist/docs/versioned/0.23.0/reference/components/table-title.mdx +28 -0
  92. package/dist/docs/versioned/0.23.0/reference/components/table.mdx +38 -0
  93. package/dist/docs/versioned/0.23.0/reference/components/tap-to-edit.mdx +26 -0
  94. package/dist/docs/versioned/0.23.0/reference/components/text-area.mdx +50 -0
  95. package/dist/docs/versioned/0.23.0/reference/components/text-field.mdx +52 -0
  96. package/dist/docs/versioned/0.23.0/reference/components/theme.mdx +26 -0
  97. package/dist/docs/versioned/0.23.0/reference/components/toast.mdx +26 -0
  98. package/dist/docs/versioned/0.23.0/reference/components/tooltip.mdx +30 -0
  99. package/dist/docs/versioned/0.23.0/reference/components/userinactivity.mdx +32 -0
  100. package/dist/docs/versioned/0.23.0/reference/environment-variables.md +382 -0
  101. package/dist/docs/versioned/0.23.0/reference/feature-flags.md +304 -0
  102. package/dist/docs/versioned/0.23.0/reference/generated/README.md +17 -0
  103. package/dist/docs/versioned/0.23.0/reference/generated/api/README.md +282 -0
  104. package/dist/docs/versioned/0.23.0/reference/generated/api/classes/APIError.md +96 -0
  105. package/dist/docs/versioned/0.23.0/reference/generated/api/classes/BetterAuthApp.md +84 -0
  106. package/dist/docs/versioned/0.23.0/reference/generated/api/classes/CachingSecretProvider.md +118 -0
  107. package/dist/docs/versioned/0.23.0/reference/generated/api/classes/CompositeSecretProvider.md +79 -0
  108. package/dist/docs/versioned/0.23.0/reference/generated/api/classes/ConfigurationApp.md +94 -0
  109. package/dist/docs/versioned/0.23.0/reference/generated/api/classes/ConsentApp.md +74 -0
  110. package/dist/docs/versioned/0.23.0/reference/generated/api/classes/DateOnly.md +123 -0
  111. package/dist/docs/versioned/0.23.0/reference/generated/api/classes/EnvSecretProvider.md +64 -0
  112. package/dist/docs/versioned/0.23.0/reference/generated/api/classes/GcpSecretProvider.md +76 -0
  113. package/dist/docs/versioned/0.23.0/reference/generated/api/classes/OpenApiMiddlewareBuilder.md +577 -0
  114. package/dist/docs/versioned/0.23.0/reference/generated/api/classes/RealtimeApp.md +112 -0
  115. package/dist/docs/versioned/0.23.0/reference/generated/api/classes/TaskCancelledError.md +23 -0
  116. package/dist/docs/versioned/0.23.0/reference/generated/api/classes/TerrenoApp.md +262 -0
  117. package/dist/docs/versioned/0.23.0/reference/generated/api/classes/VersionCheckPlugin.md +43 -0
  118. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/AdminOwnerTransformer.md +47 -0
  119. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/OwnerQueryFilter.md +11 -0
  120. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/addAuthRoutes.md +19 -0
  121. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/addGitHubAuthRoutes.md +31 -0
  122. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/addMeRoutes.md +19 -0
  123. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/addPopulateToQuery.md +15 -0
  124. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/addQuerySubscription.md +26 -0
  125. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/apiErrorMiddleware.md +23 -0
  126. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/apiFallthroughErrorMiddleware.md +26 -0
  127. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/apiUnauthorizedMiddleware.md +23 -0
  128. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/applyRequestContextToSentry.md +11 -0
  129. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/assertNoActionCollisions.md +21 -0
  130. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/asyncHandler.md +15 -0
  131. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/authenticateMiddleware.md +11 -0
  132. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/baseUserPlugin.md +11 -0
  133. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/buildQuerySchemaFromFields.md +30 -0
  134. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/checkModelsStrict.md +21 -0
  135. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/checkPermissions.md +29 -0
  136. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/clearQueryStore.md +7 -0
  137. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/clearRealtimeRegistry.md +7 -0
  138. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/computeQueryId.md +18 -0
  139. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/configurationPlugin.md +48 -0
  140. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/configureOpenApiValidator.md +28 -0
  141. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/createActionOpenApiMiddleware.md +35 -0
  142. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/createBetterAuth.md +13 -0
  143. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/createBetterAuthSessionMiddleware.md +18 -0
  144. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/createFeatureFlaggedLogger.md +53 -0
  145. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/createModelValidators.md +74 -0
  146. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/createOpenApiBuilder.md +39 -0
  147. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/createRouter.md +19 -0
  148. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/createRouterWithAuth.md +19 -0
  149. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/createScopedLogger.md +53 -0
  150. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/createScriptArgs.md +33 -0
  151. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/createValidator.md +29 -0
  152. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/createdUpdatedPlugin.md +11 -0
  153. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/cronjob.md +19 -0
  154. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/defaultResponseHandler.md +32 -0
  155. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/defineCollectionAction.md +25 -0
  156. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/defineInstanceAction.md +29 -0
  157. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/envConfigurationPlugin.md +11 -0
  158. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/errorMessage.md +13 -0
  159. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/errorStack.md +13 -0
  160. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/errorsPlugin.md +11 -0
  161. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/findExactlyOne.md +25 -0
  162. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/findOneOrNone.md +24 -0
  163. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/findOneOrNoneFor.md +37 -0
  164. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/findRegistryEntryByCollection.md +13 -0
  165. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/findRegistryEntryByRoutePath.md +13 -0
  166. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/firebaseJWTPlugin.md +11 -0
  167. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/fixMixedFields.md +21 -0
  168. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/flattenToDotPaths.md +24 -0
  169. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/formatLogContextSuffix.md +17 -0
  170. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/generateTokens.md +35 -0
  171. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/getAPIErrorBody.md +11 -0
  172. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/getBetterAuthSession.md +13 -0
  173. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/getCurrentLogContext.md +9 -0
  174. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/getCurrentRequestContext.md +8 -0
  175. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/getCurrentRequestContextAttributes.md +15 -0
  176. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/getDisableExternalErrorTracking.md +15 -0
  177. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/getMongoClientFromMongoose.md +7 -0
  178. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/getOpenApiSpecForModel.md +29 -0
  179. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/getOpenApiValidatorConfig.md +7 -0
  180. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/getQuerySubscriptionsForCollection.md +14 -0
  181. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/getRealtimeRegistry.md +7 -0
  182. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/getRequestContextFromAttributes.md +11 -0
  183. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/getSchemaFromModel.md +25 -0
  184. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/getSessionIdFromJwtPayload.md +11 -0
  185. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/githubUserPlugin.md +22 -0
  186. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/hasBetterAuthSession.md +13 -0
  187. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/installRealtimeSocketHandlers.md +27 -0
  188. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/isAPIError.md +11 -0
  189. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/isDeletedPlugin.md +15 -0
  190. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/isDisabledPlugin.md +15 -0
  191. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/isOpenApiValidatorConfigured.md +8 -0
  192. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/isValidObjectId.md +11 -0
  193. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/jsonResponseRequestIdMiddleware.md +24 -0
  194. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/logRequests.md +19 -0
  195. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/matchesQuery.md +23 -0
  196. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/modelRouter.md +83 -0
  197. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/mongooseErrorToAPIError.md +13 -0
  198. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/mountBetterAuthRoutes.md +21 -0
  199. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/openApiCompatMiddleware.md +22 -0
  200. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/openApiEtagMiddleware.md +23 -0
  201. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/parseScriptArgs.md +35 -0
  202. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/patchAppUse.md +17 -0
  203. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/permissionMiddleware.md +21 -0
  204. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/registerActionRoutes.md +25 -0
  205. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/registerRealtime.md +14 -0
  206. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/removeAllSocketQueries.md +13 -0
  207. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/removeQuerySubscription.md +17 -0
  208. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/requestContextMiddleware.md +26 -0
  209. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/resetOpenApiValidatorConfig.md +9 -0
  210. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/runActionPermissions.md +33 -0
  211. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/runWithRequestContext.md +38 -0
  212. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/runWithRequestContextAttributes.md +25 -0
  213. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/sendToGoogleChat.md +25 -0
  214. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/sendToSlack.md +29 -0
  215. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/sendToZoom.md +67 -0
  216. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/sentryAppVersionMiddleware.md +26 -0
  217. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/serialize.md +25 -0
  218. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/setRequestContext.md +11 -0
  219. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/setupAuth.md +15 -0
  220. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/setupBetterAuthUserSync.md +21 -0
  221. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/setupEnvironment.md +5 -0
  222. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/setupGitHubAuth.md +22 -0
  223. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/setupLogging.md +11 -0
  224. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/signupUser.md +23 -0
  225. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/startChangeStreamWatcher.md +21 -0
  226. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/stopChangeStreamWatcher.md +7 -0
  227. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/syncBetterAuthUser.md +19 -0
  228. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/syncConsents.md +45 -0
  229. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/timeout.md +11 -0
  230. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/transform.md +29 -0
  231. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/unpopulate.md +21 -0
  232. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/updateRequestContextFromRequest.md +15 -0
  233. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/upsertPlugin.md +23 -0
  234. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/validateActionRequest.md +35 -0
  235. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/validateModelRequestBody.md +30 -0
  236. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/validateQueryParams.md +23 -0
  237. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/validateRequestBody.md +26 -0
  238. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/validateResponseData.md +32 -0
  239. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/wrapActionResponse.md +19 -0
  240. package/dist/docs/versioned/0.23.0/reference/generated/api/functions/wrapScript.md +15 -0
  241. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/APIErrorConstructor.md +93 -0
  242. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/ActionContext.md +49 -0
  243. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/AsyncHandlerOptions.md +32 -0
  244. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/AuthOptions.md +47 -0
  245. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/BackgroundTaskDocument.md +141 -0
  246. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/BackgroundTaskMethods.md +55 -0
  247. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/BackgroundTaskModel.md +51 -0
  248. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/BackgroundTaskStatics.md +19 -0
  249. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/BaseUser.md +11 -0
  250. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/BetterAuthAppOptions.md +11 -0
  251. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/BetterAuthConfig.md +74 -0
  252. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/BetterAuthOAuthProvider.md +13 -0
  253. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/BetterAuthSession.md +43 -0
  254. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/BetterAuthSessionData.md +13 -0
  255. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/BetterAuthUser.md +43 -0
  256. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/CachingSecretProviderOptions.md +9 -0
  257. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/ChangeStreamConfig.md +41 -0
  258. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/CollectionActionConfig.md +123 -0
  259. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/ConfigRegistration.md +23 -0
  260. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/ConfigurationAppOptions.md +51 -0
  261. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/ConfigurationMetaResponse.md +7 -0
  262. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/ConfigurationModel.md +166 -0
  263. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/ConfigurationPermissions.md +45 -0
  264. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/ConfigurationPluginOptions.md +30 -0
  265. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/ConfigurationStatics.md +107 -0
  266. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/ConsentAppOptions.md +85 -0
  267. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/ConsentFormCheckbox.md +17 -0
  268. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/ConsentFormDefinition.md +83 -0
  269. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/ConsentFormDocument.md +123 -0
  270. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/ConsentFormModel.md +79 -0
  271. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/ConsentFormStatics.md +55 -0
  272. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/ConsentResponseDocument.md +105 -0
  273. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/ConsentResponseMethods.md +1 -0
  274. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/ConsentResponseModel.md +79 -0
  275. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/ConsentResponseStatics.md +55 -0
  276. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/CreateBetterAuthOptions.md +17 -0
  277. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/CreateFeatureFlaggedLoggerOptions.md +29 -0
  278. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/CreateScopedLoggerOptions.md +18 -0
  279. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/CreateValidatorOptions.md +25 -0
  280. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/CreatedDeleted.md +27 -0
  281. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/DocumentSubscription.md +17 -0
  282. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/FindExactlyOnePlugin.md +30 -0
  283. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/FindOneOrNonePlugin.md +30 -0
  284. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/GcpSecretProviderOptions.md +9 -0
  285. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/GenerateTokensOptions.md +5 -0
  286. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/GitHubAuthOptions.md +74 -0
  287. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/GitHubUserFields.md +33 -0
  288. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/HasUpsert.md +27 -0
  289. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/InstanceActionConfig.md +127 -0
  290. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/IsDeleted.md +7 -0
  291. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/JSONArray.md +7 -0
  292. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/JSONObject.md +3 -0
  293. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/JwtSessionPayload.md +19 -0
  294. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/LogContextFields.md +41 -0
  295. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/LoggingOptions.md +73 -0
  296. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/ModelRouterOptions.md +524 -0
  297. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/ModelRouterRegistration.md +33 -0
  298. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/ModelRouterValidationOptions.md +89 -0
  299. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/MongoClientLike.md +11 -0
  300. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/OpenApiBuildResult.md +34 -0
  301. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/OpenApiMiddleware.md +98 -0
  302. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/OpenApiParameter.md +66 -0
  303. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/OpenApiResponse.md +43 -0
  304. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/OpenApiSchema.md +62 -0
  305. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/OpenApiSchemaProperty.md +89 -0
  306. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/OpenApiValidatorConfig.md +94 -0
  307. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/PopulatePath.md +17 -0
  308. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/QuerySubscription.md +25 -0
  309. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/QueryValidatorOptions.md +31 -0
  310. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/RESTPermissions.md +35 -0
  311. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/RealtimeAppOptions.md +62 -0
  312. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/RealtimeConfig.md +44 -0
  313. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/RealtimeEvent.md +57 -0
  314. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/RealtimeRegistryEntry.md +41 -0
  315. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/RealtimeSocketLike.md +94 -0
  316. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/RequestBodyValidatorOptions.md +71 -0
  317. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/RequestContext.md +59 -0
  318. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/ScopedLogger.md +100 -0
  319. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/ScriptArgDef.md +60 -0
  320. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/ScriptArgs.md +121 -0
  321. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/ScriptContext.md +67 -0
  322. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/ScriptResult.md +11 -0
  323. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/SecretFieldMeta.md +29 -0
  324. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/SecretProvider.md +35 -0
  325. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/SyncConsentsOptions.md +15 -0
  326. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/SyncConsentsResult.md +23 -0
  327. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/TerrenoAppOptions.md +112 -0
  328. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/TerrenoPlugin.md +78 -0
  329. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/TerrenoRequestLogEntry.md +13 -0
  330. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/TerrenoTransformer.md +49 -0
  331. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/User.md +26 -0
  332. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/UserModel.md +113 -0
  333. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/VersionCheckResponse.md +37 -0
  334. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/VersionConfigDocument.md +65 -0
  335. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/VersionConfigModel.md +51 -0
  336. package/dist/docs/versioned/0.23.0/reference/generated/api/interfaces/WrapScriptOptions.md +27 -0
  337. package/dist/docs/versioned/0.23.0/reference/generated/api/type-aliases/AddRoutes.md +15 -0
  338. package/dist/docs/versioned/0.23.0/reference/generated/api/type-aliases/AuthProvider.md +5 -0
  339. package/dist/docs/versioned/0.23.0/reference/generated/api/type-aliases/BetterAuthInstance.md +3 -0
  340. package/dist/docs/versioned/0.23.0/reference/generated/api/type-aliases/ConfigType.md +1 -0
  341. package/dist/docs/versioned/0.23.0/reference/generated/api/type-aliases/ConfigurationPostUpdateHook.md +24 -0
  342. package/dist/docs/versioned/0.23.0/reference/generated/api/type-aliases/ConfigurationPreUpdateHook.md +20 -0
  343. package/dist/docs/versioned/0.23.0/reference/generated/api/type-aliases/ConsentFormMethods.md +1 -0
  344. package/dist/docs/versioned/0.23.0/reference/generated/api/type-aliases/ConsentFormType.md +1 -0
  345. package/dist/docs/versioned/0.23.0/reference/generated/api/type-aliases/DeepPartial.md +9 -0
  346. package/dist/docs/versioned/0.23.0/reference/generated/api/type-aliases/GooseRESTOptions.md +7 -0
  347. package/dist/docs/versioned/0.23.0/reference/generated/api/type-aliases/JSONPrimitive.md +1 -0
  348. package/dist/docs/versioned/0.23.0/reference/generated/api/type-aliases/JSONValue.md +1 -0
  349. package/dist/docs/versioned/0.23.0/reference/generated/api/type-aliases/PathValue.md +19 -0
  350. package/dist/docs/versioned/0.23.0/reference/generated/api/type-aliases/Paths.md +15 -0
  351. package/dist/docs/versioned/0.23.0/reference/generated/api/type-aliases/PermissionMethod.md +25 -0
  352. package/dist/docs/versioned/0.23.0/reference/generated/api/type-aliases/RESTMethod.md +17 -0
  353. package/dist/docs/versioned/0.23.0/reference/generated/api/type-aliases/RequestContextAttributes.md +1 -0
  354. package/dist/docs/versioned/0.23.0/reference/generated/api/type-aliases/ScriptArgValue.md +3 -0
  355. package/dist/docs/versioned/0.23.0/reference/generated/api/type-aliases/ScriptRunner.md +15 -0
  356. package/dist/docs/versioned/0.23.0/reference/generated/api/type-aliases/VersionCheckStatus.md +1 -0
  357. package/dist/docs/versioned/0.23.0/reference/generated/api/variables/ACTION_NAME_PATTERN.md +1 -0
  358. package/dist/docs/versioned/0.23.0/reference/generated/api/variables/BackgroundTask.md +1 -0
  359. package/dist/docs/versioned/0.23.0/reference/generated/api/variables/Config.md +244 -0
  360. package/dist/docs/versioned/0.23.0/reference/generated/api/variables/ConsentForm.md +1 -0
  361. package/dist/docs/versioned/0.23.0/reference/generated/api/variables/ConsentResponse.md +1 -0
  362. package/dist/docs/versioned/0.23.0/reference/generated/api/variables/MAX_DOCUMENT_SUBSCRIPTIONS.md +1 -0
  363. package/dist/docs/versioned/0.23.0/reference/generated/api/variables/MAX_MODEL_SUBSCRIPTIONS.md +4 -0
  364. package/dist/docs/versioned/0.23.0/reference/generated/api/variables/MAX_QUERY_SUBSCRIPTIONS.md +1 -0
  365. package/dist/docs/versioned/0.23.0/reference/generated/api/variables/Permissions.md +109 -0
  366. package/dist/docs/versioned/0.23.0/reference/generated/api/variables/REQUEST_CONTEXT_ATTRIBUTE_NAMES.md +39 -0
  367. package/dist/docs/versioned/0.23.0/reference/generated/api/variables/VersionConfig.md +1 -0
  368. package/dist/docs/versioned/0.23.0/reference/generated/api/variables/consentResponsePopulatePaths.md +3 -0
  369. package/dist/docs/versioned/0.23.0/reference/generated/api/variables/gooseRestRouter.md +85 -0
  370. package/dist/docs/versioned/0.23.0/reference/generated/api/variables/logger.md +109 -0
  371. package/dist/docs/versioned/0.23.0/reference/generated/api/variables/winstonLogger.md +1 -0
  372. package/dist/docs/versioned/0.23.0/reference/generated/rtk/README.md +126 -0
  373. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/buildOptimisticCreateItem.md +17 -0
  374. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/configureOfflineMutationEndpoints.md +13 -0
  375. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/createBetterAuthClient.md +30 -0
  376. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/createOfflineMiddleware.md +41 -0
  377. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/createSessionApi.md +21 -0
  378. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/createStorageAdapter.md +17 -0
  379. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/generateAuthSlice.md +35 -0
  380. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/generateBetterAuthSlice.md +87 -0
  381. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/generateProfileEndpoints.md +35 -0
  382. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/generateTags.md +15 -0
  383. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/getAuthToken.md +5 -0
  384. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/getBaseQuery.md +23 -0
  385. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/getFriendlyExpirationInfo.md +5 -0
  386. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/getRealtimeSocket.md +7 -0
  387. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/getTokenExpirationTimes.md +5 -0
  388. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/isNetworkFetchError.md +14 -0
  389. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/isWebsocketsDebugEnabled.md +5 -0
  390. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/logAuth.md +11 -0
  391. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/logSocket.md +15 -0
  392. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/populateId.md +23 -0
  393. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/realtimeDocument.md +37 -0
  394. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/realtimeList.md +43 -0
  395. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/refreshAuthToken.md +5 -0
  396. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/registerTerrenoDevStore.md +14 -0
  397. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/resolveBaseUrls.md +28 -0
  398. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/resolveFeatureFlagsOptions.md +14 -0
  399. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/selectBetterAuthError.md +13 -0
  400. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/selectBetterAuthIsAuthenticated.md +13 -0
  401. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/selectBetterAuthIsLoading.md +13 -0
  402. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/selectBetterAuthState.md +13 -0
  403. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/selectBetterAuthUser.md +13 -0
  404. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/selectBetterAuthUserId.md +13 -0
  405. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/selectConflicts.md +13 -0
  406. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/selectCurrentUserId.md +11 -0
  407. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/selectIsAuthenticating.md +11 -0
  408. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/selectIsOnline.md +13 -0
  409. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/selectIsOnlineSafe.md +15 -0
  410. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/selectIsSyncing.md +13 -0
  411. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/selectLastTokenRefreshTimestamp.md +11 -0
  412. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/selectOfflineQueue.md +13 -0
  413. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/selectQueueLength.md +13 -0
  414. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/setRealtimeDebug.md +13 -0
  415. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/setRealtimeSocket.md +27 -0
  416. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/shouldDeferOfflineMutation.md +18 -0
  417. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/shouldReplayQueuedMutation.md +18 -0
  418. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/shouldShowStillThereModal.md +5 -0
  419. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/useFeatureFlags.md +15 -0
  420. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/useOfflineStatus.md +16 -0
  421. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/useRealtimeDebug.md +18 -0
  422. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/useSelectCurrentUserId.md +5 -0
  423. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/useSelectIsAuthenticating.md +5 -0
  424. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/useServerStatus.md +26 -0
  425. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/useSocketConnection.md +19 -0
  426. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/useSyncConnection.md +32 -0
  427. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/useTerrenoFeatureFlags.md +19 -0
  428. package/dist/docs/versioned/0.23.0/reference/generated/rtk/functions/useUpgradeCheck.md +30 -0
  429. package/dist/docs/versioned/0.23.0/reference/generated/rtk/interfaces/BaseUrls.md +17 -0
  430. package/dist/docs/versioned/0.23.0/reference/generated/rtk/interfaces/BetterAuthClientConfig.md +31 -0
  431. package/dist/docs/versioned/0.23.0/reference/generated/rtk/interfaces/BetterAuthClientInterface.md +23 -0
  432. package/dist/docs/versioned/0.23.0/reference/generated/rtk/interfaces/BetterAuthSession.md +43 -0
  433. package/dist/docs/versioned/0.23.0/reference/generated/rtk/interfaces/BetterAuthSessionData.md +13 -0
  434. package/dist/docs/versioned/0.23.0/reference/generated/rtk/interfaces/BetterAuthState.md +49 -0
  435. package/dist/docs/versioned/0.23.0/reference/generated/rtk/interfaces/BetterAuthUser.md +43 -0
  436. package/dist/docs/versioned/0.23.0/reference/generated/rtk/interfaces/ConflictRecord.md +47 -0
  437. package/dist/docs/versioned/0.23.0/reference/generated/rtk/interfaces/EmailSignupRequest.md +15 -0
  438. package/dist/docs/versioned/0.23.0/reference/generated/rtk/interfaces/ExpoConstantsShape.md +29 -0
  439. package/dist/docs/versioned/0.23.0/reference/generated/rtk/interfaces/GenerateBetterAuthSliceConfig.md +23 -0
  440. package/dist/docs/versioned/0.23.0/reference/generated/rtk/interfaces/GoogleLoginRequest.md +5 -0
  441. package/dist/docs/versioned/0.23.0/reference/generated/rtk/interfaces/ListResponse.md +35 -0
  442. package/dist/docs/versioned/0.23.0/reference/generated/rtk/interfaces/OfflineMiddlewareConfig.md +15 -0
  443. package/dist/docs/versioned/0.23.0/reference/generated/rtk/interfaces/OfflineState.md +23 -0
  444. package/dist/docs/versioned/0.23.0/reference/generated/rtk/interfaces/OfflineStatus.md +87 -0
  445. package/dist/docs/versioned/0.23.0/reference/generated/rtk/interfaces/QueuedMutation.md +55 -0
  446. package/dist/docs/versioned/0.23.0/reference/generated/rtk/interfaces/RealtimeEvent.md +58 -0
  447. package/dist/docs/versioned/0.23.0/reference/generated/rtk/interfaces/ResetPasswordRequest.md +15 -0
  448. package/dist/docs/versioned/0.23.0/reference/generated/rtk/interfaces/ServerStatusOptions.md +31 -0
  449. package/dist/docs/versioned/0.23.0/reference/generated/rtk/interfaces/SocketConnection.md +11 -0
  450. package/dist/docs/versioned/0.23.0/reference/generated/rtk/interfaces/StorageAdapter.md +53 -0
  451. package/dist/docs/versioned/0.23.0/reference/generated/rtk/interfaces/TerrenoFlagDefinition.md +19 -0
  452. package/dist/docs/versioned/0.23.0/reference/generated/rtk/interfaces/UseFeatureFlagsOptions.md +50 -0
  453. package/dist/docs/versioned/0.23.0/reference/generated/rtk/interfaces/UseSocketConnectionOptions.md +87 -0
  454. package/dist/docs/versioned/0.23.0/reference/generated/rtk/interfaces/UseTerrenoFeatureFlagsOptions.md +41 -0
  455. package/dist/docs/versioned/0.23.0/reference/generated/rtk/interfaces/UseTerrenoFeatureFlagsResult.md +33 -0
  456. package/dist/docs/versioned/0.23.0/reference/generated/rtk/interfaces/UserResponse.md +17 -0
  457. package/dist/docs/versioned/0.23.0/reference/generated/rtk/interfaces/VersionCheckResponse.md +39 -0
  458. package/dist/docs/versioned/0.23.0/reference/generated/rtk/type-aliases/BetterAuthClient.md +3 -0
  459. package/dist/docs/versioned/0.23.0/reference/generated/rtk/type-aliases/BetterAuthOAuthProvider.md +3 -0
  460. package/dist/docs/versioned/0.23.0/reference/generated/rtk/type-aliases/BetterAuthSlice.md +3 -0
  461. package/dist/docs/versioned/0.23.0/reference/generated/rtk/type-aliases/EmailLoginRequest.md +1 -0
  462. package/dist/docs/versioned/0.23.0/reference/generated/rtk/type-aliases/RootState.md +1 -0
  463. package/dist/docs/versioned/0.23.0/reference/generated/rtk/type-aliases/ServerStatus.md +1 -0
  464. package/dist/docs/versioned/0.23.0/reference/generated/rtk/type-aliases/TerrenoFlagConfiguration.md +1 -0
  465. package/dist/docs/versioned/0.23.0/reference/generated/rtk/variables/AUTH_DEBUG.md +1 -0
  466. package/dist/docs/versioned/0.23.0/reference/generated/rtk/variables/IsWeb.md +1 -0
  467. package/dist/docs/versioned/0.23.0/reference/generated/rtk/variables/LOGOUT_ACTION_TYPE.md +1 -0
  468. package/dist/docs/versioned/0.23.0/reference/generated/rtk/variables/SAME_ORIGIN_SENTINEL.md +5 -0
  469. package/dist/docs/versioned/0.23.0/reference/generated/rtk/variables/TOKEN_REFRESHED_SUCCESS.md +1 -0
  470. package/dist/docs/versioned/0.23.0/reference/generated/rtk/variables/addConflict.md +1 -0
  471. package/dist/docs/versioned/0.23.0/reference/generated/rtk/variables/baseTasksUrl.md +1 -0
  472. package/dist/docs/versioned/0.23.0/reference/generated/rtk/variables/baseUrl.md +1 -0
  473. package/dist/docs/versioned/0.23.0/reference/generated/rtk/variables/baseWebsocketsUrl.md +1 -0
  474. package/dist/docs/versioned/0.23.0/reference/generated/rtk/variables/clearConflicts.md +1 -0
  475. package/dist/docs/versioned/0.23.0/reference/generated/rtk/variables/clearQueue.md +1 -0
  476. package/dist/docs/versioned/0.23.0/reference/generated/rtk/variables/dequeue.md +1 -0
  477. package/dist/docs/versioned/0.23.0/reference/generated/rtk/variables/dismissConflict.md +1 -0
  478. package/dist/docs/versioned/0.23.0/reference/generated/rtk/variables/emptySplitApi.md +1 -0
  479. package/dist/docs/versioned/0.23.0/reference/generated/rtk/variables/enqueue.md +1 -0
  480. package/dist/docs/versioned/0.23.0/reference/generated/rtk/variables/offlineReducer.md +1 -0
  481. package/dist/docs/versioned/0.23.0/reference/generated/rtk/variables/offlineSlice.md +1 -0
  482. package/dist/docs/versioned/0.23.0/reference/generated/rtk/variables/selectUndismissedConflicts.md +1 -0
  483. package/dist/docs/versioned/0.23.0/reference/generated/rtk/variables/setOnlineStatus.md +1 -0
  484. package/dist/docs/versioned/0.23.0/reference/generated/rtk/variables/setSyncing.md +1 -0
  485. package/dist/docs/versioned/0.23.0/reference/generated/rtk/variables/staggeredBaseQuery.md +1 -0
  486. package/dist/docs/versioned/0.23.0/reference/generated/rtk/variables/useGetVersionCheckQuery.md +1 -0
  487. package/dist/docs/versioned/0.23.0/reference/generated/rtk/variables/useLazyGetVersionCheckQuery.md +1 -0
  488. package/dist/docs/versioned/0.23.0/reference/mcp-server.md +586 -0
  489. package/dist/docs/versioned/0.23.0/reference/rtk.md +439 -0
  490. package/dist/docs/versioned/0.23.0/reference/ui.md +418 -0
  491. package/dist/docs/versioned/0.23.0/tasks/admin-improvements.md +429 -0
  492. package/dist/docs/versioned/0.23.0/tasks/admin-only.md +221 -0
  493. package/dist/docs/versioned/0.23.0/tasks/admin-script-runner.md +50 -0
  494. package/dist/docs/versioned/0.23.0/tasks/admin-ui-v2-django-parity.md +135 -0
  495. package/dist/docs/versioned/0.23.0/tasks/consent-forms.md +193 -0
  496. package/dist/docs/versioned/0.23.0/tasks/design-blend-skill.md +147 -0
  497. package/dist/docs/versioned/0.23.0/tasks/feature-flags-openfeature.md +77 -0
  498. package/dist/docs/versioned/0.23.0/tasks/feature-flags.md +23 -0
  499. package/dist/docs/versioned/0.23.0/tasks/model-router-actions.md +46 -0
  500. package/dist/docs/versioned/0.23.0/tasks/model-router-mcp.md +105 -0
  501. package/dist/docs/versioned/0.23.0/tasks/offline-mode.md +139 -0
  502. package/dist/docs/versioned/0.23.0/tasks/syncdb-local-first.md +117 -0
  503. package/dist/docs/versioned/0.23.0/tasks/upgrade-banner.md +73 -0
  504. package/dist/docs/versioned/0.23.0/tutorials/README.md +7 -0
  505. package/dist/docs/versioned/0.23.0/tutorials/getting-started.md +44 -0
  506. package/dist/docs/versioned/next/reference/environment-variables.md +7 -3
  507. package/dist/docs/versioned/next/reference/rtk.md +11 -4
  508. package/package.json +3 -3
  509. package/src/docs/versioned/0.23.0/README.md +29 -0
  510. package/src/docs/versioned/0.23.0/explanation/README.md +13 -0
  511. package/src/docs/versioned/0.23.0/explanation/ai-workflows.md +270 -0
  512. package/src/docs/versioned/0.23.0/explanation/authentication.md +438 -0
  513. package/src/docs/versioned/0.23.0/explanation/configuration-system.md +428 -0
  514. package/src/docs/versioned/0.23.0/explanation/dependency-management.md +192 -0
  515. package/src/docs/versioned/0.23.0/explanation/gcp-hosting-architecture.md +319 -0
  516. package/src/docs/versioned/0.23.0/explanation/model-router-actions.md +156 -0
  517. package/src/docs/versioned/0.23.0/explanation/modular-api-design.md +228 -0
  518. package/src/docs/versioned/0.23.0/how-to/README.md +20 -0
  519. package/src/docs/versioned/0.23.0/how-to/add-feature-flags.md +115 -0
  520. package/src/docs/versioned/0.23.0/how-to/add-github-oauth.md +316 -0
  521. package/src/docs/versioned/0.23.0/how-to/configure-better-auth.md +296 -0
  522. package/src/docs/versioned/0.23.0/how-to/create-a-model.md +165 -0
  523. package/src/docs/versioned/0.23.0/how-to/deploy-to-gcp.md +244 -0
  524. package/src/docs/versioned/0.23.0/how-to/upgrade-banner.md +172 -0
  525. package/src/docs/versioned/0.23.0/how-to/websocket-integration.md +416 -0
  526. package/src/docs/versioned/0.23.0/implementationPlans/IP_TEMPLATE.md +47 -0
  527. package/src/docs/versioned/0.23.0/implementationPlans/ModularAPI.md +844 -0
  528. package/src/docs/versioned/0.23.0/implementationPlans/PLAN_INDEX.md +21 -0
  529. package/src/docs/versioned/0.23.0/implementationPlans/README.md +42 -0
  530. package/src/docs/versioned/0.23.0/implementationPlans/admin-improvements.md +577 -0
  531. package/src/docs/versioned/0.23.0/implementationPlans/admin-only-research.md +258 -0
  532. package/src/docs/versioned/0.23.0/implementationPlans/admin-only.md +616 -0
  533. package/src/docs/versioned/0.23.0/implementationPlans/admin-script-runner.md +107 -0
  534. package/src/docs/versioned/0.23.0/implementationPlans/admin-ui-v2-django-parity.md +204 -0
  535. package/src/docs/versioned/0.23.0/implementationPlans/consent-forms.md +417 -0
  536. package/src/docs/versioned/0.23.0/implementationPlans/design-blend-skill.md +188 -0
  537. package/src/docs/versioned/0.23.0/implementationPlans/docs-site-and-versioning.md +138 -0
  538. package/src/docs/versioned/0.23.0/implementationPlans/feature-flags-openfeature.md +545 -0
  539. package/src/docs/versioned/0.23.0/implementationPlans/feature-flags.md +310 -0
  540. package/src/docs/versioned/0.23.0/implementationPlans/mcp-boost-parity.md +246 -0
  541. package/src/docs/versioned/0.23.0/implementationPlans/model-router-actions.md +639 -0
  542. package/src/docs/versioned/0.23.0/implementationPlans/model-router-mcp.md +186 -0
  543. package/src/docs/versioned/0.23.0/implementationPlans/offline-mode.md +311 -0
  544. package/src/docs/versioned/0.23.0/implementationPlans/syncdb-local-first.md +591 -0
  545. package/src/docs/versioned/0.23.0/implementationPlans/terreno-langfuse-integration.md +145 -0
  546. package/src/docs/versioned/0.23.0/implementationPlans/upgrade-banner.md +275 -0
  547. package/src/docs/versioned/0.23.0/reference/README.md +22 -0
  548. package/src/docs/versioned/0.23.0/reference/admin-backend.md +122 -0
  549. package/src/docs/versioned/0.23.0/reference/admin-frontend.md +205 -0
  550. package/src/docs/versioned/0.23.0/reference/api-health.md +81 -0
  551. package/src/docs/versioned/0.23.0/reference/api.md +1205 -0
  552. package/src/docs/versioned/0.23.0/reference/components/README.mdx +65 -0
  553. package/src/docs/versioned/0.23.0/reference/components/accordion.mdx +37 -0
  554. package/src/docs/versioned/0.23.0/reference/components/addressfield.mdx +26 -0
  555. package/src/docs/versioned/0.23.0/reference/components/ai-suggestion-box.mdx +26 -0
  556. package/src/docs/versioned/0.23.0/reference/components/avatar.mdx +35 -0
  557. package/src/docs/versioned/0.23.0/reference/components/badge.mdx +38 -0
  558. package/src/docs/versioned/0.23.0/reference/components/banner.mdx +26 -0
  559. package/src/docs/versioned/0.23.0/reference/components/boolean-field.mdx +36 -0
  560. package/src/docs/versioned/0.23.0/reference/components/box.mdx +26 -0
  561. package/src/docs/versioned/0.23.0/reference/components/button.mdx +44 -0
  562. package/src/docs/versioned/0.23.0/reference/components/card.mdx +26 -0
  563. package/src/docs/versioned/0.23.0/reference/components/checkbox.mdx +30 -0
  564. package/src/docs/versioned/0.23.0/reference/components/consentformscreen.mdx +26 -0
  565. package/src/docs/versioned/0.23.0/reference/components/custom-select-field.mdx +36 -0
  566. package/src/docs/versioned/0.23.0/reference/components/datatable.mdx +44 -0
  567. package/src/docs/versioned/0.23.0/reference/components/date-time-field.mdx +49 -0
  568. package/src/docs/versioned/0.23.0/reference/components/email-field.mdx +43 -0
  569. package/src/docs/versioned/0.23.0/reference/components/emoji-selector.mdx +26 -0
  570. package/src/docs/versioned/0.23.0/reference/components/field.mdx +26 -0
  571. package/src/docs/versioned/0.23.0/reference/components/height-field.mdx +45 -0
  572. package/src/docs/versioned/0.23.0/reference/components/icon.mdx +31 -0
  573. package/src/docs/versioned/0.23.0/reference/components/iconbutton.mdx +42 -0
  574. package/src/docs/versioned/0.23.0/reference/components/inner-modal-content.mdx +41 -0
  575. package/src/docs/versioned/0.23.0/reference/components/markdown-editor-field.mdx +50 -0
  576. package/src/docs/versioned/0.23.0/reference/components/markdownview.mdx +37 -0
  577. package/src/docs/versioned/0.23.0/reference/components/multiselect-field.mdx +36 -0
  578. package/src/docs/versioned/0.23.0/reference/components/number-field.mdx +46 -0
  579. package/src/docs/versioned/0.23.0/reference/components/page.mdx +46 -0
  580. package/src/docs/versioned/0.23.0/reference/components/pagination.mdx +30 -0
  581. package/src/docs/versioned/0.23.0/reference/components/password-field.mdx +26 -0
  582. package/src/docs/versioned/0.23.0/reference/components/phone-number-field.mdx +44 -0
  583. package/src/docs/versioned/0.23.0/reference/components/radio-field.mdx +31 -0
  584. package/src/docs/versioned/0.23.0/reference/components/sectiondivider.mdx +26 -0
  585. package/src/docs/versioned/0.23.0/reference/components/segmented-control.mdx +34 -0
  586. package/src/docs/versioned/0.23.0/reference/components/select-field.mdx +26 -0
  587. package/src/docs/versioned/0.23.0/reference/components/selectbadge.mdx +35 -0
  588. package/src/docs/versioned/0.23.0/reference/components/side-drawer.mdx +34 -0
  589. package/src/docs/versioned/0.23.0/reference/components/sidebar-navigation-non-expo.mdx +35 -0
  590. package/src/docs/versioned/0.23.0/reference/components/signature-field.mdx +35 -0
  591. package/src/docs/versioned/0.23.0/reference/components/slider.mdx +43 -0
  592. package/src/docs/versioned/0.23.0/reference/components/spinner.mdx +29 -0
  593. package/src/docs/versioned/0.23.0/reference/components/table-badge.mdx +32 -0
  594. package/src/docs/versioned/0.23.0/reference/components/table-boolean.mdx +29 -0
  595. package/src/docs/versioned/0.23.0/reference/components/table-date.mdx +30 -0
  596. package/src/docs/versioned/0.23.0/reference/components/table-icon-button.mdx +28 -0
  597. package/src/docs/versioned/0.23.0/reference/components/table-number.mdx +30 -0
  598. package/src/docs/versioned/0.23.0/reference/components/table-text.mdx +30 -0
  599. package/src/docs/versioned/0.23.0/reference/components/table-title.mdx +28 -0
  600. package/src/docs/versioned/0.23.0/reference/components/table.mdx +38 -0
  601. package/src/docs/versioned/0.23.0/reference/components/tap-to-edit.mdx +26 -0
  602. package/src/docs/versioned/0.23.0/reference/components/text-area.mdx +50 -0
  603. package/src/docs/versioned/0.23.0/reference/components/text-field.mdx +52 -0
  604. package/src/docs/versioned/0.23.0/reference/components/theme.mdx +26 -0
  605. package/src/docs/versioned/0.23.0/reference/components/toast.mdx +26 -0
  606. package/src/docs/versioned/0.23.0/reference/components/tooltip.mdx +30 -0
  607. package/src/docs/versioned/0.23.0/reference/components/userinactivity.mdx +32 -0
  608. package/src/docs/versioned/0.23.0/reference/environment-variables.md +382 -0
  609. package/src/docs/versioned/0.23.0/reference/feature-flags.md +304 -0
  610. package/src/docs/versioned/0.23.0/reference/generated/README.md +17 -0
  611. package/src/docs/versioned/0.23.0/reference/generated/api/README.md +282 -0
  612. package/src/docs/versioned/0.23.0/reference/generated/api/classes/APIError.md +96 -0
  613. package/src/docs/versioned/0.23.0/reference/generated/api/classes/BetterAuthApp.md +84 -0
  614. package/src/docs/versioned/0.23.0/reference/generated/api/classes/CachingSecretProvider.md +118 -0
  615. package/src/docs/versioned/0.23.0/reference/generated/api/classes/CompositeSecretProvider.md +79 -0
  616. package/src/docs/versioned/0.23.0/reference/generated/api/classes/ConfigurationApp.md +94 -0
  617. package/src/docs/versioned/0.23.0/reference/generated/api/classes/ConsentApp.md +74 -0
  618. package/src/docs/versioned/0.23.0/reference/generated/api/classes/DateOnly.md +123 -0
  619. package/src/docs/versioned/0.23.0/reference/generated/api/classes/EnvSecretProvider.md +64 -0
  620. package/src/docs/versioned/0.23.0/reference/generated/api/classes/GcpSecretProvider.md +76 -0
  621. package/src/docs/versioned/0.23.0/reference/generated/api/classes/OpenApiMiddlewareBuilder.md +577 -0
  622. package/src/docs/versioned/0.23.0/reference/generated/api/classes/RealtimeApp.md +112 -0
  623. package/src/docs/versioned/0.23.0/reference/generated/api/classes/TaskCancelledError.md +23 -0
  624. package/src/docs/versioned/0.23.0/reference/generated/api/classes/TerrenoApp.md +262 -0
  625. package/src/docs/versioned/0.23.0/reference/generated/api/classes/VersionCheckPlugin.md +43 -0
  626. package/src/docs/versioned/0.23.0/reference/generated/api/functions/AdminOwnerTransformer.md +47 -0
  627. package/src/docs/versioned/0.23.0/reference/generated/api/functions/OwnerQueryFilter.md +11 -0
  628. package/src/docs/versioned/0.23.0/reference/generated/api/functions/addAuthRoutes.md +19 -0
  629. package/src/docs/versioned/0.23.0/reference/generated/api/functions/addGitHubAuthRoutes.md +31 -0
  630. package/src/docs/versioned/0.23.0/reference/generated/api/functions/addMeRoutes.md +19 -0
  631. package/src/docs/versioned/0.23.0/reference/generated/api/functions/addPopulateToQuery.md +15 -0
  632. package/src/docs/versioned/0.23.0/reference/generated/api/functions/addQuerySubscription.md +26 -0
  633. package/src/docs/versioned/0.23.0/reference/generated/api/functions/apiErrorMiddleware.md +23 -0
  634. package/src/docs/versioned/0.23.0/reference/generated/api/functions/apiFallthroughErrorMiddleware.md +26 -0
  635. package/src/docs/versioned/0.23.0/reference/generated/api/functions/apiUnauthorizedMiddleware.md +23 -0
  636. package/src/docs/versioned/0.23.0/reference/generated/api/functions/applyRequestContextToSentry.md +11 -0
  637. package/src/docs/versioned/0.23.0/reference/generated/api/functions/assertNoActionCollisions.md +21 -0
  638. package/src/docs/versioned/0.23.0/reference/generated/api/functions/asyncHandler.md +15 -0
  639. package/src/docs/versioned/0.23.0/reference/generated/api/functions/authenticateMiddleware.md +11 -0
  640. package/src/docs/versioned/0.23.0/reference/generated/api/functions/baseUserPlugin.md +11 -0
  641. package/src/docs/versioned/0.23.0/reference/generated/api/functions/buildQuerySchemaFromFields.md +30 -0
  642. package/src/docs/versioned/0.23.0/reference/generated/api/functions/checkModelsStrict.md +21 -0
  643. package/src/docs/versioned/0.23.0/reference/generated/api/functions/checkPermissions.md +29 -0
  644. package/src/docs/versioned/0.23.0/reference/generated/api/functions/clearQueryStore.md +7 -0
  645. package/src/docs/versioned/0.23.0/reference/generated/api/functions/clearRealtimeRegistry.md +7 -0
  646. package/src/docs/versioned/0.23.0/reference/generated/api/functions/computeQueryId.md +18 -0
  647. package/src/docs/versioned/0.23.0/reference/generated/api/functions/configurationPlugin.md +48 -0
  648. package/src/docs/versioned/0.23.0/reference/generated/api/functions/configureOpenApiValidator.md +28 -0
  649. package/src/docs/versioned/0.23.0/reference/generated/api/functions/createActionOpenApiMiddleware.md +35 -0
  650. package/src/docs/versioned/0.23.0/reference/generated/api/functions/createBetterAuth.md +13 -0
  651. package/src/docs/versioned/0.23.0/reference/generated/api/functions/createBetterAuthSessionMiddleware.md +18 -0
  652. package/src/docs/versioned/0.23.0/reference/generated/api/functions/createFeatureFlaggedLogger.md +53 -0
  653. package/src/docs/versioned/0.23.0/reference/generated/api/functions/createModelValidators.md +74 -0
  654. package/src/docs/versioned/0.23.0/reference/generated/api/functions/createOpenApiBuilder.md +39 -0
  655. package/src/docs/versioned/0.23.0/reference/generated/api/functions/createRouter.md +19 -0
  656. package/src/docs/versioned/0.23.0/reference/generated/api/functions/createRouterWithAuth.md +19 -0
  657. package/src/docs/versioned/0.23.0/reference/generated/api/functions/createScopedLogger.md +53 -0
  658. package/src/docs/versioned/0.23.0/reference/generated/api/functions/createScriptArgs.md +33 -0
  659. package/src/docs/versioned/0.23.0/reference/generated/api/functions/createValidator.md +29 -0
  660. package/src/docs/versioned/0.23.0/reference/generated/api/functions/createdUpdatedPlugin.md +11 -0
  661. package/src/docs/versioned/0.23.0/reference/generated/api/functions/cronjob.md +19 -0
  662. package/src/docs/versioned/0.23.0/reference/generated/api/functions/defaultResponseHandler.md +32 -0
  663. package/src/docs/versioned/0.23.0/reference/generated/api/functions/defineCollectionAction.md +25 -0
  664. package/src/docs/versioned/0.23.0/reference/generated/api/functions/defineInstanceAction.md +29 -0
  665. package/src/docs/versioned/0.23.0/reference/generated/api/functions/envConfigurationPlugin.md +11 -0
  666. package/src/docs/versioned/0.23.0/reference/generated/api/functions/errorMessage.md +13 -0
  667. package/src/docs/versioned/0.23.0/reference/generated/api/functions/errorStack.md +13 -0
  668. package/src/docs/versioned/0.23.0/reference/generated/api/functions/errorsPlugin.md +11 -0
  669. package/src/docs/versioned/0.23.0/reference/generated/api/functions/findExactlyOne.md +25 -0
  670. package/src/docs/versioned/0.23.0/reference/generated/api/functions/findOneOrNone.md +24 -0
  671. package/src/docs/versioned/0.23.0/reference/generated/api/functions/findOneOrNoneFor.md +37 -0
  672. package/src/docs/versioned/0.23.0/reference/generated/api/functions/findRegistryEntryByCollection.md +13 -0
  673. package/src/docs/versioned/0.23.0/reference/generated/api/functions/findRegistryEntryByRoutePath.md +13 -0
  674. package/src/docs/versioned/0.23.0/reference/generated/api/functions/firebaseJWTPlugin.md +11 -0
  675. package/src/docs/versioned/0.23.0/reference/generated/api/functions/fixMixedFields.md +21 -0
  676. package/src/docs/versioned/0.23.0/reference/generated/api/functions/flattenToDotPaths.md +24 -0
  677. package/src/docs/versioned/0.23.0/reference/generated/api/functions/formatLogContextSuffix.md +17 -0
  678. package/src/docs/versioned/0.23.0/reference/generated/api/functions/generateTokens.md +35 -0
  679. package/src/docs/versioned/0.23.0/reference/generated/api/functions/getAPIErrorBody.md +11 -0
  680. package/src/docs/versioned/0.23.0/reference/generated/api/functions/getBetterAuthSession.md +13 -0
  681. package/src/docs/versioned/0.23.0/reference/generated/api/functions/getCurrentLogContext.md +9 -0
  682. package/src/docs/versioned/0.23.0/reference/generated/api/functions/getCurrentRequestContext.md +8 -0
  683. package/src/docs/versioned/0.23.0/reference/generated/api/functions/getCurrentRequestContextAttributes.md +15 -0
  684. package/src/docs/versioned/0.23.0/reference/generated/api/functions/getDisableExternalErrorTracking.md +15 -0
  685. package/src/docs/versioned/0.23.0/reference/generated/api/functions/getMongoClientFromMongoose.md +7 -0
  686. package/src/docs/versioned/0.23.0/reference/generated/api/functions/getOpenApiSpecForModel.md +29 -0
  687. package/src/docs/versioned/0.23.0/reference/generated/api/functions/getOpenApiValidatorConfig.md +7 -0
  688. package/src/docs/versioned/0.23.0/reference/generated/api/functions/getQuerySubscriptionsForCollection.md +14 -0
  689. package/src/docs/versioned/0.23.0/reference/generated/api/functions/getRealtimeRegistry.md +7 -0
  690. package/src/docs/versioned/0.23.0/reference/generated/api/functions/getRequestContextFromAttributes.md +11 -0
  691. package/src/docs/versioned/0.23.0/reference/generated/api/functions/getSchemaFromModel.md +25 -0
  692. package/src/docs/versioned/0.23.0/reference/generated/api/functions/getSessionIdFromJwtPayload.md +11 -0
  693. package/src/docs/versioned/0.23.0/reference/generated/api/functions/githubUserPlugin.md +22 -0
  694. package/src/docs/versioned/0.23.0/reference/generated/api/functions/hasBetterAuthSession.md +13 -0
  695. package/src/docs/versioned/0.23.0/reference/generated/api/functions/installRealtimeSocketHandlers.md +27 -0
  696. package/src/docs/versioned/0.23.0/reference/generated/api/functions/isAPIError.md +11 -0
  697. package/src/docs/versioned/0.23.0/reference/generated/api/functions/isDeletedPlugin.md +15 -0
  698. package/src/docs/versioned/0.23.0/reference/generated/api/functions/isDisabledPlugin.md +15 -0
  699. package/src/docs/versioned/0.23.0/reference/generated/api/functions/isOpenApiValidatorConfigured.md +8 -0
  700. package/src/docs/versioned/0.23.0/reference/generated/api/functions/isValidObjectId.md +11 -0
  701. package/src/docs/versioned/0.23.0/reference/generated/api/functions/jsonResponseRequestIdMiddleware.md +24 -0
  702. package/src/docs/versioned/0.23.0/reference/generated/api/functions/logRequests.md +19 -0
  703. package/src/docs/versioned/0.23.0/reference/generated/api/functions/matchesQuery.md +23 -0
  704. package/src/docs/versioned/0.23.0/reference/generated/api/functions/modelRouter.md +83 -0
  705. package/src/docs/versioned/0.23.0/reference/generated/api/functions/mongooseErrorToAPIError.md +13 -0
  706. package/src/docs/versioned/0.23.0/reference/generated/api/functions/mountBetterAuthRoutes.md +21 -0
  707. package/src/docs/versioned/0.23.0/reference/generated/api/functions/openApiCompatMiddleware.md +22 -0
  708. package/src/docs/versioned/0.23.0/reference/generated/api/functions/openApiEtagMiddleware.md +23 -0
  709. package/src/docs/versioned/0.23.0/reference/generated/api/functions/parseScriptArgs.md +35 -0
  710. package/src/docs/versioned/0.23.0/reference/generated/api/functions/patchAppUse.md +17 -0
  711. package/src/docs/versioned/0.23.0/reference/generated/api/functions/permissionMiddleware.md +21 -0
  712. package/src/docs/versioned/0.23.0/reference/generated/api/functions/registerActionRoutes.md +25 -0
  713. package/src/docs/versioned/0.23.0/reference/generated/api/functions/registerRealtime.md +14 -0
  714. package/src/docs/versioned/0.23.0/reference/generated/api/functions/removeAllSocketQueries.md +13 -0
  715. package/src/docs/versioned/0.23.0/reference/generated/api/functions/removeQuerySubscription.md +17 -0
  716. package/src/docs/versioned/0.23.0/reference/generated/api/functions/requestContextMiddleware.md +26 -0
  717. package/src/docs/versioned/0.23.0/reference/generated/api/functions/resetOpenApiValidatorConfig.md +9 -0
  718. package/src/docs/versioned/0.23.0/reference/generated/api/functions/runActionPermissions.md +33 -0
  719. package/src/docs/versioned/0.23.0/reference/generated/api/functions/runWithRequestContext.md +38 -0
  720. package/src/docs/versioned/0.23.0/reference/generated/api/functions/runWithRequestContextAttributes.md +25 -0
  721. package/src/docs/versioned/0.23.0/reference/generated/api/functions/sendToGoogleChat.md +25 -0
  722. package/src/docs/versioned/0.23.0/reference/generated/api/functions/sendToSlack.md +29 -0
  723. package/src/docs/versioned/0.23.0/reference/generated/api/functions/sendToZoom.md +67 -0
  724. package/src/docs/versioned/0.23.0/reference/generated/api/functions/sentryAppVersionMiddleware.md +26 -0
  725. package/src/docs/versioned/0.23.0/reference/generated/api/functions/serialize.md +25 -0
  726. package/src/docs/versioned/0.23.0/reference/generated/api/functions/setRequestContext.md +11 -0
  727. package/src/docs/versioned/0.23.0/reference/generated/api/functions/setupAuth.md +15 -0
  728. package/src/docs/versioned/0.23.0/reference/generated/api/functions/setupBetterAuthUserSync.md +21 -0
  729. package/src/docs/versioned/0.23.0/reference/generated/api/functions/setupEnvironment.md +5 -0
  730. package/src/docs/versioned/0.23.0/reference/generated/api/functions/setupGitHubAuth.md +22 -0
  731. package/src/docs/versioned/0.23.0/reference/generated/api/functions/setupLogging.md +11 -0
  732. package/src/docs/versioned/0.23.0/reference/generated/api/functions/signupUser.md +23 -0
  733. package/src/docs/versioned/0.23.0/reference/generated/api/functions/startChangeStreamWatcher.md +21 -0
  734. package/src/docs/versioned/0.23.0/reference/generated/api/functions/stopChangeStreamWatcher.md +7 -0
  735. package/src/docs/versioned/0.23.0/reference/generated/api/functions/syncBetterAuthUser.md +19 -0
  736. package/src/docs/versioned/0.23.0/reference/generated/api/functions/syncConsents.md +45 -0
  737. package/src/docs/versioned/0.23.0/reference/generated/api/functions/timeout.md +11 -0
  738. package/src/docs/versioned/0.23.0/reference/generated/api/functions/transform.md +29 -0
  739. package/src/docs/versioned/0.23.0/reference/generated/api/functions/unpopulate.md +21 -0
  740. package/src/docs/versioned/0.23.0/reference/generated/api/functions/updateRequestContextFromRequest.md +15 -0
  741. package/src/docs/versioned/0.23.0/reference/generated/api/functions/upsertPlugin.md +23 -0
  742. package/src/docs/versioned/0.23.0/reference/generated/api/functions/validateActionRequest.md +35 -0
  743. package/src/docs/versioned/0.23.0/reference/generated/api/functions/validateModelRequestBody.md +30 -0
  744. package/src/docs/versioned/0.23.0/reference/generated/api/functions/validateQueryParams.md +23 -0
  745. package/src/docs/versioned/0.23.0/reference/generated/api/functions/validateRequestBody.md +26 -0
  746. package/src/docs/versioned/0.23.0/reference/generated/api/functions/validateResponseData.md +32 -0
  747. package/src/docs/versioned/0.23.0/reference/generated/api/functions/wrapActionResponse.md +19 -0
  748. package/src/docs/versioned/0.23.0/reference/generated/api/functions/wrapScript.md +15 -0
  749. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/APIErrorConstructor.md +93 -0
  750. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/ActionContext.md +49 -0
  751. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/AsyncHandlerOptions.md +32 -0
  752. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/AuthOptions.md +47 -0
  753. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/BackgroundTaskDocument.md +141 -0
  754. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/BackgroundTaskMethods.md +55 -0
  755. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/BackgroundTaskModel.md +51 -0
  756. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/BackgroundTaskStatics.md +19 -0
  757. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/BaseUser.md +11 -0
  758. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/BetterAuthAppOptions.md +11 -0
  759. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/BetterAuthConfig.md +74 -0
  760. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/BetterAuthOAuthProvider.md +13 -0
  761. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/BetterAuthSession.md +43 -0
  762. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/BetterAuthSessionData.md +13 -0
  763. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/BetterAuthUser.md +43 -0
  764. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/CachingSecretProviderOptions.md +9 -0
  765. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/ChangeStreamConfig.md +41 -0
  766. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/CollectionActionConfig.md +123 -0
  767. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/ConfigRegistration.md +23 -0
  768. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/ConfigurationAppOptions.md +51 -0
  769. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/ConfigurationMetaResponse.md +7 -0
  770. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/ConfigurationModel.md +166 -0
  771. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/ConfigurationPermissions.md +45 -0
  772. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/ConfigurationPluginOptions.md +30 -0
  773. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/ConfigurationStatics.md +107 -0
  774. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/ConsentAppOptions.md +85 -0
  775. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/ConsentFormCheckbox.md +17 -0
  776. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/ConsentFormDefinition.md +83 -0
  777. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/ConsentFormDocument.md +123 -0
  778. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/ConsentFormModel.md +79 -0
  779. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/ConsentFormStatics.md +55 -0
  780. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/ConsentResponseDocument.md +105 -0
  781. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/ConsentResponseMethods.md +1 -0
  782. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/ConsentResponseModel.md +79 -0
  783. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/ConsentResponseStatics.md +55 -0
  784. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/CreateBetterAuthOptions.md +17 -0
  785. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/CreateFeatureFlaggedLoggerOptions.md +29 -0
  786. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/CreateScopedLoggerOptions.md +18 -0
  787. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/CreateValidatorOptions.md +25 -0
  788. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/CreatedDeleted.md +27 -0
  789. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/DocumentSubscription.md +17 -0
  790. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/FindExactlyOnePlugin.md +30 -0
  791. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/FindOneOrNonePlugin.md +30 -0
  792. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/GcpSecretProviderOptions.md +9 -0
  793. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/GenerateTokensOptions.md +5 -0
  794. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/GitHubAuthOptions.md +74 -0
  795. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/GitHubUserFields.md +33 -0
  796. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/HasUpsert.md +27 -0
  797. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/InstanceActionConfig.md +127 -0
  798. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/IsDeleted.md +7 -0
  799. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/JSONArray.md +7 -0
  800. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/JSONObject.md +3 -0
  801. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/JwtSessionPayload.md +19 -0
  802. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/LogContextFields.md +41 -0
  803. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/LoggingOptions.md +73 -0
  804. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/ModelRouterOptions.md +524 -0
  805. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/ModelRouterRegistration.md +33 -0
  806. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/ModelRouterValidationOptions.md +89 -0
  807. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/MongoClientLike.md +11 -0
  808. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/OpenApiBuildResult.md +34 -0
  809. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/OpenApiMiddleware.md +98 -0
  810. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/OpenApiParameter.md +66 -0
  811. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/OpenApiResponse.md +43 -0
  812. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/OpenApiSchema.md +62 -0
  813. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/OpenApiSchemaProperty.md +89 -0
  814. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/OpenApiValidatorConfig.md +94 -0
  815. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/PopulatePath.md +17 -0
  816. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/QuerySubscription.md +25 -0
  817. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/QueryValidatorOptions.md +31 -0
  818. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/RESTPermissions.md +35 -0
  819. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/RealtimeAppOptions.md +62 -0
  820. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/RealtimeConfig.md +44 -0
  821. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/RealtimeEvent.md +57 -0
  822. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/RealtimeRegistryEntry.md +41 -0
  823. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/RealtimeSocketLike.md +94 -0
  824. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/RequestBodyValidatorOptions.md +71 -0
  825. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/RequestContext.md +59 -0
  826. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/ScopedLogger.md +100 -0
  827. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/ScriptArgDef.md +60 -0
  828. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/ScriptArgs.md +121 -0
  829. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/ScriptContext.md +67 -0
  830. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/ScriptResult.md +11 -0
  831. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/SecretFieldMeta.md +29 -0
  832. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/SecretProvider.md +35 -0
  833. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/SyncConsentsOptions.md +15 -0
  834. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/SyncConsentsResult.md +23 -0
  835. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/TerrenoAppOptions.md +112 -0
  836. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/TerrenoPlugin.md +78 -0
  837. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/TerrenoRequestLogEntry.md +13 -0
  838. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/TerrenoTransformer.md +49 -0
  839. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/User.md +26 -0
  840. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/UserModel.md +113 -0
  841. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/VersionCheckResponse.md +37 -0
  842. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/VersionConfigDocument.md +65 -0
  843. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/VersionConfigModel.md +51 -0
  844. package/src/docs/versioned/0.23.0/reference/generated/api/interfaces/WrapScriptOptions.md +27 -0
  845. package/src/docs/versioned/0.23.0/reference/generated/api/type-aliases/AddRoutes.md +15 -0
  846. package/src/docs/versioned/0.23.0/reference/generated/api/type-aliases/AuthProvider.md +5 -0
  847. package/src/docs/versioned/0.23.0/reference/generated/api/type-aliases/BetterAuthInstance.md +3 -0
  848. package/src/docs/versioned/0.23.0/reference/generated/api/type-aliases/ConfigType.md +1 -0
  849. package/src/docs/versioned/0.23.0/reference/generated/api/type-aliases/ConfigurationPostUpdateHook.md +24 -0
  850. package/src/docs/versioned/0.23.0/reference/generated/api/type-aliases/ConfigurationPreUpdateHook.md +20 -0
  851. package/src/docs/versioned/0.23.0/reference/generated/api/type-aliases/ConsentFormMethods.md +1 -0
  852. package/src/docs/versioned/0.23.0/reference/generated/api/type-aliases/ConsentFormType.md +1 -0
  853. package/src/docs/versioned/0.23.0/reference/generated/api/type-aliases/DeepPartial.md +9 -0
  854. package/src/docs/versioned/0.23.0/reference/generated/api/type-aliases/GooseRESTOptions.md +7 -0
  855. package/src/docs/versioned/0.23.0/reference/generated/api/type-aliases/JSONPrimitive.md +1 -0
  856. package/src/docs/versioned/0.23.0/reference/generated/api/type-aliases/JSONValue.md +1 -0
  857. package/src/docs/versioned/0.23.0/reference/generated/api/type-aliases/PathValue.md +19 -0
  858. package/src/docs/versioned/0.23.0/reference/generated/api/type-aliases/Paths.md +15 -0
  859. package/src/docs/versioned/0.23.0/reference/generated/api/type-aliases/PermissionMethod.md +25 -0
  860. package/src/docs/versioned/0.23.0/reference/generated/api/type-aliases/RESTMethod.md +17 -0
  861. package/src/docs/versioned/0.23.0/reference/generated/api/type-aliases/RequestContextAttributes.md +1 -0
  862. package/src/docs/versioned/0.23.0/reference/generated/api/type-aliases/ScriptArgValue.md +3 -0
  863. package/src/docs/versioned/0.23.0/reference/generated/api/type-aliases/ScriptRunner.md +15 -0
  864. package/src/docs/versioned/0.23.0/reference/generated/api/type-aliases/VersionCheckStatus.md +1 -0
  865. package/src/docs/versioned/0.23.0/reference/generated/api/variables/ACTION_NAME_PATTERN.md +1 -0
  866. package/src/docs/versioned/0.23.0/reference/generated/api/variables/BackgroundTask.md +1 -0
  867. package/src/docs/versioned/0.23.0/reference/generated/api/variables/Config.md +244 -0
  868. package/src/docs/versioned/0.23.0/reference/generated/api/variables/ConsentForm.md +1 -0
  869. package/src/docs/versioned/0.23.0/reference/generated/api/variables/ConsentResponse.md +1 -0
  870. package/src/docs/versioned/0.23.0/reference/generated/api/variables/MAX_DOCUMENT_SUBSCRIPTIONS.md +1 -0
  871. package/src/docs/versioned/0.23.0/reference/generated/api/variables/MAX_MODEL_SUBSCRIPTIONS.md +4 -0
  872. package/src/docs/versioned/0.23.0/reference/generated/api/variables/MAX_QUERY_SUBSCRIPTIONS.md +1 -0
  873. package/src/docs/versioned/0.23.0/reference/generated/api/variables/Permissions.md +109 -0
  874. package/src/docs/versioned/0.23.0/reference/generated/api/variables/REQUEST_CONTEXT_ATTRIBUTE_NAMES.md +39 -0
  875. package/src/docs/versioned/0.23.0/reference/generated/api/variables/VersionConfig.md +1 -0
  876. package/src/docs/versioned/0.23.0/reference/generated/api/variables/consentResponsePopulatePaths.md +3 -0
  877. package/src/docs/versioned/0.23.0/reference/generated/api/variables/gooseRestRouter.md +85 -0
  878. package/src/docs/versioned/0.23.0/reference/generated/api/variables/logger.md +109 -0
  879. package/src/docs/versioned/0.23.0/reference/generated/api/variables/winstonLogger.md +1 -0
  880. package/src/docs/versioned/0.23.0/reference/generated/rtk/README.md +126 -0
  881. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/buildOptimisticCreateItem.md +17 -0
  882. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/configureOfflineMutationEndpoints.md +13 -0
  883. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/createBetterAuthClient.md +30 -0
  884. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/createOfflineMiddleware.md +41 -0
  885. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/createSessionApi.md +21 -0
  886. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/createStorageAdapter.md +17 -0
  887. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/generateAuthSlice.md +35 -0
  888. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/generateBetterAuthSlice.md +87 -0
  889. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/generateProfileEndpoints.md +35 -0
  890. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/generateTags.md +15 -0
  891. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/getAuthToken.md +5 -0
  892. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/getBaseQuery.md +23 -0
  893. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/getFriendlyExpirationInfo.md +5 -0
  894. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/getRealtimeSocket.md +7 -0
  895. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/getTokenExpirationTimes.md +5 -0
  896. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/isNetworkFetchError.md +14 -0
  897. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/isWebsocketsDebugEnabled.md +5 -0
  898. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/logAuth.md +11 -0
  899. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/logSocket.md +15 -0
  900. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/populateId.md +23 -0
  901. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/realtimeDocument.md +37 -0
  902. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/realtimeList.md +43 -0
  903. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/refreshAuthToken.md +5 -0
  904. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/registerTerrenoDevStore.md +14 -0
  905. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/resolveBaseUrls.md +28 -0
  906. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/resolveFeatureFlagsOptions.md +14 -0
  907. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/selectBetterAuthError.md +13 -0
  908. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/selectBetterAuthIsAuthenticated.md +13 -0
  909. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/selectBetterAuthIsLoading.md +13 -0
  910. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/selectBetterAuthState.md +13 -0
  911. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/selectBetterAuthUser.md +13 -0
  912. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/selectBetterAuthUserId.md +13 -0
  913. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/selectConflicts.md +13 -0
  914. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/selectCurrentUserId.md +11 -0
  915. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/selectIsAuthenticating.md +11 -0
  916. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/selectIsOnline.md +13 -0
  917. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/selectIsOnlineSafe.md +15 -0
  918. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/selectIsSyncing.md +13 -0
  919. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/selectLastTokenRefreshTimestamp.md +11 -0
  920. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/selectOfflineQueue.md +13 -0
  921. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/selectQueueLength.md +13 -0
  922. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/setRealtimeDebug.md +13 -0
  923. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/setRealtimeSocket.md +27 -0
  924. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/shouldDeferOfflineMutation.md +18 -0
  925. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/shouldReplayQueuedMutation.md +18 -0
  926. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/shouldShowStillThereModal.md +5 -0
  927. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/useFeatureFlags.md +15 -0
  928. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/useOfflineStatus.md +16 -0
  929. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/useRealtimeDebug.md +18 -0
  930. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/useSelectCurrentUserId.md +5 -0
  931. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/useSelectIsAuthenticating.md +5 -0
  932. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/useServerStatus.md +26 -0
  933. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/useSocketConnection.md +19 -0
  934. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/useSyncConnection.md +32 -0
  935. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/useTerrenoFeatureFlags.md +19 -0
  936. package/src/docs/versioned/0.23.0/reference/generated/rtk/functions/useUpgradeCheck.md +30 -0
  937. package/src/docs/versioned/0.23.0/reference/generated/rtk/interfaces/BaseUrls.md +17 -0
  938. package/src/docs/versioned/0.23.0/reference/generated/rtk/interfaces/BetterAuthClientConfig.md +31 -0
  939. package/src/docs/versioned/0.23.0/reference/generated/rtk/interfaces/BetterAuthClientInterface.md +23 -0
  940. package/src/docs/versioned/0.23.0/reference/generated/rtk/interfaces/BetterAuthSession.md +43 -0
  941. package/src/docs/versioned/0.23.0/reference/generated/rtk/interfaces/BetterAuthSessionData.md +13 -0
  942. package/src/docs/versioned/0.23.0/reference/generated/rtk/interfaces/BetterAuthState.md +49 -0
  943. package/src/docs/versioned/0.23.0/reference/generated/rtk/interfaces/BetterAuthUser.md +43 -0
  944. package/src/docs/versioned/0.23.0/reference/generated/rtk/interfaces/ConflictRecord.md +47 -0
  945. package/src/docs/versioned/0.23.0/reference/generated/rtk/interfaces/EmailSignupRequest.md +15 -0
  946. package/src/docs/versioned/0.23.0/reference/generated/rtk/interfaces/ExpoConstantsShape.md +29 -0
  947. package/src/docs/versioned/0.23.0/reference/generated/rtk/interfaces/GenerateBetterAuthSliceConfig.md +23 -0
  948. package/src/docs/versioned/0.23.0/reference/generated/rtk/interfaces/GoogleLoginRequest.md +5 -0
  949. package/src/docs/versioned/0.23.0/reference/generated/rtk/interfaces/ListResponse.md +35 -0
  950. package/src/docs/versioned/0.23.0/reference/generated/rtk/interfaces/OfflineMiddlewareConfig.md +15 -0
  951. package/src/docs/versioned/0.23.0/reference/generated/rtk/interfaces/OfflineState.md +23 -0
  952. package/src/docs/versioned/0.23.0/reference/generated/rtk/interfaces/OfflineStatus.md +87 -0
  953. package/src/docs/versioned/0.23.0/reference/generated/rtk/interfaces/QueuedMutation.md +55 -0
  954. package/src/docs/versioned/0.23.0/reference/generated/rtk/interfaces/RealtimeEvent.md +58 -0
  955. package/src/docs/versioned/0.23.0/reference/generated/rtk/interfaces/ResetPasswordRequest.md +15 -0
  956. package/src/docs/versioned/0.23.0/reference/generated/rtk/interfaces/ServerStatusOptions.md +31 -0
  957. package/src/docs/versioned/0.23.0/reference/generated/rtk/interfaces/SocketConnection.md +11 -0
  958. package/src/docs/versioned/0.23.0/reference/generated/rtk/interfaces/StorageAdapter.md +53 -0
  959. package/src/docs/versioned/0.23.0/reference/generated/rtk/interfaces/TerrenoFlagDefinition.md +19 -0
  960. package/src/docs/versioned/0.23.0/reference/generated/rtk/interfaces/UseFeatureFlagsOptions.md +50 -0
  961. package/src/docs/versioned/0.23.0/reference/generated/rtk/interfaces/UseSocketConnectionOptions.md +87 -0
  962. package/src/docs/versioned/0.23.0/reference/generated/rtk/interfaces/UseTerrenoFeatureFlagsOptions.md +41 -0
  963. package/src/docs/versioned/0.23.0/reference/generated/rtk/interfaces/UseTerrenoFeatureFlagsResult.md +33 -0
  964. package/src/docs/versioned/0.23.0/reference/generated/rtk/interfaces/UserResponse.md +17 -0
  965. package/src/docs/versioned/0.23.0/reference/generated/rtk/interfaces/VersionCheckResponse.md +39 -0
  966. package/src/docs/versioned/0.23.0/reference/generated/rtk/type-aliases/BetterAuthClient.md +3 -0
  967. package/src/docs/versioned/0.23.0/reference/generated/rtk/type-aliases/BetterAuthOAuthProvider.md +3 -0
  968. package/src/docs/versioned/0.23.0/reference/generated/rtk/type-aliases/BetterAuthSlice.md +3 -0
  969. package/src/docs/versioned/0.23.0/reference/generated/rtk/type-aliases/EmailLoginRequest.md +1 -0
  970. package/src/docs/versioned/0.23.0/reference/generated/rtk/type-aliases/RootState.md +1 -0
  971. package/src/docs/versioned/0.23.0/reference/generated/rtk/type-aliases/ServerStatus.md +1 -0
  972. package/src/docs/versioned/0.23.0/reference/generated/rtk/type-aliases/TerrenoFlagConfiguration.md +1 -0
  973. package/src/docs/versioned/0.23.0/reference/generated/rtk/variables/AUTH_DEBUG.md +1 -0
  974. package/src/docs/versioned/0.23.0/reference/generated/rtk/variables/IsWeb.md +1 -0
  975. package/src/docs/versioned/0.23.0/reference/generated/rtk/variables/LOGOUT_ACTION_TYPE.md +1 -0
  976. package/src/docs/versioned/0.23.0/reference/generated/rtk/variables/SAME_ORIGIN_SENTINEL.md +5 -0
  977. package/src/docs/versioned/0.23.0/reference/generated/rtk/variables/TOKEN_REFRESHED_SUCCESS.md +1 -0
  978. package/src/docs/versioned/0.23.0/reference/generated/rtk/variables/addConflict.md +1 -0
  979. package/src/docs/versioned/0.23.0/reference/generated/rtk/variables/baseTasksUrl.md +1 -0
  980. package/src/docs/versioned/0.23.0/reference/generated/rtk/variables/baseUrl.md +1 -0
  981. package/src/docs/versioned/0.23.0/reference/generated/rtk/variables/baseWebsocketsUrl.md +1 -0
  982. package/src/docs/versioned/0.23.0/reference/generated/rtk/variables/clearConflicts.md +1 -0
  983. package/src/docs/versioned/0.23.0/reference/generated/rtk/variables/clearQueue.md +1 -0
  984. package/src/docs/versioned/0.23.0/reference/generated/rtk/variables/dequeue.md +1 -0
  985. package/src/docs/versioned/0.23.0/reference/generated/rtk/variables/dismissConflict.md +1 -0
  986. package/src/docs/versioned/0.23.0/reference/generated/rtk/variables/emptySplitApi.md +1 -0
  987. package/src/docs/versioned/0.23.0/reference/generated/rtk/variables/enqueue.md +1 -0
  988. package/src/docs/versioned/0.23.0/reference/generated/rtk/variables/offlineReducer.md +1 -0
  989. package/src/docs/versioned/0.23.0/reference/generated/rtk/variables/offlineSlice.md +1 -0
  990. package/src/docs/versioned/0.23.0/reference/generated/rtk/variables/selectUndismissedConflicts.md +1 -0
  991. package/src/docs/versioned/0.23.0/reference/generated/rtk/variables/setOnlineStatus.md +1 -0
  992. package/src/docs/versioned/0.23.0/reference/generated/rtk/variables/setSyncing.md +1 -0
  993. package/src/docs/versioned/0.23.0/reference/generated/rtk/variables/staggeredBaseQuery.md +1 -0
  994. package/src/docs/versioned/0.23.0/reference/generated/rtk/variables/useGetVersionCheckQuery.md +1 -0
  995. package/src/docs/versioned/0.23.0/reference/generated/rtk/variables/useLazyGetVersionCheckQuery.md +1 -0
  996. package/src/docs/versioned/0.23.0/reference/mcp-server.md +586 -0
  997. package/src/docs/versioned/0.23.0/reference/rtk.md +439 -0
  998. package/src/docs/versioned/0.23.0/reference/ui.md +418 -0
  999. package/src/docs/versioned/0.23.0/tasks/admin-improvements.md +429 -0
  1000. package/src/docs/versioned/0.23.0/tasks/admin-only.md +221 -0
  1001. package/src/docs/versioned/0.23.0/tasks/admin-script-runner.md +50 -0
  1002. package/src/docs/versioned/0.23.0/tasks/admin-ui-v2-django-parity.md +135 -0
  1003. package/src/docs/versioned/0.23.0/tasks/consent-forms.md +193 -0
  1004. package/src/docs/versioned/0.23.0/tasks/design-blend-skill.md +147 -0
  1005. package/src/docs/versioned/0.23.0/tasks/feature-flags-openfeature.md +77 -0
  1006. package/src/docs/versioned/0.23.0/tasks/feature-flags.md +23 -0
  1007. package/src/docs/versioned/0.23.0/tasks/model-router-actions.md +46 -0
  1008. package/src/docs/versioned/0.23.0/tasks/model-router-mcp.md +105 -0
  1009. package/src/docs/versioned/0.23.0/tasks/offline-mode.md +139 -0
  1010. package/src/docs/versioned/0.23.0/tasks/syncdb-local-first.md +117 -0
  1011. package/src/docs/versioned/0.23.0/tasks/upgrade-banner.md +73 -0
  1012. package/src/docs/versioned/0.23.0/tutorials/README.md +7 -0
  1013. package/src/docs/versioned/0.23.0/tutorials/getting-started.md +44 -0
  1014. package/src/docs/versioned/next/reference/environment-variables.md +7 -3
  1015. package/src/docs/versioned/next/reference/rtk.md +11 -4
@@ -0,0 +1,844 @@
1
+ # Modular API Implementation Plan
2
+
3
+ ## Overview
4
+
5
+ This document outlines the implementation plan for a new modular API design in `@terreno/api`. The goal is to create a `TerrenoApp` class that provides a cleaner, more flexible interface for building APIs while maintaining backward compatibility with the existing `setupServer` function.
6
+
7
+ ## Goals
8
+
9
+ 1. **Fluent Builder API**: `const app = TerrenoApp.create({...}).addModelRouter(...).addRoute(...)`
10
+ 2. **Comprehensive Hooks**: Lifecycle hooks at every stage of server initialization and request handling
11
+ 3. **Configuration over Environment**: All settings passed via options, not env vars
12
+ 4. **Toggleable Middleware**: Every default middleware can be enabled/disabled
13
+ 5. **Health Checks**: Built-in `/health` endpoint with optional custom health check function
14
+ 6. **Breaking Change**: This replaces `setupServer` - no backward compatibility layer
15
+
16
+ ---
17
+
18
+ ## Architecture
19
+
20
+ ### File Structure
21
+
22
+ ```
23
+ api/src/
24
+ ├── TerrenoApp.ts # Main TerrenoApp class (NEW)
25
+ ├── TerrenoAppOptions.ts # Types and defaults (NEW)
26
+ ├── TerrenoAppMiddleware.ts # Built-in middleware configurations (NEW)
27
+ ├── TerrenoAppHooks.ts # Hook type definitions and runner (NEW)
28
+ ├── expressServer.ts # DEPRECATED - to be removed in future version
29
+ ├── api.ts # Existing - unchanged
30
+ └── index.ts # Export TerrenoApp, remove setupServer exports
31
+ ```
32
+
33
+ ### Core Classes
34
+
35
+ ```typescript
36
+ // TerrenoApp.ts
37
+ class TerrenoApp {
38
+ static create(options: TerrenoAppOptions): TerrenoApp;
39
+
40
+ // Fluent configuration
41
+ addModelRouter<T>(path: string, model: Model<T>, options: ModelRouterOptions<T>): this;
42
+ addModelRouter<T>(path: string, model: Model<T>, permissions: RESTPermissions<T>): this; // Shorthand
43
+ addRoute(path: string, router: Router | AddRoutesCallback, options?: AddRouteOptions): this;
44
+ addMiddleware(middleware: RequestHandler, options?: MiddlewareOptions): this;
45
+ addErrorHandlingMiddleware(middleware: ErrorRequestHandler): this;
46
+
47
+ // WebSocket
48
+ enableWebSocket(options?: WebSocketOptions): this;
49
+
50
+ // Lifecycle
51
+ build(): Express; // Returns configured Express app without starting
52
+ start(): Promise<{ app: Express; server: Server; wss?: WebSocketServer }>; // Build + listen
53
+
54
+ // Access
55
+ getExpressApp(): Express;
56
+ getServer(): Server | null;
57
+ getWebSocketServer(): WebSocketServer | null;
58
+
59
+ // Shutdown
60
+ shutdown(): Promise<void>; // Graceful shutdown
61
+ }
62
+ ```
63
+
64
+ ---
65
+
66
+ ## Configuration Options
67
+
68
+ ### TerrenoAppOptions Interface
69
+
70
+ ```typescript
71
+ interface TerrenoAppOptions {
72
+ // === Authentication ===
73
+ auth: AuthOptions;
74
+
75
+ // === Server ===
76
+ server?: ServerOptions;
77
+
78
+ // === Logging ===
79
+ logging?: LoggingOptions;
80
+
81
+ // === Middleware ===
82
+ middleware?: MiddlewareOptions;
83
+
84
+ // === Health Check ===
85
+ health?: HealthOptions;
86
+
87
+ // === OpenAPI / Swagger ===
88
+ openApi?: OpenApiOptions;
89
+
90
+ // === Error Handling ===
91
+ errors?: ErrorOptions;
92
+
93
+ // === WebSocket ===
94
+ webSocket?: WebSocketOptions;
95
+
96
+ // === Graceful Shutdown ===
97
+ shutdown?: ShutdownOptions;
98
+
99
+ // === Hooks ===
100
+ hooks?: AppHooks;
101
+ }
102
+ ```
103
+
104
+ ### Detailed Option Types
105
+
106
+ #### AuthOptions
107
+
108
+ ```typescript
109
+ interface AuthOptions {
110
+ // User model for authentication (required)
111
+ userModel: Model<any>;
112
+
113
+ // Token configuration (replaces env vars)
114
+ token: {
115
+ issuer: string; // TOKEN_ISSUER
116
+ secret: string; // TOKEN_SECRET
117
+ expiresIn?: string; // TOKEN_EXPIRES_IN (default: '1h')
118
+ };
119
+
120
+ refreshToken?: {
121
+ secret: string; // REFRESH_TOKEN_SECRET
122
+ expiresIn?: string; // REFRESH_TOKEN_EXPIRES_IN (default: '7d')
123
+ };
124
+
125
+ session?: {
126
+ secret: string; // SESSION_SECRET
127
+ };
128
+
129
+ // Auth scheme customization
130
+ scheme?: 'jwt' | 'custom';
131
+
132
+ // Custom token generation (existing authOptions.generateToken)
133
+ generateToken?: (user: any) => TokenPayload;
134
+
135
+ // Enable/disable built-in auth routes (/auth/login, /auth/signup, etc.)
136
+ enableAuthRoutes?: boolean; // default: true
137
+
138
+ // Enable/disable /me route
139
+ enableMeRoute?: boolean; // default: true
140
+ }
141
+ ```
142
+
143
+ #### ServerOptions
144
+
145
+ ```typescript
146
+ interface ServerOptions {
147
+ port?: number; // default: 9000
148
+ skipListen?: boolean; // default: false (for testing)
149
+ trustProxy?: boolean | string; // Express trust proxy setting
150
+ }
151
+ ```
152
+
153
+ #### LoggingOptions
154
+
155
+ ```typescript
156
+ interface LoggingOptions {
157
+ // Request logging
158
+ requests?: {
159
+ enabled?: boolean; // default: true
160
+ maskFields?: string[]; // Fields to mask (default: ['password'])
161
+ };
162
+
163
+ // Slow request logging
164
+ slowRequests?: {
165
+ enabled?: boolean; // default: false
166
+ readThresholdMs?: number; // default: 200
167
+ writeThresholdMs?: number; // default: 500
168
+ };
169
+
170
+ // Logger configuration
171
+ logger?: {
172
+ level?: 'debug' | 'info' | 'warn' | 'error';
173
+ format?: 'json' | 'pretty';
174
+ };
175
+ }
176
+ ```
177
+
178
+ #### MiddlewareOptions
179
+
180
+ ```typescript
181
+ interface MiddlewareOptions {
182
+ // CORS
183
+ cors?: {
184
+ enabled?: boolean; // default: true
185
+ origin?: string | string[] | RegExp | boolean;
186
+ credentials?: boolean;
187
+ } | false; // false to disable
188
+
189
+ // JSON body parsing
190
+ json?: {
191
+ enabled?: boolean; // default: true
192
+ limit?: string; // default: '100kb'
193
+ } | false;
194
+
195
+ // Query string parsing
196
+ queryParser?: {
197
+ enabled?: boolean; // default: true
198
+ arrayLimit?: number; // default: 200
199
+ } | false;
200
+
201
+ // Helmet security headers
202
+ helmet?: {
203
+ enabled?: boolean; // default: false (opt-in)
204
+ options?: HelmetOptions;
205
+ } | false;
206
+
207
+ // Rate limiting
208
+ rateLimit?: {
209
+ enabled?: boolean; // default: false (opt-in)
210
+ windowMs?: number;
211
+ max?: number;
212
+ } | false;
213
+
214
+ // Compression
215
+ compression?: {
216
+ enabled?: boolean; // default: false (opt-in)
217
+ } | false;
218
+ }
219
+ ```
220
+
221
+ #### HealthOptions
222
+
223
+ ```typescript
224
+ interface HealthOptions {
225
+ enabled?: boolean; // default: true
226
+ path?: string; // default: '/health'
227
+
228
+ // Optional custom health check function
229
+ // Return { healthy: boolean, details?: any } or throw to indicate unhealthy
230
+ check?: () => Promise<HealthCheckResult> | HealthCheckResult;
231
+ }
232
+
233
+ interface HealthCheckResult {
234
+ healthy: boolean;
235
+ details?: Record<string, any>;
236
+ }
237
+ ```
238
+
239
+ #### OpenApiOptions
240
+
241
+ ```typescript
242
+ interface OpenApiOptions {
243
+ enabled?: boolean; // default: true
244
+ path?: string; // default: '/openapi.json'
245
+
246
+ // Swagger UI
247
+ swagger?: {
248
+ enabled?: boolean; // default: false
249
+ path?: string; // default: '/swagger'
250
+ };
251
+
252
+ // OpenAPI spec metadata
253
+ info?: {
254
+ title?: string;
255
+ version?: string;
256
+ description?: string;
257
+ };
258
+ }
259
+ ```
260
+
261
+ #### ErrorOptions
262
+
263
+ ```typescript
264
+ interface ErrorOptions {
265
+ // Sentry integration
266
+ sentry?: {
267
+ enabled?: boolean;
268
+ dsn?: string;
269
+ environment?: string;
270
+ options?: SentryOptions;
271
+ } | false;
272
+
273
+ // Include stack traces in error responses
274
+ includeStackTrace?: boolean; // default: false (true in dev)
275
+ }
276
+ ```
277
+
278
+ #### WebSocketOptions
279
+
280
+ ```typescript
281
+ interface WebSocketOptions {
282
+ enabled?: boolean; // default: false
283
+
284
+ // Path for WebSocket upgrades (default: use same server)
285
+ path?: string; // e.g., '/ws'
286
+
287
+ // Authentication for WebSocket connections
288
+ authenticate?: (request: IncomingMessage) => Promise<any | null> | any | null;
289
+
290
+ // Called when a new connection is established
291
+ onConnection?: (ws: WebSocket, user: any | null) => void;
292
+
293
+ // Called when a message is received
294
+ onMessage?: (ws: WebSocket, message: Buffer, user: any | null) => void;
295
+
296
+ // Called when a connection is closed
297
+ onClose?: (ws: WebSocket, code: number, reason: string, user: any | null) => void;
298
+
299
+ // Called on WebSocket error
300
+ onError?: (ws: WebSocket, error: Error, user: any | null) => void;
301
+
302
+ // ws library options
303
+ wsOptions?: WebSocketServerOptions;
304
+ }
305
+ ```
306
+
307
+ #### ShutdownOptions
308
+
309
+ ```typescript
310
+ interface ShutdownOptions {
311
+ // Enable automatic SIGTERM/SIGINT handling (default: true)
312
+ handleSignals?: boolean;
313
+
314
+ // Timeout for graceful shutdown in ms (default: 30000)
315
+ timeout?: number;
316
+
317
+ // Called before shutdown begins
318
+ onShutdown?: () => void | Promise<void>;
319
+ }
320
+ ```
321
+
322
+ ---
323
+
324
+ ## Hooks System
325
+
326
+ ### AppHooks Interface
327
+
328
+ ```typescript
329
+ interface AppHooks {
330
+ // === Initialization Hooks ===
331
+
332
+ // Called immediately after Express app is created, before any middleware
333
+ onAppCreated?: (app: Express) => void | Promise<void>;
334
+
335
+ // Called after core middleware (cors, json, query) but before auth
336
+ onCoreMiddlewareReady?: (app: Express) => void | Promise<void>;
337
+
338
+ // Called after auth is configured but before routes
339
+ onAuthReady?: (app: Express) => void | Promise<void>;
340
+
341
+ // Called after all routes are registered but before error handlers
342
+ onRoutesReady?: (app: Express) => void | Promise<void>;
343
+
344
+ // Called after all middleware and error handlers are set up
345
+ onReady?: (app: Express) => void | Promise<void>;
346
+
347
+ // Called after server starts listening
348
+ onListening?: (server: Server, port: number) => void | Promise<void>;
349
+
350
+ // Called after WebSocket server is created (if enabled)
351
+ onWebSocketReady?: (wss: WebSocketServer) => void | Promise<void>;
352
+
353
+ // === Request Lifecycle Hooks ===
354
+
355
+ // Called for every request before any processing
356
+ onRequest?: (req: Request, res: Response) => void | Promise<void>;
357
+
358
+ // Called after authentication middleware runs
359
+ onAuthenticated?: (req: Request, res: Response, user: any | null) => void | Promise<void>;
360
+
361
+ // Called before sending response
362
+ onResponse?: (req: Request, res: Response, body: any) => void | Promise<void>;
363
+
364
+ // Called when an error occurs
365
+ onError?: (error: Error, req: Request, res: Response) => void | Promise<void>;
366
+ }
367
+ ```
368
+
369
+ ### Hook Execution Points
370
+
371
+ ```
372
+ ┌─────────────────────────────────────────────────────────────────┐
373
+ │ INITIALIZATION PHASE │
374
+ ├─────────────────────────────────────────────────────────────────┤
375
+ │ 1. Express app created │
376
+ │ └── onAppCreated() │
377
+ │ │
378
+ │ 2. Core middleware: cors, json, queryParser │
379
+ │ └── onCoreMiddlewareReady() │
380
+ │ │
381
+ │ 3. Auth: setupAuth(), addAuthRoutes() │
382
+ │ └── onAuthReady() │
383
+ │ │
384
+ │ 4. Routes: health, openapi, model routers, custom routes │
385
+ │ └── onRoutesReady() │
386
+ │ │
387
+ │ 5. Error handling middleware (addErrorHandlingMiddleware) │
388
+ │ 6. Built-in error handlers: apiError, fallthrough │
389
+ │ └── onReady() │
390
+ │ │
391
+ │ 7. Server.listen() │
392
+ │ └── onListening() │
393
+ │ │
394
+ │ 8. WebSocket server created (if enabled) │
395
+ │ └── onWebSocketReady() │
396
+ └─────────────────────────────────────────────────────────────────┘
397
+
398
+ ┌─────────────────────────────────────────────────────────────────┐
399
+ │ REQUEST PHASE │
400
+ ├─────────────────────────────────────────────────────────────────┤
401
+ │ Request arrives │
402
+ │ └── onRequest() │
403
+ │ │
404
+ │ Authentication runs │
405
+ │ └── onAuthenticated() │
406
+ │ │
407
+ │ Route handler executes │
408
+ │ │
409
+ │ Response sending │
410
+ │ └── onResponse() │
411
+ │ │
412
+ │ Error (if any) │
413
+ │ └── onError() │
414
+ └─────────────────────────────────────────────────────────────────┘
415
+ ```
416
+
417
+ ---
418
+
419
+ ## API Usage Examples
420
+
421
+ ### Basic Setup
422
+
423
+ ```typescript
424
+ import { TerrenoApp } from '@terreno/api';
425
+ import { User } from './models/User';
426
+
427
+ const app = TerrenoApp.create({
428
+ auth: {
429
+ userModel: User,
430
+ token: {
431
+ issuer: 'my-app',
432
+ secret: process.env.TOKEN_SECRET!,
433
+ expiresIn: '2h',
434
+ },
435
+ refreshToken: {
436
+ secret: process.env.REFRESH_TOKEN_SECRET!,
437
+ },
438
+ session: {
439
+ secret: process.env.SESSION_SECRET!,
440
+ },
441
+ },
442
+ server: {
443
+ port: 3000,
444
+ },
445
+ });
446
+
447
+ await app.start();
448
+ ```
449
+
450
+ ### Adding Model Routers
451
+
452
+ ```typescript
453
+ import { TerrenoApp, Permissions, OwnerQueryFilter } from '@terreno/api';
454
+ import { User, Post, Comment } from './models';
455
+
456
+ const app = TerrenoApp.create({ auth: { userModel: User, ... } })
457
+ // Full options
458
+ .addModelRouter('/posts', Post, {
459
+ permissions: {
460
+ create: [Permissions.IsAuthenticated],
461
+ read: [Permissions.IsAny],
462
+ update: [Permissions.IsOwner],
463
+ delete: [Permissions.IsOwner],
464
+ list: [Permissions.IsAny],
465
+ },
466
+ queryFields: ['title', 'authorId'],
467
+ queryFilter: OwnerQueryFilter,
468
+ })
469
+ // Shorthand: just pass permissions object directly
470
+ .addModelRouter('/comments', Comment, {
471
+ create: [Permissions.IsAuthenticated],
472
+ read: [Permissions.IsAny],
473
+ update: [Permissions.IsOwner],
474
+ delete: [Permissions.IsOwner],
475
+ list: [Permissions.IsAny],
476
+ });
477
+
478
+ await app.start();
479
+ ```
480
+
481
+ The shorthand detects when you pass a permissions object directly (has `create`/`read`/`update`/`delete`/`list` keys) vs full ModelRouterOptions (has `permissions` key).
482
+
483
+ #### Model Router Request Lifecycle
484
+
485
+ When a request hits a modelRouter endpoint, processing follows this order:
486
+
487
+ ```
488
+ 1. Express middleware (cors, json, helmet, etc.)
489
+ 2. Authentication middleware (JWT verification → req.user)
490
+ 3. onRequest hook fires
491
+ 4. onAuthenticated hook fires (if user was authenticated)
492
+ 5. Permission check (e.g., IsAuthenticated, IsOwner)
493
+ └── If denied → 403 response, skip remaining steps
494
+ 6. Query filter applied (e.g., OwnerQueryFilter adds { ownerId: req.user.id } to list queries)
495
+ 7. Route handler executes (create/read/update/delete/list)
496
+ └── For list: queryFields restrict which fields can be filtered via query params
497
+ └── For update/delete: document is fetched first, then permissions (e.g., IsOwner) are checked against it
498
+ 8. onResponse hook fires
499
+ 9. Response sent
500
+ ```
501
+
502
+ The `queryFilter` runs **after** authentication but **before** the database query, so it has access to `req.user` and can scope queries accordingly. This is useful for multi-tenant apps where users should only see their own data.
503
+
504
+ ### Adding Custom Routes
505
+
506
+ ```typescript
507
+ const app = TerrenoApp.create({ ... })
508
+ // Add route with a router
509
+ .addRoute('/webhooks', webhookRouter)
510
+
511
+ // Add route with a callback function
512
+ .addRoute('/custom', (router) => {
513
+ router.get('/ping', (req, res) => res.json({ pong: true }));
514
+ router.post('/echo', (req, res) => res.json(req.body));
515
+ })
516
+
517
+ // Add route with OpenAPI spec (merged into generated /openapi.json)
518
+ .addRoute('/custom', (router) => {
519
+ router.get('/ping', (req, res) => res.json({ pong: true }));
520
+ }, {
521
+ openapi: {
522
+ '/ping': {
523
+ get: {
524
+ summary: 'Ping endpoint',
525
+ responses: { '200': { description: 'Pong response' } },
526
+ },
527
+ },
528
+ },
529
+ })
530
+
531
+ // Mount at root
532
+ .addRoute('/', (router) => {
533
+ router.get('/version', (req, res) => res.json({ version: '1.0.0' }));
534
+ });
535
+ ```
536
+
537
+ ### Configuring Middleware
538
+
539
+ ```typescript
540
+ const app = TerrenoApp.create({
541
+ auth: { ... },
542
+ middleware: {
543
+ cors: {
544
+ enabled: true,
545
+ origin: ['https://myapp.com', 'https://admin.myapp.com'],
546
+ credentials: true,
547
+ },
548
+ json: {
549
+ limit: '10mb',
550
+ },
551
+ helmet: {
552
+ enabled: true,
553
+ },
554
+ rateLimit: {
555
+ enabled: true,
556
+ windowMs: 15 * 60 * 1000, // 15 minutes
557
+ max: 100,
558
+ },
559
+ },
560
+ });
561
+ ```
562
+
563
+ ### Custom Health Check
564
+
565
+ ```typescript
566
+ const app = TerrenoApp.create({
567
+ auth: { ... },
568
+ health: {
569
+ enabled: true,
570
+ path: '/health',
571
+ check: async () => {
572
+ const dbConnected = mongoose.connection.readyState === 1;
573
+ const redisConnected = await redis.ping().catch(() => false);
574
+
575
+ return {
576
+ healthy: dbConnected && redisConnected,
577
+ details: {
578
+ database: dbConnected ? 'connected' : 'disconnected',
579
+ redis: redisConnected ? 'connected' : 'disconnected',
580
+ uptime: process.uptime(),
581
+ },
582
+ };
583
+ },
584
+ },
585
+ });
586
+ ```
587
+
588
+ ### Using Hooks
589
+
590
+ ```typescript
591
+ const app = TerrenoApp.create({
592
+ auth: { ... },
593
+ hooks: {
594
+ onAppCreated: (app) => {
595
+ console.log('Express app created');
596
+ },
597
+
598
+ onAuthReady: (app) => {
599
+ // Add custom auth middleware after built-in auth
600
+ app.use('/admin', adminAuthMiddleware);
601
+ },
602
+
603
+ onRoutesReady: (app) => {
604
+ // Add routes that need to come after model routers
605
+ app.use('/analytics', analyticsRouter);
606
+ },
607
+
608
+ onReady: (app) => {
609
+ console.log('App fully configured');
610
+ },
611
+
612
+ onListening: (server, port) => {
613
+ console.log(`Server listening on port ${port}`);
614
+ },
615
+
616
+ onRequest: (req, res) => {
617
+ req.startTime = Date.now();
618
+ },
619
+
620
+ onError: (error, req, res) => {
621
+ // Custom error tracking
622
+ errorTracker.capture(error, { url: req.url, user: req.user?.id });
623
+ },
624
+
625
+ onShutdown: async () => {
626
+ await mongoose.disconnect();
627
+ await redis.quit();
628
+ },
629
+ },
630
+ });
631
+ ```
632
+
633
+ ### Adding Custom Middleware
634
+
635
+ ```typescript
636
+ const app = TerrenoApp.create({ ... })
637
+ // Add middleware that runs for all routes
638
+ .addMiddleware(requestIdMiddleware)
639
+
640
+ // Add middleware with options
641
+ .addMiddleware(customMiddleware, {
642
+ path: '/api', // Only apply to /api routes
643
+ position: 'afterAuth', // Insert after auth middleware
644
+ });
645
+ ```
646
+
647
+ ### Adding Error Handling Middleware
648
+
649
+ Error handling middleware (4-argument Express handlers) must be mounted **after** all routes. Use `addErrorHandlingMiddleware()` for integrations like Sentry that require this ordering:
650
+
651
+ ```typescript
652
+ import * as Sentry from '@sentry/node';
653
+
654
+ const app = TerrenoApp.create({ ... })
655
+ .addModelRouter('/posts', Post, { ... })
656
+ .addRoute('/webhooks', webhookRouter)
657
+
658
+ // Mounted after all routes but before TerrenoApp's built-in error handler
659
+ .addErrorHandlingMiddleware(Sentry.setupExpressErrorHandler)
660
+
661
+ // Can add multiple — they run in order
662
+ .addErrorHandlingMiddleware((err, req, res, next) => {
663
+ // Custom error logging
664
+ logger.error('Unhandled error', { error: err, url: req.url });
665
+ next(err);
666
+ });
667
+ ```
668
+
669
+ During `build()`, the ordering is:
670
+ 1. Built-in middleware (cors, json, helmet, etc.)
671
+ 2. Custom middleware via `addMiddleware()`
672
+ 3. Auth middleware
673
+ 4. Routes (model routers + custom routes)
674
+ 5. **Error handling middleware via `addErrorHandlingMiddleware()`** ← inserted here
675
+ 6. TerrenoApp's built-in error handler (APIError formatting, stack traces)
676
+
677
+ ### WebSocket Support
678
+
679
+ ```typescript
680
+ const app = TerrenoApp.create({
681
+ auth: { ... },
682
+ webSocket: {
683
+ enabled: true,
684
+ path: '/ws',
685
+
686
+ // Authenticate WebSocket connections using the same JWT system
687
+ authenticate: async (request) => {
688
+ const token = new URL(request.url!, 'http://localhost').searchParams.get('token');
689
+ if (!token) return null;
690
+ return verifyToken(token); // Returns user or null
691
+ },
692
+
693
+ onConnection: (ws, user) => {
694
+ console.log(`User ${user?.id ?? 'anonymous'} connected`);
695
+ ws.send(JSON.stringify({ type: 'welcome', userId: user?.id }));
696
+ },
697
+
698
+ onMessage: (ws, message, user) => {
699
+ const data = JSON.parse(message.toString());
700
+ // Handle message...
701
+ },
702
+
703
+ onClose: (ws, code, reason, user) => {
704
+ console.log(`User ${user?.id} disconnected: ${code}`);
705
+ },
706
+ },
707
+ hooks: {
708
+ onWebSocketReady: (wss) => {
709
+ // Access the raw WebSocket server for advanced use cases
710
+ console.log('WebSocket server ready');
711
+ },
712
+ },
713
+ });
714
+
715
+ const { app, server, wss } = await app.start();
716
+
717
+ // Broadcast to all connected clients
718
+ wss.clients.forEach((client) => {
719
+ client.send(JSON.stringify({ type: 'broadcast', data: 'Hello everyone!' }));
720
+ });
721
+ ```
722
+
723
+ ### Graceful Shutdown
724
+
725
+ ```typescript
726
+ const app = TerrenoApp.create({
727
+ auth: { ... },
728
+ shutdown: {
729
+ handleSignals: true, // Auto-handle SIGTERM/SIGINT (default: true)
730
+ timeout: 30000, // 30 second timeout for graceful shutdown
731
+
732
+ onShutdown: async () => {
733
+ // Cleanup before shutdown
734
+ await mongoose.disconnect();
735
+ await redis.quit();
736
+ await closeSomeConnections();
737
+ },
738
+ },
739
+ });
740
+
741
+ await app.start();
742
+
743
+ // Can also trigger shutdown programmatically
744
+ process.on('custom-shutdown-event', async () => {
745
+ await app.shutdown();
746
+ });
747
+ ```
748
+
749
+ When `handleSignals` is true (default), TerrenoApp will:
750
+ 1. Stop accepting new connections
751
+ 2. Wait for existing requests to complete (up to `timeout`)
752
+ 3. Close WebSocket connections gracefully
753
+ 4. Call `onShutdown` hook
754
+ 5. Exit process
755
+
756
+ ### Disabling Features
757
+
758
+ ```typescript
759
+ const app = TerrenoApp.create({
760
+ auth: {
761
+ userModel: User,
762
+ token: { ... },
763
+ enableAuthRoutes: false, // Don't add /auth/* routes
764
+ enableMeRoute: false, // Don't add /me route
765
+ },
766
+ middleware: {
767
+ cors: false, // Disable CORS entirely
768
+ },
769
+ logging: {
770
+ requests: {
771
+ enabled: false, // Disable request logging
772
+ },
773
+ },
774
+ openApi: {
775
+ enabled: false, // Disable OpenAPI generation
776
+ },
777
+ health: {
778
+ enabled: false, // Disable health endpoint
779
+ },
780
+ });
781
+ ```
782
+
783
+ ### Testing Setup
784
+
785
+ ```typescript
786
+ // In tests
787
+ const app = TerrenoApp.create({
788
+ auth: { ... },
789
+ server: {
790
+ skipListen: true, // Don't start HTTP server
791
+ },
792
+ logging: {
793
+ requests: { enabled: false },
794
+ },
795
+ });
796
+
797
+ const expressApp = app.build(); // Get Express app without listening
798
+ // Use with supertest
799
+ ```
800
+
801
+ ---
802
+
803
+ ## Implementation Tasks
804
+
805
+ ### Phase 1: Core Implementation
806
+
807
+ Implement TerrenoApp with full test coverage. Each feature should be tested as it's built.
808
+
809
+ **New Files:**
810
+ - `TerrenoAppOptions.ts` - Option interfaces, defaults, and validation
811
+ - `TerrenoAppHooks.ts` - Hook type definitions and async runner
812
+ - `TerrenoApp.ts` - Main class with fluent API
813
+
814
+ **Features to implement (with tests):**
815
+ - `create()`, `build()`, `start()` lifecycle
816
+ - `addModelRouter()` with shorthand support
817
+ - `addRoute()` and `addMiddleware()`
818
+ - All toggleable middleware (cors, json, helmet, etc.)
819
+ - Health endpoint with custom check function
820
+ - All initialization and request lifecycle hooks
821
+ - WebSocket support with authentication
822
+ - Graceful shutdown with signal handling
823
+
824
+ **Update example-backend** to demonstrate the new API.
825
+
826
+ ### Phase 2: Deprecation & Documentation
827
+
828
+ - Add `@deprecated` JSDoc to `setupServer` and related exports in `expressServer.ts`
829
+ - Update `index.ts` to export TerrenoApp as primary API
830
+ - Keep setupServer export with deprecation warning
831
+ - Write migration guide for users
832
+
833
+ ---
834
+
835
+ ## Breaking Changes
836
+
837
+ This is a **breaking change** release. Users must migrate from `setupServer` to `TerrenoApp`.
838
+
839
+ ### What's Changing
840
+
841
+ 1. **`setupServer` deprecated** - Marked deprecated, will be removed in next major version
842
+ 2. **Environment variables no longer used** - All configuration via options (no fallback to env vars)
843
+ 3. **`modelRouter` unchanged** - Same signature and options, works with TerrenoApp
844
+ 4. **New primary API** - `TerrenoApp.create()` replaces `setupServer()`