@kitiumai/utils-ts
Version:
Comprehensive TypeScript utilities for KitiumAI projects
64 lines • 2.18 kB
TypeScript
/**
* Integration with @kitiumai/error package
* Provides utilities to convert UtilsError to KitiumError format
*/
import { isUtilsError, type UtilsError, type UtilsErrorInit } from '../runtime/error.js';
type KitiumErrorShape = {
readonly code: string;
readonly message: string;
readonly statusCode?: number;
readonly severity: 'fatal' | 'error' | 'warning' | 'info' | 'debug';
readonly kind: 'business' | 'validation' | 'auth' | 'rate_limit' | 'not_found' | 'conflict' | 'dependency' | 'internal';
readonly retryable: boolean;
readonly retryDelay?: number;
readonly maxRetries?: number;
readonly backoff?: 'linear' | 'exponential' | 'fixed';
readonly help?: string;
readonly docs?: string;
readonly source?: string;
readonly context?: Record<string, unknown>;
readonly cause?: unknown;
};
/**
* Check if @kitiumai/error package is available
*/
export declare function isKitiumErrorAvailable(): Promise<boolean>;
/**
* Convert UtilsError to KitiumError shape
*/
export declare function toKitiumErrorShape(error: UtilsError): KitiumErrorShape;
/**
* Create a KitiumError from UtilsError (requires @kitiumai/error as peer dependency)
*/
export declare function toKitiumError(error: UtilsError): Promise<Error>;
/**
* Create a utility error with optional KitiumError conversion
*/
export declare function createUtilsErrorWithKitium(init: UtilsErrorInit, convertToKitium?: boolean): Promise<Error>;
/**
* Enrich a UtilsError with KitiumError context (if available)
*/
export declare function enrichUtilsError(error: UtilsError, context: Record<string, unknown>): Promise<Error>;
/**
* Error mapper utilities
*/
export declare const errorMapper: {
/**
* Check if error is a UtilsError
*/
isUtilsError: typeof isUtilsError;
/**
* Convert to KitiumError shape
*/
toKitiumErrorShape: typeof toKitiumErrorShape;
/**
* Convert to KitiumError instance
*/
toKitiumError: typeof toKitiumError;
/**
* Check if KitiumError package is available
*/
isKitiumErrorAvailable: typeof isKitiumErrorAvailable;
};
export {};
//# sourceMappingURL=error.d.ts.map