@veltdev/sdk-staging 5.0.0-beta.2 → 5.0.0-beta.21
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/app/models/data/comment-actions.data.model.d.ts +70 -0
- package/app/models/data/comment-annotation.data.model.d.ts +1 -0
- package/app/models/data/comment-events.data.model.d.ts +34 -1
- package/app/models/data/comment-utils.data.model.d.ts +26 -0
- package/app/models/data/config.data.model.d.ts +11 -0
- package/app/models/element/comment-element.model.d.ts +157 -9
- package/app/models/element/notification-element.model.d.ts +20 -0
- package/app/utils/constants.d.ts +1 -0
- package/app/utils/enums.d.ts +7 -2
- package/package.json +1 -1
- package/velt.js +118 -112
|
@@ -41,9 +41,31 @@ export interface CopyLinkRequest {
|
|
|
41
41
|
annotationId: string;
|
|
42
42
|
options?: RequestOptions;
|
|
43
43
|
}
|
|
44
|
+
/**
|
|
45
|
+
* Visibility type for comment annotations.
|
|
46
|
+
* - 'public': Visible to everyone (default:velt)
|
|
47
|
+
* - 'organization': Visible only to users in the specified organization
|
|
48
|
+
* - 'self': Visible only to specified users (private comments)
|
|
49
|
+
*/
|
|
50
|
+
export type CommentVisibilityType = 'public' | 'organization' | 'self';
|
|
51
|
+
/**
|
|
52
|
+
* Configuration for comment visibility/access control.
|
|
53
|
+
*/
|
|
54
|
+
export interface CommentVisibilityConfig {
|
|
55
|
+
/** The type of visibility for the comment */
|
|
56
|
+
type: CommentVisibilityType;
|
|
57
|
+
/** Annotation ID for the comment to update visibility */
|
|
58
|
+
annotationId?: string;
|
|
59
|
+
/** Organization ID for 'organization' type visibility */
|
|
60
|
+
organizationId?: string;
|
|
61
|
+
/** User IDs for 'self' type visibility - array of user IDs who can see the comment */
|
|
62
|
+
userIds?: string[];
|
|
63
|
+
}
|
|
44
64
|
export interface AddCommentAnnotationRequest {
|
|
45
65
|
annotation: CommentAnnotation;
|
|
46
66
|
options?: RequestOptions;
|
|
67
|
+
/** Optional visibility configuration for the comment */
|
|
68
|
+
visibility?: CommentVisibilityConfig;
|
|
47
69
|
}
|
|
48
70
|
export interface ApproveCommentAnnotationRequest {
|
|
49
71
|
annotationId: string;
|
|
@@ -61,6 +83,24 @@ export interface DeleteCommentAnnotationRequest {
|
|
|
61
83
|
annotationId: string;
|
|
62
84
|
options?: RequestOptions;
|
|
63
85
|
}
|
|
86
|
+
/**
|
|
87
|
+
* Query parameters for fetching comment annotation counts.
|
|
88
|
+
*
|
|
89
|
+
* @property organizationId - Filter by organization (enables org-wide aggregation when used alone)
|
|
90
|
+
* @property documentIds - Filter by specific document IDs
|
|
91
|
+
* @property locationIds - Filter by location IDs within documents
|
|
92
|
+
* @property statusIds - Filter by comment status IDs (e.g., "open", "resolved")
|
|
93
|
+
* @property folderId - Filter by folder ID (use with allDocuments for folder-wide counts)
|
|
94
|
+
* @property allDocuments - When true with folderId, aggregates all documents in folder
|
|
95
|
+
* @property locationId - Single location filter (deprecated, use locationIds)
|
|
96
|
+
* @property aggregateDocuments - When true, combines all documentIds into single count
|
|
97
|
+
* @property filterGhostComments - When true, excludes orphaned/deleted comments from counts
|
|
98
|
+
* @property batchedPerDocument - When true, uses efficient batched listeners (4 instead of 100)
|
|
99
|
+
* but still returns per-document counts. Best for large document lists (50+).
|
|
100
|
+
* Trade-off: slight delay on updates due to debouncing.
|
|
101
|
+
* @property debounceMs - Debounce time in milliseconds for batchedPerDocument mode (default: 5000ms).
|
|
102
|
+
* Prevents rapid re-fetches when multiple documents update in quick succession.
|
|
103
|
+
*/
|
|
64
104
|
export interface CommentRequestQuery {
|
|
65
105
|
organizationId?: string;
|
|
66
106
|
documentIds?: string[];
|
|
@@ -71,6 +111,10 @@ export interface CommentRequestQuery {
|
|
|
71
111
|
locationId?: string;
|
|
72
112
|
aggregateDocuments?: boolean;
|
|
73
113
|
filterGhostComments?: boolean;
|
|
114
|
+
/** Enable batched listeners with per-document counts. Uses 4 listeners instead of N listeners. */
|
|
115
|
+
batchedPerDocument?: boolean;
|
|
116
|
+
/** Debounce time in ms for batchedPerDocument mode (default: 5000). */
|
|
117
|
+
debounceMs?: number;
|
|
74
118
|
}
|
|
75
119
|
export interface SubscribeCommentAnnotationRequest {
|
|
76
120
|
annotationId: string;
|
|
@@ -170,6 +214,32 @@ export interface ToggleReactionRequest {
|
|
|
170
214
|
};
|
|
171
215
|
options?: RequestOptions;
|
|
172
216
|
}
|
|
217
|
+
export interface SubmitCommentRequest {
|
|
218
|
+
targetComposerElementId: string;
|
|
219
|
+
}
|
|
220
|
+
export interface ClearComposerRequest {
|
|
221
|
+
targetComposerElementId: string;
|
|
222
|
+
}
|
|
223
|
+
export interface GetComposerDataRequest {
|
|
224
|
+
targetComposerElementId: string;
|
|
225
|
+
}
|
|
226
|
+
/**
|
|
227
|
+
* FormatConfig - Configuration for format options
|
|
228
|
+
*/
|
|
229
|
+
export interface FormatConfig {
|
|
230
|
+
bold?: {
|
|
231
|
+
enable: boolean;
|
|
232
|
+
};
|
|
233
|
+
italic?: {
|
|
234
|
+
enable: boolean;
|
|
235
|
+
};
|
|
236
|
+
underline?: {
|
|
237
|
+
enable: boolean;
|
|
238
|
+
};
|
|
239
|
+
strikethrough?: {
|
|
240
|
+
enable: boolean;
|
|
241
|
+
};
|
|
242
|
+
}
|
|
173
243
|
export interface FetchCommentAnnotationsRequest {
|
|
174
244
|
createdAfter?: number;
|
|
175
245
|
createdBefore?: number;
|
|
@@ -184,6 +184,7 @@ export declare class CommentAnnotation {
|
|
|
184
184
|
unsubscribedUsers?: CommentAnnotationUnsubscribedUsers;
|
|
185
185
|
subscribedGroups?: CommentAnnotationSubscribedGroups;
|
|
186
186
|
resolvedByUserId?: string | null;
|
|
187
|
+
resolvedByUser?: User | null;
|
|
187
188
|
multiThreadAnnotationId?: string;
|
|
188
189
|
isDraft?: boolean;
|
|
189
190
|
sourceId?: string;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { CommentAccessMode, CommentEventTypes, CommentStatus } from "../../utils/enums";
|
|
1
|
+
import { AssignToType, CommentAccessMode, CommentEventTypes, CommentStatus } from "../../utils/enums";
|
|
2
2
|
import { Attachment } from "./attachment.model";
|
|
3
3
|
import { VeltButtonClickEvent } from "./button.data.model";
|
|
4
4
|
import { AddAttachmentResponse } from "./comment-actions.data.model";
|
|
@@ -54,6 +54,7 @@ export interface CommentSuggestionEventData {
|
|
|
54
54
|
}
|
|
55
55
|
export type CommentEventTypesMap = {
|
|
56
56
|
[CommentEventTypes.ADD_COMMENT_ANNOTATION]: AddCommentAnnotationEvent;
|
|
57
|
+
[CommentEventTypes.ADD_COMMENT_ANNOTATION_DRAFT]: AddCommentAnnotationDraftEvent;
|
|
57
58
|
[CommentEventTypes.APPROVE_COMMENT_ANNOTATION]: ApproveCommentAnnotationEvent;
|
|
58
59
|
[CommentEventTypes.ACCEPT_COMMENT_ANNOTATION]: AcceptCommentAnnotationEvent;
|
|
59
60
|
[CommentEventTypes.REJECT_COMMENT_ANNOTATION]: RejectCommentAnnotationEvent;
|
|
@@ -79,9 +80,12 @@ export type CommentEventTypesMap = {
|
|
|
79
80
|
[CommentEventTypes.COMMENT_SIDEBAR_DATA_UPDATE]: CommentSidebarDataUpdateEvent;
|
|
80
81
|
[CommentEventTypes.AUTOCOMPLETE_SEARCH]: AutocompleteSearchEvent;
|
|
81
82
|
[CommentEventTypes.COMPOSER_CLICKED]: ComposerClickedEvent;
|
|
83
|
+
[CommentEventTypes.COMPOSER_TEXT_CHANGE]: ComposerTextChangeEvent;
|
|
82
84
|
[CommentEventTypes.LINK_CLICKED]: LinkClickedEvent;
|
|
83
85
|
[CommentEventTypes.COMMENT_PIN_CLICKED]: CommentPinClickedEvent;
|
|
84
86
|
[CommentEventTypes.COMMENT_BUBBLE_CLICKED]: CommentBubbleClickedEvent;
|
|
87
|
+
[CommentEventTypes.COMMENT_TOOL_CLICK]: CommentToolClickEvent;
|
|
88
|
+
[CommentEventTypes.SIDEBAR_BUTTON_CLICK]: SidebarButtonClickEvent;
|
|
85
89
|
};
|
|
86
90
|
export interface AddAttachmentEvent {
|
|
87
91
|
annotationId: string;
|
|
@@ -96,6 +100,10 @@ export interface DeleteAttachmentEvent {
|
|
|
96
100
|
attachment: Attachment;
|
|
97
101
|
metadata: VeltEventMetadata;
|
|
98
102
|
}
|
|
103
|
+
export interface AddCommentAnnotationDraftEvent {
|
|
104
|
+
metadata: VeltEventMetadata;
|
|
105
|
+
addContext: (context: Record<string, unknown>) => void;
|
|
106
|
+
}
|
|
99
107
|
export interface AddCommentAnnotationEvent {
|
|
100
108
|
annotationId: string;
|
|
101
109
|
commentAnnotation: CommentAnnotation;
|
|
@@ -270,3 +278,28 @@ export interface CommentBubbleClickedEvent {
|
|
|
270
278
|
commentAnnotation: CommentAnnotation;
|
|
271
279
|
metadata?: VeltEventMetadata;
|
|
272
280
|
}
|
|
281
|
+
export interface ComposerTextChangeEvent {
|
|
282
|
+
text: string;
|
|
283
|
+
annotation: CommentAnnotation;
|
|
284
|
+
targetComposerElementId: string;
|
|
285
|
+
metadata?: VeltEventMetadata;
|
|
286
|
+
}
|
|
287
|
+
export interface AssignToConfig {
|
|
288
|
+
type: AssignToType;
|
|
289
|
+
}
|
|
290
|
+
export interface PageModeComposerConfig {
|
|
291
|
+
context?: {
|
|
292
|
+
[key: string]: any;
|
|
293
|
+
} | null;
|
|
294
|
+
targetElementId?: string | null;
|
|
295
|
+
}
|
|
296
|
+
export interface CommentToolClickEvent {
|
|
297
|
+
context: {
|
|
298
|
+
[key: string]: any;
|
|
299
|
+
} | null;
|
|
300
|
+
targetElementId?: string | null;
|
|
301
|
+
metadata?: VeltEventMetadata;
|
|
302
|
+
}
|
|
303
|
+
export interface SidebarButtonClickEvent {
|
|
304
|
+
metadata?: VeltEventMetadata;
|
|
305
|
+
}
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { Location } from './location.model';
|
|
1
2
|
export interface IUnreadCommentsMap {
|
|
2
3
|
[annotationId: string]: number;
|
|
3
4
|
}
|
|
@@ -14,3 +15,28 @@ export interface TransformContext {
|
|
|
14
15
|
inverseScale?: number;
|
|
15
16
|
};
|
|
16
17
|
}
|
|
18
|
+
/**
|
|
19
|
+
* Context data returned by the comment context provider.
|
|
20
|
+
* This is a flexible object that can contain custom properties.
|
|
21
|
+
*/
|
|
22
|
+
export interface CommentContext {
|
|
23
|
+
/**
|
|
24
|
+
* Optional comment type. When set to 'manual', the comment will be treated as a manual comment
|
|
25
|
+
* and the target element will be removed.
|
|
26
|
+
*/
|
|
27
|
+
commentType?: 'manual' | string;
|
|
28
|
+
/**
|
|
29
|
+
* Allow additional custom properties
|
|
30
|
+
*/
|
|
31
|
+
[key: string]: unknown;
|
|
32
|
+
}
|
|
33
|
+
export type CommentContextProviderResponse = CommentContext | null | undefined;
|
|
34
|
+
/**
|
|
35
|
+
* A function that provides custom context for comments.
|
|
36
|
+
* Can return the context synchronously or asynchronously via a Promise.
|
|
37
|
+
*
|
|
38
|
+
* @param documentId - The ID of the document
|
|
39
|
+
* @param location - Optional location information
|
|
40
|
+
* @returns The comment context object or a Promise that resolves to it
|
|
41
|
+
*/
|
|
42
|
+
export type CommentContextProvider = (documentId: string, location?: Location) => CommentContextProviderResponse | Promise<CommentContextProviderResponse>;
|
|
@@ -53,6 +53,14 @@ export declare class Config {
|
|
|
53
53
|
* The domain of the API proxy.
|
|
54
54
|
*/
|
|
55
55
|
apiProxyDomain?: string;
|
|
56
|
+
/**
|
|
57
|
+
* Controls whether global Velt styles are loaded.
|
|
58
|
+
* When true (default), global styles are applied.
|
|
59
|
+
* When false, global styles are not loaded - useful for custom styling.
|
|
60
|
+
*
|
|
61
|
+
* Default: true
|
|
62
|
+
*/
|
|
63
|
+
globalStyles?: boolean;
|
|
56
64
|
}
|
|
57
65
|
export interface ExtendedFirebaseOptions extends FirebaseOptions {
|
|
58
66
|
storeDbId: string;
|
|
@@ -66,3 +74,6 @@ export interface DisableLogsConfig {
|
|
|
66
74
|
warnings?: boolean;
|
|
67
75
|
suppressAll?: boolean;
|
|
68
76
|
}
|
|
77
|
+
export interface GetProjectConfigResponse {
|
|
78
|
+
isPrivateCommentsEnabled: boolean;
|
|
79
|
+
}
|
|
@@ -1,16 +1,16 @@
|
|
|
1
1
|
// @ts-nocheck
|
|
2
2
|
import { Observable } from "rxjs";
|
|
3
|
-
import {
|
|
4
|
-
import {
|
|
5
|
-
import { CustomCategory, CustomPriority, CustomStatus } from "../data/custom-filter.data.model";
|
|
6
|
-
import { CustomAnnotationDropdownData } from "../data/custom-chip-dropdown.data.model";
|
|
3
|
+
import { AssignToType, CommentSidebarSystemFiltersOperator, SidebarButtonCountType } from "../../utils/enums";
|
|
4
|
+
import { UploadFileData } from "../data/attachment.model";
|
|
7
5
|
import { AutocompleteData } from "../data/autocomplete.data.model";
|
|
6
|
+
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";
|
|
7
|
+
import { CommentAnnotation, CommentOnElementConfig, CommentSelectionChangeData, ManualCommentAnnotationConfig, UpdateContextConfig } from "../data/comment-annotation.data.model";
|
|
8
|
+
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";
|
|
8
9
|
import { CommentSidebarCustomActionEventData, CommentSidebarData, CommentSidebarDataOptions } from "../data/comment-sidebar-config.model";
|
|
10
|
+
import { CommentContextProvider, FormatConfig, TransformContext, UnreadCommentsCount } from "../data/comment-utils.data.model";
|
|
11
|
+
import { CustomAnnotationDropdownData } from "../data/custom-chip-dropdown.data.model";
|
|
12
|
+
import { CustomCategory, CustomPriority, CustomStatus } from "../data/custom-filter.data.model";
|
|
9
13
|
export { ReactionMap } from '../data/reaction-annotation.data.model';
|
|
10
|
-
import { AcceptCommentAnnotationRequest, AddAttachmentRequest, AddAttachmentResponse, AddCommentAnnotationRequest, AddCommentRequest, AddReactionRequest, ApproveCommentAnnotationRequest, AssignUserRequest, AssignUserEvent, CopyLinkRequest, DeleteAttachmentRequest, DeleteCommentAnnotationRequest, CommentRequestQuery, CommentRequestQuery, DeleteCommentRequest, DeleteReactionRequest, DeleteRecordingRequest, GetAttachmentRequest, GetCommentRequest, GetLinkRequest, GetRecordingRequest, RejectCommentAnnotationRequest, ResolveCommentAnnotationRequest, SubscribeCommentAnnotationRequest, UnsubscribeCommentAnnotationRequest, ToggleReactionRequest, UpdateAccessRequest, UpdateCommentRequest, UpdatePriorityRequest, UpdateStatusRequest, FetchCommentAnnotationsRequest } from "../data/comment-actions.data.model";
|
|
11
|
-
import { UnreadCommentsCount, TransformContext } from "../data/comment-utils.data.model";
|
|
12
|
-
import { CommentSidebarSystemFiltersOperator, SidebarButtonCountType } from "../../utils/enums";
|
|
13
|
-
import { UploadFileData } from "../data/attachment.model";
|
|
14
14
|
|
|
15
15
|
export declare class CommentElement {
|
|
16
16
|
/**
|
|
@@ -85,6 +85,39 @@ export declare class CommentElement {
|
|
|
85
85
|
*/
|
|
86
86
|
toggleCommentSidebar: () => any;
|
|
87
87
|
|
|
88
|
+
/**
|
|
89
|
+
* To enable context in page mode composer feature
|
|
90
|
+
* When enabled, clicking comment tool will open sidebar with page mode composer and pass context
|
|
91
|
+
*/
|
|
92
|
+
enableContextInPageModeComposer: () => void;
|
|
93
|
+
|
|
94
|
+
/**
|
|
95
|
+
* To disable context in page mode composer feature
|
|
96
|
+
*/
|
|
97
|
+
disableContextInPageModeComposer: () => void;
|
|
98
|
+
|
|
99
|
+
/**
|
|
100
|
+
* To clear page mode composer context
|
|
101
|
+
*/
|
|
102
|
+
clearPageModeComposerContext: () => void;
|
|
103
|
+
|
|
104
|
+
/**
|
|
105
|
+
* To set context in page mode composer
|
|
106
|
+
* @param config The page mode composer config containing context and targetElementId
|
|
107
|
+
*/
|
|
108
|
+
setContextInPageModeComposer: (config: PageModeComposerConfig | null) => void;
|
|
109
|
+
|
|
110
|
+
/**
|
|
111
|
+
* To focus the page mode composer input
|
|
112
|
+
*/
|
|
113
|
+
focusPageModeComposer: () => void;
|
|
114
|
+
|
|
115
|
+
/**
|
|
116
|
+
* To set assign to type for comment dialog
|
|
117
|
+
* @param config The assign to config containing type
|
|
118
|
+
*/
|
|
119
|
+
setAssignToType: (config: AssignToConfig) => void;
|
|
120
|
+
|
|
88
121
|
/**
|
|
89
122
|
* To enable moderator mode
|
|
90
123
|
*/
|
|
@@ -329,7 +362,7 @@ export declare class CommentElement {
|
|
|
329
362
|
* @description Sets the comment context provider
|
|
330
363
|
* @param provider
|
|
331
364
|
*/
|
|
332
|
-
public setContextProvider: (provider:
|
|
365
|
+
public setContextProvider: (provider: CommentContextProvider | null) => void;
|
|
333
366
|
|
|
334
367
|
/**
|
|
335
368
|
* To enable suggestion mode
|
|
@@ -823,6 +856,13 @@ export declare class CommentElement {
|
|
|
823
856
|
*/
|
|
824
857
|
public updateContext: (annotationId: string, context: any, config?: UpdateContextConfig) => Promise<any>;
|
|
825
858
|
|
|
859
|
+
/**
|
|
860
|
+
* Updates the visibility of a comment annotation.
|
|
861
|
+
* @param visibility Visibility configuration (public, organization, or self) including annotationId
|
|
862
|
+
* @returns Promise<any>
|
|
863
|
+
*/
|
|
864
|
+
public updateVisibility: (visibility: CommentVisibilityConfig) => Promise<any>;
|
|
865
|
+
|
|
826
866
|
/**
|
|
827
867
|
* Subscribe to selected comments
|
|
828
868
|
* @returns list of selected comments
|
|
@@ -1274,6 +1314,42 @@ export declare class CommentElement {
|
|
|
1274
1314
|
*/
|
|
1275
1315
|
public disablePaginatedContactList: () => void;
|
|
1276
1316
|
|
|
1317
|
+
/**
|
|
1318
|
+
* To enable format options (bold, italic, underline, strikethrough)
|
|
1319
|
+
*/
|
|
1320
|
+
public enableFormatOptions: () => void;
|
|
1321
|
+
|
|
1322
|
+
/**
|
|
1323
|
+
* To disable format options
|
|
1324
|
+
*/
|
|
1325
|
+
public disableFormatOptions: () => void;
|
|
1326
|
+
|
|
1327
|
+
/**
|
|
1328
|
+
* Set format config to control which format options are enabled
|
|
1329
|
+
* @param config FormatConfig with enable flags for each format type
|
|
1330
|
+
*/
|
|
1331
|
+
public setFormatConfig: (config: FormatConfig) => void;
|
|
1332
|
+
|
|
1333
|
+
/**
|
|
1334
|
+
* Programmatically trigger comment submission for a composer with the given targetComposerElementId
|
|
1335
|
+
* @param request SubmitCommentRequest containing targetComposerElementId
|
|
1336
|
+
*/
|
|
1337
|
+
public submitComment: (request: SubmitCommentRequest) => void;
|
|
1338
|
+
|
|
1339
|
+
/**
|
|
1340
|
+
* Programmatically clear the composer state for the given targetComposerElementId
|
|
1341
|
+
* @param request ClearComposerRequest containing targetComposerElementId
|
|
1342
|
+
*/
|
|
1343
|
+
public clearComposer: (request: ClearComposerRequest) => void;
|
|
1344
|
+
|
|
1345
|
+
/**
|
|
1346
|
+
* Get the current composer data for a given targetComposerElementId
|
|
1347
|
+
* Returns the same data as COMPOSER_TEXT_CHANGE event but as a one-time fetch
|
|
1348
|
+
* @param request GetComposerDataRequest containing targetComposerElementId
|
|
1349
|
+
* @returns The composer data or null if not found
|
|
1350
|
+
*/
|
|
1351
|
+
public getComposerData: (request: GetComposerDataRequest) => ComposerTextChangeEvent | null;
|
|
1352
|
+
|
|
1277
1353
|
constructor();
|
|
1278
1354
|
/**
|
|
1279
1355
|
* Subscribe to comments on the current document.
|
|
@@ -2075,6 +2151,14 @@ export declare class CommentElement {
|
|
|
2075
2151
|
*/
|
|
2076
2152
|
private _updateContext;
|
|
2077
2153
|
|
|
2154
|
+
/**
|
|
2155
|
+
* Updates the visibility of a comment annotation.
|
|
2156
|
+
* @param annotationId Annotation Id
|
|
2157
|
+
* @param visibility Visibility configuration (public, organization, or self)
|
|
2158
|
+
* @returns Promise<any>
|
|
2159
|
+
*/
|
|
2160
|
+
private _updateVisibility;
|
|
2161
|
+
|
|
2078
2162
|
/**
|
|
2079
2163
|
* Subscribe to selected comments
|
|
2080
2164
|
* @returns list of selected comments
|
|
@@ -2526,4 +2610,68 @@ export declare class CommentElement {
|
|
|
2526
2610
|
* To disable paginated contact list
|
|
2527
2611
|
*/
|
|
2528
2612
|
private _disablePaginatedContactList;
|
|
2613
|
+
/**
|
|
2614
|
+
* To enable format options (bold, italic, underline, strikethrough)
|
|
2615
|
+
*/
|
|
2616
|
+
private _enableFormatOptions;
|
|
2617
|
+
/**
|
|
2618
|
+
* To disable format options
|
|
2619
|
+
*/
|
|
2620
|
+
private _disableFormatOptions;
|
|
2621
|
+
/**
|
|
2622
|
+
* To set format config to control which format options are enabled
|
|
2623
|
+
* @param config FormatConfig with enable flags for each format type
|
|
2624
|
+
*/
|
|
2625
|
+
private _setFormatConfig;
|
|
2626
|
+
|
|
2627
|
+
/**
|
|
2628
|
+
* Programmatically trigger comment submission for a composer with the given targetComposerElementId
|
|
2629
|
+
* @param request SubmitCommentRequest containing targetComposerElementId
|
|
2630
|
+
*/
|
|
2631
|
+
private _submitComment;
|
|
2632
|
+
|
|
2633
|
+
/**
|
|
2634
|
+
* Programmatically clear the composer state for the given targetComposerElementId
|
|
2635
|
+
* @param request ClearComposerRequest containing targetComposerElementId
|
|
2636
|
+
*/
|
|
2637
|
+
private _clearComposer;
|
|
2638
|
+
|
|
2639
|
+
/**
|
|
2640
|
+
* Get the current composer data for a given targetComposerElementId
|
|
2641
|
+
* Returns the same data as COMPOSER_TEXT_CHANGE event but as a one-time fetch
|
|
2642
|
+
* @param request GetComposerDataRequest containing targetComposerElementId
|
|
2643
|
+
* @returns The composer data or null if not found
|
|
2644
|
+
*/
|
|
2645
|
+
private _getComposerData;
|
|
2646
|
+
|
|
2647
|
+
/**
|
|
2648
|
+
* To enable context in page mode composer feature
|
|
2649
|
+
*/
|
|
2650
|
+
private _enableContextInPageModeComposer;
|
|
2651
|
+
|
|
2652
|
+
/**
|
|
2653
|
+
* To disable context in page mode composer feature
|
|
2654
|
+
*/
|
|
2655
|
+
private _disableContextInPageModeComposer;
|
|
2656
|
+
|
|
2657
|
+
/**
|
|
2658
|
+
* To clear page mode composer context
|
|
2659
|
+
*/
|
|
2660
|
+
private _clearPageModeComposerContext;
|
|
2661
|
+
|
|
2662
|
+
/**
|
|
2663
|
+
* To set context in page mode composer
|
|
2664
|
+
*/
|
|
2665
|
+
private _setContextInPageModeComposer;
|
|
2666
|
+
|
|
2667
|
+
/**
|
|
2668
|
+
* To focus the page mode composer input
|
|
2669
|
+
*/
|
|
2670
|
+
private _focusPageModeComposer;
|
|
2671
|
+
|
|
2672
|
+
/**
|
|
2673
|
+
* To set assign to type for comment dialog
|
|
2674
|
+
* @param type 'dropdown' | 'checkbox'
|
|
2675
|
+
*/
|
|
2676
|
+
private _setAssignToType;
|
|
2529
2677
|
}
|
|
@@ -68,6 +68,16 @@ export declare class NotificationElement {
|
|
|
68
68
|
*/
|
|
69
69
|
getSettings: () => Observable<NotificationSettingsConfig | null>;
|
|
70
70
|
|
|
71
|
+
/**
|
|
72
|
+
* To enable settings config by organization
|
|
73
|
+
*/
|
|
74
|
+
enableSettingsAtOrganizationLevel: () => void;
|
|
75
|
+
|
|
76
|
+
/**
|
|
77
|
+
* To disable settings config by organization
|
|
78
|
+
*/
|
|
79
|
+
disableSettingsAtOrganizationLevel: () => void;
|
|
80
|
+
|
|
71
81
|
/**
|
|
72
82
|
* To mute all notifications
|
|
73
83
|
*/
|
|
@@ -200,6 +210,16 @@ export declare class NotificationElement {
|
|
|
200
210
|
*/
|
|
201
211
|
private _disableSettings;
|
|
202
212
|
|
|
213
|
+
/**
|
|
214
|
+
* To enable settings config by organization
|
|
215
|
+
*/
|
|
216
|
+
private _enableSettingsAtOrganizationLevel;
|
|
217
|
+
|
|
218
|
+
/**
|
|
219
|
+
* To disable settings config by organization
|
|
220
|
+
*/
|
|
221
|
+
private _disableSettingsAtOrganizationLevel;
|
|
222
|
+
|
|
203
223
|
/**
|
|
204
224
|
* To enable self notifications
|
|
205
225
|
*/
|
package/app/utils/constants.d.ts
CHANGED
|
@@ -11,6 +11,7 @@ export declare class Constants {
|
|
|
11
11
|
static LISTENER_BATCH_SIZE: number;
|
|
12
12
|
static LISTENER_CONTEXT_BATCH_SIZE: number;
|
|
13
13
|
static DEFAULT_VELT_CONTEXT: string;
|
|
14
|
+
static VISIBILITY_SELF_PREFIX: string;
|
|
14
15
|
static FIREBASE_PARTIAL_PATH_ORGANIZATIONS: string;
|
|
15
16
|
static FIREBASE_PARTIAL_PATH_FOLDERS: string;
|
|
16
17
|
static FIREBASE_PARTIAL_PATH_DOCS: string;
|
package/app/utils/enums.d.ts
CHANGED
|
@@ -29,6 +29,7 @@ export declare enum ResolverActions {
|
|
|
29
29
|
}
|
|
30
30
|
export declare const CommentEventTypes: {
|
|
31
31
|
readonly ADD_COMMENT_ANNOTATION: "addCommentAnnotation";
|
|
32
|
+
readonly ADD_COMMENT_ANNOTATION_DRAFT: "addCommentAnnotationDraft";
|
|
32
33
|
readonly DELETE_COMMENT_ANNOTATION: "deleteCommentAnnotation";
|
|
33
34
|
readonly APPROVE_COMMENT_ANNOTATION: "approveCommentAnnotation";
|
|
34
35
|
readonly ACCEPT_COMMENT_ANNOTATION: "acceptCommentAnnotation";
|
|
@@ -54,9 +55,12 @@ export declare const CommentEventTypes: {
|
|
|
54
55
|
readonly COMMENT_SIDEBAR_DATA_UPDATE: "commentSidebarDataUpdate";
|
|
55
56
|
readonly AUTOCOMPLETE_SEARCH: "autocompleteSearch";
|
|
56
57
|
readonly COMPOSER_CLICKED: "composerClicked";
|
|
58
|
+
readonly COMPOSER_TEXT_CHANGE: "composerTextChange";
|
|
57
59
|
readonly LINK_CLICKED: "linkClicked";
|
|
58
60
|
readonly COMMENT_PIN_CLICKED: "commentPinClicked";
|
|
59
61
|
readonly COMMENT_BUBBLE_CLICKED: "commentBubbleClicked";
|
|
62
|
+
readonly COMMENT_TOOL_CLICK: "commentToolClick";
|
|
63
|
+
readonly SIDEBAR_BUTTON_CLICK: "sidebarButtonClick";
|
|
60
64
|
};
|
|
61
65
|
export declare const RecorderEventTypes: {
|
|
62
66
|
readonly TRANSCRIPTION_DONE: "transcriptionDone";
|
|
@@ -185,6 +189,7 @@ export declare enum AnalyticsFeatures {
|
|
|
185
189
|
COMMENT_SIDEBAR = "commentSidebar"
|
|
186
190
|
}
|
|
187
191
|
export type FeatureType = 'area' | 'arrow' | 'audioHuddle' | 'comment' | 'cursor' | 'huddle' | 'liveStateSync' | 'presence' | 'recorder' | 'rewriter' | 'tag' | 'liveSelection' | 'notification' | 'reaction' | 'multiThread';
|
|
192
|
+
export type AssignToType = 'dropdown' | 'checkbox';
|
|
188
193
|
export declare enum DeviceType {
|
|
189
194
|
DESKTOP = "Desktop",
|
|
190
195
|
MOBILE = "Mobile",
|
|
@@ -277,10 +282,10 @@ export type OverlayOriginY = 'top' | 'center' | 'bottom';
|
|
|
277
282
|
export type OverlayOriginX = 'start' | 'center' | 'end';
|
|
278
283
|
export type SubtitlesMode = 'floating' | 'embed';
|
|
279
284
|
export type RecorderVariant = 'default' | 'embed';
|
|
280
|
-
export type ReactionPinType = 'timeline' | 'comment';
|
|
285
|
+
export type ReactionPinType = 'timeline' | 'comment' | 'standalone';
|
|
281
286
|
export type SidebarPosition = 'left' | 'right';
|
|
282
287
|
export type SidebarSortingCriteria = 'date' | 'unread' | null;
|
|
283
|
-
export type SidebarFilterCriteria = 'all' | 'read' | 'unread' | 'resolved' | 'open' | 'reset' | null;
|
|
288
|
+
export type SidebarFilterCriteria = 'all' | 'read' | 'unread' | 'resolved' | 'open' | 'assignedToMe' | 'reset' | null;
|
|
284
289
|
export type SidebarFilterSearchType = 'people' | 'assigned' | 'tagged' | 'involved' | 'pages' | 'documents' | 'statuses' | 'priorities' | 'categories' | 'versions' | string;
|
|
285
290
|
export type InlineSortingCriteria = 'createdFirst' | 'createdLast' | 'updatedFirst' | 'updatedLast';
|
|
286
291
|
export type NotificationPanelMode = 'popover' | 'sidebar';
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@veltdev/sdk-staging",
|
|
3
|
-
"version": "5.0.0-beta.
|
|
3
|
+
"version": "5.0.0-beta.21",
|
|
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": [
|