@kitiumai/error/dist/types.d.ts

Enterprise-grade error primitives for Kitium products: rich metadata, HTTP/Problem Details mapping, observability, and registry-driven error governance.

type ErrorSeverity = 'fatal' | 'error' | 'warning' | 'info' | 'debug';
type ErrorKind = 'business' | 'validation' | 'auth' | 'rate_limit' | 'not_found' | 'conflict' | 'dependency' | 'internal' | (string & {});
type ErrorLifecycle = 'draft' | 'active' | 'deprecated';
type RetryBackoff = 'linear' | 'exponential' | 'fixed';
interface RetryInfo {
    readonly retryable: boolean;
    readonly retryDelay?: number;
    readonly maxRetries?: number;
    readonly backoff?: RetryBackoff;
}
interface ErrorContext {
    readonly correlationId?: string;
    readonly requestId?: string;
    readonly spanId?: string;
    readonly tenantId?: string;
    readonly userId?: string;
    readonly [key: string]: unknown;
}
interface ErrorShape {
    readonly code: string;
    readonly message: string;
    readonly statusCode?: number;
    readonly severity: ErrorSeverity;
    readonly kind: ErrorKind;
    readonly lifecycle?: ErrorLifecycle;
    readonly schemaVersion?: string;
    readonly retryable: boolean;
    readonly retryDelay?: number;
    readonly maxRetries?: number;
    readonly backoff?: RetryBackoff;
    readonly help?: string;
    readonly docs?: string;
    readonly source?: string;
    readonly userMessage?: string;
    readonly i18nKey?: string;
    readonly redact?: string[];
    readonly context?: ErrorContext;
    readonly cause?: unknown;
}
interface ProblemDetails {
    readonly type?: string;
    readonly title: string;
    readonly status?: number;
    readonly detail?: string;
    readonly instance?: string;
    readonly extensions?: Record<string, unknown>;
}
interface ErrorRegistryEntry extends ErrorShape {
    readonly fingerprint?: string;
    readonly toProblem?: (error: ErrorShape) => ProblemDetails;
}
interface ErrorRegistry {
    register(entry: ErrorRegistryEntry): void;
    resolve(code: string): ErrorRegistryEntry | undefined;
    toProblemDetails(error: ErrorShape): ProblemDetails;
}
interface ErrorMetrics {
    readonly totalErrors: number;
    readonly errorsByKind: Record<ErrorKind, number>;
    readonly errorsBySeverity: Record<ErrorSeverity, number>;
    readonly retryableErrors: number;
    readonly nonRetryableErrors: number;
}
interface RetryOutcome<T> {
    readonly attempts: number;
    readonly result?: T;
    readonly error?: unknown;
    readonly lastDelayMs?: number;
}
interface RetryOptions {
    readonly maxAttempts?: number;
    readonly baseDelayMs?: number;
    readonly backoff?: RetryBackoff;
    readonly onAttempt?: (attempt: number, error: ErrorShape) => void;
}
interface TraceSpanLike {
    setAttribute(key: string, value: unknown): void;
    recordException(exception: unknown): void;
    setStatus(status: {
        code: number;
        message?: string;
    }): void;
}

export { ErrorContext, ErrorKind, ErrorLifecycle, ErrorMetrics, ErrorRegistry, ErrorRegistryEntry, ErrorSeverity, ErrorShape, ProblemDetails, RetryBackoff, RetryInfo, RetryOptions, RetryOutcome, TraceSpanLike };