@veltdev/sdk 4.7.5 → 4.7.7

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

@@ -61,6 +61,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[];
@@ -71,6 +89,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/app/models/data/comment-events.data.model.d.ts

@@ -83,6 +83,8 @@ export type CommentEventTypesMap = {
     [CommentEventTypes.COMMENT_PIN_CLICKED]: CommentPinClickedEvent;
     [CommentEventTypes.COMMENT_BUBBLE_CLICKED]: CommentBubbleClickedEvent;
     [CommentEventTypes.COMPOSER_TEXT_CHANGE]: ComposerTextChangeEvent;
+    [CommentEventTypes.COMMENT_TOOL_CLICK]: CommentToolClickEvent;
+    [CommentEventTypes.SIDEBAR_BUTTON_CLICK]: SidebarButtonClickEvent;
 };
 export interface AddAttachmentEvent {
     annotationId: string;
@@ -277,3 +279,12 @@ export interface ComposerTextChangeEvent {
     targetComposerElementId: string;
     metadata?: VeltEventMetadata;
 }
+export interface CommentToolClickEvent {
+    context: {
+        [key: string]: any;
+    } | null;
+    metadata?: VeltEventMetadata;
+}
+export interface SidebarButtonClickEvent {
+    metadata?: VeltEventMetadata;
+}

package/app/models/element/comment-element.model.d.ts

@@ -9,7 +9,7 @@ import { CommentSidebarCustomActionEventData, CommentSidebarData, CommentSidebar
 export { ReactionMap } from '../data/reaction-annotation.data.model';
 import { AcceptCommentAnnotationRequest, AddAttachmentRequest, AddAttachmentResponse, AddCommentAnnotationRequest, AddCommentRequest, AddReactionRequest, ApproveCommentAnnotationRequest, AssignUserRequest, AssignUserEvent, ClearComposerRequest, CommentRequestQuery, CopyLinkRequest, DeleteAttachmentRequest, DeleteCommentAnnotationRequest, DeleteCommentRequest, DeleteReactionRequest, DeleteRecordingRequest, FetchCommentAnnotationsRequest, GetAttachmentRequest, GetCommentRequest, GetComposerDataRequest, GetLinkRequest, GetRecordingRequest, RejectCommentAnnotationRequest, ResolveCommentAnnotationRequest, SubmitCommentRequest, SubscribeCommentAnnotationRequest, ToggleReactionRequest, UnsubscribeCommentAnnotationRequest, UpdateAccessRequest, UpdateCommentRequest, UpdatePriorityRequest, UpdateStatusRequest } from "../data/comment-actions.data.model";
 import { UnreadCommentsCount, TransformContext } from "../data/comment-utils.data.model";
-import { CommentSidebarSystemFiltersOperator, SidebarButtonCountType } from "../../utils/enums";
+import { AssignToType, CommentSidebarSystemFiltersOperator, SidebarButtonCountType } from "../../utils/enums";
 import { UploadFileData } from "../data/attachment.model";
 
 export declare class CommentElement {
@@ -85,6 +85,39 @@ export declare class CommentElement {
    */
   toggleCommentSidebar: () => any;
 
+  /**
+   * To enable context in page mode composer feature
+   * When enabled, clicking comment tool will open sidebar with page mode composer and pass context
+   */
+  enableContextInPageModeComposer: () => void;
+
+  /**
+   * To disable context in page mode composer feature
+   */
+  disableContextInPageModeComposer: () => void;
+
+  /**
+   * To clear page mode composer context
+   */
+  clearPageModeComposerContext: () => void;
+
+  /**
+   * To set context in page mode composer
+   * @param context The context to set
+   */
+  setContextInPageModeComposer: (context: { [key: string]: any } | null) => void;
+
+  /**
+   * To focus the page mode composer input
+   */
+  focusPageModeComposer: () => void;
+
+  /**
+   * To set assign to type for comment dialog
+   * @param type 'dropdown' | 'checkbox'
+   */
+  setAssignToType: (type: AssignToType) => void;
+
   /**
   * To enable moderator mode
   */
@@ -2566,4 +2599,35 @@ export declare class CommentElement {
    * @returns The composer data or null if not found
    */
   private _getComposerData;
+
+  /**
+   * To enable context in page mode composer feature
+   */
+  private _enableContextInPageModeComposer;
+
+  /**
+   * To disable context in page mode composer feature
+   */
+  private _disableContextInPageModeComposer;
+
+  /**
+   * To clear page mode composer context
+   */
+  private _clearPageModeComposerContext;
+
+  /**
+   * To set context in page mode composer
+   */
+  private _setContextInPageModeComposer;
+
+  /**
+   * To focus the page mode composer input
+   */
+  private _focusPageModeComposer;
+
+  /**
+   * To set assign to type for comment dialog
+   * @param type 'dropdown' | 'checkbox'
+   */
+  private _setAssignToType;
 }

package/app/utils/enums.d.ts

@@ -58,6 +58,8 @@ export declare const CommentEventTypes: {
     readonly COMMENT_PIN_CLICKED: "commentPinClicked";
     readonly COMMENT_BUBBLE_CLICKED: "commentBubbleClicked";
     readonly COMPOSER_TEXT_CHANGE: "composerTextChange";
+    readonly COMMENT_TOOL_CLICK: "commentToolClick";
+    readonly SIDEBAR_BUTTON_CLICK: "sidebarButtonClick";
 };
 export declare const RecorderEventTypes: {
     readonly TRANSCRIPTION_DONE: "transcriptionDone";
@@ -186,6 +188,7 @@ export declare enum AnalyticsFeatures {
     COMMENT_SIDEBAR = "commentSidebar"
 }
 export type FeatureType = 'area' | 'arrow' | 'audioHuddle' | 'comment' | 'cursor' | 'huddle' | 'liveStateSync' | 'presence' | 'recorder' | 'rewriter' | 'tag' | 'liveSelection' | 'notification' | 'reaction' | 'multiThread';
+export type AssignToType = 'dropdown' | 'checkbox';
 export declare enum DeviceType {
     DESKTOP = "Desktop",
     MOBILE = "Mobile",
@@ -278,10 +281,10 @@ export type OverlayOriginY = 'top' | 'center' | 'bottom';
 export type OverlayOriginX = 'start' | 'center' | 'end';
 export type SubtitlesMode = 'floating' | 'embed';
 export type RecorderVariant = 'default' | 'embed';
-export type ReactionPinType = 'timeline' | 'comment';
+export type ReactionPinType = 'timeline' | 'comment' | 'standalone';
 export type SidebarPosition = 'left' | 'right';
 export type SidebarSortingCriteria = 'date' | 'unread' | null;
-export type SidebarFilterCriteria = 'all' | 'read' | 'unread' | 'resolved' | 'open' | 'reset' | null;
+export type SidebarFilterCriteria = 'all' | 'read' | 'unread' | 'resolved' | 'open' | 'assignedToMe' | 'reset' | null;
 export type SidebarFilterSearchType = 'people' | 'assigned' | 'tagged' | 'involved' | 'pages' | 'documents' | 'statuses' | 'priorities' | 'categories' | 'versions' | string;
 export type InlineSortingCriteria = 'createdFirst' | 'createdLast' | 'updatedFirst' | 'updatedLast';
 export type NotificationPanelMode = 'popover' | 'sidebar';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@veltdev/sdk",
-    "version": "4.7.5",
+    "version": "4.7.7",
     "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": [
@@ -36,7 +36,7 @@
     "scripts": {
         "test": "echo \"Error: no test specified\" && exit 1",
         "version:update": "node ../update-npm-package.mjs",
-        "publish:sdk": "npm publish --access public --tag v4-7-5"
+        "publish:sdk": "npm publish --access public --tag v4-7-7"
     },
     "author": "",
     "license": "ISC",