convex-feedback 0.2.0-beta.8 → 0.2.0

package/src/client/api.ts

@@ -11,7 +11,10 @@ import type {
   EntryStatus,
   EntryStatusFilter,
   FeedbackComment,
+  FeedbackActivityComment,
+  FeedbackActivityEntry,
   FeedbackEntry,
+  FeedbackReaction,
   FeedbackMetadata,
   AdminFeedbackEntry,
   EntryPriority,
@@ -56,6 +59,12 @@ export type ListEntriesArgs = {
   sort?: EntrySort;
 };
 
+/** Arguments for cursor-paginated entries created by the current actor. */
+export type ListUserEntriesArgs = {
+  /** Convex cursor-pagination options. */
+  paginationOpts: PaginationOptions;
+};
+
 /**
  * Arguments for retrieving one entry.
  */
@@ -168,6 +177,17 @@ export type UpdateEntryArgs = {
   body: string;
 };
 
+/**
+ * Arguments for permanently deleting an entry as an administrator.
+ *
+ * Deletion hides the entry immediately and finishes dependent-document
+ * cleanup in bounded scheduled batches before the entry is hard-deleted.
+ */
+export type DeleteEntryArgs = {
+  /** Entry to delete. */
+  entryId: string;
+};
+
 /**
  * Arguments for changing an entry workflow status.
  */
@@ -184,6 +204,7 @@ export type AdminListEntriesArgs = {
   paginationOpts: PaginationOptions;
   kinds?: EntryKind[];
   status?: EntryStatus;
+  statusFilter?: EntryStatusFilter;
   priority?: EntryPriority;
 };
 
@@ -201,6 +222,10 @@ export type ListRoadmapArgs = {
   paginationOpts: PaginationOptions;
   status?: RoadmapStatus;
 };
+export type GetRoadmapItemArgs = {
+  /** Identifier returned by the component for the requested roadmap item. */
+  roadmapId: string;
+};
 export type SearchRoadmapArgs = { searchQuery: string; limit?: number };
 export type CreateRoadmapArgs = {
   title: string;
@@ -289,6 +314,18 @@ export type ListCommentsArgs = {
   sort?: CommentSort;
 };
 
+/** Arguments for cursor-paginated comments created by the current actor. */
+export type ListUserCommentsArgs = {
+  /** Convex cursor-pagination options. */
+  paginationOpts: PaginationOptions;
+};
+
+/** Arguments for cursor-paginated reactions created by the current actor. */
+export type ListUserReactionsArgs = {
+  /** Convex cursor-pagination options. */
+  paginationOpts: PaginationOptions;
+};
+
 /**
  * Arguments for creating a top-level comment or reply.
  */
@@ -318,11 +355,9 @@ export type UpdateCommentArgs = {
   body: string;
 };
 
-/**
- * Arguments for soft-deleting a comment.
- */
+/** Arguments for permanently deleting a comment and its descendants. */
 export type DeleteCommentArgs = {
-  /** Comment to soft-delete. */
+  /** Comment subtree to delete. */
   commentId: string;
 };
 
@@ -364,10 +399,13 @@ export type SetCommentLikeResult = {
  * @typeParam RateLimitResult A validated rejection value returned by mutations
  * when non-throwing rate limiting is configured. The default `never` preserves
  * the original success-only mutation results.
+ * @typeParam CallbackRejectionResult A validated rejection value returned only
+ * by create mutations when callback return mode is configured.
  */
 export interface FeedbackPublicApi<
   Name extends string | undefined = string | undefined,
   RateLimitResult = never,
+  CallbackRejectionResult = never,
 > {
   /** Returns whether the host actor has admin permissions. */
   isAdmin: FunctionReference<
@@ -396,6 +434,15 @@ export interface FeedbackPublicApi<
     Name
   >;
 
+  /** Returns entries created by the authenticated actor. */
+  listUserEntries: FunctionReference<
+    "query",
+    "public",
+    ListUserEntriesArgs,
+    PaginationResult<FeedbackActivityEntry>,
+    Name
+  >;
+
   /** Returns one entry or `null` when it does not exist. */
   getEntry: FunctionReference<
     "query",
@@ -428,7 +475,7 @@ export interface FeedbackPublicApi<
     "mutation",
     "public",
     CreateEntryArgs,
-    string | RateLimitResult,
+    string | RateLimitResult | CallbackRejectionResult,
     Name
   >;
 
@@ -441,6 +488,15 @@ export interface FeedbackPublicApi<
     Name
   >;
 
+  /** Starts permanent entry deletion; cleanup runs in bounded background batches. */
+  deleteEntry: FunctionReference<
+    "mutation",
+    "public",
+    DeleteEntryArgs,
+    null | RateLimitResult,
+    Name
+  >;
+
   /** Changes entry status, or returns a configured rate-limit rejection. */
   setEntryStatus: FunctionReference<
     "mutation",
@@ -486,6 +542,14 @@ export interface FeedbackPublicApi<
     PaginationResult<RoadmapItem>,
     Name
   >;
+  /** Returns one roadmap item or `null` when it does not exist. */
+  getRoadmapItem: FunctionReference<
+    "query",
+    "public",
+    GetRoadmapItemArgs,
+    RoadmapItem | null,
+    Name
+  >;
   searchRoadmap: FunctionReference<
     "query",
     "public",
@@ -568,12 +632,30 @@ export interface FeedbackPublicApi<
     Name
   >;
 
+  /** Returns comments created by the authenticated actor. */
+  listUserComments: FunctionReference<
+    "query",
+    "public",
+    ListUserCommentsArgs,
+    PaginationResult<FeedbackActivityComment>,
+    Name
+  >;
+
+  /** Returns reactions created by the authenticated actor. */
+  listUserReactions: FunctionReference<
+    "query",
+    "public",
+    ListUserReactionsArgs,
+    PaginationResult<FeedbackReaction>,
+    Name
+  >;
+
   /** Creates a comment/reply, returning its ID or a rate-limit rejection. */
   createComment: FunctionReference<
     "mutation",
     "public",
     CreateCommentArgs,
-    string | RateLimitResult,
+    string | RateLimitResult | CallbackRejectionResult,
     Name
   >;
 
@@ -586,7 +668,7 @@ export interface FeedbackPublicApi<
     Name
   >;
 
-  /** Soft-deletes a comment, or returns a configured rate-limit rejection. */
+  /** Permanently deletes a comment subtree, or returns a configured rate-limit rejection. */
   deleteComment: FunctionReference<
     "mutation",
     "public",

package/src/client/config.ts

@@ -86,9 +86,7 @@ export interface FeedbackCommentsConfig {
   editableByAuthor: boolean;
 
   /**
-   * Whether comment authors may soft-delete their own comments.
-   *
-   * Deletion preserves the document so nested replies retain their structure.
+   * Whether comment authors may permanently delete their own comments.
    *
    * @default true
    */