@veltdev/types 5.0.0-beta.13 → 5.0.0-beta.15

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

@@ -214,6 +214,32 @@ export interface ToggleReactionRequest {
     };
     options?: RequestOptions;
 }
+export interface SubmitCommentRequest {
+    targetComposerElementId: string;
+}
+export interface ClearComposerRequest {
+    targetComposerElementId: string;
+}
+export interface GetComposerDataRequest {
+    targetComposerElementId: string;
+}
+/**
+ * FormatConfig - Configuration for format options
+ */
+export interface FormatConfig {
+    bold?: {
+        enable: boolean;
+    };
+    italic?: {
+        enable: boolean;
+    };
+    underline?: {
+        enable: boolean;
+    };
+    strikethrough?: {
+        enable: boolean;
+    };
+}
 export interface FetchCommentAnnotationsRequest {
     createdAfter?: number;
     createdBefore?: number;

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

@@ -184,6 +184,7 @@ export declare class CommentAnnotation {
     unsubscribedUsers?: CommentAnnotationUnsubscribedUsers;
     subscribedGroups?: CommentAnnotationSubscribedGroups;
     resolvedByUserId?: string | null;
+    resolvedByUser?: User | null;
     multiThreadAnnotationId?: string;
     isDraft?: boolean;
     sourceId?: string;

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

@@ -1,4 +1,4 @@
-import { CommentAccessMode, CommentEventTypes, CommentStatus } from "../../utils/enums";
+import { AssignToType, CommentAccessMode, CommentEventTypes, CommentStatus } from "../../utils/enums";
 import { Attachment } from "./attachment.model";
 import { VeltButtonClickEvent } from "./button.data.model";
 import { AddAttachmentResponse } from "./comment-actions.data.model";
@@ -84,6 +84,8 @@ export type CommentEventTypesMap = {
     [CommentEventTypes.LINK_CLICKED]: LinkClickedEvent;
     [CommentEventTypes.COMMENT_PIN_CLICKED]: CommentPinClickedEvent;
     [CommentEventTypes.COMMENT_BUBBLE_CLICKED]: CommentBubbleClickedEvent;
+    [CommentEventTypes.COMMENT_TOOL_CLICK]: CommentToolClickEvent;
+    [CommentEventTypes.SIDEBAR_BUTTON_CLICK]: SidebarButtonClickEvent;
 };
 export interface AddAttachmentEvent {
     annotationId: string;
@@ -278,5 +280,26 @@ export interface CommentBubbleClickedEvent {
 }
 export interface ComposerTextChangeEvent {
     text: string;
+    annotation: CommentAnnotation;
+    targetComposerElementId: string;
+    metadata?: VeltEventMetadata;
+}
+export interface AssignToConfig {
+    type: AssignToType;
+}
+export interface PageModeComposerConfig {
+    context?: {
+        [key: string]: any;
+    } | null;
+    targetElementId?: string | null;
+}
+export interface CommentToolClickEvent {
+    context: {
+        [key: string]: any;
+    } | null;
+    targetElementId?: string | null;
+    metadata?: VeltEventMetadata;
+}
+export interface SidebarButtonClickEvent {
     metadata?: VeltEventMetadata;
 }

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

@@ -1,13 +1,13 @@
 // @ts-nocheck
 import { Observable } from "rxjs";
-import { CommentSidebarSystemFiltersOperator, SidebarButtonCountType } from "../../utils/enums";
+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, 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 { 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 { 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 { 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";
-import { CommentContextProvider, TransformContext, UnreadCommentsCount } from "../data/comment-utils.data.model";
+import { CommentContextProvider, FormatConfig, 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';
@@ -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 config The page mode composer config containing context and targetElementId
+   */
+  setContextInPageModeComposer: (config: PageModeComposerConfig | null) => void;
+
+  /**
+   * To focus the page mode composer input
+   */
+  focusPageModeComposer: () => void;
+
+  /**
+   * To set assign to type for comment dialog
+   * @param config The assign to config containing type
+   */
+  setAssignToType: (config: AssignToConfig) => void;
+
   /**
   * To enable moderator mode
   */
@@ -1271,13 +1304,6 @@ 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
    */
@@ -1288,6 +1314,42 @@ export declare class CommentElement {
    */
   public disablePaginatedContactList: () => void;
 
+  /**
+   * To enable format options (bold, italic, underline, strikethrough)
+   */
+  public enableFormatOptions: () => void;
+
+  /**
+   * To disable format options
+   */
+  public disableFormatOptions: () => void;
+
+  /**
+   * Set format config to control which format options are enabled
+   * @param config FormatConfig with enable flags for each format type
+   */
+  public setFormatConfig: (config: FormatConfig) => void;
+
+  /**
+   * Programmatically trigger comment submission for a composer with the given targetComposerElementId
+   * @param request SubmitCommentRequest containing targetComposerElementId
+   */
+  public submitComment: (request: SubmitCommentRequest) => void;
+
+  /**
+   * Programmatically clear the composer state for the given targetComposerElementId
+   * @param request ClearComposerRequest containing targetComposerElementId
+   */
+  public clearComposer: (request: ClearComposerRequest) => void;
+
+  /**
+   * Get the current composer data for a given targetComposerElementId
+   * Returns the same data as COMPOSER_TEXT_CHANGE event but as a one-time fetch
+   * @param request GetComposerDataRequest containing targetComposerElementId
+   * @returns The composer data or null if not found
+   */
+  public getComposerData: (request: GetComposerDataRequest) => ComposerTextChangeEvent | null;
+
   constructor();
   /**
    * Subscribe to comments on the current document.
@@ -2548,11 +2610,68 @@ export declare class CommentElement {
    * To disable paginated contact list
    */
   private _disablePaginatedContactList;
+  /**
+   * To enable format options (bold, italic, underline, strikethrough)
+   */
+  private _enableFormatOptions;
+  /**
+   * To disable format options
+   */
+  private _disableFormatOptions;
+  /**
+   * To set format config to control which format options are enabled
+   * @param config FormatConfig with enable flags for each format type
+   */
+  private _setFormatConfig;
 
   /**
-   * 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
+   * Programmatically trigger comment submission for a composer with the given targetComposerElementId
+   * @param request SubmitCommentRequest containing targetComposerElementId
    */
   private _submitComment;
+
+  /**
+   * Programmatically clear the composer state for the given targetComposerElementId
+   * @param request ClearComposerRequest containing targetComposerElementId
+   */
+  private _clearComposer;
+
+  /**
+   * Get the current composer data for a given targetComposerElementId
+   * Returns the same data as COMPOSER_TEXT_CHANGE event but as a one-time fetch
+   * @param request GetComposerDataRequest containing targetComposerElementId
+   * @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

@@ -59,6 +59,8 @@ export declare const CommentEventTypes: {
     readonly LINK_CLICKED: "linkClicked";
     readonly COMMENT_PIN_CLICKED: "commentPinClicked";
     readonly COMMENT_BUBBLE_CLICKED: "commentBubbleClicked";
+    readonly COMMENT_TOOL_CLICK: "commentToolClick";
+    readonly SIDEBAR_BUTTON_CLICK: "sidebarButtonClick";
 };
 export declare const RecorderEventTypes: {
     readonly TRANSCRIPTION_DONE: "transcriptionDone";
@@ -187,6 +189,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",
@@ -279,10 +282,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/types",
-    "version": "5.0.0-beta.13",
+    "version": "5.0.0-beta.15",
     "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": [