@fatagnus/convex-feedback 0.1.0

package/src/convex/supportTeams.ts

@@ -0,0 +1,179 @@
+import { v } from "convex/values";
+import { mutation, query, internalQuery } from "./_generated/server";
+import {
+  feedbackTypeValidator,
+  bugSeverityValidator,
+} from "./schema";
+
+// Return type for support team records
+const supportTeamReturnValidator = v.object({
+  _id: v.id("supportTeams"),
+  _creationTime: v.number(),
+  teamName: v.string(),
+  memberEmails: v.array(v.string()),
+  feedbackTypes: v.array(feedbackTypeValidator),
+  bugReportSeverities: v.array(bugSeverityValidator),
+  isActive: v.boolean(),
+  createdAt: v.number(),
+  updatedAt: v.number(),
+});
+
+/**
+ * List all support teams.
+ */
+export const list = query({
+  args: {
+    activeOnly: v.optional(v.boolean()),
+  },
+  returns: v.array(supportTeamReturnValidator),
+  handler: async (ctx, args) => {
+    if (args.activeOnly) {
+      return await ctx.db
+        .query("supportTeams")
+        .withIndex("by_active", (q) => q.eq("isActive", true))
+        .collect();
+    }
+    return await ctx.db.query("supportTeams").collect();
+  },
+});
+
+/**
+ * Get a support team by ID.
+ */
+export const get = query({
+  args: {
+    teamId: v.id("supportTeams"),
+  },
+  returns: v.union(supportTeamReturnValidator, v.null()),
+  handler: async (ctx, args) => {
+    return await ctx.db.get(args.teamId);
+  },
+});
+
+/**
+ * Internal query to find all active teams that handle a given feedback type.
+ */
+export const getTeamsForFeedbackType = internalQuery({
+  args: {
+    feedbackType: feedbackTypeValidator,
+  },
+  returns: v.array(supportTeamReturnValidator),
+  handler: async (ctx, args) => {
+    const allTeams = await ctx.db
+      .query("supportTeams")
+      .withIndex("by_active", (q) => q.eq("isActive", true))
+      .collect();
+
+    return allTeams.filter((team) =>
+      team.feedbackTypes.includes(args.feedbackType)
+    );
+  },
+});
+
+/**
+ * Internal query to find all active teams that handle a given bug report severity.
+ */
+export const getTeamsForBugReportSeverity = internalQuery({
+  args: {
+    severity: bugSeverityValidator,
+  },
+  returns: v.array(supportTeamReturnValidator),
+  handler: async (ctx, args) => {
+    const allTeams = await ctx.db
+      .query("supportTeams")
+      .withIndex("by_active", (q) => q.eq("isActive", true))
+      .collect();
+
+    return allTeams.filter((team) =>
+      team.bugReportSeverities.includes(args.severity)
+    );
+  },
+});
+
+/**
+ * Create a new support team.
+ */
+export const create = mutation({
+  args: {
+    teamName: v.string(),
+    memberEmails: v.array(v.string()),
+    feedbackTypes: v.array(feedbackTypeValidator),
+    bugReportSeverities: v.array(bugSeverityValidator),
+  },
+  returns: v.id("supportTeams"),
+  handler: async (ctx, args) => {
+    const now = Date.now();
+    return await ctx.db.insert("supportTeams", {
+      teamName: args.teamName,
+      memberEmails: args.memberEmails,
+      feedbackTypes: args.feedbackTypes,
+      bugReportSeverities: args.bugReportSeverities,
+      isActive: true,
+      createdAt: now,
+      updatedAt: now,
+    });
+  },
+});
+
+/**
+ * Update a support team.
+ */
+export const update = mutation({
+  args: {
+    teamId: v.id("supportTeams"),
+    teamName: v.optional(v.string()),
+    memberEmails: v.optional(v.array(v.string())),
+    feedbackTypes: v.optional(v.array(feedbackTypeValidator)),
+    bugReportSeverities: v.optional(v.array(bugSeverityValidator)),
+    isActive: v.optional(v.boolean()),
+  },
+  returns: v.null(),
+  handler: async (ctx, args) => {
+    const team = await ctx.db.get(args.teamId);
+    if (!team) {
+      throw new Error("Support team not found");
+    }
+
+    const updates: Record<string, unknown> = {
+      updatedAt: Date.now(),
+    };
+
+    if (args.teamName !== undefined) {
+      updates.teamName = args.teamName;
+    }
+    if (args.memberEmails !== undefined) {
+      updates.memberEmails = args.memberEmails;
+    }
+    if (args.feedbackTypes !== undefined) {
+      updates.feedbackTypes = args.feedbackTypes;
+    }
+    if (args.bugReportSeverities !== undefined) {
+      updates.bugReportSeverities = args.bugReportSeverities;
+    }
+    if (args.isActive !== undefined) {
+      updates.isActive = args.isActive;
+    }
+
+    await ctx.db.patch(args.teamId, updates);
+    return null;
+  },
+});
+
+/**
+ * Delete a support team.
+ */
+export const remove = mutation({
+  args: {
+    teamId: v.id("supportTeams"),
+  },
+  returns: v.null(),
+  handler: async (ctx, args) => {
+    const team = await ctx.db.get(args.teamId);
+    if (!team) {
+      throw new Error("Support team not found");
+    }
+
+    await ctx.db.delete(args.teamId);
+    return null;
+  },
+});

