SDK e CLI
Fóir pubblica due pacchetti npm: un client tipizzato per la tua applicazione e uno strumento da riga di comando per script e CI.
Il client tipizzato
Il client tipizzato in @foir/sdk invia GraphQL allo stesso endpoint di qualsiasi altro client e scrive il documento per te. Una chiamata tipizzata è una richiesta. Per impostazione predefinita restituisce ogni campo scalare del modello, e pick, omit e include modificano la selezione.
I suoi tipi vengono da foir types e sono generati per chiave, quindi un'operazione che la chiave non può eseguire non è nel tipo.
Dove gira il client
Il client usa solo fetch e non ha stato a livello di modulo. La documentazione lo copre in Hydrogen, nei loader di React Router, in TanStack Start e nei runtime edge. Altri entry point dello stesso pacchetto gestiscono le sessioni dei tuoi utenti, gli aggiornamenti in tempo reale e i media.
Che cosa copre la CLI
@foir/cli installa il comando foir. I suoi gruppi di comandi coprono record, modelli, locali, media, ricerca, rollout, release, la cache, le chiavi API, i tuoi utenti e i loro ruoli, le organizzazioni, le operazioni, gli hook, le pianificazioni, i secret, i provider di login, l'esportazione e la generazione dei tipi. Applica anche il tuo file di configurazione con un push. Il riferimento della CLI elenca i comandi, e il riferimento degli intent nella documentazione mostra quali azioni della piattaforma ne hanno uno.
Output e login per gli script
Ogni comando stampa una tabella per impostazione predefinita e può stampare JSON, JSON Lines o solo gli id, per il piping. I payload arrivano da un flag, da un file o da stdin. Accedi dal browser, con un flusso a codice dispositivo per SSH, container e CI, oppure imposti una chiave API nell'ambiente per le esecuzioni headless.
Approfondisci
La guida all'SDK tratta l'installazione del client tipizzato, la generazione dei suoi tipi e l'esecuzione delle chiamate, e la CLI ha un proprio riferimento.