@bbearai/core 0.2.0 → 0.2.2

package/dist/index.d.mts

@@ -161,6 +161,15 @@ interface BugBearTheme {
 }
 type TestTemplate = 'steps' | 'checklist' | 'rubric' | 'freeform';
 type RubricMode = 'pass_fail' | 'rating';
+/** Skip reason for skipped test assignments */
+type SkipReason = 'blocked' | 'not_ready' | 'dependency' | 'other';
+/** Test group (folder) for organizing test cases */
+interface TestGroup {
+    id: string;
+    name: string;
+    description?: string;
+    sortOrder: number;
+}
 interface QATrack {
     id: string;
     name: string;
@@ -184,8 +193,20 @@ interface TestAssignment {
         /** Route/screen to navigate to when starting this test */
         targetRoute?: string;
         track?: QATrack;
+        /** Test group (folder) this test belongs to */
+        group?: TestGroup;
     };
-    status: 'pending' | 'in_progress' | 'passed' | 'failed' | 'blocked';
+    status: 'pending' | 'in_progress' | 'passed' | 'failed' | 'blocked' | 'skipped';
+    /** Reason for skipping (when status is 'skipped') */
+    skipReason?: SkipReason;
+    /** When the assignment was started (set to in_progress) */
+    startedAt?: string;
+    /** Duration in seconds (calculated when completed) */
+    durationSeconds?: number;
+    /** Whether this is a verification assignment for a fixed bug */
+    isVerification?: boolean;
+    /** Original report ID if this is a verification assignment */
+    originalReportId?: string;
 }
 interface TestStep {
     stepNumber: number;
@@ -213,6 +234,37 @@ interface TestResult {
     /** Overall notes */
     notes?: string;
 }
+/**
+ * Feedback from testers about a test case
+ * Helps improve test quality over time
+ */
+interface TestFeedback {
+    /** Overall rating (1-5 stars) */
+    rating: 1 | 2 | 3 | 4 | 5;
+    /** Optional detailed ratings */
+    clarityRating?: 1 | 2 | 3 | 4 | 5;
+    stepsRating?: 1 | 2 | 3 | 4 | 5;
+    relevanceRating?: 1 | 2 | 3 | 4 | 5;
+    /** Free-form feedback note */
+    feedbackNote?: string;
+    /** Specific improvement suggestion */
+    suggestedImprovement?: string;
+    /** Quick feedback flags */
+    isOutdated?: boolean;
+    needsMoreDetail?: boolean;
+    stepsUnclear?: boolean;
+    expectedResultUnclear?: boolean;
+}
+/**
+ * Options for submitting test feedback
+ */
+interface SubmitFeedbackOptions {
+    testCaseId: string;
+    assignmentId?: string;
+    feedback: TestFeedback;
+    /** Time taken to complete in seconds */
+    timeToCompleteSeconds?: number;
+}
 interface TesterInfo {
     id: string;
     name: string;
@@ -442,6 +494,92 @@ interface CoverageMatrixRow {
     lastTestedAt: string | null;
     tracks: Record<string, CoverageMatrixCell>;
 }
+/** Session status */
+type QASessionStatus = 'active' | 'paused' | 'completed' | 'abandoned';
+/** Finding type - lighter than a bug report */
+type FindingType = 'bug' | 'concern' | 'suggestion' | 'question';
+/** Finding severity - includes observation for non-issues */
+type FindingSeverity = 'critical' | 'high' | 'medium' | 'low' | 'observation';
+/** QA Session - exploratory testing session */
+interface QASession {
+    id: string;
+    projectId: string;
+    testerId: string;
+    /** Area being explored */
+    focusArea?: string;
+    /** QA track focus */
+    track?: string;
+    /** Platform being tested */
+    platform?: string;
+    /** Timing */
+    startedAt: string;
+    endedAt?: string;
+    /** Session notes */
+    notes?: string;
+    /** Routes visited during session */
+    routesCovered: string[];
+    /** Status */
+    status: QASessionStatus;
+    /** Metrics */
+    durationMinutes?: number;
+    findingsCount: number;
+    bugsFiled: number;
+    createdAt: string;
+    updatedAt: string;
+}
+/** QA Finding - quick observation during a session */
+interface QAFinding {
+    id: string;
+    sessionId: string;
+    projectId: string;
+    /** Type of finding */
+    type: FindingType;
+    /** Severity level */
+    severity: FindingSeverity;
+    /** Content */
+    title: string;
+    description?: string;
+    /** Context (auto-captured) */
+    route?: string;
+    screenshotUrl?: string;
+    consoleLogs?: ConsoleLogEntry[];
+    networkSnapshot?: NetworkRequest[];
+    deviceInfo?: DeviceInfo;
+    appContext?: AppContext;
+    /** Conversion tracking */
+    convertedToBugId?: string;
+    convertedToTestId?: string;
+    /** Dismissal */
+    dismissed: boolean;
+    dismissedReason?: string;
+    dismissedAt?: string;
+    createdAt: string;
+    updatedAt: string;
+}
+/** Options for starting a QA session */
+interface StartSessionOptions {
+    focusArea?: string;
+    track?: string;
+    platform?: string;
+}
+/** Options for ending a QA session */
+interface EndSessionOptions {
+    notes?: string;
+    routesCovered?: string[];
+}
+/** Options for adding a finding */
+interface AddFindingOptions {
+    type: FindingType;
+    title: string;
+    description?: string;
+    severity?: FindingSeverity;
+    route?: string;
+    screenshotUrl?: string;
+    consoleLogs?: ConsoleLogEntry[];
+    networkSnapshot?: NetworkRequest[];
+    deviceInfo?: DeviceInfo;
+    appContext?: AppContext;
+}
 
 /**
  * BugBear Client
@@ -480,6 +618,51 @@ declare class BugBearClient {
      * First looks up the tester by email, then fetches their assignments
      */
     getAssignedTests(): Promise<TestAssignment[]>;
+    /**
+     * Get assignment by ID with time tracking fields
+     */
+    getAssignment(assignmentId: string): Promise<(TestAssignment & {
+        startedAt?: string;
+        durationSeconds?: number;
+    }) | null>;
+    /**
+     * Update assignment status with automatic time tracking
+     * - Sets started_at when status changes to 'in_progress'
+     * - Calculates duration_seconds when status changes to 'passed'/'failed'/'blocked'
+     * - Optionally include feedback when completing a test
+     */
+    updateAssignmentStatus(assignmentId: string, status: TestAssignment['status'], options?: {
+        notes?: string;
+        testResult?: TestResult;
+        /** Include feedback when completing the test */
+        feedback?: TestFeedback;
+    }): Promise<{
+        success: boolean;
+        error?: string;
+        durationSeconds?: number;
+    }>;
+    /**
+     * Skip a test assignment with a required reason
+     * Marks the assignment as 'skipped' and records why it was skipped
+     */
+    skipAssignment(assignmentId: string, reason: SkipReason, notes?: string): Promise<{
+        success: boolean;
+        error?: string;
+    }>;
+    /**
+     * Submit feedback on a test case to help improve test quality
+     * This empowers testers to shape better tests over time
+     */
+    submitTestFeedback(options: SubmitFeedbackOptions): Promise<{
+        success: boolean;
+        error?: string;
+    }>;
+    /**
+     * Get the currently active (in_progress) assignment for the tester
+     */
+    getActiveAssignment(): Promise<(TestAssignment & {
+        startedAt?: string;
+    }) | null>;
     /**
      * Get current tester info
      * Looks up tester by email from the host app's authenticated user
@@ -606,6 +789,69 @@ declare class BugBearClient {
         threadId?: string;
         error?: string;
     }>;
+    /**
+     * Start a new QA session for exploratory testing
+     */
+    startSession(options?: StartSessionOptions): Promise<{
+        success: boolean;
+        session?: QASession;
+        error?: string;
+    }>;
+    /**
+     * End the current QA session
+     */
+    endSession(sessionId: string, options?: EndSessionOptions): Promise<{
+        success: boolean;
+        session?: QASession;
+        error?: string;
+    }>;
+    /**
+     * Get the current active session for the tester
+     */
+    getActiveSession(): Promise<QASession | null>;
+    /**
+     * Get a session by ID
+     */
+    getSession(sessionId: string): Promise<QASession | null>;
+    /**
+     * Get session history for the tester
+     */
+    getSessionHistory(limit?: number): Promise<QASession[]>;
+    /**
+     * Add a finding during a session
+     */
+    addFinding(sessionId: string, options: AddFindingOptions): Promise<{
+        success: boolean;
+        finding?: QAFinding;
+        error?: string;
+    }>;
+    /**
+     * Get findings for a session
+     */
+    getSessionFindings(sessionId: string): Promise<QAFinding[]>;
+    /**
+     * Convert a finding to a bug report
+     */
+    convertFindingToBug(findingId: string): Promise<{
+        success: boolean;
+        bugId?: string;
+        error?: string;
+    }>;
+    /**
+     * Dismiss a finding
+     */
+    dismissFinding(findingId: string, reason?: string): Promise<{
+        success: boolean;
+        error?: string;
+    }>;
+    /**
+     * Transform database session to QASession type
+     */
+    private transformSession;
+    /**
+     * Transform database finding to QAFinding type
+     */
+    private transformFinding;
 }
 /**
  * Create a BugBear client instance
@@ -667,4 +913,4 @@ declare function captureError(error: Error, errorInfo?: {
     componentStack?: string;
 };
 
-export { type AppContext, BugBearClient, type BugBearConfig, type BugBearReport, type BugBearTheme, type ChecklistItem, type ChecklistResult, type ConsoleLogEntry, type CoverageGap, type CoverageMatrixCell, type CoverageMatrixRow, type DeployChecklist, type DeviceInfo, type EnhancedBugContext, type HostUserInfo, type MessageSenderType, type NetworkRequest, type PriorityFactors, type QAHealthMetrics, type QAHealthScore, type QATrack, type RegressionEvent, type ReportStatus, type ReportType, type RoutePriority, type RouteTestStats, type RubricMode, type RubricResult, type Severity, type TestAssignment, type TestResult, type TestStep, type TestTemplate, type TesterInfo, type TesterMessage, type TesterProfileUpdate, type TesterThread, type ThreadPriority, type ThreadType, captureError, contextCapture, createBugBear };
+export { type AddFindingOptions, type AppContext, BugBearClient, type BugBearConfig, type BugBearReport, type BugBearTheme, type ChecklistItem, type ChecklistResult, type ConsoleLogEntry, type CoverageGap, type CoverageMatrixCell, type CoverageMatrixRow, type DeployChecklist, type DeviceInfo, type EndSessionOptions, type EnhancedBugContext, type FindingSeverity, type FindingType, type HostUserInfo, type MessageSenderType, type NetworkRequest, type PriorityFactors, type QAFinding, type QAHealthMetrics, type QAHealthScore, type QASession, type QASessionStatus, type QATrack, type RegressionEvent, type ReportStatus, type ReportType, type RoutePriority, type RouteTestStats, type RubricMode, type RubricResult, type Severity, type SkipReason, type StartSessionOptions, type SubmitFeedbackOptions, type TestAssignment, type TestFeedback, type TestGroup, type TestResult, type TestStep, type TestTemplate, type TesterInfo, type TesterMessage, type TesterProfileUpdate, type TesterThread, type ThreadPriority, type ThreadType, captureError, contextCapture, createBugBear };

package/dist/index.d.ts

@@ -161,6 +161,15 @@ interface BugBearTheme {
 }
 type TestTemplate = 'steps' | 'checklist' | 'rubric' | 'freeform';
 type RubricMode = 'pass_fail' | 'rating';
+/** Skip reason for skipped test assignments */
+type SkipReason = 'blocked' | 'not_ready' | 'dependency' | 'other';
+/** Test group (folder) for organizing test cases */
+interface TestGroup {
+    id: string;
+    name: string;
+    description?: string;
+    sortOrder: number;
+}
 interface QATrack {
     id: string;
     name: string;
@@ -184,8 +193,20 @@ interface TestAssignment {
         /** Route/screen to navigate to when starting this test */
         targetRoute?: string;
         track?: QATrack;
+        /** Test group (folder) this test belongs to */
+        group?: TestGroup;
     };
-    status: 'pending' | 'in_progress' | 'passed' | 'failed' | 'blocked';
+    status: 'pending' | 'in_progress' | 'passed' | 'failed' | 'blocked' | 'skipped';
+    /** Reason for skipping (when status is 'skipped') */
+    skipReason?: SkipReason;
+    /** When the assignment was started (set to in_progress) */
+    startedAt?: string;
+    /** Duration in seconds (calculated when completed) */
+    durationSeconds?: number;
+    /** Whether this is a verification assignment for a fixed bug */
+    isVerification?: boolean;
+    /** Original report ID if this is a verification assignment */
+    originalReportId?: string;
 }
 interface TestStep {
     stepNumber: number;
@@ -213,6 +234,37 @@ interface TestResult {
     /** Overall notes */
     notes?: string;
 }
+/**
+ * Feedback from testers about a test case
+ * Helps improve test quality over time
+ */
+interface TestFeedback {
+    /** Overall rating (1-5 stars) */
+    rating: 1 | 2 | 3 | 4 | 5;
+    /** Optional detailed ratings */
+    clarityRating?: 1 | 2 | 3 | 4 | 5;
+    stepsRating?: 1 | 2 | 3 | 4 | 5;
+    relevanceRating?: 1 | 2 | 3 | 4 | 5;
+    /** Free-form feedback note */
+    feedbackNote?: string;
+    /** Specific improvement suggestion */
+    suggestedImprovement?: string;
+    /** Quick feedback flags */
+    isOutdated?: boolean;
+    needsMoreDetail?: boolean;
+    stepsUnclear?: boolean;
+    expectedResultUnclear?: boolean;
+}
+/**
+ * Options for submitting test feedback
+ */
+interface SubmitFeedbackOptions {
+    testCaseId: string;
+    assignmentId?: string;
+    feedback: TestFeedback;
+    /** Time taken to complete in seconds */
+    timeToCompleteSeconds?: number;
+}
 interface TesterInfo {
     id: string;
     name: string;
@@ -442,6 +494,92 @@ interface CoverageMatrixRow {
     lastTestedAt: string | null;
     tracks: Record<string, CoverageMatrixCell>;
 }
+/** Session status */
+type QASessionStatus = 'active' | 'paused' | 'completed' | 'abandoned';
+/** Finding type - lighter than a bug report */
+type FindingType = 'bug' | 'concern' | 'suggestion' | 'question';
+/** Finding severity - includes observation for non-issues */
+type FindingSeverity = 'critical' | 'high' | 'medium' | 'low' | 'observation';
+/** QA Session - exploratory testing session */
+interface QASession {
+    id: string;
+    projectId: string;
+    testerId: string;
+    /** Area being explored */
+    focusArea?: string;
+    /** QA track focus */
+    track?: string;
+    /** Platform being tested */
+    platform?: string;
+    /** Timing */
+    startedAt: string;
+    endedAt?: string;
+    /** Session notes */
+    notes?: string;
+    /** Routes visited during session */
+    routesCovered: string[];
+    /** Status */
+    status: QASessionStatus;
+    /** Metrics */
+    durationMinutes?: number;
+    findingsCount: number;
+    bugsFiled: number;
+    createdAt: string;
+    updatedAt: string;
+}
+/** QA Finding - quick observation during a session */
+interface QAFinding {
+    id: string;
+    sessionId: string;
+    projectId: string;
+    /** Type of finding */
+    type: FindingType;
+    /** Severity level */
+    severity: FindingSeverity;
+    /** Content */
+    title: string;
+    description?: string;
+    /** Context (auto-captured) */
+    route?: string;
+    screenshotUrl?: string;
+    consoleLogs?: ConsoleLogEntry[];
+    networkSnapshot?: NetworkRequest[];
+    deviceInfo?: DeviceInfo;
+    appContext?: AppContext;
+    /** Conversion tracking */
+    convertedToBugId?: string;
+    convertedToTestId?: string;
+    /** Dismissal */
+    dismissed: boolean;
+    dismissedReason?: string;
+    dismissedAt?: string;
+    createdAt: string;
+    updatedAt: string;
+}
+/** Options for starting a QA session */
+interface StartSessionOptions {
+    focusArea?: string;
+    track?: string;
+    platform?: string;
+}
+/** Options for ending a QA session */
+interface EndSessionOptions {
+    notes?: string;
+    routesCovered?: string[];
+}
+/** Options for adding a finding */
+interface AddFindingOptions {
+    type: FindingType;
+    title: string;
+    description?: string;
+    severity?: FindingSeverity;
+    route?: string;
+    screenshotUrl?: string;
+    consoleLogs?: ConsoleLogEntry[];
+    networkSnapshot?: NetworkRequest[];
+    deviceInfo?: DeviceInfo;
+    appContext?: AppContext;
+}
 
 /**
  * BugBear Client
@@ -480,6 +618,51 @@ declare class BugBearClient {
      * First looks up the tester by email, then fetches their assignments
      */
     getAssignedTests(): Promise<TestAssignment[]>;
+    /**
+     * Get assignment by ID with time tracking fields
+     */
+    getAssignment(assignmentId: string): Promise<(TestAssignment & {
+        startedAt?: string;
+        durationSeconds?: number;
+    }) | null>;
+    /**
+     * Update assignment status with automatic time tracking
+     * - Sets started_at when status changes to 'in_progress'
+     * - Calculates duration_seconds when status changes to 'passed'/'failed'/'blocked'
+     * - Optionally include feedback when completing a test
+     */
+    updateAssignmentStatus(assignmentId: string, status: TestAssignment['status'], options?: {
+        notes?: string;
+        testResult?: TestResult;
+        /** Include feedback when completing the test */
+        feedback?: TestFeedback;
+    }): Promise<{
+        success: boolean;
+        error?: string;
+        durationSeconds?: number;
+    }>;
+    /**
+     * Skip a test assignment with a required reason
+     * Marks the assignment as 'skipped' and records why it was skipped
+     */
+    skipAssignment(assignmentId: string, reason: SkipReason, notes?: string): Promise<{
+        success: boolean;
+        error?: string;
+    }>;
+    /**
+     * Submit feedback on a test case to help improve test quality
+     * This empowers testers to shape better tests over time
+     */
+    submitTestFeedback(options: SubmitFeedbackOptions): Promise<{
+        success: boolean;
+        error?: string;
+    }>;
+    /**
+     * Get the currently active (in_progress) assignment for the tester
+     */
+    getActiveAssignment(): Promise<(TestAssignment & {
+        startedAt?: string;
+    }) | null>;
     /**
      * Get current tester info
      * Looks up tester by email from the host app's authenticated user
@@ -606,6 +789,69 @@ declare class BugBearClient {
         threadId?: string;
         error?: string;
     }>;
+    /**
+     * Start a new QA session for exploratory testing
+     */
+    startSession(options?: StartSessionOptions): Promise<{
+        success: boolean;
+        session?: QASession;
+        error?: string;
+    }>;
+    /**
+     * End the current QA session
+     */
+    endSession(sessionId: string, options?: EndSessionOptions): Promise<{
+        success: boolean;
+        session?: QASession;
+        error?: string;
+    }>;
+    /**
+     * Get the current active session for the tester
+     */
+    getActiveSession(): Promise<QASession | null>;
+    /**
+     * Get a session by ID
+     */
+    getSession(sessionId: string): Promise<QASession | null>;
+    /**
+     * Get session history for the tester
+     */
+    getSessionHistory(limit?: number): Promise<QASession[]>;
+    /**
+     * Add a finding during a session
+     */
+    addFinding(sessionId: string, options: AddFindingOptions): Promise<{
+        success: boolean;
+        finding?: QAFinding;
+        error?: string;
+    }>;
+    /**
+     * Get findings for a session
+     */
+    getSessionFindings(sessionId: string): Promise<QAFinding[]>;
+    /**
+     * Convert a finding to a bug report
+     */
+    convertFindingToBug(findingId: string): Promise<{
+        success: boolean;
+        bugId?: string;
+        error?: string;
+    }>;
+    /**
+     * Dismiss a finding
+     */
+    dismissFinding(findingId: string, reason?: string): Promise<{
+        success: boolean;
+        error?: string;
+    }>;
+    /**
+     * Transform database session to QASession type
+     */
+    private transformSession;
+    /**
+     * Transform database finding to QAFinding type
+     */
+    private transformFinding;
 }
 /**
  * Create a BugBear client instance
@@ -667,4 +913,4 @@ declare function captureError(error: Error, errorInfo?: {
     componentStack?: string;
 };
 
-export { type AppContext, BugBearClient, type BugBearConfig, type BugBearReport, type BugBearTheme, type ChecklistItem, type ChecklistResult, type ConsoleLogEntry, type CoverageGap, type CoverageMatrixCell, type CoverageMatrixRow, type DeployChecklist, type DeviceInfo, type EnhancedBugContext, type HostUserInfo, type MessageSenderType, type NetworkRequest, type PriorityFactors, type QAHealthMetrics, type QAHealthScore, type QATrack, type RegressionEvent, type ReportStatus, type ReportType, type RoutePriority, type RouteTestStats, type RubricMode, type RubricResult, type Severity, type TestAssignment, type TestResult, type TestStep, type TestTemplate, type TesterInfo, type TesterMessage, type TesterProfileUpdate, type TesterThread, type ThreadPriority, type ThreadType, captureError, contextCapture, createBugBear };
+export { type AddFindingOptions, type AppContext, BugBearClient, type BugBearConfig, type BugBearReport, type BugBearTheme, type ChecklistItem, type ChecklistResult, type ConsoleLogEntry, type CoverageGap, type CoverageMatrixCell, type CoverageMatrixRow, type DeployChecklist, type DeviceInfo, type EndSessionOptions, type EnhancedBugContext, type FindingSeverity, type FindingType, type HostUserInfo, type MessageSenderType, type NetworkRequest, type PriorityFactors, type QAFinding, type QAHealthMetrics, type QAHealthScore, type QASession, type QASessionStatus, type QATrack, type RegressionEvent, type ReportStatus, type ReportType, type RoutePriority, type RouteTestStats, type RubricMode, type RubricResult, type Severity, type SkipReason, type StartSessionOptions, type SubmitFeedbackOptions, type TestAssignment, type TestFeedback, type TestGroup, type TestResult, type TestStep, type TestTemplate, type TesterInfo, type TesterMessage, type TesterProfileUpdate, type TesterThread, type ThreadPriority, type ThreadType, captureError, contextCapture, createBugBear };