Skip to content

SDK overview

Axowl ships two SDK families. Most web apps use the JS/TS one; .NET services use the .NET clients.

PackagePurpose
@axowl/sdkReact hooks & components — AxowlProvider, useAxowl, usePermission, useSession, useOrg
@axowl/sdk-backendExpress & Next.js middleware — axowlMiddleware, requirePermission, getAuth, canAccess
@axowl/sdk-coreShared core (used internally)
@axowl/sdk-wasmWASM integrity-verification core (packages/sdk-wasm)
import { AxowlProvider, useAxowl, usePermission } from '@axowl/sdk';
<AxowlProvider orgSlug="my-org" appKey="ak_live_xxxxx"><App /></AxowlProvider>
const { user, isSignedIn, signIn } = useAxowl();
const { can } = usePermission(); // can('dashboard.view')

Features (per axowl-sdk/README.md): magic-link, social (Google/Line), passkey (FIDO2), federated (OIDC); JWT auto-refresh; wildcard permission matching; React hooks; Express/Next middleware.

ProjectPurposePage
Axowl.Sdk.Identity.ClientIntrospection, permission checks, [RequirePermission]Identity
Axowl.Sdk.Integrity.ClientVerify sealed records (REST/gRPC/Fallback)Integrity
Axowl.Sdk.Eventing.ClientSubscribe / emit sealed eventsEventing
Axowl.Sdk.Korean.Identity.Client[RequireKoreanIdentity] gatingKorean Identity

Each client uses a 3-layer transport (REST + gRPC over h2c + fallback), confirmed by the Rest*Client / Grpc*Client / Fallback*Client files in each project.