@fatagnus/convex-feedback 0.1.0

package/dist/react/index.js

@@ -0,0 +1,36 @@
+/**
+ * @convex-dev/feedback - React Components
+ *
+ * React components for bug reports and feedback collection.
+ *
+ * @example
+ * ```tsx
+ * import { BugReportProvider, BugReportButton } from '@convex-dev/feedback/react';
+ * import { api } from './convex/_generated/api';
+ *
+ * function App() {
+ *   return (
+ *     <BugReportProvider>
+ *       <YourApp />
+ *       <BugReportButton
+ *         reporterType="staff"
+ *         reporterId={user.id}
+ *         reporterEmail={user.email}
+ *         reporterName={user.name}
+ *         bugReportApi={{
+ *           create: api.feedback.bugReports.create,
+ *           generateUploadUrl: api.feedback.bugReports.generateUploadUrl,
+ *         }}
+ *         feedbackApi={{
+ *           create: api.feedback.feedback.create,
+ *           generateUploadUrl: api.feedback.feedback.generateUploadUrl,
+ *         }}
+ *       />
+ *     </BugReportProvider>
+ *   );
+ * }
+ * ```
+ */
+export { BugReportProvider, useBugReportContext, } from './BugReportContext';
+export { BugReportButton, } from './BugReportButton';
+//# sourceMappingURL=index.js.map

