TypeScript Types

Complete type definitions for next-api-layer.

Core Types#

AuthProxyConfig#

Main configuration for createAuthProxy.

ApiClientConfig#

Configuration for createApiClient.

Security Types#

CsrfConfig#

RateLimitConfig#

AuditConfig#

Access Control Types#

AccessConfig#

Response Types#

ApiResponse#

Standard API response wrapper.

AuthResult#

Result from authentication validation.

TokenInfo#

Token validation result.

Cookie Types#

CookieOptions#

Sanitization Types#

SanitizationConfig#

Response Mappers#

ResponseMappers#

Custom parsers for different backend formats.

Client-Side Types#

AuthState#

UseAuthReturn#

AuthProviderProps#

I18n Types#

I18nConfig#

Error Types#

v0.2.0 introduces a comprehensive error class hierarchy for better error handling.

ApiError (Base)#

Base class for all API errors.

HttpError#

HTTP response errors (4xx, 5xx).

TimeoutError#

Request timeout errors.

NetworkError#

Network connectivity errors.

AuthError#

Authentication-related errors.

ValidationError#

Validation errors with field-level details.

RateLimitError#

Rate limit exceeded errors.

Type Guards#

Usage Example#

Utility Types#

RequestOptions#

ResponseFormat#

MethodSpoofingConfig#

ErrorMessages#