mirror of
https://github.com/stack-auth/stack.git
synced 2026-06-16 21:08:38 +08:00
13fccd32b6
Some checks failed
all-good: Did all the other checks pass? / all-good (push) Has been cancelled
Ensure Prisma migrations are in sync with the schema / check_prisma_migrations (22.x) (push) Has been cancelled
DB migration compat / Check if migrations changed (push) Has been cancelled
Docker Server Build and Push / Docker Build and Push Server (push) Has been cancelled
Docker Server Build and Run / docker (push) Has been cancelled
Runs E2E API Tests (Local Emulator) / E2E Tests (Local Emulator, Node ${{ matrix.node-version }}) (22.x) (push) Has been cancelled
Runs E2E API Tests / E2E Tests (Node ${{ matrix.node-version }}, Freestyle ${{ matrix.freestyle-mode }}) (mock, 22.x) (push) Has been cancelled
Runs E2E API Tests / E2E Tests (Node ${{ matrix.node-version }}, Freestyle ${{ matrix.freestyle-mode }}) (prod, 22.x) (push) Has been cancelled
Runs E2E API Tests with custom port prefix / build (22.x) (push) Has been cancelled
Lint & build / lint_and_build (latest) (push) Has been cancelled
Dev Environment Test With Custom Base Port / restart-dev-and-test-with-custom-base-port (push) Has been cancelled
Dev Environment Test / restart-dev-and-test (push) Has been cancelled
Run setup tests with custom base port / setup-tests-with-custom-base-port (push) Has been cancelled
Run setup tests / setup-tests (push) Has been cancelled
TOC Generator / TOC Generator (push) Has been cancelled
DB migration compat / Back-compat — Current branch migrations with ${{ needs.check-migrations-changed.outputs.base_branch }} branch code (push) Has been cancelled
DB migration compat / Forward-compat — Current branch code with ${{ needs.check-migrations-changed.outputs.base_branch }} branch migrations (push) Has been cancelled
DB migration compat / No migration changes (skipped) (push) Has been cancelled
70 lines
3.0 KiB
Plaintext
70 lines
3.0 KiB
Plaintext
---
|
|
title: "SDK Overview"
|
|
description: "The SDK reference for Stack Auth's Next.js SDK."
|
|
sidebarTitle: "Overview"
|
|
---
|
|
|
|
This is the SDK reference for Stack Auth's Next.js SDK.
|
|
|
|
<Info>
|
|
For a list of components, see the [Components](/docs/components/overview) page. For instructions on how to get started and how to use the SDK, see the [Setup & Installation](/docs/getting-started/setup) page. If you are using a framework or programming language other than Next.js, you can use [our REST API](/docs/rest-api/overview).
|
|
</Info>
|
|
|
|
## General
|
|
|
|
| Type | Description |
|
|
|------|-------------|
|
|
| [StackClientApp](/docs/sdk/objects/stack-app#stackclientapp) | Client-level permissions for frontend code |
|
|
| [StackServerApp](/docs/sdk/objects/stack-app#stackserverapp) | Server-level permissions with full access |
|
|
| [Project](/docs/sdk/types/project#project) | Project configuration and settings |
|
|
|
|
## Users & User Data
|
|
|
|
| Type | Description |
|
|
|------|-------------|
|
|
| [CurrentUser](/docs/sdk/types/user#currentuser) | Client-side authenticated user |
|
|
| [ServerUser](/docs/sdk/types/user#serveruser) | Server-side user with full access |
|
|
| [CurrentServerUser](/docs/sdk/types/user#currentserveruser) | Current user with server permissions |
|
|
| [ContactChannel](/docs/sdk/types/contact-channel#contactchannel) | User contact information (email, phone) |
|
|
| [ServerContactChannel](/docs/sdk/types/contact-channel#servercontactchannel) | Server-side contact channel with extended control |
|
|
|
|
## Teams
|
|
|
|
| Type | Description |
|
|
|------|-------------|
|
|
| [Team](/docs/sdk/types/team#team) | Team management and configuration |
|
|
| [ServerTeam](/docs/sdk/types/team#serverteam) | Server-side team with full access |
|
|
| [TeamPermission](/docs/sdk/types/team-permission#teampermission) | Team-level permissions |
|
|
| [ServerTeamPermission](/docs/sdk/types/team-permission#serverteampermission) | Server-side team permissions |
|
|
| [TeamUser](/docs/sdk/types/team-user#teamuser) | Team membership representation |
|
|
| [ServerTeamUser](/docs/sdk/types/team-user#serverteamuser) | Server-side team user |
|
|
| [TeamProfile](/docs/sdk/types/team-profile#teamprofile) | Team-specific user profiles |
|
|
| [ServerTeamProfile](/docs/sdk/types/team-profile#serverteamprofile) | Server-side team profiles |
|
|
|
|
## Email
|
|
|
|
| Type | Description |
|
|
|------|-------------|
|
|
| [SendEmailOptions](/docs/sdk/types/email#sendemailoptions) | Email sending configuration |
|
|
|
|
## Payments & Items
|
|
|
|
| Type | Description |
|
|
|------|-------------|
|
|
| [Customer](/docs/sdk/types/customer#customer) | Customer billing interface |
|
|
| [Item](/docs/sdk/types/item#item) | Client-side resource management |
|
|
| [ServerItem](/docs/sdk/types/item#serveritem) | Server-side resource management with quantity operations |
|
|
|
|
## Hooks
|
|
|
|
| Hook | Description |
|
|
|------|-------------|
|
|
| [useStackApp](/docs/sdk/hooks/use-stack-app) | React hook to access the StackClientApp instance |
|
|
| [useUser](/docs/sdk/hooks/use-user) | React hook to access the current user |
|
|
|
|
## API Keys
|
|
|
|
| Type | Description |
|
|
|------|-------------|
|
|
| [ApiKey](/docs/sdk/types/api-key) | API key management for programmatic access |
|