Nuxt EdgeDB

輕鬆將 Nuxt 3 與 EdgeDB 整合，以最少的配置為您的應用程式增加強大的資料庫層。

特色

🍱 輕鬆整合：只需一行配置即可設定資料庫。
🎩 即時 Schema 更新：透過監看 schema、queries 和 migrations，體驗類似 HMR 的 DX。
🛟 類型化的查詢生成：使用 @edgedb/generate 自動產生類型化的查詢客戶端。
🍩 整合的資料庫管理：從 Nuxt DevTools 管理您的資料庫。
🔐 彈性的驗證：一鍵切換 Email 或 OAuth 驗證，並支援自訂驗證提供者。
🧙 初始指南：引導您完成 EdgeDB CLI 設定和專案初始化。

快速設定

將 nuxt-edgedb-module 依賴項新增至您的專案

npx nuxi@latest module add edgedb

將 nuxt-edgedb-module 新增至 nuxt.config.ts 的 modules 區段

export default defineNuxtConfig({
  modules: [
    'nuxt-edgedb-module'
  ]
})

在專案根目錄中執行 npx nuxt-edgedb-module 以執行 CLI 設定精靈。

npx nuxt-edgedb-module

就這樣！您的 Nuxt 專案現在有一個資料庫了。✨

如果您尚未在您的電腦上安裝 EdgeDB，安裝精靈將會協助您安裝。

範例專案

如果您想執行範例專案，您必須複製此儲存庫並執行 playground。

因為 EdgeDB 無法在 Stackblitz 或 CodeSandbox 等 Web 容器環境中執行。

git clone git@github.com:Tahul/nuxt-edgedb.git
cd nuxt-edgedb
pnpm install
pnpm stub
cd playground
edgedb project init
npx nuxt-edgedb-module
pnpm run dev

模組選項

您可以從您的 nuxt.config.ts 檔案設定模組的任何行為

export default defineNuxtConfig({
  modules: ['nuxt-edgedb-module'],
  edgeDb: {
    // Devtools integrations
    devtools: true,
    // Completely toggle watchers feature
    watch: true,
    // Enable or disable prompts on watch events
    watchPrompt: true,
    // Generate target for your queries and query builder
    generateTarget: 'ts',
    // dbschema/ dir
    dbschemaDir: 'dbschema',
    // Individual queries dir (useEdgeDbQueries composable)
    queriesDir: 'queries',
    // Toggle CLI install wizard
    installCli: true,
    // Toggles composables
    composables: true,
    // Toggles auto-injection on auth credentials
    injectDbCredentials: true,
    // Enables authentication integration
    auth: false,
    // Enables oauth integration
    oauth: false,
  }
})

伺服器使用

此模組會自動匯入 Nuxt 應用程式 server/ 環境中所有可用的 composable。

useEdgeDb

useEdgeDb 使用您的 Nuxt 環境配置，公開從 edgedb 匯入的原始客戶端。

// server/api/blogpost/[id].ts
import { defineEventHandler, getRouterParams } from 'h3'

export default defineEventHandler(async (req) => {
  const params = getRouterParams(req)
  const id = params.id
  const client = useEdgeDb()

  const blogpost = await client.querySingle(`
    select BlogPost {
      title,
      description
    } filter .id = <uuid>$id
  `, {
    id: id
  });

  return blogpost
})

useEdgeDbQueries

useEdgeDbQueries 公開您所有來自 dbschema/queries.ts 的查詢。

您不必傳遞客戶端給它們。它們將使用 useEdgeDb 產生且範圍限定於目前請求的客戶端。

// queries/getBlogPost.edgeql
select BlogPost {
  title,
  description
} filter .id = <uuid>$blogpost_id

// server/api/blogpost/[id].ts
import { defineEventHandler, getRouterParams } from 'h3'

export default defineEventHandler(async (req) => {
  const params = getRouterParams(req)
  const id = params.id
  const { getBlogpPost } = useEdgeDbQueries()
  const blogPost = await getBlogpost({ blogpost_id: id })

  return blogpost
})

您仍然可以直接從 #edgedb/queries 匯入 queries，並將來自 useEdgeDb() 的客戶端傳遞給它們。

// server/api/blogpost/[id].ts
import { getBlogPost } from '#edgedb/queries'
import { defineEventHandler, getRouterParams } from 'h3'

