SDK JavaScript
@aurabase/aurabase-js — client digitato per Node, Bun, Deno, Next.js, React, SvelteKit, Vue. Copre database, autenticazione, tempo reale, archiviazione, funzioni.
Un pacchetto, quattro manager#
pnpm add @aurabase/aurabase-js
L'SDK include direttamente l'esportazione di @aurabase/aurabase-js/ssr per Next.js (App Router, Server Actions, Middleware), Remix, Nuxt e SvelteKit con gestione automatica dei cookie di sessione e Chunking anti-troncamento.
Creare il cliente#
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 } }
)
Supporto nativo del rendering lato server#
Per le architetture SSR (Next.js App Router, Middleware, Server Actions, SvelteKit), importare createServerClient from @aurabase/aurabase-js/ssr. La sessione utente viene automaticamente archiviata in cookie httpOnly sicuri, con supporto multi-chunk per token di grandi dimensioni:
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 dal tuo schema#
npx @aurabase/gen --out lib/aurabase.types.ts (o aura db generate, che scrive types.ts nella cartella corrente) genera il file dei tipi dallo schema completo (tabelle, viste, enumerazioni, funzioni RPC). Per collegarti a createClient<Database> per digitare tutte le tue query.
{
"scripts": {
"types:gen": "npx @aurabase/gen --out src/aurabase.types.ts",
"migrate": "aura db push && pnpm types:gen"
}
}
Per servizio#
Banca dati
.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>>
In tempo reale
.channel(name, config?)→Channelchannel.on(event, filter, cb)→Channelchannel.subscribe()→Channelchannel.send({ type, event, payload })→Promise<void>channel.unsubscribe()→Promise<void>
Stoccaggio
.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 }>
Funzioni
.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 }>
Solo invoke è aperto alla chiave pubblica (anon). list, get, listJobs, getJob, enqueueJob, listCronJobs, createCronJob e deleteCronJob richiedono una chiave service_role e appartengono al tuo server: un FunctionDef trasporta il codice sorgente della funzione e le variabili di ambiente, quindi queste chiamate rispondono 403 a una chiave pubblica. invoke segnala errori come FunctionsHttpError (la funzione ha risposto con un errore, qualsiasi stato) o FunctionsRelayError (la piattaforma non è riuscita: rete, 502, 503, 504), entrambi esportati da @aurabase/aurabase-js.
Forma uniforme {dati, errore}#
Ogni metodo asincrono restituisce { data, error }. error è null in caso di successo, altrimenti un'istanza AuraError (anch'essa esportata con l'alias AurabaseError) con code, message, status e details. Passa { parseBigIntAsString: true } nelle opzioni createClient se lo schema utilizza valori bigint a 64 bit oltre 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 // istanza di AuraError / AurabaseError
}