SDK de JavaScript: funciones

aura.functions es un FunctionsService. Casi nunca lo construyes tú mismo.

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

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

El paquete @aurabase/functions se instala con @aurabase/aurabase-js. Instálelo solo si crea su propio cliente desde @aurabase/core. Requiere Node.js 20 o posterior y envía módulos ES y CommonJS con declaraciones de tipo.

Cada método devuelve Promise<AuraResponse<T>>, un objeto { data, error } que nunca arroja:

Pruebe data en lugar de error cuando necesite el valor: solo entonces TypeScript sabe que no es 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 está codificado en la URL, por lo que un valor que contenga /, ? o # no puede abandonar su posición. Un nombre que contenga tales caracteres simplemente no se encuentra.

invoke actualiza primero una sesión de usuario caducada, envía el JWT del usuario cuando hay uno y nunca vuelve a intentar una llamada.

Cómo usarlo: Invoca una función. Cómo falla: Errores, tiempos de espera y reintentos.

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

Ambos necesitan una clave service_role. get acepta el nombre o el id ; Si una función tiene el nombre de una identificación, el nombre gana. Un FunctionDef contiene el código fuente y las variables de la función, por eso una clave pública recibe 403.

No existe ningún método para implementar, actualizar o eliminar una función, o para escribir secretos: utilice la API HTTP o la 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 devuelve { code: 'bad_request', status: 400 } sin ninguna solicitud cuando functionName está vacío o solo tiene espacios y, en caso contrario, recorta el nombre.
• listJobs filtra en status (pending, running, completed, failed, dead) y devuelve entre 1 y 500 trabajos, 50 de forma predeterminada.
• Reintentar trabajos inactivos no tiene ningún método: consulte la cola de mensajes no entregados .

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

schedule tiene 5 o 6 campos, en UTC. deleteCronJob toma el nombre y devuelve 404 para un nombre desconocido. No hay getCronJob o updateCronJob.

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

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

Ambas clases de error extienden AuraError, por lo que isAuraError(error) es verdadero. AuraError tiene status, code, message, details, retryAfter y los captadores isNotFound, isUnauthorized, isForbidden y isRateLimited.

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