nuxt-convex-module 0.0.1 → 0.9.1

package/dist/module.d.mts

@@ -38,6 +38,13 @@ interface BetterAuthModuleOptions {
      */
     loginPath?: string;
 }
+/**
+ * Options for the `convex` key in `nuxt.config`. Every key is optional: the
+ * URLs default to the environment, and each integration auto-enables from
+ * your `package.json`.
+ *
+ * @public
+ */
 interface ModuleOptions {
     /**
      * Convex deployment URL. Defaults to `NUXT_PUBLIC_CONVEX_URL`, then to the
@@ -50,30 +57,31 @@ interface ModuleOptions {
      */
     siteUrl?: string;
     /**
-     * Better Auth integration. Auto-enabled when `@convex-dev/better-auth` is
-     * installed; set `false` to force it off, `true` to require it, or a
+     * Better Auth integration. Auto-enabled when `@convex-dev/better-auth` is a
+     * dependency of your app; set `false` to force it off, `true` to require it
+     * (a package a layer or workspace root provides counts then), or a
      * {@link BetterAuthModuleOptions} object to point at a custom auth client.
      */
     betterAuth?: boolean | BetterAuthModuleOptions;
     /**
-     * Polar billing components. Auto-enabled when `@convex-dev/polar` is
-     * installed; set `false` to force it off (or `true` to require it).
+     * Polar billing components. Auto-enabled when `@convex-dev/polar` is a
+     * dependency of your app; set `false` to force it off (or `true` to require it).
      */
     polar?: boolean;
     /**
      * Clerk auth adapter (`provideConvexAuthFromClerk` / `<ConvexProviderWithClerk>`).
-     * Auto-enabled when `@clerk/vue` is installed; set `false` to force it off.
+     * Auto-enabled when `@clerk/vue` is a dependency of your app; set `false` to force it off.
      */
     clerk?: boolean;
     /**
      * Auth0 auth adapter (`provideConvexAuthFromAuth0` / `<ConvexProviderWithAuth0>`).
-     * Auto-enabled when `@auth0/auth0-vue` is installed; set `false` to force it off.
+     * Auto-enabled when `@auth0/auth0-vue` is a dependency of your app; set `false` to force it off.
      */
     auth0?: boolean;
     /**
      * Convex-aware security headers through [`nuxt-security`](https://nuxt-security.vercel.app).
-     * Auto-enabled when `nuxt-security` is installed — the module registers it
-     * as a module dependency (no `modules` entry needed) and extends its
+     * Auto-enabled when `nuxt-security` is a dependency of your app (or listed in
+     * `modules`) — the module registers it as a module dependency and extends its
      * Content Security Policy with your deployment's origins at runtime. Set
      * `false` to leave nuxt-security's CSP alone, or `true` to require the
      * package. Disabling nuxt-security itself (`security: false` in
@@ -88,6 +96,17 @@ interface ModuleOptions {
      * Nuxt DevTools is; set `false` to disable just the Convex tab.
      */
     devtools?: boolean;
+    /**
+     * Run Convex beside Nuxt with one command. On the first `nuxt dev` (or
+     * `nuxt prepare`) in an app whose `dev` script is still the plain
+     * `nuxt dev`, the module rewrites it to `convex dev --start 'nuxt dev'`:
+     * the Convex CLI starts the dev deployment, starts Nuxt next to it, and
+     * hands it `CONVEX_URL` / `CONVEX_SITE_URL` in the environment — no `.env`
+     * needed for local development. A `dev` script you have already changed,
+     * or one that runs `convex dev` somewhere, is left alone. Set `false` to
+     * never touch `package.json`.
+     */
+    devScript?: boolean;
 }
 declare module '@nuxt/schema' {
     interface RuntimeConfig {
@@ -106,100 +125,5 @@ declare module '@nuxt/schema' {
 }
 declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
 
-/**
- * Which opt-in integrations ended up enabled — returned by
- * {@link registerIntegrations} for the dev startup summary (and the DevTools
- * panel, which reports the active adapter).
- */
-interface IntegrationFlags {
-    betterAuth: boolean;
-    clerk: boolean;
-    auth0: boolean;
-    polar: boolean;
-    /** nuxt-security registered and its CSP extended with the Convex origins. */
-    security: boolean;
-}
-/**
- * Decide whether an opt-in integration is enabled, distinguishing the
- * misconfiguration case: explicitly enabled but the backing package is not
- * installed (`missingPackage`), where silently registering the runtime would
- * surface as an opaque Vite import error instead of an actionable message.
- * Auto-detection (option unset) treats package absence as the normal case.
- */
-declare function resolveIntegrationState(explicit: boolean | object | undefined, installed: boolean): {
-    enabled: boolean;
-    missingPackage: boolean;
-};
-/** Result of {@link validateModuleOptions}: findings plus normalized values. */
-interface ModuleOptionDiagnostics {
-    errors: string[];
-    warnings: string[];
-    /** `authRoute` with a leading slash ensured and any trailing slash stripped. */
-    authRoute: string;
-}
-/**
- * Validate the resolved module configuration, turning silent misconfiguration
- * (swapped `.convex.cloud`/`.convex.site` URLs, malformed URLs, an `authRoute`
- * that would produce a broken server-handler route, a `betterAuth.authClient`
- * path that doesn't exist) into actionable messages. Pure — the caller logs
- * the findings and applies the normalized `authRoute`. Exported for tests.
- */
-declare function validateModuleOptions(input: {
-    url: string;
-    siteUrl: string;
-    authRoute: string;
-    authClient?: string;
-    rootDir: string;
-}): ModuleOptionDiagnostics;
-/**
- * The dev-mode one-line startup summary: resolved deployment URL, functions
- * directory, and which opt-in integrations are active.
- */
-declare function formatStartupSummary(url: string, functionsDir: string, integrations: IntegrationFlags): string;
-/**
- * Resolve the deployment and site URLs from module options, then environment.
- *
- * The `NUXT_PUBLIC_*` names come first: they are the Nuxt-shaped ones, and the
- * only ones Nitro will also apply as a runtime override on a built app. The
- * unprefixed names are read after them because that is what `npx convex dev`
- * writes — the Convex CLI picks its variable name per framework and has no Nuxt
- * case, so it falls back to `CONVEX_URL`. Reading both means someone who has
- * only ever run the CLI needs no `convex.url` in `nuxt.config` at all.
- *
- * Exported for tests.
- */
-declare function resolveDeploymentUrls(options: Pick<ModuleOptions, 'url' | 'siteUrl'>, env: Record<string, string | undefined>): {
-    url: string;
-    siteUrl: string;
-};
-/**
- * Build the ordered import-alias map for the Convex functions folder and its
- * generated modules, so user code and server routes can `import from
- * '#convex/...'` without spelling out `_generated`.
- *
- * - `#convex/api`        -> _generated/api        (`api`, `internal`, `components`)
- * - `#convex/server`     -> _generated/server     (`query`, `mutation`, `action`, `*Ctx`, ...)
- * - `#convex/dataModel`  -> _generated/dataModel  (`DataModel`, `Doc`, `Id`, `TableNames`)
- * - `#convex/_generated` -> _generated            (long form, covers every generated file)
- * - `#convex`            -> <rootDir>/<functionsDir>
- *
- * Order is significant: both Vite and Nitro resolve aliases with
- * `@rollup/plugin-alias`, which is first-match-wins and treats `#convex` as a
- * prefix of `#convex/api`. The specific generated-module aliases must come
- * before the catch-all `#convex`, otherwise `#convex/api` would resolve to
- * `<functionsDir>/api` instead of `<functionsDir>/_generated/api` (and would
- * shadow any user function file literally named `api.ts` / `server.ts`).
- */
-declare function getConvexAliases(rootDir: string): Record<string, string>;
-/**
- * Contents of the fallback type template: placeholder (`any`-typed) ambient
- * declarations for the generated `#convex/*` modules while `convex dev`
- * hasn't emitted codegen yet, so a fresh project typechecks instead of failing
- * on every `#convex/api` import. Once codegen exists the template goes empty
- * and the real generated types win via the tsconfig `paths` the aliases
- * already produce.
- */
-declare function convexTypeFallbackContents(hasApi: boolean, functionsDir: string): string;
-
-export { convexTypeFallbackContents, _default as default, formatStartupSummary, getConvexAliases, resolveDeploymentUrls, resolveIntegrationState, validateModuleOptions };
-export type { BetterAuthModuleOptions, IntegrationFlags, ModuleOptionDiagnostics, ModuleOptions };
+export { _default as default };
+export type { BetterAuthModuleOptions, ModuleOptions };

package/dist/module.json

@@ -1,11 +1,11 @@
 {
   "name": "nuxt-convex-module",
   "configKey": "convex",
-  "docs": "https://github.com/qruto/nuxt-convex-module#readme",
+  "docs": "https://nuxt-convex-module.dev",
   "compatibility": {
     "nuxt": ">=4.1.0"
   },
-  "version": "0.0.1",
+  "version": "0.9.1",
   "builder": {
     "@nuxt/module-builder": "1.0.3",
     "unbuild": "unknown"