/** * Admin help operation — business logic for progressive-disclosure help. * * Generates tier-filtered operation listings, cost hints, quick-start * guidance, and domain-grouped operation summaries for the admin.help query. * * @task T5708 */ /** Minimal operation definition consumed by help logic. */ export interface HelpOperationDef { gateway: 'query' | 'mutate'; domain: string; operation: string; description: string; tier: number; } /** Cost hint classification for an operation. */ export type CostHint = 'minimal' | 'moderate' | 'heavy'; /** Domain-grouped operation format (compact). */ export interface GroupedOperations { [domain: string]: { query: string[]; mutate: string[]; }; } /** Verbose operation entry with cost hints. */ export interface VerboseOperation { gateway: string; domain: string; operation: string; description: string; costHint: CostHint; } /** Result of the help computation. */ export interface HelpResult { tier: number; operationCount: number; quickStart: string[] | undefined; operations: GroupedOperations | VerboseOperation[]; guidance: string; escalation: string; } /** * Determine cost hint for an operation based on domain and operation name. */ export declare function getCostHint(domain: string, operation: string): CostHint; /** * Group operations by domain into a compact format. * * @param ops - Operations filtered to the requested tier * @returns Domain-grouped operations with query and mutate arrays */ export declare function groupOperationsByDomain(ops: HelpOperationDef[]): GroupedOperations; /** * Build verbose operation entries with cost hints. * * @param ops - Operations filtered to the requested tier * @returns Array of verbose operation objects */ export declare function buildVerboseOperations(ops: HelpOperationDef[]): VerboseOperation[]; /** * Compute the help result for the admin.help operation. * * Accepts the full OPERATIONS registry and filters/formats based on tier * and verbosity. This is pure business logic with no dispatch or engine * dependencies. * * @param allOperations - The full operation registry * @param tier - The tier level to filter to (0, 1, or 2) * @param verbose - Whether to return full operation objects or compact grouped format * @returns The computed help result */ export declare function computeHelp(allOperations: HelpOperationDef[], tier: number, verbose: boolean): HelpResult; /** Help topic content and related commands (system-level static help). */ export interface HelpData { /** Topic identifier. */ topic?: string; /** Human-readable help content. */ content: string; /** Related CLI commands for cross-reference. */ relatedCommands?: string[]; } /** Static help topic dictionary for the system domain. */ export declare const SYSTEM_HELP_TOPICS: Record; /** * Get static system help content for a given topic or general overview. * * Replaces `systemHelp` from system-engine.ts, moving the static HELP_TOPICS * dictionary and lookup logic into core/admin/help.ts. * * @param topic - Optional topic name to look up; returns overview if omitted * @returns Help content for the requested topic or general overview * * @task T1571 */ export declare function getSystemHelp(topic?: string): HelpData; //# sourceMappingURL=help.d.ts.map