/**
 * Clarification-related type definitions for spec-kit
 *
 * These types represent the clarification workflow, where questions
 * are generated during specification review and answers are collected
 * from stakeholders.
 */
/**
 * Status of a clarification question.
 *
 * Used to explicitly track whether a question has been answered.
 *
 * @example
 * ```typescript
 * const status = ClarificationStatus.PENDING;
 * if (status === ClarificationStatus.ANSWERED) {
 *   console.log('Question has been answered');
 * }
 * ```
 */
export declare enum ClarificationStatus {
    /** Question awaiting answer */
    PENDING = "pending",
    /** Question has been answered */
    ANSWERED = "answered"
}
/**
 * Option for a clarification question.
 *
 * Represents a labeled choice (A, B, C, etc.) for multiple-choice questions.
 *
 * @example
 * ```typescript
 * const option: ClarificationOption = {
 *   label: 'A',
 *   description: 'Use OAuth 2.0 with JWT tokens',
 * };
 * ```
 */
export interface ClarificationOption {
    /** Option label (A, B, C) */
    label: string;
    /** Description */
    description: string;
}
/**
 * A clarification question with answer status.
 *
 * Represents a question that needs to be answered to clarify
 * requirements or implementation decisions.
 *
 * @example
 * ```typescript
 * const question: ClarificationQuestion = {
 *   number: 1,
 *   topic: 'Authentication',
 *   context: 'Need to decide on authentication method for API',
 *   question: 'Which authentication method should we use?',
 *   options: [
 *     { label: 'A', description: 'OAuth 2.0' },
 *     { label: 'B', description: 'API Keys' },
 *   ],
 *   answer: null, // Pending
 * };
 * ```
 */
export interface ClarificationQuestion {
    /** Sequential question number */
    number: number;
    /** Short topic identifier */
    topic: string;
    /** Why this question matters */
    context: string;
    /** The specific question */
    question: string;
    /** Optional A/B/C options */
    options?: ClarificationOption[];
    /** Answer or null if pending */
    answer: string | null;
    /** Explicit status of the question */
    status: ClarificationStatus;
}
/**
 * A batch of clarification questions added together.
 *
 * Questions are grouped into batches when they are generated
 * at the same time during specification review.
 *
 * @example
 * ```typescript
 * const batch: ClarificationBatch = {
 *   number: 1,
 *   timestamp: '2024-01-15T10:30:00Z',
 *   questions: [question1, question2],
 * };
 * ```
 */
export interface ClarificationBatch {
    /** Batch number */
    number: number;
    /** ISO timestamp when batch was created */
    timestamp: string;
    /** Questions in batch */
    questions: ClarificationQuestion[];
}
/**
 * Complete model for a clarifications file.
 *
 * Represents the full content of a clarifications.md file,
 * including all batches and their questions.
 *
 * @example
 * ```typescript
 * const file: ClarificationsFile = {
 *   featureName: '042-user-auth',
 *   batches: [batch1, batch2],
 *   totalQuestions: 5,
 *   answeredQuestions: 3,
 *   pendingQuestions: 2,
 * };
 * ```
 */
export interface ClarificationsFile {
    /** Feature name this file belongs to */
    featureName: string;
    /** All question batches */
    batches: ClarificationBatch[];
    /** Total number of questions across all batches */
    totalQuestions: number;
    /** Number of questions with answers */
    answeredQuestions: number;
    /** Number of questions without answers */
    pendingQuestions: number;
}
/**
 * Result of appending new clarification questions.
 *
 * Returned after adding new questions to a clarifications file.
 *
 * @example
 * ```typescript
 * const result: ClarificationAppendResult = {
 *   success: true,
 *   batchNumber: 2,
 *   questionsAdded: 3,
 *   firstQuestionNumber: 4,
 * };
 * ```
 */
export interface ClarificationAppendResult {
    /** Whether the append succeeded */
    success: boolean;
    /** Batch number assigned to the new questions */
    batchNumber: number;
    /** Number of questions added */
    questionsAdded: number;
    /** First question number in the new batch */
    firstQuestionNumber: number;
    /** Error message if success is false */
    error?: string;
}
/**
 * Input for creating a new clarification question.
 *
 * Used when adding new questions to a clarifications file.
 *
 * @example
 * ```typescript
 * const input: ClarificationQuestionInput = {
 *   topic: 'Database',
 *   context: 'Need to decide on database for user data',
 *   question: 'Should we use PostgreSQL or MongoDB?',
 *   options: [
 *     { label: 'A', description: 'PostgreSQL' },
 *     { label: 'B', description: 'MongoDB' },
 *   ],
 * };
 * ```
 */
