JavaScript-SDK
@aurabase/aurabase-js - getypte client voor Node, Bun, Deno, Next.js, React, SvelteKit, Vue. Omvat database, authenticatie, realtime, opslag, functies.
Eén pakket, vier managers#
pnpm add @aurabase/aurabase-js
De SDK omvat rechtstreeks @aurabase/aurabase-js/ssr-export voor Next.js (App Router, Server Actions, Middleware), Remix, Nuxt en SvelteKit met automatisch beheer van sessiecookies en anti-truncatie chunking.
Maak de klant aan#
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 } }
)
Ondersteuning voor native server-side rendering#
Voor SSR-architecturen (Next.js App Router, Middleware, Server Actions, SvelteKit) importeert u createServerClient uit @aurabase/aurabase-js/ssr. De gebruikerssessie wordt automatisch opgeslagen in beveiligde httpOnly-cookies, met ondersteuning voor meerdere stukken voor grote tokens:
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 uit uw schema#
npx @aurabase/gen --out lib/aurabase.types.ts (of aura db generate, dat types.ts in de huidige map schrijft) genereert het typenbestand op basis van uw volledige schema (tabellen, views, enums, RPC-functies). Om in te pluggen in createClient<Database> om al uw vragen te typen.
{
"scripts": {
"types:gen": "npx @aurabase/gen --out src/aurabase.types.ts",
"migrate": "aura db push && pnpm types:gen"
}
}
Door dienst#
Database
.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())
Aut
.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>>
Realtime
.channel(name, config?)→Channelchannel.on(event, filter, cb)→Channelchannel.subscribe()→Channelchannel.send({ type, event, payload })→Promise<void>channel.unsubscribe()→Promise<void>
Opslag
.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 }>
Functies
.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 }>
Alleen invoke is toegankelijk voor de openbare sleutel (anon). list, get, listJobs, getJob, enqueueJob, listCronJobs, createCronJob en deleteCronJob vereisen een service_role sleutel en horen op uw server: een FunctionDef draagt de broncode en omgevingsvariabelen van de functie, dus deze oproepen beantwoorden 403 naar een openbare sleutel. invoke rapporteert fouten als FunctionsHttpError (de functie beantwoord met een fout, welke status dan ook) of FunctionsRelayError (het platform is mislukt: netwerk, 502, 503, 504), beide geëxporteerd door @aurabase/aurabase-js.
Uniforme vorm {gegevens, fout}#
Elke asynchrone methode retourneert { data, error }. error is bij succes null, anders een AuraError-instantie (ook geëxporteerd onder de alias AurabaseError) met code, message, status en details. Geef { parseBigIntAsString: true } door in de createClient-opties als uw schema 64-bits bigint-waarden gebruikt die verder gaan dan 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 // exemplaar van AuraError / AurabaseError
}