nuxt-convex-module 0.14.1 → 0.14.2

package/dist/devtools-client/index.html

@@ -1 +1 @@
-<!DOCTYPE html><html><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1"><script type="importmap">{"imports":{"#entry":"/__nuxt-convex-module/_nuxt/CtC_CmOY.js"}}</script><link rel="stylesheet" href="/__nuxt-convex-module/_nuxt/entry.jOWrhpYd.css" crossorigin><link rel="modulepreload" as="script" crossorigin href="/__nuxt-convex-module/_nuxt/CtC_CmOY.js"><script type="module" src="/__nuxt-convex-module/_nuxt/CtC_CmOY.js" crossorigin></script><link rel="prefetch" as="script" crossorigin href="/__nuxt-convex-module/_nuxt/C-J9qZjr.js"></head><body><div id="__nuxt"></div><div id="teleports"></div><script>window.__NUXT__={};window.__NUXT__.config={public:{},app:{baseURL:"/__nuxt-convex-module",buildId:"7121d13f-7e15-4436-95a8-70fef1a171ce",buildAssetsDir:"/_nuxt/",cdnURL:""}}</script><script type="application/json" data-nuxt-data="nuxt-app" data-ssr="false" id="__NUXT_DATA__">[{"prerenderedAt":1,"serverRendered":2},1794230621568,false]</script></body></html>
+<!DOCTYPE html><html><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1"><script type="importmap">{"imports":{"#entry":"/__nuxt-convex-module/_nuxt/CtC_CmOY.js"}}</script><link rel="stylesheet" href="/__nuxt-convex-module/_nuxt/entry.jOWrhpYd.css" crossorigin><link rel="modulepreload" as="script" crossorigin href="/__nuxt-convex-module/_nuxt/CtC_CmOY.js"><script type="module" src="/__nuxt-convex-module/_nuxt/CtC_CmOY.js" crossorigin></script><link rel="prefetch" as="script" crossorigin href="/__nuxt-convex-module/_nuxt/C-J9qZjr.js"></head><body><div id="__nuxt"></div><div id="teleports"></div><script>window.__NUXT__={};window.__NUXT__.config={public:{},app:{baseURL:"/__nuxt-convex-module",buildId:"45bb65c1-9f29-4c02-bccc-cf2e35308dd6",buildAssetsDir:"/_nuxt/",cdnURL:""}}</script><script type="application/json" data-nuxt-data="nuxt-app" data-ssr="false" id="__NUXT_DATA__">[{"prerenderedAt":1,"serverRendered":2},1794326993439,false]</script></body></html>

package/dist/module.json

@@ -5,7 +5,7 @@
   "compatibility": {
     "nuxt": ">=4.6.0"
   },
