@lupinum/better-convex-nuxt 1.0.0-beta.6 → 1.0.0-beta.7

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 (89) hide show
  1. package/README.md +29 -0
  2. package/dist/agent/AGENTS.md +102 -0
  3. package/dist/agent/manifest.json +587 -0
  4. package/dist/agent/pages/docs/build/agents/mcp-apps.md +206 -0
  5. package/dist/agent/pages/docs/build/agents/mcp.md +376 -0
  6. package/dist/agent/pages/docs/build/application-behavior/connection-state.md +89 -0
  7. package/dist/agent/pages/docs/build/application-behavior/devtools.md +51 -0
  8. package/dist/agent/pages/docs/build/application-behavior/error-handling.md +66 -0
  9. package/dist/agent/pages/docs/build/application-behavior/logging.md +69 -0
  10. package/dist/agent/pages/docs/build/application-behavior/performance.md +62 -0
  11. package/dist/agent/pages/docs/build/authentication/auth-state-and-user.md +59 -0
  12. package/dist/agent/pages/docs/build/authentication/backend-authorization.md +84 -0
  13. package/dist/agent/pages/docs/build/authentication/better-auth-plugins.md +95 -0
  14. package/dist/agent/pages/docs/build/authentication/better-auth-setup.md +162 -0
  15. package/dist/agent/pages/docs/build/authentication/custom-user-fields.md +60 -0
  16. package/dist/agent/pages/docs/build/authentication/delegated-oauth-and-mcp.md +369 -0
  17. package/dist/agent/pages/docs/build/authentication/overview.md +60 -0
  18. package/dist/agent/pages/docs/build/authentication/route-protection.md +66 -0
  19. package/dist/agent/pages/docs/build/authentication/sign-in-and-sign-out.md +82 -0
  20. package/dist/agent/pages/docs/build/authentication/transactional-email.md +95 -0
  21. package/dist/agent/pages/docs/build/authentication/user-synchronization.md +132 -0
  22. package/dist/agent/pages/docs/build/authentication/workforce-profile.md +201 -0
  23. package/dist/agent/pages/docs/build/files/storage-urls.md +71 -0
  24. package/dist/agent/pages/docs/build/files/upload-files.md +135 -0
  25. package/dist/agent/pages/docs/build/files/validation-and-deletion.md +66 -0
  26. package/dist/agent/pages/docs/build/queries/loading-and-stale-data.md +62 -0
  27. package/dist/agent/pages/docs/build/queries/pagination.md +111 -0
  28. package/dist/agent/pages/docs/build/queries/queries.md +113 -0
  29. package/dist/agent/pages/docs/build/queries/reactive-arguments.md +80 -0
  30. package/dist/agent/pages/docs/build/queries/ssr-options.md +61 -0
  31. package/dist/agent/pages/docs/build/server/credentials-and-security.md +80 -0
  32. package/dist/agent/pages/docs/build/server/server-convex.md +144 -0
  33. package/dist/agent/pages/docs/build/server/server-routes.md +76 -0
  34. package/dist/agent/pages/docs/build/server/webhooks-and-jobs.md +64 -0
  35. package/dist/agent/pages/docs/build/write-data/actions.md +65 -0
  36. package/dist/agent/pages/docs/build/write-data/concurrent-operations.md +69 -0
  37. package/dist/agent/pages/docs/build/write-data/forms.md +76 -0
  38. package/dist/agent/pages/docs/build/write-data/mutations.md +60 -0
  39. package/dist/agent/pages/docs/build/write-data/optimistic-updates.md +102 -0
  40. package/dist/agent/pages/docs/get-started/add-a-mutation.md +111 -0
  41. package/dist/agent/pages/docs/get-started/add-authentication.md +218 -0
  42. package/dist/agent/pages/docs/get-started/choose-your-path.md +111 -0
  43. package/dist/agent/pages/docs/get-started/first-realtime-page.md +104 -0
  44. package/dist/agent/pages/docs/get-started/installation.md +126 -0
  45. package/dist/agent/pages/docs/get-started/next-steps.md +59 -0
  46. package/dist/agent/pages/docs/get-started/plain-vue.md +160 -0
  47. package/dist/agent/pages/docs/get-started/project-structure.md +91 -0
  48. package/dist/agent/pages/docs/get-started/protect-data.md +135 -0
  49. package/dist/agent/pages/docs/operations/beta3-session-generation-migration.md +101 -0
  50. package/dist/agent/pages/docs/operations/deployment.md +87 -0
  51. package/dist/agent/pages/docs/operations/environment-variables.md +103 -0
  52. package/dist/agent/pages/docs/operations/release-compatibility.md +70 -0
  53. package/dist/agent/pages/docs/operations/security-model.md +72 -0
  54. package/dist/agent/pages/docs/operations/troubleshooting.md +72 -0
  55. package/dist/agent/pages/docs/overview/comparison.md +88 -0
  56. package/dist/agent/pages/docs/overview/introduction.md +78 -0
  57. package/dist/agent/pages/docs/overview/limitations.md +92 -0
  58. package/dist/agent/pages/docs/overview/use-cases.md +81 -0
  59. package/dist/agent/pages/docs/overview/who-it-is-for.md +57 -0
  60. package/dist/agent/pages/docs/overview/why-better-convex-nuxt.md +88 -0
  61. package/dist/agent/pages/docs/recipes/authenticated-server-route.md +54 -0
  62. package/dist/agent/pages/docs/recipes/component-testing.md +166 -0
  63. package/dist/agent/pages/docs/recipes/file-upload-form.md +70 -0
  64. package/dist/agent/pages/docs/recipes/infinite-scroll.md +66 -0
  65. package/dist/agent/pages/docs/recipes/optimistic-todo-list.md +93 -0
  66. package/dist/agent/pages/docs/recipes/organization-permissions.md +77 -0
  67. package/dist/agent/pages/docs/recipes/protected-dashboard.md +90 -0
  68. package/dist/agent/pages/docs/recipes/public-and-private-data.md +68 -0
  69. package/dist/agent/pages/docs/recipes/realtime-feed.md +106 -0
  70. package/dist/agent/pages/docs/reference/api-surface.md +128 -0
  71. package/dist/agent/pages/docs/reference/composables.md +168 -0
  72. package/dist/agent/pages/docs/reference/error-types.md +60 -0
  73. package/dist/agent/pages/docs/reference/module-configuration.md +75 -0
  74. package/dist/agent/pages/docs/reference/package-exports.md +77 -0
  75. package/dist/agent/pages/docs/reference/server-api.md +90 -0
  76. package/dist/agent/pages/docs/understand/authentication-and-identity.md +104 -0
  77. package/dist/agent/pages/docs/understand/design-decisions.md +100 -0
  78. package/dist/agent/pages/docs/understand/errors-and-failures.md +87 -0
  79. package/dist/agent/pages/docs/understand/glossary.md +86 -0
  80. package/dist/agent/pages/docs/understand/mental-model.md +76 -0
  81. package/dist/agent/pages/docs/understand/query-ownership-and-caching.md +65 -0
  82. package/dist/agent/pages/docs/understand/request-lifecycle.md +68 -0
  83. package/dist/agent/pages/docs/understand/server-and-client-boundaries.md +95 -0
  84. package/dist/agent/pages/docs/understand/ssr-hydration-realtime.md +78 -0
  85. package/dist/agent/pages/docs.md +18 -0
  86. package/dist/module.json +1 -1
  87. package/dist/runtime/shared/release-fingerprint.js +1 -1
  88. package/package.json +10 -7
  89. package/security/upstream-convex-better-auth.json +1 -1
