Gere tipos TypeScript do seu banco de dados
Um comando transforma suas tabelas em tipos. Seu editor rejeita uma coluna errada ou um valor errado antes de você executar qualquer coisa.
Gere o arquivo#
npx @aurabase/gen --url https://my-app.aurabase.cloud --key "$AURABASE_SERVICE_ROLE_KEY" --out src/types/database.types.ts
A introspecção do esquema (GET /v1/db/schema) requer uma chave service_role (AURABASE_SERVICE_ROLE_KEY); passar uma chave anon é rejeitado com uma mensagem explícita. Sem --url e --key, @aurabase/gen lê NEXT_PUBLIC_AURABASE_URL e AURABASE_SERVICE_ROLE_KEY do seu ambiente e .env, .env.local, .env.development (ou um instantâneo de esquema local com --from-file).
Em um projeto com duas tabelas e duas funções, imprime:
[aurabase-gen] Types written to src/types/database.types.ts (2 table(s), 2 function(s), 0 enum(s), 0 view(s)).
Execute-o novamente sempre que o esquema for alterado (ou passe --check no CI para falhar no desvio do esquema). Adicione --schema <name> para um esquema diferente de public, --type-name para renomear o tipo principal e --numeric-as-string para manter numeric/decimal como string em vez de number.
Use-o com o cliente#
import { createClient } from '@aurabase/aurabase-js'
import type { Database } from '../types/database.types'
export const aura = createClient<Database>(process.env.NEXT_PUBLIC_AURABASE_URL!, process.env.NEXT_PUBLIC_AURABASE_ANON_KEY!)
O tipo gerado descreve cada tabela com Row, Insert e Update. Contra um arquivo real, o compilador deu estes resultados:
const { data } = await aura.from('todos').select('id, title, done')
const title: string | undefined = data?.[0]?.title // ok
const wrong: number | undefined = data?.[0]?.title // erro: string não pode ser atribuída ao número
await aura.from('todos').insert({ title: 1 }) // erro: o número não pode ser atribuído à string
await aura.from('todos').insert({ title: 'ok' }) // ok: as outras colunas têm padrões
Em Insert, uma coluna com uma coluna padrão ou anulável é opcional. Em Update, cada coluna é opcional.
Tipos de linha para seus componentes#
import type { Tables, TablesInsert, TablesUpdate, Enums } from '../types/database.types'
type Todo = Tables<'todos'> // uma linha, conforme lido
type NewTodo = TablesInsert<'todos'> // o que insert() aceita
type TodoPatch = TablesUpdate<'todos'> // o que update() aceita
Enums<'name'> fornece os valores de uma enumeração de banco de dados.
O que é verificado#
- Uma tabela que não está no arquivo gerado é e não rejeitada:
aura.from('anything')ainda é compilada e suas linhas não são digitadas. - As funções aparecem em
Functionscom argumentos digitados e valores de retorno:add(a int, b int) returns intforneceArgs: { a: number; b: number }eReturns: number, e uma funçãoRETURNS TABLE (content text, dist float8)forneceReturns: { content: string; dist: number }[]. Uma função que retorna um tipo composto anônimo ainda é exibida comoRecord<string, unknown>. - Filtros, cargas úteis
insert()eupdate(), enums e incorporações de relacionamento são verificados. A lista de colunas dentro da stringselect('a, b')é usada para digitar o resultado, mas um nome com erro ortográfico só é detectado em tempo de execução (COLUMN_NOT_FOUND, com uma dica «Talvez você quis dizer…»). - Os botões Types do Studio e
npx @aurabase/genproduzem o mesmo arquivo. - O arquivo reflete o esquema no momento em que você o gerou. Uma coluna adicionada posteriormente é desconhecida para os tipos até que você execute a ferramenta novamente.
- A introspecção do esquema requer
AURABASE_SERVICE_ROLE_KEY(execute-o localmente ou em CI; nunca confirme uma chaveservice_roleou exponha-a no código do cliente).