/** * Options for formatting an error with structured remediation guidance. */ export type ErrorRemediationOptions = { /** What happened - the error description. */ readonly what: string; /** Why it happened - root cause or context. */ readonly why?: string; /** How to fix - actionable remediation steps. Can be a single string or an array of numbered steps. */ readonly fix?: string | readonly string[]; /** Error code for reference. */ readonly errorCode?: string; /** Documentation link. */ readonly docsUrl?: string; }; /** * Formats an error with structured remediation guidance. * * Returns a multi-line string with what/why/fix sections following the * what/why/fix pattern for CLI error display. Only sections with defined * values are included; undefined fields are omitted entirely. * * @param options - The error remediation options * @returns A formatted multi-line string with remediation guidance * * @example * formatErrorWithRemediation({ what: 'Connection failed' }) * // "Error: Connection failed" * * @example * formatErrorWithRemediation({ what: 'Could not connect.', why: 'Token expired.', fix: ['Run sf org login web'] }) */ export declare function formatErrorWithRemediation(options: ErrorRemediationOptions): string;