export default defineEventHandler(async (req) => {
  const params = getRouterParams(req)
  const id = params.id
  const client = useEdgeDb()
  const blogPost = await getBlogpost(client, { blogpost_id: id })

  return blogpost
})

useEdgeDbQueryBuilder

useEdgeDbQueryBuilder 直接將產生的查詢建構器公開給您的 server/ 環境。

// server/api/blogpost/[id].ts
import { defineEventHandler, getRouterParams } from 'h3'

export default defineEventHandler(async (req) => {
  const params = getRouterParams(req)
  const id = params.id
  const client = useEdgeDb()
  const e = useEdgeDbQueryBuilder()

  const blogPostQuery = e.select(
    e.BlogPost,
    (blogPost) => ({
      id: true,
      title: true,
      description: true,
      filter_single: { id }
    })
  )

  const blogPost = await blogPostQuery.run(client)

  return blogpost
})

類型

所有由 EdgeDB 產生的介面都可以透過 #edgedb/interfaces 的匯入使用。

<script setup lang="ts">
import type { BlogPost } from '#edgedb/interfaces'

defineProps<{ blogPost: BlogPost }>()
</script>

驗證

您可以將 EdgeDB 用作僅透過 server/api 端點和客戶端上的 $fetch 公開的伺服器端資料庫，避免需要驗證。

但在某些專案中，您可能希望您的使用者登入，以便他們在伺服器上也有身分。幸好，此模組已涵蓋這點。

在瀏覽這些驗證安裝步驟之前，我們強烈建議您閱讀 EdgeDB 驗證文件。

在您的 Nuxt 配置中啟用 `auth` 選項

export default defineNuxtConfig({
  modules: ['nuxt-edgedb-module'],
  edgedb: {
    auth: true
  }
})

在您的 schema 中設定 EdgeDB 驗證

在此範例中，您可以注意到

global current_user，它定義一個連結到客戶端權杖身分的全域屬性。
type User 是您的使用者模型，您可以自由變更它，這稍後可以透過遷移完成。
access policy author_has_full_access & using (.author ?= global current_user); 定義使用者只能存取他們自己的 BlogPost 的策略。

// dbschema/default.esdl
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;
  }

  type BlogPost {
    property content: str {
      default := 'My blog post content.';
    };
    property title: str {
      default := 'My blog post';
    };
    required author: User;

    access policy author_has_full_access
      allow all
      using (.author ?= global current_user);

    access policy others_read_only
      allow select;
  }
}

您可以在伺服器執行時編輯此 schema，並接受提示訊息以自動遷移。

如果您在伺服器關閉時進行這些編輯，您可以執行 edgedb migration create 和 edgedb migrate。

在您的伺服器中設定 EdgeDB 驗證

您需要在您的 EdgeDB 伺服器上啟用驗證提供者。

這可以在您的 DevTools 中透過 EdgeDB 標籤完成。

瀏覽您的資料庫至 Auth Admin 並指定

auth_signing_key
allowed_redirect_urls

您還必須啟用一些提供者。您可以先從 Email + Password 開始。

如果您啟用 required_verification，您將需要為您的 EdgeDB 實例配置 SMTP 伺服器。

您可以在這裡找到有關如何在本地使用 Mailtrap 嘗試此功能的更多說明。

請勿忘記這些步驟也必須在您的生產環境中執行。

在客戶端使用驗證元件

當您在您的配置中啟用驗證時，此模組會在您的專案中注入這些元件

您可以查看這些元件的原始碼，以了解更多關於它們的 props。

它們都是未樣式的元件，只公開實現順暢驗證流程所需的邏輯。

<template>
  <EdgeDbAuthEmailLogin
    v-slot="{ email, updateEmail, password, updatePassword, submit, loading }"
    redirect-to="/"
  >
    <div>
      <input
        type="email"
        :value="email"
        placeholder="your@email.com"
        @change="(e) => updateEmail(e.target.value)"
      >
      <input
        type="password"
        :value="password"
        placeholder="password"
        @change="(e) => updatePassword(e.target.value)"
      >
      <button
        type="button"
        @click="(e) => !loading && submit()"
      >
        {{ loading ? 'Loading' : 'Login' }}
      </button>
    </div>
  </EdgeDbAuthEmailLogin>
</template>

當然，您可以完全在本地重寫任何這些元件，以實作您自己的驗證流程。

OAuth

如果您想使用 OAuth，您必須在您的 nuxt.config 中啟用它

export default defineNuxtConfig({
  edgeDb: {
    oauth: true
  }
})

