@veltdev/types 6.0.8-beta.2 → 6.0.9-beta.1
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.
|
@@ -291,3 +291,16 @@ export interface CrossOrganizationConfig {
|
|
|
291
291
|
/** Feeds the merge applies to. Only `'forYou'` is supported; `'all'` is ignored with a warning. */
|
|
292
292
|
feeds?: ('forYou' | 'all')[];
|
|
293
293
|
}
|
|
294
|
+
/**
|
|
295
|
+
* Config for the user-scoped "For You" notifications fetch
|
|
296
|
+
* (`enableUserScopedNotifications`). When enabled, the SDK fetches the user's
|
|
297
|
+
* newest notifications for the current organization directly — independent of
|
|
298
|
+
* the recently-active-documents window — so unread notifications on documents
|
|
299
|
+
* outside that window stay visible in the For You tab and unread count.
|
|
300
|
+
*
|
|
301
|
+
* @see specs/org-notifications-top15-document-window/spec.md
|
|
302
|
+
*/
|
|
303
|
+
export interface UserScopedNotificationsConfig {
|
|
304
|
+
/** Max user-scoped notifications fetched. Default 25; clamped to [1, 200]. */
|
|
305
|
+
limit?: number;
|
|
306
|
+
}
|
|
@@ -4,9 +4,9 @@ import { Observable } from "rxjs";
|
|
|
4
4
|
import { AssignToType, CommentSidebarSystemFiltersOperator, DetectionStrategy, SidebarButtonCountType } from "../../utils/enums";
|
|
5
5
|
import { UploadFileData, Attachment } from "../data/attachment.model";
|
|
6
6
|
import { AutocompleteData } from "../data/autocomplete.data.model";
|
|
7
|
-
import { AcceptCommentAnnotationRequest, AddAttachmentRequest, AddAttachmentResponse, AddCommentAnnotationRequest, AddCommentRequest, AddReactionRequest, ApproveCommentAnnotationRequest, AssignUserRequest, CommentRequestQuery, CommentVisibilityConfig, ClearComposerRequest, CopyLinkRequest, DeleteAttachmentRequest, DeleteCommentAnnotationRequest, DeleteCommentRequest, DeleteReactionRequest, DeleteRecordingRequest, FetchCommentAnnotationsRequest, FormatConfig, GetAttachmentRequest, GetCommentRequest, GetComposerDataRequest, GetLinkRequest, GetRecordingRequest, PrivateModeConfig, RejectCommentAnnotationRequest, ResolveCommentAnnotationRequest, SubmitCommentRequest, SubscribeCommentAnnotationRequest, ToggleReactionRequest, UnsubscribeCommentAnnotationRequest, UpdateAccessRequest, UpdateCommentRequest, UpdatePriorityRequest, UpdateStatusRequest } from "../data/comment-actions.data.model";
|
|
7
|
+
import { AcceptSuggestionRequest, RejectSuggestionRequest, AcceptCommentAnnotationRequest, AddAttachmentRequest, AddAttachmentResponse, AddCommentAnnotationRequest, AddCommentRequest, AddReactionRequest, ApproveCommentAnnotationRequest, AssignUserRequest, CommentRequestQuery, CommentVisibilityConfig, ClearComposerRequest, CopyLinkRequest, DeleteAttachmentRequest, DeleteCommentAnnotationRequest, DeleteCommentRequest, DeleteReactionRequest, DeleteRecordingRequest, FetchCommentAnnotationsRequest, FormatConfig, GetAttachmentRequest, GetCommentRequest, GetComposerDataRequest, GetLinkRequest, GetRecordingRequest, PrivateModeConfig, RejectCommentAnnotationRequest, ResolveCommentAnnotationRequest, SubmitCommentRequest, SubscribeCommentAnnotationRequest, ToggleReactionRequest, UnsubscribeCommentAnnotationRequest, UpdateAccessRequest, UpdateCommentRequest, UpdatePriorityRequest, UpdateStatusRequest } from "../data/comment-actions.data.model";
|
|
8
8
|
import { CommentAnnotation, CommentOnElementConfig, CommentSelectionChangeData, ManualCommentAnnotationConfig, UpdateContextConfig } from "../data/comment-annotation.data.model";
|
|
9
|
-
import { AcceptCommentAnnotationEvent, AddCommentAnnotationEvent, AddCommentEvent, AddReactionEvent, ApproveCommentAnnotationEvent, AssignToConfig, AssignUserEvent, CommentAddEventData, CommentEventTypesMap, CommentUpdateEventData, ComposerTextChangeEvent, CopyLinkEvent, DeleteAttachmentEvent, DeleteCommentAnnotationEvent, DeleteCommentEvent, DeleteReactionEvent, DeleteRecordingEvent, FetchCommentAnnotationsResponse, GetCommentAnnotationsCountResponse, GetCommentAnnotationsResponse, GetLinkResponse, PageModeComposerConfig, RejectCommentAnnotationEvent, SubscribeCommentAnnotationEvent, UnsubscribeCommentAnnotationEvent, ToggleReactionEvent, UpdateAccessEvent, UpdateCommentEvent, UpdatePriorityEvent, UpdateStatusEvent } from "../data/comment-events.data.model";
|
|
9
|
+
import { SuggestionAcceptEvent, SuggestionRejectEvent, AcceptCommentAnnotationEvent, AddCommentAnnotationEvent, AddCommentEvent, AddReactionEvent, ApproveCommentAnnotationEvent, AssignToConfig, AssignUserEvent, CommentAddEventData, CommentEventTypesMap, CommentUpdateEventData, ComposerTextChangeEvent, CopyLinkEvent, DeleteAttachmentEvent, DeleteCommentAnnotationEvent, DeleteCommentEvent, DeleteReactionEvent, DeleteRecordingEvent, FetchCommentAnnotationsResponse, GetCommentAnnotationsCountResponse, GetCommentAnnotationsResponse, GetLinkResponse, PageModeComposerConfig, RejectCommentAnnotationEvent, SubscribeCommentAnnotationEvent, UnsubscribeCommentAnnotationEvent, ToggleReactionEvent, UpdateAccessEvent, UpdateCommentEvent, UpdatePriorityEvent, UpdateStatusEvent } from "../data/comment-events.data.model";
|
|
10
10
|
import { CommentSidebarCustomActionEventData, CommentSidebarCustomActionsState, CommentSidebarData, CommentSidebarDataOptions } from "../data/comment-sidebar-config.model";
|
|
11
11
|
import { CommentContextProvider, TransformContext, UnreadCommentsCount } from "../data/comment-utils.data.model";
|
|
12
12
|
import { CustomAnnotationDropdownData } from "../data/custom-chip-dropdown.data.model";
|
|
@@ -1082,14 +1082,44 @@ export declare class CommentElement {
|
|
|
1082
1082
|
|
|
1083
1083
|
/**
|
|
1084
1084
|
* To accept comment annotation
|
|
1085
|
+
*
|
|
1086
|
+
* @deprecated Use {@link acceptSuggestion} instead.
|
|
1087
|
+
*
|
|
1088
|
+
* The legacy "comments-as-suggestions" flow. Writes the workflow status
|
|
1089
|
+
* (`annotation.status = Accepted`) and does NOT change `annotation.type`, so a
|
|
1090
|
+
* suggestion card accepted this way keeps rendering as a suggestion.
|
|
1091
|
+
* `acceptSuggestion` writes `annotation.suggestion.status` AND flips `type` to
|
|
1092
|
+
* `'comment'`, which is what retires the card.
|
|
1093
|
+
*
|
|
1094
|
+
* Still functional; no removal date is set. `approveCommentAnnotation` is a
|
|
1095
|
+
* separate mechanism and is NOT deprecated.
|
|
1085
1096
|
*/
|
|
1086
1097
|
public acceptCommentAnnotation: (request: AcceptCommentAnnotationRequest) => Promise<AcceptCommentAnnotationEvent | null>;
|
|
1087
1098
|
|
|
1088
1099
|
/**
|
|
1089
1100
|
* To reject comment annotation
|
|
1101
|
+
*
|
|
1102
|
+
* @deprecated Use {@link rejectSuggestion} instead. The reject half of the
|
|
1103
|
+
* legacy flow — writes `annotation.status = Rejected` without touching
|
|
1104
|
+
* `annotation.type`. See {@link acceptCommentAnnotation}.
|
|
1090
1105
|
*/
|
|
1091
1106
|
public rejectCommentAnnotation: (request: RejectCommentAnnotationRequest) => Promise<RejectCommentAnnotationEvent | null>;
|
|
1092
1107
|
|
|
1108
|
+
/**
|
|
1109
|
+
* Accept a `type: 'suggestion'` annotation — the same operation the suggestion
|
|
1110
|
+
* card's built-in accept button performs: writes `suggestion.status` AND flips
|
|
1111
|
+
* `type` to `'comment'`, which retires the card into a normal thread.
|
|
1112
|
+
*
|
|
1113
|
+
* Distinct from `acceptCommentAnnotation`, which is the legacy
|
|
1114
|
+
* comments-as-suggestions flow and writes `annotation.status` instead.
|
|
1115
|
+
*/
|
|
1116
|
+
public acceptSuggestion: (request: AcceptSuggestionRequest) => Promise<SuggestionAcceptEvent | null>;
|
|
1117
|
+
|
|
1118
|
+
/**
|
|
1119
|
+
* Reject a `type: 'suggestion'` annotation. See `acceptSuggestion`.
|
|
1120
|
+
*/
|
|
1121
|
+
public rejectSuggestion: (request: RejectSuggestionRequest) => Promise<SuggestionRejectEvent | null>;
|
|
1122
|
+
|
|
1093
1123
|
/**
|
|
1094
1124
|
* To subscribe comment annotation
|
|
1095
1125
|
*/
|
|
@@ -2471,6 +2501,8 @@ export declare class CommentElement {
|
|
|
2471
2501
|
* To reject comment annotation
|
|
2472
2502
|
*/
|
|
2473
2503
|
private _rejectCommentAnnotation;
|
|
2504
|
+
private _acceptSuggestion;
|
|
2505
|
+
private _rejectSuggestion;
|
|
2474
2506
|
|
|
2475
2507
|
/**
|
|
2476
2508
|
* To subscribe to comment annotation
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { Observable } from "rxjs";
|
|
2
2
|
|
|
3
|
-
import { CrossOrganizationConfig, GetNotificationsDataQuery, Notification, NotificationInitialSettingsConfig, NotificationSettingsConfig, NotificationTabConfig } from "../data/notification.model";
|
|
3
|
+
import { CrossOrganizationConfig, GetNotificationsDataQuery, Notification, NotificationInitialSettingsConfig, NotificationSettingsConfig, NotificationTabConfig, UserScopedNotificationsConfig } from "../data/notification.model";
|
|
4
4
|
import { NotificationEventTypesMap } from "../data/notifications-events.data.model";
|
|
5
5
|
|
|
6
6
|
export declare class NotificationElement {
|
|
@@ -139,6 +139,19 @@ export declare class NotificationElement {
|
|
|
139
139
|
*/
|
|
140
140
|
disableCrossOrganization: () => void;
|
|
141
141
|
|
|
142
|
+
/**
|
|
143
|
+
* To enable the user-scoped "For You" notifications fetch: fetches the user's newest
|
|
144
|
+
* notifications for the current organization independent of the recently-active-documents
|
|
145
|
+
* window, so unread notifications on older documents stay visible in the For You tab and
|
|
146
|
+
* unread count. Default limit 25; clamped to [1, 200].
|
|
147
|
+
*/
|
|
148
|
+
enableUserScopedNotifications: (config?: UserScopedNotificationsConfig) => void;
|
|
149
|
+
|
|
150
|
+
/**
|
|
151
|
+
* To disable the user-scoped "For You" notifications fetch (restores windowed behavior)
|
|
152
|
+
*/
|
|
153
|
+
disableUserScopedNotifications: () => void;
|
|
154
|
+
|
|
142
155
|
/**
|
|
143
156
|
* Subscribe to notification events
|
|
144
157
|
*/
|
|
@@ -281,6 +294,16 @@ export declare class NotificationElement {
|
|
|
281
294
|
*/
|
|
282
295
|
private _disableCrossOrganization;
|
|
283
296
|
|
|
297
|
+
/**
|
|
298
|
+
* To enable the user-scoped "For You" notifications fetch
|
|
299
|
+
*/
|
|
300
|
+
private _enableUserScopedNotifications;
|
|
301
|
+
|
|
302
|
+
/**
|
|
303
|
+
* To disable the user-scoped "For You" notifications fetch
|
|
304
|
+
*/
|
|
305
|
+
private _disableUserScopedNotifications;
|
|
306
|
+
|
|
284
307
|
/**
|
|
285
308
|
* Subscribe to notification events
|
|
286
309
|
*/
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@veltdev/types",
|
|
3
|
-
"version": "6.0.
|
|
3
|
+
"version": "6.0.9-beta.1",
|
|
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": [
|