-  "version": "0.14.1",
+  "version": "0.14.2",
   "builder": {
     "@nuxt/module-builder": "1.0.3",
     "unbuild": "unknown"

package/dist/module.mjs

@@ -535,7 +535,7 @@ function registerIntegrations(resolver, nuxt, options, policy, authRoute) {
   const resolve = (key, pkg) => report(key, pkg, resolveIntegrationState(options[key], isPackageInstalled(pkg, rootDir), isDeclaredDependency(pkg, rootDir)));
   const betterAuth = resolve("betterAuth", "@convex-dev/better-auth");
   if (betterAuth) {
-    registerBetterAuth(resolver, authRoute, policy);
+    registerBetterAuth(resolver, authRoute, policy, nuxt.options.experimental);
   } else {
     registerBaseConvexClient(resolver);
   }
@@ -684,9 +684,12 @@ const AUTH_PROXY_SECURITY_RULES = {
   xssValidator: false,
   allowedMethodsRestricter: { methods: ["GET", "HEAD", "POST", "OPTIONS"] }
 };
-function registerBetterAuth(resolver, authRoute, policy) {
+function registerBetterAuth(resolver, authRoute, policy, experimental) {
   addPlugin(resolver.resolve("./runtime/better-auth/vue/plugin.client"));
   addPlugin(resolver.resolve("./runtime/better-auth/vue/plugin.server"));
+  if (experimental.emitRouteChunkError === "automatic" && experimental.appManifest) {
+    addPlugin(resolver.resolve("./runtime/better-auth/nuxt/chunk-reload.client"));
+  }
   const noSessionVary = resolver.resolve("./runtime/better-auth/nuxt/no-session-vary");
   addNitroPlugin({ nitro2: noSessionVary, nitro3: noSessionVary });
   registerIntegrationImports(resolver, "betterAuth", policy);

package/dist/runtime/better-auth/nuxt/chunk-reload.client.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("nuxt/app").Plugin<Record<string, unknown>> & import("nuxt/app").ObjectPlugin<Record<string, unknown>>;
+export default _default;

package/dist/runtime/better-auth/nuxt/chunk-reload.client.js

@@ -0,0 +1,41 @@
+import { defineNuxtPlugin, reloadNuxtApp, useRuntimeConfig } from "#app";
+import { onAuthClientLoadFailure } from "../vue/auth-client-loader.js";
+function latestBuildURL(app) {
+  const root = (app.cdnURL || app.baseURL).replace(/\/+$/, "");
+  const dir = app.buildAssetsDir.replace(/^\/+/, "").replace(/\/+$/, "");
+  return `${root}/${dir}/builds/latest.json?${Date.now()}`;
+}
+async function newerBuild(url, buildId) {
+  try {
+    const response = await fetch(url, { cache: "no-store" });
+    if (!response.ok) return void 0;
+    const latest = await response.json();
+    return typeof latest.id === "string" && latest.id !== buildId ? latest : void 0;
+  } catch {
+    return void 0;
+  }
+}
+export default defineNuxtPlugin({
+  name: "nuxt-convex-module:better-auth:chunk-reload",
+  setup(nuxtApp) {
+    const { app } = useRuntimeConfig();
+    const chunkErrors = /* @__PURE__ */ new WeakSet();
+    nuxtApp.hook("app:chunkError", ({ error }) => {
+      if (typeof error === "object" && error !== null) chunkErrors.add(error);
+    });
+    let checking = false;
+    let announced = false;
+    onAuthClientLoadFailure(({ error, used }) => {
+      if (checking) return;
+      checking = true;
+      void newerBuild(latestBuildURL(app), app.buildId).then((build) => {
+        checking = false;
+        if (!build || typeof error !== "object" || error === null || !chunkErrors.has(error)) return;
+        if (used) return reloadNuxtApp();
+        if (announced) return;
+        announced = true;
+        void nuxtApp.callHook("app:manifest:update", build);
+      });
+    });
+  }
+});

package/dist/runtime/better-auth/vue/auth-client-loader.js

@@ -3,9 +3,15 @@ let loaded;
 let loading;
 let deferred = false;
 const waiting = /* @__PURE__ */ new Set();
+const failing = /* @__PURE__ */ new Set();
+let used = false;
 let evaluated;
 let stopSignal;
 export function loadAuthClient() {
+  used = true;
+  return load();
+}
+function load() {
   if (evaluated) registerAuthClient(evaluated);
   loading ??= import("#convex/auth-client").then(
     ({ authClient }) => {
@@ -14,6 +20,9 @@ export function loadAuthClient() {
     },
     (error) => {
       loading = void 0;
+      const failure = { error, used };
+      used = false;
+      notify(failing, failure);
       throw error;
     }
   );
@@ -33,11 +42,15 @@ export function registerAuthClient(client) {
   evaluated = void 0;
   loaded = client;
   loading ??= Promise.resolve(client);
+  failing.clear();
   const listeners = [...waiting];
   waiting.clear();
-  for (const listener of listeners) {
+  notify(listeners, client);
+}
+function notify(listeners, value) {
+  for (const listener of [...listeners]) {
     try {
-      listener(client);
+      listener(value);
     } catch (error) {
       report(error);
     }
@@ -61,12 +74,18 @@ export function onAuthClient(listener) {
   waiting.add(listener);
   return () => waiting.delete(listener);
 }
+export function onAuthClientLoadFailure(listener) {
+  if (loaded) return () => {
+  };
+  failing.add(listener);
+  return () => failing.delete(listener);
+}
 export function deferAuthClient() {
   if (deferred || loaded) return;
   deferred = true;
   const onVisible = () => {
     if (document.visibilityState !== "visible") return;
-    void loadAuthClient().then(() => document.removeEventListener("visibilitychange", onVisible), () => {
+    void load().then(() => document.removeEventListener("visibilitychange", onVisible), () => {
     });
   };
   document.addEventListener("visibilitychange", onVisible);
@@ -75,7 +94,7 @@ export function retryAuthClientLoad() {
   if (loaded || typeof window === "undefined") return;
   const retry = () => {
     if (document.visibilityState !== "visible") return;
-    void loadAuthClient().then(() => {
+    void load().then(() => {
       window.removeEventListener("online", retry);
       document.removeEventListener("visibilitychange", retry);
     }, () => {
@@ -183,4 +202,6 @@ export function __resetAuthClientLoaderForTests() {
   stopSignal = void 0;
   evaluated = void 0;
   waiting.clear();
+  failing.clear();
+  used = false;
 }

package/dist/runtime/vue/composables/use-upload-queue.d.ts

@@ -16,9 +16,12 @@ export type UploadItemStage = 'prepare' | 'upload' | 'after';
 /**
  * A single entry in the queue managed by {@link useUploadQueue}.
  *
+ * @typeParam TData - The app's own data for the item, given to
+ *   {@link VueUploadQueue.enqueue}. `undefined` when the queue takes none.
+ *
  * @public
  */
-export interface UploadQueueItem {
+export interface UploadQueueItem<TData = undefined> {
     /** Stable id for this queue entry (not the storage id). */
     id: string;
     /** The file or blob being uploaded. */
@@ -48,13 +51,26 @@ export interface UploadQueueItem {
      * and for a preview.
      */
     prepared: Blob | null;
+    /**
+     * The app's data for this item, as given to `enqueue`: what the file is
+     * for (a document id, a kind, a position). Every hook reads it off the
+     * item. Deeply reactive like the rest of the item: an object reads as
+     * Vue's proxy of the one given, not a copy, so a change through it
+     * reaches that object and every item the same call queued (`toRaw`
+     * returns the object itself). A ref held as one of its properties reads
+     * unwrapped; one inside an array or a `Map` stays a ref. `undefined`
+     * when `enqueue` was given none.
+     */
+    data: TData;
 }
 /**
  * Options for {@link useUploadQueue}.
  *
+ * @typeParam TData - The data each item carries; see {@link UploadQueueItem}.
+ *
  * @public
  */
-export interface UseUploadQueueOptions {
+export interface UseUploadQueueOptions<TData = undefined> {
     /** Maximum number of uploads to run at once. Defaults to `3`. */
     concurrency?: number;
     /**
@@ -63,7 +79,7 @@ export interface UseUploadQueueOptions {
      * item ends `error`, refused when `isRefusal` says so. Runs once per
      * item: a retry reuses what it returned.
      */
-    prepare?: (file: Blob, item: UploadQueueItem, signal: AbortSignal) => Blob | Promise<Blob>;
+    prepare?: (file: Blob, item: UploadQueueItem<TData>, signal: AbortSignal) => Blob | Promise<Blob>;
     /**
      * Runs once the file is stored, before the item counts as a success:
      * attach the storage id to a document, run a check on it. The item stays
@@ -74,7 +90,7 @@ export interface UseUploadQueueOptions {
      * in error, so `onItemError` can delete it; the queue never deletes files,
      * and a retry forgets it before uploading again.
      */
-    after?: (storageId: StorageId, item: UploadQueueItem, signal: AbortSignal) => void | Promise<void>;
+    after?: (storageId: StorageId, item: UploadQueueItem<TData>, signal: AbortSignal) => void | Promise<void>;
     /**
      * Whether an error is a refusal (the app turned the file away) rather than
      * a failure (the network, the deployment, an abort). Defaults to: the
@@ -82,33 +98,46 @@ export interface UseUploadQueueOptions {
      * An aborted item is never refused, and neither is an error this check
      * throws on.
      */
-    isRefusal?: (error: Error, item: UploadQueueItem) => boolean;
+    isRefusal?: (error: Error, item: UploadQueueItem<TData>) => boolean;
     /**
      * Called when an individual item finishes uploading (after `after`). A
      * throw ends the item `error` with its storage id kept; a retry then runs
      * only this callback again, never `after` a second time.
      */
-    onItemSuccess?: (storageId: StorageId, item: UploadQueueItem) => void | Promise<void>;
+    onItemSuccess?: (storageId: StorageId, item: UploadQueueItem<TData>) => void | Promise<void>;
     /** Called when an individual item fails or is refused (`item.refused` says which). */
-    onItemError?: (error: Error, item: UploadQueueItem) => void;
+    onItemError?: (error: Error, item: UploadQueueItem<TData>) => void;
     /**
      * Called once every queued item has settled (succeeded or failed), after
      * every `onItemSuccess` has returned.
      */
-    onComplete?: (items: UploadQueueItem[]) => void;
+    onComplete?: (items: UploadQueueItem<TData>[]) => void;
 }
 /** Accepted inputs to {@link VueUploadQueue.enqueue}. @public */
 export type EnqueueInput = Blob | Blob[] | FileList | null | undefined;
+/**
+ * The `data` argument of {@link VueUploadQueue.enqueue}: optional when the
+ * item data may be `undefined`, required otherwise.
+ *
+ * @public
+ */
+export type EnqueueData<TData> = undefined extends TData ? [data?: TData] : [data: TData];
 /**
  * The reactive queue returned by {@link useUploadQueue}.
  *
+ * @typeParam TData - The data each item carries; see {@link UploadQueueItem}.
+ *
  * @public
  */
-export interface VueUploadQueue {
+export interface VueUploadQueue<TData = undefined> {
     /** Reactive list of queued items, in insertion order. */
-    items: Readonly<Ref<UploadQueueItem[]>>;
-    /** Add one or more files to the queue; uploading starts automatically. */
-    enqueue: (files: EnqueueInput) => void;
+    items: Readonly<Ref<UploadQueueItem<TData>[]>>;
+    /**
+     * Add one or more files to the queue; uploading starts automatically.
+     * `data` goes on every item this call queues, as `item.data`: queue files
+     * one call at a time to give each its own.
+     */
+    enqueue: (files: EnqueueInput, ...data: EnqueueData<TData>) => void;
     /** `true` while any item is pending or uploading. */
     isUploading: Readonly<Ref<boolean>>;
     /** Aggregate progress across all items, from `0` to `1`. */
@@ -152,6 +181,11 @@ export interface VueUploadQueue {
  * item says whether the app `refused` it or it failed, so the UI can show a
  * reason for one and {@link VueUploadQueue.retry} the other.
  *
+ * `enqueue(files, data)` attaches the app's own data to the items it
+ * queues, as `item.data`, so a hook knows what a file is for without a
+ * side map: type it with the `TData` parameter,
+ * `useUploadQueue<{ albumId: Id<'albums'> }>(…)`.
+ *
  * @example
  * ```vue
  * <script setup lang="ts">
@@ -180,6 +214,8 @@ export interface VueUploadQueue {
  * </template>
  * ```
  *
+ * @typeParam TData - The data each item carries, given to `enqueue`;
+ *   `undefined` (no data) by default.
  * @param generateUploadUrl - A `FunctionReference` for the public
  *   `generateUploadUrl` mutation.
  * @param options - Optional {@link UseUploadQueueOptions}.
@@ -187,6 +223,6 @@ export interface VueUploadQueue {
  *
  * @public
  */
-export declare function useUploadQueue(generateUploadUrl: GenerateUploadUrl, options?: UseUploadQueueOptions): VueUploadQueue;
+export declare function useUploadQueue<TData = undefined>(generateUploadUrl: GenerateUploadUrl, options?: UseUploadQueueOptions<TData>): VueUploadQueue<TData>;
 /** @public */
 export declare const useConvexUploadQueue: typeof useUploadQueue;

package/dist/runtime/vue/composables/use-upload-queue.js

@@ -115,7 +115,7 @@ export function useUploadQueue(generateUploadUrl, options = {}) {
       }
     }
   }
-  function enqueue(files) {
+  function enqueue(files, ...[data]) {
     const incoming = normalizeFiles(files);
     if (incoming.length === 0) return;
     items.value.push(
@@ -128,7 +128,9 @@ export function useUploadQueue(generateUploadUrl, options = {}) {
         error: null,
         refused: false,
         stage: null,
-        prepared: null
+        prepared: null,
+        // `undefined` only when `TData` allows it: `EnqueueData` requires it otherwise.
+        data
       }))
     );
     held = false;

package/dist/runtime/vue/index.d.ts

@@ -88,6 +88,6 @@ export type { ConnectionState, OptimisticUpdate, QueryJournal, } from 'convex/br
 export type { FunctionReference, FunctionReference_future, FunctionArgs, FunctionReturnType, OptionalRestArgs, ArgsAndOptions, } from 'convex/server';
 export type { Value } from 'convex/values';
 export { useUpload, useConvexUpload, uploadFile, type VueUpload, type UseUploadOptions, type UploadFileOptions, type GenerateUploadUrl, type StorageId, } from './composables/use-upload.js';
-export { useUploadQueue, useConvexUploadQueue, type VueUploadQueue, type UseUploadQueueOptions, type UploadQueueItem, type UploadItemStage, type UploadItemStatus, type EnqueueInput, } from './composables/use-upload-queue.js';
+export { useUploadQueue, useConvexUploadQueue, type VueUploadQueue, type UseUploadQueueOptions, type UploadQueueItem, type UploadItemStage, type UploadItemStatus, type EnqueueInput, type EnqueueData, } from './composables/use-upload-queue.js';
 export { useStorageUrl, useConvexStorageUrl, type GetStorageUrl, } from './composables/use-storage-url.js';
 export { ConvexImage } from './components/convex-image.js';

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package.json",
   "name": "nuxt-convex-module",
-  "version": "0.14.1",
+  "version": "0.14.2",
   "description": "Convex backend integration with live queries, mutations, actions, pagination, file storage and SSR, auto-imported and typed against your deployment. The same Vue client runs without Nuxt; Better Auth, Clerk, Auth0 and Polar are opt-in.",
   "repository": {
     "type": "git",
@@ -221,7 +221,7 @@
     "changelogen": "^0.6.2",
     "convex": "^1.49.0",
     "eslint": "^10.13.0",
-    "fallow": "3.39.0",
+    "fallow": "3.41.0",
     "happy-dom": "^21.0.4",
     "installed-check": "^11.0.0",
     "nuxt": "^4.6.3",