SDK JavaScript: funções

aura.functions é um FunctionsService. Você quase nunca constrói sozinho.

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

const aura = createClient('https://my-app.aurabase.cloud', 'aura_anon_…')
aura.functions.invoke('hello')

O pacote @aurabase/functions é instalado com @aurabase/aurabase-js. Instale-o sozinho apenas se você compor seu próprio cliente a partir de @aurabase/core. Requer Node.js 20 ou posterior e vem com módulos ES e CommonJS com declarações de tipo.

Todo método retorna Promise<AuraResponse<T>>, um objeto { data, error } que nunca lança:

Teste data em vez de error quando precisar do valor: só então TypeScript sabe que não é null.

invoke<T = unknown>(
  name: string,
  options?: {
    body?: unknown
    method?: string
    path?: string
    headers?: Record<string, string>
    signal?: AbortSignal
    timeout?: number
    responseType?: 'json' | 'text' | 'blob' | 'arrayBuffer'
  },
): Promise<AuraResponse<T>>

name é codificado na URL, portanto, um valor contendo /, ? ou # não pode sair de sua posição. Um nome que contenha tais caracteres simplesmente não é encontrado.

invoke atualiza primeiro uma sessão de usuário expirada, envia o JWT do usuário quando há uma e nunca tenta novamente uma chamada.

Como usar: Invoque uma função. Como falha: Erros, tempos limites e novas tentativas.

list(): Promise<AuraResponse<FunctionDef[]>>
get(nameOrId: string): Promise<AuraResponse<FunctionDef>>

Ambos precisam de uma chave service_role. get aceita o nome ou o id ; se uma função for nomeada como um id, o nome vence. Um FunctionDef contém o código fonte e as variáveis ​​da função, por isso uma chave pública recebe 403.

Não há método para implantar, atualizar ou excluir uma função ou para escrever segredos: use a HTTP API ou a CLI.

enqueueJob(
  functionName: string,
  options?: { payload?: unknown; delaySecs?: number; maxAttempts?: number },
): Promise<AuraResponse<Job>>

listJobs(options?: { status?: string; limit?: number }): Promise<AuraResponse<Job[]>>
getJob(jobId: string): Promise<AuraResponse<Job>>

• enqueueJob retorna { code: 'bad_request', status: 400 } sem qualquer solicitação quando functionName está vazio ou apenas espaços, e corta o nome caso contrário.
• listJobs filtra status (pending, running, completed, failed, dead) e retorna entre 1 e 500 trabalhos, 50 por padrão.
• A repetição de trabalhos inativos não tem método: consulte a fila de mensagens mortas .

listCronJobs(): Promise<AuraResponse<CronJob[]>>
createCronJob(
  name: string,
  schedule: string,
  functionName: string,
  options?: { payload?: unknown },
): Promise<AuraResponse<CronJob>>
deleteCronJob(name: string): Promise<AuraResponse<null>>

schedule possui 5 ou 6 campos, em UTC. deleteCronJob pega o nome e retorna 404 para um nome desconhecido. Não há getCronJob ou updateCronJob.

Exportado por @aurabase/aurabase-js e @aurabase/functions:

import {
  FunctionsHttpError,
  FunctionsRelayError,
  isRelayStatus,
  type FunctionsResponseType,
} from '@aurabase/aurabase-js'

Ambas as classes de erro estendem AuraError, então isAuraError(error) é verdadeiro. AuraError tem status, code, message, details, retryAfter, e os getters isNotFound, isUnauthorized, isForbidden e isRateLimited.

Tipos de dados, exportados por @aurabase/aurabase-js: