azirid-react 0.6.0 → 0.8.0

package/README.md

@@ -670,6 +670,89 @@ export default function PayphoneCallbackPage() {
 
 ---
 
+## Multi-tenant
+
+Every authenticated user always has an active `tenantId` and `tenantRole` in the JWT. On signup, if no `tenantId` is provided, a personal tenant is automatically created and the user becomes `OWNER`.
+
+### Tenant switching via `useAzirid()`
+
+```tsx
+import { useAzirid } from 'azirid-react'
+
+function TenantSwitcher({ tenantId }: { tenantId: string }) {
+  const { user, switchTenant } = useAzirid()
+
+  return (
+    <div>
+      <p>Active tenant: {user?.tenantId} ({user?.tenantRole})</p>
+      <button onClick={() => switchTenant(tenantId)}>Switch</button>
+    </div>
+  )
+}
+```
+
+`switchTenant(tenantId)` calls the refresh endpoint with the new `tenantId`, updates the access token in memory, and invalidates all queries — no re-login required.
+
+### `useTenants`
+
+List all tenants the authenticated user belongs to.
+
+```tsx
+import { useTenants } from 'azirid-react'
+
+function TenantList() {
+  const { data: tenants, isLoading } = useTenants()
+
+  if (isLoading) return <Spinner />
+
+  return (
+    <ul>
+      {tenants?.map((t) => (
+        <li key={t.tenantId}>
+          {t.name} — {t.role}
+        </li>
+      ))}
+    </ul>
+  )
+}
+```
+
+### `useTenantMembers`
+
+List all members of a specific tenant. The authenticated user must be a member.
+
+```tsx
+import { useTenantMembers } from 'azirid-react'
+
+function MemberList({ tenantId }: { tenantId: string }) {
+  const { data: members } = useTenantMembers(tenantId)
+
+  return (
+    <ul>
+      {members?.map((m) => (
+        <li key={m.id}>
+          {m.user.email} — {m.role}
+        </li>
+      ))}
+    </ul>
+  )
+}
+```
+
+### `useSwitchTenant`
+
+Headless hook for tenant switching (same as `switchTenant` from `useAzirid()`, but usable outside the main context hook).
+
+```tsx
+import { useSwitchTenant } from 'azirid-react'
+
+const { switchTenant } = useSwitchTenant()
+
+await switchTenant('tenant-id-here')
+```
+
+---
+
 ## Referrals
 
 All referral hooks require `<AziridProvider>` in the tree and an authenticated user.
@@ -1255,7 +1338,7 @@ import type {
 
 | Type | Description |
 | --- | --- |
-| `AuthUser` | Authenticated user object (`id`, `email`, `firstName`, `emailVerified`, `mfaEnabled`, `appId`, `tenantId`, ...) |
+| `AuthUser` | Authenticated user object (`id`, `email`, `tenantId`, `tenantRole`, `appId`, ...) — `tenantId` and `tenantRole` are always present |
 | `AuthSuccessResponse` | Login/signup response (`accessToken`, `user`) |
 | `AuthState` | Full auth state (`user`, `accessToken`, `isAuthenticated`, `isLoading`, `error`) |
 | `SignupData` | Signup payload (`email`, `password`, `acceptedTosVersion?`, `referralCode?`, ...) |
@@ -1264,6 +1347,14 @@ import type {
 | `AziridProviderProps` | All provider props (see table above) |
 | `AziridContextValue` | Context value returned by `useAzirid()` |
 
+### Tenant Types
+
+| Type | Description |
+| --- | --- |
+| `TenantWithRole` | Tenant membership (`tenantId`, `name`, `slug`, `role: 'OWNER' \| 'MEMBER'`, `joinedAt`) |
+| `TenantMemberInfo` | Tenant member (`id`, `role`, `joinedAt`, `user: { id, email, firstName, lastName }`) |
+| `CreateTenantData` | Create tenant payload (`name`, `description?`) |
+
 ### Billing Types
 
 | Type | Description |