Skip to content

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

FieldValue
Import path@system-core/core/auth-client
Package export./auth-client
Source entrycore/auth-client/index.ts
Exported symbols10
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

ExportKindSource
getDefaultRoleLevelfunctioncore/auth/meta.ts

Consts

ExportKindSource
DEFAULT_AUTH_UX_METAconstcore/auth/meta.ts
DEFAULT_LOGIN_METHOD_METAconstcore/auth/meta.ts
DEFAULT_PERMISSION_METAconstcore/auth/meta.ts
DEFAULT_ROLE_DEFINITIONSconstcore/auth/meta.ts
DEFAULT_ROLE_HIERARCHYconstcore/auth/meta.ts

Interfaces

ExportKindSource
LoginMethodMetainterfacecore/auth/meta.ts
PermissionMetainterfacecore/auth/meta.ts
RoleMetainterfacecore/auth/meta.ts

Type

ExportKindSource
LoginMethodtypecore/auth/meta.ts

system-core documentation for maintainers, integrators, and AI build agents.