package/README.md CHANGED
@@ -127,6 +127,35 @@ or the first signing key. It refuses production provisioning.
127
127
 
128
128
  MCP remains opt in. Installing the Vue or Nuxt package does not start an MCP server or grant application authority.
129
129
 
130
+ <!-- BEGIN:consumer-onboarding -->
131
+
132
+ ## Use a coding agent
133
+
134
+ A coding agent is a development tool that can inspect and change your project.
135
+ After installation, copy this prompt into your coding agent:
136
+
137
+ ```text
138
+ Add Better Convex to this application using the smallest suitable Nuxt, Vue,
139
+ or MCP package. Read the project's existing instructions first. Resolve the
140
+ installed @lupinum/better-convex-*/agent-docs export from this application's
141
+ directory and read its starting pages. Use the installed version's examples
142
+ and public types. Preserve existing authorization, routes, conventions, and
143
+ AGENTS.md instructions. Convex functions remain the source of truth for
144
+ authorization; do not move that rule into client state, Nuxt middleware, or MCP
145
+ transport. Add or update one short Better Convex pointer in AGENTS.md if the
146
+ project allows it; do not duplicate the documentation. If the file is absent,
147
+ create only that pointer. Report missing guidance. Verify the affected type,
148
+ build, runtime, authentication, and disposal boundaries.
149
+ ```
150
+
151
+ If the installed package has no `agent-docs` export, read its packaged README
152
+ and types. Use documentation from the matching source tag when more detail is
153
+ needed. Installing or updating the package does not edit project instructions.
154
+ The pointer resolves the installed package, so upgrades and rollbacks select
155
+ the matching documentation without copying it into your application.
156
+
157
+ <!-- END:consumer-onboarding -->
158
+
130
159
  ## Documentation
