feat(build): do not inject missing generate targets as aliases (breaking build)

Author: Tahul

package.json

@@ -15,7 +15,8 @@
   "main": "./dist/module.cjs",
   "types": "./dist/types.d.ts",
   "files": [
-    "dist"
+    "dist",
+    "templates"
   ],
   "scripts": {
     "build": "nuxt-module-build build",
@@ -48,4 +49,4 @@
     "nuxt": "^3.8.2",
     "vitest": "^0.34.6"
   }
-}
+}

playground/nuxt.config.ts

@@ -11,4 +11,7 @@ export default defineNuxtConfig({
   tailwindcss: {
     viewer: false,
   },
+  typescript: {
+    includeWorkspace: true,
+  },
 })

playground/pages/blogposts/[id].vue

@@ -5,7 +5,7 @@ const { params } = useRoute()
 
 const { data: blogpost } = await useAsyncData<BlogPost>(
   `blogpost-${params.id}`,
-  async () => await $fetch(`/api/blogpost/${params.id}`),
+  async () => await $fetch(`/api/blogpost?id=${params.id}`),
 )
 </script>
 

playground/server/api/blogpost.ts

@@ -0,0 +1,38 @@
+import { defineEventHandler, getQuery, isMethod, readBody } from 'h3'
+import { useEdgeDbQueries } from '#edgedb/server'
+import type { BlogPost } from '#edgedb/interfaces'
+
+export default defineEventHandler(async (req) => {
+  const query = getQuery(req)
+  const { insertBlogPost, allBlogPosts, deleteBlogPost, getBlogPost } = useEdgeDbQueries(req)
+
+  if (isMethod(req, 'POST')) {
+    const {
+      title,
+      description,
+      content,
+    } = await readBody(req)
+
+    const blogPost = await insertBlogPost({
+      blogpost_title: title,
+      blogpost_description: description,
+      blogpost_content: content,
+    })
+
+    return blogPost
+  }
+
+  if (isMethod(req, 'GET')) {
+    if (query?.id) {
+      const blogpost = await getBlogPost({ blogpost_id: query.id.toString() })
+      return blogpost as BlogPost
+    }
+
+    return await allBlogPosts()
+  }
+
+  if (isMethod(req, 'DELETE') && query?.id) {
+    await deleteBlogPost({ blogpost_id: query.id.toString() })
+    return { deleted: query?.id }
+  }
+})

playground/server/api/blogpost/[id].ts

@@ -1,5 +1,6 @@
 import { existsSync } from 'node:fs'
 import { addComponentsDir, addImportsDir, addPlugin, addServerHandler, addServerImports, createResolver, defineNuxtModule } from '@nuxt/kit'
+import type { ViteDevServer } from 'vite'
 import { createConsola } from 'consola'
 import { join } from 'pathe'
 import chalk from 'chalk'
