auth-client
Generated Reference
Browser-safe auth UX metadata, permission descriptors, and admin-facing auth configuration helpers. This page is generated from core/auth-client/index.ts against package version 0.8.3 on the 0.8 docs line.
Import
ts
import { DEFAULT_ROLE_DEFINITIONS, DEFAULT_PERMISSION_META } from '@system-core/core/auth-client'Entry
| Field | Value |
|---|---|
| Import path | @system-core/core/auth-client |
| Package export | ./auth-client |
| Source entry | core/auth-client/index.ts |
| Exported symbols | 10 |
| Runtime file | ./dist/auth-client.js |
| Types file | ./dist/auth-client.d.ts |
Use This Surface When
- Use this for admin and account UIs that need auth-facing metadata without server runtime code.
- Keep permissions and UX descriptors on client-safe exports.
- Pair it with the root auth runtime rather than duplicating auth configuration schemas.
Public Surface
Function
| Export | Kind | Source |
|---|---|---|
getDefaultRoleLevel | function | core/auth/meta.ts |
Consts
| Export | Kind | Source |
|---|---|---|
DEFAULT_AUTH_UX_META | const | core/auth/meta.ts |
DEFAULT_LOGIN_METHOD_META | const | core/auth/meta.ts |
DEFAULT_PERMISSION_META | const | core/auth/meta.ts |
DEFAULT_ROLE_DEFINITIONS | const | core/auth/meta.ts |
DEFAULT_ROLE_HIERARCHY | const | core/auth/meta.ts |
Interfaces
| Export | Kind | Source |
|---|---|---|
LoginMethodMeta | interface | core/auth/meta.ts |
PermissionMeta | interface | core/auth/meta.ts |
RoleMeta | interface | core/auth/meta.ts |
Type
| Export | Kind | Source |
|---|---|---|
LoginMethod | type | core/auth/meta.ts |