@veltdev/sdk-staging 4.7.13 → 5.0.0-beta.10
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 +20 -31
- package/app/models/data/comment-annotation.data.model.d.ts +0 -1
- package/app/models/data/comment-events.data.model.d.ts +7 -32
- package/app/models/data/comment-utils.data.model.d.ts +26 -0
- package/app/models/data/config.data.model.d.ts +8 -0
- package/app/models/data/custom-filter.data.model.d.ts +2 -0
- package/app/models/element/comment-element.model.d.ts +35 -129
- package/app/utils/constants.d.ts +1 -10
- package/app/utils/enums.d.ts +4 -7
- package/package.json +2 -2
- package/velt.js +144 -133
|
@@ -41,9 +41,29 @@ 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
|
+
/** Organization ID for 'organization' type visibility */
|
|
58
|
+
organizationId?: string;
|
|
59
|
+
/** User IDs for 'self' type visibility - array of user IDs who can see the comment */
|
|
60
|
+
userIds?: string[];
|
|
61
|
+
}
|
|
44
62
|
export interface AddCommentAnnotationRequest {
|
|
45
63
|
annotation: CommentAnnotation;
|
|
46
64
|
options?: RequestOptions;
|
|
65
|
+
/** Optional visibility configuration for the comment */
|
|
66
|
+
visibility?: CommentVisibilityConfig;
|
|
47
67
|
}
|
|
48
68
|
export interface ApproveCommentAnnotationRequest {
|
|
49
69
|
annotationId: string;
|
|
@@ -61,24 +81,6 @@ export interface DeleteCommentAnnotationRequest {
|
|
|
61
81
|
annotationId: string;
|
|
62
82
|
options?: RequestOptions;
|
|
63
83
|
}
|
|
64
|
-
/**
|
|
65
|
-
* Query parameters for fetching comment annotation counts.
|
|
66
|
-
*
|
|
67
|
-
* @property organizationId - Filter by organization (enables org-wide aggregation when used alone)
|
|
68
|
-
* @property documentIds - Filter by specific document IDs
|
|
69
|
-
* @property locationIds - Filter by location IDs within documents
|
|
70
|
-
* @property statusIds - Filter by comment status IDs (e.g., "open", "resolved")
|
|
71
|
-
* @property folderId - Filter by folder ID (use with allDocuments for folder-wide counts)
|
|
72
|
-
* @property allDocuments - When true with folderId, aggregates all documents in folder
|
|
73
|
-
* @property locationId - Single location filter (deprecated, use locationIds)
|
|
74
|
-
* @property aggregateDocuments - When true, combines all documentIds into single count
|
|
75
|
-
* @property filterGhostComments - When true, excludes orphaned/deleted comments from counts
|
|
76
|
-
* @property batchedPerDocument - When true, uses efficient batched listeners (4 instead of 100)
|
|
77
|
-
* but still returns per-document counts. Best for large document lists (50+).
|
|
78
|
-
* Trade-off: slight delay on updates due to debouncing.
|
|
79
|
-
* @property debounceMs - Debounce time in milliseconds for batchedPerDocument mode (default: 5000ms).
|
|
80
|
-
* Prevents rapid re-fetches when multiple documents update in quick succession.
|
|
81
|
-
*/
|
|
82
84
|
export interface CommentRequestQuery {
|
|
83
85
|
organizationId?: string;
|
|
84
86
|
documentIds?: string[];
|
|
@@ -89,10 +91,6 @@ export interface CommentRequestQuery {
|
|
|
89
91
|
locationId?: string;
|
|
90
92
|
aggregateDocuments?: boolean;
|
|
91
93
|
filterGhostComments?: boolean;
|
|
92
|
-
/** Enable batched listeners with per-document counts. Uses 4 listeners instead of N listeners. */
|
|
93
|
-
batchedPerDocument?: boolean;
|
|
94
|
-
/** Debounce time in ms for batchedPerDocument mode (default: 5000). */
|
|
95
|
-
debounceMs?: number;
|
|
96
94
|
}
|
|
97
95
|
export interface SubscribeCommentAnnotationRequest {
|
|
98
96
|
annotationId: string;
|
|
@@ -210,12 +208,3 @@ export interface FetchCommentAnnotationsRequest {
|
|
|
210
208
|
userIds?: string[];
|
|
211
209
|
mentionedUserIds?: string[];
|
|
212
210
|
}
|
|
213
|
-
export interface SubmitCommentRequest {
|
|
214
|
-
targetComposerElementId: string;
|
|
215
|
-
}
|
|
216
|
-
export interface ClearComposerRequest {
|
|
217
|
-
targetComposerElementId: string;
|
|
218
|
-
}
|
|
219
|
-
export interface GetComposerDataRequest {
|
|
220
|
-
targetComposerElementId: string;
|
|
221
|
-
}
|
|
@@ -184,7 +184,6 @@ export declare class CommentAnnotation {
|
|
|
184
184
|
unsubscribedUsers?: CommentAnnotationUnsubscribedUsers;
|
|
185
185
|
subscribedGroups?: CommentAnnotationSubscribedGroups;
|
|
186
186
|
resolvedByUserId?: string | null;
|
|
187
|
-
resolvedByUser?: User | null;
|
|
188
187
|
multiThreadAnnotationId?: string;
|
|
189
188
|
isDraft?: boolean;
|
|
190
189
|
sourceId?: string;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { 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,13 +80,10 @@ 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;
|
|
85
|
-
[CommentEventTypes.COMPOSER_TEXT_CHANGE]: ComposerTextChangeEvent;
|
|
86
|
-
[CommentEventTypes.COMMENT_TOOL_CLICK]: CommentToolClickEvent;
|
|
87
|
-
[CommentEventTypes.SIDEBAR_BUTTON_CLICK]: SidebarButtonClickEvent;
|
|
88
|
-
[CommentEventTypes.ATTACHMENT_DOWNLOAD_CLICKED]: AttachmentDownloadClickedEvent;
|
|
89
87
|
};
|
|
90
88
|
export interface AddAttachmentEvent {
|
|
91
89
|
annotationId: string;
|
|
@@ -100,6 +98,10 @@ export interface DeleteAttachmentEvent {
|
|
|
100
98
|
attachment: Attachment;
|
|
101
99
|
metadata: VeltEventMetadata;
|
|
102
100
|
}
|
|
101
|
+
export interface AddCommentAnnotationDraftEvent {
|
|
102
|
+
metadata: VeltEventMetadata;
|
|
103
|
+
addContext: (context: Record<string, unknown>) => void;
|
|
104
|
+
}
|
|
103
105
|
export interface AddCommentAnnotationEvent {
|
|
104
106
|
annotationId: string;
|
|
105
107
|
commentAnnotation: CommentAnnotation;
|
|
@@ -276,32 +278,5 @@ export interface CommentBubbleClickedEvent {
|
|
|
276
278
|
}
|
|
277
279
|
export interface ComposerTextChangeEvent {
|
|
278
280
|
text: string;
|
|
279
|
-
annotation: CommentAnnotation;
|
|
280
|
-
targetComposerElementId: string;
|
|
281
|
-
metadata?: VeltEventMetadata;
|
|
282
|
-
}
|
|
283
|
-
export interface CommentToolClickEvent {
|
|
284
|
-
context: {
|
|
285
|
-
[key: string]: any;
|
|
286
|
-
} | null;
|
|
287
|
-
targetElementId?: string | null;
|
|
288
|
-
metadata?: VeltEventMetadata;
|
|
289
|
-
}
|
|
290
|
-
export interface SidebarButtonClickEvent {
|
|
291
|
-
metadata?: VeltEventMetadata;
|
|
292
|
-
}
|
|
293
|
-
export interface AttachmentDownloadClickedEvent {
|
|
294
|
-
annotationId: string;
|
|
295
|
-
commentAnnotation: CommentAnnotation;
|
|
296
|
-
attachment: Attachment;
|
|
297
281
|
metadata?: VeltEventMetadata;
|
|
298
282
|
}
|
|
299
|
-
export interface PageModeComposerConfig {
|
|
300
|
-
context?: {
|
|
301
|
-
[key: string]: any;
|
|
302
|
-
} | null;
|
|
303
|
-
targetElementId?: string | null;
|
|
304
|
-
}
|
|
305
|
-
export interface AssignToConfig {
|
|
306
|
-
type: AssignToType;
|
|
307
|
-
}
|
|
@@ -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;
|
|
@@ -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 { 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, CopyLinkRequest, DeleteAttachmentRequest, DeleteCommentAnnotationRequest, DeleteCommentRequest, DeleteReactionRequest, DeleteRecordingRequest, FetchCommentAnnotationsRequest, GetAttachmentRequest, GetCommentRequest, GetLinkRequest, GetRecordingRequest, RejectCommentAnnotationRequest, ResolveCommentAnnotationRequest, 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, CommentAddEventData, CommentEventTypesMap, CommentUpdateEventData, CopyLinkEvent, DeleteAttachmentEvent, DeleteCommentAnnotationEvent, DeleteCommentEvent, DeleteReactionEvent, DeleteRecordingEvent, FetchCommentAnnotationsResponse, GetCommentAnnotationsCountResponse, GetCommentAnnotationsResponse, GetLinkEvent, 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, 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, ClearComposerRequest, CommentRequestQuery, 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";
|
|
11
|
-
import { UnreadCommentsCount, TransformContext } from "../data/comment-utils.data.model";
|
|
12
|
-
import { AssignToType, CommentSidebarSystemFiltersOperator, SidebarButtonCountType } from "../../utils/enums";
|
|
13
|
-
import { UploadFileData } from "../data/attachment.model";
|
|
14
14
|
|
|
15
15
|
export declare class CommentElement {
|
|
16
16
|
/**
|
|
@@ -85,39 +85,6 @@ 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
|
-
|
|
121
88
|
/**
|
|
122
89
|
* To enable moderator mode
|
|
123
90
|
*/
|
|
@@ -175,16 +142,6 @@ export declare class CommentElement {
|
|
|
175
142
|
*/
|
|
176
143
|
disableAttachments: () => any;
|
|
177
144
|
|
|
178
|
-
/**
|
|
179
|
-
* Enable automatic file download when attachment download button is clicked
|
|
180
|
-
*/
|
|
181
|
-
enableAttachmentDownload: () => any;
|
|
182
|
-
|
|
183
|
-
/**
|
|
184
|
-
* Disable automatic file download when attachment download button is clicked. The attachmentDownloadClicked event will still be triggered.
|
|
185
|
-
*/
|
|
186
|
-
disableAttachmentDownload: () => any;
|
|
187
|
-
|
|
188
145
|
/**
|
|
189
146
|
* Get if user is part of global contact or not.
|
|
190
147
|
*/
|
|
@@ -372,7 +329,7 @@ export declare class CommentElement {
|
|
|
372
329
|
* @description Sets the comment context provider
|
|
373
330
|
* @param provider
|
|
374
331
|
*/
|
|
375
|
-
public setContextProvider: (provider:
|
|
332
|
+
public setContextProvider: (provider: CommentContextProvider | null) => void;
|
|
376
333
|
|
|
377
334
|
/**
|
|
378
335
|
* To enable suggestion mode
|
|
@@ -866,6 +823,14 @@ export declare class CommentElement {
|
|
|
866
823
|
*/
|
|
867
824
|
public updateContext: (annotationId: string, context: any, config?: UpdateContextConfig) => Promise<any>;
|
|
868
825
|
|
|
826
|
+
/**
|
|
827
|
+
* Updates the visibility of a comment annotation.
|
|
828
|
+
* @param annotationId Annotation Id
|
|
829
|
+
* @param visibility Visibility configuration (public, organization, or self)
|
|
830
|
+
* @returns Promise<any>
|
|
831
|
+
*/
|
|
832
|
+
public updateVisibility: (annotationId: string, visibility: CommentVisibilityConfig) => Promise<any>;
|
|
833
|
+
|
|
869
834
|
/**
|
|
870
835
|
* Subscribe to selected comments
|
|
871
836
|
* @returns list of selected comments
|
|
@@ -1307,6 +1272,13 @@ export declare class CommentElement {
|
|
|
1307
1272
|
*/
|
|
1308
1273
|
public disableScreenshot: () => void;
|
|
1309
1274
|
|
|
1275
|
+
/**
|
|
1276
|
+
* To programmatically submit a comment from a velt-comment-composer.
|
|
1277
|
+
* Finds the composer within the element identified by referenceId and submits its content.
|
|
1278
|
+
* @param referenceId The ID of the HTML element containing the velt-comment-composer
|
|
1279
|
+
*/
|
|
1280
|
+
public submitComment: (referenceId: string) => void;
|
|
1281
|
+
|
|
1310
1282
|
/**
|
|
1311
1283
|
* To enable paginated contact list
|
|
1312
1284
|
*/
|
|
@@ -1317,26 +1289,6 @@ export declare class CommentElement {
|
|
|
1317
1289
|
*/
|
|
1318
1290
|
public disablePaginatedContactList: () => void;
|
|
1319
1291
|
|
|
1320
|
-
/**
|
|
1321
|
-
* Programmatically trigger comment submission for a composer with the given targetComposerElementId
|
|
1322
|
-
* @param request SubmitCommentRequest containing targetComposerElementId
|
|
1323
|
-
*/
|
|
1324
|
-
public submitComment: (request: SubmitCommentRequest) => void;
|
|
1325
|
-
|
|
1326
|
-
/**
|
|
1327
|
-
* Clear the composer state for a composer with the given targetComposerElementId
|
|
1328
|
-
* @param request ClearComposerRequest containing targetComposerElementId
|
|
1329
|
-
*/
|
|
1330
|
-
public clearComposer: (request: ClearComposerRequest) => void;
|
|
1331
|
-
|
|
1332
|
-
/**
|
|
1333
|
-
* Get the current composer data for a given targetComposerElementId
|
|
1334
|
-
* Returns the same data as COMPOSER_TEXT_CHANGE event but as a one-time fetch
|
|
1335
|
-
* @param request GetComposerDataRequest containing targetComposerElementId
|
|
1336
|
-
* @returns The composer data or null if not found
|
|
1337
|
-
*/
|
|
1338
|
-
public getComposerData: (request: GetComposerDataRequest) => ComposerTextChangeEvent | null;
|
|
1339
|
-
|
|
1340
1292
|
constructor();
|
|
1341
1293
|
/**
|
|
1342
1294
|
* Subscribe to comments on the current document.
|
|
@@ -1467,16 +1419,6 @@ export declare class CommentElement {
|
|
|
1467
1419
|
*/
|
|
1468
1420
|
private _disableAttachments;
|
|
1469
1421
|
|
|
1470
|
-
/**
|
|
1471
|
-
* To enable automatic file download on attachment download click
|
|
1472
|
-
*/
|
|
1473
|
-
private _enableAttachmentDownload;
|
|
1474
|
-
|
|
1475
|
-
/**
|
|
1476
|
-
* To disable automatic file download on attachment download click
|
|
1477
|
-
*/
|
|
1478
|
-
private _disableAttachmentDownload;
|
|
1479
|
-
|
|
1480
1422
|
/**
|
|
1481
1423
|
* Enable device info in comments
|
|
1482
1424
|
*/
|
|
@@ -2148,6 +2090,14 @@ export declare class CommentElement {
|
|
|
2148
2090
|
*/
|
|
2149
2091
|
private _updateContext;
|
|
2150
2092
|
|
|
2093
|
+
/**
|
|
2094
|
+
* Updates the visibility of a comment annotation.
|
|
2095
|
+
* @param annotationId Annotation Id
|
|
2096
|
+
* @param visibility Visibility configuration (public, organization, or self)
|
|
2097
|
+
* @returns Promise<any>
|
|
2098
|
+
*/
|
|
2099
|
+
private _updateVisibility;
|
|
2100
|
+
|
|
2151
2101
|
/**
|
|
2152
2102
|
* Subscribe to selected comments
|
|
2153
2103
|
* @returns list of selected comments
|
|
@@ -2601,53 +2551,9 @@ export declare class CommentElement {
|
|
|
2601
2551
|
private _disablePaginatedContactList;
|
|
2602
2552
|
|
|
2603
2553
|
/**
|
|
2604
|
-
*
|
|
2605
|
-
*
|
|
2554
|
+
* To programmatically submit a comment from a velt-comment-composer.
|
|
2555
|
+
* Finds the composer within the element identified by referenceId and submits its content.
|
|
2556
|
+
* @param referenceId The ID of the HTML element containing the velt-comment-composer
|
|
2606
2557
|
*/
|
|
2607
2558
|
private _submitComment;
|
|
2608
|
-
|
|
2609
|
-
/**
|
|
2610
|
-
* Clear the composer state for a composer with the given targetComposerElementId
|
|
2611
|
-
* @param request ClearComposerRequest containing targetComposerElementId
|
|
2612
|
-
*/
|
|
2613
|
-
private _clearComposer;
|
|
2614
|
-
|
|
2615
|
-
/**
|
|
2616
|
-
* Get the current composer data for a given targetComposerElementId
|
|
2617
|
-
* Returns the same data as COMPOSER_TEXT_CHANGE event but as a one-time fetch
|
|
2618
|
-
* @param request GetComposerDataRequest containing targetComposerElementId
|
|
2619
|
-
* @returns The composer data or null if not found
|
|
2620
|
-
*/
|
|
2621
|
-
private _getComposerData;
|
|
2622
|
-
|
|
2623
|
-
/**
|
|
2624
|
-
* To enable context in page mode composer feature
|
|
2625
|
-
*/
|
|
2626
|
-
private _enableContextInPageModeComposer;
|
|
2627
|
-
|
|
2628
|
-
/**
|
|
2629
|
-
* To disable context in page mode composer feature
|
|
2630
|
-
*/
|
|
2631
|
-
private _disableContextInPageModeComposer;
|
|
2632
|
-
|
|
2633
|
-
/**
|
|
2634
|
-
* To clear page mode composer context
|
|
2635
|
-
*/
|
|
2636
|
-
private _clearPageModeComposerContext;
|
|
2637
|
-
|
|
2638
|
-
/**
|
|
2639
|
-
* To set context in page mode composer
|
|
2640
|
-
*/
|
|
2641
|
-
private _setContextInPageModeComposer;
|
|
2642
|
-
|
|
2643
|
-
/**
|
|
2644
|
-
* To focus the page mode composer input
|
|
2645
|
-
*/
|
|
2646
|
-
private _focusPageModeComposer;
|
|
2647
|
-
|
|
2648
|
-
/**
|
|
2649
|
-
* To set assign to type for comment dialog
|
|
2650
|
-
* @param type 'dropdown' | 'checkbox'
|
|
2651
|
-
*/
|
|
2652
|
-
private _setAssignToType;
|
|
2653
2559
|
}
|
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;
|
|
@@ -244,16 +245,6 @@ export declare class Constants {
|
|
|
244
245
|
VELT_WIREFRAME: string;
|
|
245
246
|
VELT_AUTOCOMPLETE: string;
|
|
246
247
|
VELT_AUTOCOMPLETE_CHIP: string;
|
|
247
|
-
VELT_COMMENT_DIALOG_HEADER: string;
|
|
248
|
-
VELT_COMMENT_DIALOG_BODY: string;
|
|
249
|
-
VELT_COMMENT_DIALOG_FOOTER: string;
|
|
250
|
-
VELT_COMMENT_DIALOG_PRIORITY: string;
|
|
251
|
-
VELT_COMMENT_DIALOG_STATUS: string;
|
|
252
|
-
VELT_COMMENT_DIALOG_COPY_LINK: string;
|
|
253
|
-
VELT_COMMENT_DIALOG_RESOLVE_BUTTON: string;
|
|
254
|
-
VELT_COMMENT_DIALOG_OPTIONS: string;
|
|
255
|
-
VELT_COMMENT_DIALOG_BODY_THREAD_CARD: string;
|
|
256
|
-
VELT_COMMENT_DIALOG_PRIVATE_BANNER: string;
|
|
257
248
|
VELT_COMMENT_COMPOSER: string;
|
|
258
249
|
VELT_SKELETON_LOADER: string;
|
|
259
250
|
VELT_SHADOW_DOM_INTERNAL: 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,13 +55,10 @@ 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";
|
|
60
|
-
readonly COMPOSER_TEXT_CHANGE: "composerTextChange";
|
|
61
|
-
readonly COMMENT_TOOL_CLICK: "commentToolClick";
|
|
62
|
-
readonly SIDEBAR_BUTTON_CLICK: "sidebarButtonClick";
|
|
63
|
-
readonly ATTACHMENT_DOWNLOAD_CLICKED: "attachmentDownloadClicked";
|
|
64
62
|
};
|
|
65
63
|
export declare const RecorderEventTypes: {
|
|
66
64
|
readonly TRANSCRIPTION_DONE: "transcriptionDone";
|
|
@@ -189,7 +187,6 @@ export declare enum AnalyticsFeatures {
|
|
|
189
187
|
COMMENT_SIDEBAR = "commentSidebar"
|
|
190
188
|
}
|
|
191
189
|
export type FeatureType = 'area' | 'arrow' | 'audioHuddle' | 'comment' | 'cursor' | 'huddle' | 'liveStateSync' | 'presence' | 'recorder' | 'rewriter' | 'tag' | 'liveSelection' | 'notification' | 'reaction' | 'multiThread';
|
|
192
|
-
export type AssignToType = 'dropdown' | 'checkbox';
|
|
193
190
|
export declare enum DeviceType {
|
|
194
191
|
DESKTOP = "Desktop",
|
|
195
192
|
MOBILE = "Mobile",
|
|
@@ -282,10 +279,10 @@ export type OverlayOriginY = 'top' | 'center' | 'bottom';
|
|
|
282
279
|
export type OverlayOriginX = 'start' | 'center' | 'end';
|
|
283
280
|
export type SubtitlesMode = 'floating' | 'embed';
|
|
284
281
|
export type RecorderVariant = 'default' | 'embed';
|
|
285
|
-
export type ReactionPinType = 'timeline' | 'comment'
|
|
282
|
+
export type ReactionPinType = 'timeline' | 'comment';
|
|
286
283
|
export type SidebarPosition = 'left' | 'right';
|
|
287
284
|
export type SidebarSortingCriteria = 'date' | 'unread' | null;
|
|
288
|
-
export type SidebarFilterCriteria = 'all' | 'read' | 'unread' | 'resolved' | 'open' | '
|
|
285
|
+
export type SidebarFilterCriteria = 'all' | 'read' | 'unread' | 'resolved' | 'open' | 'reset' | null;
|
|
289
286
|
export type SidebarFilterSearchType = 'people' | 'assigned' | 'tagged' | 'involved' | 'pages' | 'documents' | 'statuses' | 'priorities' | 'categories' | 'versions' | string;
|
|
290
287
|
export type InlineSortingCriteria = 'createdFirst' | 'createdLast' | 'updatedFirst' | 'updatedLast';
|
|
291
288
|
export type NotificationPanelMode = 'popover' | 'sidebar';
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@veltdev/sdk-staging",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "5.0.0-beta.10",
|
|
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": [
|
|
@@ -36,7 +36,7 @@
|
|
|
36
36
|
"scripts": {
|
|
37
37
|
"test": "echo \"Error: no test specified\" && exit 1",
|
|
38
38
|
"version:update": "node ../update-npm-package.mjs",
|
|
39
|
-
"publish:sdk": "npm publish
|
|
39
|
+
"publish:sdk": "npm publish"
|
|
40
40
|
},
|
|
41
41
|
"author": "",
|
|
42
42
|
"license": "ISC",
|