SDK JavaScriptu
@aurabase/aurabase-js — wpisany klient dla Node, Bun, Deno, Next.js, React, SvelteKit, Vue. Obejmuje bazę danych, uwierzytelnianie, czas rzeczywisty, przechowywanie i funkcje.
Jeden pakiet, czterech menedżerów#
pnpm add @aurabase/aurabase-js
SDK bezpośrednio umożliwia eksport @aurabase/aurabase-js/ssr do Next.js (App Router, Server Actions, Middleware), Remix, Nuxt i SvelteKit z automatycznym zarządzaniem sesyjnymi plikami cookie i fragmentacją zapobiegającą obcinaniu.
Utwórz klienta#
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 } }
)
Natywna obsługa renderowania po stronie serwera#
W przypadku architektur SSR (Next.js App Router, Middleware, Server Actions, SvelteKit) zaimportuj createServerClient z @aurabase/aurabase-js/ssr. Sesja użytkownika jest automatycznie zapisywana w bezpiecznych plikach cookie httpOnly z obsługą wielu fragmentów dla dużych tokenów:
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
}
Codegen z twojego schematu#
npx @aurabase/gen --out lib/aurabase.types.ts (lub aura db generate, który zapisuje types.ts w bieżącym folderze) generuje plik typów z całego schematu (tabele, widoki, wyliczenia, funkcje RPC). Aby podłączyć się do createClient<Database> i wpisać wszystkie zapytania.
{
"scripts": {
"types:gen": "npx @aurabase/gen --out src/aurabase.types.ts",
"migrate": "aura db push && pnpm types:gen"
}
}
Przez serwis#
Baza danych
.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())
Autoryt
.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>>
W czasie rzeczywistym
.channel(name, config?)→Channelchannel.on(event, filter, cb)→Channelchannel.subscribe()→Channelchannel.send({ type, event, payload })→Promise<void>channel.unsubscribe()→Promise<void>
Składowanie
.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 }>
Funkcje
.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 }>
Tylko klucz invoke jest otwarty dla publiczności (anon). list, get, listJobs, getJob, enqueueJob, listCronJobs, createCronJob i deleteCronJob wymagają klucza service_role i należą do Twojego serwera: FunctionDef przenosi kod źródłowy funkcji i zmienne środowiskowe, więc te wywołania odpowiadają 403 do klucza publicznego. invoke zgłasza błędy jako FunctionsHttpError (funkcja odpowiedziała błędem, dowolny status) lub FunctionsRelayError (awaria platformy: sieć, 502, 503, 504), oba eksportowane przez @aurabase/aurabase-js.
Jednolity kształt {dane, błąd}#
Każda metoda asynchroniczna zwraca { data, error }. error to null w przypadku powodzenia, w przeciwnym razie instancja AuraError (również eksportowana pod aliasem AurabaseError) z code, message, status i details. Przekaż { parseBigIntAsString: true } w opcjach createClient, jeśli Twój schemat używa 64-bitowych wartości bigint poza Number.MAX_SAFE_INTEGER.
import { AurabaseError } from '@aurabase/aurabase-js'
const { data, error } = await aura.from('users').select('*').single()
if (error) {
if (error.code === 'PGRST116') notFound()
throw error // instancja AuraError / AurabaseError
}