@lupinum/better-convex-nuxt 0.8.0-beta.40

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-present Lupinum OG and contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/LICENSES/Apache-2.0.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1.  Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+2.  Grant of Copyright License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+3.  Grant of Patent License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+4.  Redistribution. You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+    Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+    stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+    that You distribute, all copyright, patent, trademark, and
+    attribution notices from the Source form of the Work,
+    excluding those notices that do not pertain to any part of
+    the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+    distribution, then any Derivative Works that You distribute must
+    include a readable copy of the attribution notices contained
+    within such NOTICE file, excluding those notices that do not
+    pertain to any part of the Derivative Works, in at least one
+    of the following places: within a NOTICE text file distributed
+    as part of the Derivative Works; within the Source form or
+    documentation, if provided along with the Derivative Works; or,
+    within a display generated by the Derivative Works, if and
+    wherever such third-party notices normally appear. The contents
+    of the NOTICE file are for informational purposes only and
+    do not modify the License. You may add Your own attribution
+    notices within Derivative Works that You distribute, alongside
+    or as an addendum to the NOTICE text from the Work, provided
+    that such additional attribution notices cannot be construed
+    as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+5.  Submission of Contributions. Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+6.  Trademarks. This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+7.  Disclaimer of Warranty. Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+8.  Limitation of Liability. In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+9.  Accepting Warranty or Additional Liability. While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,151 @@
+<p align="center">
+  <img src="docs/public/web-app-manifest-512x512.png" width="128" alt="Better Convex icon">
+</p>
+
+<h1 align="center">Better Convex</h1>
+
+<p align="center">Use Convex in Nuxt or Vue with one identity-safe query lifecycle from SSR to realtime.</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/@lupinum/better-convex-nuxt"><img src="https://img.shields.io/npm/v/@lupinum/better-convex-nuxt?label=npm" alt="npm version"></a>
+  <a href="https://github.com/lupinum-dev/better-convex/actions/workflows/ci.yml"><img src="https://github.com/lupinum-dev/better-convex/actions/workflows/ci.yml/badge.svg" alt="CI status"></a>
+  <a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="MIT license"></a>
+</p>
+
+> [!WARNING]
+> These packages are beta software. The auth architecture is a hard cutover and is not compatible with an existing Better Auth component database. Read the changelog before every upgrade.
+
+## Why use Better Convex?
+
+Better Convex removes the integration code between Nuxt, Vue, Convex, and optional Better Auth. A query can render during SSR, reuse the server result during hydration, and continue as a browser subscription.
+
+Identity changes cannot reuse query state from another user. Server calls are request scoped. Mutations, actions, uploads, connection state, and structured errors use the same runtime model.
+
+## When to use it
+
+Use the Nuxt package for SSR, Nitro calls, generated aliases, uploads, DevTools, and optional Better Auth. Use the Vue package for a Vite or embedded Vue application that does not need Nuxt or Nitro. Use the MCP package when a Convex HTTP Action must expose a bounded MCP server.
+
+Do not use Better Convex as an authorization layer. Every Convex function must still validate identity, ownership, membership, and roles on the backend.
+
+## Requirements
+
+- Node.js `^22.12.0 || ^24.11.0 || >=26.0.0` for the Nuxt package.
+- Nuxt `4.5.1` and Convex `1.42.2` for the current Nuxt beta.
+- Vue `^3.5.0` and Convex `1.42.2` for the Vue package.
+
+Better Auth is optional. Auth-enabled applications must install the exact peer versions in the package manifest.
+
+## Installation
+
+Install the Nuxt package and its exact peers:
+
+```bash
+pnpm add @lupinum/better-convex-nuxt convex@1.42.2 nuxt@4.5.1
+```
+
+```ts
+export default defineNuxtConfig({
+  modules: ['@lupinum/better-convex-nuxt'],
+})
+```
+
+```dotenv
+NUXT_PUBLIC_CONVEX_URL=https://your-deployment.convex.cloud
+```
+
+Store this value in `.env.local`. Run the checked configuration helper if you need to create that file:
+
+```bash
+pnpm exec better-convex-nuxt-convex configure
+```
+
+## Quick start
+
+Call a generated Convex query from a page:
+
+```vue
+<script setup lang="ts">
+import { api } from '#convex/api'
+
+const { data: tasks, status, error } = await useConvexQuery(api.tasks.list, {})
+</script>
+
+<template>
+  <p v-if="status === 'pending'">Loading tasks…</p>
+  <p v-else-if="error">Could not load tasks.</p>
+  <ul v-else>
+    <li v-for="task in tasks" :key="task._id">{{ task.text }}</li>
+  </ul>
+</template>
+```
+
+Queries use SSR and realtime updates by default. Pass an explicit arguments object. Use the literal `'skip'` to pause a query.
+
+## Server calls and mutations
+
+Create a mutation composable inside component setup:
+
+```ts
+const createTask = useConvexMutation(api.tasks.create)
+await createTask({ text: 'Review the release' })
+```
+
+Create a server caller inside each Nitro request:
+
+```ts
+import { api } from '#convex/api'
+import { serverConvex } from '#convex/server'
+
+export default defineEventHandler(async (event) => {
+  const convex = await serverConvex(event)
+  return convex.query(api.tasks.list)
+})
+```
+
+Do not share an authenticated server caller across requests.
+
+## Authentication
+
+Authentication is off when `convex.auth` is omitted. An auth-enabled application installs the exact Better Auth peers and supplies its public origin.
+
+The module transports identity through a bounded same-origin proxy. Convex functions remain the source of truth for authorization. Route middleware is navigation behavior, not backend access control.
+
+Read the [authentication setup guide](https://better-convex.lupinum.com/docs/get-started/add-authentication) before you enable auth.
+
+## Packages
+
+| Package                       | Use it for                                                       |
+| ----------------------------- | ---------------------------------------------------------------- |
+| `@lupinum/better-convex-nuxt` | Nuxt SSR, Nitro, uploads, DevTools, and optional Better Auth.    |
+| `@lupinum/better-convex-vue`  | Identity-safe Convex queries and calls in plain or embedded Vue. |
+| `@lupinum/better-convex-mcp`  | Provider-neutral MCP request handling in Convex HTTP Actions.    |
+
+MCP remains opt in. Installing the Vue or Nuxt package does not start an MCP server or grant application authority.
+
+## Documentation
+
+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).
+
+The generated [API surface](https://better-convex.lupinum.com/docs/reference/api-surface) is the source of truth for public exports.
+
+## Contributing and development
+
+Read [CONTRIBUTING.md](CONTRIBUTING.md) before you open a pull request. Run the normal handoff gate before you submit a change:
+
+```bash
+corepack enable
+pnpm install --frozen-lockfile
+pnpm verify
+```
+
+Maintainers use the protected workflow in [MAINTAINING.md](MAINTAINING.md) and [RELEASING.md](RELEASING.md) for releases.
+
+## Support and security
+
+Open a [GitHub issue](https://github.com/lupinum-dev/better-convex/issues) for bugs and focused proposals. Join the [Lupinum OSS Discord](https://discord.gg/RPH6SeA36N) for project discussion.
+
+Use the private process in [SECURITY.md](SECURITY.md) to report a vulnerability. Do not report a vulnerability in a public issue.
+
+## License
+
+Better Convex is available under the [MIT License](LICENSE). Copyright belongs to [Lupinum OG](https://lupinum.com).

package/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,38 @@
+# Third-party notices
+
+Better Convex Nuxt is distributed under the repository's MIT license. Selected
+Convex/Better Auth integration source is derived from the Apache-2.0 work below;
+those portions remain subject to Apache License 2.0. The complete Apache license
+is included at `LICENSES/Apache-2.0.txt`.
+
+## get-convex/better-auth
+
+- Source: https://github.com/get-convex/better-auth
+- Baseline commit: `c628916b451a6b4cff0f5464f134475464b1a6da`
+- Baseline tag: `v0.12.5`
+- Import date: 2026-07-16
+- Original license: Apache-2.0
+- Upstream NOTICE status: the inspected baseline commit contains no `NOTICE`
+  file.
+
+The authorized intake surface is limited to the component client/adapter/schema,
+Convex JWT integration, auth-provider configuration, component codegen, narrow
+context types, and compiled test helper recorded in
+`security/upstream-convex-better-auth.json`. Each incorporated target and its
+modifications must be recorded there before release.
+
+Derived targets are restricted to `src/runtime/convex-auth/**`, the internal
+`src/runtime/auth-client/convex-client-plugin.ts` integration leaf, and the
+build-only `internal/convex-auth/schema-options.ts` schema profile.
+
+The following upstream areas are intentionally omitted: Next.js, React, React
+Start, TanStack and other framework examples, cross-domain integration, upstream
+documentation and release tooling, compatibility aliases, production test
+profiles, deprecated OIDC-provider composition, JWT cookie caching, destructive
+key rotation, forwarded-origin restoration, and unrelated generic utilities.
+
+Better Convex Nuxt modifies the retained integration for a Nuxt-and-Convex-only
+public API, logical Better Auth IDs, atomic Convex storage operations, explicit
+origin and token-class validation, additive signing-key rotation, and one shared
+packaged/local adapter implementation. Adapted files carry a prominent
+modification notice when required by the provenance ledger.

package/dist/module.d.mts

@@ -0,0 +1,55 @@
+import * as _nuxt_schema from '@nuxt/schema';
+import * as __runtime_composables_useConvexPaginatedQuery from '../dist/runtime/composables/useConvexPaginatedQuery.js';
+export { NuxtConvexPaginatedQuery, UseConvexPaginatedQueryState } from '../dist/runtime/composables/useConvexPaginatedQuery.js';
+import * as _lupinum_better_convex_vue from '@lupinum/better-convex-vue';
+export { ConvexCallStatus, ConvexClientHandle, OptimisticUpdate, UseConvexCall } from '@lupinum/better-convex-vue';
+import * as convex_server from 'convex/server';
+import * as __runtime_composables_useConvexQuery from '../dist/runtime/composables/useConvexQuery.js';
+export { NuxtConvexQuery, UseConvexQueryState } from '../dist/runtime/composables/useConvexQuery.js';
+import { ConvexAuthOptions } from '../dist/runtime/utils/auth-config.js';
+export { ConvexAuthOptions } from '../dist/runtime/utils/auth-config.js';
+import { LogLevel } from '../dist/runtime/utils/logger.js';
+export { ConvexAuthMode, ConvexAuthStatus } from '../dist/runtime/utils/auth-status.js';
+export { ConvexRuntimeConfig } from '../dist/runtime/utils/runtime-config.js';
+export { UseConvexAuthReturn } from '../dist/runtime/utils/auth-contract.js';
+export { UploadProgressInfo, UploadStatus, UploadUrlMutation, UseConvexFileUploadOptions, UseConvexFileUploadReturn } from '../dist/runtime/composables/useConvexFileUpload.js';
+export { UseConvexMutationOptions } from '../dist/runtime/composables/useConvexMutation.js';
+
+/** Per-call query options for the Nuxt composable, including its SSR policy. */
+type UseConvexQueryOptions = __runtime_composables_useConvexQuery.UseNuxtConvexQueryOptions;
+/** The exact rest parameters accepted by Nuxt's `useConvexQuery`. */
+type UseConvexQueryParameters<Query extends convex_server.FunctionReference<'query'>, Options extends UseConvexQueryOptions = UseConvexQueryOptions> = _lupinum_better_convex_vue.UseConvexQueryParameters<Query, Options>;
+/** Per-call pagination options for the Nuxt composable, including its SSR policy. */
+type UseConvexPaginatedQueryOptions = __runtime_composables_useConvexPaginatedQuery.UseNuxtConvexPaginatedQueryOptions;
+/**
+ * Better Convex Nuxt module options .
+ *
+ * Omitted auth produces a Convex-only build. An object explicitly installs
+ * authentication; `false` removes auth inherited from a Nuxt layer.
+ */
+interface ModuleOptions {
+    /** Convex deployment URL (WebSocket) - e.g., https://your-app.convex.cloud */
+    url?: string;
+    /**
+     * Convex site URL (HTTP Actions) - e.g., https://your-app.convex.site.
+     * If not provided, automatically derived from `url`.
+     */
+    siteUrl?: string;
+    /**
+     * Authentication installation. An object opts in; omission is off. `false`
+     * is the explicit Nuxt-layer tombstone for inherited auth configuration.
+     */
+    auth?: false | ConvexAuthOptions;
+    /**
+     * Enable module logging.
+     * - false: No logs (production default)
+     * - 'info': Simple logs for everyday use
+     * - 'debug': Detailed logs with timing for deep debugging
+     * @default false
+     */
+    logging?: LogLevel;
+}
+declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
+
+export { _default as default };
+export type { ModuleOptions, UseConvexPaginatedQueryOptions, UseConvexQueryOptions, UseConvexQueryParameters };

package/dist/module.json

@@ -0,0 +1,12 @@
+{
+  "name": "@lupinum/better-convex-nuxt",
+  "configKey": "convex",
+  "compatibility": {
+    "nuxt": "4.5.1"
+  },
+  "version": "0.8.0-beta.40",
+  "builder": {
+    "@nuxt/module-builder": "1.0.2",
+    "unbuild": "3.6.1"
+  }
+}