@fatagnus/convex-feedback 0.2.6 → 0.2.8

package/src/convex/tsconfig.json

@@ -0,0 +1,24 @@
+{
+  /* This TypeScript project config describes the environment that
+   *  Convex functions run in and is used for typechecking.
+   *  You can modify it, but some settings required to use Convex
+   *  cannot be changed.
+   */
+  "compilerOptions": {
+    /* Defaults from Convex */
+    "target": "ESNext",
+    "lib": ["ES2021", "dom"],
+    "skipLibCheck": true,
+    "allowSyntheticDefaultImports": true,
+    "strict": false,
+    "noEmit": true,
+    "noErrorTruncation": true,
+
+    /* Required for bundler-style imports */
+    "moduleResolution": "Bundler",
+    "module": "ESNext",
+    "isolatedModules": true
+  },
+  "include": ["./**/*"],
+  "exclude": ["node_modules"]
+}

package/src/index.ts

@@ -22,7 +22,45 @@
  * export default app;
  * ```
  *
- * 2. Set required environment variables in your Convex dashboard:
+ * 2. Register HTTP routes in your `convex/http.ts` (optional, for ticket API):
+ *
+ * ```typescript
+ * import { httpRouter } from "convex/server";
+ * import { registerFeedbackRoutes } from "@convex-dev/feedback";
+ *
+ * const http = httpRouter();
+ *
+ * // Register feedback API routes
+ * registerFeedbackRoutes(http, { pathPrefix: "/feedback" });
+ *
+ * // Your other routes...
+ * export default http;
+ * ```
+ *
+ * This registers these endpoints:
+ * - GET  /feedback/api/prompt/{ticketNumber} - Fetch AI prompt
+ * - GET  /feedback/api/items - List items
+ * - GET  /feedback/api/items/{ticketNumber} - Get single item
+ * - PATCH /feedback/api/items/{ticketNumber}/status - Update status
+ * - PATCH /feedback/api/items/{ticketNumber}/archive - Archive/unarchive
+ *
+ * 3. Pass API keys when creating bug reports/feedback:
+ *
+ * **Important:** Convex components don't inherit environment variables from the
+ * parent app. You must pass the API keys when calling the component's create
+ * mutations:
+ *
+ * ```typescript
+ * // In your parent app wrapper function:
+ * await ctx.runMutation(components.feedback.bugReports.create, {
+ *   ...args,
+ *   openRouterApiKey: process.env.OPENROUTER_API_KEY,
+ *   resendApiKey: process.env.RESEND_API_KEY,
+ *   resendFromEmail: process.env.RESEND_FROM_EMAIL,
+ * });
+ * ```
+ *
+ * The following environment variables should be set 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)
@@ -124,12 +162,22 @@ 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 type CounterType = 'bug' | 'feedback';
+export type PromptTemplate = 'fix' | 'implement' | 'analyze' | 'codebuff';
+
+// Re-export HTTP registration helper
+export { registerFeedbackRoutes } from './convex/http';
+
+// Re-export HTTP options type from types
+export type { RegisterFeedbackRoutesOptions } from './types';
 
 // Export document types
 export type {
   BugReport,
   Feedback,
   SupportTeam,
+  ApiKey,
+  ApiKeyCreated,
   // Interview types
   InterviewContext,
   FeatureArea,

package/src/types.ts

@@ -171,6 +171,7 @@ export interface InterviewState {
 export interface BugReport {
   _id: string;
   _creationTime: number;
+  ticketNumber?: string;
   title: string;
   description: string;
   severity: 'low' | 'medium' | 'high' | 'critical';
@@ -208,6 +209,7 @@ export interface BugReport {
 export interface Feedback {
   _id: string;
   _creationTime: number;
+  ticketNumber?: string;
   type: 'feature_request' | 'change_request' | 'general';
   title: string;
   description: string;
@@ -239,6 +241,31 @@ export interface Feedback {
   updatedAt: number;
 }
 
+/**
+ * API Key document type (without the actual key)
+ */
+export interface ApiKey {
+  _id: string;
+  keyPrefix: string;
+  name: string;
+  expiresAt?: number;
+  isRevoked: boolean;
+  revokedAt?: number;
+  createdAt: number;
+  isExpired: boolean;
+}
+
+/**
+ * API Key creation result (includes the full key)
+ */
+export interface ApiKeyCreated {
+  key: string;
+  keyPrefix: string;
+  name: string;
+  expiresAt: number | null;
+  createdAt: number;
+}
+
 /**
  * Support team document type
  */
@@ -253,3 +280,14 @@ export interface SupportTeam {
   createdAt: number;
   updatedAt: number;
 }
+
+/**
+ * Options for registering feedback HTTP routes
+ */
+export interface RegisterFeedbackRoutesOptions {
+  /**
+   * Optional path prefix for all routes (e.g., "/feedback" -> "/feedback/api/items")
+   * Default: "" (no prefix)
+   */
+  pathPrefix?: string;
+}