package/dist/react/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/react/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AAEH,OAAO,EACL,iBAAiB,EACjB,mBAAmB,GAIpB,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EACL,eAAe,GAEhB,MAAM,mBAAmB,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,89 @@
+/**
+ * Shared types for @convex-dev/feedback
+ */
+/**
+ * Bug report document type
+ * Note: _id is typed as string for portability. Use your app's Id type for full typing.
+ */
+export interface BugReport {
+    _id: string;
+    _creationTime: number;
+    title: string;
+    description: string;
+    severity: 'low' | 'medium' | 'high' | 'critical';
+    status: 'open' | 'in-progress' | 'resolved' | 'closed';
+    isArchived?: boolean;
+    reporterType: 'staff' | 'customer';
+    reporterId: string;
+    reporterEmail: string;
+    reporterName: string;
+    url: string;
+    route?: string;
+    browserInfo: string;
+    consoleErrors?: string;
+    screenshotStorageId?: string;
+    viewportWidth: number;
+    viewportHeight: number;
+    networkState: string;
+    aiSummary?: string;
+    aiRootCauseAnalysis?: string;
+    aiReproductionSteps?: string[];
+    aiSuggestedFix?: string;
+    aiEstimatedEffort?: 'low' | 'medium' | 'high';
+    aiSuggestedSeverity?: 'low' | 'medium' | 'high' | 'critical';
+    aiAnalyzedAt?: number;
+    aiThreadId?: string;
+    notificationsSentAt?: number;
+    createdAt: number;
+    updatedAt: number;
+}
+/**
+ * Feedback document type
+ */
+export interface Feedback {
+    _id: string;
+    _creationTime: number;
+    type: 'feature_request' | 'change_request' | 'general';
+    title: string;
+    description: string;
+    priority: 'nice_to_have' | 'important' | 'critical';
+    status: 'open' | 'under_review' | 'planned' | 'in_progress' | 'completed' | 'declined';
+    isArchived?: boolean;
+    reporterType: 'staff' | 'customer';
+    reporterId: string;
+    reporterEmail: string;
+    reporterName: string;
+    url: string;
+    route?: string;
+    browserInfo: string;
+    consoleErrors?: string;
+    screenshotStorageId?: string;
+    viewportWidth: number;
+    viewportHeight: number;
+    networkState: string;
+    aiSummary?: string;
+    aiImpactAnalysis?: string;
+    aiActionItems?: string[];
+    aiEstimatedEffort?: 'low' | 'medium' | 'high';
+    aiSuggestedPriority?: 'nice_to_have' | 'important' | 'critical';
+    aiAnalyzedAt?: number;
+    aiThreadId?: string;
+    notificationsSentAt?: number;
+    createdAt: number;
+    updatedAt: number;
+}
+/**
+ * Support team document type
+ */
+export interface SupportTeam {
+    _id: string;
+    _creationTime: number;
+    teamName: string;
+    memberEmails: string[];
+    feedbackTypes: ('feature_request' | 'change_request' | 'general')[];
+    bugReportSeverities: ('low' | 'medium' | 'high' | 'critical')[];
+    isActive: boolean;
+    createdAt: number;
+    updatedAt: number;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,GAAG,EAAE,MAAM,CAAC;IACZ,aAAa,EAAE,MAAM,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,UAAU,CAAC;IACjD,MAAM,EAAE,MAAM,GAAG,aAAa,GAAG,UAAU,GAAG,QAAQ,CAAC;IACvD,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,YAAY,EAAE,OAAO,GAAG,UAAU,CAAC;IACnC,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,aAAa,EAAE,MAAM,CAAC;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,EAAE,MAAM,CAAC;IAErB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC/B,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,iBAAiB,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,CAAC;IAC9C,mBAAmB,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,UAAU,CAAC;IAC7D,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB,GAAG,EAAE,MAAM,CAAC;IACZ,aAAa,EAAE,MAAM,CAAC;IACtB,IAAI,EAAE,iBAAiB,GAAG,gBAAgB,GAAG,SAAS,CAAC;IACvD,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,cAAc,GAAG,WAAW,GAAG,UAAU,CAAC;IACpD,MAAM,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS,GAAG,aAAa,GAAG,WAAW,GAAG,UAAU,CAAC;IACvF,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,YAAY,EAAE,OAAO,GAAG,UAAU,CAAC;IACnC,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,aAAa,EAAE,MAAM,CAAC;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,YAAY,EAAE,MAAM,CAAC;IAErB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IACzB,iBAAiB,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,CAAC;IAC9C,mBAAmB,CAAC,EAAE,cAAc,GAAG,WAAW,GAAG,UAAU,CAAC;IAChE,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,aAAa,EAAE,CAAC,iBAAiB,GAAG,gBAAgB,GAAG,SAAS,CAAC,EAAE,CAAC;IACpE,mBAAmB,EAAE,CAAC,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,UAAU,CAAC,EAAE,CAAC;IAChE,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB"}

package/dist/types.js

@@ -0,0 +1,5 @@
+/**
+ * Shared types for @convex-dev/feedback
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG"}

package/package.json

@@ -0,0 +1,101 @@
+{
+  "name": "@fatagnus/convex-feedback",
+  "version": "0.1.0",
+  "description": "Bug reports and feedback collection component for Convex applications with AI analysis and email notifications",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ozanturksever/convex-feedback"
+  },
+  "homepage": "https://github.com/ozanturksever/convex-feedback#readme",
+  "bugs": {
+    "url": "https://github.com/ozanturksever/convex-feedback/issues"
+  },
+  "author": "Ozan Turksever <ozan.turksever@gmail.com>",
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "convex",
+    "feedback",
+    "bug-reports",
+    "ai-analysis",
+    "email-notifications",
+    "react"
+  ],
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./react": {
+      "types": "./dist/react/index.d.ts",
+      "import": "./dist/react/index.js"
+    },
+    "./convex.config": "./src/convex/convex.config.ts",
+    "./convex/*": "./src/convex/*"
+  },
+  "files": [
+    "dist",
+    "src",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "typecheck": "tsc --noEmit",
+    "clean": "rm -rf dist"
+  },
+  "peerDependencies": {
+    "@ai-sdk/openai-compatible": ">=0.1.0",
+    "@convex-dev/agent": ">=0.1.0",
+    "@mantine/core": ">=7.0.0",
+    "@mantine/form": ">=7.0.0",
+    "@mantine/hooks": ">=7.0.0",
+    "@mantine/notifications": ">=7.0.0",
+    "@tabler/icons-react": ">=3.0.0",
+    "convex": ">=1.17.0",
+    "html2canvas": ">=1.4.0",
+    "react": ">=18.0.0",
+    "resend": ">=4.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@convex-dev/agent": {
+      "optional": true
+    },
+    "@ai-sdk/openai-compatible": {
+      "optional": true
+    },
+    "resend": {
+      "optional": true
+    },
+    "@mantine/core": {
+      "optional": true
+    },
+    "@mantine/form": {
+      "optional": true
+    },
+    "@mantine/hooks": {
+      "optional": true
+    },
+    "@mantine/notifications": {
+      "optional": true
+    },
+    "@tabler/icons-react": {
+      "optional": true
+    },
+    "html2canvas": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "@types/react": "^18.0.0",
+    "typescript": "^5.0.0"
+  }
+}

package/src/convex/agents/bugReportAgent.ts

@@ -0,0 +1,277 @@
+/**
+ * Bug Report AI Agent
+ *
+ * Automatically analyzes bug report submissions and generates:
+ * - Summary of the bug
+ * - Root cause analysis
+ * - Reproduction steps
+ * - Suggested fix
+ * - Estimated effort (low/medium/high)
+ * - Suggested severity (low/medium/high/critical)
+ *
+ * Triggers email notifications to the reporter and assigned team.
+ */
+
+import { v } from "convex/values";
+import { Agent, createThread } from "@convex-dev/agent";
+import { createOpenAICompatible } from "@ai-sdk/openai-compatible";
+import { components, internal } from "../_generated/api";
+import { internalAction, internalQuery } from "../_generated/server";
+import type { BugSeverity, Effort } from "../schema";
+
+// Create OpenRouter provider
+const openrouter = createOpenAICompatible({
+  name: "openrouter",
+  baseURL: "https://openrouter.ai/api/v1",
+  headers: {
+    Authorization: `Bearer ${process.env.OPENROUTER_API_KEY}`,
+  },
+});
+
+// Agent name constant
+const AGENT_NAME = "Bug Report Analyst";
+
+// ============================================================================
+// Agent Definition
+// ============================================================================
+
+/**
+ * Bug Report Analysis Agent
+ *
+ * Analyzes bug report submissions and generates comprehensive analysis.
+ */
+export const bugReportAgent = new Agent(components.agent, {
+  name: AGENT_NAME,
+  languageModel: openrouter.languageModel("anthropic/claude-sonnet-4"),
+
+  instructions: `You are the Bug Report Analyst, an AI assistant that analyzes bug report submissions.
+
+When given a bug report, you will:
+1. **Summarize** the bug in 2-3 clear sentences
+2. **Analyze Root Cause** - identify potential underlying causes based on the symptoms described
+3. **Extract Reproduction Steps** - create clear, numbered steps to reproduce the bug
+4. **Suggest Fix** - provide a recommended approach to fix the bug
+5. **Estimate Effort** - rate as "low" (< 1 day), "medium" (1-3 days), or "high" (> 3 days)
+6. **Suggest Severity** - rate as "low" (minor inconvenience), "medium" (affects workflow), "high" (blocks work), or "critical" (data loss/security)
+
+## Response Format
+Always respond in the following JSON format:
+\`\`\`json
+{
+  "summary": "A 2-3 sentence summary of the bug",
+  "rootCauseAnalysis": "Analysis of potential root cause",
+  "reproductionSteps": ["Step 1", "Step 2", "Step 3"],
+  "suggestedFix": "Recommended approach to fix the bug",
+  "estimatedEffort": "low" | "medium" | "high",
+  "suggestedSeverity": "low" | "medium" | "high" | "critical",
+  "reasoning": "Brief explanation for estimates"
+}
+\`\`\`
+
+## Guidelines
+- Be precise and technical in your analysis
+- Consider edge cases and related issues
+- Reproduction steps should be specific and actionable
+- Suggested fix should be practical and implementable
+- Effort estimation should account for investigation, fix, testing, and deployment
+- Severity should reflect user impact and business criticality`,
+
+  tools: {},
+  maxSteps: 3,
+});
+
+// ============================================================================
+// Internal Queries
+// ============================================================================
+
+/**
+ * Get bug report by ID for analysis
+ */
+export const getBugReportForAnalysis = internalQuery({
+  args: {
+    bugReportId: v.id("bugReports"),
+  },
+  returns: v.union(
+    v.object({
+      _id: v.id("bugReports"),
+      title: v.string(),
+      description: v.string(),
+      severity: v.string(),
+      reporterName: v.string(),
+      reporterEmail: v.string(),
+      url: v.string(),
+      browserInfo: v.string(),
+      consoleErrors: v.optional(v.string()),
+    }),
+    v.null()
+  ),
+  handler: async (ctx, args) => {
+    const bugReport = await ctx.db.get(args.bugReportId);
+    if (!bugReport) {
+      return null;
+    }
+    return {
+      _id: bugReport._id,
+      title: bugReport.title,
+      description: bugReport.description,
+      severity: bugReport.severity,
+      reporterName: bugReport.reporterName,
+      reporterEmail: bugReport.reporterEmail,
+      url: bugReport.url,
+      browserInfo: bugReport.browserInfo,
+      consoleErrors: bugReport.consoleErrors,
+    };
+  },
+});
+
+// ============================================================================
+// Main Processing Action
+// ============================================================================
+
+/**
+ * Analyze bug report using AI and send notifications.
+ * This is the main entry point triggered after bug report creation.
+ */
+export const processBugReport = internalAction({
+  args: {
+    bugReportId: v.id("bugReports"),
+  },
+  returns: v.object({
+    success: v.boolean(),
+    error: v.optional(v.string()),
+  }),
+  handler: async (ctx, args): Promise<{ success: boolean; error?: string }> => {
+    // Check if OpenRouter API key is configured
+    if (!process.env.OPENROUTER_API_KEY) {
+      console.log("OPENROUTER_API_KEY not configured, skipping AI analysis");
+      // Still try to send notifications without AI analysis
+      try {
+        await ctx.runAction(internal.emails.bugReportEmails.sendBugReportNotifications, {
+          reportId: args.bugReportId,
+          analysis: null,
+        });
+      } catch {
+        console.log("Email notifications not configured");
+      }
+      return { success: true };
+    }
+
+    // Get the bug report
+    const bugReport = await ctx.runQuery(internal.agents.bugReportAgent.getBugReportForAnalysis, {
+      bugReportId: args.bugReportId,
+    });
+
+    if (!bugReport) {
+      return { success: false, error: "Bug report not found" };
+    }
+
+    // Create a thread for this analysis
+    const threadId = await createThread(ctx, components.agent, {
+      title: `Bug Report Analysis: ${bugReport.title}`,
+    });
+
+    // Build the prompt for analysis
+    const consoleErrorsSection = bugReport.consoleErrors 
+      ? `**Console Errors:** ${bugReport.consoleErrors}` 
+      : "";
+    
+    const analysisPrompt = `Please analyze the following bug report:
+
+**Title:** ${bugReport.title}
+**Description:** ${bugReport.description}
+**Reporter Severity:** ${bugReport.severity}
+**Submitted From:** ${bugReport.url}
+**Browser Info:** ${bugReport.browserInfo}
+${consoleErrorsSection}
+
+Provide your analysis in the JSON format specified.`;
+
+    // Generate analysis using the agent
+    let result: { text: string };
+    try {
+      result = await bugReportAgent.generateText(
+        ctx,
+        { threadId },
+        { prompt: analysisPrompt }
+      );
+    } catch (error) {
+      console.error("AI analysis failed:", error);
+      return { success: false, error: `AI analysis failed: ${error instanceof Error ? error.message : String(error)}` };
+    }
+
+    // Parse the AI response
+    let analysis: {
+      summary: string;
+      rootCauseAnalysis: string;
+      reproductionSteps: string[];
+      suggestedFix: string;
+      estimatedEffort: Effort;
+      suggestedSeverity: BugSeverity;
+    };
+
+    try {
+      // Extract JSON from the response (handle markdown code blocks)
+      const jsonMatch = result.text.match(/```json\s*([\s\S]*?)\s*```/);
+      const jsonStr = jsonMatch ? jsonMatch[1] : result.text;
+      const parsed = JSON.parse(jsonStr);
+      
+      analysis = {
+        summary: parsed.summary || "Unable to generate summary",
+        rootCauseAnalysis: parsed.rootCauseAnalysis || "Unable to generate root cause analysis",
+        reproductionSteps: Array.isArray(parsed.reproductionSteps) ? parsed.reproductionSteps : [],
+        suggestedFix: parsed.suggestedFix || "Unable to generate suggested fix",
+        estimatedEffort: ["low", "medium", "high"].includes(parsed.estimatedEffort) 
+          ? parsed.estimatedEffort 
+          : "medium",
+        suggestedSeverity: ["low", "medium", "high", "critical"].includes(parsed.suggestedSeverity)
+          ? parsed.suggestedSeverity
+          : bugReport.severity as BugSeverity,
+      };
+    } catch {
+      // If parsing fails, create a basic analysis from the text
+      analysis = {
+        summary: result.text.substring(0, 500),
+        rootCauseAnalysis: "AI analysis parsing failed. Please review manually.",
+        reproductionSteps: ["Review bug report manually", "Contact reporter for clarification"],
+        suggestedFix: "Manual investigation required.",
+        estimatedEffort: "medium",
+        suggestedSeverity: bugReport.severity as BugSeverity,
+      };
+    }
+
+    // Update bug report with analysis
+    await ctx.runMutation(internal.bugReports.updateWithAnalysis, {
+      bugReportId: args.bugReportId,
+      aiSummary: analysis.summary,
+      aiRootCauseAnalysis: analysis.rootCauseAnalysis,
+      aiReproductionSteps: analysis.reproductionSteps,
+      aiSuggestedFix: analysis.suggestedFix,
+      aiEstimatedEffort: analysis.estimatedEffort,
+      aiSuggestedSeverity: analysis.suggestedSeverity,
+      aiThreadId: threadId,
+    });
+
+    // Send email notifications
+    try {
+      await ctx.runAction(internal.emails.bugReportEmails.sendBugReportNotifications, {
+        reportId: args.bugReportId,
+        analysis: {
+          summary: analysis.summary,
+          rootCauseAnalysis: analysis.rootCauseAnalysis,
+          reproductionSteps: analysis.reproductionSteps,
+          suggestedFix: analysis.suggestedFix,
+          estimatedEffort: analysis.estimatedEffort,
+        },
+      });
+
+      // Mark notifications as sent
+      await ctx.runMutation(internal.bugReports.markNotificationsSent, {
+        bugReportId: args.bugReportId,
+      });
+    } catch {
+      console.log("Email notifications not configured or failed");
+    }
+
+    return { success: true };
+  },
+});