جافا سكريبت SDK
@aurabase/aurabase-js - العميل المكتوب لـ Node وBun وDeno وNext.js وReact وSvelteKit وVue. يغطي قاعدة البيانات، والمصادقة، في الوقت الحقيقي، والتخزين، والوظائف.
حزمة واحدة وأربعة مديرين#
pnpm add @aurabase/aurabase-js
تتضمن SDK مباشرةً تصدير @aurabase/aurabase-js/ssr لـ Next.js (جهاز توجيه التطبيقات وإجراءات الخادم والبرامج الوسيطة) وRemix وNuxt وSvelteKit مع الإدارة التلقائية لملفات تعريف الارتباط الخاصة بالجلسة والتقطيع المضاد للاقتطاع.
إنشاء العميل#
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، والبرمجيات الوسيطة، وإجراءات الخادم، وSvelteKit)، قم باستيراد createServerClient من @aurabase/aurabase-js/ssr. يتم تخزين جلسة المستخدم تلقائيًا في ملفات تعريف الارتباط httpOnly الآمنة، مع دعم متعدد الأجزاء للرموز الكبيرة:
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 من المخطط الخاص بك#
npx @aurabase/gen --out lib/aurabase.types.ts (أو aura db generate، الذي يكتب types.ts في المجلد الحالي) ينشئ ملف الأنواع من مخططك الكامل (الجداول، وطرق العرض، والتعدادات، ووظائف RPC). للتوصيل بـ createClient<Database> لكتابة جميع استفساراتك.
{
"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?)→Channelchannel.on(event, filter, cb)→Channelchannel.subscribe()→Channelchannel.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 إذا كان مخططك يستخدم قيم bigint 64 بت بعد 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 // مثيل AuraError / AurabaseError
}