Saltar al contenido

@xid-kit/solid

Provider de contexto SolidJS, primitivas de autenticación basadas en signals y componentes headless sobre @xid-kit/core.

Ver como Markdown

Estado

El estado del paquete es Paquete actual. El provider de contexto SolidJS, las primitivas basadas en signals y los componentes headless están implementados. Una prueba de ida y vuelta real contra un IdP en infraestructura de producción está pendiente de verificación manual.

Configuración del proveedor

Envuelve tu app con XidProvider. Crea un XidClient, llama a client.load() al montar para obtener la sesión actual y limpia recursos vía onCleanup.

import { XidProvider } from '@xid-kit/solid'

export function App() {
  return (
    <XidProvider publishableKey="pk_live_...">
      <Routes />
    </XidProvider>
  )
}

Primitivas de autenticación

Cada primitiva devuelve un Accessor<T> reactivo (funciones getter). Llámalo en JSX o en createEffect para rastrear cambios.

import { createAuth, createUser, createOrganization, createSession } from '@xid-kit/solid'
import { Show } from 'solid-js'

function Profile() {
  const auth = createAuth()
  // auth.isLoaded()  -- Accessor<boolean>
  // auth.isSignedIn() -- Accessor<boolean>
  // auth.userId()    -- Accessor<string | null>
  // auth.getToken()  -- () => Promise<Result<string, XidError>>
  // auth.signOut()   -- (options?) => Promise<Result<null, XidError>>

  return (
    <Show when={auth.isLoaded()} fallback={<p>Loading...</p>}>
      <Show when={auth.isSignedIn()} fallback={<p>Not signed in</p>}>
        <p>Signed in as {auth.userId()}</p>
        <button onClick={() => void auth.signOut()}>Sign out</button>
      </Show>
    </Show>
  )
}

createOrganization y createSession

const org = createOrganization()
// org() is CreateOrganizationReturn
if (org().isSignedIn) {
  console.log(org().organization?.name, org().membership?.role)
  await org().setActive('org_new_id')
}

const session = createSession()
if (session().isSignedIn) {
  const { value: token } = await session().getToken()
  // use token for backend requests
}

Componentes headless

import { SignInButton, SignOutButton, Protect } from '@xid-kit/solid'

// Navigates to /sign-in by default
<SignInButton signInUrl="/auth/sign-in" redirectUrl="/dashboard">
  Log in
</SignInButton>

// Signs out all sessions; pass sessionId to target one
<SignOutButton redirectUrl="/home">Log out</SignOutButton>

// Role and permission gate
<Protect role="org:admin" fallback={<p>Admins only</p>}>
  <Settings />
</Protect>

<Protect permission="org:member:write" fallback={null}>
  <InviteForm />
</Protect>

API exportada

Exportar Tipo Propósito
XidProvider componente Crea XidClient, llama a load() al montar y limpia recursos vía onCleanup
createAuth primitiva isLoaded, isSignedIn, userId, sessionId, session, getToken, signOut como Accessors
createUser primitiva Accessor que envuelve una unión discriminada sobre isLoaded / isSignedIn / user
createOrganization primitiva Accessor que devuelve la organización, membresía y setActive para la org activa
createSession primitiva Accessor que devuelve la sesión y getToken para la sesión activa
SignInButton componente Botón headless que navega a la URL de inicio de sesión al hacer clic
SignOutButton componente Botón headless que llama a signOut al hacer clic
Protect componente Barrera de rol y permiso con prop de reserva

Almacenamiento de tokens

  • Los tokens de sesión son cookies HttpOnly establecidas por el Worker XID. El SDK nunca almacena tokens en localStorage.
  • getToken() devuelve un JWT de corta duración (60 s) almacenado en caché por TokenManager en @xid-kit/core.
Navegación

Escribe para buscar...

Usa las flechas para navegarPulsa Intro para seleccionarPulsa Escape para cerrar