package/src/index.ts

@@ -0,0 +1,77 @@
+/**
+ * @convex-dev/feedback
+ *
+ * Bug reports and feedback collection component for Convex applications.
+ *
+ * ## Installation
+ *
+ * ```bash
+ * npm install @convex-dev/feedback
+ * ```
+ *
+ * ## Setup
+ *
+ * 1. Add the component to your `convex/convex.config.ts`:
+ *
+ * ```typescript
+ * import { defineApp } from "convex/server";
+ * import feedback from "@convex-dev/feedback/convex.config";
+ *
+ * const app = defineApp();
+ * app.use(feedback);
+ * export default app;
+ * ```
+ *
+ * 2. Set required environment variables in your Convex dashboard:
+ * - `OPENROUTER_API_KEY` - For AI analysis (optional)
+ * - `RESEND_API_KEY` - For email notifications (optional)
+ * - `RESEND_FROM_EMAIL` - From address for emails (optional)
+ *
+ * ## Usage
+ *
+ * ### Convex Functions
+ *
+ * The component exposes these functions through `api.feedback`:
+ *
+ * - `api.feedback.bugReports.create` - Create a bug report
+ * - `api.feedback.bugReports.list` - List bug reports
+ * - `api.feedback.bugReports.get` - Get a bug report by ID
+ * - `api.feedback.bugReports.updateStatus` - Update bug report status
+ * - `api.feedback.bugReports.archive` - Archive a bug report
+ * - `api.feedback.bugReports.unarchive` - Unarchive a bug report
+ *
+ * - `api.feedback.feedback.create` - Create feedback
+ * - `api.feedback.feedback.list` - List feedback
+ * - `api.feedback.feedback.get` - Get feedback by ID
+ * - `api.feedback.feedback.updateStatus` - Update feedback status
+ *
+ * - `api.feedback.supportTeams.list` - List support teams
+ * - `api.feedback.supportTeams.create` - Create a support team
+ * - `api.feedback.supportTeams.update` - Update a support team
+ *
+ * ### React Components
+ *
+ * Import from `@convex-dev/feedback/react`:
+ *
+ * ```tsx
+ * import { BugReportProvider, BugReportButton } from '@convex-dev/feedback/react';
+ * ```
+ *
+ * @module
+ */
+
+// Type definitions
+export type BugSeverity = 'low' | 'medium' | 'high' | 'critical';
+export type BugStatus = 'open' | 'in-progress' | 'resolved' | 'closed';
+export type FeedbackType = 'feature_request' | 'change_request' | 'general';
+export type FeedbackPriority = 'nice_to_have' | 'important' | 'critical';
+export type FeedbackStatus = 'open' | 'under_review' | 'planned' | 'in_progress' | 'completed' | 'declined';
+export type ReporterType = 'staff' | 'customer';
+export type Effort = 'low' | 'medium' | 'high';
+
+// Export document types
+export type {
+  BugReport,
+  Feedback,
+  SupportTeam,
+} from './types';