SDK et CLI

Le client typé

Le client typé de @foir/sdk envoie du GraphQL au même endpoint que n'importe quel autre client et écrit le document pour vous. Un appel typé correspond à une requête. Il renvoie par défaut chaque champ scalaire du modèle, et pick, omit et include ajustent la sélection.

Ses types proviennent de foir types et sont générés par clé, de sorte qu'une opération que la clé ne peut pas effectuer n'est pas dans le type.

Où s'exécute le client

Le client n'utilise que fetch et ne garde aucun état au niveau du module. La documentation le couvre dans Hydrogen, les loaders React Router, TanStack Start et les runtimes edge. D'autres points d'entrée du même paquet gèrent les sessions de vos utilisateurs, les mises à jour en direct et les médias.

Ce que couvre la CLI

@foir/cli installe la commande foir. Ses groupes de commandes couvrent les enregistrements, les modèles, les locales, les médias, la recherche, les déploiements, les publications, le cache, les clés API, vos utilisateurs et leurs rôles, les organisations, les opérations, les hooks, les planifications, les secrets, les fournisseurs de connexion, l'export et la génération de types. Elle applique aussi votre fichier de config avec un push. La référence de la CLI liste les commandes, et la référence des intentions dans la documentation indique quelles actions de la plateforme en ont une.

Sortie et connexion pour les scripts

Chaque commande affiche un tableau par défaut et peut afficher du JSON, du JSON Lines ou seulement des identifiants, pour les chaîner. Les charges viennent d'une option, d'un fichier ou de stdin. Vous vous connectez par le navigateur, avec un flux par code d'appareil pour SSH, les conteneurs et la CI, ou vous définissez une clé API dans l'environnement pour les exécutions sans interface.