@@ -224,14 +225,16 @@ export default defineNuxtModule<ModuleOptions>({
 
     if (canPrompt && options.devtools) {
       let uiUrl: any | undefined
-      try {
-        uiUrl = await execa.execa(`edgedb`, ['ui', '--print-url'])
-      }
-      catch (e) {
-        //
+      if (!process.env.NUXT_EDGEDB_UI_URL && options.injectDbCredentials) {
+        try {
+          uiUrl = await execa.execa(`edgedb`, ['ui', '--print-url'])
+        }
+        catch (e) {
+          //
+        }
       }
 
-      if (uiUrl?.stdout) {
+      if (process.env?.NUXT_EDGEDB_UI_URL || uiUrl?.stdout) {
         nuxt.hook('devtools:customTabs', (tabs) => {
           tabs.push({
             // unique identifier
@@ -244,7 +247,7 @@ export default defineNuxtModule<ModuleOptions>({
             // iframe view
             view: {
               type: 'iframe',
-              src: uiUrl.stdout,
+              src: process.env?.NUXT_EDGEDB_UI_URL || uiUrl.stdout,
               persistent: true,
             },
           })
@@ -390,12 +393,23 @@ export default defineNuxtModule<ModuleOptions>({
       })
     }
 
+    const queriesPath = join(dbschemaDir, '/queries.ts')
+    const interfacesPath = join(dbschemaDir, '/interfaces.ts')
+    const builderPath = join(dbschemaDir, '/query-builder/index.ts')
+
+    const hasQueries = existsSync(queriesPath)
+    const hasInterfaces = existsSync(interfacesPath)
+    const hasQueryBuilder = existsSync(queryBuilderDir)
+
     // Inject aliases
     const nuxtOptions = nuxt.options
     nuxtOptions.alias = nuxtOptions.alias ?? {}
-    nuxtOptions.alias['#edgedb/queries'] = join(dbschemaDir, '/queries.ts')
-    nuxtOptions.alias['#edgedb/interfaces'] = join(dbschemaDir, '/interfaces.ts')
-    nuxtOptions.alias['#edgedb/builder'] = join(dbschemaDir, '/query-builder/index.ts')
+    if (hasQueries)
+      nuxtOptions.alias['#edgedb/queries'] = queriesPath
+    if (hasInterfaces)
+      nuxtOptions.alias['#edgedb/interfaces'] = interfacesPath
+    if (hasQueryBuilder)
+      nuxtOptions.alias['#edgedb/builder'] = builderPath
 
     if (!nuxt.options._prepare) {
       await generateInterfaces()
@@ -437,21 +451,34 @@ export default defineNuxtModule<ModuleOptions>({
           config.externals.inline ??= []
           config.externals.inline.push(resolveLocal('./runtime/server'))
 
+          // Fixes for weird cjs query builder imports
+          if (hasQueryBuilder) {
+            config.replace ??= {}
+            config.replace['edgedb/dist/primitives/buffer'] = 'edgedb/dist/primitives/buffer.js'
+            config.replace['edgedb/dist/reflection/index'] = 'edgedb/dist/reflection/index.js'
+          }
+
           // Push server aliases
           config.alias ??= {}
           config.alias['#edgedb/server'] = resolveLocal('./runtime/server/index')
-          config.alias['#edgedb/queries'] = join(dbschemaDir, '/queries.ts')
-          config.alias['#edgedb/interfaces'] = join(dbschemaDir, '/interfaces.ts')
-          config.alias['#edgedb/builder'] = join(dbschemaDir, '/query-builder/index.ts')
+          if (hasQueries)
+            config.alias['#edgedb/queries'] = join(dbschemaDir, '/queries.ts')
+          if (hasInterfaces)
+            config.alias['#edgedb/interfaces'] = join(dbschemaDir, '/interfaces.ts')
+          if (hasQueryBuilder)
+            config.alias['#edgedb/builder'] = join(dbschemaDir, '/query-builder/index.ts')
 
           // Enforce paths on typescript config
           config.typescript ??= {}
           config.typescript.tsConfig ??= {}
           config.typescript.tsConfig.compilerOptions ??= {}
           config.typescript.tsConfig.compilerOptions.paths ??= {}
-          config.typescript.tsConfig.compilerOptions.paths['#edgedb/queries'] = [`${join(dbschemaDir, '/queries.ts')}`]
-          config.typescript.tsConfig.compilerOptions.paths['#edgedb/interfaces'] = [`${join(dbschemaDir, '/interfaces.ts')}`]
-          config.typescript.tsConfig.compilerOptions.paths['#edgedb/builder'] = [`${join(dbschemaDir, '/query-builder/index.ts')}`]
+          if (hasQueries)
+            config.typescript.tsConfig.compilerOptions.paths['#edgedb/queries'] = [`${join(dbschemaDir, '/queries.ts')}`]
+          if (hasInterfaces)
+            config.typescript.tsConfig.compilerOptions.paths['#edgedb/interfaces'] = [`${join(dbschemaDir, '/interfaces.ts')}`]
+          if (hasQueryBuilder)
+            config.typescript.tsConfig.compilerOptions.paths['#edgedb/builder'] = [`${join(dbschemaDir, '/query-builder/index.ts')}`]
         },
       )
     }

playground/server/api/blogpost/index.ts

@@ -6,7 +6,7 @@ export type EdgeDbQueries = keyof typeof queries
 
 export function useEdgeDbQueries(
   req: H3Event<EventHandlerRequest> | undefined = undefined,
-): { [K in EdgeDbQueries]: (arg: Parameters<typeof queries[K]>[1]) => ReturnType<typeof queries[K]> } {
+): { [K in EdgeDbQueries]: (arg?: Parameters<typeof queries[K]>[1]) => ReturnType<typeof queries[K]> } {
   const client = useEdgeDb(req)
 
   return Object.fromEntries(

src/module.ts

@@ -0,0 +1,38 @@
+using extension auth;
+
+module default {
+  global current_user := (
+    assert_single((
+      select User { id, name }
+      filter .identity = global ext::auth::ClientTokenIdentity
+    ))
+  );
+
+  type User {
+    required name: str;
+    required identity: ext::auth::Identity;
+    multi link posts -> BlogPost {
+      on source delete delete target;
+    }
+  }
+
+  type BlogPost {
+    property content: str {
+      default := 'My super blog post.';
+    };
+    property description: str {
+      default := 'My blog post description.';
+    };
+    property title: str {
+      default := 'My blog super blog post title.';
+    };
+    required author: User {
+      default := global current_user;
+    };
+    access policy author_has_full_access
+      allow all
+      using (.author ?= global current_user);
+    access policy others_read_only
+      allow select;
+  }
+}

src/runtime/server/composables/useEdgeDbQueries.ts

@@ -0,0 +1,13 @@
+module default {
+  type BlogPost {
+    property content: str {
+      default := 'My super blog post.';
+    };
+    property description: str {
+      default := 'My blog post description.';
+    };
+    property title: str {
+      default := 'My blog super blog post title.';
+    };
+  }
+}