@veltdev/sdk 3.0.40 → 3.0.42

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -34,23 +34,24 @@ export declare class CommentSidebarFilters {
34
34
  name?: string;
35
35
  }[];
36
36
  }
37
- export interface CommentSidebarActionsConfig {
37
+ export interface CommentSidebarCustomActionsState {
38
38
  [key: string]: boolean;
39
39
  }
40
- export interface CommentSidebarDataConfig {
41
- actions: CommentSidebarActionsConfig;
40
+ export interface CommentSidebarCustomActionEventData {
41
+ actions: CommentSidebarCustomActionsState;
42
42
  data: CommentAnnotation[];
43
43
  unreadDataMap: {
44
44
  [commentAnnotationId: string]: number;
45
45
  };
46
46
  systemFilteredData: CommentAnnotation[];
47
47
  }
48
- export interface CommentSidebarData {
49
- type: 'group';
50
- data: {
51
- displayName: string;
52
- isExpanded: boolean;
53
- annotations: CommentAnnotation[];
54
- };
48
+ export declare class CommentSidebarData {
49
+ groupId?: string;
50
+ groupName?: string;
51
+ isExpanded?: boolean;
52
+ annotations: CommentAnnotation[];
53
+ }
54
+ export declare class CommentSidebarDataOptions {
55
+ grouping?: boolean;
55
56
  }
56
57
  export {};
@@ -54,6 +54,7 @@ export declare class Comment {
54
54
  * Auto generated.
55
55
  */
56
56
  lastUpdated?: Date;
57
+ createdAt?: any;
57
58
  status: 'added' | 'updated';
58
59
  /**
59
60
  * List of attachments.
@@ -20,3 +20,11 @@ export declare class Selection {
20
20
  targetTextRange?: TargetTextRange | null;
21
21
  pageInfo: PageInfo;
22
22
  }
23
+ export declare enum UserIndicatorPosition {
24
+ Start = "start",
25
+ End = "end"
26
+ }
27
+ export declare enum UserIndicatorType {
28
+ Avatar = "avatar",
29
+ Label = "label"
30
+ }
@@ -4,7 +4,7 @@ import { CommentAnnotation, CommentOnElementConfig, CommentSelectionChangeData,
4
4
  import { CustomCategory, CustomPriority, CustomStatus } from "../data/custom-filter.data.model";
5
5
  import { CustomAnnotationDropdownData } from "../data/custom-chip-dropdown.data.model";
6
6
  import { AutocompleteData } from "../data/autocomplete.data.model";
7
-
7
+ import { CommentSidebarCustomActionEventData, CommentSidebarData, CommentSidebarDataOptions } from "../data/comment-sidebar-config.model";
8
8
  export { ReactionMap } from '../data/reaction-annotation.data.model';
9
9
  export declare class CommentElement {
10
10
  /**
@@ -827,41 +827,41 @@ export declare class CommentElement {
827
827
  * Subscribe to comment sidebar action button click
828
828
  * @returns comment sidebar data
829
829
  */
830
- public onCommentSidebarActionButtonClick: () => Observable<CommentSidebarDataConfig | null>;
830
+ public onCommentSidebarActionButtonClick: () => Observable<CommentSidebarCustomActionEventData | null>;
831
831
 
832
832
  /**
833
833
  * To set comment sidebar data
834
834
  * @param data comment sidebar data
835
835
  */
836
- public setCommentSidebarData: (data: CommentSidebarData[]) => void;
836
+ public setCommentSidebarData: (data: CommentSidebarData[], options?: CommentSidebarDataOptions) => void;
837
837
 
838
838
  /**
839
839
  * Subscribe to comment sidebar init
840
840
  * @returns comment sidebar data
841
841
  */
842
- public onCommentSidebarInit: () => Observable<CommentSidebarDataConfig | null>;
842
+ public onCommentSidebarInit: () => Observable<CommentSidebarCustomActionEventData | null>;
843
843
 
844
844
  /**
845
845
  * Subscribe to comment sidebar data
846
846
  * @returns comment sidebar data
847
847
  */
848
- public onCommentSidebarData: () => Observable<CommentSidebarDataConfig | null>;
848
+ public onCommentSidebarData: () => Observable<CommentSidebarCustomActionEventData | null>;
849
849
 
850
850
  /**
851
851
  * To set comment sidebar default actions config
852
852
  * @param data comment sidebar default actions config
853
853
  */
854
- public setCommentSidebarDefaultActionsConfig: (data: CommentSidebarActionsConfig) => void;
854
+ public setCommentSidebarDefaultCustomActions: (data: CommentSidebarCustomActionsState) => void;
855
855
 
856
856
  /**
857
857
  * To enable comment sidebar custom filter mode
858
858
  */
859
- public enableCommentSidebarCustomFilterMode: () => void;
859
+ public enableSidebarCustomActions: () => void;
860
860
 
861
861
  /**
862
862
  * To disable comment sidebar custom filter mode
863
863
  */
864
- public disableCommentSidebarCustomFilterMode: () => void;
864
+ public disableSidebarCustomActions: () => void;
865
865
 
866
866
  constructor();
867
867
  /**
@@ -1681,6 +1681,7 @@ export declare class CommentElement {
1681
1681
  /**
1682
1682
  * To set comment sidebar data
1683
1683
  * @param data comment sidebar data
1684
+ * @param options options
1684
1685
  */
1685
1686
  private _setCommentSidebarData;
1686
1687
 
@@ -1700,15 +1701,15 @@ export declare class CommentElement {
1700
1701
  * To set comment sidebar default actions config
1701
1702
  * @param data comment sidebar default actions config
1702
1703
  */
1703
- private _setCommentSidebarDefaultActionsConfig;
1704
+ private _setCommentSidebarDefaultCustomActions;
1704
1705
 
1705
1706
  /**
1706
1707
  * To enable comment sidebar custom filter mode
1707
1708
  */
1708
- private _enableCommentSidebarCustomFilterMode;
1709
+ private _enableSidebarCustomActions;
1709
1710
 
1710
1711
  /**
1711
1712
  * To disable comment sidebar custom filter mode
1712
1713
  */
1713
- private _disableCommentSidebarCustomFilterMode;
1714
+ private _disableSidebarCustomActions;
1714
1715
  }
@@ -1,4 +1,5 @@
1
1
  // @ts-nocheck
2
+ import { UserIndicatorPosition, UserIndicatorType } from "../data/selection.model";
2
3
  export declare class SelectionElement {
3
4
  /**
4
5
  * To enable selections
@@ -8,7 +9,48 @@ export declare class SelectionElement {
8
9
  /**
9
10
  * To disable selections
10
11
  */
11
- disableLiveSelection: () => void;
12
+ disableLiveSelection: () => void;
13
+
14
+ /**
15
+ * To enable user indicator
16
+ */
17
+ enableUserIndicator: () => void;
18
+
19
+ /**
20
+ * To disable user indicator
21
+ */
22
+ disableUserIndicator: () => void;
23
+
24
+ /**
25
+ * To set user indicator position
26
+ */
27
+ setUserIndicatorPosition: (position: UserIndicatorPosition) => void;
28
+
29
+ /**
30
+ * To set user indicator type
31
+ */
32
+ setUserIndicatorType: (type: UserIndicatorType) => void;
33
+
34
+ /**
35
+ * To enable default elements tracking
36
+ */
37
+ enableDefaultElementsTracking: () => void;
38
+
39
+ /**
40
+ * To disable default elements tracking
41
+ */
42
+ disableDefaultElementsTracking: () => void;
43
+
44
+ /**
45
+ * To enable default styling
46
+ */
47
+ enableDefaultStyling: () => void;
48
+
49
+ /**
50
+ * To disable default styling
51
+ */
52
+ disableDefaultStyling: () => void;
53
+
12
54
  constructor();
13
55
 
14
56
  /**
@@ -20,4 +62,44 @@ export declare class SelectionElement {
20
62
  * To disable selections
21
63
  */
22
64
  private _disableLiveSelection;
23
- }
65
+
66
+ /**
67
+ * To enable user indicator
68
+ */
69
+ private _enableUserIndicator;
70
+
71
+ /**
72
+ * To disable user indicator
73
+ */
74
+ private _disableUserIndicator;
75
+
76
+ /**
77
+ * To set user indicator position
78
+ */
79
+ private _setUserIndicatorPosition;
80
+
81
+ /**
82
+ * To set user indicator type
83
+ */
84
+ private _setUserIndicatorType;
85
+
86
+ /**
87
+ * To enable default elements tracking
88
+ */
89
+ private _enableDefaultElementsTracking;
90
+
91
+ /**
92
+ * To disable default elements tracking
93
+ */
94
+ private _disableDefaultElementsTracking;
95
+
96
+ /**
97
+ * To enable default styling
98
+ */
99
+ private _enableDefaultStyling;
100
+
101
+ /**
102
+ * To disable default styling
103
+ */
104
+ private _disableDefaultStyling;
105
+ }
@@ -62,6 +62,10 @@ export declare class Constants {
62
62
  static SNIPPYLY_HIGHLIGHT_USER: string;
63
63
  static SNIPPYLY_HIGHLIGHT_USER_NAME: string;
64
64
  static SNIPPYLY_HIGHLIGHT_USER_TEXT: string;
65
+ static VELT_LIVE_SELECTION_ON_ELEMENT: string;
66
+ static VELT_LIVE_SELECTION_ON_ELEMENT_DEFAULT: string;
67
+ static VELT_LIVE_SELECTION_ON_TEXT: string;
68
+ static VELT_LIVE_SELECTION_ON_TEXT_DEFAULT: string;
65
69
  static VELT_IGNORE_CHANGE_DETECTION: string;
66
70
  static VELT_CUSTOM_CSS: string;
67
71
  static TAGS: {
@@ -260,6 +264,9 @@ export declare class Constants {
260
264
  DEFAULT_CURSOR: string;
261
265
  VELT_HUDDLE_ON_CURSOR_MODE: string;
262
266
  VELT_SELECTION_ENABLED: string;
267
+ VELT_LIVE_SELECTION_ENABLED: string;
268
+ VELT_LIVE_SELECTION_USER_INDICATOR_POSITION: string;
269
+ VELT_LIVE_SELECTION_USER_INDICATOR_TYPE: string;
263
270
  VELT_SELECTION_CONFIG: string;
264
271
  VELT_POPOVER_MODE: string;
265
272
  VELT_ELEMENT_CACHE_ID: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@veltdev/sdk",
3
- "version": "3.0.40",
3
+ "version": "3.0.42",
4
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.",
5
5
  "homepage": "https://velt.dev",
6
6
  "keywords": [