@fatagnus/convex-feedback 0.1.0

package/LICENSE

@@ -0,0 +1,177 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no theory of
+      liability, whether in contract, strict liability, or tort
+      (including negligence or otherwise) arising in any way out of
+      the use or inability to use the Work (even if such Holder or other
+      party has been advised of the possibility of such damages), shall
+      any Contributor be liable to You for damages, including any direct,
+      indirect, special, incidental, or consequential damages of any
+      character arising as a result of this License or out of the use or
+      inability to use the Work (including but not limited to damages for
+      loss of goodwill, work stoppage, computer failure or malfunction, or
+      any and all other commercial damages or losses), even if such
+      Contributor has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

package/README.md

@@ -0,0 +1,382 @@
+# @fatagnus/convex-feedback
+
+Bug reports and feedback collection component for Convex applications with AI analysis and email notifications.
+
+## Features
+
+- 🐛 **Bug Reports** - Capture bug reports with browser diagnostics, console errors, and screenshots
+- 💬 **Feedback** - Collect feature requests, change requests, and general feedback
+- 🤖 **AI Analysis** - Automatic analysis of submissions using OpenRouter/Claude
+- 📧 **Email Notifications** - Send notifications to reporters and support teams via Resend
+- 👥 **Support Teams** - Route notifications to the right teams based on type/severity
+- 📸 **Screenshots** - Capture or upload screenshots with reports
+- 🔄 **Real-time** - Leverages Convex for real-time updates
+
+## Installation
+
+```bash
+npm install @fatagnus/convex-feedback
+```
+
+### Peer Dependencies
+
+**Required:**
+- `convex` (>=1.17.0)
+- `react` (>=18.0.0)
+
+**Optional (for React components):**
+- `@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)
+- `html2canvas` (>=1.4.0)
+
+**Optional (for AI analysis):**
+- `@convex-dev/agent` (>=0.1.0)
+- `@ai-sdk/openai-compatible` (>=0.1.0)
+
+**Optional (for email notifications):**
+- `resend` (>=4.0.0)
+
+## Setup
+
+### 1. Add the Component
+
+Add the feedback component to your Convex app configuration:
+
+```typescript
+// convex/convex.config.ts
+import { defineApp } from "convex/server";
+import feedback from "@fatagnus/convex-feedback/convex.config";
+
+const app = defineApp();
+app.use(feedback);
+export default app;
+```
+
+### 2. Configure Environment Variables
+
+Set these environment variables in your Convex dashboard:
+
+| Variable | Required | Description |
+|----------|----------|-------------|
+| `OPENROUTER_API_KEY` | No | OpenRouter API key for AI analysis |
+| `RESEND_API_KEY` | No | Resend API key for email notifications |
+| `RESEND_FROM_EMAIL` | No | From email address (default: `bugs@resend.dev`) |
+
+### 3. Add React Components
+
+Wrap your app with the `BugReportProvider` and add the `BugReportButton`:
+
+```tsx
+import { BugReportProvider, BugReportButton } from '@fatagnus/convex-feedback/react';
+import { api } from './convex/_generated/api';
+
+function App() {
+  const user = useCurrentUser(); // Your auth hook
+
+  return (
+    <BugReportProvider>
+      <YourApp />
+      
+      {user && (
+        <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>
+  );
+}
+```
+
+## API Reference
+
+### Bug Reports
+
+#### `bugReports.create`
+
+Create a new bug report.
+
+```typescript
+const bugReportId = await ctx.runMutation(api.feedback.bugReports.create, {
+  title: "Button not working",
+  description: "The submit button doesn't respond to clicks",
+  severity: "high", // low | medium | high | critical
+  reporterType: "staff", // staff | customer
+  reporterId: "user_123",
+  reporterEmail: "user@example.com",
+  reporterName: "John Doe",
+  url: "https://app.example.com/form",
+  route: "/form",
+  browserInfo: JSON.stringify({ userAgent: "..." }),
+  consoleErrors: JSON.stringify([{ message: "Error..." }]),
+  screenshotStorageId: "storage_id_here", // optional
+  viewportWidth: 1920,
+  viewportHeight: 1080,
+  networkState: "online",
+});
+```
+
+#### `bugReports.list`
+
+List bug reports with optional filters.
+
+```typescript
+const reports = await ctx.runQuery(api.feedback.bugReports.list, {
+  status: "open", // optional: open | in-progress | resolved | closed
+  severity: "high", // optional: low | medium | high | critical
+  includeArchived: false, // optional, default: false
+  limit: 50, // optional, default: 50
+});
+```
+
+#### `bugReports.get`
+
+Get a single bug report by ID.
+
+```typescript
+const report = await ctx.runQuery(api.feedback.bugReports.get, {
+  reportId: "bug_report_id",
+});
+```
+
+#### `bugReports.updateStatus`
+
+Update the status of a bug report.
+
+```typescript
+await ctx.runMutation(api.feedback.bugReports.updateStatus, {
+  reportId: "bug_report_id",
+  status: "resolved",
+});
+```
+
+#### `bugReports.archive` / `bugReports.unarchive`
+
+Archive or unarchive a bug report.
+
+```typescript
+await ctx.runMutation(api.feedback.bugReports.archive, {
+  reportId: "bug_report_id",
+});
+```
+
+### Feedback
+
+#### `feedback.create`
+
+Create new feedback.
+
+```typescript
+const feedbackId = await ctx.runMutation(api.feedback.feedback.create, {
+  type: "feature_request", // feature_request | change_request | general
+  title: "Dark mode support",
+  description: "Please add dark mode to reduce eye strain",
+  priority: "important", // nice_to_have | important | critical
+  reporterType: "customer",
+  reporterId: "customer_123",
+  reporterEmail: "customer@example.com",
+  reporterName: "Jane Doe",
+  url: "https://app.example.com/settings",
+  browserInfo: JSON.stringify({ userAgent: "..." }),
+  viewportWidth: 1920,
+  viewportHeight: 1080,
+  networkState: "online",
+});
+```
+
+#### `feedback.list`
+
+List feedback with optional filters.
+
+```typescript
+const items = await ctx.runQuery(api.feedback.feedback.list, {
+  status: "open", // optional
+  type: "feature_request", // optional
+  priority: "important", // optional
+  includeArchived: false, // optional
+  limit: 50, // optional
+});
+```
+
+### Support Teams
+
+#### `supportTeams.create`
+
+Create a support team for notification routing.
+
+```typescript
+const teamId = await ctx.runMutation(api.feedback.supportTeams.create, {
+  teamName: "Engineering Team",
+  memberEmails: ["dev1@example.com", "dev2@example.com"],
+  feedbackTypes: ["feature_request", "change_request"],
+  bugReportSeverities: ["high", "critical"],
+});
+```
+
+#### `supportTeams.list`
+
+List all support teams.
+
+```typescript
+const teams = await ctx.runQuery(api.feedback.supportTeams.list, {
+  activeOnly: true, // optional
+});
+```
+
+#### `supportTeams.update`
+
+Update a support team.
+
+```typescript
+await ctx.runMutation(api.feedback.supportTeams.update, {
+  teamId: "team_id",
+  teamName: "Updated Team Name",
+  memberEmails: ["new@example.com"],
+  isActive: true,
+});
+```
+
+## React Components
+
+### BugReportProvider
+
+Provider component that captures console errors for bug reports. Wrap your app with this provider.
+
+```tsx
+import { BugReportProvider } from '@fatagnus/convex-feedback/react';
+
+function App() {
+  return (
+    <BugReportProvider maxErrors={20}>
+      <YourApp />
+    </BugReportProvider>
+  );
+}
+```
+
+**Props:**
+
+| Prop | Type | Default | Description |
+|------|------|---------|-------------|
+| `children` | `ReactNode` | - | Child components |
+| `maxErrors` | `number` | `20` | Maximum console errors to capture |
+
+### BugReportButton
+
+Floating action button for submitting bug reports and feedback.
+
+```tsx
+import { BugReportButton } from '@fatagnus/convex-feedback/react';
+
+<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,
+  }}
+  position={{ bottom: 20, right: 20 }}
+  buttonColor="red"
+  showFeedback={true}
+  onSuccess={(type) => console.log(`${type} submitted`)}
+  onError={(error, type) => console.error(`${type} failed:`, error)}
+/>
+```
+
+**Props:**
+
+| Prop | Type | Default | Description |
+|------|------|---------|-------------|
+| `reporterType` | `'staff' \| 'customer'` | - | Type of reporter |
+| `reporterId` | `string` | - | Unique reporter identifier |
+| `reporterEmail` | `string` | - | Reporter's email |
+| `reporterName` | `string` | - | Reporter's display name |
+| `bugReportApi` | `object` | - | Convex API references for bug reports |
+| `feedbackApi` | `object` | - | Convex API references for feedback |
+| `position` | `object` | `{ bottom: 20, right: 20 }` | FAB position |
+| `buttonColor` | `string` | `'red'` | Button color |
+| `showFeedback` | `boolean` | `true` | Show feedback tab |
+| `onSuccess` | `function` | - | Success callback |
+| `onError` | `function` | - | Error callback |
+
+### useBugReportContext
+
+Hook to access the bug report context for error capture.
+
+```tsx
+import { useBugReportContext } from '@fatagnus/convex-feedback/react';
+
+function MyComponent() {
+  const { getConsoleErrors, clearConsoleErrors } = useBugReportContext();
+  
+  const errors = getConsoleErrors();
+  // ...
+}
+```
+
+## AI Analysis
+
+When `OPENROUTER_API_KEY` is configured, the component automatically analyzes submissions:
+
+### Bug Reports
+
+- **Summary** - Concise description of the bug
+- **Root Cause Analysis** - Potential underlying causes
+- **Reproduction Steps** - Steps to reproduce the issue
+- **Suggested Fix** - Recommended approach to resolve
+- **Estimated Effort** - Low/Medium/High effort estimate
+- **Suggested Severity** - AI-recommended severity level
+
+### Feedback
+
+- **Summary** - Concise description of the feedback
+- **Impact Analysis** - What areas/users are affected
+- **Action Items** - Concrete next steps
+- **Estimated Effort** - Low/Medium/High effort estimate
+- **Suggested Priority** - AI-recommended priority level
+
+## Email Notifications
+
+When `RESEND_API_KEY` is configured, the component sends email notifications:
+
+### To Reporters
+
+- Thank you email with submission summary
+- Professional HTML email template
+
+### To Support Teams
+
+- Full submission details with AI analysis
+- Routed based on feedback type or bug severity
+- Rich HTML template with all diagnostics
+
+## Schema
+
+The component creates these tables:
+
+- `bugReports` - Bug report submissions
+- `feedback` - Feedback submissions
+- `supportTeams` - Team configuration for notification routing
+
+## License
+
+Apache-2.0

package/dist/convex/agents/bugReportAgent.d.ts

@@ -0,0 +1,30 @@
+/**
+ * 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 { Agent } from "@convex-dev/agent";
+/**
+ * Bug Report Analysis Agent
+ *
+ * Analyzes bug report submissions and generates comprehensive analysis.
+ */
+export declare const bugReportAgent: Agent<object, {}>;
+/**
+ * Get bug report by ID for analysis
+ */
+export declare const getBugReportForAnalysis: any;
+/**
+ * Analyze bug report using AI and send notifications.
+ * This is the main entry point triggered after bug report creation.
+ */
+export declare const processBugReport: any;
+//# sourceMappingURL=bugReportAgent.d.ts.map

package/dist/convex/agents/bugReportAgent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bugReportAgent.d.ts","sourceRoot":"","sources":["../../../src/convex/agents/bugReportAgent.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAGH,OAAO,EAAE,KAAK,EAAgB,MAAM,mBAAmB,CAAC;AAsBxD;;;;GAIG;AACH,eAAO,MAAM,cAAc,mBAsCzB,CAAC;AAMH;;GAEG;AACH,eAAO,MAAM,uBAAuB,KAmClC,CAAC;AAMH;;;GAGG;AACH,eAAO,MAAM,gBAAgB,KA8I3B,CAAC"}