コンテンツへスキップ
オーラベースのロゴ
オーラベース

JavaScript SDK

@aurabase/aurabase-js — Node、Bun、Deno、Next.js、React、SvelteKit、Vue の型付きクライアント。データベース、認証、リアルタイム、ストレージ、機能をカバーします。

リファレンス10 分 読み取りレベル 参照2026/04/15 に改訂

このページは自動翻訳されました。英語版が正式です。

1 つのパッケージ、4 つのマネージャー#

terminalbash
pnpm add @aurabase/aurabase-js
ヒント

SDK には、セッション Cookie と切り捨て防止チャンキングの自動管理を備えた Next.js (App Router、Server Actions、Middleware)、Remix、Nuxt、および SvelteKit 用の @aurabase/aurabase-js/ssr エクスポートが直接含まれています。

クライアントを作成する#

src/lib/aurabase.tstypescript
import { createClient } from '@aurabase/aurabase-js'
import type { Database } from './aurabase.types'

export const aura = createClient<Database>(
  process.env.NEXT_PUBLIC_AURABASE_URL!,
  process.env.NEXT_PUBLIC_AURABASE_ANON_KEY!,
  { auth: { persistSession: true } }
)

ネイティブのサーバー側レンダリングのサポート#

SSR アーキテクチャ (Next.js App Router、ミドルウェア、サーバー アクション、SvelteKit) の場合は、 @aurabase/aurabase-js/ssrから createServerClient をインポートします。ユーザー セッションは、大きなトークンのマルチチャンク サポートを備えた安全な httpOnly Cookie に自動的に保存されます。

src/middleware.tstypescript
import { createServerClient } from '@aurabase/aurabase-js/ssr'
import { NextResponse, type NextRequest } from 'next/server'

export async function middleware(request: NextRequest) {
  let response = NextResponse.next({ request })
  const aura = createServerClient(
    process.env.NEXT_PUBLIC_AURABASE_URL!,
    process.env.NEXT_PUBLIC_AURABASE_ANON_KEY!,
    {
      cookies: {
        getAll() { return request.cookies.getAll() },
        setAll(cookies) {
          cookies.forEach(({ name, value, options }) => {
            request.cookies.set(name, value)
            response.cookies.set(name, value, options)
          })
        },
      },
    })
  await aura.auth.getSession()
  return response
}

スキーマからのコード生成#

npx @aurabase/gen --out lib/aurabase.types.ts (または、現在のフォルダーに types.ts を書き込む aura db generate) は、完全なスキーマ (テーブル、ビュー、列挙型、RPC 関数) からタイプ ファイルを生成します。 createClient<Database> にプラグインしてすべてのクエリを入力します。

package.jsonjson
{
  "scripts": {
    "types:gen": "npx @aurabase/gen --out src/aurabase.types.ts",
    "migrate": "aura db push && pnpm types:gen"
  }
}

サービス別#

データベース

  • .from(table).select(cols?) → SelectBuilder<T>
  • .from(table).insert(row) → Promise<{ data, error }>
  • .from(table).update(patch) → UpdateBuilder<T>
  • .from(table).delete() → DeleteBuilder<T>
  • .rpc(fn, args) → Promise<{ data, error }>
  • .nosql.collection(name) → NoSqlCollectionClient (find()、 insertOne()、 aggregate()、 createIndex())

認証

  • .auth.signUp({ email, password, options? }) → Promise<AuraResponse<LoginResponse>>
  • .auth.signInWithPassword({ email, password }) → Promise<AuraResponse<LoginResponse>>
  • .auth.signInWithOAuth(provider, opts?) | ({ provider, ... }) → Promise<AuraResponse<{ url }>>
  • .auth.getSession() → Promise<{ data: { session }, error }>
  • .auth.signOut() → Promise<AuraResponse<void>>
  • .auth.mfa.enroll() | .auth.mfaEnroll() → Promise<AuraResponse<MfaEnrollResponse>>

リアルタイム

  • .channel(name, config?) → Channel
  • channel.on(event, filter, cb) → Channel
  • channel.subscribe() → Channel
  • channel.send({ type, event, payload }) → Promise<void>
  • channel.unsubscribe() → Promise<void>

ストレージ

  • .storage.from(bucket).upload(path, file, opts?) → Promise<{ data, error }>
  • .storage.from(bucket).download(path) → Promise<Blob>
  • .storage.from(bucket).getPublicUrl(path, opts?) → { publicUrl }
  • .storage.from(bucket).createSignedUrl(path, expiresIn) → Promise<{ signedUrl }>
  • .storage.from(bucket).remove(paths[]) → Promise<{ data, error }>

機能

  • .functions.invoke(name, { body?, method?, path?, headers?, responseType?, signal?, timeout? }) → Promise<{ data, error }>
  • .functions.list() → Promise<{ data: FunctionDef[], error }>
  • .functions.get(nameOrId) → Promise<{ data: FunctionDef, error }>
  • .functions.listJobs({ status?, limit? }) → Promise<{ data: Job[], error }>
  • .functions.getJob(jobId) → Promise<{ data: Job, error }>
  • .functions.enqueueJob(functionName, { payload?, delaySecs?, maxAttempts? }) → Promise<{ data: Job, error }>
  • .functions.listCronJobs() → Promise<{ data: CronJob[], error }>
  • .functions.createCronJob(name, schedule, functionName, { payload? }) → Promise<{ data: CronJob, error }>
  • .functions.deleteCronJob(name) → Promise<{ data, error }>

invoke のみが公開 (anon) キーとして公開されています。 list、 get、 listJobs、 getJob、 enqueueJob、 listCronJobs、 createCronJob および deleteCronJob は service_role キーを必要とし、サーバーに属します。 FunctionDef は関数のソース コードと環境変数を運ぶため、これらの呼び出しは応答します。 403 を公開キーに変換します。 invoke は、エラーを FunctionsHttpError (関数がエラー、任意のステータスで応答) または FunctionsRelayError (プラットフォームが失敗しました: ネットワーク、502、503、504) として報告し、どちらも @aurabase/aurabase-jsによってエクスポートされます。

均一形状 { データ、エラー }#

各非同期メソッドは { data, error }を返します。 error は、成功した場合は null 、それ以外の場合は、 code、 message、 status、および detailsを含む AuraError インスタンス (エイリアス AurabaseErrorでエクスポートされる) になります。スキーマが Number.MAX_SAFE_INTEGERを超える 64 ビット bigint 値を使用する場合は、 createClient オプションに { parseBigIntAsString: true } を渡します。

errors.tstypescript
import { AurabaseError } from '@aurabase/aurabase-js'

const { data, error } = await aura.from('users').select('*').single()

if (error) {
  if (error.code === 'PGRST116') notFound()
  throw error // AuraError / AurabaseError のインスタンス
}

さらに進むには#