@veltdev/react 1.0.52 → 1.0.54
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.
- package/cjs/index.js +5 -17
- package/cjs/index.js.map +1 -1
- package/cjs/types/components/SnippylyComments/SnippylyComments.d.ts +1 -85
- package/cjs/types/components/SnippylyCommentsSidebar/SnippylyCommentsSidebar.d.ts +30 -0
- package/cjs/types/constants.d.ts +1 -1
- package/esm/index.js +5 -17
- package/esm/index.js.map +1 -1
- package/esm/types/components/SnippylyComments/SnippylyComments.d.ts +1 -85
- package/esm/types/components/SnippylyCommentsSidebar/SnippylyCommentsSidebar.d.ts +30 -0
- package/esm/types/constants.d.ts +1 -1
- package/index.d.ts +36 -90
- package/package.json +1 -1
|
@@ -1,37 +1,17 @@
|
|
|
1
1
|
import React from 'react';
|
|
2
2
|
export interface IVeltCommentsProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> {
|
|
3
3
|
streamViewContainerId?: string;
|
|
4
|
-
/**
|
|
5
|
-
* @deprecated
|
|
6
|
-
*/
|
|
7
|
-
pinHighlighterClass?: string;
|
|
8
|
-
/**
|
|
9
|
-
* @deprecated
|
|
10
|
-
*/
|
|
11
|
-
textHighlighterClass?: string;
|
|
12
4
|
autoCategorize?: boolean;
|
|
13
|
-
/**
|
|
14
|
-
* @deprecated Use `onSignIn` instead
|
|
15
|
-
*/
|
|
16
|
-
signIn?: Function;
|
|
17
5
|
onSignIn?: Function;
|
|
18
6
|
onUpgrade?: Function;
|
|
19
7
|
textMode?: boolean;
|
|
20
8
|
popoverMode?: boolean;
|
|
21
9
|
popoverTriangleComponent?: boolean;
|
|
22
|
-
/**
|
|
23
|
-
* @deprecated Use `floatingMode` instead
|
|
24
|
-
*/
|
|
25
|
-
floatingCommentsMode?: boolean;
|
|
26
10
|
floatingCommentDialog?: boolean;
|
|
27
11
|
moderatorMode?: boolean;
|
|
28
12
|
streamMode?: boolean;
|
|
29
13
|
signInButton?: boolean;
|
|
30
14
|
upgradeButton?: boolean;
|
|
31
|
-
/**
|
|
32
|
-
* @deprecated Use `attachments` instead
|
|
33
|
-
*/
|
|
34
|
-
allowAttachments?: boolean;
|
|
35
15
|
attachments?: boolean;
|
|
36
16
|
/**
|
|
37
17
|
* Pass `all` to allow all type of recordings.
|
|
@@ -41,32 +21,12 @@ export interface IVeltCommentsProps extends React.DetailedHTMLProps<React.HTMLAt
|
|
|
41
21
|
*/
|
|
42
22
|
recordings?: string;
|
|
43
23
|
reactions?: boolean;
|
|
44
|
-
/**
|
|
45
|
-
* @deprecated Use `deviceInfo` instead
|
|
46
|
-
*/
|
|
47
|
-
showDeviceInfo?: boolean;
|
|
48
24
|
deviceInfo?: boolean;
|
|
49
|
-
/**
|
|
50
|
-
* @deprecated Use `commentIndex` instead
|
|
51
|
-
*/
|
|
52
|
-
showCommentIndex?: boolean;
|
|
53
25
|
commentIndex?: boolean;
|
|
54
26
|
dialogOnHover?: boolean;
|
|
55
27
|
dialogOnTargetElementClick?: boolean;
|
|
56
|
-
/**
|
|
57
|
-
* @deprecated Use `priority` instead
|
|
58
|
-
*/
|
|
59
|
-
showPriority?: boolean;
|
|
60
28
|
priority?: boolean;
|
|
61
|
-
/**
|
|
62
|
-
* @deprecated Use `status` instead
|
|
63
|
-
*/
|
|
64
|
-
showStatus?: boolean;
|
|
65
29
|
status?: boolean;
|
|
66
|
-
/**
|
|
67
|
-
* @deprecated Use `resolveButton` instead
|
|
68
|
-
*/
|
|
69
|
-
showResolveButton?: boolean;
|
|
70
30
|
resolveButton?: boolean;
|
|
71
31
|
inboxMode?: boolean;
|
|
72
32
|
suggestionMode?: boolean;
|
|
@@ -76,46 +36,19 @@ export interface IVeltCommentsProps extends React.DetailedHTMLProps<React.HTMLAt
|
|
|
76
36
|
minimap?: boolean;
|
|
77
37
|
persistentCommentMode?: boolean;
|
|
78
38
|
ghostComments?: boolean;
|
|
79
|
-
/**
|
|
80
|
-
* @deprecated Use `ghostCommentsIndicator` instead
|
|
81
|
-
*/
|
|
82
|
-
ghostCommentsMessage?: boolean;
|
|
83
39
|
ghostCommentsIndicator?: boolean;
|
|
84
40
|
commentsOnDom?: boolean;
|
|
85
41
|
commentTool?: boolean;
|
|
86
42
|
sidebarButtonOnCommentDialog?: boolean;
|
|
87
43
|
scrollToComponent?: boolean;
|
|
44
|
+
userMentions?: boolean;
|
|
88
45
|
allowedElementIds?: string[];
|
|
89
|
-
/**
|
|
90
|
-
* @deprecated Use `onCommentAdd` instead
|
|
91
|
-
*/
|
|
92
|
-
commentAdded?: Function;
|
|
93
46
|
onCommentAdd?: Function;
|
|
94
47
|
onCustomPinInject?: Function;
|
|
95
48
|
onCommentUpdate?: Function;
|
|
96
|
-
/**
|
|
97
|
-
* @deprecated Use `onCommentAccept` instead
|
|
98
|
-
*/
|
|
99
|
-
commentAccepted?: Function;
|
|
100
49
|
onCommentAccept?: Function;
|
|
101
|
-
/**
|
|
102
|
-
* @deprecated Use `onCommentReject` instead
|
|
103
|
-
*/
|
|
104
|
-
commentRejected?: Function;
|
|
105
50
|
onCommentReject?: Function;
|
|
106
51
|
onSidebarButtonOnCommentDialogClick?: Function;
|
|
107
|
-
/**
|
|
108
|
-
* @deprecated Use `customStatus` instead
|
|
109
|
-
*/
|
|
110
|
-
customStatuses?: {
|
|
111
|
-
id: string;
|
|
112
|
-
color: string;
|
|
113
|
-
name: string;
|
|
114
|
-
type: 'default' | 'ongoing' | 'terminal';
|
|
115
|
-
lightColor?: string;
|
|
116
|
-
svg?: string;
|
|
117
|
-
iconUrl?: string;
|
|
118
|
-
}[];
|
|
119
52
|
customStatus?: {
|
|
120
53
|
id: string;
|
|
121
54
|
color: string;
|
|
@@ -125,29 +58,12 @@ export interface IVeltCommentsProps extends React.DetailedHTMLProps<React.HTMLAt
|
|
|
125
58
|
svg?: string;
|
|
126
59
|
iconUrl?: string;
|
|
127
60
|
}[];
|
|
128
|
-
/**
|
|
129
|
-
* @deprecated Use `customPriority` instead
|
|
130
|
-
*/
|
|
131
|
-
customPriorities?: {
|
|
132
|
-
id: string;
|
|
133
|
-
color: string;
|
|
134
|
-
name: string;
|
|
135
|
-
lightColor?: string;
|
|
136
|
-
}[];
|
|
137
61
|
customPriority?: {
|
|
138
62
|
id: string;
|
|
139
63
|
color: string;
|
|
140
64
|
name: string;
|
|
141
65
|
lightColor?: string;
|
|
142
66
|
}[];
|
|
143
|
-
/**
|
|
144
|
-
* @deprecated Use `customCategory` instead
|
|
145
|
-
*/
|
|
146
|
-
customCategories?: {
|
|
147
|
-
id: string;
|
|
148
|
-
color: string;
|
|
149
|
-
name: string;
|
|
150
|
-
}[];
|
|
151
67
|
customCategory?: {
|
|
152
68
|
id: string;
|
|
153
69
|
color: string;
|
|
@@ -1,4 +1,31 @@
|
|
|
1
1
|
import React from 'react';
|
|
2
|
+
declare class FilterTypeConfig {
|
|
3
|
+
name?: string;
|
|
4
|
+
enable?: boolean;
|
|
5
|
+
multiSelection?: boolean;
|
|
6
|
+
enableGrouping?: boolean;
|
|
7
|
+
}
|
|
8
|
+
declare class CommentSidebarFilterConfig {
|
|
9
|
+
location?: FilterTypeConfig;
|
|
10
|
+
people?: FilterTypeConfig;
|
|
11
|
+
priority?: FilterTypeConfig;
|
|
12
|
+
category?: FilterTypeConfig;
|
|
13
|
+
commentType?: FilterTypeConfig;
|
|
14
|
+
}
|
|
15
|
+
declare class CommentSidebarGroupConfig {
|
|
16
|
+
enable?: boolean;
|
|
17
|
+
name?: string;
|
|
18
|
+
}
|
|
19
|
+
declare class CommentSidebarFilters {
|
|
20
|
+
location?: Location[];
|
|
21
|
+
people?: {
|
|
22
|
+
userId?: string;
|
|
23
|
+
email?: string;
|
|
24
|
+
}[];
|
|
25
|
+
priority?: string[];
|
|
26
|
+
status?: string[];
|
|
27
|
+
category?: string[];
|
|
28
|
+
}
|
|
2
29
|
export interface IVeltCommentsSidebarProps {
|
|
3
30
|
embedMode?: boolean;
|
|
4
31
|
/**
|
|
@@ -8,6 +35,9 @@ export interface IVeltCommentsSidebarProps {
|
|
|
8
35
|
urlNavigation?: boolean;
|
|
9
36
|
pageMode?: boolean;
|
|
10
37
|
currentLocationSuffix?: boolean;
|
|
38
|
+
filterConfig?: CommentSidebarFilterConfig;
|
|
39
|
+
groupConfig?: CommentSidebarGroupConfig;
|
|
40
|
+
filters?: CommentSidebarFilters;
|
|
11
41
|
/**
|
|
12
42
|
* @deprecated Use `onSidebarOpen` instead
|
|
13
43
|
*/
|
package/esm/types/constants.d.ts
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const VELT_SDK_VERSION = "1.0.
|
|
1
|
+
export declare const VELT_SDK_VERSION = "1.0.64";
|
package/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/// <reference types="react" />
|
|
2
2
|
import React from 'react';
|
|
3
|
-
import { Config, Velt, User, UserOptions, Location } from '@veltdev/types';
|
|
3
|
+
import { Config, Velt, User, UserOptions, Location as Location$1 } from '@veltdev/types';
|
|
4
4
|
|
|
5
5
|
interface IVeltProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> {
|
|
6
6
|
apiKey: string;
|
|
@@ -31,37 +31,17 @@ declare const SnippylyCommentBubble: React.FC<IVeltCommentBubbleProps>;
|
|
|
31
31
|
|
|
32
32
|
interface IVeltCommentsProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> {
|
|
33
33
|
streamViewContainerId?: string;
|
|
34
|
-
/**
|
|
35
|
-
* @deprecated
|
|
36
|
-
*/
|
|
37
|
-
pinHighlighterClass?: string;
|
|
38
|
-
/**
|
|
39
|
-
* @deprecated
|
|
40
|
-
*/
|
|
41
|
-
textHighlighterClass?: string;
|
|
42
34
|
autoCategorize?: boolean;
|
|
43
|
-
/**
|
|
44
|
-
* @deprecated Use `onSignIn` instead
|
|
45
|
-
*/
|
|
46
|
-
signIn?: Function;
|
|
47
35
|
onSignIn?: Function;
|
|
48
36
|
onUpgrade?: Function;
|
|
49
37
|
textMode?: boolean;
|
|
50
38
|
popoverMode?: boolean;
|
|
51
39
|
popoverTriangleComponent?: boolean;
|
|
52
|
-
/**
|
|
53
|
-
* @deprecated Use `floatingMode` instead
|
|
54
|
-
*/
|
|
55
|
-
floatingCommentsMode?: boolean;
|
|
56
40
|
floatingCommentDialog?: boolean;
|
|
57
41
|
moderatorMode?: boolean;
|
|
58
42
|
streamMode?: boolean;
|
|
59
43
|
signInButton?: boolean;
|
|
60
44
|
upgradeButton?: boolean;
|
|
61
|
-
/**
|
|
62
|
-
* @deprecated Use `attachments` instead
|
|
63
|
-
*/
|
|
64
|
-
allowAttachments?: boolean;
|
|
65
45
|
attachments?: boolean;
|
|
66
46
|
/**
|
|
67
47
|
* Pass `all` to allow all type of recordings.
|
|
@@ -71,32 +51,12 @@ interface IVeltCommentsProps extends React.DetailedHTMLProps<React.HTMLAttribute
|
|
|
71
51
|
*/
|
|
72
52
|
recordings?: string;
|
|
73
53
|
reactions?: boolean;
|
|
74
|
-
/**
|
|
75
|
-
* @deprecated Use `deviceInfo` instead
|
|
76
|
-
*/
|
|
77
|
-
showDeviceInfo?: boolean;
|
|
78
54
|
deviceInfo?: boolean;
|
|
79
|
-
/**
|
|
80
|
-
* @deprecated Use `commentIndex` instead
|
|
81
|
-
*/
|
|
82
|
-
showCommentIndex?: boolean;
|
|
83
55
|
commentIndex?: boolean;
|
|
84
56
|
dialogOnHover?: boolean;
|
|
85
57
|
dialogOnTargetElementClick?: boolean;
|
|
86
|
-
/**
|
|
87
|
-
* @deprecated Use `priority` instead
|
|
88
|
-
*/
|
|
89
|
-
showPriority?: boolean;
|
|
90
58
|
priority?: boolean;
|
|
91
|
-
/**
|
|
92
|
-
* @deprecated Use `status` instead
|
|
93
|
-
*/
|
|
94
|
-
showStatus?: boolean;
|
|
95
59
|
status?: boolean;
|
|
96
|
-
/**
|
|
97
|
-
* @deprecated Use `resolveButton` instead
|
|
98
|
-
*/
|
|
99
|
-
showResolveButton?: boolean;
|
|
100
60
|
resolveButton?: boolean;
|
|
101
61
|
inboxMode?: boolean;
|
|
102
62
|
suggestionMode?: boolean;
|
|
@@ -106,46 +66,19 @@ interface IVeltCommentsProps extends React.DetailedHTMLProps<React.HTMLAttribute
|
|
|
106
66
|
minimap?: boolean;
|
|
107
67
|
persistentCommentMode?: boolean;
|
|
108
68
|
ghostComments?: boolean;
|
|
109
|
-
/**
|
|
110
|
-
* @deprecated Use `ghostCommentsIndicator` instead
|
|
111
|
-
*/
|
|
112
|
-
ghostCommentsMessage?: boolean;
|
|
113
69
|
ghostCommentsIndicator?: boolean;
|
|
114
70
|
commentsOnDom?: boolean;
|
|
115
71
|
commentTool?: boolean;
|
|
116
72
|
sidebarButtonOnCommentDialog?: boolean;
|
|
117
73
|
scrollToComponent?: boolean;
|
|
74
|
+
userMentions?: boolean;
|
|
118
75
|
allowedElementIds?: string[];
|
|
119
|
-
/**
|
|
120
|
-
* @deprecated Use `onCommentAdd` instead
|
|
121
|
-
*/
|
|
122
|
-
commentAdded?: Function;
|
|
123
76
|
onCommentAdd?: Function;
|
|
124
77
|
onCustomPinInject?: Function;
|
|
125
78
|
onCommentUpdate?: Function;
|
|
126
|
-
/**
|
|
127
|
-
* @deprecated Use `onCommentAccept` instead
|
|
128
|
-
*/
|
|
129
|
-
commentAccepted?: Function;
|
|
130
79
|
onCommentAccept?: Function;
|
|
131
|
-
/**
|
|
132
|
-
* @deprecated Use `onCommentReject` instead
|
|
133
|
-
*/
|
|
134
|
-
commentRejected?: Function;
|
|
135
80
|
onCommentReject?: Function;
|
|
136
81
|
onSidebarButtonOnCommentDialogClick?: Function;
|
|
137
|
-
/**
|
|
138
|
-
* @deprecated Use `customStatus` instead
|
|
139
|
-
*/
|
|
140
|
-
customStatuses?: {
|
|
141
|
-
id: string;
|
|
142
|
-
color: string;
|
|
143
|
-
name: string;
|
|
144
|
-
type: 'default' | 'ongoing' | 'terminal';
|
|
145
|
-
lightColor?: string;
|
|
146
|
-
svg?: string;
|
|
147
|
-
iconUrl?: string;
|
|
148
|
-
}[];
|
|
149
82
|
customStatus?: {
|
|
150
83
|
id: string;
|
|
151
84
|
color: string;
|
|
@@ -155,29 +88,12 @@ interface IVeltCommentsProps extends React.DetailedHTMLProps<React.HTMLAttribute
|
|
|
155
88
|
svg?: string;
|
|
156
89
|
iconUrl?: string;
|
|
157
90
|
}[];
|
|
158
|
-
/**
|
|
159
|
-
* @deprecated Use `customPriority` instead
|
|
160
|
-
*/
|
|
161
|
-
customPriorities?: {
|
|
162
|
-
id: string;
|
|
163
|
-
color: string;
|
|
164
|
-
name: string;
|
|
165
|
-
lightColor?: string;
|
|
166
|
-
}[];
|
|
167
91
|
customPriority?: {
|
|
168
92
|
id: string;
|
|
169
93
|
color: string;
|
|
170
94
|
name: string;
|
|
171
95
|
lightColor?: string;
|
|
172
96
|
}[];
|
|
173
|
-
/**
|
|
174
|
-
* @deprecated Use `customCategory` instead
|
|
175
|
-
*/
|
|
176
|
-
customCategories?: {
|
|
177
|
-
id: string;
|
|
178
|
-
color: string;
|
|
179
|
-
name: string;
|
|
180
|
-
}[];
|
|
181
97
|
customCategory?: {
|
|
182
98
|
id: string;
|
|
183
99
|
color: string;
|
|
@@ -187,6 +103,33 @@ interface IVeltCommentsProps extends React.DetailedHTMLProps<React.HTMLAttribute
|
|
|
187
103
|
}
|
|
188
104
|
declare const SnippylyComments: React.FC<IVeltCommentsProps>;
|
|
189
105
|
|
|
106
|
+
declare class FilterTypeConfig {
|
|
107
|
+
name?: string;
|
|
108
|
+
enable?: boolean;
|
|
109
|
+
multiSelection?: boolean;
|
|
110
|
+
enableGrouping?: boolean;
|
|
111
|
+
}
|
|
112
|
+
declare class CommentSidebarFilterConfig {
|
|
113
|
+
location?: FilterTypeConfig;
|
|
114
|
+
people?: FilterTypeConfig;
|
|
115
|
+
priority?: FilterTypeConfig;
|
|
116
|
+
category?: FilterTypeConfig;
|
|
117
|
+
commentType?: FilterTypeConfig;
|
|
118
|
+
}
|
|
119
|
+
declare class CommentSidebarGroupConfig {
|
|
120
|
+
enable?: boolean;
|
|
121
|
+
name?: string;
|
|
122
|
+
}
|
|
123
|
+
declare class CommentSidebarFilters {
|
|
124
|
+
location?: Location[];
|
|
125
|
+
people?: {
|
|
126
|
+
userId?: string;
|
|
127
|
+
email?: string;
|
|
128
|
+
}[];
|
|
129
|
+
priority?: string[];
|
|
130
|
+
status?: string[];
|
|
131
|
+
category?: string[];
|
|
132
|
+
}
|
|
190
133
|
interface IVeltCommentsSidebarProps {
|
|
191
134
|
embedMode?: boolean;
|
|
192
135
|
/**
|
|
@@ -196,6 +139,9 @@ interface IVeltCommentsSidebarProps {
|
|
|
196
139
|
urlNavigation?: boolean;
|
|
197
140
|
pageMode?: boolean;
|
|
198
141
|
currentLocationSuffix?: boolean;
|
|
142
|
+
filterConfig?: CommentSidebarFilterConfig;
|
|
143
|
+
groupConfig?: CommentSidebarGroupConfig;
|
|
144
|
+
filters?: CommentSidebarFilters;
|
|
199
145
|
/**
|
|
200
146
|
* @deprecated Use `onSidebarOpen` instead
|
|
201
147
|
*/
|
|
@@ -362,11 +308,11 @@ declare function useSetDocumentId(documentId: string): void;
|
|
|
362
308
|
/**
|
|
363
309
|
* @beta This hook is in beta
|
|
364
310
|
*/
|
|
365
|
-
declare function useSetLocation(location: Location): void;
|
|
311
|
+
declare function useSetLocation(location: Location$1): void;
|
|
366
312
|
/**
|
|
367
313
|
* @beta This hook is in beta
|
|
368
314
|
*/
|
|
369
|
-
declare function useAddLocation(location: Location): void;
|
|
315
|
+
declare function useAddLocation(location: Location$1): void;
|
|
370
316
|
|
|
371
317
|
/**
|
|
372
318
|
* @beta This hook is in beta
|
|
@@ -375,7 +321,7 @@ declare function useCommentUtils(): any;
|
|
|
375
321
|
/**
|
|
376
322
|
* @beta This hook is in beta
|
|
377
323
|
*/
|
|
378
|
-
declare function useCommentAnnotations(documentId?: string, location?: Location): any;
|
|
324
|
+
declare function useCommentAnnotations(documentId?: string, location?: Location$1): any;
|
|
379
325
|
/**
|
|
380
326
|
* @beta This hook is in beta
|
|
381
327
|
*/
|
|
@@ -459,6 +405,6 @@ declare function useTagUtils(): any | undefined;
|
|
|
459
405
|
/**
|
|
460
406
|
* @beta This hook is in beta
|
|
461
407
|
*/
|
|
462
|
-
declare function useTagAnnotations(documentId?: string, location?: Location): any;
|
|
408
|
+
declare function useTagAnnotations(documentId?: string, location?: Location$1): any;
|
|
463
409
|
|
|
464
410
|
export { SnippylyArrowTool as VeltArrowTool, SnippylyArrows as VeltArrows, SnippylyCommentBubble as VeltCommentBubble, VeltCommentPlayerTimeline, SnippylyCommentTool as VeltCommentTool, SnippylyComments as VeltComments, SnippylyCommentsSidebar as VeltCommentsSidebar, SnippylyCursor as VeltCursor, SnippylyHuddle as VeltHuddle, SnippylyHuddleTool as VeltHuddleTool, SnippylyPresence as VeltPresence, SnippylyProvider as VeltProvider, SnippylyRecorderControlPanel as VeltRecorderControlPanel, SnippylyRecorderNotes as VeltRecorderNotes, SnippylyRecorderPlayer as VeltRecorderPlayer, SnippylyRecorderTool as VeltRecorderTool, SnippylySidebarButton as VeltSidebarButton, SnippylyTagTool as VeltTagTool, SnippylyTags as VeltTags, SnippylyUserInviteTool as VeltUserInviteTool, SnippylyUserRequestTool as VeltUserRequestTool, VeltVideoPlayer, useAIRewriterUtils, useAddLocation, useClient, useCommentAddHandler, useCommentAnnotations, useCommentDialogSidebarClickHandler, useCommentModeState, useCommentUpdateHandler, useCommentUtils, useCursorUsers, useCursorUtils, useHuddleUtils, useIdentify, useLiveSelectionUtils, useLiveStateData, useLiveStateSyncUtils, usePresenceUsers, usePresenceUtils, useRecorderAddHandler, useRecorderUtils, useSetDocumentId, useSetLiveStateData, useSetLocation, useTagAnnotations, useTagUtils, useUserEditorState, useVeltClient };
|