@veltdev/sdk-staging 1.0.3 → 1.0.5

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.
@@ -2,22 +2,50 @@
2
2
  export declare class AreaElement {
3
3
  /**
4
4
  * To enable area feature
5
+ *
6
+ * @deprecated Use enableAreaComment instead.
5
7
  */
6
8
  enableArea: () => void;
7
9
 
8
10
  /**
9
11
  * To disable area feature
12
+ *
13
+ * @deprecated Use disableAreaComment instead.
10
14
  */
11
15
  disableArea: () => void;
16
+
17
+ /**
18
+ * To enable area feature
19
+ */
20
+ enableAreaComment: () => void;
21
+
22
+ /**
23
+ * To disable area feature
24
+ */
25
+ disableAreaComment: () => void;
12
26
  constructor();
13
27
 
14
28
  /**
15
29
  * To enable area feature
30
+ *
31
+ * @deprecated Use enableAreaComment instead.
16
32
  */
17
33
  private _enableArea;
18
34
 
19
35
  /**
20
36
  * To disable area feature
37
+ *
38
+ * @deprecated Use disableAreaComment instead.
21
39
  */
22
40
  private _disableArea;
41
+
42
+ /**
43
+ * To enable area feature
44
+ */
45
+ private _enableAreaComment;
46
+
47
+ /**
48
+ * To disable area feature
49
+ */
50
+ private _disableAreaComment;
23
51
  }
@@ -1,6 +1,7 @@
1
1
  // @ts-nocheck
2
2
  import { Observable } from "rxjs";
3
3
  import { CommentPinAnnotation } from "../data/comment-pin-annotation.data.model";
