본문으로 건너뛰기
아우라베이스 로고
아우라베이스

자바스크립트 SDK

@aurabase/aurabase-js — Node, Bun, Deno, Next.js, React, SvelteKit, Vue에 대해 유형화된 클라이언트입니다. 데이터베이스, 인증, 실시간, 스토리지, 기능을 다룹니다.

레퍼런스10분 읽기레벨 참조2026. 4. 15.에 개정됨

이 페이지는 자동으로 번역되었습니다. 영어 버전은 권위가 있습니다.

패키지 1개, 관리자 4명#

terminalbash
pnpm add @aurabase/aurabase-js
팁

SDK에는 세션 쿠키 및 잘림 방지 청킹의 자동 관리 기능을 갖춘 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, Middleware, Server Actions, SvelteKit)의 경우 @aurabase/aurabase-js/ssr에서 createServerClient를 가져옵니다. 사용자 세션은 대규모 토큰에 대한 다중 청크 지원과 함께 보안 httpOnly 쿠키에 자동으로 저장됩니다.

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 인스턴스
}

더 나아가려면#