@veltdev/sdk 5.0.1-beta.2 → 5.0.1-beta.4

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

@@ -44,10 +44,10 @@ export interface CopyLinkRequest {
 /**
  * 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)
+ * - 'organizationPrivate': Visible only to users in the specified organization
+ * - 'restricted': Visible only to specified users (private comments)
  */
-export type CommentVisibilityType = 'public' | 'organization' | 'self';
+export type CommentVisibilityType = 'public' | 'organizationPrivate' | 'restricted';
 /**
  * Configuration for comment visibility/access control.
  */
@@ -56,11 +56,17 @@ export interface CommentVisibilityConfig {
     type: CommentVisibilityType;
     /** Annotation ID for the comment to update visibility */
     annotationId?: string;
-    /** Organization ID for 'organization' type visibility */
+    /** Organization ID for 'organizationPrivate' type visibility */
     organizationId?: string;
-    /** User IDs for 'self' type visibility - array of user IDs who can see the comment */
+    /** User IDs for 'restricted' type visibility - array of user IDs who can see the comment */
     userIds?: string[];
 }
+/**
+ * Configuration for private mode (enablePrivateMode/disablePrivateMode).
+ * Same as CommentVisibilityConfig but without annotationId and organizationId,
+ * since private mode applies to all new comments.
+ */
+export type PrivateModeConfig = Omit<CommentVisibilityConfig, 'annotationId' | 'organizationId'>;
 export interface AddCommentAnnotationRequest {
     annotation: CommentAnnotation;
     options?: RequestOptions;

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

@@ -87,6 +87,7 @@ export type CommentEventTypesMap = {
     [CommentEventTypes.COMMENT_TOOL_CLICK]: CommentToolClickEvent;
     [CommentEventTypes.SIDEBAR_BUTTON_CLICK]: SidebarButtonClickEvent;
     [CommentEventTypes.ATTACHMENT_DOWNLOAD_CLICKED]: AttachmentDownloadClickedEvent;
+    [CommentEventTypes.COMMENT_SAVED]: CommentSavedEvent;
 };
 export interface AddAttachmentEvent {
     annotationId: string;
@@ -176,6 +177,11 @@ export interface AddCommentEvent {
     comment: Comment;
     metadata: VeltEventMetadata;
 }
+export interface CommentSavedEvent {
+    annotationId: string;
+    commentAnnotation: CommentAnnotation;
+    metadata: VeltEventMetadata;
+}
 export interface UpdateCommentEvent {
     annotationId: string;
     commentAnnotation: CommentAnnotation;

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

@@ -3,7 +3,7 @@ import { Observable } from "rxjs";
 import { AssignToType, 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, ClearComposerRequest, 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 { AcceptCommentAnnotationRequest, AddAttachmentRequest, AddAttachmentResponse, AddCommentAnnotationRequest, AddCommentRequest, AddReactionRequest, ApproveCommentAnnotationRequest, AssignUserEvent, AssignUserRequest, CommentRequestQuery, CommentVisibilityConfig, ClearComposerRequest, CopyLinkRequest, DeleteAttachmentRequest, DeleteCommentAnnotationRequest, DeleteCommentRequest, DeleteReactionRequest, DeleteRecordingRequest, FetchCommentAnnotationsRequest, GetAttachmentRequest, GetCommentRequest, GetComposerDataRequest, GetLinkRequest, GetRecordingRequest, PrivateModeConfig, RejectCommentAnnotationRequest, ResolveCommentAnnotationRequest, SubmitCommentRequest, 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, AssignToConfig, CommentAddEventData, CommentEventTypesMap, CommentUpdateEventData, ComposerTextChangeEvent, CopyLinkEvent, DeleteAttachmentEvent, DeleteCommentAnnotationEvent, DeleteCommentEvent, DeleteReactionEvent, DeleteRecordingEvent, FetchCommentAnnotationsResponse, GetCommentAnnotationsCountResponse, GetCommentAnnotationsResponse, GetLinkEvent, PageModeComposerConfig, RejectCommentAnnotationEvent, ToggleReactionEvent, UpdateAccessEvent, UpdateCommentEvent, UpdatePriorityEvent, UpdateStatusEvent } from "../data/comment-events.data.model";
 import { CommentSidebarCustomActionEventData, CommentSidebarData, CommentSidebarDataOptions } from "../data/comment-sidebar-config.model";
@@ -518,6 +518,18 @@ export declare class CommentElement {
    */
   public disablePrivateCommentMode: () => void;
 
+  /**
+   * To enable private mode with visibility configuration.
+   * All new comments will be created with the specified visibility.
+   * @param config PrivateModeConfig with type and optional userIds
+   */
+  public enablePrivateMode: (config: PrivateModeConfig) => void;
+
+  /**
+   * To disable private mode. New comments will revert to default public visibility.
+   */
+  public disablePrivateMode: () => void;
+
   /**
    * To enable scroll to comment.
    */
@@ -1825,6 +1837,18 @@ export declare class CommentElement {
    */
   private _disablePrivateCommentMode;
 
+  /**
+   * To enable private mode with visibility configuration.
+   * All new comments will be created with the specified visibility.
+   * @param config PrivateModeConfig with type and optional userIds
+   */
+  private _enablePrivateMode;
+
+  /**
+   * To disable private mode. New comments will revert to default public visibility.
+   */
+  private _disablePrivateMode;
+
   /**
    * To enable scroll to comment.
    */

package/app/utils/enums.d.ts

@@ -62,6 +62,7 @@ export declare const CommentEventTypes: {
     readonly COMMENT_TOOL_CLICK: "commentToolClick";
     readonly SIDEBAR_BUTTON_CLICK: "sidebarButtonClick";
     readonly ATTACHMENT_DOWNLOAD_CLICKED: "attachmentDownloadClicked";
+    readonly COMMENT_SAVED: "commentSaved";
 };
 export declare const RecorderEventTypes: {
     readonly TRANSCRIPTION_DONE: "transcriptionDone";

package/package.json

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