@veltdev/sdk 3.0.68 → 3.0.70

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

@@ -1,13 +1,13 @@
 // @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, CommentUpdateEventData, CopyLinkEvent, DeleteAttachmentEvent, DeleteCommentAnnotationEvent, DeleteCommentEvent, DeleteReactionEvent, DeleteRecordingEvent, GetLinkEvent, RejectCommentAnnotationEvent, ToggleReactionEvent, UpdateAccessEvent, UpdateCommentEvent, UpdatePriorityEvent, UpdateStatusEvent } from "../data/comment-events.data.model";
+import { AcceptCommentAnnotationEvent, AddCommentAnnotationEvent, AddCommentEvent, AddReactionEvent, ApproveCommentAnnotationEvent, CommentAddEventData, CommentEventTypesMap, CommentUpdateEventData, CopyLinkEvent, DeleteAttachmentEvent, DeleteCommentAnnotationEvent, DeleteCommentEvent, DeleteReactionEvent, DeleteRecordingEvent, GetLinkEvent, RejectCommentAnnotationEvent, ToggleReactionEvent, UpdateAccessEvent, UpdateCommentEvent, UpdatePriorityEvent, UpdateStatusEvent } 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 { AutocompleteData } from "../data/autocomplete.data.model";
 import { CommentSidebarCustomActionEventData, CommentSidebarData, CommentSidebarDataOptions } from "../data/comment-sidebar-config.model";
 export { ReactionMap } from '../data/reaction-annotation.data.model';
