---
title: "@xid-kit/remix"
description: "Remix loader and action server helpers, cookie session storage, and OAuth callback handler with React SDK re-exports."
locale: "en"
---

> Documentation Index
> Fetch the locale documentation index at: https://xid.dev/en/llms.txt
> Use this file to discover all available pages before exploring further.

# @xid-kit/remix

## Status

Package status is **Current package**. Remix loader/action auth helpers, cookie session integration, and OAuth callback handler are implemented. A real IdP round-trip on production infrastructure is still pending manual verification.

## Session storage setup

```ts
// app/sessions.server.ts
import { createXidSessionStorage } from '@xid-kit/remix'

export const sessionStorage = createXidSessionStorage({
  secret: process.env.SESSION_SECRET!, // required: cookie signing secret
  // cookieName: '__xid_session', maxAge: 2592000, secure: true
})
```

## Reading auth in loaders

`getAuth` extracts a bearer token or session cookie, verifies it networklessly, and returns an `AuthResult`. `requireAuth` automatically throws a 302 redirect to `redirectPath` when unauthenticated.

```ts
import { getAuth, requireAuth } from '@xid-kit/remix'
import { json, redirect } from '@remix-run/node'
import type { LoaderFunctionArgs } from '@remix-run/node'
import { sessionStorage } from '~/sessions.server'

// Optional check
export async function loader({ request }: LoaderFunctionArgs) {
  const auth = await getAuth(request, {
jwtKey: process.env.XID_JWT_KEY!,
sessionStorage,
  })
  if (!auth.userId) return redirect('/login')
  return json({ userId: auth.userId, orgId: auth.orgId })
}

// Guard: throws redirect automatically when unauthenticated
export async function protectedLoader({ request }: LoaderFunctionArgs) {
  const auth = await requireAuth(
request,
{ jwtKey: process.env.XID_JWT_KEY!, sessionStorage },
{ redirectPath: '/login' },
  )
  return json({ userId: auth.userId })
}
```

## OAuth callback handler

`handleCallback` validates the `state` parameter to prevent CSRF, exchanges the authorization code, and returns a `Response` with `Set-Cookie`.

```ts
// app/routes/auth.callback.ts
import { handleCallback } from '@xid-kit/remix'
import type { ActionFunctionArgs } from '@remix-run/node'
import { sessionStorage } from '~/sessions.server'

export async function action({ request }: ActionFunctionArgs) {
  const result = await handleCallback(request, {
clientId: process.env.XID_CLIENT_ID!,
redirectUri: process.env.XID_REDIRECT_URI!,
sessionStorage,
defaultReturnTo: '/dashboard',
  })

  if (!result.ok) throw new Response(result.error, { status: 400 })
  return result.response // 302 redirect + Set-Cookie
}
```

## Client provider (root.tsx)

```tsx
import { XidProvider } from '@xid-kit/remix' // re-export from @xid-kit/react
import { useLoaderData, Outlet } from '@remix-run/react'

export default function App() {
  const { auth } = useLoaderData<typeof loader>()
  return (
<XidProvider
  publishableKey={window.ENV.XID_PUBLISHABLE_KEY}
  initialState={auth.userId ? { userId: auth.userId } : undefined}
>
  <Outlet />
</XidProvider>
  )
}
```

## Management API client

```ts
import { xidClient } from '@xid-kit/remix'

const client = xidClient({ secretKey: process.env.XID_SECRET_KEY! })

export async function loader() {
  const result = await client.getUser('user_abc')
  if (!result.ok) throw new Response(result.error.message, { status: result.error.status })
  return json(result.value)
}
```

## Exported API

| Export | Kind | Purpose |
| --- | --- | --- |
| `createXidSessionStorage` | function | Remix cookie session storage for XID tokens |
| `getAuth` | function | Verify JWT or session token; returns AuthResult |
| `requireAuth` | function | Like getAuth but throws a redirect response when unauthenticated |
| `handleCallback` | function | OAuth callback: validates state, exchanges code, sets session cookie |
| `xidClient` | function | Returns a server-side Management API client bound to the secret key |
| `getTokenFromSession, setTokensInSession, clearTokensFromSession` | functions | Low-level token helpers for custom session handling |

## Re-exports

Re-exports all [@xid-kit/react](/sdks/react) client components and hooks. `root.tsx` needs only one import for both provider and client components.

## PKCE and security

- Public clients use Authorization Code with PKCE S256. No client secret is stored.
- `handleCallback` validates the `state` parameter against the session to prevent CSRF.
- Access tokens are stored in `HttpOnly` session cookies; they are never written to `localStorage`.

Source: https://xid.dev/sdks/remix/index.mdx