@veltdev/sdk 5.0.0-beta.1 → 5.0.0-beta.11

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

@@ -41,9 +41,31 @@ export interface CopyLinkRequest {
     annotationId: string;
     options?: RequestOptions;
 }
+/**
+ * Visibility type for comment annotations.
+ * - 'public': Visible to everyone (default:velt)
+ * - 'organization': Visible only to users in the specified organization
+ * - 'self': Visible only to specified users (private comments)
+ */
+export type CommentVisibilityType = 'public' | 'organization' | 'self';
+/**
+ * Configuration for comment visibility/access control.
+ */
+export interface CommentVisibilityConfig {
+    /** The type of visibility for the comment */
+    type: CommentVisibilityType;
+    /** Annotation ID for the comment to update visibility */
+    annotationId?: string;
+    /** Organization ID for 'organization' type visibility */
+    organizationId?: string;
+    /** User IDs for 'self' type visibility - array of user IDs who can see the comment */
+    userIds?: string[];
+}
 export interface AddCommentAnnotationRequest {
     annotation: CommentAnnotation;
     options?: RequestOptions;
+    /** Optional visibility configuration for the comment */
+    visibility?: CommentVisibilityConfig;
 }
 export interface ApproveCommentAnnotationRequest {
     annotationId: string;
@@ -61,6 +83,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 +111,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

@@ -54,6 +54,7 @@ export interface CommentSuggestionEventData {
 }
 export type CommentEventTypesMap = {
     [CommentEventTypes.ADD_COMMENT_ANNOTATION]: AddCommentAnnotationEvent;
+    [CommentEventTypes.ADD_COMMENT_ANNOTATION_DRAFT]: AddCommentAnnotationDraftEvent;
     [CommentEventTypes.APPROVE_COMMENT_ANNOTATION]: ApproveCommentAnnotationEvent;
     [CommentEventTypes.ACCEPT_COMMENT_ANNOTATION]: AcceptCommentAnnotationEvent;
     [CommentEventTypes.REJECT_COMMENT_ANNOTATION]: RejectCommentAnnotationEvent;
@@ -79,6 +80,7 @@ export type CommentEventTypesMap = {
     [CommentEventTypes.COMMENT_SIDEBAR_DATA_UPDATE]: CommentSidebarDataUpdateEvent;
     [CommentEventTypes.AUTOCOMPLETE_SEARCH]: AutocompleteSearchEvent;
     [CommentEventTypes.COMPOSER_CLICKED]: ComposerClickedEvent;
+    [CommentEventTypes.COMPOSER_TEXT_CHANGE]: ComposerTextChangeEvent;
     [CommentEventTypes.LINK_CLICKED]: LinkClickedEvent;
     [CommentEventTypes.COMMENT_PIN_CLICKED]: CommentPinClickedEvent;
     [CommentEventTypes.COMMENT_BUBBLE_CLICKED]: CommentBubbleClickedEvent;
@@ -96,6 +98,10 @@ export interface DeleteAttachmentEvent {
     attachment: Attachment;
     metadata: VeltEventMetadata;
 }
+export interface AddCommentAnnotationDraftEvent {
+    metadata: VeltEventMetadata;
+    addContext: (context: Record<string, unknown>) => void;
+}
 export interface AddCommentAnnotationEvent {
     annotationId: string;
     commentAnnotation: CommentAnnotation;
@@ -270,3 +276,7 @@ export interface CommentBubbleClickedEvent {
     commentAnnotation: CommentAnnotation;
     metadata?: VeltEventMetadata;
 }
+export interface ComposerTextChangeEvent {
+    text: string;
+    metadata?: VeltEventMetadata;
+}

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

@@ -1,3 +1,4 @@
+import { Location } from './location.model';
 export interface IUnreadCommentsMap {
     [annotationId: string]: number;
 }
@@ -14,3 +15,28 @@ export interface TransformContext {
         inverseScale?: number;
     };
 }
+/**
+ * Context data returned by the comment context provider.
+ * This is a flexible object that can contain custom properties.
+ */
+export interface CommentContext {
+    /**
+     * Optional comment type. When set to 'manual', the comment will be treated as a manual comment
+     * and the target element will be removed.
+     */
+    commentType?: 'manual' | string;
+    /**
+     * Allow additional custom properties
+     */
+    [key: string]: unknown;
+}
+export type CommentContextProviderResponse = CommentContext | null | undefined;
+/**
+ * A function that provides custom context for comments.
+ * Can return the context synchronously or asynchronously via a Promise.
+ *
+ * @param documentId - The ID of the document
+ * @param location - Optional location information
+ * @returns The comment context object or a Promise that resolves to it
+ */
+export type CommentContextProvider = (documentId: string, location?: Location) => CommentContextProviderResponse | Promise<CommentContextProviderResponse>;

package/app/models/data/config.data.model.d.ts

@@ -53,6 +53,14 @@ export declare class Config {
      * The domain of the API proxy.
      */
     apiProxyDomain?: string;
+    /**
+     * Controls whether global Velt styles are loaded.
+     * When true (default), global styles are applied.
+     * When false, global styles are not loaded - useful for custom styling.
+     *
+     * Default: true
+     */
+    globalStyles?: boolean;
 }
 export interface ExtendedFirebaseOptions extends FirebaseOptions {
     storeDbId: string;
@@ -66,3 +74,6 @@ export interface DisableLogsConfig {
     warnings?: boolean;
     suppressAll?: boolean;
 }
+export interface GetProjectConfigResponse {
+    isPrivateCommentsEnabled: boolean;
+}

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

@@ -1,16 +1,16 @@
 // @ts-nocheck
 import { Observable } from "rxjs";
-import { CommentAnnotation, CommentOnElementConfig, CommentSelectionChangeData, ManualCommentAnnotationConfig, UpdateContextConfig } from "../data/comment-annotation.data.model";
-import { AcceptCommentAnnotationEvent, AddCommentAnnotationEvent, AddCommentEvent, AddReactionEvent, ApproveCommentAnnotationEvent, CommentAddEventData, CommentEventTypesMap, CommentUpdateEventData, CopyLinkEvent, DeleteAttachmentEvent, DeleteCommentAnnotationEvent, DeleteCommentEvent, DeleteReactionEvent, DeleteRecordingEvent, GetLinkEvent, RejectCommentAnnotationEvent, ToggleReactionEvent, UpdateAccessEvent, UpdateCommentEvent, UpdatePriorityEvent, UpdateStatusEvent, GetCommentAnnotationsResponse, GetCommentAnnotationsCountResponse, FetchCommentAnnotationsResponse } from "../data/comment-events.data.model";
-import { CustomCategory, CustomPriority, CustomStatus } from "../data/custom-filter.data.model";
-import { CustomAnnotationDropdownData } from "../data/custom-chip-dropdown.data.model";
+import { CommentSidebarSystemFiltersOperator, SidebarButtonCountType } from "../../utils/enums";
+import { UploadFileData } from "../data/attachment.model";
 import { AutocompleteData } from "../data/autocomplete.data.model";
+import { AcceptCommentAnnotationRequest, AddAttachmentRequest, AddAttachmentResponse, AddCommentAnnotationRequest, AddCommentRequest, AddReactionRequest, ApproveCommentAnnotationRequest, AssignUserEvent, AssignUserRequest, CommentRequestQuery, CommentVisibilityConfig, CopyLinkRequest, DeleteAttachmentRequest, DeleteCommentAnnotationRequest, DeleteCommentRequest, DeleteReactionRequest, DeleteRecordingRequest, FetchCommentAnnotationsRequest, GetAttachmentRequest, GetCommentRequest, GetLinkRequest, GetRecordingRequest, RejectCommentAnnotationRequest, ResolveCommentAnnotationRequest, SubscribeCommentAnnotationRequest, ToggleReactionRequest, UnsubscribeCommentAnnotationRequest, UpdateAccessRequest, UpdateCommentRequest, UpdatePriorityRequest, UpdateStatusRequest } from "../data/comment-actions.data.model";
+import { CommentAnnotation, CommentOnElementConfig, CommentSelectionChangeData, ManualCommentAnnotationConfig, UpdateContextConfig } from "../data/comment-annotation.data.model";
+import { AcceptCommentAnnotationEvent, AddCommentAnnotationEvent, AddCommentEvent, AddReactionEvent, ApproveCommentAnnotationEvent, CommentAddEventData, CommentEventTypesMap, CommentUpdateEventData, CopyLinkEvent, DeleteAttachmentEvent, DeleteCommentAnnotationEvent, DeleteCommentEvent, DeleteReactionEvent, DeleteRecordingEvent, FetchCommentAnnotationsResponse, GetCommentAnnotationsCountResponse, GetCommentAnnotationsResponse, GetLinkEvent, RejectCommentAnnotationEvent, ToggleReactionEvent, UpdateAccessEvent, UpdateCommentEvent, UpdatePriorityEvent, UpdateStatusEvent } from "../data/comment-events.data.model";
 import { CommentSidebarCustomActionEventData, CommentSidebarData, CommentSidebarDataOptions } from "../data/comment-sidebar-config.model";
+import { CommentContextProvider, TransformContext, UnreadCommentsCount } from "../data/comment-utils.data.model";
+import { CustomAnnotationDropdownData } from "../data/custom-chip-dropdown.data.model";
+import { CustomCategory, CustomPriority, CustomStatus } from "../data/custom-filter.data.model";
 export { ReactionMap } from '../data/reaction-annotation.data.model';
-import { AcceptCommentAnnotationRequest, AddAttachmentRequest, AddAttachmentResponse, AddCommentAnnotationRequest, AddCommentRequest, AddReactionRequest, ApproveCommentAnnotationRequest, AssignUserRequest, AssignUserEvent, CopyLinkRequest, DeleteAttachmentRequest, DeleteCommentAnnotationRequest, CommentRequestQuery, CommentRequestQuery, DeleteCommentRequest, DeleteReactionRequest, DeleteRecordingRequest, GetAttachmentRequest, GetCommentRequest, GetLinkRequest, GetRecordingRequest, RejectCommentAnnotationRequest, ResolveCommentAnnotationRequest, SubscribeCommentAnnotationRequest, UnsubscribeCommentAnnotationRequest, ToggleReactionRequest, UpdateAccessRequest, UpdateCommentRequest, UpdatePriorityRequest, UpdateStatusRequest, FetchCommentAnnotationsRequest } from "../data/comment-actions.data.model";
-import { UnreadCommentsCount, TransformContext } from "../data/comment-utils.data.model";
-import { CommentSidebarSystemFiltersOperator, SidebarButtonCountType } from "../../utils/enums";
-import { UploadFileData } from "../data/attachment.model";
 
 export declare class CommentElement {
   /**
@@ -329,7 +329,7 @@ export declare class CommentElement {
    * @description Sets the comment context provider
    * @param provider
    */
-  public setContextProvider: (provider: (documentId: string, location?: any) => any) => void;
+  public setContextProvider: (provider: CommentContextProvider | null) => void;
 
   /**
    * To enable suggestion mode
@@ -823,6 +823,13 @@ export declare class CommentElement {
    */
   public updateContext: (annotationId: string, context: any, config?: UpdateContextConfig) => Promise<any>;
 
+  /**
+   * Updates the visibility of a comment annotation.
+   * @param visibility Visibility configuration (public, organization, or self) including annotationId
+   * @returns Promise<any>
+   */
+  public updateVisibility: (visibility: CommentVisibilityConfig) => Promise<any>;
+
   /**
    * Subscribe to selected comments
    * @returns list of selected comments
@@ -1264,6 +1271,13 @@ export declare class CommentElement {
    */
   public disableScreenshot: () => void;
 
+  /**
+   * To programmatically submit a comment from a velt-comment-composer.
+   * Finds the composer within the element identified by referenceId and submits its content.
+   * @param referenceId The ID of the HTML element containing the velt-comment-composer
+   */
+  public submitComment: (referenceId: string) => void;
+
   /**
    * To enable paginated contact list
    */
@@ -2075,6 +2089,14 @@ export declare class CommentElement {
    */
   private _updateContext;
 
+  /**
+   * Updates the visibility of a comment annotation.
+   * @param annotationId Annotation Id
+   * @param visibility Visibility configuration (public, organization, or self)
+   * @returns Promise<any>
+   */
+  private _updateVisibility;
+
   /**
    * Subscribe to selected comments
    * @returns list of selected comments
@@ -2526,4 +2548,11 @@ export declare class CommentElement {
    * To disable paginated contact list
    */
   private _disablePaginatedContactList;
+
+  /**
+   * To programmatically submit a comment from a velt-comment-composer.
+   * Finds the composer within the element identified by referenceId and submits its content.
+   * @param referenceId The ID of the HTML element containing the velt-comment-composer
+   */
+  private _submitComment;
 }

package/app/utils/constants.d.ts

@@ -11,6 +11,7 @@ export declare class Constants {
     static LISTENER_BATCH_SIZE: number;
     static LISTENER_CONTEXT_BATCH_SIZE: number;
     static DEFAULT_VELT_CONTEXT: string;
+    static VISIBILITY_SELF_PREFIX: string;
     static FIREBASE_PARTIAL_PATH_ORGANIZATIONS: string;
     static FIREBASE_PARTIAL_PATH_FOLDERS: string;
     static FIREBASE_PARTIAL_PATH_DOCS: string;

package/app/utils/enums.d.ts

@@ -29,6 +29,7 @@ export declare enum ResolverActions {
 }
 export declare const CommentEventTypes: {
     readonly ADD_COMMENT_ANNOTATION: "addCommentAnnotation";
+    readonly ADD_COMMENT_ANNOTATION_DRAFT: "addCommentAnnotationDraft";
     readonly DELETE_COMMENT_ANNOTATION: "deleteCommentAnnotation";
     readonly APPROVE_COMMENT_ANNOTATION: "approveCommentAnnotation";
     readonly ACCEPT_COMMENT_ANNOTATION: "acceptCommentAnnotation";
@@ -54,6 +55,7 @@ export declare const CommentEventTypes: {
     readonly COMMENT_SIDEBAR_DATA_UPDATE: "commentSidebarDataUpdate";
     readonly AUTOCOMPLETE_SEARCH: "autocompleteSearch";
     readonly COMPOSER_CLICKED: "composerClicked";
+    readonly COMPOSER_TEXT_CHANGE: "composerTextChange";
     readonly LINK_CLICKED: "linkClicked";
     readonly COMMENT_PIN_CLICKED: "commentPinClicked";
     readonly COMMENT_BUBBLE_CLICKED: "commentBubbleClicked";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@veltdev/sdk",
-    "version": "5.0.0-beta.1",
+    "version": "5.0.0-beta.11",
     "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": [