4
+ import { CustomCategory, CustomPriority, CustomStatus } from "../data/custom-filter.data.model";
4
5
  export declare class CommentElement {
5
6
  /**
6
7
  * Subscribe to comments on the current document.
@@ -31,17 +32,26 @@ export declare class CommentElement {
31
32
  allowedElementIds: (elementIds: string[]) => any;
32
33
 
33
34
  /**
34
- * To enable/disable floating comments
35
- *
36
- * By default floating comments will be enabled
37
- *
38
- * Pass `true` to disable floating comments
39
- *
40
- * Pass `false` to enable floating comments
41
- *
42
- * @param disable Enble/Disable floating comments
35
+ * To enable floating comments
36
+ * @deprecated Use enableFloatingMode instead
37
+ */
38
+ enableFloatingComments: () => any;
39
+
40
+ /**
41
+ * To disable floating comments
42
+ * @deprecated Use disableFloatingMode instead
43
+ */
44
+ disableFloatingComments: () => any;
45
+
46
+ /**
47
+ * To enable floating mode
48
+ */
49
+ enableFloatingMode: () => any;
50
+
51
+ /**
52
+ * To disable floating mode
43
53
  */
44
- disableFloatingComments: (disable: boolean) => any;
54
+ disableFloatingMode: () => any;
45
55
 
46
56
  /**
47
57
  * To add comments on specific elements
@@ -66,27 +76,38 @@ export declare class CommentElement {
66
76
  toggleCommentSidebar: () => any;
67
77
 
68
78
  /**
69
- * To enable/disable moderator mode
70
- *
71
- * @param moderatorMode pass `true` to enable it, `false` to disable it.
79
+ * To enable moderator mode
72
80
  */
73
- enableModeratorMode: (moderatorMode: boolean) => any;
81
+ enableModeratorMode: () => any;
74
82
 
75
83
  /**
76
- * To enable/disable stream mode
77
- *
78
- * @param enable pass `true` to enable it, `false` to disable it.
84
+ * To disable moderator mode
85
+ */
86
+ disableModeratorMode: () => any;
87
+
88
+ /**
89
+ * To enable stream mode
90
+ */
91
+ enableStreamMode: () => any;
92
+
93
+ /**
94
+ * To disable stream mode
79
95
  */
80
- enableStreamMode: (enable: boolean) => any;
96
+ disableStreamMode: () => any;
81
97
 
82
98
  /**
83
99
  * To show sign in button in comments if user is signed out
84
- *
85
- * @param enable pass `true` to enable it, `false` to disable it.
86
100
  */
87
- enableSignInButton: (enable: boolean) => any;
101
+ enableSignInButton: () => any;
102
+
103
+ /**
104
+ * To hide sign in button in comments if user is signed out
105
+ */
106
+ disableSignInButton: () => any;
88
107
 
89
108
  /**
109
+ * @deprecated Use onCommentModeChange instead
110
+ *
90
111
  * Subscribe to add comment mode change.
91
112
  *
92
113
  * Returns Observable<boolean>.
@@ -94,19 +115,60 @@ export declare class CommentElement {
94
115
  addCommentModeChange: () => Observable<boolean>;
95
116
 
96
117
  /**
97
- * Enable this feature to add attachments in comments
98
- *
99
- * @param enable pass `true` to enable it, `false` to disable it.
118
+ * Subscribe to comment mode change.
119
+ *
120
+ * Returns Observable<boolean>.
100
121
  */
101
- enableAttachment: (enable: boolean) => any;
122
+ onCommentModeChange: () => Observable<boolean>;
123
+
124
+ /**
125
+ * Enable attachments feature in comments
126
+ *
127
+ * @deprecated Use enableAttachments instead
128
+ */
129
+ enableAttachment: () => any;
130
+
131
+ /**
132
+ * Disable attachments feature in comments
133
+ *
134
+ * @deprecated Use disableAttachments instead
135
+ */
136
+ disableAttachment: () => any;
137
+
138
+ /**
139
+ * Enable attachments feature in comments
140
+ */
141
+ enableAttachments: () => any;
142
+
143
+ /**
144
+ * Disable attachments feature in comments
145
+ */
146
+ disableAttachments: () => any;
147
+
148
+ /**
149
+ * Get if user is part of global contact or not.
150
+ */
151
+ isUserGlobalContact: () => Observable<boolean>;
102
152
 
103
153
  /**
104
154
  * Enable this feature to show device info in comments
105
155
  *
106
156
  * @param showInfo pass `true` to show info, `false` to hide it.
157
+ *
158
+ * @deprecated Use enableDeviceInfo and disableDeviceInfo instead
107
159
  */
108
160
  showDeviceInfo: (showInfo: boolean) => any;
109
161
 
162
+ /**
163
+ * Enable device info in comments
164
+ */
165
+ enableDeviceInfo: () => any;
166
+
167
+ /**
168
+ * Disable device info in comments
169
+ */
170
+ disableDeviceInfo: () => any;
171
+
110
172
  /**
111
173
  * Enable comment mode to add comments.
112
174
  */
@@ -120,9 +182,21 @@ export declare class CommentElement {
120
182
  /**
121
183
  * To show/hide comment number
122
184
  * @param show pass `true` to show it, `false` to hide it.
185
+ *
186
+ * @deprecated Use enableCommentIndex and disableCommentIndex instead
123
187
  */
124
188
  public showCommentIndex: (show: boolean) => any;
125
189
 
190
+ /**
191
+ * To show comment number
192
+ */
193
+ public enableCommentIndex: () => any;
194
+
195
+ /**
196
+ * To hide comment number
197
+ */
198
+ public disableCommentIndex: () => any;
199
+
126
200
  /**
127
201
  * To enable popover mode
128
202
  */
@@ -175,34 +249,118 @@ export declare class CommentElement {
175
249
 
176
250
  /**
177
251
  * To enable feature to resolve comments
252
+ *
253
+ * @deprecated Use enableResolveButton instead
178
254
  */
179
255
  public enableResolve: () => any;
180
256
 
181
257
  /**
182
258
  * To disable feature to resolve comments
259
+ *
260
+ * @deprecated Use disableResolveButton instead
183
261
  */
184
262
  public disableResolve: () => any;
185
263
 
264
+ /**
265
+ * To enable feature to show resolve button
266
+ */
267
+ public enableResolveButton: () => any;
268
+
269
+ /**
270
+ * To disable feature to show resolve button
271
+ */
272
+ public disableResolveButton: () => any;
273
+
186
274
  /**
187
275
  * To enable feature to show ghost comments
276
+ *
277
+ * @deprecated Use enableGhostComments instead
188
278
  */
189
279
  public enableGhostCommentsInDOM: () => any;
190
280
 
191
281
  /**
192
282
  * To disable feature to show ghost comments
283
+ *
284
+ * @deprecated Use disableGhostComments instead
193
285
  */
194
286
  public disableGhostCommentsInDOM: () => any;
195
287
 
288
+ /**
289
+ * To enable feature to show ghost comments
290
+ */
291
+ public enableGhostComments: () => any;
292
+
293
+ /**
294
+ * To disable feature to show ghost comments
295
+ */
296
+ public disableGhostComments: () => any;
297
+
196
298
  /**
197
299
  * To enable feature to show ghost comments message in comment dialog and comment sidebar
300
+ *
301
+ * @deprecated Use enableGhostCommentsIndicator instead
198
302
  */
199
303
  public enableGhostCommentsMessage: () => any;
200
304
 
201
305
  /**
202
306
  * To disable feature to show ghost comments message in comment dialog and comment sidebar
307
+ *
308
+ * @deprecated Use disableGhostCommentsIndicator instead
203
309
  */
204
310
  public disableGhostCommentsMessage: () => any;
205
311
 
312
+ /**
313
+ * To enable feature to show ghost comments message in comment dialog and comment sidebar
314
+ */
315
+ public enableGhostCommentsIndicator: () => any;
316
+
317
+ /**
318
+ * To disable feature to show ghost comments message in comment dialog and comment sidebar
319
+ */
320
+ public disableGhostCommentsIndicator: () => any;
321
+
322
+ /**
323
+ * @description Sets custom status filters
324
+ * @param statuses
325
+ *
326
+ * @deprecated Use setCustomStatus instead
327
+ */
328
+ setCustomStatuses: (statuses: CustomStatus[]) => void;
329
+
330
+ /**
331
+ * @description Sets custom status filters
332
+ * @param statuses
333
+ */
334
+ setCustomStatus: (statuses: CustomStatus[]) => void;
335
+
336
+ /**
337
+ * @description Sets custom priority filters
338
+ * @param priorities
339
+ *
340
+ * @deprecated Use setCustomPriority instead
341
+ */
342
+ setCustomPriorities: (priorities: CustomPriority[]) => void;
343
+
344
+ /**
345
+ * @description Sets custom priority filters
346
+ * @param priorities
347
+ */
348
+ setCustomPriority: (priorities: CustomPriority[]) => void;
349
+
350
+ /**
351
+ * @description Sets custom categories filters
352
+ * @param categories
353
+ *
354
+ * @deprecated Use setCustomCategory instead
355
+ */
356
+ setCustomCategories: (categories: CustomCategory[]) => void;
357
+
358
+ /**
359
+ * @description Sets custom categories filters
360
+ * @param categories
361
+ */
362
+ setCustomCategory: (categories: CustomCategory[]) => void;
363
+
206
364
  /**
207
365
  * To enable inbox mode
208
366
  */
@@ -223,6 +381,22 @@ export declare class CommentElement {
223
381
  */
224
382
  public disableAutoCategorize: () => any;
225
383
 
384
+ /**
385
+ * To enable dark mode in comments
386
+ */
387
+ public enableDarkMode: () => any;
388
+
389
+ /**
390
+ * To disable dark mode in comments
391
+ */
392
+ public disableDarkMode: () => any;
393
+
394
+ /**
395
+ * @description Sets the comment context provider
396
+ * @param provider
397
+ */
398
+ public setContextProvider: (provider: (documentId: string, location?: any) => any) => void;
399
+
226
400
  /**
227
401
  * To enable suggestion mode
228
402
  */
@@ -262,18 +436,27 @@ export declare class CommentElement {
262
436
  private _allowedElementIds;
263
437
 
264
438
  /**
265
- * To enable/disable floating comments
266
- *
267
- * By default floating comments will be enabled
268
- *
269
- * Pass `true` to disable floating comments
270
- *
271
- * Pass `false` to enable floating comments
272
- *
273
- * @param disable Enble/Disable floating comments
439
+ * To enable floating comments
440
+ * @deprecated Use enableFloatingMode instead
441
+ */
442
+ private _enableFloatingComments;
443
+
444
+ /**
445
+ * To disable floating comments
446
+ * @deprecated Use disableFloatingMode instead
274
447
  */
275
448
  private _disableFloatingComments;
276
449
 
450
+ /**
451
+ * To enable floating mode
452
+ */
453
+ private _enableFloatingMode;
454
+
455
+ /**
456
+ * To disable floating mode
457
+ */
458
+ private _disableFloatingMode;
459
+
277
460
  /**
278
461
  * To add comments on specific elements
279
462
  *
@@ -297,27 +480,38 @@ export declare class CommentElement {
297
480
  private _toggleCommentSidebar;
298
481
 
299
482
  /**
300
- * To enable/disable moderator mode
301
- *
302
- * @param moderatorMode pass `true` to enable it, `false` to disable it.
483
+ * To enable moderator mode
303
484
  */
304
485
  private _enableModeratorMode;
305
486
 
306
487
  /**
307
- * To enable/disable stream mode
308
- *
309
- * @param enable pass `true` to enable it, `false` to disable it.
488
+ * To disable moderator mode
489
+ */
490
+ private _disableModeratorMode;
491
+
492
+ /**
493
+ * To enable stream mode
310
494
  */
311
495
  private _enableStreamMode;
312
496
 
497
+ /**
498
+ * To disable stream mode
499
+ */
500
+ private _disableStreamMode;
501
+
313
502
  /**
314
503
  * To show sign in button in comments if user is signed out
315
- *
316
- * @param enable pass `true` to enable it, `false` to disable it.
317
504
  */
318
505
  private _enableSignInButton;
319
506
 
320
507
  /**
508
+ * To hide sign in button in comments if user is signed out
509
+ */
510
+ private _disableSignInButton;
511
+
512
+ /**
513
+ * @deprecated Use onCommentModeChange instead
514
+ *
321
515
  * Subscribe to add comment mode change.
322
516
  *
323
517
  * Returns Observable<boolean>.
@@ -325,19 +519,55 @@ export declare class CommentElement {
325
519
  private _addCommentModeChange;
326
520
 
327
521
  /**
328
- * Enable this feature to add attachments in comments
329
- *
330
- * @param enable pass `true` to enable it, `false` to disable it.
522
+ * Subscribe to comment mode change.
523
+ *
524
+ * Returns Observable<boolean>.
525
+ */
526
+ private _onCommentModeChange;
527
+
528
+ /**
529
+ * Enable attachments feature in comments
530
+ *
531
+ * @deprecated Use enableAttachments instead
331
532
  */
332
533
  private _enableAttachment;
333
534
 
535
+ /**
536
+ * Disable attachments feature in comments
537
+ *
538
+ * @deprecated Use disableAttachments instead
539
+ */
540
+ private _disableAttachment;
541
+
542
+ /**
543
+ * To enable attachments feature in comments
544
+ */
545
+ private _enableAttachments;
546
+
547
+ /**
548
+ * To disable attachments feature in comments
549
+ */
550
+ private _disableAttachments;
551
+
334
552
  /**
335
553
  * Enable this feature to show device info in comments
336
554
  *
337
555
  * @param showInfo pass `true` to show info, `false` to hide it.
556
+ *
557
+ * @deprecated Use enableDeviceInfo and disableDeviceInfo instead
338
558
  */
339
559
  private _showDeviceInfo;
340
560
 
561
+ /**
562
+ * Enable device info in comments
563
+ */
564
+ private _enableDeviceInfo;
565
+
566
+ /**
567
+ * Disable device info in comments
568
+ */
569
+ private _disableDeviceInfo;
570
+
341
571
  /**
342
572
  * Enable comment mode to add comments.
343
573
  */
@@ -351,9 +581,21 @@ export declare class CommentElement {
351
581
  /**
352
582
  * To show/hide comment number
353
583
  * @param show pass `true` to show it, `false` to hide it.
584
+ *
585
+ * @deprecated Use enableCommentIndex and disableCommentIndex instead
354
586
  */
355
587
  private _showCommentIndex;
356
588
 
589
+ /**
590
+ * To enable comment number
591
+ */
592
+ private _enableCommentIndex;
593
+
594
+ /**
595
+ * To disable comment number
596
+ */
597
+ private _disableCommentIndex;
598
+
357
599
  /**
358
600
  * To enable popover mode
359
601
  */
@@ -406,34 +648,118 @@ export declare class CommentElement {
406
648
 
407
649
  /**
408
650
  * To enable feature to resolve comments
651
+ *
652
+ * @deprecated Use enableResolveButton instead
409
653
  */
410
654
  private _enableResolve;
411
655
 
412
656
  /**
413
657
  * To disable feature to resolve comments
658
+ *
659
+ * @deprecated Use disableResolveButton instead
414
660
  */
415
661
  private _disableResolve;
416
662
 
663
+ /**
664
+ * To enable feature to show resolve button
665
+ */
666
+ private _enableResolveButton;
667
+
668
+ /**
669
+ * To disable feature to show resolve button
670
+ */
671
+ private _disableResolveButton;
672
+
417
673
  /**
418
674
  * To enable feature to show ghost comments
675
+ *
676
+ * @deprecated Use enableGhostComments instead
419
677
  */
420
678
  private _enableGhostCommentsInDOM;
421
679
 
422
680
  /**
423
681
  * To disable feature to show ghost comments
682
+ *
683
+ * @deprecated Use disableGhostComments instead
424
684
  */
425
685
  private _disableGhostCommentsInDOM;
426
686
 
687
+ /**
688
+ * To enable feature to show ghost comments
689
+ */
690
+ private _enableGhostComments;
691
+
692
+ /**
693
+ * To disable feature to show ghost comments
694
+ */
695
+ private _disableGhostComments;
696
+
427
697
  /**
428
698
  * To enable feature to show ghost comments message in comment dialog and comment sidebar
699
+ *
700
+ * @deprecated Use enableGhostCommentsIndicator instead
429
701
  */
430
702
  private _enableGhostCommentsMessage;
431
703
 
432
704
  /**
433
705
  * To disable feature to show ghost comments message in comment dialog and comment sidebar
706
+ *
707
+ * @deprecated Use disableGhostCommentsIndicator instead
434
708
  */
435
709
  private _disableGhostCommentsMessage;
436
710
 
711
+ /**
712
+ * To enable feature to show ghost comments message in comment dialog and comment sidebar
713
+ */
714
+ private _enableGhostCommentsIndicator;
715
+
716
+ /**
717
+ * To disable feature to show ghost comments message in comment dialog and comment sidebar
718
+ */
719
+ private _disableGhostCommentsIndicator;
720
+
721
+ /**
722
+ * @description Sets custom status filters
723
+ * @param statuses
724
+ *
725
+ * @deprecated Use setCustomStatus instead
726
+ */
727
+ private _setCustomStatuses;
728
+
729
+ /**
730
+ * @description Sets custom status filters
731
+ * @param statuses
732
+ */
733
+ private _setCustomStatus;
734
+
735
+ /**
736
+ * @description Sets custom priority filters
737
+ * @param priorities
738
+ *
739
+ * @deprecated Use setCustomPriority instead
740
+ */
741
+ private _setCustomPriorities;
742
+
743
+ /**
744
+ * @description Sets custom priority filters
745
+ * @param priorities
746
+ */
747
+ private _setCustomPriority;
748
+
749
+ /**
750
+ * @description Sets custom categories filters
751
+ * @param categories
752
+ *
753
+ * @deprecated Use setCustomCategory instead
754
+ */
755
+ private _setCustomCategories;
756
+
757
+ /**
758
+ * @description Sets custom categories filters
759
+ * @param categories
760
+ */
761
+ private _setCustomCategory;
762
+
437
763
  /**
438
764
  * To enable inbox mode
439
765
  */
@@ -454,6 +780,22 @@ export declare class CommentElement {
454
780
  */
455
781
  private _disableAutoCategorize;
456
782
 
783
+ /**
784
+ * To enable dark mode in comments
785
+ */
786
+ private _enableDarkMode;
787
+
788
+ /**
789
+ * To disable dark mode in comments
790
+ */
791
+ private _disableDarkMode;
792
+
793
+ /**
794
+ * @description Sets the comment context provider
795
+ * @param provider
796
+ */
797
+ private _setContextProvider;
798
+
457
799
  /**
458
800
  * To enable suggestion mode
459
801
  */
@@ -6,9 +6,18 @@ export declare class CursorElement {
6
6
  * Subscribe to cursors of all online users who are either active or inactive on the current document.
7
7
  *
8
8
  * Returns Observable<CursorUser[] | null>.
9
+ *
10
+ * @deprecated Use getOnlineUsersOnCurrentDocument instead.
9
11
  */
10
12
  getLiveCursorsOnCurrentDocument: () => Observable<CursorUser[] | null>;
11
13
 
14
+ /**
15
+ * Subscribe to cursors of all online users who are either active or inactive on the current document.
16
+ *
17
+ * Returns Observable<CursorUser[] | null>.
18
+ */
19
+ getOnlineUsersOnCurrentDocument: () => Observable<CursorUser[] | null>;
20
+
12
21
  /**
13
22
  * To set inactivity time (Default value is 2 minutes)
14
23
  * @param time inactivity time in milliseconds
@@ -25,9 +34,18 @@ export declare class CursorElement {
25
34
  * Subscribe to cursors of all online users who are either active or inactive on the current document.
26
35
  *
27
36
  * Returns Observable<CursorUser[] | null>.
37
+ *
38
+ * @deprecated Use getOnlineUsersOnCurrentDocument instead.
28
39
  */
29
40
  private _getLiveCursorsOnCurrentDocument;
30
41
 
42
+ /**
43
+ * Subscribe to cursors of all online users who are either active or inactive on the current document.
44
+ *
45
+ * Returns Observable<CursorUser[] | null>.
46
+ */
47
+ private _getOnlineUsersOnCurrentDocument;
48
+
31
49
  /**
32
50
  * To set inactivity time (Default value is 2 minutes)
33
51
  * @param time inactivity time in milliseconds