@veltdev/types-dev 5.0.2-beta.112 → 5.0.2-beta.12
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/client/snippyly.model.d.ts +1 -34
- package/app/models/data/attachment-resolver.data.model.d.ts +2 -2
- package/app/models/data/attachment.model.d.ts +0 -1
- package/app/models/data/autocomplete.data.model.d.ts +3 -4
- package/app/models/data/base-metadata.data.model.d.ts +0 -3
- package/app/models/data/comment-actions.data.model.d.ts +0 -12
- package/app/models/data/comment-annotation.data.model.d.ts +0 -63
- package/app/models/data/comment-events.data.model.d.ts +0 -24
- package/app/models/data/comment-resolver.data.model.d.ts +3 -3
- package/app/models/data/comment-sidebar-config.model.d.ts +0 -2
- package/app/models/data/comment.data.model.d.ts +0 -18
- package/app/models/data/config.data.model.d.ts +0 -26
- package/app/models/data/core-events.data.model.d.ts +0 -72
- package/app/models/data/crdt.data.model.d.ts +0 -51
- package/app/models/data/document-paths.data.model.d.ts +0 -1
- package/app/models/data/document.data.model.d.ts +0 -2
- package/app/models/data/live-state-events.data.model.d.ts +0 -6
- package/app/models/data/notification.model.d.ts +0 -24
- package/app/models/data/page-info.model.d.ts +0 -9
- package/app/models/data/presence-user.data.model.d.ts +0 -5
- package/app/models/data/provider.data.model.d.ts +0 -6
- package/app/models/data/reaction-annotation.data.model.d.ts +0 -5
- package/app/models/data/reaction-resolver.data.model.d.ts +3 -3
- package/app/models/data/recorder-annotation.data.model.d.ts +0 -11
- package/app/models/data/recorder-events.data.model.d.ts +0 -3
- package/app/models/data/resolver.data.model.d.ts +0 -1
- package/app/models/data/user-resolver.data.model.d.ts +0 -2
- package/app/models/data/user.data.model.d.ts +1 -50
- package/app/models/element/comment-element.model.d.ts +0 -44
- package/app/models/element/crdt-element.model.d.ts +1 -88
- package/app/models/element/notification-element.model.d.ts +1 -15
- package/app/models/element/presence-element.model.d.ts +0 -25
- package/app/models/element/rewriter-element.model.d.ts +0 -20
- package/app/utils/constants.d.ts +0 -226
- package/app/utils/enums.d.ts +7 -40
- package/models.d.ts +0 -8
- package/package.json +1 -1
- package/types.d.ts +0 -3
- package/app/models/data/activity-resolver.data.model.d.ts +0 -27
- package/app/models/data/activity.data.model.d.ts +0 -181
- package/app/models/data/agent-suggestion.data.model.d.ts +0 -57
- package/app/models/data/notification-resolver.data.model.d.ts +0 -39
- package/app/models/data/recorder-resolver.data.model.d.ts +0 -58
- package/app/models/data/rewriter-events.data.model.d.ts +0 -44
- package/app/models/data/suggestion-events.data.model.d.ts +0 -57
- package/app/models/data/suggestion.data.model.d.ts +0 -267
- package/app/models/element/activity-element.model.d.ts +0 -33
- package/app/models/element/suggestion-element.model.d.ts +0 -180
- package/app/utils/console.d.ts +0 -25
- package/app/utils/page-info-store.d.ts +0 -29
|
@@ -5,7 +5,6 @@ import { DocumentUser } from "../models/data/document-user.data.model";
|
|
|
5
5
|
import { Location } from "../models/data/location.model";
|
|
6
6
|
import { User, UserOptions, VeltAuthProvider, VeltPermissionProvider } from "../models/data/user.data.model";
|
|
7
7
|
import { CustomCss } from "../models/data/custom-css.data.model";
|
|
8
|
-
import { ActivityElement } from "../models/element/activity-element.model";
|
|
9
8
|
import { AreaElement } from "../models/element/area-element.model";
|
|
10
9
|
import { ArrowElement } from "../models/element/arrow-element.model";
|
|
11
10
|
import { CommentElement } from "../models/element/comment-element.model";
|
|
@@ -24,7 +23,6 @@ import { TagElement } from "../models/element/tag-element.model";
|
|
|
24
23
|
import { FeatureType } from "../utils/enums";
|
|
25
24
|
import { UserContact } from "../models/data/user-contact.data.model";
|
|
26
25
|
import { DocumentMetadata } from "../models/data/document-metadata.model";
|
|
27
|
-
import { PageInfo } from "../models/data/page-info.model";
|
|
28
26
|
import { ReactionElement } from "../models/element/reaction-element.model";
|
|
29
27
|
import { CrdtElement } from "../models/element/crdt-element.model";
|
|
30
28
|
import { VeltEventMetadata, VeltDebugInfo } from "../models/data/event-metadata.data.model";
|
|
@@ -56,23 +54,6 @@ export declare class Snippyly {
|
|
|
56
54
|
* @param documentMetadata Document Metadata
|
|
57
55
|
*/
|
|
58
56
|
setDocument: (id: string, documentMetadata?: DocumentMetadata) => Promise<void>;
|
|
59
|
-
/**
|
|
60
|
-
* Provide custom page info that the SDK should use instead of generating it from the browser
|
|
61
|
-
* (`window.location` / `document.title`). Newly created data (comments, reactions, recordings,
|
|
62
|
-
* presence, cursors, etc.) will use the provided page info. Already saved/existing data is not
|
|
63
|
-
* affected.
|
|
64
|
-
* @param pageInfo client-provided page info
|
|
65
|
-
* @param options optional; pass a `documentId` to scope the page info to a specific document
|
|
66
|
-
* (per-document page info takes precedence over the global page info)
|
|
67
|
-
*/
|
|
68
|
-
setPageInfo: (pageInfo: PageInfo, options?: { documentId?: string; }) => void;
|
|
69
|
-
/**
|
|
70
|
-
* Clear custom page info previously set via `setPageInfo`. The SDK will resume generating
|
|
71
|
-
* page info from the browser.
|
|
72
|
-
* @param options optional; pass a `documentId` to clear only that document's page info,
|
|
73
|
-
* otherwise the global page info is cleared
|
|
74
|
-
*/
|
|
75
|
-
clearPageInfo: (options?: { documentId?: string; }) => void;
|
|
76
57
|
/**
|
|
77
58
|
* Tell us the unique ID of the current document/resource on which you want to enable collaboration.
|
|
78
59
|
* @param id unique document ID
|
|
@@ -251,10 +232,6 @@ export declare class Snippyly {
|
|
|
251
232
|
* Get the Autocomplete Object.
|
|
252
233
|
*/
|
|
253
234
|
getAutocompleteElement: () => AutocompleteElement;
|
|
254
|
-
/**
|
|
255
|
-
* Get the Activity Element Object.
|
|
256
|
-
*/
|
|
257
|
-
getActivityElement: () => ActivityElement;
|
|
258
235
|
/**
|
|
259
236
|
* Get the Area Object.
|
|
260
237
|
*/
|
|
@@ -383,7 +360,7 @@ export declare class Snippyly {
|
|
|
383
360
|
/**
|
|
384
361
|
* To update user contact list.
|
|
385
362
|
*/
|
|
386
|
-
updateContactList: (userContacts: UserContact[], config?: { merge: boolean
|
|
363
|
+
updateContactList: (userContacts: UserContact[], config?: { merge: boolean }) => void;
|
|
387
364
|
|
|
388
365
|
/**
|
|
389
366
|
* To get document metadata.
|
|
@@ -426,16 +403,6 @@ export declare class Snippyly {
|
|
|
426
403
|
*/
|
|
427
404
|
disableSafeEval: () => void;
|
|
428
405
|
|
|
429
|
-
/**
|
|
430
|
-
* Enable Firestore persistent cache for offline support.
|
|
431
|
-
*/
|
|
432
|
-
enableFirestorePersistentCache: (config?: { ha?: boolean }) => void;
|
|
433
|
-
|
|
434
|
-
/**
|
|
435
|
-
* Disable Firestore persistent cache.
|
|
436
|
-
*/
|
|
437
|
-
disableFirestorePersistentCache: (config?: { ha?: boolean }) => void;
|
|
438
|
-
|
|
439
406
|
/**
|
|
440
407
|
* To reset the button toggle map.
|
|
441
408
|
*/
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import { ResolverActions } from "../../utils/enums";
|
|
2
2
|
import { ResolverConfig, ResolverResponse } from "./resolver.data.model";
|
|
3
3
|
export interface AttachmentDataProvider {
|
|
4
|
-
save
|
|
5
|
-
delete
|
|
4
|
+
save: (request: SaveAttachmentResolverRequest) => Promise<ResolverResponse<SaveAttachmentResolverData>>;
|
|
5
|
+
delete: (request: DeleteAttachmentResolverRequest) => Promise<ResolverResponse<undefined>>;
|
|
6
6
|
config?: ResolverConfig;
|
|
7
7
|
}
|
|
8
8
|
export interface DeleteAttachmentResolverRequest {
|
|
@@ -22,20 +22,19 @@ export declare class AutocompleteItem {
|
|
|
22
22
|
groupId?: string;
|
|
23
23
|
}
|
|
24
24
|
export declare class AutocompleteReplaceData {
|
|
25
|
-
text
|
|
25
|
+
text: string;
|
|
26
26
|
custom: AutocompleteItem;
|
|
27
27
|
}
|
|
28
28
|
export declare class AutocompleteGroupReplaceData {
|
|
29
|
-
text
|
|
29
|
+
text: string;
|
|
30
30
|
groupId: string;
|
|
31
31
|
clientGroupId: string;
|
|
32
32
|
group?: OrganizationUserGroup;
|
|
33
33
|
}
|
|
34
34
|
export declare class AutocompleteUserContactReplaceData {
|
|
35
|
-
text
|
|
35
|
+
text: string;
|
|
36
36
|
userId: string;
|
|
37
37
|
contact?: UserContact;
|
|
38
|
-
isEmailValid?: boolean;
|
|
39
38
|
}
|
|
40
39
|
export declare class AutocompleteGroup {
|
|
41
40
|
id: string;
|
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
import { DocumentMetadata } from './document-metadata.model';
|
|
2
1
|
export declare class BaseMetadata {
|
|
3
2
|
apiKey?: string;
|
|
4
3
|
documentId?: string;
|
|
@@ -7,6 +6,4 @@ export declare class BaseMetadata {
|
|
|
7
6
|
clientOrganizationId?: string;
|
|
8
7
|
folderId?: string;
|
|
9
8
|
veltFolderId?: string;
|
|
10
|
-
documentMetadata?: DocumentMetadata;
|
|
11
|
-
sdkVersion?: string | null;
|
|
12
9
|
}
|
|
@@ -89,16 +89,6 @@ export interface RejectCommentAnnotationRequest {
|
|
|
89
89
|
annotationId: string;
|
|
90
90
|
options?: RequestOptions;
|
|
91
91
|
}
|
|
92
|
-
export interface AcceptSuggestionRequest {
|
|
93
|
-
annotationId: string;
|
|
94
|
-
options?: RequestOptions;
|
|
95
|
-
}
|
|
96
|
-
export interface RejectSuggestionRequest {
|
|
97
|
-
annotationId: string;
|
|
98
|
-
/** Optional human-readable reason persisted on the suggestion. */
|
|
99
|
-
reason?: string;
|
|
100
|
-
options?: RequestOptions;
|
|
101
|
-
}
|
|
102
92
|
export interface DeleteCommentAnnotationRequest {
|
|
103
93
|
annotationId: string;
|
|
104
94
|
options?: RequestOptions;
|
|
@@ -135,8 +125,6 @@ export interface CommentRequestQuery {
|
|
|
135
125
|
batchedPerDocument?: boolean;
|
|
136
126
|
/** Debounce time in ms for batchedPerDocument mode (default: 5000). */
|
|
137
127
|
debounceMs?: number;
|
|
138
|
-
/** Filter annotations by agent fields. Matches annotations where `agent.agentFields` array contains any of the provided values. */
|
|
139
|
-
agentFields?: string[];
|
|
140
128
|
}
|
|
141
129
|
export interface SubscribeCommentAnnotationRequest {
|
|
142
130
|
annotationId: string;
|
|
@@ -7,7 +7,6 @@ import { CustomAnnotationDropdownItem } from "./custom-chip-dropdown.data.model"
|
|
|
7
7
|
import { CustomCategory, CustomPriority, CustomStatus } from "./custom-filter.data.model";
|
|
8
8
|
import { Location } from "./location.model";
|
|
9
9
|
import { PageInfo } from "./page-info.model";
|
|
10
|
-
import { SuggestionData } from "./suggestion.data.model";
|
|
11
10
|
import { TargetElement } from "./target-element.data.model";
|
|
12
11
|
import { TargetTextRange } from "./target-text-range.data.model";
|
|
13
12
|
import { User } from "./user.data.model";
|
|
@@ -17,34 +16,6 @@ export interface CommentAnnotationVisibilityConfig {
|
|
|
17
16
|
organizationId?: string;
|
|
18
17
|
userIds?: string[];
|
|
19
18
|
}
|
|
20
|
-
/**
|
|
21
|
-
* Structured result produced by an AI agent for a comment annotation.
|
|
22
|
-
* Read-only from the SDK's perspective — written upstream by the agent.
|
|
23
|
-
*/
|
|
24
|
-
export interface AgentResult {
|
|
25
|
-
/** Short, bold headline rendered at the top of the agent suggestion card. */
|
|
26
|
-
title?: string;
|
|
27
|
-
}
|
|
28
|
-
/**
|
|
29
|
-
* Identity + output of the AI agent that authored a comment annotation.
|
|
30
|
-
* Present on annotations created by an agent. The agent-suggestion UI renders
|
|
31
|
-
* iff `agent` is present AND `type === 'suggestion'` (and the viewer is admin).
|
|
32
|
-
*
|
|
33
|
-
* `agentFields` mirrors the Firestore query field used by
|
|
34
|
-
* `CommentRequestQuery.agentFields` (see comment-actions.data.model.ts).
|
|
35
|
-
*/
|
|
36
|
-
export interface AgentData {
|
|
37
|
-
/** Canonical display name of the agent (card header). */
|
|
38
|
-
agentName?: string;
|
|
39
|
-
/** Legacy display name of the agent (card header); superseded by `agentName`. */
|
|
40
|
-
name?: string;
|
|
41
|
-
/** Avatar URL for the agent (card header); falls back to a default icon. */
|
|
42
|
-
avatar?: string;
|
|
43
|
-
/** Structured agent output (title, …). */
|
|
44
|
-
result?: AgentResult;
|
|
45
|
-
/** Queryable agent attributes. */
|
|
46
|
-
agentFields?: string[];
|
|
47
|
-
}
|
|
48
19
|
export declare class CommentAnnotation {
|
|
49
20
|
/**
|
|
50
21
|
* Unique identifier for the comment pin annotation.
|
|
@@ -179,12 +150,6 @@ export declare class CommentAnnotation {
|
|
|
179
150
|
location?: Location | null;
|
|
180
151
|
type?: string;
|
|
181
152
|
commentType?: string;
|
|
182
|
-
/**
|
|
183
|
-
* Origin of the annotation. `'agent'` indicates the annotation was authored by
|
|
184
|
-
* an AI agent (drives the blue pin marker, agent identity header and blue text
|
|
185
|
-
* highlight). Absent / any other value indicates a regular user comment.
|
|
186
|
-
*/
|
|
187
|
-
sourceType?: string;
|
|
188
153
|
metadata?: CommentMetadata;
|
|
189
154
|
/**
|
|
190
155
|
* Selected text range of comment annotation
|
|
@@ -196,10 +161,6 @@ export declare class CommentAnnotation {
|
|
|
196
161
|
selectAllContent?: boolean;
|
|
197
162
|
approved?: boolean;
|
|
198
163
|
status: CustomStatus;
|
|
199
|
-
/**
|
|
200
|
-
* User id of the user who updated the status of the comment annotation
|
|
201
|
-
*/
|
|
202
|
-
statusUpdatedByUserId?: string | null;
|
|
203
164
|
/**
|
|
204
165
|
* To maintain index of current annotation in available list of annotations
|
|
205
166
|
* It will start from 1, so no need to add 1 in that.
|
|
@@ -238,30 +199,6 @@ export declare class CommentAnnotation {
|
|
|
238
199
|
viewedByUserIds?: string[];
|
|
239
200
|
viewedBy?: User[];
|
|
240
201
|
unread?: boolean;
|
|
241
|
-
/**
|
|
242
|
-
* SDK-managed suggestion data. Present iff type === 'suggestion'.
|
|
243
|
-
* Customer code must not write to this directly — use the SuggestionElement API.
|
|
244
|
-
*
|
|
245
|
-
* See docs/suggestions-api-contract.md for the full storage model.
|
|
246
|
-
*/
|
|
247
|
-
suggestion?: SuggestionData;
|
|
248
|
-
/**
|
|
249
|
-
* AI agent identity + output. Present on agent-authored annotations.
|
|
250
|
-
* Read-only from the SDK; written upstream by the agent.
|
|
251
|
-
* See specs/agent-suggestion-comment-ui/spec.md (INV-001).
|
|
252
|
-
*/
|
|
253
|
-
agent?: AgentData;
|
|
254
|
-
/**
|
|
255
|
-
* Server-derived set of all user IDs involved in this annotation
|
|
256
|
-
* (subscribed + unsubscribed participants). Written upstream; read-only
|
|
257
|
-
* from the SDK.
|
|
258
|
-
*/
|
|
259
|
-
involvedUserIds?: string[];
|
|
260
|
-
/**
|
|
261
|
-
* Server-derived set of user IDs @mentioned across this annotation's
|
|
262
|
-
* comments. Written upstream; read-only from the SDK.
|
|
263
|
-
*/
|
|
264
|
-
mentionedUserIds?: string[];
|
|
265
202
|
}
|
|
266
203
|
export declare class GhostComment {
|
|
267
204
|
targetElement?: TargetElement | null;
|
|
@@ -67,7 +67,6 @@ export type CommentEventTypesMap = {
|
|
|
67
67
|
[CommentEventTypes.UPDATE_ACCESS]: UpdateAccessEvent;
|
|
68
68
|
[CommentEventTypes.RESOLVE_COMMENT]: ResolveCommentEvent;
|
|
69
69
|
[CommentEventTypes.ADD_COMMENT]: AddCommentEvent;
|
|
70
|
-
[CommentEventTypes.ADD_COMMENT_DRAFT]: AddCommentDraftEvent;
|
|
71
70
|
[CommentEventTypes.UPDATE_COMMENT]: UpdateCommentEvent;
|
|
72
71
|
[CommentEventTypes.DELETE_COMMENT]: DeleteCommentEvent;
|
|
73
72
|
[CommentEventTypes.ADD_ATTACHMENT]: AddAttachmentEvent;
|
|
@@ -93,8 +92,6 @@ export type CommentEventTypesMap = {
|
|
|
93
92
|
[CommentEventTypes.COMMENT_SAVED]: CommentSavedEvent;
|
|
94
93
|
[CommentEventTypes.COMMENT_SAVE_TRIGGERED]: CommentSaveTriggeredEvent;
|
|
95
94
|
[CommentEventTypes.VISIBILITY_OPTION_CLICKED]: VisibilityOptionClickedEvent;
|
|
96
|
-
[CommentEventTypes.SUGGESTION_ACCEPTED]: SuggestionAcceptEvent;
|
|
97
|
-
[CommentEventTypes.SUGGESTION_REJECTED]: SuggestionRejectEvent;
|
|
98
95
|
};
|
|
99
96
|
export interface AddAttachmentEvent {
|
|
100
97
|
annotationId: string;
|
|
@@ -153,20 +150,6 @@ export interface DeleteCommentAnnotationEvent {
|
|
|
153
150
|
commentAnnotation: CommentAnnotation;
|
|
154
151
|
metadata: VeltEventMetadata;
|
|
155
152
|
}
|
|
156
|
-
export interface SuggestionAcceptEvent {
|
|
157
|
-
annotationId: string;
|
|
158
|
-
commentAnnotation: CommentAnnotation;
|
|
159
|
-
metadata: VeltEventMetadata;
|
|
160
|
-
actionUser: User;
|
|
161
|
-
}
|
|
162
|
-
export interface SuggestionRejectEvent {
|
|
163
|
-
annotationId: string;
|
|
164
|
-
commentAnnotation: CommentAnnotation;
|
|
165
|
-
metadata: VeltEventMetadata;
|
|
166
|
-
actionUser: User;
|
|
167
|
-
/** Optional human-readable reason supplied at reject time. */
|
|
168
|
-
rejectReason?: string | null;
|
|
169
|
-
}
|
|
170
153
|
export interface GetCommentAnnotationsResponse {
|
|
171
154
|
data: Record<string, CommentAnnotation[]> | null;
|
|
172
155
|
}
|
|
@@ -203,12 +186,6 @@ export interface AddCommentEvent {
|
|
|
203
186
|
comment: Comment;
|
|
204
187
|
metadata: VeltEventMetadata;
|
|
205
188
|
}
|
|
206
|
-
export interface AddCommentDraftEvent {
|
|
207
|
-
annotationId: string;
|
|
208
|
-
commentAnnotation: CommentAnnotation;
|
|
209
|
-
comment: Comment;
|
|
210
|
-
metadata: VeltEventMetadata;
|
|
211
|
-
}
|
|
212
189
|
export interface CommentSavedEvent {
|
|
213
190
|
annotationId: string;
|
|
214
191
|
commentAnnotation: CommentAnnotation;
|
|
@@ -216,7 +193,6 @@ export interface CommentSavedEvent {
|
|
|
216
193
|
}
|
|
217
194
|
export interface CommentSaveTriggeredEvent {
|
|
218
195
|
annotationId: string;
|
|
219
|
-
commentAnnotation: CommentAnnotation;
|
|
220
196
|
metadata: VeltEventMetadata;
|
|
221
197
|
}
|
|
222
198
|
export interface UpdateCommentEvent {
|
|
@@ -4,9 +4,9 @@ import { BaseMetadata } from "./base-metadata.data.model";
|
|
|
4
4
|
import { CommentAnnotation } from "./comment-annotation.data.model";
|
|
5
5
|
import { ResolverConfig, ResolverResponse } from "./resolver.data.model";
|
|
6
6
|
export interface CommentAnnotationDataProvider {
|
|
7
|
-
get
|
|
8
|
-
save
|
|
9
|
-
delete
|
|
7
|
+
get: (request: GetCommentResolverRequest) => Promise<ResolverResponse<Record<string, PartialCommentAnnotation>>>;
|
|
8
|
+
save: (request: SaveCommentResolverRequest) => Promise<ResolverResponse<undefined>>;
|
|
9
|
+
delete: (request: DeleteCommentResolverRequest) => Promise<ResolverResponse<undefined>>;
|
|
10
10
|
config?: ResolverConfig;
|
|
11
11
|
}
|
|
12
12
|
export interface GetCommentResolverRequest {
|
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
import { CommentAccessMode } from "../../utils/enums";
|
|
2
1
|
import { CommentAnnotation } from "./comment-annotation.data.model";
|
|
3
2
|
import { UnreadCommentsMap } from "./comment-utils.data.model";
|
|
4
3
|
import { CustomFilters } from "./custom-filter.data.model";
|
|
@@ -65,7 +64,6 @@ export declare class CommentSidebarFilters {
|
|
|
65
64
|
priority?: string[];
|
|
66
65
|
status?: string[];
|
|
67
66
|
category?: string[];
|
|
68
|
-
accessModes?: CommentAccessMode[];
|
|
69
67
|
version?: {
|
|
70
68
|
id: string;
|
|
71
69
|
name?: string;
|
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
import { Attachment } from "./attachment.model";
|
|
2
2
|
import { AutocompleteGroupReplaceData, AutocompleteReplaceData, AutocompleteUserContactReplaceData } from "./autocomplete.data.model";
|
|
3
|
-
import type { AgentData } from "./comment-annotation.data.model";
|
|
4
3
|
import { ReactionAnnotation } from "./reaction-annotation.data.model";
|
|
5
4
|
import { RecordedData } from "./recorder.model";
|
|
6
5
|
import { User } from "./user.data.model";
|
|
@@ -89,21 +88,4 @@ export declare class Comment {
|
|
|
89
88
|
*/
|
|
90
89
|
isEdited?: boolean;
|
|
91
90
|
reactionAnnotations?: ReactionAnnotation[];
|
|
92
|
-
/**
|
|
93
|
-
* Origin of this individual comment. `'agent'` indicates the comment was
|
|
94
|
-
* authored by an AI agent (agent replies / multi-agent threads). Stamped
|
|
95
|
-
* server-side; mirrors `CommentAnnotation.sourceType` at the comment level.
|
|
96
|
-
*/
|
|
97
|
-
sourceType?: string;
|
|
98
|
-
/**
|
|
99
|
-
* AI agent identity + output for an agent-authored comment. Present on
|
|
100
|
-
* per-comment agent replies. Read-only from the SDK; written upstream by the
|
|
101
|
-
* agent. Mirrors `CommentAnnotation.agent` at the comment level.
|
|
102
|
-
*/
|
|
103
|
-
agent?: AgentData;
|
|
104
|
-
/**
|
|
105
|
-
* Customer-supplied metadata bag persisted as-is. Only present when a caller
|
|
106
|
-
* provides it; not server-generated.
|
|
107
|
-
*/
|
|
108
|
-
metadata?: any;
|
|
109
91
|
}
|
|
@@ -51,7 +51,6 @@ export declare class Config {
|
|
|
51
51
|
advancedQueriesDisabled?: boolean;
|
|
52
52
|
/**
|
|
53
53
|
* The domain of the API proxy.
|
|
54
|
-
* @deprecated Use `proxyConfig.apiHost` instead.
|
|
55
54
|
*/
|
|
56
55
|
apiProxyDomain?: string;
|
|
57
56
|
/**
|
|
@@ -62,26 +61,6 @@ export declare class Config {
|
|
|
62
61
|
* Default: true
|
|
63
62
|
*/
|
|
64
63
|
globalStyles?: boolean;
|
|
65
|
-
/**
|
|
66
|
-
* Configuration for routing all traffic through reverse proxies.
|
|
67
|
-
*/
|
|
68
|
-
proxyConfig?: ProxyConfig;
|
|
69
|
-
}
|
|
70
|
-
export interface ProxyConfig {
|
|
71
|
-
/** Custom host for the Velt CDN (e.g., 'cdn-proxy.customer.com') */
|
|
72
|
-
cdnHost?: string;
|
|
73
|
-
/** Custom host for the Velt API (e.g., 'api-proxy.customer.com') */
|
|
74
|
-
apiHost?: string;
|
|
75
|
-
/** Custom host for Firestore (e.g., 'firestore-proxy.customer.com') */
|
|
76
|
-
v2DbHost?: string;
|
|
77
|
-
/** Custom host for Firebase RTDB (e.g., 'rtdb-proxy.customer.com'). Replaces the firebaseio.com domain in all RTDB URLs. */
|
|
78
|
-
v1DbHost?: string;
|
|
79
|
-
/** Custom host for Firebase Storage (e.g., 'storage-proxy.customer.com'). Replaces firebasestorage.googleapis.com. */
|
|
80
|
-
storageHost?: string;
|
|
81
|
-
/** Custom host for Firebase Auth (e.g., 'auth-proxy.customer.com'). Replaces identitytoolkit.googleapis.com and securetoken.googleapis.com. */
|
|
82
|
-
authHost?: string;
|
|
83
|
-
/** Force long-polling for Firestore and RTDB instead of WebSocket. Default: false (WebSocket). */
|
|
84
|
-
forceLongPolling?: boolean;
|
|
85
64
|
}
|
|
86
65
|
export interface ExtendedFirebaseOptions extends FirebaseOptions {
|
|
87
66
|
storeDbId: string;
|
|
@@ -97,9 +76,4 @@ export interface DisableLogsConfig {
|
|
|
97
76
|
}
|
|
98
77
|
export interface GetProjectConfigResponse {
|
|
99
78
|
isPrivateCommentsEnabled: boolean;
|
|
100
|
-
activityConfig?: ActivityConfig;
|
|
101
|
-
}
|
|
102
|
-
export interface ActivityConfig {
|
|
103
|
-
immutable: boolean;
|
|
104
|
-
isEnabled: boolean;
|
|
105
79
|
}
|
|
@@ -7,9 +7,6 @@ export type CoreEventTypesMap = {
|
|
|
7
7
|
[CoreEventTypes.COMMENT_RESOLVER]: CommentResolverEvent;
|
|
8
8
|
[CoreEventTypes.ATTACHMENT_RESOLVER]: AttachmentResolverEvent;
|
|
9
9
|
[CoreEventTypes.REACTION_RESOLVER]: ReactionResolverEvent;
|
|
10
|
-
[CoreEventTypes.RECORDER_RESOLVER]: RecorderResolverEvent;
|
|
11
|
-
[CoreEventTypes.NOTIFICATION_RESOLVER]: NotificationResolverEvent;
|
|
12
|
-
[CoreEventTypes.ACTIVITY_RESOLVER]: ActivityResolverEvent;
|
|
13
10
|
[CoreEventTypes.VELT_BUTTON_CLICK]: VeltButtonClickEvent;
|
|
14
11
|
[CoreEventTypes.USER_UPDATE]: UserUpdateEvent;
|
|
15
12
|
[CoreEventTypes.DOCUMENT_INIT]: DocumentInitEvent;
|
|
@@ -150,75 +147,6 @@ export type ReactionResolverEventType = {
|
|
|
150
147
|
REACTION_DELETE_RESULT: 'reactionDeleteResult';
|
|
151
148
|
REACTION_DELETE_ERROR: 'reactionDeleteError';
|
|
152
149
|
};
|
|
153
|
-
export declare enum RecorderResolverSource {
|
|
154
|
-
RESOLVE_RECORDER_ANNOTATIONS = "resolveRecorderAnnotations",
|
|
155
|
-
SAVE_RECORDER_ANNOTATION = "saveRecorderAnnotation",
|
|
156
|
-
DELETE_RECORDER_ANNOTATION = "deleteRecorderAnnotation",
|
|
157
|
-
FORMAT_RESPONSE = "formatResponse",
|
|
158
|
-
INIT_DOCUMENTS = "initDocuments",
|
|
159
|
-
SET_DATA = "setData",
|
|
160
|
-
UPDATE_DATA = "updateData",
|
|
161
|
-
DELETE_DATA = "deleteData"
|
|
162
|
-
}
|
|
163
|
-
export declare enum RecorderResolverModuleName {
|
|
164
|
-
GET_RECORDER_ANNOTATIONS = "getRecorderAnnotations"
|
|
165
|
-
}
|
|
166
|
-
export type RecorderResolverEvent = BaseResolverEvent<RecorderResolverEventType, RecorderResolverSource, RecorderResolverModuleName>;
|
|
167
|
-
export type RecorderResolverEventType = {
|
|
168
|
-
RECORDER_RESOLUTION_REQUEST_FORMED: 'recorderResolutionRequestFormed';
|
|
169
|
-
RECORDER_RESOLUTION_REQUEST_TRIGGERED: 'recorderResolutionRequestTriggered';
|
|
170
|
-
RECORDER_RESOLUTION_RESULT: 'recorderResolutionResult';
|
|
171
|
-
RECORDER_RESOLUTION_ERROR: 'recorderResolutionError';
|
|
172
|
-
RECORDER_RESOLUTION_RESULT_FROM_CACHE: 'recorderResolutionResultFromCache';
|
|
173
|
-
RECORDER_SAVE_REQUEST_FORMED: 'recorderSaveRequestFormed';
|
|
174
|
-
RECORDER_SAVE_REQUEST_TRIGGERED: 'recorderSaveRequestTriggered';
|
|
175
|
-
RECORDER_SAVE_RESULT: 'recorderSaveResult';
|
|
176
|
-
RECORDER_SAVE_ERROR: 'recorderSaveError';
|
|
177
|
-
RECORDER_DELETE_REQUEST_FORMED: 'recorderDeleteRequestFormed';
|
|
178
|
-
RECORDER_DELETE_REQUEST_TRIGGERED: 'recorderDeleteRequestTriggered';
|
|
179
|
-
RECORDER_DELETE_RESULT: 'recorderDeleteResult';
|
|
180
|
-
RECORDER_DELETE_ERROR: 'recorderDeleteError';
|
|
181
|
-
};
|
|
182
|
-
export declare enum NotificationResolverSource {
|
|
183
|
-
RESOLVE_NOTIFICATIONS = "resolveNotifications",
|
|
184
|
-
DELETE_NOTIFICATION = "deleteNotification",
|
|
185
|
-
DELETE_DATA = "deleteData",
|
|
186
|
-
FORMAT_RESPONSE = "formatResponse"
|
|
187
|
-
}
|
|
188
|
-
export declare enum NotificationResolverModuleName {
|
|
189
|
-
GET_NOTIFICATIONS = "getNotifications"
|
|
190
|
-
}
|
|
191
|
-
export type NotificationResolverEventType = {
|
|
192
|
-
NOTIFICATION_RESOLUTION_REQUEST_FORMED: 'notificationResolutionRequestFormed';
|
|
193
|
-
NOTIFICATION_RESOLUTION_REQUEST_TRIGGERED: 'notificationResolutionRequestTriggered';
|
|
194
|
-
NOTIFICATION_RESOLUTION_RESULT: 'notificationResolutionResult';
|
|
195
|
-
NOTIFICATION_RESOLUTION_ERROR: 'notificationResolutionError';
|
|
196
|
-
NOTIFICATION_DELETE_REQUEST_FORMED: 'notificationDeleteRequestFormed';
|
|
197
|
-
NOTIFICATION_DELETE_REQUEST_TRIGGERED: 'notificationDeleteRequestTriggered';
|
|
198
|
-
NOTIFICATION_DELETE_RESULT: 'notificationDeleteResult';
|
|
199
|
-
NOTIFICATION_DELETE_ERROR: 'notificationDeleteError';
|
|
200
|
-
};
|
|
201
|
-
export type NotificationResolverEvent = BaseResolverEvent<NotificationResolverEventType, NotificationResolverSource, NotificationResolverModuleName>;
|
|
202
|
-
export declare enum ActivityResolverSource {
|
|
203
|
-
RESOLVE_ACTIVITIES = "resolveActivities",
|
|
204
|
-
SAVE_ACTIVITY = "saveActivity",
|
|
205
|
-
FORMAT_RESPONSE = "formatResponse"
|
|
206
|
-
}
|
|
207
|
-
export declare enum ActivityResolverModuleName {
|
|
208
|
-
GET_ACTIVITIES = "getActivities"
|
|
209
|
-
}
|
|
210
|
-
export type ActivityResolverEventType = {
|
|
211
|
-
ACTIVITY_RESOLUTION_REQUEST_FORMED: 'activityResolutionRequestFormed';
|
|
212
|
-
ACTIVITY_RESOLUTION_REQUEST_TRIGGERED: 'activityResolutionRequestTriggered';
|
|
213
|
-
ACTIVITY_RESOLUTION_RESULT: 'activityResolutionResult';
|
|
214
|
-
ACTIVITY_RESOLUTION_ERROR: 'activityResolutionError';
|
|
215
|
-
ACTIVITY_RESOLUTION_RESULT_FROM_CACHE: 'activityResolutionResultFromCache';
|
|
216
|
-
ACTIVITY_SAVE_REQUEST_FORMED: 'activitySaveRequestFormed';
|
|
217
|
-
ACTIVITY_SAVE_REQUEST_TRIGGERED: 'activitySaveRequestTriggered';
|
|
218
|
-
ACTIVITY_SAVE_RESULT: 'activitySaveResult';
|
|
219
|
-
ACTIVITY_SAVE_ERROR: 'activitySaveError';
|
|
220
|
-
};
|
|
221
|
-
export type ActivityResolverEvent = BaseResolverEvent<ActivityResolverEventType, ActivityResolverSource, ActivityResolverModuleName>;
|
|
222
150
|
export type ErrorEvent = {
|
|
223
151
|
event?: string;
|
|
224
152
|
sourceMethod?: string;
|
|
@@ -58,54 +58,3 @@ export interface CrdtDeleteVersionQuery {
|
|
|
58
58
|
id: string;
|
|
59
59
|
versionId: string;
|
|
60
60
|
}
|
|
61
|
-
export interface CrdtPushMessageQuery {
|
|
62
|
-
id: string;
|
|
63
|
-
data: number[];
|
|
64
|
-
yjsClientId: number;
|
|
65
|
-
messageType?: 'sync' | 'awareness';
|
|
66
|
-
/** User-facing value for event emission only (not stored in database) */
|
|
67
|
-
eventData?: unknown;
|
|
68
|
-
/** Yjs data type: 'text' | 'map' | 'array' | 'xml' | 'xmltext' */
|
|
69
|
-
type?: string;
|
|
70
|
-
/** Content key used in Y.Doc shared types */
|
|
71
|
-
contentKey?: string;
|
|
72
|
-
/** Editor/library source: 'tiptap', 'plate', 'codemirror', etc. */
|
|
73
|
-
source?: string;
|
|
74
|
-
}
|
|
75
|
-
export interface CrdtOnMessageQuery {
|
|
76
|
-
id: string;
|
|
77
|
-
callback: (message: CrdtMessageData) => void;
|
|
78
|
-
afterTs?: number;
|
|
79
|
-
}
|
|
80
|
-
export interface CrdtMessageData {
|
|
81
|
-
data: number[];
|
|
82
|
-
yjsClientId: number;
|
|
83
|
-
timestamp: number;
|
|
84
|
-
}
|
|
85
|
-
export interface CrdtSnapshotData {
|
|
86
|
-
state?: Uint8Array | number[];
|
|
87
|
-
vector?: Uint8Array | number[];
|
|
88
|
-
timestamp?: number;
|
|
89
|
-
}
|
|
90
|
-
export interface CrdtGetSnapshotQuery {
|
|
91
|
-
id: string;
|
|
92
|
-
}
|
|
93
|
-
export interface CrdtSaveSnapshotQuery {
|
|
94
|
-
id: string;
|
|
95
|
-
state: Uint8Array | number[];
|
|
96
|
-
vector: Uint8Array | number[];
|
|
97
|
-
/** Yjs data type: 'text' | 'map' | 'array' | 'xml' | 'xmltext' */
|
|
98
|
-
type?: string;
|
|
99
|
-
/** Content key used in Y.Doc shared types */
|
|
100
|
-
contentKey?: string;
|
|
101
|
-
/** Editor/library source: 'tiptap', 'plate', 'codemirror', etc. */
|
|
102
|
-
source?: string;
|
|
103
|
-
}
|
|
104
|
-
export interface CrdtGetMessagesQuery {
|
|
105
|
-
id: string;
|
|
106
|
-
afterTs?: number;
|
|
107
|
-
}
|
|
108
|
-
export interface CrdtPruneMessagesQuery {
|
|
109
|
-
id: string;
|
|
110
|
-
beforeTs: number;
|
|
111
|
-
}
|
|
@@ -16,8 +16,6 @@ export interface SetDocumentsRequestOptions {
|
|
|
16
16
|
locationId?: string;
|
|
17
17
|
rootDocumentId?: string;
|
|
18
18
|
context?: SetDocumentsContext;
|
|
19
|
-
debounceTime?: number;
|
|
20
|
-
optimisticPermissions?: boolean;
|
|
21
19
|
}
|
|
22
20
|
export interface UpdateDocumentsRequest<T = unknown> {
|
|
23
21
|
organizationId?: string;
|
|
@@ -5,18 +5,12 @@ export interface AccessRequestEvent {
|
|
|
5
5
|
editor?: User;
|
|
6
6
|
timestamp?: number;
|
|
7
7
|
status?: string;
|
|
8
|
-
totalUsers?: number;
|
|
9
|
-
presenceSnippylyUserIds?: string[];
|
|
10
|
-
presenceClientUserIds?: string[];
|
|
11
8
|
}
|
|
12
9
|
export interface SEMEvent {
|
|
13
10
|
viewer?: User;
|
|
14
11
|
editor?: User;
|
|
15
12
|
timestamp?: number;
|
|
16
13
|
role?: string;
|
|
17
|
-
totalUsers?: number;
|
|
18
|
-
presenceSnippylyUserIds?: string[];
|
|
19
|
-
presenceClientUserIds?: string[];
|
|
20
14
|
}
|
|
21
15
|
export type LiveStateEventTypesMap = {
|
|
22
16
|
[LiveStateSyncEventTypes.ACCESS_REQUESTED]: AccessRequestEvent;
|
|
@@ -137,10 +137,6 @@ export declare class Notification {
|
|
|
137
137
|
* Is comment text available
|
|
138
138
|
*/
|
|
139
139
|
isCommentResolverUsed?: boolean;
|
|
140
|
-
/**
|
|
141
|
-
* Is notification resolver used
|
|
142
|
-
*/
|
|
143
|
-
isNotificationResolverUsed?: boolean;
|
|
144
140
|
/**
|
|
145
141
|
* Display body message template
|
|
146
142
|
*/
|
|
@@ -257,23 +253,3 @@ export interface NotificationsDocConfig {
|
|
|
257
253
|
export interface GetNotificationsDataQuery {
|
|
258
254
|
type?: 'all' | 'forYou' | 'documents';
|
|
259
255
|
}
|
|
260
|
-
/**
|
|
261
|
-
* Configuration for the opt-in cross-organization "For You" notifications feature.
|
|
262
|
-
*
|
|
263
|
-
* When enabled, the SDK merges notifications from other organizations the user
|
|
264
|
-
* belongs to (resolved from the global `userNotificationIndex`) into the existing
|
|
265
|
-
* "For You" feed. All fields are optional; sensible defaults are applied by
|
|
266
|
-
* `NotificationService.setCrossOrganizationConfig`.
|
|
267
|
-
*
|
|
268
|
-
* @see specs/notification-api-scope/spec.md
|
|
269
|
-
*/
|
|
270
|
-
export interface CrossOrganizationConfig {
|
|
271
|
-
/** Whether cross-organization notifications are active. Defaults to `true` on enable. */
|
|
272
|
-
enabled?: boolean;
|
|
273
|
-
/** Allowlist of organization IDs to include. When omitted, all indexed orgs are eligible. */
|
|
274
|
-
organizationIds?: string[];
|
|
275
|
-
/** Organization IDs to exclude. The current organization is always excluded. */
|
|
276
|
-
excludeOrganizationIds?: string[];
|
|
277
|
-
/** Feeds the merge applies to. Only `'forYou'` is supported; `'all'` is ignored with a warning. */
|
|
278
|
-
feeds?: ('forYou' | 'all')[];
|
|
279
|
-
}
|
|
@@ -47,13 +47,4 @@ export declare class PageInfo {
|
|
|
47
47
|
*/
|
|
48
48
|
screenWidth?: number;
|
|
49
49
|
deviceInfo?: IDeviceInfo;
|
|
50
|
-
/**
|
|
51
|
-
* @param applyClientOverride when true (default), merges the CURRENT document's client page
|
|
52
|
-
* info override at construction time — covers the bare `new PageInfo()` sites
|
|
53
|
-
* (cursor / presence / selection). No-op when the client hasn't provided any, so the
|
|
54
|
-
* default empty-page-info behavior is unchanged. `getPageInfo(documentId)` passes
|
|
55
|
-
* `false` so it can apply a specific document's override itself, without the current
|
|
56
|
-
* document's fields leaking onto a different document's page info.
|
|
57
|
-
*/
|
|
58
|
-
constructor(applyClientOverride?: boolean);
|
|
59
50
|
}
|
|
@@ -83,9 +83,4 @@ export declare class PresenceUser {
|
|
|
83
83
|
initial?: string;
|
|
84
84
|
isTabAway?: boolean;
|
|
85
85
|
isUserIdle?: boolean;
|
|
86
|
-
/**
|
|
87
|
-
* Whether this custom user is local-only (not persisted to DB).
|
|
88
|
-
* Only applicable to users added via addUser API.
|
|
89
|
-
*/
|
|
90
|
-
localOnly?: boolean;
|
|
91
86
|
}
|