@veltdev/sdk-staging 3.0.63 → 3.0.64-patch.2

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

@@ -174,6 +174,7 @@ export declare class CommentAnnotation {
     resolvedByUserId?: string | null;
     multiThreadAnnotationId?: string;
     isDraft?: boolean;
+    sourceId?: string;
 }
 export declare class GhostComment {
     targetElement?: TargetElement | null;
@@ -202,6 +203,7 @@ export declare class CommentOnElementConfig {
     status?: string;
     context?: any;
     openComment?: boolean;
+    sourceId?: string;
 }
 export declare class CommentIAMConfig {
     accessMode?: CommentAccessMode;

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

@@ -0,0 +1,33 @@
+import { CommentStatus } from "../../utils/enums";
+import { CommentAnnotation, UpdateContextConfig } from "./comment-annotation.data.model";
+import { Location } from "./location.model";
+import { User } from "./user.data.model";
+export interface CommentAddEventData {
+    annotation: CommentAnnotation;
+    location?: Location;
+    documentId?: string;
+    addContext: (context: any) => void;
+    targetAnnotationId?: string;
+    targetCommentId?: number;
+    elementRef?: {
+        xpath: string;
+    };
+}
+export interface CommentEvent {
+    annotation?: CommentAnnotation | null;
+    element?: HTMLElement;
+    type?: string;
+    targetAnnotationId?: string;
+    targetCommentId?: number;
+    updateContext?: (context: any, config?: UpdateContextConfig) => void;
+}
+export interface CommentUpdateEventData extends CommentEvent {
+}
+export interface CommentSuggestionEventData {
+    annotationId: string;
+    actionUser?: User;
+    actionType?: CommentStatus;
+    replaceContentHtml?: string;
+    replaceContentText?: string;
+    annotation?: any;
+}

package/app/models/data/comment-sidebar-config.model.d.ts

@@ -34,23 +34,24 @@ export declare class CommentSidebarFilters {
         name?: string;
     }[];
 }
-export interface CommentSidebarActionsConfig {
+export interface CommentSidebarCustomActionsState {
     [key: string]: boolean;
 }
-export interface CommentSidebarDataConfig {
-    actions: CommentSidebarActionsConfig;
+export interface CommentSidebarCustomActionEventData {
+    actions: CommentSidebarCustomActionsState;
     data: CommentAnnotation[];
     unreadDataMap: {
         [commentAnnotationId: string]: number;
     };
     systemFilteredData: CommentAnnotation[];
 }
-export interface CommentSidebarData {
-    type: 'group';
-    data: {
-        displayName: string;
-        isExpanded: boolean;
-        annotations: CommentAnnotation[];
-    };
+export declare class CommentSidebarData {
+    groupId?: string;
+    groupName?: string;
+    isExpanded?: boolean;
+    annotations: CommentAnnotation[];
+}
+export declare class CommentSidebarDataOptions {
+    grouping?: boolean;
 }
 export {};

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

@@ -54,6 +54,7 @@ export declare class Comment {
      * Auto generated.
      */
     lastUpdated?: Date;
+    createdAt?: any;
     status: 'added' | 'updated';
     /**
      * List of attachments.

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

@@ -1,3 +1,4 @@
+import { FirebaseOptions } from "@angular/fire/app";
 import { FeatureType } from "../../utils/enums";
 export declare class Config {
     /**
@@ -43,3 +44,6 @@ export declare class Config {
      */
     usePrefersColorScheme?: boolean;
 }
+export interface ExtendedFirebaseOptions extends FirebaseOptions {
+    storeDbId: string;
+}

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

@@ -126,3 +126,33 @@ export declare class RecorderAnnotation {
      */
     displayName?: string;
 }
+declare class RecorderDataTranscriptSegment {
+    startTime: string;
+    endTime: string;
+    startTimeInSeconds: number;
+    endTimeInSeconds: number;
+    text: string;
+}
+declare class RecorderDataTranscription {
+    transcriptSegments?: RecorderDataTranscriptSegment[];
+    vttFileUrl?: string;
+    contentSummary?: string;
+}
+declare class RecorderDataAsset {
+    url: string;
+    mimeType?: string;
+    fileName?: string;
+    /** File size in bytes */
+    fileSizeInBytes?: number;
+    /**
+     * The format/extension of the file
+     * @example 'mp3', 'mp4', 'webm'
+     */
+    fileFormat?: 'mp3' | 'mp4' | 'webm' | string;
+    thumbnailUrl?: string;
+}
+export declare class RecorderData {
+    assets: RecorderDataAsset[];
+    transcription: RecorderDataTranscription;
+}
+export {};

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

@@ -20,3 +20,14 @@ export declare class Selection {
     targetTextRange?: TargetTextRange | null;
     pageInfo: PageInfo;
 }
+export declare enum UserIndicatorPosition {
+    Start = "start",
+    End = "end"
+}
+export declare enum UserIndicatorType {
+    Avatar = "avatar",
+    Label = "label"
+}
+export declare class LiveSelectionData {
+    [userIdHash: string]: Selection;
+}

package/app/models/data/target-text-range.data.model.d.ts

@@ -3,6 +3,14 @@ export declare class TargetTextRange {
      * Xpath of common Ancestor Container
      */
     commonAncestorContainer?: string;
+    /**
+     * Full xpath of common Ancestor Container
+     */
+    commonAncestorContainerFXpath?: string;
+    /**
+     * Full xpath of common Ancestor Container with class names
+     */
+    commonAncestorContainerCFXpath?: string;
     /**
      * Selected text
      */

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

@@ -10,6 +10,7 @@ export declare class User {
      * Default: Random avatar name.
      */
     name?: string;
+    clientUserName?: string;
     /**
     * Your user's display picture URL.
     *

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

@@ -1,10 +1,11 @@
 // @ts-nocheck
 import { Observable } from "rxjs";
 import { CommentAnnotation, CommentOnElementConfig, CommentSelectionChangeData, ManualCommentAnnotationConfig, UpdateContextConfig } from "../data/comment-annotation.data.model";
+import { CommentAddEventData, CommentUpdateEventData } 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';
 export declare class CommentElement {
   /**
@@ -393,12 +394,12 @@ export declare class CommentElement {
   /**
    * To get documentId, location and set context data when comment is added.
    */
-  public onCommentAdd: () => Observable<any>;
+  public onCommentAdd: () => Observable<CommentAddEventData>;
 
   /**
    * To get data when comment is updated.
    */
-  public onCommentUpdate: () => Observable<any>;
+  public onCommentUpdate: () => Observable<CommentUpdateEventData>;
 
   /**
    * To add comment on selected text.
@@ -550,14 +551,26 @@ export declare class CommentElement {
 
   /**
    * To enable showing recording summary in comments
+   * @deprecated Use `enableRecordingTranscription` instead
    */
   public enableRecordingSummary: () => void;
 
   /**
    * To disable showing recording summary in comments
+   * @deprecated Use `disableRecordingTranscription` instead
    */
   public disableRecordingSummary: () => void;
 
+  /**
+   * To enable recording transcription
+   */
+  public enableRecordingTranscription: () => void;
+
+  /**
+   * To disable recording transcription
+   */
+  public disableRecordingTranscription: () => void;
+
   /**
    * To enable recording countdown
    */
@@ -827,41 +840,67 @@ export declare class CommentElement {
    * Subscribe to comment sidebar action button click
    * @returns comment sidebar data
    */
-  public onCommentSidebarActionButtonClick: () => Observable<CommentSidebarDataConfig | null>;
+  public onCommentSidebarActionButtonClick: () => Observable<CommentSidebarCustomActionEventData | null>;
 
   /**
    * To set comment sidebar data
    * @param data comment sidebar data
    */
-  public setCommentSidebarData: (data: CommentSidebarData[]) => void;
+  public setCommentSidebarData: (data: CommentSidebarData[], options?: CommentSidebarDataOptions) => void;
 
   /**
    * Subscribe to comment sidebar init
    * @returns comment sidebar data
    */
-  public onCommentSidebarInit: () => Observable<CommentSidebarDataConfig | null>;
+  public onCommentSidebarInit: () => Observable<CommentSidebarCustomActionEventData | null>;
 
   /**
    * Subscribe to comment sidebar data
    * @returns comment sidebar data
    */
-  public onCommentSidebarData: () => Observable<CommentSidebarDataConfig | null>;
+  public onCommentSidebarData: () => Observable<CommentSidebarCustomActionEventData | null>;
 
   /**
    * To set comment sidebar default actions config
    * @param data comment sidebar default actions config
    */
-  public setCommentSidebarDefaultActionsConfig: (data: CommentSidebarActionsConfig) => void;
+  public setCommentSidebarDefaultCustomActions: (data: CommentSidebarCustomActionsState) => void;
 
   /**
    * To enable comment sidebar custom filter mode
    */
-  public enableCommentSidebarCustomFilterMode: () => void;
-  
+  public enableSidebarCustomActions: () => void;
+
   /**
    * To disable comment sidebar custom filter mode
    */
-  public disableCommentSidebarCustomFilterMode: () => void;
+  public disableSidebarCustomActions: () => void;
+
+  // /**
+  //  * To get comment navigation button click
+  //  * @returns comment navigation button click
+  //  */
+  // public onCommentNavigationButtonClick: () => Observable<any>;
+
+  /**
+   * To enable resolve status access admin only
+   */
+  public enableResolveStatusAccessAdminOnly: () => void;
+
+  /**
+   * To disable resolve status access admin only
+   */
+  public disableResolveStatusAccessAdminOnly: () => void;
+
+  /**
+   * To enable seen by users
+   */
+  public enableSeenByUsers: () => void;
+
+  /**
+   * To disable seen by users
+   */
+  public disableSeenByUsers: () => void;
 
   constructor();
   /**
@@ -1402,14 +1441,26 @@ export declare class CommentElement {
 
   /**
    * To enable showing recording summary in comments
+   * @deprecated Use `enableRecordingTranscription` instead
    */
   private _enableRecordingSummary;
 
   /**
    * To disable showing recording summary in comments
+   * @deprecated Use `disableRecordingTranscription` instead
    */
   private _disableRecordingSummary;
 
+  /** 
+   * To enable recording transcription
+   */
+  private _enableRecordingTranscription;
+
+  /**
+   * To disable recording transcription
+   */
+  private _disableRecordingTranscription;
+
   /**
    * To enable recording countdown
    */
@@ -1681,6 +1732,7 @@ export declare class CommentElement {
   /**
    * To set comment sidebar data
    * @param data comment sidebar data
+   * @param options options
    */
   private _setCommentSidebarData;
 
@@ -1689,7 +1741,7 @@ export declare class CommentElement {
    * @returns comment sidebar data
    */
   private _onCommentSidebarInit;
-  
+
   /**
    * To subscribe to comment sidebar data
    * @returns comment sidebar data
@@ -1700,15 +1752,41 @@ export declare class CommentElement {
    * To set comment sidebar default actions config
    * @param data comment sidebar default actions config
    */
-  private _setCommentSidebarDefaultActionsConfig;
+  private _setCommentSidebarDefaultCustomActions;
 
   /**
    * To enable comment sidebar custom filter mode
    */
-  private _enableCommentSidebarCustomFilterMode;
+  private _enableSidebarCustomActions;
 
   /**
    * To disable comment sidebar custom filter mode
    */
-  private _disableCommentSidebarCustomFilterMode;
-}
+  private _disableSidebarCustomActions;
+
+  // /**
+  //  * To get comment navigation button click
+  //  * @returns comment navigation button click
+  //  */
+  // private _onCommentNavigationButtonClick;
+
+  /**
+   * To enable resolve status access admin only
+   */
+  private _enableResolveStatusAccessAdminOnly;
+
+  /**
+   * To disable resolve status access admin only
+   */
+  private _disableResolveStatusAccessAdminOnly;
+
+  /**
+   * To enable seen by users
+   */
+  private _enableSeenByUsers;
+
+  /**
+   * To disable seen by users
+   */
+  private _disableSeenByUsers;
+}

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

@@ -52,6 +52,12 @@ export declare class NotificationElement {
      * To get unread notifications count
      */
     getUnreadNotificationsCount: () => Observable<{ forYou: number | null, all: number | null }>;
+
+    /**
+     * To mark notification as read by id
+     */
+    markNotificationAsReadById: (notificationId: string) => void;
+
     constructor();
 
     /**
@@ -103,4 +109,9 @@ export declare class NotificationElement {
      * To get unread notifications count
      */
     private _getUnreadNotificationsCount;
+
+    /**
+     * To mark notification as read by id
+     */
+    private _markNotificationAsReadById;
 }

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

@@ -1,5 +1,6 @@
 // @ts-nocheck
 import { Observable } from "rxjs";
+import { RecorderData } from "../data/recorder-annotation.data.model";
 
 export declare class RecorderElement {
 
@@ -17,6 +18,21 @@ export declare class RecorderElement {
      */
     disableRecordingCountdown: () => void;
 
+    /**
+     * To get recording data by recorder id
+     */
+    getRecordingDataByRecorderId: (recorderId: string) => Observable<RecorderData | null>;
+
+    /**
+     * To enable recording transcription
+     */
+    enableRecordingTranscription: () => void;
+
+    /**
+     * To disable recording transcription
+     */
+    disableRecordingTranscription: () => void;
+
     constructor();
 
     private _initRecording;
@@ -32,4 +48,19 @@ export declare class RecorderElement {
      * To disable dark mode in comments
      */
     private _disableRecordingCountdown;
+
+    /**
+     * To get recording data by recorder id
+     */
+    private _getRecordingDataByRecorderId;
+
+    /**
+     * To enable recording transcription
+     */
+    private _enableRecordingTranscription;
+
+    /**
+     * To disable recording transcription
+     */
+    private _disableRecordingTranscription;
 }

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

@@ -1,4 +1,5 @@
 // @ts-nocheck
+import { LiveSelectionData, UserIndicatorPosition, UserIndicatorType } from "../data/selection.model";
 export declare class SelectionElement {
     /**
      * To enable selections
@@ -8,7 +9,53 @@ export declare class SelectionElement {
     /**
      * To disable selections
      */
-    disableLiveSelection: () => void;  
+    disableLiveSelection: () => void;
+
+    /**
+     * To enable user indicator
+     */
+    enableUserIndicator: () => void;
+
+    /**
+     * To disable user indicator
+     */
+    disableUserIndicator: () => void;
+
+    /**
+     * To set user indicator position
+     */
+    setUserIndicatorPosition: (position: UserIndicatorPosition) => void;
+
+    /**
+     * To set user indicator type
+     */
+    setUserIndicatorType: (type: UserIndicatorType) => void;
+
+    /** 
+     * To enable default elements tracking
+     */
+    enableDefaultElementsTracking: () => void;
+
+    /**
+     * To disable default elements tracking
+     */
+    disableDefaultElementsTracking: () => void;
+
+    /**
+     * To enable default styling
+     */
+    enableDefaultStyling: () => void;
+
+    /**
+     * To disable default styling
+     */
+    disableDefaultStyling: () => void;
+
+    /**
+     * To get live selection data
+     */
+    getLiveSelectionData: () => Observable<LiveSelectionData | null>;
+
     constructor();
 
     /**
@@ -20,4 +67,49 @@ export declare class SelectionElement {
      * To disable selections
      */
     private _disableLiveSelection;
-}
+
+    /**
+     * To enable user indicator
+     */
+    private _enableUserIndicator;
+
+    /**
+     * To disable user indicator
+     */
+    private _disableUserIndicator;
+
+    /**
+     * To set user indicator position
+     */
+    private _setUserIndicatorPosition;
+
+    /**
+     * To set user indicator type
+     */
+    private _setUserIndicatorType;
+
+    /** 
+     * To enable default elements tracking
+     */
+    private _enableDefaultElementsTracking;
+
+    /**
+     * To disable default elements tracking
+     */
+    private _disableDefaultElementsTracking;
+
+    /**
+     * To enable default styling
+     */
+    private _enableDefaultStyling;
+
+    /**
+     * To disable default styling
+     */
+    private _disableDefaultStyling;
+
+    /**
+     * To get live selection data
+     */
+    private _getLiveSelectionData;
+}

package/app/utils/constants.d.ts

@@ -9,6 +9,8 @@ export declare class Constants {
     static FIREBASE_PARTIAL_PATH_ORGANIZATIONS: string;
     static FIREBASE_PARTIAL_PATH_DOCS: string;
     static FIREBASE_PARTIAL_PATH_PRESENCE: string;
+    static FIREBASE_PARTIAL_PATH_ORGANIZATION_USERS: string;
+    static FIREBASE_PARTIAL_PATH_DOCUMENT_USERS: string;
     static FIREBASE_PARTIAL_PATH_CURSOR: string;
     static FIREBASE_PARTIAL_PATH_ARROW: string;
     static FIREBASE_PARTIAL_PATH_AREA: string;
@@ -20,6 +22,10 @@ export declare class Constants {
     static FIREBASE_PARTIAL_PATH_HUDDLE: string;
     static FIREBASE_PARTIAL_PATH_CONTACTS: string;
     static FIREBASE_PARTIAL_PATH_GROUPS: string;
+    static FIREBASE_PARTIAL_PATH_NOTIFICATION_DOCS: string;
+    static FIREBASE_PARTIAL_PATH_NOTIFICATION_USERS: string;
+    static FIREBASE_PARTIAL_PATH_DOC_NOTIFICATION: string;
+    static FIREBASE_PARTIAL_PATH_USER_NOTIFICATION: string;
     static FIREBASE_PARTIAL_PATH_GLOBAL: string;
     static FIREBASE_PARTIAL_PATH_LOGINS: string;
     static FIREBASE_PARTIAL_PATH_METADATA: string;
@@ -33,6 +39,10 @@ export declare class Constants {
     static FIREBASE_PARTIAL_PATH_IAM: string;
     static FIREBASE_PARTIAL_PATH_REACTION: string;
     static FIREBASE_PARTIAL_PATH_VIEWS: string;
+    static FIREBASE_PARTIAL_PATH_COMMENT_VIEWS: string;
+    static FIREBASE_PARTIAL_PATH_NOTIFICATION_VIEWS: string;
+    static FIREBASE_PARTIAL_PATH_DOCUMENT_VIEWS: string;
+    static FIREBASE_PARTIAL_PATH_LOCATION_VIEWS: string;
     static FIREBASE_PARTIAL_PATH_NOTIFICATIONS: string;
     static FIREBASE_PARTIAL_PATH_ORGANIZATION_NOTIFICATIONS: string;
     static FIREBASE_PARTIAL_PATH_LAST_NOTIFICATION_TIMESTAMP: string;
@@ -62,6 +72,10 @@ export declare class Constants {
     static SNIPPYLY_HIGHLIGHT_USER: string;
     static SNIPPYLY_HIGHLIGHT_USER_NAME: string;
     static SNIPPYLY_HIGHLIGHT_USER_TEXT: string;
+    static VELT_LIVE_SELECTION_ON_ELEMENT: string;
+    static VELT_LIVE_SELECTION_ON_ELEMENT_DEFAULT: string;
+    static VELT_LIVE_SELECTION_ON_TEXT: string;
+    static VELT_LIVE_SELECTION_ON_TEXT_DEFAULT: string;
     static VELT_IGNORE_CHANGE_DETECTION: string;
     static VELT_CUSTOM_CSS: string;
     static TAGS: {
@@ -236,6 +250,7 @@ export declare class Constants {
         TARGET_ELEMENT_ID: string;
         VELT_ID: string;
         VELT_ELEMENT: string;
+        VELT_SOURCE_ID: string;
         VELT_ANNOTATION_ID: string;
         VELT_ANNOTATION_IDS: string;
         VELT_COMMENT_PIN_HOST: string;
@@ -252,6 +267,7 @@ export declare class Constants {
         VELT_RECORDER_PIN_HOST_STATIC: string;
         VELT_RECORDER_DISABLED: string;
         VELT_ANNOTATION_DRAFT: string;
+        VELT_ANNOTATION_EDIT_COMMENT: string;
         VELT_LOCATION: string;
         VELT_LOCATION_ID: string;
         VELT_THEME: string;
@@ -260,6 +276,9 @@ export declare class Constants {
         DEFAULT_CURSOR: string;
         VELT_HUDDLE_ON_CURSOR_MODE: string;
         VELT_SELECTION_ENABLED: string;
+        VELT_LIVE_SELECTION_ENABLED: string;
+        VELT_LIVE_SELECTION_USER_INDICATOR_POSITION: string;
+        VELT_LIVE_SELECTION_USER_INDICATOR_TYPE: string;
         VELT_SELECTION_CONFIG: string;
         VELT_POPOVER_MODE: string;
         VELT_ELEMENT_CACHE_ID: string;
@@ -318,6 +337,7 @@ export declare class Constants {
         SNIPPYLY_HUDDLE_DATA: string;
         VELT_TAB_ID: string;
         VELT_COMMENT_SIDEBAR_FILTERS_RESET: string;
+        VELT_COMMENT_SIDEBAR_CUSTOM_ACTIONS_STATE: string;
         VELT_CURSOR_MULTIPLE_USERS_DETECTED: string;
         VELT_PRESENCE_MULTIPLE_USERS_DETECTED: string;
         VELT_CUSTOM_PRIORITY_MAP: string;
@@ -328,6 +348,8 @@ export declare class Constants {
         SNIPPYLY_DEFAULT_MEDIA_SOURCE_OPTIONS: string;
         SNIPPYLY_QUEUED_COMMENT: string;
         VELT_USER: string;
+        VELT_USER_FORCE_RE_LOGGED_IN: string;
+        VELT_VERSION: string;
     };
     static NON_NESTABLE_ELEMENTS: {
         [tag: string]: boolean;

package/models.d.ts

@@ -3,6 +3,7 @@ export * from './app/models/data/attachment.model';
 export * from './app/models/data/area-annotation.data.model';
 export * from './app/models/data/chatgpt.data.model';
 export * from './app/models/data/comment-annotation.data.model';
+export * from './app/models/data/comment-events.data.model';
 export * from './app/models/data/comment.data.model';
 export * from './app/models/data/config.data.model';
 export * from './app/models/data/cursor-position.data.model';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@veltdev/sdk-staging",
-    "version": "3.0.63",
+    "version": "3.0.64-patch.2",
     "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": [