-import { AcceptCommentAnnotationConfig, AddAttachmentConfig, AddAttachmentResponse, AddCommentAnnotationConfig, AddCommentConfig, AddReactionConfig, ApproveCommentAnnotationConfig, CopyLinkConfig, DeleteAttachmentConfig, DeleteCommentAnnotationConfig, DeleteCommentConfig, DeleteReactionConfig, DeleteRecordingConfig, GetAttachmentConfig, GetCommentConfig, GetLinkConfig, GetRecordingConfig, RejectCommentAnnotationConfig, ResolveCommentAnnotationConfig, ToggleReactionConfig, UpdateAccessConfig, UpdateCommentConfig, UpdatePriorityConfig, UpdateStatusConfig } from "../data/comment-actions.data.model";
+import { AcceptCommentAnnotationRequest, AddAttachmentRequest, AddAttachmentResponse, AddCommentAnnotationRequest, AddCommentRequest, AddReactionRequest, ApproveCommentAnnotationRequest, AssignUserRequest, AssignUserEvent, CopyLinkRequest, DeleteAttachmentRequest, DeleteCommentAnnotationRequest, DeleteCommentRequest, DeleteReactionRequest, DeleteRecordingRequest, GetAttachmentRequest, GetCommentRequest, GetLinkRequest, GetRecordingRequest, RejectCommentAnnotationRequest, ResolveCommentAnnotationRequest, SubscribeCommentAnnotationRequest, UnsubscribeCommentAnnotationRequest, ToggleReactionRequest, UpdateAccessRequest, UpdateCommentRequest, UpdatePriorityRequest, UpdateStatusRequest } from "../data/comment-actions.data.model";
 export declare class CommentElement {
   /**
    * Subscribe to comments on the current document.
@@ -394,11 +394,15 @@ export declare class CommentElement {
 
   /**
    * To get documentId, location and set context data when comment is added.
+   * 
+   * @deprecated Use `AddCommentAnnotationEvent` instead
    */
   public onCommentAdd: () => Observable<CommentAddEventData>;
 
   /**
    * To get data when comment is updated.
+   * 
+   * @deprecated Use action specific events instead
    */
   public onCommentUpdate: () => Observable<CommentUpdateEventData>;
 
@@ -916,122 +920,137 @@ export declare class CommentElement {
   /**
    * To add comment annotation
    */
-  public addCommentAnnotation: (config: AddCommentAnnotationConfig) => Promise<AddCommentAnnotationEvent | null>;
+  public addCommentAnnotation: (config: AddCommentAnnotationRequest) => Promise<AddCommentAnnotationEvent | null>;
 
   /**
    * To approve comment annotation
    */
-  public approveCommentAnnotation: (config: ApproveCommentAnnotationConfig) => Promise<ApproveCommentAnnotationEvent | null>;
+  public approveCommentAnnotation: (config: ApproveCommentAnnotationRequest) => Promise<ApproveCommentAnnotationEvent | null>;
 
   /**
    * To accept comment annotation
    */
-  public acceptCommentAnnotation: (config: AcceptCommentAnnotationConfig) => Promise<AcceptCommentAnnotationEvent | null>;
+  public acceptCommentAnnotation: (config: AcceptCommentAnnotationRequest) => Promise<AcceptCommentAnnotationEvent | null>;
 
   /**
    * To reject comment annotation
    */
-  public rejectCommentAnnotation: (config: RejectCommentAnnotationConfig) => Promise<RejectCommentAnnotationEvent | null>;
+  public rejectCommentAnnotation: (config: RejectCommentAnnotationRequest) => Promise<RejectCommentAnnotationEvent | null>;
+
+  /**
+   * To subscribe comment annotation
+   */
+  public subscribeCommentAnnotation: (config: SubscribeCommentAnnotationRequest) => Promise<SubscribeCommentAnnotationEvent | null>;
+
+  /**
+   * To unsubscribe comment annotation
+   */
+  public unsubscribeCommentAnnotation: (config: UnsubscribeCommentAnnotationRequest) => Promise<UnsubscribeCommentAnnotationEvent | null>;
 
   /**
    * To delete comment annotation
    */
-  public deleteCommentAnnotation: (config: DeleteCommentAnnotationConfig) => Promise<DeleteCommentAnnotationEvent | null>;
+  public deleteCommentAnnotation: (config: DeleteCommentAnnotationRequest) => Promise<DeleteCommentAnnotationEvent | null>;
+
+  /**
+   * To assign user to comment annotation
+   */
+  public assignUser: (config: AssignUserRequest) => Promise<AssignUserEvent | null>;
 
   /**
    * To update priority
    */
-  public updatePriority: (config: UpdatePriorityConfig) => Promise<UpdatePriorityEvent | null>;
+  public updatePriority: (config: UpdatePriorityRequest) => Promise<UpdatePriorityEvent | null>;
 
   /**
    * To update status
    */
-  public updateStatus: (config: UpdateStatusConfig) => Promise<UpdateStatusEvent | null>;
+  public updateStatus: (config: UpdateStatusRequest) => Promise<UpdateStatusEvent | null>;
 
   /**
    * To update access
    */
-  public updateAccess: (config: UpdateAccessConfig) => Promise<UpdateAccessEvent | null>;
+  public updateAccess: (config: UpdateAccessRequest) => Promise<UpdateAccessEvent | null>;
 
   /**
    * To resolve comment annotation
    */
-  public resolveCommentAnnotation: (config: ResolveCommentAnnotationConfig) => Promise<any>;
+  public resolveCommentAnnotation: (config: ResolveCommentAnnotationRequest) => Promise<any>;
 
   /**
    * To get link
    */
-  public getLink: (config: GetLinkConfig) => Promise<GetLinkEvent | null>;
+  public getLink: (config: GetLinkRequest) => Promise<GetLinkEvent | null>;
 
   /**
    * To copy link
    */
-  public copyLink: (config: CopyLinkConfig) => Promise<CopyLinkEvent | null>;
+  public copyLink: (config: CopyLinkRequest) => Promise<CopyLinkEvent | null>;
 
   /**
    * To add comment
    */
-  public addComment: (config: AddCommentConfig) => Promise<AddCommentEvent | null>;
+  public addComment: (config: AddCommentRequest) => Promise<AddCommentEvent | null>;
 
   /**
    * To update comment
    */
-  public updateComment: (config: UpdateCommentConfig) => Promise<UpdateCommentEvent | null>;
+  public updateComment: (config: UpdateCommentRequest) => Promise<UpdateCommentEvent | null>;
 
   /**
    * To delete comment
    */
-  public deleteComment: (config: DeleteCommentConfig) => Promise<DeleteCommentEvent | null>;
+  public deleteComment: (config: DeleteCommentRequest) => Promise<DeleteCommentEvent | null>;
 
   /**
    * To get comment
    */
-  public getComment: (config: GetCommentConfig) => Promise<Comment[]>;
+  public getComment: (config: GetCommentRequest) => Promise<Comment[]>;
 
   /**
    * To add attachment
    */
-  public addAttachment: (config: AddAttachmentConfig) => Promise<AddAttachmentResponse[]>;
+  public addAttachment: (config: AddAttachmentRequest) => Promise<AddAttachmentResponse[]>;
 
   /**
    * To get attachment
    */
-  public getAttachment: (config: GetAttachmentConfig) => Promise<Attachment[]>;
+  public getAttachment: (config: GetAttachmentRequest) => Promise<Attachment[]>;
 
   /**
    * To delete attachment
    */
-  public deleteAttachment: (config: DeleteAttachmentConfig) => Promise<DeleteAttachmentEvent | null>;
+  public deleteAttachment: (config: DeleteAttachmentRequest) => Promise<DeleteAttachmentEvent | null>;
 
   /**
    * To get recording
    */
-  public getRecording: (config: GetRecordingConfig) => Promise<RecordedData[]>;
+  public getRecording: (config: GetRecordingRequest) => Promise<RecordedData[]>;
 
   /**
    * To delete recording
    */
-  public deleteRecording: (config: DeleteRecordingConfig) => Promise<DeleteRecordingEvent | null>;
+  public deleteRecording: (config: DeleteRecordingRequest) => Promise<DeleteRecordingEvent | null>;
 
   /**
    * To add reaction
    */
-  public addReaction: (config: AddReactionConfig) => Promise<AddReactionEvent | null>;
+  public addReaction: (config: AddReactionRequest) => Promise<AddReactionEvent | null>;
 
   /**
    * To delete reaction
    */
-  public deleteReaction: (config: DeleteReactionConfig) => Promise<DeleteReactionEvent | null>;
+  public deleteReaction: (config: DeleteReactionRequest) => Promise<DeleteReactionEvent | null>;
 
   /**
    * To toggle reaction
    */
-  public toggleReaction: (config: ToggleReactionConfig) => Promise<ToggleReactionEvent | null>;
+  public toggleReaction: (config: ToggleReactionRequest) => Promise<ToggleReactionEvent | null>;
 
   /**
    * Subscribe to comment actions
    */
-  public on: (action: CommentActionTypes) => Observable<any>;
+  public on: <T extends keyof CommentEventTypesMap>(action: T) => Observable<CommentEventTypesMap[T]>;
   constructor();
   /**
    * Subscribe to comments on the current document.
@@ -1952,11 +1971,26 @@ export declare class CommentElement {
    */
   private _rejectCommentAnnotation;
 
+  /**
+   * To subscribe to comment annotation
+   */
+  private _subscribeCommentAnnotation;
+
+  /**
+   * To unsubscribe to comment annotation
+   */
+  private _unsubscribeCommentAnnotation;
+
   /**
    * To delete comment annotation
    */
   private _deleteCommentAnnotation;
 
+  /**
+   * To assign user to comment annotation
+   */
+  private _assignUser;
+
   /**
    * To update priority
    */

package/app/utils/constants.d.ts

@@ -372,7 +372,7 @@ export declare class Constants {
     static VELT_BASE_REM_UNIT: string;
     static VELT_VIEWPORT_WIDTH: string;
     static VELT_VIEWPORT_HEIGHT: string;
-    static VELT_COLOR: string;
+    static VELT_SELECTION_COLOR: string;
     static VELT_MIN_ARROW_LENGTH: number;
     static VELT_ARROW_VIEWPORT_PADDING: number;
     static LIVE_STATE_REQUEST_EDITOR_ACCESS_WAIT_TIME: number;

package/app/utils/enums.d.ts

@@ -16,29 +16,31 @@ export declare enum CommentStatus {
     SUBSCRIBED = "subscribed",
     UNSUBSCRIBED = "unsubscribed"
 }
-export declare enum CommentActionTypes {
-    ADD_COMMENT_ANNOTATION = "addCommentAnnotation",
-    UPDATE_COMMENT_ANNOTATION = "updateCommentAnnotation",
-    DELETE_COMMENT_ANNOTATION = "deleteCommentAnnotation",
-    APPROVE_COMMENT_ANNOTATION = "approveCommentAnnotation",
-    ACCEPT_COMMENT_ANNOTATION = "acceptCommentAnnotation",
-    REJECT_COMMENT_ANNOTATION = "rejectCommentAnnotation",
-    UPDATE_STATUS = "updateStatus",
-    UPDATE_PRIORITY = "updatePriority",
-    UPDATE_ACCESS = "updateAccess",
-    RESOLVE_COMMENT = "resolveComment",
-    ADD_COMMENT = "addComment",
-    UPDATE_COMMENT = "updateComment",
-    DELETE_COMMENT = "deleteComment",
-    ADD_ATTACHMENT = "addAttachment",
-    DELETE_ATTACHMENT = "deleteAttachment",
-    DELETE_RECORDING = "deleteRecording",
-    GET_LINK = "getLink",
-    COPY_LINK = "copyLink",
-    ADD_REACTION = "addReaction",
-    DELETE_REACTION = "deleteReaction",
-    TOGGLE_REACTION = "toggleReaction"
-}
+export declare const CommentEventTypes: {
+    readonly ADD_COMMENT_ANNOTATION: "addCommentAnnotation";
+    readonly DELETE_COMMENT_ANNOTATION: "deleteCommentAnnotation";
+    readonly APPROVE_COMMENT_ANNOTATION: "approveCommentAnnotation";
+    readonly ACCEPT_COMMENT_ANNOTATION: "acceptCommentAnnotation";
+    readonly REJECT_COMMENT_ANNOTATION: "rejectCommentAnnotation";
+    readonly SUBSCRIBE_COMMENT_ANNOTATION: "subscribeCommentAnnotation";
+    readonly UNSUBSCRIBE_COMMENT_ANNOTATION: "unsubscribeCommentAnnotation";
+    readonly ASSIGN_USER: "assignUser";
+    readonly UPDATE_STATUS: "updateStatus";
+    readonly UPDATE_PRIORITY: "updatePriority";
+    readonly UPDATE_ACCESS: "updateAccess";
+    readonly RESOLVE_COMMENT: "resolveComment";
+    readonly ADD_COMMENT: "addComment";
+    readonly UPDATE_COMMENT: "updateComment";
+    readonly DELETE_COMMENT: "deleteComment";
+    readonly ADD_ATTACHMENT: "addAttachment";
+    readonly DELETE_ATTACHMENT: "deleteAttachment";
+    readonly DELETE_RECORDING: "deleteRecording";
+    readonly COPY_LINK: "copyLink";
+    readonly ADD_REACTION: "addReaction";
+    readonly DELETE_REACTION: "deleteReaction";
+    readonly TOGGLE_REACTION: "toggleReaction";
+};
+export type CommentEventType = typeof CommentEventTypes[keyof typeof CommentEventTypes];
 export declare enum TagStatus {
     ADDED = "added",
     UPDATED = "updated",

package/models.d.ts

@@ -56,3 +56,4 @@ export * from './app/models/data/reaction.data.model';
 export * from './app/models/data/organization-groups.data.model';
 export * from './app/models/data/organization-metadata.model';
 export * from './app/models/data/user-organization.data.model';
+export * from './app/models/data/event-metadata.data.model';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@veltdev/sdk",
-    "version": "3.0.68",
+    "version": "3.0.70",
     "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": [