這會將兩個新元件注入您的應用程式

EdgeDB 目前支援以下提供者的 OAuth

Apple
Azure (Microsoft)
GitHub
Google

為了使 OAuth 正常運作，您必須透過 Nuxt DevTools 訪問您的 EdgeDB 實例 UI。

瀏覽到您的資料庫並訪問「Auth Admin」標籤。

在您的提供者列表中，您可以新增您想要的任何提供者，並配置必要的金鑰（通常是客戶端 appid 和 secret）。

請勿忘記將您的提供者的回呼 URL 設定為在您的 EdgeDB Auth Admin 頂部列出的 URL。

然後，您可以在您的應用程式中建立一個簡單的 OAuth 按鈕，如下所示

<template>
  <!-- Gives access to all available auth providers -->
  <EdgeDbAuthProviders v-slot="{ oAuthProviders: providers }">
    <!-- Create a OAuth button behavior from a provider name -->
    <EdgeDbOAuthButton
      v-for="provider of providers"
      :key="provider.name"
      v-slot="{ redirect }"
      :provider="provider.name"
    >
      <!-- Call `redirect` from the OAuthButton -->
      <button @click="() => redirect()">
        {{ provider.display_name }}
      </button>
    </EdgeDbOAuthButton>
  </EdgeDbAuthProviders>
</template>

您還需要一個回呼頁面，可以使用 EdgeDbAuthCallback。

<template>
  <EdgeDbOAuthCallback
    v-slot="{ loading }"
    redirect-to="/"
  >
    <div>
      <h2>OAuth callback</h2>
      <p v-if="loading">
        Loading...
      </p>
      </UCard>
    </div>
  </EdgeDbOAuthCallback>
</template>

太棒了，對吧？！只需幾行程式碼，我們就為我們的應用程式新增了基本的驗證功能。

客戶端使用

現在驗證已實作，您也可以在您的 Nuxt 應用程式中存取 useEdgeDbIdentity composable。

<script setup lang="ts">
const { isLoggedIn } = useEdgeDbIdentity()
</script>

<template>
  <div>
    <LoginButton v-if="isLoggedIn" />
    <LogoutButton v-else />
  </div>
</template>

您可以查看 useEdgeDbIdentity 以了解更多詳細資訊。

伺服器端使用

驗證過程會使用一個名為 edgedb-auth-token 的 cookie。

在伺服器上，如果您想驗證目前使用者對資料庫的請求，您只需將目前的請求物件傳遞給 composable

export default defineEventHandler(async (req) => {
  // Will throw an error, as you cannot delete a BlogPost without being the author
  const { deleteBlogPost } = useEdgeDbQueries()
  await deleteBlogPost({ blogpost_id: id })

  // Success
  const { deleteBlogPost: deleteBlogPostAuthenticated } = useEdgeDbQueries(req)
  await deleteBlogPostAuthenticated({ blogpost_id: id })

  return { id }
})

其他驗證解決方案

EdgeDDB 驗證是一個很棒的解決方案，但最終您的應用程式可能需要更多功能。

請勿忘記 EdgeDB 也可以用作資料庫。您可以建立自己的驗證或使用現有的解決方案，例如

您也可以同時使用並從您自己的驗證提供者建立 Identity 物件，並使用 edgedb-auth-token 作為您的 cookie。

我建議您查看 https://github.com/edgedb/edgedb-examples，其中包含許多在 EdgeDB 上建立的自訂驗證的絕佳範例。

驗證環境變數

# Your EdgeDB instance auth extension base URL
NUXT_EDGEDB_AUTH_BASE_URL=https://127.0.0.1:10702/db/edgedb/ext/auth/
# Your EdgeDB instance OAuth callback URL
NUXT_EDGEDB_OAUTH_CALLBACK=https://127.0.0.1:10702/db/edgedb/ext/auth/callback
# Your app callback page
NUXT_EDGEDB_OAUTH_REDIRECT_URL=https://127.0.0.1:3000/auth/callback
# Your app app reset password URL (receiving the token from the forgot password email)
NUXT_EDGEDB_AUTH_RESET_PASSWORD_URL=https://127.0.0.1:3000/auth/reset-password
# Your app email verify url (receiving the token from email verify feature)
NUXT_EDGEDB_AUTH_VERIFY_REDIRECT_URL=https://127.0.0.1:3000/auth/verify

進一步了解驗證

