Serveur · Référence
SDK et exports du paquet
Choisissez le bon point d'entrée pour les composants, middleware serveur, schémas, API et autorisations de projet.
@krak-stack/auth publie des points d'entrée distincts pour l'interface navigateur, les services Effect, contrats API, schémas et autorisations. Importez le point le plus étroit correspondant à la frontière d'exécution.
Carte des exports
| Point d'entrée | Usage |
|---|---|
@krak-stack/auth/components | Fournisseur, formulaires auth, contrôles de compte et organisation et aides d'autorisation UI |
@krak-stack/auth/server | Proxy, AuthMiddleware, AuthService, ActorRequired, acteurs et politiques |
@krak-stack/auth/access | Catalogues d'accès typés et construction des politiques |
@krak-stack/auth/access/matrix | Tableau de référence des autorisations généré |
@krak-stack/auth/api | Contrats Effect HttpApi combinés |
@krak-stack/auth/auth | Contrat HttpApi d'authentification navigateur et schémas associés |
@krak-stack/auth/schema | Schémas partagés des utilisateurs, organisations, sessions, projets et clés API |
@krak-stack/auth/query | Aides de requête pour les clients Effect Atom |
@krak-stack/auth/admin | Contrat de l'API administrative |
@krak-stack/auth/extra | Contrat de l'API navigateur supplémentaire |
@krak-stack/auth/tailwind.css | Détection Tailwind des classes des composants |
Utilisez @krak-stack/auth/auth pour construire un client Effect HttpApiClient ou AtomHttpApi destiné aux endpoints d'authentification du navigateur. Pour l'interface, importez directement les composants et atomes fournis depuis @krak-stack/auth/components.
Configuration serveur
AuthClientConfig résout l'URL depuis une option explicite, puis KRAKSTACK_AUTH_URL et enfin VITE_KRAKSTACK_AUTH_URL. Le code serveur devrait préférer KRAKSTACK_AUTH_URL. L'identifiant de confiance provient d'une valeur masquée explicite ou de KRAKSTACK_AUTH_SERVICE_API_KEY.
import { AuthClientConfig, AuthService } from "@krak-stack/auth/server";
import { Effect } from "effect";
const currentSession = Effect.gen(function* () {
const auth = yield* AuthService;
return yield* auth.getSession();
}).pipe(Effect.provide(AuthClientConfig.layer()));Utilisez le middleware API pour transférer la session de la requête plutôt que de construire manuellement les en-têtes.
État de la distribution des composants
Le paquet React utilise les dépendances homologues déclarées et les primitives UI Krakstack/shadcn de @krak-stack/registry. Suivez Composants React et CSS. Les sous-chemins serveur possèdent une frontière plus petite et explicite.
La référence des opérations HTTP est disponible dans la référence API.