@terreno/mcp 0.22.2 → 0.23.1

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,117 @@
1
+ # Task List: SyncDB Local-First Data Layer
2
+
3
+ *Structured task breakdown for automated implementation. Each task should be independently implementable and testable.*
4
+
5
+ ## Phase 1: Foundation
6
+
7
+ - [ ] **Task 1.1**: Scaffold `@terreno/syncdb` package
8
+ - Description: Create the package with core entrypoints, lifecycle interfaces, and typed configuration.
9
+ - Files: `syncdb/package.json` (new), `syncdb/src/index.ts` (new), `syncdb/src/types.ts` (new), `syncdb/README.md` (new)
10
+ - Depends on: none
11
+ - Acceptance: package compiles and exports `createSyncDbClient` and configuration types.
12
+
13
+ - [ ] **Task 1.2**: Define storage and sync contracts
14
+ - Description: Add canonical interfaces for entities, outbox records, sync cursors, conflicts, and keyring entries.
15
+ - Files: `syncdb/src/storage/types.ts` (new), `syncdb/src/sync/types.ts` (new), `syncdb/src/crypto/types.ts` (new)
16
+ - Depends on: Task 1.1
17
+ - Acceptance: type checks enforce required fields and operations.
18
+
19
+ ## Phase 2: Local DB and Encryption
20
+
21
+ - [ ] **Task 2.1**: Implement IndexedDB adapter with migrations
22
+ - Description: Add object stores for entities/outbox/cursors/conflicts/keyring and schema version migration support.
23
+ - Files: `syncdb/src/storage/indexedDb.ts` (new), `syncdb/src/storage/migrations.ts` (new), `syncdb/src/storage/indexedDb.test.ts` (new)
24
+ - Depends on: Task 1.2
25
+ - Acceptance: storage CRUD + migration tests pass.
26
+
27
+ - [ ] **Task 2.2**: Implement key manager (Web Crypto)
28
+ - Description: Add DEK generation + wrap/unwrap logic and persistence integration.
29
+ - Files: `syncdb/src/crypto/keyManager.ts` (new), `syncdb/src/crypto/keyManager.test.ts` (new)
30
+ - Depends on: Task 1.2
31
+ - Acceptance: key lifecycle tests pass for generate/wrap/unwrap/reload.
32
+
33
+ - [ ] **Task 2.3**: Encrypt IndexedDB payloads at rest
34
+ - Description: Add AES-GCM envelope encryption/decryption and integrate in storage read/write paths.
35
+ - Files: `syncdb/src/crypto/envelope.ts` (new), `syncdb/src/storage/secureStorage.ts` (new), `syncdb/src/crypto/envelope.test.ts` (new)
36
+ - Depends on: Task 2.1, Task 2.2
37
+ - Acceptance: tests verify no plaintext persistence and successful decrypt roundtrip.
38
+
39
+ ## Phase 3: Local Mutation Engine
40
+
41
+ - [ ] **Task 3.1**: Add optimistic local mutation application
42
+ - Description: Apply local patches immediately and retain inverse patches for rollback.
43
+ - Files: `syncdb/src/mutations/optimistic.ts` (new), `syncdb/src/mutations/optimistic.test.ts` (new)
44
+ - Depends on: Task 2.3
45
+ - Acceptance: immediate local apply and rollback tests pass.
46
+
47
+ - [ ] **Task 3.2**: Implement durable outbox state machine
48
+ - Description: Persist queued mutations and manage transitions `queued -> inFlight -> acked/conflicted/failed`.
49
+ - Files: `syncdb/src/mutations/outbox.ts` (new), `syncdb/src/mutations/outbox.test.ts` (new)
50
+ - Depends on: Task 3.1
51
+ - Acceptance: replay transition and retry logic tests pass.
52
+
53
+ - [ ] **Task 3.3**: Implement conflict capture and resolution
54
+ - Description: Persist conflict records and support `useServer` and `keepMine` resolution paths.
55
+ - Files: `syncdb/src/mutations/conflicts.ts` (new), `syncdb/src/mutations/conflicts.test.ts` (new)
56
+ - Depends on: Task 3.2
57
+ - Acceptance: both resolution strategies correctly update local state and queue state.
58
+
59
+ ## Phase 4: Websocket Delta Sync
60
+
61
+ - [ ] **Task 4.1**: Build sync transport client
62
+ - Description: Add websocket connect/auth/reconnect lifecycle and sync event channel handling.
63
+ - Files: `syncdb/src/sync/transport.ts` (new), `syncdb/src/sync/transport.test.ts` (new)
64
+ - Depends on: Task 1.2
65
+ - Acceptance: transport lifecycle tests pass including reconnect behavior.
66
+
67
+ - [ ] **Task 4.2**: Implement cursor-aware delta applier
68
+ - Description: Apply deltas idempotently with monotonic cursor checks and gap handling.
69
+ - Files: `syncdb/src/sync/deltaApplier.ts` (new), `syncdb/src/sync/deltaApplier.test.ts` (new)
70
+ - Depends on: Task 2.3, Task 4.1
71
+ - Acceptance: ordered delta tests pass; duplicate/out-of-order deltas are safely handled.
72
+
73
+ - [ ] **Task 4.3**: Wire ack/nack replay coordinator
74
+ - Description: Connect outbox replay to server ack/nack responses and conflict creation.
75
+ - Files: `syncdb/src/sync/replayCoordinator.ts` (new), `syncdb/src/sync/replayCoordinator.test.ts` (new)
76
+ - Depends on: Task 3.3, Task 4.2
77
+ - Acceptance: ack finalizes queued mutations; nack creates conflict records.
78
+
79
+ ## Phase 5: App Integration and Migration Bridge
80
+
81
+ - [ ] **Task 5.1**: Implement React hooks and provider
82
+ - Description: Add `useEntity`, `useQuery`, `useMutation`, `useSyncStatus`, and context provider wiring.
83
+ - Files: `syncdb/src/react/provider.tsx` (new), `syncdb/src/react/hooks.ts` (new), `syncdb/src/react/hooks.test.tsx` (new)
84
+ - Depends on: Task 3.3, Task 4.3
85
+ - Acceptance: hooks update on local mutations and remote deltas.
86
+
87
+ - [ ] **Task 5.2**: Add Redux migration bridge
88
+ - Description: Provide optional adapter for Redux-based consumers transitioning from `@terreno/rtk`.
89
+ - Files: `syncdb/src/bridge/reduxBridge.ts` (new), `syncdb/src/bridge/reduxBridge.test.ts` (new)
90
+ - Depends on: Task 5.1
91
+ - Acceptance: bridge supports selector and dispatch-driven mutation usage.
92
+
93
+ - [ ] **Task 5.3**: Integrate `example-frontend` todos behind `USE_SYNCDB`
94
+ - Description: Switch todos flow to syncdb under a feature flag while keeping legacy path available.
95
+ - Files: `example-frontend/store/index.ts`, `example-frontend/store/sdk.ts`, `example-frontend/app/(tabs)/index.tsx`, `example-frontend/app/_layout.tsx`
96
+ - Depends on: Task 5.1, Task 5.2
97
+ - Acceptance: flagged path supports offline local create/update/delete and sync reconciliation.
98
+
99
+ ## Phase 6: Codegen and Validation
100
+
101
+ - [ ] **Task 6.1**: Prototype `@terreno/syncdb-codegen`
102
+ - Description: Create codegen package that emits typed syncdb operation descriptors from OpenAPI.
103
+ - Files: `syncdb-codegen/package.json` (new), `syncdb-codegen/src/index.ts` (new), `syncdb-codegen/src/*.test.ts` (new)
104
+ - Depends on: Task 1.1
105
+ - Acceptance: generator produces valid descriptors for one sample domain.
106
+
107
+ - [ ] **Task 6.2**: Author migration docs
108
+ - Description: Document migration path from `@terreno/rtk` to `@terreno/syncdb` and rollout strategy.
109
+ - Files: `syncdb/README.md`, `docs/implementationPlans/syncdb-local-first.md`
110
+ - Depends on: Task 5.3
111
+ - Acceptance: docs include setup, API usage, and feature-flag rollout playbook.
112
+
113
+ - [ ] **Task 6.3**: Run validation suite
114
+ - Description: Execute compile, lint, and tests for touched packages and resolve regressions.
115
+ - Files: as needed in touched packages
116
+ - Depends on: Task 6.2
117
+ - Acceptance: relevant compile/lint/test commands pass with no blockers.
@@ -0,0 +1,73 @@
1
+ # Task List: Upgrade Banner
2
+
3
+ *Structured task breakdown for automated implementation. Each task should be independently implementable and testable.*
4
+
5
+ ## Phase 1: Backend + Admin
6
+
7
+ - [ ] **Task 1.1**: Create VersionConfig Mongoose model
8
+ - Description: Create the VersionConfig model with schema, interface, and TypeScript types in `@terreno/api`. Fields: webWarningVersion, webRequiredVersion, mobileWarningVersion, mobileRequiredVersion, warningMessage, requiredMessage, updateUrl. All version fields default to 0, messages have sensible defaults.
9
+ - Files: `api/src/models/versionConfig.ts` (create), `api/src/index.ts` (export)
10
+ - Depends on: none
11
+ - Acceptance: Model can be imported from `@terreno/api`, compiles cleanly, schema matches spec
12
+
13
+ - [ ] **Task 1.2**: Add public `GET /version-check` endpoint
14
+ - Description: Add a built-in public route via VersionCheckPlugin (TerrenoPlugin) that handles `GET /version-check?version=N&platform=web|mobile`. Fetches the singleton VersionConfig, compares the client's build number against the platform-specific thresholds, and returns a JSON object including status and, when a config exists, version threshold fields: `{status, message?, updateUrl?, requiredVersion?, warningVersion?}`. Returns `{status: "ok"}` if no config document exists.
15
+ - Files: `api/src/versionCheckPlugin.ts` (create - exports VersionCheckPlugin)
16
+ - Depends on: Task 1.1
17
+ - Acceptance: Endpoint returns correct status for all combinations: no config → ok, version >= warning → ok, version < warning → warning, version < required → required. No auth required.
18
+
19
+ - [ ] **Task 1.3**: Add admin `GET/PUT /admin/version-config` routes
20
+ - Description: Add admin-only routes for reading and upserting the singleton VersionConfig document. GET returns the current config (or defaults if none exists). PUT upserts the document. Both require `Permissions.IsAdmin`. Wire into AdminApp or as standalone admin routes.
21
+ - Files: `admin-backend/src/adminApp.ts` (modify) or `api/src/routes/versionCheck.ts` (extend)
22
+ - Depends on: Task 1.1
23
+ - Acceptance: Authenticated admin can GET and PUT the config. Non-admin gets 403. PUT creates if not exists, updates if exists.
24
+
25
+ - [ ] **Task 1.4**: Add admin frontend Version Config screen
26
+ - Description: Create a custom admin screen in `@terreno/admin-frontend` for editing the singleton VersionConfig. Form with all fields, "Save" button that PUTs to `/admin/version-config`. Add it as a special entry in the admin model list or as a standalone screen.
27
+ - Files: `admin-frontend/src/AdminVersionConfig.tsx` (create), `admin-frontend/src/index.tsx` (export)
28
+ - Depends on: Task 1.3
29
+ - Acceptance: Admin can view and edit all version config fields. Save persists to backend. Form loads existing values on mount.
30
+
31
+ - [ ] **Task 1.5**: Write unit tests for version check logic
32
+ - Description: Test the version check endpoint logic: no config returns ok, version comparisons for web and mobile platforms, edge cases (version = 0, version = threshold exactly, missing query params).
33
+ - Files: `api/src/__tests__/versionCheck.test.ts` (create)
34
+ - Depends on: Task 1.2
35
+ - Acceptance: All test cases pass covering ok/warning/required status for both platforms.
36
+
37
+ - [ ] **Task 1.6**: Wire up example backend
38
+ - Description: Ensure the example backend includes the VersionConfig model and version-check endpoint. Verify the admin panel shows the version config screen.
39
+ - Files: `example-backend/src/server.ts` (modify if needed)
40
+ - Depends on: Task 1.3, Task 1.4
41
+ - Acceptance: Running the example backend exposes `/version-check` and `/admin/version-config`. Admin panel shows the config screen.
42
+
43
+ ## Phase 2: Client + CI
44
+
45
+ - [ ] **Task 2.1**: Create `UpgradeRequiredScreen` component
46
+ - Description: Build a full-screen blocking component in `@terreno/ui`. Centered layout with warning icon, configurable message text, and an "Update" button. The button calls an `onUpdate` callback prop. No dismiss, no navigation escape. Props: `message: string`, `onUpdate: () => void`.
47
+ - Files: `ui/src/UpgradeRequiredScreen.tsx` (create), `ui/src/index.ts` (export)
48
+ - Depends on: none
49
+ - Acceptance: Component renders full-screen with message and button. Button triggers onUpdate. No way to dismiss or navigate away.
50
+
51
+ - [ ] **Task 2.2**: Create `useUpgradeCheck` hook
52
+ - Description: Build a hook in `@terreno/rtk` that checks `GET /version-check` on mount. Gets build number from `Constants.expoConfig.extra.buildNumber`, platform from existing `IsWeb` util. On "warning": shows persistent toast with message + "Update" button + dismiss X. On "required": returns `{isRequired: true, requiredMessage, onUpdate}`. The `onUpdate` function handles platform logic: web → `window.location.reload()`, mobile → try `expo-updates` `fetchUpdateAsync()`/`reloadAsync()`, fall back to `Linking.openURL(updateUrl)`. Skips check if build number is undefined.
53
+ - Files: `rtk/src/useUpgradeCheck.ts` (create), `rtk/src/index.ts` (export)
54
+ - Depends on: Task 1.2
55
+ - Acceptance: Hook returns correct state for ok/warning/required. Toast appears for warning. isRequired flag set for required. onUpdate triggers appropriate platform action.
56
+
57
+ - [ ] **Task 2.3**: Add `app.config.ts` build number injection
58
+ - Description: Create or update `app.config.ts` in the example frontend to dynamically set `expo.extra.buildNumber` from `git rev-list --count HEAD` at build time. Document the pattern for consuming apps.
59
+ - Files: `example-frontend/app.config.ts` (create/modify), `example-frontend/app.json` (may need adjustment)
60
+ - Depends on: none
61
+ - Acceptance: Running `expo start` or `expo build` sets `Constants.expoConfig.extra.buildNumber` to the current git commit count.
62
+
63
+ - [ ] **Task 2.4**: Wire up example frontend
64
+ - Description: Add `useUpgradeCheck()` to the example frontend's root layout. When `isRequired` is true, render `UpgradeRequiredScreen` instead of normal app content.
65
+ - Files: `example-frontend/app/_layout.tsx` (modify)
66
+ - Depends on: Task 2.1, Task 2.2, Task 2.3
67
+ - Acceptance: Example app checks version on mount. Warning shows toast. Required shows blocking screen. Normal operation when version is ok or build number is missing.
68
+
69
+ - [ ] **Task 2.5**: Document GitHub Actions build number pattern
70
+ - Description: Add a CI snippet or documentation showing how to inject the build number in GitHub Actions workflows using `git rev-list --count HEAD`. Include examples for both EAS Build and web deployments.
71
+ - Files: `docs/how-to/upgrade-banner.md` (create) or inline in example-frontend README
72
+ - Depends on: Task 2.3
73
+ - Acceptance: Clear instructions for consuming apps to set up automatic build numbering in CI.
@@ -0,0 +1,7 @@
1
+ # Tutorials
2
+
3
+ Learning-oriented, hands-on lessons. Start here if you are new to Terreno.
4
+
5
+ ## Contents
6
+
7
+ - [Getting started](getting-started.md) — Install, run the examples, and see the stack in action
@@ -0,0 +1,44 @@
1
+ # Getting Started
2
+
3
+ Run the example full stack to see Terreno in action.
4
+
5
+ ## Prerequisites
6
+
7
+ - [Bun](https://bun.sh/) installed
8
+ - MongoDB running (for the backend example)
9
+
10
+ ## Steps
11
+
12
+ 1. **Clone and install**
13
+
14
+ ```bash
15
+ bun install
16
+ ```
17
+
18
+ 2. **Start the backend** (terminal 1)
19
+
20
+ ```bash
21
+ bun run backend:dev
22
+ ```
23
+
24
+ Backend runs at `http://localhost:4000`. OpenAPI spec at `/openapi.json`.
25
+
26
+ 3. **Start the frontend** (terminal 2)
27
+
28
+ ```bash
29
+ bun run frontend:web
30
+ ```
31
+
32
+ Frontend runs in the browser and talks to the backend.
33
+
34
+ 4. **Optional: regenerate SDK** after backend route changes
35
+
36
+ ```bash
37
+ cd example-frontend && bun run sdk
38
+ ```
39
+
40
+ ## Next steps
41
+
42
+ - [How to create a model](../how-to/create-a-model.md) — Learn model conventions including required field descriptions
43
+ - [How-to guides](../how-to/) — Task-focused guides
44
+ - [Reference](../reference/) — Package and API details
@@ -146,12 +146,16 @@ The base URL is resolved in priority order:
146
146
 
147
147
  1. `Constants.expoConfig?.extra?.BASE_URL` (production/staging builds)
148
148
  2. `process.env.EXPO_PUBLIC_API_URL` (development web)
149
- 3. `Constants.expoConfig?.hostUri` + `:3000` (dev simulator/device)
150
- 4. `http://localhost:3000` (fallback)
149
+ 3. `Constants.expoConfig?.hostUri` + the dev API port (dev simulator/device)
150
+ 4. `http://localhost:<dev API port>` (fallback)
151
+
152
+ The dev API port defaults to `4000` and is overridable per app via `EXPO_PUBLIC_DEV_API_PORT`
153
+ or `expoConfig.extra.DEV_API_PORT` (for example `3000` or `9000`).
151
154
 
152
155
  | Variable | Required | Default | Description |
153
156
  |----------|----------|---------|-------------|
154
- | `EXPO_PUBLIC_API_URL` | ❌ | Auto-detected | Backend API base URL<br/>Web: `http://localhost:3000`<br/>Simulator: Auto-detected via `hostUri`<br/>Device: Use your computer's local IP |
157
+ | `EXPO_PUBLIC_API_URL` | ❌ | Auto-detected | Backend API base URL<br/>Web: `http://localhost:4000`<br/>Simulator: Auto-detected via `hostUri`<br/>Device: Use your computer's local IP |
158
+ | `EXPO_PUBLIC_DEV_API_PORT` | ❌ | 4000 | Local dev API port for host/localhost resolution (also settable via `extra.DEV_API_PORT`) |
155
159
 
156
160
  ### Debug Flags
157
161
 
@@ -337,8 +337,11 @@ Base RTK Query API with authentication, retry logic, and automatic token refresh
337
337
  **Base URL Resolution (priority order):**
338
338
  1. `Constants.expoConfig?.extra?.BASE_URL` (production/staging)
339
339
  2. `process.env.EXPO_PUBLIC_API_URL` (dev web)
340
- 3. `Constants.expoConfig?.hostUri` + `:3000` (dev simulator/device)
341
- 4. `http://localhost:3000` (fallback)
340
+ 3. `Constants.expoConfig?.hostUri` + the dev API port (dev simulator/device)
341
+ 4. `http://localhost:<dev API port>` (fallback)
342
+
343
+ The dev API port defaults to `4000` and is overridable per app via `EXPO_PUBLIC_DEV_API_PORT`
344
+ or `expoConfig.extra.DEV_API_PORT` (for example `3000` or `9000`).
342
345
 
343
346
  ## Debugging
344
347
 
@@ -396,14 +399,18 @@ Configuration for frontend apps using @terreno/rtk:
396
399
  | Variable | Required | Default | Description |
397
400
  |----------|----------|---------|-------------|
398
401
  | `EXPO_PUBLIC_API_URL` | No | Auto-detected | Backend API base URL (production/staging deployments) |
402
+ | `EXPO_PUBLIC_DEV_API_PORT` | No | 4000 | Local dev API port for host/localhost resolution (also settable via `extra.DEV_API_PORT`) |
399
403
  | `NODE_ENV` | No | `development` | Environment: `development`, `production`, `test` |
400
404
 
401
405
  **Base URL resolution priority:**
402
406
 
403
407
  1. `Constants.expoConfig?.extra?.BASE_URL` (from `app.json` `extra` field)
404
408
  2. `process.env.EXPO_PUBLIC_API_URL` (for web development)
405
- 3. `Constants.expoConfig?.hostUri` + `:3000` (for Expo dev server - simulator/device)
406
- 4. `http://localhost:3000` (fallback)
409
+ 3. `Constants.expoConfig?.hostUri` + the dev API port (for Expo dev server - simulator/device)
410
+ 4. `http://localhost:<dev API port>` (fallback)
411
+
412
+ The dev API port defaults to `4000` and is overridable per app via `EXPO_PUBLIC_DEV_API_PORT`
413
+ or `expoConfig.extra.DEV_API_PORT` (for example `3000` or `9000`).
407
414
 
408
415
  **Example `app.json` configuration:**
409
416
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@terreno/mcp",
3
- "version": "0.22.2",
3
+ "version": "0.23.1",
4
4
  "description": "MCP server for Terreno - provides documentation, tools, and prompts for building full-stack apps",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",
@@ -27,13 +27,13 @@
27
27
  "dependencies": {
28
28
  "@modelcontextprotocol/sdk": "^1.27.0",
29
29
  "@sentry/bun": "^10.39.0",
30
- "@terreno/api": "0.22.2",
30
+ "@terreno/api": "0.23.1",
31
31
  "minisearch": "^7.2.0",
32
32
  "mongoose": "8.23.0"
33
33
  },
34
34
  "devDependencies": {
35
35
  "@biomejs/biome": "^2.3.6",
36
- "@types/bun": "^1.2.4",
36
+ "@types/bun": "^1.3.8",
37
37
  "@types/node": "^25.3.0",
38
38
  "typescript": "~5.9.2"
39
39
  },
@@ -0,0 +1,29 @@
1
+ # Terreno Documentation
2
+
3
+ Documentation for the Terreno monorepo: shared packages for full-stack applications with React Native and Express/Mongoose.
4
+
5
+ ## Structure
6
+
7
+ - **[Tutorials](tutorials/)** — Learning-oriented, hands-on lessons
8
+ - **[How-to guides](how-to/)** — Problem-oriented, practical steps
9
+ - **[Reference](reference/)** — Technical reference for APIs and packages
10
+ - **[Explanation](explanation/)** — Concepts and context
11
+ - **[Implementation Plans](implementationPlans/)** — Forward-looking plans for major features
12
+
13
+ ## Packages
14
+
15
+ | Package | Description |
16
+ |---------|-------------|
17
+ | [@terreno/api](reference/api.md) | REST API framework (Express/Mongoose) |
18
+ | [@terreno/ui](reference/ui.md) | React Native UI component library |
19
+ | [@terreno/rtk](reference/rtk.md) | RTK Query utilities for API backends |
20
+ | [@terreno/admin-backend](reference/admin-backend.md) | Admin panel backend plugin |
21
+ | [@terreno/admin-frontend](reference/admin-frontend.md) | Admin panel frontend screens |
22
+ | [@terreno/api-health](reference/api-health.md) | Health check endpoint plugin |
23
+ | [@terreno/mcp](reference/mcp-server.md) | AI coding assistant integration (MCP) |
24
+
25
+ ## Quick links
26
+
27
+ - [Getting started](tutorials/getting-started.md)
28
+ - [AGENTS.md](../AGENTS.md) — Onboarding context for AI assistants
29
+ - [.cursorrules](../.cursorrules) — Project and code style rules
@@ -0,0 +1,13 @@
1
+ # Explanation
2
+
3
+ Understanding-oriented documentation: concepts, architecture, and context.
4
+
5
+ ## Contents
6
+
7
+ - [AI-powered workflows](ai-workflows.md) — Autonomous documentation, testing, and maintenance workflows
8
+ - [Authentication architecture](authentication.md) — How JWT, OAuth, and token refresh work
9
+ - [Configuration system](configuration-system.md) — Runtime configuration with database persistence
10
+ - [Dependency management](dependency-management.md) — Dependabot, auto-merge, and security practices
11
+ - [GCP hosting architecture](gcp-hosting-architecture.md) — Static site hosting with GCS and Cloud CDN
12
+ - [Modular API design](modular-api-design.md) — 🚧 Why TerrenoApp replaces setupServer
13
+ - [modelRouter actions](model-router-actions.md) — Named collection and instance operations on modelRouter
@@ -0,0 +1,270 @@
1
+ # AI-Powered Workflows
2
+
3
+ Understanding Terreno's autonomous AI workflows for continuous improvement.
4
+
5
+ ## Overview
6
+
7
+ Terreno uses GitHub Actions with AI agents to maintain code quality, documentation, and developer experience. These workflows run automatically and create pull requests when improvements are needed.
8
+
9
+ ## Workflow Categories
10
+
11
+ ### Documentation Workflows
12
+
13
+ #### Update Docs
14
+ **Trigger:** Push to master
15
+ **Purpose:** Keeps documentation synchronized with code changes
16
+
17
+ Analyzes code diffs after each merge to identify:
18
+ - New or changed APIs, functions, classes
19
+ - Missing or outdated documentation
20
+ - Documentation gaps that need attention
21
+
22
+ **Output:** Draft pull requests with documentation updates following the Diátaxis framework (tutorials, how-to guides, reference, explanation).
23
+
24
+ **Philosophy:** Treats documentation gaps like failing tests — they must be fixed.
25
+
26
+ #### Update Rules
27
+ **Trigger:** Push to master
28
+ **Purpose:** Keeps AI assistant rules synchronized with codebase changes
29
+
30
+ Maintains the single source of truth in `.rulesync/rules/` and ensures:
31
+ - `.cursorrules` (Cursor IDE)
32
+ - `.windsurfrules` (Windsurf IDE)
33
+ - `AGENTS.md` (Claude Code, Copilot)
34
+ - `.github/copilot-instructions.md` (GitHub Copilot)
35
+
36
+ **Workflow:**
37
+ 1. Detects package changes, new APIs, or convention updates
38
+ 2. Updates source files in `.rulesync/rules/`
39
+ 3. Creates PR with instructions to run `bun run rules` to regenerate outputs
40
+ 4. Ensures `rulesync-check` CI passes
41
+
42
+ **Key insight:** Rule files are code — they must be kept in sync with implementation.
43
+
44
+ ### Code Quality Workflows
45
+
46
+ #### Daily JSDoc Improver
47
+ **Trigger:** Daily schedule + push to master
48
+ **Purpose:** Systematically improves JSDoc documentation across the codebase
49
+
50
+ **Two modes:**
51
+ - **Targeted (on push):** Improves JSDoc for files changed in recent commits
52
+ - **Systematic (daily):** Three-phase approach covering entire codebase
53
+
54
+ **Output:** Draft PRs with improved JSDoc comments on exported functions, methods, and classes.
55
+
56
+ #### Daily Test Improver
57
+ **Trigger:** Daily schedule
58
+ **Purpose:** Enhances test coverage and test quality
59
+
60
+ Analyzes test files and implementation to:
61
+ - Add missing test cases
62
+ - Improve test clarity and coverage
63
+ - Identify edge cases that need testing
64
+ - Ensure tests follow best practices
65
+
66
+ **Output:** Draft PRs with test improvements.
67
+
68
+ ### Maintenance Workflows
69
+
70
+ #### Agentic Maintenance
71
+ **Trigger:** Daily at 00:37 UTC
72
+ **Purpose:** Cleans up expired issues, discussions, and pull requests
73
+
74
+ Automatically closes expired entities based on the `expires` field in safe-outputs configuration. Schedule is determined by the shortest expiration time across all workflows.
75
+
76
+ **Prevents:** Stale issues and PRs from accumulating.
77
+
78
+ #### RulesSync Check
79
+ **Trigger:** Pull request
80
+ **Purpose:** Validates that generated rule files are synchronized with sources
81
+
82
+ **Validation steps:**
83
+ 1. Runs `bun run rules` to regenerate outputs
84
+ 2. Checks for uncommitted changes
85
+ 3. Fails if generated files don't match committed versions
86
+
87
+ **Prevents:** Merging PRs with out-of-sync rule files.
88
+
89
+ ## CI/CD Workflows
90
+
91
+ ### Package Testing
92
+
93
+ Each package has its own CI workflow that runs on pull requests and pushes:
94
+
95
+ | Workflow | Package | Tests |
96
+ |----------|---------|-------|
97
+ | `api-ci.yml` | @terreno/api | Unit tests, type checking, linting |
98
+ | `ui-ci.yml` | @terreno/ui | Component tests, type checking, linting |
99
+ | `rtk-ci.yml` | @terreno/rtk | Unit tests, type checking, linting |
100
+ | `mcp-server-ci.yml` | @terreno/mcp | Integration tests, type checking, linting |
101
+ | `example-backend-ci.yml` | example-backend | Integration tests, type checking |
102
+ | `example-frontend-ci.yml` | example-frontend | Build verification, type checking |
103
+ | `ui-demo-ci.yml` | demo | Build verification, type checking |
104
+
105
+ ### Deployment Workflows
106
+
107
+ #### Demo Deploy
108
+ **Trigger:** Push to master
109
+ **Purpose:** Deploys UI demo to Google Cloud Storage with Cloud CDN
110
+
111
+ **Architecture:** Static site hosting with custom domain, SSL, and CDN acceleration.
112
+
113
+ **Learn more:** [GCP Hosting Architecture](gcp-hosting-architecture.md), [Deploy to GCP](../how-to/deploy-to-gcp.md)
114
+
115
+ #### Frontend Example Deploy
116
+ **Trigger:** Push to master, pull request
117
+ **Purpose:** Deploys example frontend with preview environments
118
+
119
+ **Features:**
120
+ - **Production:** Deploys to production GCS bucket on master
121
+ - **Preview:** Creates preview environments for pull requests
122
+ - **Cleanup:** Automatically removes preview environments when PRs close
123
+
124
+ #### MCP Server Deploy
125
+ **Trigger:** Push to master
126
+ **Purpose:** Deploys Model Context Protocol server
127
+
128
+ Builds and deploys the MCP server for AI coding assistant integration.
129
+
130
+ #### Preview Cleanup
131
+ **Trigger:** Pull request close
132
+ **Purpose:** Removes preview deployments when PRs are closed or merged
133
+
134
+ Ensures preview environments don't accumulate and waste resources.
135
+
136
+ ### Security & Quality
137
+
138
+ #### CodeQL Analysis
139
+ **Trigger:** Push to master, pull request, schedule (weekly)
140
+ **Purpose:** Security vulnerability scanning with GitHub CodeQL
141
+
142
+ **Languages analyzed:** JavaScript, TypeScript
143
+
144
+ **Output:** Security alerts in the Security tab when vulnerabilities are found.
145
+
146
+ #### Dependabot Auto-merge
147
+ **Trigger:** Dependabot pull request opened
148
+ **Purpose:** Automatically merges dependency updates after CI passes
149
+
150
+ **Requirements for auto-merge:**
151
+ - All CI checks pass
152
+ - Dependabot PR (created by Dependabot)
153
+ - No conflicts
154
+ - 7-day cooldown for security (see Dependency Management)
155
+
156
+ **Learn more:** [Dependency Management](dependency-management.md)
157
+
158
+ ### Publishing
159
+
160
+ #### Publish on Tag
161
+ **Trigger:** Tag push matching `v*.*.*`
162
+ **Purpose:** Publishes packages to npm registry
163
+
164
+ **Workflow:**
165
+ 1. Validates tag format and package versions match
166
+ 2. Runs full test suite
167
+ 3. Publishes to npm with appropriate tags (`latest` or `next`)
168
+ 4. Creates GitHub release with changelog
169
+
170
+ **Packages published:**
171
+ - @terreno/api
172
+ - @terreno/ui
173
+ - @terreno/rtk
174
+ - @terreno/mcp
175
+
176
+ ## Workflow Philosophy
177
+
178
+ ### Single Source of Truth
179
+ - **Documentation:** Code is truth, docs must reflect it
180
+ - **Rules:** `.rulesync/rules/` is truth, generated files derive from it
181
+ - **Tests:** Implementation is truth, tests verify it
182
+
183
+ ### Fail Fast
184
+ - All checks must pass before merge
185
+ - Generated files must be committed (no drift)
186
+ - Documentation gaps are treated like failing tests
187
+
188
+ ### Autonomous Improvement
189
+ - Workflows create PRs, not commits
190
+ - PRs are drafts requiring human review
191
+ - Workflow agents make suggestions, humans make decisions
192
+
193
+ ### Continuous Sync
194
+ - Documentation syncs on every master push
195
+ - Rules sync on every master push
196
+ - Dependencies update daily (Dependabot)
197
+ - Quality improvements run daily (JSDoc, tests)
198
+
199
+ ## Working with AI Workflows
200
+
201
+ ### When a Workflow Creates a PR
202
+
203
+ 1. **Review the changes** — AI is helpful but not perfect
204
+ 2. **Run suggested commands** — E.g., `bun run rules` for rule updates
205
+ 3. **Test locally** — Ensure changes work as intended
206
+ 4. **Approve or close** — Merge if valuable, close if not
207
+
208
+ ### When a Workflow Fails
209
+
210
+ Check the workflow run logs in the Actions tab:
211
+ - **Documentation updates:** May need manual clarification
212
+ - **Rule updates:** May need manual fixes to `.rulesync/rules/`
213
+ - **JSDoc/test improvements:** May need guidance on conventions
214
+
215
+ ### Customizing Workflows
216
+
217
+ Workflow definitions live in `.github/workflows/*.md` files. These are compiled into `.github/workflows/*.lock.yml` by the GitHub Agentic Workflows CLI.
218
+
219
+ **To customize:**
220
+ 1. Edit the `.md` source file (e.g., `update-docs.md`)
221
+ 2. Run `gh aw compile` (if using gh-aw CLI)
222
+ 3. Commit both the `.md` and regenerated `.lock.yml`
223
+
224
+ **Note:** Never edit `.lock.yml` files directly — they are generated.
225
+
226
+ ## Best Practices
227
+
228
+ ### For Maintainers
229
+ - **Review workflow PRs regularly** — Don't let them accumulate
230
+ - **Provide feedback** — If a workflow generates bad suggestions, close with a comment explaining why
231
+ - **Tune prompts** — If a workflow consistently misses the mark, update the `.md` file
232
+
233
+ ### For Contributors
234
+ - **Run CI before pushing** — `bun run lint && bun run test`
235
+ - **Update rules if needed** — `bun run rules` after changing `.rulesync/rules/`
236
+ - **Check workflow status** — Ensure your PR doesn't break workflows
237
+
238
+ ### For Users
239
+ - **Check Actions tab** — See what's running and what's pending
240
+ - **Review draft PRs** — Workflow-generated PRs may contain useful improvements
241
+ - **Report issues** — If a workflow behaves unexpectedly, open an issue
242
+
243
+ ## Troubleshooting
244
+
245
+ ### Workflow doesn't run when expected
246
+ - Check `.github/workflows/*.yml` trigger configuration
247
+ - Verify branch name matches (usually `master`)
248
+ - Check workflow permissions and safe-outputs limits
249
+
250
+ ### RulesSync check fails on PR
251
+ - Run `bun run rules` locally
252
+ - Commit any generated file changes
253
+ - Ensure `.rulesync/rules/` files have valid YAML frontmatter
254
+
255
+ ### Dependabot PR doesn't auto-merge
256
+ - Verify all CI checks pass (green checkmarks)
257
+ - Check 7-day cooldown hasn't been violated
258
+ - Ensure no merge conflicts exist
259
+
260
+ ### AI workflow creates poor quality PR
261
+ - Review the workflow definition in `.github/workflows/*.md`
262
+ - Consider customizing the prompt or instructions
263
+ - Close the PR with feedback for future improvements
264
+
265
+ ## Related Documentation
266
+
267
+ - [Dependency Management](dependency-management.md) — Dependabot configuration and auto-merge
268
+ - [Deploy to GCP](../how-to/deploy-to-gcp.md) — Manual deployment guide
269
+ - [GCP Hosting Architecture](gcp-hosting-architecture.md) — Static site hosting design
270
+ - [Environment Variables](../reference/environment-variables.md) — Configuration reference