export interface ClarificationQuestionInput {
    /** Short topic identifier */
    topic: string;
    /** Why this question matters */
    context: string;
    /** The specific question */
    question: string;
    /** Optional A/B/C options */
    options?: ClarificationOption[];
}
/**
 * Status of a Humancy request for a question.
 *
 * Tracks whether the Humancy request was successfully sent.
 *
 * @example
 * ```typescript
 * const status: HumancyRequestStatus = {
 *   question_number: 1,
 *   sent: true,
 *   type: 'ask_question',
 * };
 * ```
 */
export interface HumancyRequestStatus {
    /** Question number */
    question_number: number;
    /** Whether Humancy request was sent */
    sent: boolean;
    /** Humancy request type used */
    type: 'ask_question' | 'request_decision';
    /** Error message if sent is false */
    error?: string;
}
/**
 * Output for the read operation.
 *
 * Returns the parsed clarifications file with batch and question details.
 *
 * @example
 * ```typescript
 * const result: ReadClarificationsOutput = {
 *   success: true,
 *   exists: true,
 *   batches: [...],
 *   pending_count: 2,
 *   total_count: 5,
 * };
 * ```
 */
export interface ReadClarificationsOutput {
    /** Whether the operation succeeded */
    success: boolean;
    /** Whether clarifications.md exists */
    exists: boolean;
    /** All question batches */
    batches: ClarificationBatch[];
    /** Number of pending questions */
    pending_count: number;
    /** Total number of questions */
    total_count: number;
    /** Error message if success is false */
    error?: string;
    /** Answers discovered from GitHub issue comments */
    github_answers?: ParsedAnswer[];
    /** IDs of GitHub comments containing clarification batches */
    github_comment_ids?: string[];
}
/**
 * Output for the append operation.
 *
 * Returns information about the newly created batch.
 *
 * @example
 * ```typescript
 * const result: AppendClarificationsOutput = {
 *   success: true,
 *   batch_number: 2,
 *   questions_added: 3,
 *   first_question_number: 4,
 * };
 * ```
 */
export interface AppendClarificationsOutput {
    /** Whether the operation succeeded */
    success: boolean;
    /** Batch number assigned */
    batch_number: number;
    /** Number of questions added */
    questions_added: number;
    /** First question number in batch */
    first_question_number: number;
    /** Humancy request status per question */
    humancy_requests?: HumancyRequestStatus[];
    /** Error message if success is false */
    error?: string;
    /** Result of posting the clarification comment to GitHub */
    github_comment?: GitHubCommentResult;
}
/**
 * Output for the update_answer operation.
 *
 * Returns information about the updated question.
 *
 * @example
 * ```typescript
 * const result: UpdateAnswerOutput = {
 *   success: true,
 *   question_number: 1,
 *   previous_answer: null,
 *   status: ClarificationStatus.ANSWERED,
 * };
 * ```
 */
export interface UpdateAnswerOutput {
    /** Whether the operation succeeded */
    success: boolean;
    /** Question number updated */
    question_number: number;
    /** Previous answer (null if was pending) */
    previous_answer: string | null;
    /** New status */
    status: ClarificationStatus;
    /** Error message if success is false */
    error?: string;
}
/**
 * Result of posting a clarification comment to GitHub.
 */
export interface GitHubCommentResult {
    /** GitHub comment ID */
    comment_id: string;
    /** Issue number the comment was posted to */
    issue_number: number;
    /** Batch number of the clarification */
    batch_number: number;
    /** HTML marker string (e.g., 'generacy-clarification:batch-1') */
    marker: string;
}
/**
 * A parsed answer from a GitHub issue comment.
 */
export interface ParsedAnswer {
    /** Question number this answer corresponds to */
    question_number: number;
    /** The answer text */
    answer: string;
    /** Where the answer was found */
    source: 'file' | 'github';
    /** GitHub comment ID where answer was found (if source is 'github') */
    comment_id?: string;
}
//# sourceMappingURL=clarification.d.ts.map