131
160
 
132
161
  Read the [Better Convex documentation](https://better-convex.lupinum.com). Start with [choose your path](https://better-convex.lupinum.com/docs/get-started/choose-your-path), the [mental model](https://better-convex.lupinum.com/docs/understand/mental-model), and [limitations](https://better-convex.lupinum.com/docs/overview/limitations).
@@ -0,0 +1,102 @@
1
+ # @lupinum/better-convex-nuxt
2
+
3
+ Documentation for installed version 1.0.0-beta.7.
4
+
5
+ Read the relevant local pages before changing this package’s integration.
6
+ Project instructions govern architecture, style and permissions.
7
+
8
+ ## Start here
9
+
10
+ - [Choose Your Path](./pages/docs/get-started/choose-your-path.md) — /docs/get-started/choose-your-path
11
+ - [Installation](./pages/docs/get-started/installation.md) — /docs/get-started/installation
12
+ - [Limitations and Trade-offs](./pages/docs/overview/limitations.md) — /docs/overview/limitations
13
+
14
+ ## Find a page
15
+
16
+ The index below maps public documentation routes to this installed snapshot.
17
+ For links to this documentation site, use the matching local page in manifest.json
18
+ instead of fetching a possibly different website version. Preserve URL fragments.
19
+ External dependencies have their own versioned contracts. Report missing guidance.
20
+
21
+ - [Better Convex documentation](./pages/docs.md) — /docs
22
+ - [Vue MCP Apps](./pages/docs/build/agents/mcp-apps.md) — /docs/build/agents/mcp-apps
23
+ - [MCP on Convex](./pages/docs/build/agents/mcp.md) — /docs/build/agents/mcp
24
+ - [Connection State](./pages/docs/build/application-behavior/connection-state.md) — /docs/build/application-behavior/connection-state
25
+ - [DevTools](./pages/docs/build/application-behavior/devtools.md) — /docs/build/application-behavior/devtools
26
+ - [Error Handling](./pages/docs/build/application-behavior/error-handling.md) — /docs/build/application-behavior/error-handling
27
+ - [Logging](./pages/docs/build/application-behavior/logging.md) — /docs/build/application-behavior/logging
28
+ - [Performance](./pages/docs/build/application-behavior/performance.md) — /docs/build/application-behavior/performance
29
+ - [Auth State and User Data](./pages/docs/build/authentication/auth-state-and-user.md) — /docs/build/authentication/auth-state-and-user
30
+ - [Backend Authorization](./pages/docs/build/authentication/backend-authorization.md) — /docs/build/authentication/backend-authorization
31
+ - [Better Auth Plugins](./pages/docs/build/authentication/better-auth-plugins.md) — /docs/build/authentication/better-auth-plugins
32
+ - [Better Auth Setup](./pages/docs/build/authentication/better-auth-setup.md) — /docs/build/authentication/better-auth-setup
33
+ - [Custom User Fields](./pages/docs/build/authentication/custom-user-fields.md) — /docs/build/authentication/custom-user-fields
34
+ - [Delegated OAuth and MCP](./pages/docs/build/authentication/delegated-oauth-and-mcp.md) — /docs/build/authentication/delegated-oauth-and-mcp
35
+ - [Authentication](./pages/docs/build/authentication/overview.md) — /docs/build/authentication/overview
36
+ - [Route Protection](./pages/docs/build/authentication/route-protection.md) — /docs/build/authentication/route-protection
37
+ - [Sign In and Sign Out](./pages/docs/build/authentication/sign-in-and-sign-out.md) — /docs/build/authentication/sign-in-and-sign-out
38
+ - [Transactional auth email](./pages/docs/build/authentication/transactional-email.md) — /docs/build/authentication/transactional-email
39
+ - [User Synchronization](./pages/docs/build/authentication/user-synchronization.md) — /docs/build/authentication/user-synchronization
40
+ - [Workforce authentication candidate](./pages/docs/build/authentication/workforce-profile.md) — /docs/build/authentication/workforce-profile
41
+ - [Storage URLs](./pages/docs/build/files/storage-urls.md) — /docs/build/files/storage-urls
42
+ - [Upload Files](./pages/docs/build/files/upload-files.md) — /docs/build/files/upload-files
43
+ - [File Validation and Deletion](./pages/docs/build/files/validation-and-deletion.md) — /docs/build/files/validation-and-deletion
44
+ - [Loading and Stale Data](./pages/docs/build/queries/loading-and-stale-data.md) — /docs/build/queries/loading-and-stale-data
45
+ - [Pagination](./pages/docs/build/queries/pagination.md) — /docs/build/queries/pagination
46
+ - [Queries](./pages/docs/build/queries/queries.md) — /docs/build/queries/queries
47
+ - [Reactive Arguments](./pages/docs/build/queries/reactive-arguments.md) — /docs/build/queries/reactive-arguments
48
+ - [Query Execution Options](./pages/docs/build/queries/ssr-options.md) — /docs/build/queries/ssr-options
49
+ - [Credentials and Server Security](./pages/docs/build/server/credentials-and-security.md) — /docs/build/server/credentials-and-security
50
+ - [serverConvex](./pages/docs/build/server/server-convex.md) — /docs/build/server/server-convex
51
+ - [Server Routes](./pages/docs/build/server/server-routes.md) — /docs/build/server/server-routes
52
+ - [Webhooks and Jobs](./pages/docs/build/server/webhooks-and-jobs.md) — /docs/build/server/webhooks-and-jobs
53
+ - [Actions](./pages/docs/build/write-data/actions.md) — /docs/build/write-data/actions
54
+ - [Concurrent Operations](./pages/docs/build/write-data/concurrent-operations.md) — /docs/build/write-data/concurrent-operations
55
+ - [Form submissions](./pages/docs/build/write-data/forms.md) — /docs/build/write-data/forms
56
+ - [Mutations](./pages/docs/build/write-data/mutations.md) — /docs/build/write-data/mutations
57
+ - [Optimistic Updates](./pages/docs/build/write-data/optimistic-updates.md) — /docs/build/write-data/optimistic-updates
58
+ - [Add a Mutation](./pages/docs/get-started/add-a-mutation.md) — /docs/get-started/add-a-mutation
59
+ - [Add Authentication](./pages/docs/get-started/add-authentication.md) — /docs/get-started/add-authentication
60
+ - [Choose Your Path](./pages/docs/get-started/choose-your-path.md) — /docs/get-started/choose-your-path
61
+ - [First Real-Time Page](./pages/docs/get-started/first-realtime-page.md) — /docs/get-started/first-realtime-page
62
+ - [Installation](./pages/docs/get-started/installation.md) — /docs/get-started/installation
63
+ - [Next Steps](./pages/docs/get-started/next-steps.md) — /docs/get-started/next-steps
64
+ - [Plain Vue and Vite](./pages/docs/get-started/plain-vue.md) — /docs/get-started/plain-vue
65
+ - [Project Structure](./pages/docs/get-started/project-structure.md) — /docs/get-started/project-structure
66
+ - [Protect Data](./pages/docs/get-started/protect-data.md) — /docs/get-started/protect-data
67
+ - [Migrate beta.3 users](./pages/docs/operations/beta3-session-generation-migration.md) — /docs/operations/beta3-session-generation-migration
68
+ - [Deployment](./pages/docs/operations/deployment.md) — /docs/operations/deployment
69
+ - [Environment Variables](./pages/docs/operations/environment-variables.md) — /docs/operations/environment-variables
70
+ - [Release Compatibility](./pages/docs/operations/release-compatibility.md) — /docs/operations/release-compatibility
71
+ - [Security Model](./pages/docs/operations/security-model.md) — /docs/operations/security-model
72
+ - [Troubleshooting](./pages/docs/operations/troubleshooting.md) — /docs/operations/troubleshooting
73
+ - [Compare Nuxt Integrations](./pages/docs/overview/comparison.md) — /docs/overview/comparison
74
+ - [Better Convex Nuxt](./pages/docs/overview/introduction.md) — /docs/overview/introduction
75
+ - [Limitations and Trade-offs](./pages/docs/overview/limitations.md) — /docs/overview/limitations
76
+ - [Use Cases](./pages/docs/overview/use-cases.md) — /docs/overview/use-cases
77
+ - [Who It Is For](./pages/docs/overview/who-it-is-for.md) — /docs/overview/who-it-is-for
78
+ - [Why Better Convex Nuxt](./pages/docs/overview/why-better-convex-nuxt.md) — /docs/overview/why-better-convex-nuxt
79
+ - [Authenticated Server Route](./pages/docs/recipes/authenticated-server-route.md) — /docs/recipes/authenticated-server-route
80
+ - [Test Signed-In Screens](./pages/docs/recipes/component-testing.md) — /docs/recipes/component-testing
81
+ - [File Upload Form](./pages/docs/recipes/file-upload-form.md) — /docs/recipes/file-upload-form
82
+ - [Infinite Scroll](./pages/docs/recipes/infinite-scroll.md) — /docs/recipes/infinite-scroll
83
+ - [Optimistic Todo List](./pages/docs/recipes/optimistic-todo-list.md) — /docs/recipes/optimistic-todo-list
84
+ - [Organization Permissions](./pages/docs/recipes/organization-permissions.md) — /docs/recipes/organization-permissions
85
+ - [Protected Dashboard](./pages/docs/recipes/protected-dashboard.md) — /docs/recipes/protected-dashboard
86
+ - [Public and Private Data](./pages/docs/recipes/public-and-private-data.md) — /docs/recipes/public-and-private-data
87
+ - [Real-Time Feed](./pages/docs/recipes/realtime-feed.md) — /docs/recipes/realtime-feed
88
+ - [API Surface](./pages/docs/reference/api-surface.md) — /docs/reference/api-surface
89
+ - [Composables](./pages/docs/reference/composables.md) — /docs/reference/composables
90
+ - [Error Types](./pages/docs/reference/error-types.md) — /docs/reference/error-types
91
+ - [Module Configuration](./pages/docs/reference/module-configuration.md) — /docs/reference/module-configuration
92
+ - [Package Exports](./pages/docs/reference/package-exports.md) — /docs/reference/package-exports
93
+ - [Server API](./pages/docs/reference/server-api.md) — /docs/reference/server-api
94
+ - [Authentication and Identity](./pages/docs/understand/authentication-and-identity.md) — /docs/understand/authentication-and-identity
95
+ - [Design Decisions](./pages/docs/understand/design-decisions.md) — /docs/understand/design-decisions
96
+ - [Errors and Failures](./pages/docs/understand/errors-and-failures.md) — /docs/understand/errors-and-failures
97
+ - [Glossary](./pages/docs/understand/glossary.md) — /docs/understand/glossary
98
+ - [Mental Model](./pages/docs/understand/mental-model.md) — /docs/understand/mental-model
99
+ - [Query Ownership and Caching](./pages/docs/understand/query-ownership-and-caching.md) — /docs/understand/query-ownership-and-caching
100
+ - [Request Lifecycle](./pages/docs/understand/request-lifecycle.md) — /docs/understand/request-lifecycle
101
+ - [Server and Client Boundaries](./pages/docs/understand/server-and-client-boundaries.md) — /docs/understand/server-and-client-boundaries
102
+ - [SSR, Hydration, and Real-Time](./pages/docs/understand/ssr-hydration-realtime.md) — /docs/understand/ssr-hydration-realtime