SDK e CLI
O Fóir publica dois pacotes npm: um cliente tipado para a sua aplicação e uma ferramenta de linha de comando para scripts e CI.
O cliente tipado
O cliente tipado em @foir/sdk envia GraphQL ao mesmo endpoint que qualquer outro cliente e escreve o documento para você. Uma chamada tipada é uma requisição. Ela devolve todos os campos escalares do modelo por padrão, e pick, omit e include ajustam a seleção.
Seus tipos vêm de foir types e são gerados por chave, então uma operação que a chave não pode executar não está no tipo.
Onde o cliente roda
O cliente usa apenas fetch e não guarda estado em nível de módulo. A documentação o cobre em Hydrogen, loaders do React Router, TanStack Start e runtimes de edge. Outros pontos de entrada do mesmo pacote cuidam de sessões dos seus usuários, atualizações em tempo real e mídia.
O que a CLI cobre
@foir/cli instala o comando foir. Seus grupos de comandos cobrem registros, modelos, locales, mídia, busca, rollouts, releases, o cache, chaves de API, seus usuários e seus papéis, organizações, operações, hooks, agendamentos, segredos, provedores de login, exportação e geração de tipos. Ela também aplica o seu arquivo de config com um push. A referência da CLI lista os comandos, e a referência de intents na documentação mostra quais ações da plataforma têm um.
Saída e login para scripts
Todo comando imprime uma tabela por padrão e pode imprimir JSON, JSON Lines ou apenas ids, para usar em pipes. Os payloads vêm de uma flag, de um arquivo ou do stdin. Você faz login pelo navegador, com um fluxo de código de dispositivo para SSH, contêineres e CI, ou define uma chave de API no ambiente para execuções sem interface.
Leia os detalhes
O guia do SDK cobre a instalação do cliente tipado, a geração de seus tipos e a realização de chamadas, e a CLI tem sua própria referência.