mirror of
https://github.com/stack-auth/stack.git
synced 2026-06-13 21:01:21 +08:00
2f4f5ba9da
Reworded Stack Auth -> Hexclave in restricted-users.mdx; renamed stack-app.mdx (guides + sdk/objects) and use-stack-app.mdx -> hexclave-app / use-hexclave-app; updated docs.json slugs + cross-links and added redirects from old slugs. Kept migration.mdx + 'formerly known as Stack Auth' historical notes. docs build validation + typecheck + lint green.
70 lines
2.8 KiB
Plaintext
70 lines
2.8 KiB
Plaintext
---
|
|
title: "SDK Overview"
|
|
description: "The SDK reference for Hexclave's Next.js SDK."
|
|
sidebarTitle: "Overview"
|
|
---
|
|
|
|
This is the SDK reference for Hexclave's Next.js SDK.
|
|
|
|
<Info>
|
|
For setup instructions and how to use the SDK, see [Setup & Installation](/guides/getting-started/setup). If you are using a framework or programming language other than Next.js, you can use [our REST API](/api/overview).
|
|
</Info>
|
|
|
|
## General
|
|
|
|
| Type | Description |
|
|
|------|-------------|
|
|
| [HexclaveClientApp](/sdk/objects/hexclave-app#stackclientapp) | Client-level permissions for frontend code |
|
|
| [HexclaveServerApp](/sdk/objects/hexclave-app#stackserverapp) | Server-level permissions with full access |
|
|
| [Project](/sdk/types/project#project) | Project configuration and settings |
|
|
|
|
## Users & User Data
|
|
|
|
| Type | Description |
|
|
|------|-------------|
|
|
| [CurrentUser](/sdk/types/user#currentuser) | Client-side authenticated user |
|
|
| [ServerUser](/sdk/types/user#serveruser) | Server-side user with full access |
|
|
| [CurrentServerUser](/sdk/types/user#currentserveruser) | Current user with server permissions |
|
|
| [ContactChannel](/sdk/types/contact-channel#contactchannel) | User contact information (email, phone) |
|
|
| [ServerContactChannel](/sdk/types/contact-channel#servercontactchannel) | Server-side contact channel with extended control |
|
|
|
|
## Teams
|
|
|
|
| Type | Description |
|
|
|------|-------------|
|
|
| [Team](/sdk/types/team#team) | Team management and configuration |
|
|
| [ServerTeam](/sdk/types/team#serverteam) | Server-side team with full access |
|
|
| [TeamPermission](/sdk/types/team-permission#teampermission) | Team-level permissions |
|
|
| [ServerTeamPermission](/sdk/types/team-permission#serverteampermission) | Server-side team permissions |
|
|
| [TeamUser](/sdk/types/team-user#teamuser) | Team membership representation |
|
|
| [ServerTeamUser](/sdk/types/team-user#serverteamuser) | Server-side team user |
|
|
| [TeamProfile](/sdk/types/team-profile#teamprofile) | Team-specific user profiles |
|
|
| [ServerTeamProfile](/sdk/types/team-profile#serverteamprofile) | Server-side team profiles |
|
|
|
|
## Email
|
|
|
|
| Type | Description |
|
|
|------|-------------|
|
|
| [SendEmailOptions](/sdk/types/email#sendemailoptions) | Email sending configuration |
|
|
|
|
## Payments & Items
|
|
|
|
| Type | Description |
|
|
|------|-------------|
|
|
| [Customer](/sdk/types/customer#customer) | Customer billing interface |
|
|
| [Item](/sdk/types/item#item) | Client-side resource management |
|
|
| [ServerItem](/sdk/types/item#serveritem) | Server-side resource management with quantity operations |
|
|
|
|
## Hooks
|
|
|
|
| Hook | Description |
|
|
|------|-------------|
|
|
| [useHexclaveApp](/sdk/hooks/use-hexclave-app) | React hook to access the HexclaveClientApp instance |
|
|
| [useUser](/sdk/hooks/use-user) | React hook to access the current user |
|
|
|
|
## API Keys
|
|
|
|
| Type | Description |
|
|
|------|-------------|
|
|
| [ApiKey](/sdk/types/api-key) | API key management for programmatic access |
|