Roep een functie aan

invoke is de enige oproep die een openbare sleutel kan maken. Het werkt hetzelfde in een browser en op een server.

import { createClient } from '@aurabase/aurabase-js'

const aura = createClient(process.env.AURA_URL!, process.env.AURA_ANON_KEY!)

const { data, error } = await aura.functions.invoke<{ greeting: string }>('hello', {
  body: { name: 'Ada' },
})
if (error) throw error
console.log(data?.greeting)

// Na het inloggen voegt de SDK de JWT van de gebruiker toe aan elk gesprek: geen extra code.
await aura.auth.signInWithPassword({ email, password })
const { data } = await aura.functions.invoke('whoami')
// De functie ziet x-aura-role: authenticated en de ID van de gebruiker.

De generieke invoke<T> typt alleen het antwoord. De naam en de hoofdtekst worden tijdens het compileren niet gecontroleerd.

Uw functie ontvangt precies het verzoek dat u beschrijft, en geen omhulsel eromheen.

await aura.functions.invoke('items', {
  method: 'PUT',
  path: '/items/1',
  headers: { 'x-source': 'dashboard' },
  body: { qty: 2 },
})

Deno.serve(async (req) => {
  const url = new URL(req.url)          // padnaam: '/items/1'
  const source = req.headers.get('x-source') // 'dashboard'
  const body = await req.json()         // { aantal: 2 }
  return Response.json({ method: req.method, id: url.pathname.split('/').pop(), source, body })
})

Regels die de moeite waard zijn om te weten:

• GET en HEAD worden zonder body verzonden.
• Een hoofdtekst die geen string is, wordt verzonden als JSON, met content-type: application/json, tenzij u er een instelt. Een string body wordt verzonden zoals het is en krijgt ook content-type: application/json, dus lees het met req.text().
• Zonder body ontvangt de functie een verzoek zonder hoofdtekst. Een kale await req.json() gooit, dus schrijf await req.json().catch(() => ({})) wanneer de oproep kan worden gedaan zonder een payload.
• De body moet JSON zijn: een object, array, string, getal of booleaanse waarde. Een Blob, ArrayBuffer, getypte array, FormData, URLSearchParams of ReadableStream wordt geweigerd met de foutcode invalid_body voordat er een verzoek wordt verzonden.
• Framingheaders (content-length, transfer-encoding, connection, host, …) worden genegeerd.

Het platform valideert de sleutel en het token van de gebruiker voordat uw functie wordt uitgevoerd en voegt vervolgens deze headers toe:

Deno.serve((req) => {
  if (req.headers.get('x-aura-role') !== 'authenticated') {
    return new Response('Sign in first', { status: 401 })
  }
  return Response.json({ userId: req.headers.get('x-aura-user-id') })
})

Echte resultaten van deze oproep met drie verschillende sleutels:

{ "role": "anon",          "userId": null }
{ "role": "authenticated", "userId": "b125f8cd-ddc8-4042-9d9d-2e0aa3cebe51" }
{ "role": "service_role",  "userId": null }

Verzend zonder de SDK een JSON-object dat de aanvraag beschrijft. Het veld body is wat uw functie ontvangt.

curl -X POST "$AURA_URL/v1/functions/hello/invoke" \
  -H "apikey: $AURA_ANON_KEY" \
  -H "Content-Type: application/json" \
  -d '{"body":{"name":"Ada"}}'

Zowel apikey als Content-Type: application/json zijn vereist. Voeg Authorization: Bearer <user JWT> toe om te bellen als ingelogde gebruiker. Het standaardantwoord is een envelop; de header X-Aurabase-Invoke-Mode: raw retourneert in plaats daarvan het eigen antwoord van uw functie, zie niet-JSON-antwoorden.

invoke gooit nooit. Het retourneert { data, error }:

const { data, error } = await aura.functions.invoke('hello', { body: { name: 'Ada' } })

if (error) {
  // error.status: HTTP-status van de fout
  // error.message: de tekst die uw functie heeft geretourneerd, of de uitleg van het platform
  return
}
// gegevens zijn nul wanneer de functie geen inhoud retourneert (bijvoorbeeld een 204)
if (data === null) return
console.log(data)

Test data in plaats van error als je de waarde nodig hebt: TypeScript weet dan dat het niet null is. Om fouten nauwkeurig af te handelen, leest u fouten, time-outs en nieuwe pogingen.