convex-feedback 0.1.3 → 0.1.5

package/src/component/model.ts

@@ -16,6 +16,11 @@ export const entryStatusValidator = v.union(
   v.literal("closed"),
 );
 
+export const entryStatusFilterValidator = v.union(
+  v.literal("open"),
+  v.literal("closed"),
+);
+
 export const entrySortValidator = v.union(
   v.literal("top"),
   v.literal("newest"),
@@ -32,6 +37,22 @@ export const actorValidator = v.object({
   isModerator: v.boolean(),
 });
 
+export const feedbackMetadataValueValidator = v.union(
+  v.string(),
+  v.number(),
+  v.boolean(),
+);
+
+export const feedbackMetadataRecordValidator = v.record(
+  v.string(),
+  feedbackMetadataValueValidator,
+);
+
+export const feedbackMetadataValidator = v.object({
+  standard: v.optional(feedbackMetadataRecordValidator),
+  additional: v.optional(feedbackMetadataRecordValidator),
+});
+
 export const publicEntryValidator = v.object({
   id: v.string(),
   creationTime: v.number(),
@@ -44,6 +65,7 @@ export const publicEntryValidator = v.object({
   commentCount: v.number(),
   updatedAt: v.optional(v.number()),
   viewerHasUpvoted: v.boolean(),
+  metadata: v.optional(feedbackMetadataValidator),
 });
 
 export const publicCommentValidator = v.object({
@@ -83,6 +105,15 @@ export type EntryKind = Infer<typeof entryKindValidator>;
  */
 export type EntryStatus = Infer<typeof entryStatusValidator>;
 
+/** Coarse status bucket used by the indexed board and search filters. */
+export type EntryStatusFilter = Infer<typeof entryStatusFilterValidator>;
+
+export function entryStatusFilterForStatus(
+  status: EntryStatus,
+): EntryStatusFilter {
+  return status === "closed" ? "closed" : "open";
+}
+
 /**
  * Server-side ordering strategy for feedback entries.
  *
@@ -119,6 +150,14 @@ export type CommentSort = Infer<typeof commentSortValidator>;
  */
 export type FeedbackActor = Infer<typeof actorValidator>;
 
+/** Scalar value accepted in entry diagnostic metadata. */
+export type FeedbackMetadataValue = Infer<
+  typeof feedbackMetadataValueValidator
+>;
+
+/** Flat metadata values grouped by their source. */
+export type FeedbackMetadata = Infer<typeof feedbackMetadataValidator>;
+
 /**
  * Public representation of a feedback, feature-request, or bug-report entry.
  *
@@ -157,6 +196,11 @@ export type FeedbackActor = Infer<typeof actorValidator>;
  * @property viewerHasUpvoted
  * Whether the actor associated with the current query has upvoted the entry.
  * `false` when no viewer actor is available.
+ *
+ * @property metadata
+ * Creation-time diagnostic metadata. Present only when `getEntry` is queried
+ * by a moderator. Ordinary entry lists, searches, and non-moderator reads omit
+ * this property.
  */
 export type FeedbackEntry = Infer<typeof publicEntryValidator>;
 

package/src/component/schema.ts

@@ -1,13 +1,19 @@
 import { defineSchema, defineTable } from "convex/server";
 import { v } from "convex/values";
 
-import { entryKindValidator, entryStatusValidator } from "./model.js";
+import {
+  entryKindValidator,
+  entryStatusFilterValidator,
+  entryStatusValidator,
+  feedbackMetadataValidator,
+} from "./model.js";
 
 const schema = defineSchema({
   entries: defineTable({
     actorId: v.string(),
     kind: entryKindValidator,
     status: entryStatusValidator,
+    statusFilter: v.optional(entryStatusFilterValidator),
     title: v.string(),
     body: v.string(),
     normalizedTitle: v.string(),
@@ -15,19 +21,28 @@ const schema = defineSchema({
     upvoteCount: v.number(),
     commentCount: v.number(),
     updatedAt: v.optional(v.number()),
+    metadata: v.optional(feedbackMetadataValidator),
   })
     .index("by_kind", ["kind"])
     .index("by_status", ["status"])
     .index("by_kind_status", ["kind", "status"])
+    .index("by_status_filter", ["statusFilter"])
+    .index("by_kind_status_filter", ["kind", "statusFilter"])
     .index("by_upvotes", ["upvoteCount"])
     .index("by_kind_upvotes", ["kind", "upvoteCount"])
     .index("by_status_upvotes", ["status", "upvoteCount"])
     .index("by_kind_status_upvotes", ["kind", "status", "upvoteCount"])
+    .index("by_status_filter_upvotes", ["statusFilter", "upvoteCount"])
+    .index("by_kind_status_filter_upvotes", [
+      "kind",
+      "statusFilter",
+      "upvoteCount",
+    ])
     .index("by_normalized_title", ["normalizedTitle"])
     .index("by_kind_normalized_title", ["kind", "normalizedTitle"])
     .searchIndex("search", {
       searchField: "searchText",
-      filterFields: ["kind", "status"],
+      filterFields: ["kind", "status", "statusFilter"],
     }),
 
   comments: defineTable({

package/src/react/index.ts

@@ -9,6 +9,7 @@ import type {
   EntryKind,
   EntrySort,
   EntryStatus,
+  EntryStatusFilter,
   SimilarEntriesResult,
 } from "../component/model.js";
 
@@ -61,6 +62,9 @@ export interface UseEntriesArgs {
   /** Optional workflow-status filter. */
   status?: EntryStatus;
 
+  /** Optional indexed open or closed board bucket. */
+  statusFilter?: EntryStatusFilter;
+
   /**
    * Server-side entry ordering.
    *
@@ -120,6 +124,9 @@ export interface SearchEntriesArgs {
   /** Optional workflow-status filter. */
   status?: EntryStatus;
 
+  /** Optional indexed open or closed board bucket. */
+  statusFilter?: EntryStatusFilter;
+
   /**
    * Maximum number of results requested.
    *
@@ -212,6 +219,9 @@ function createFeedbackHooksImplementation<RateLimitResult>(
       const queryArgs = {
         ...(args.kinds === undefined ? {} : { kinds: [...args.kinds] }),
         ...(args.status === undefined ? {} : { status: args.status }),
+        ...(args.statusFilter === undefined
+          ? {}
+          : { statusFilter: args.statusFilter }),
         ...(args.sort === undefined ? {} : { sort: args.sort }),
       };
 
@@ -244,6 +254,9 @@ function createFeedbackHooksImplementation<RateLimitResult>(
         searchQuery,
         ...(args.kinds === undefined ? {} : { kinds: [...args.kinds] }),
         ...(args.status === undefined ? {} : { status: args.status }),
+        ...(args.statusFilter === undefined
+          ? {}
+          : { statusFilter: args.statusFilter }),
         ...(args.limit === undefined ? {} : { limit: args.limit }),
       };