@veltdev/sdk-staging 5.0.0-beta.11 → 5.0.0-beta.12

package/app/models/data/comment-actions.data.model.d.ts

@@ -81,6 +81,24 @@ export interface DeleteCommentAnnotationRequest {
     annotationId: string;
     options?: RequestOptions;
 }
+/**
+ * Query parameters for fetching comment annotation counts.
+ *
+ * @property organizationId - Filter by organization (enables org-wide aggregation when used alone)
+ * @property documentIds - Filter by specific document IDs
+ * @property locationIds - Filter by location IDs within documents
+ * @property statusIds - Filter by comment status IDs (e.g., "open", "resolved")
+ * @property folderId - Filter by folder ID (use with allDocuments for folder-wide counts)
+ * @property allDocuments - When true with folderId, aggregates all documents in folder
+ * @property locationId - Single location filter (deprecated, use locationIds)
+ * @property aggregateDocuments - When true, combines all documentIds into single count
+ * @property filterGhostComments - When true, excludes orphaned/deleted comments from counts
+ * @property batchedPerDocument - When true, uses efficient batched listeners (4 instead of 100)
+ *                                but still returns per-document counts. Best for large document lists (50+).
+ *                                Trade-off: slight delay on updates due to debouncing.
+ * @property debounceMs - Debounce time in milliseconds for batchedPerDocument mode (default: 5000ms).
+ *                        Prevents rapid re-fetches when multiple documents update in quick succession.
+ */
 export interface CommentRequestQuery {
     organizationId?: string;
     documentIds?: string[];
@@ -91,6 +109,10 @@ export interface CommentRequestQuery {
     locationId?: string;
     aggregateDocuments?: boolean;
     filterGhostComments?: boolean;
+    /** Enable batched listeners with per-document counts. Uses 4 listeners instead of N listeners. */
+    batchedPerDocument?: boolean;
+    /** Debounce time in ms for batchedPerDocument mode (default: 5000). */
+    debounceMs?: number;
 }
 export interface SubscribeCommentAnnotationRequest {
     annotationId: string;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@veltdev/sdk-staging",
-    "version": "5.0.0-beta.11",
+    "version": "5.0.0-beta.12",
     "description": "Velt is an SDK to add collaborative features to your product within minutes. Example: Comments like Figma, Frame.io, Google docs or sheets, Recording like Loom, Huddles like Slack and much more.",
     "homepage": "https://velt.dev",
     "keywords": [