EdgeDB 驗證僅提供用於驗證的最基本的身分功能。

在驗證設定提供的程式碼範例中，User 類型與 Identity 介面一起使用。

如果您想在註冊時使用其他屬性填寫 User，您將必須自己實作此行為。

如果您想從 OAuth 提供者解析資料，您可以使用來自 Nitro 外掛程式的 Nitro hook，名為 edgedb:auth:callback。

// server/plugins/auth.ts

export default defineNitroPlugin((app) => {
  app.hooks.hook('edgedb:auth:callback', (data) => {
    const {
      code,
      verifier,
      codeExchangeUrl,
      codeExchangeResponseData,
    } = data

    // codeExchangeResponseData contains the OAuth token from the provider.
    // ... implement your own authentication logic.
  })
})

生產

如果您想脫離開發並將您的資料庫部署到生產環境，您必須遵循 EdgeDB 指南。

EdgeDB 是一個設計為自行託管的開源資料庫。

但是，他們還提供 Cloud，由於環境變數，它與此模組完全相容。

如果您想自訂 composable 使用的 DSN，您可以使用模組提供的環境變數

NUXT_EDGEDB_HOST=
NUXT_EDGEDB_PORT=
NUXT_EDGEDB_USER=
NUXT_EDGEDB_PASS=
NUXT_EDGEDB_DATABASE=

如果您想使用環境變數，您必須指定所有變數，否則客戶端將回退到預設值。

問與答

我的資料庫客戶端會暴露在使用者空間嗎？

不會，useEdgeDb 和 useEdgeDbQueries 僅在 Nuxt 的 server/ 環境中可用。

您可以作為選擇加入功能，從客戶端的 @dbschema/queries 匯入查詢。

您需要使用從 createClient() 取得的客戶端來提供這些查詢。

<script setup lang="ts">
import { createClient } from 'edgedb'
import { getUser } from '@dbschema/queries'

const client = createClient()
const user = await getUser(client, 42)
</script>

您也可以選擇**加入選擇使用**的方式，將查詢建構器匯入到客戶端。

我認為這對於超級管理員/內部儀表板可能很有用，但在安全性存取方面，請自行承擔風險使用。

<script setup lang="ts">
import e, { type $infer } from '#edgedb/builder'

const query = e.select(e.Movie, () => ({ id: true, title: true }))
type result = $infer<typeof query>
//   ^ { id: string; title: string }[]
</script>

請小心這些匯入，因為如果您匯入錯誤的查詢，您可能會最終讓客戶端可以使用寫入操作，這可能會損壞您的資料庫。

如何在生產環境中執行遷移？

在您的生產環境中複製您的 Nuxt 專案。
確保您在伺服器上安裝了 EdgeDB CLI。
將 edgedb migrate --quiet 添加到您的 CLI 指令稿中。

我應該對生成的檔案進行版本控制嗎？

不，因為它們是使用您的 Nuxt 客戶端生成的，您應該將它們添加到您的 .gitignore 中。

**/*.edgeql.ts
dbschema/queries.*
dbschema/query-builder
dbschema/interfaces.ts
queries/*.query.ts

如果您更改 **Dir 選項，則必須相應地更改這些路徑。

資料庫結構的 HMR（熱模組替換）真的安全嗎？

嗯，這取決於您何時要使用它。

我建議在您隨意開發專案時保持 watchPrompt 啟用。

這將防止執行任何不必要的遷移，並且僅在您向結構新增內容時才會提示。

如果您想快速進行並知道自己在做什麼，則可以將 watchPrompt 設為 false，並在結構上的任何變更時自動建立和套用遷移。

如果您不想要任何這些功能，只需將 watch 設為 false，並對開發資料庫中套用的變更感到安全。

資料庫的 HMR 在生產環境中顯然**沒有**任何效果。

為什麼名稱不是 `nuxt-edgedb`？

因為該名稱已在 NPM 上被佔用。

它似乎被 ohmree 佔用了，但該套件似乎處於非活動狀態。

如果有人碰巧認識他，我很樂意與他聯繫！

貢獻

此整合仍有許多很棒的功能可以建立。

我很高興收到並審閱任何 Pull Request。

開發

# Install dependencies
npm install

# Generate type stubs
npm run dev:prepare

# Develop with the playground
npm run dev

# Build the playground
npm run dev:build

# Run ESLint
npm run lint

# Run Vitest
npm run test
npm run test:watch

# Release new version
npm run release