Перейти к содержимому
Логотип Аурабаза
аурабаза

JavaScript SDK

@aurabase/aurabase-js — типизированный клиент для Node, Bun, Deno, Next.js, React, SvelteKit, Vue. Охватывает базу данных, аутентификацию, режим реального времени, хранилище, функции.

Справочник10 мин читатьУровень ссылкаПересмотрено 15 апр. 2026 г.

Эта страница была переведена автоматически. Английская версия является авторитетной.

Один пакет, четыре менеджера#

terminalbash
pnpm add @aurabase/aurabase-js
Совет

SDK напрямую включает экспорт @aurabase/aurabase-js/ssr для Next.js (App Router, Server Actions, Middleware), Remix, Nuxt и SvelteKit с автоматическим управлением сеансовыми файлами cookie и блокировкой для предотвращения усечения.

Создать клиент#

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, промежуточное ПО, действия сервера, SvelteKit) импортируйте createServerClient из @aurabase/aurabase-js/ssr. Сеанс пользователя автоматически сохраняется в защищенных файлах cookie 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 (или aura db generate, который записывает types.ts в текущую папку) генерирует файл типов из вашей полной схемы (таблицы, представления, перечисления, функции 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, в противном случае — экземпляр AuraError (также экспортируемый под псевдонимом AurabaseError) с code, message, status и details. Передайте { parseBigIntAsString: true } в параметрах createClient, если ваша схема использует 64-битные значения bigint за пределами Number.MAX_SAFE_INTEGER.

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
}

Чтобы пойти дальше#