@veltdev/types 4.5.0-beta.4 → 4.5.0-beta.40

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.
Files changed (29) hide show
  1. package/app/client/snippyly.model.d.ts +44 -6
  2. package/app/models/data/button.data.model.d.ts +2 -0
  3. package/app/models/data/comment-annotation.data.model.d.ts +7 -0
  4. package/app/models/data/comment-sidebar-config.model.d.ts +20 -0
  5. package/app/models/data/core-events.data.model.d.ts +9 -0
  6. package/app/models/data/custom-filter.data.model.d.ts +8 -0
  7. package/app/models/data/document-paths.data.model.d.ts +12 -0
  8. package/app/models/data/document.data.model.d.ts +2 -0
  9. package/app/models/data/location.model.d.ts +10 -0
  10. package/app/models/data/multi-thread.data.model.d.ts +2 -0
  11. package/app/models/data/notification.model.d.ts +20 -1
  12. package/app/models/data/notifications-events.data.model.d.ts +9 -0
  13. package/app/models/data/presence-actions.data.model.d.ts +5 -0
  14. package/app/models/data/presence-events.data.model.d.ts +8 -0
  15. package/app/models/data/recorder-annotation.data.model.d.ts +3 -0
  16. package/app/models/data/recorder-events.data.model.d.ts +10 -0
  17. package/app/models/data/recorder.model.d.ts +6 -8
  18. package/app/models/data/resolver.data.model.d.ts +6 -0
  19. package/app/models/data/user-resolver.data.model.d.ts +2 -0
  20. package/app/models/element/comment-element.model.d.ts +105 -10
  21. package/app/models/element/crdt-element.model.d.ts +116 -0
  22. package/app/models/element/notification-element.model.d.ts +81 -1
  23. package/app/models/element/presence-element.model.d.ts +15 -1
  24. package/app/models/element/recorder-element.model.d.ts +30 -0
  25. package/app/utils/constants.d.ts +2 -0
  26. package/app/utils/enums.d.ts +17 -1
  27. package/models.d.ts +2 -0
  28. package/package.json +1 -1
  29. package/types.d.ts +1 -0
@@ -24,6 +24,7 @@ import { FeatureType } from "../utils/enums";
24
24
  import { UserContact } from "../models/data/user-contact.data.model";
25
25
  import { DocumentMetadata } from "../models/data/document-metadata.model";
26
26
  import { ReactionElement } from "../models/element/reaction-element.model";
27
+ import { CrdtElement } from "../models/element/crdt-element.model";
27
28
  import { VeltEventMetadata } from "../models/data/event-metadata.data.model";
28
29
  import { CoreEventTypesMap } from "../models/data/core-events.data.model";
29
30
  import { Document, SetDocumentsRequestOptions, FetchDocumentsRequest, FetchFoldersRequest, UpdateDocumentsRequest, UpdateLocationsRequest } from "../models/data/document.data.model";
@@ -31,6 +32,7 @@ import { FetchDocumentsResponse, FetchFoldersResponse } from "../models/data/doc
31
32
  import { UserDataProvider } from "../models/data/user-resolver.data.model";
32
33
  import { VeltDataProvider } from "../models/data/provider.data.model";
33
34
  import { VeltResetButtonStateConfig } from "../models/data/button.data.model";
35
+ import { SetLocationsRequestOptions } from "../models/data/location.model";
34
36
 
35
37
  export declare class Snippyly {
36
38
  constructor();
@@ -48,17 +50,22 @@ export declare class Snippyly {
48
50
  * @param id unique document ID
49
51
  * @param documentMetadata Document Metadata
50
52
  */
51
- setDocument: (id: string, documentMetadata?: DocumentMetadata) => void;
53
+ setDocument: (id: string, documentMetadata?: DocumentMetadata) => Promise<void>;
52
54
  /**
53
55
  * Tell us the unique ID of the current document/resource on which you want to enable collaboration.
54
56
  * @param id unique document ID
55
57
  * @deprecated This method is deprecated. Use `setDocuments` method instead.
56
58
  */
57
- setDocumentId: (id: string) => void;
59
+ setDocumentId: (id: string) => Promise<void>;
58
60
  /**
59
61
  * To set multiple documents
60
62
  */
61
- setDocuments: (documents: Document[], options?: SetDocumentsRequestOptions) => void;
63
+ setDocuments: (documents: Document[], options?: SetDocumentsRequestOptions) => Promise<void>;
64
+ /**
65
+ * To set the root document
66
+ * @param document Document object
67
+ */
68
+ setRootDocument: (document: Document) => Promise<void>;
62
69
  /**
63
70
  * To unset the document id
64
71
  * @deprecated This method is deprecated. Use `unsetDocuments` method instead.
@@ -100,12 +107,39 @@ export declare class Snippyly {
100
107
  * @param params Location
101
108
  * @param appendLocation Append location to existing location
102
109
  */
103
- setLocation: (params: Location, appendLocation?: boolean) => void;
110
+ setLocation: (params: Location, appendLocation?: boolean) => Promise<void>;
111
+
112
+ /**
113
+ * To set the root location
114
+ * @param location Location object
115
+ */
116
+ setRootLocation: (location: Location) => Promise<void>;
117
+
118
+ /**
119
+ * To set multiple locations
120
+ * @param locations Location objects
121
+ * @param options Set locations options
122
+ */
123
+ setLocations: (locations: Location[], options?: SetLocationsRequestOptions) => Promise<void>;
124
+
104
125
  /**
105
126
  * To remove location from a User
106
127
  * @param location Location
107
128
  */
108
129
  removeLocation: (location?: Location) => void;
130
+
131
+ /**
132
+ * To remove multiple locations
133
+ * @param locations Location objects
134
+ */
135
+ removeLocations: (locations?: Location[]) => void;
136
+
137
+ /**
138
+ * To remove location ids
139
+ * @param locationIds Location ids
140
+ */
141
+ unsetLocationIds: (locationIds?: string[]) => void;
142
+
109
143
  /**
110
144
  * To exclude data of specific location ids
111
145
  * @param ids Location Ids
@@ -192,6 +226,10 @@ export declare class Snippyly {
192
226
  * Get the Area Object.
193
227
  */
194
228
  getReactionElement: () => ReactionElement;
229
+ /**
230
+ * Get the CRDT Element Object.
231
+ */
232
+ getCrdtElement: () => CrdtElement;
195
233
  /**
196
234
  * Get the metadata of the current resource.
197
235
  */
@@ -211,7 +249,7 @@ export declare class Snippyly {
211
249
  * @param location Location object
212
250
  * @deprecated This method is deprecated and will be removed in next release. Use `setLocation` method with `appendLocation: true` instead.
213
251
  */
214
- addLocation: (location: any) => any;
252
+ addLocation: (location: any) => Promise<any>;
215
253
  /**
216
254
  * To set the dark mode of Velt components.
217
255
  * @param value {boolean} true/false
@@ -315,5 +353,5 @@ export declare class Snippyly {
315
353
  /**
316
354
  * To reset the button toggle map.
317
355
  */
318
- resetVeltButtonState: (config?: VeltResetButtonStateConfig) => void;
356
+ resetVeltButtonState: (config?: VeltResetButtonStateConfig) => void;
319
357
  }
@@ -1,11 +1,13 @@
1
1
  import { CommentAnnotation } from "./comment-annotation.data.model";
2
2
  import { UnreadCommentsMap } from "./comment-utils.data.model";
3
3
  import { Comment } from "./comment.data.model";
4
+ import { CustomFilters } from "./custom-filter.data.model";
4
5
  import { VeltEventMetadata } from "./event-metadata.data.model";
5
6
  import { Notification } from "./notification.model";
6
7
  export interface VeltButtonClickEvent extends VeltButtonData {
7
8
  buttonContext?: VeltButtonContext;
8
9
  metadata?: VeltEventMetadata;
10
+ customFilters?: CustomFilters;
9
11
  }
10
12
  export interface VeltButtonContext {
11
13
  type?: string;
@@ -164,6 +164,10 @@ export declare class CommentAnnotation {
164
164
  * Custom context data provided by the user
165
165
  */
166
166
  context?: any;
167
+ /**
168
+ * Context id generated from context data
169
+ */
170
+ contextId?: string;
167
171
  iam: CommentIAMConfig;
168
172
  isPageAnnotation?: boolean;
169
173
  targetInlineCommentElementId?: string;
@@ -244,3 +248,6 @@ export declare class CommentAnnotationSubscribedGroups {
244
248
  export declare class UpdateContextConfig {
245
249
  merge?: boolean;
246
250
  }
251
+ export interface ContextOptions {
252
+ partialMatch?: boolean;
253
+ }
@@ -1,15 +1,25 @@
1
1
  import { CommentAnnotation } from "./comment-annotation.data.model";
2
2
  import { UnreadCommentsMap } from "./comment-utils.data.model";
3
+ import { CustomFilters } from "./custom-filter.data.model";
3
4
  import { Location } from "./location.model";
5
+ declare class FilterOption {
6
+ id: string;
7
+ name: string;
8
+ }
4
9
  declare class FilterTypeConfig {
5
10
  name?: string;
6
11
  enable?: boolean;
7
12
  multiSelection?: boolean;
8
13
  enableGrouping?: boolean;
9
14
  order?: string[];
15
+ placeholder?: string;
16
+ id?: string;
17
+ type?: 'custom' | 'system';
18
+ options?: FilterOption[];
10
19
  }
11
20
  export declare class CommentSidebarFilterConfig {
12
21
  location?: FilterTypeConfig;
22
+ document?: FilterTypeConfig;
13
23
  people?: FilterTypeConfig;
14
24
  assigned?: FilterTypeConfig;
15
25
  tagged?: FilterTypeConfig;
@@ -18,6 +28,7 @@ export declare class CommentSidebarFilterConfig {
18
28
  category?: FilterTypeConfig;
19
29
  commentType?: FilterTypeConfig;
20
30
  version?: FilterTypeConfig;
31
+ [key: string]: FilterTypeConfig | undefined;
21
32
  }
22
33
  export declare class CommentSidebarGroupConfig {
23
34
  enable?: boolean;
@@ -25,6 +36,10 @@ export declare class CommentSidebarGroupConfig {
25
36
  }
26
37
  export declare class CommentSidebarFilters {
27
38
  location?: Location[];
39
+ document?: {
40
+ id?: string;
41
+ documentName?: string;
42
+ }[];
28
43
  people?: {
29
44
  userId?: string;
30
45
  email?: string;
@@ -47,6 +62,10 @@ export declare class CommentSidebarFilters {
47
62
  id: string;
48
63
  name?: string;
49
64
  }[];
65
+ [key: string]: {
66
+ id?: string;
67
+ name?: string;
68
+ }[] | string[] | undefined;
50
69
  }
51
70
  export interface CommentSidebarCustomActionsState {
52
71
  [key: string]: boolean;
@@ -56,6 +75,7 @@ export interface CommentSidebarCustomActionEventData {
56
75
  data: CommentAnnotation[];
57
76
  unreadDataMap: UnreadCommentsMap;
58
77
  systemFilteredData: CommentAnnotation[];
78
+ customFilters: CustomFilters;
59
79
  }
60
80
  export declare class CommentSidebarData {
61
81
  groupId?: string;
@@ -6,10 +6,19 @@ export type CoreEventTypesMap = {
6
6
  [CoreEventTypes.USER_UPDATE]: UserUpdateEvent;
7
7
  [CoreEventTypes.DOCUMENT_INIT]: DocumentInitEvent;
8
8
  [CoreEventTypes.ERROR]: ErrorEvent;
9
+ [CoreEventTypes.INIT_UPDATE]: InitUpdateEvent;
9
10
  };
10
11
  export type UserUpdateEvent = User | null;
11
12
  export type DocumentInitEvent = boolean | undefined;
12
13
  export type ErrorEvent = {
14
+ error?: string;
13
15
  code: string;
14
16
  message?: string;
17
+ source?: string;
18
+ };
19
+ export type InitUpdateEvent = {
20
+ event: string;
21
+ methodName?: string;
22
+ source?: string;
23
+ payload?: any;
15
24
  };
@@ -13,6 +13,14 @@ export interface CustomStatus extends CustomFilter {
13
13
  svg?: string;
14
14
  iconUrl?: string;
15
15
  }
16
+ export interface CustomFilterOption {
17
+ id: string;
18
+ name: string;
19
+ selected: boolean;
20
+ }
21
+ export interface CustomFilters {
22
+ [key: string]: CustomFilterOption[];
23
+ }
16
24
  export interface CustomCategory extends CustomFilter {
17
25
  }
18
26
  export interface CustomCategoryMap {
@@ -3,10 +3,18 @@ export declare class DocumentPaths {
3
3
  * The document's unique identifier.
4
4
  */
5
5
  documentId?: string;
6
+ folderId?: string;
7
+ locationId?: string;
8
+ allDocuments?: boolean;
9
+ veltFolderId?: string;
6
10
  /**
7
11
  * Presence path.
8
12
  */
9
13
  presence?: string;
14
+ /**
15
+ * User config path.
16
+ */
17
+ userConfig?: string;
10
18
  docs?: string;
11
19
  /**
12
20
  * Cursor path.
@@ -64,6 +72,10 @@ export declare class DocumentPaths {
64
72
  * User login path.
65
73
  */
66
74
  logins?: string;
75
+ /**
76
+ * CRDT path.
77
+ */
78
+ crdt?: string;
67
79
  /**
68
80
  * Selection path.
69
81
  */
@@ -8,9 +8,11 @@ export interface SetDocumentsRequestOptions {
8
8
  folderId?: string;
9
9
  allDocuments?: boolean;
10
10
  locationId?: string;
11
+ rootDocumentId?: string;
11
12
  }
12
13
  export interface UpdateDocumentsRequest<T = unknown> {
13
14
  organizationId?: string;
15
+ folderId?: string;
14
16
  documents?: UpdateDocumentMetadata<T>[];
15
17
  }
16
18
  export interface UpdateDocumentMetadata<T = unknown> {
@@ -23,3 +23,13 @@ export declare class Version {
23
23
  */
24
24
  name: string;
25
25
  }
26
+ export declare class SetLocationsRequestOptions {
27
+ /**
28
+ * Root location.
29
+ */
30
+ rootLocationId?: string;
31
+ /**
32
+ * Merge locations.
33
+ */
34
+ appendLocation?: boolean;
35
+ }
@@ -55,6 +55,8 @@ export declare class MultiThreadCommentAnnotation {
55
55
  isDraft?: boolean;
56
56
  sourceId?: string;
57
57
  metadata?: MultiThreadMetadata;
58
+ isTemporary?: boolean;
59
+ context?: any;
58
60
  }
59
61
  export declare class MultiThreadMetadata extends BaseMetadata {
60
62
  [key: string]: any;
@@ -1,4 +1,4 @@
1
- import { AreaStatus, ArrowStatus, CommentStatus, HuddleActionTypes, NotificationSource, TagStatus, UserActionTypes } from "../../utils/enums";
1
+ import { AreaStatus, ArrowStatus, CommentStatus, HuddleActionTypes, NotificationSettingsItemType, NotificationSource, TagStatus, UserActionTypes } from "../../utils/enums";
2
2
  import { DocumentMetadata } from "./document-metadata.model";
3
3
  import { DocumentUser } from "./document-user.data.model";
4
4
  import { Location } from "./location.model";
@@ -230,3 +230,22 @@ export declare class NotificationTabConfig {
230
230
  all?: NotificationTabConfigItem;
231
231
  people?: NotificationTabConfigItem;
232
232
  }
233
+ export declare class NotificationInitialSettingsConfig {
234
+ name?: string;
235
+ id: string;
236
+ default?: string;
237
+ enable?: boolean;
238
+ values?: NotificationConfigValue[];
239
+ }
240
+ export declare class NotificationConfigValue {
241
+ name?: string;
242
+ id: NotificationSettingsItemType;
243
+ }
244
+ export declare class NotificationSettingsConfig {
245
+ [key: string]: NotificationSettingsItemType;
246
+ }
247
+ export interface NotificationsDocConfig {
248
+ inbox: 'ALL' | 'NONE' | 'MINE';
249
+ email: 'ALL' | 'NONE' | 'MINE';
250
+ [key: string]: string;
251
+ }
@@ -0,0 +1,9 @@
1
+ import { NotificationSettingsConfig } from "./notification.model";
2
+ import { NotificationEventTypes } from "../../utils/enums";
3
+ export interface SettingsUpdatedEvent {
4
+ settings: NotificationSettingsConfig;
5
+ isMutedAll: boolean;
6
+ }
7
+ export type NotificationEventTypesMap = {
8
+ [NotificationEventTypes.SETTINGS_UPDATED]: SettingsUpdatedEvent;
9
+ };
@@ -0,0 +1,5 @@
1
+ export interface PresenceRequestQuery {
2
+ documentId?: string;
3
+ organizationId?: string;
4
+ statuses?: string[];
5
+ }
@@ -3,6 +3,14 @@ import { PresenceUser } from "./presence-user.data.model";
3
3
  export interface PresenceMultipleUsersOnlineEvent {
4
4
  users: PresenceUser[];
5
5
  }
6
+ export interface PresenceUserStateChangeEvent {
7
+ user: PresenceUser;
8
+ state: string;
9
+ }
6
10
  export type PresenceEventTypesMap = {
7
11
  [PresenceEventTypes.MULTIPLE_USERS_ONLINE]: PresenceMultipleUsersOnlineEvent;
12
+ [PresenceEventTypes.USER_STATE_CHANGE]: PresenceUserStateChangeEvent;
8
13
  };
14
+ export interface GetPresenceDataResponse {
15
+ data: PresenceUser[] | null;
16
+ }
@@ -180,6 +180,8 @@ export interface RecorderBoundedScaleRange {
180
180
  centerY?: number;
181
181
  topLeftX?: number;
182
182
  topLeftY?: number;
183
+ topLeftXPixels?: number;
184
+ topLeftYPixels?: number;
183
185
  }
184
186
  export interface RecorderEditRange {
185
187
  trimRanges: RecorderBoundedTrimRange[];
@@ -213,6 +215,7 @@ declare class RecorderDataAsset {
213
215
  */
214
216
  fileFormat?: RecorderFileFormat;
215
217
  thumbnailUrl?: string;
218
+ transcription: RecorderDataTranscription;
216
219
  }
217
220
  export declare class RecorderData {
218
221
  recorderId: string;
@@ -8,6 +8,16 @@ export interface RecordingDeleteEvent extends RecorderData {
8
8
  }
9
9
  export interface RecordingEditDoneEvent extends RecorderData {
10
10
  }
11
+ export interface RecordingErrorEvent {
12
+ type: string;
13
+ message: string;
14
+ recorderId?: string;
15
+ }
16
+ export interface RecordingSaveInitiatedEvent {
17
+ annotationId?: string;
18
+ message: string;
19
+ type: 'edit' | 'record';
20
+ }
11
21
  export type RecorderEventTypesMap = {
12
22
  [RecorderEventTypes.TRANSCRIPTION_DONE]: TranscriptionDoneEvent;
13
23
  [RecorderEventTypes.RECORDING_DONE]: RecordingDoneEvent;
@@ -93,15 +93,13 @@ export declare class RecordedData {
93
93
  };
94
94
  getThumbnailTag: (url?: string) => string;
95
95
  }
96
+ export declare class RecorderQualityConstraintsOptions {
97
+ video?: MediaTrackConstraints;
98
+ audio?: MediaTrackConstraints;
99
+ }
96
100
  export declare class RecorderQualityConstraints {
97
- safari?: {
98
- video?: MediaTrackConstraints;
99
- audio?: MediaTrackConstraints;
100
- };
101
- other?: {
102
- video?: MediaTrackConstraints;
103
- audio?: MediaTrackConstraints;
104
- };
101
+ safari?: RecorderQualityConstraintsOptions;
102
+ other?: RecorderQualityConstraintsOptions;
105
103
  }
106
104
  export declare class RecorderEncodingOptions {
107
105
  safari?: MediaRecorderOptions;
@@ -3,6 +3,12 @@ export interface ResolverConfig {
3
3
  saveRetryConfig?: RetryConfig;
4
4
  deleteRetryConfig?: RetryConfig;
5
5
  getRetryConfig?: RetryConfig;
6
+ resolveUsersConfig?: ResolveUsersConfig;
7
+ }
8
+ export interface ResolveUsersConfig {
9
+ organization?: boolean;
10
+ folder?: boolean;
11
+ document?: boolean;
6
12
  }
7
13
  export interface ResolverResponse<T> {
8
14
  data?: T;
@@ -1,5 +1,7 @@
1
+ import { ResolverConfig } from "./resolver.data.model";
1
2
  import { User } from "./user.data.model";
2
3
  export interface UserDataProvider {
3
4
  get(userIds: string[]): Promise<Record<string, User>>;
5
+ config?: ResolverConfig;
4
6
  resolveTimeout?: number;
5
7
  }
@@ -126,7 +126,7 @@ export declare class CommentElement {
126
126
 
127
127
  /**
128
128
  * Subscribe to comment mode change.
129
- *
129
+ *
130
130
  * Returns Observable<boolean>.
131
131
  */
132
132
  onCommentModeChange: () => Observable<boolean>;
@@ -278,7 +278,7 @@ export declare class CommentElement {
278
278
 
279
279
  /**
280
280
  * @description Sets custom status filters
281
- * @param statuses
281
+ * @param statuses
282
282
  */
283
283
  setCustomStatus: (statuses: CustomStatus[]) => void;
284
284
 
@@ -326,7 +326,7 @@ export declare class CommentElement {
326
326
 
327
327
  /**
328
328
  * @description Sets the comment context provider
329
- * @param provider
329
+ * @param provider
330
330
  */
331
331
  public setContextProvider: (provider: (documentId: string, location?: any) => any) => void;
332
332
 
@@ -397,14 +397,14 @@ export declare class CommentElement {
397
397
 
398
398
  /**
399
399
  * To get documentId, location and set context data when comment is added.
400
- *
400
+ *
401
401
  * @legacy Use `AddCommentAnnotationEvent` instead
402
402
  */
403
403
  public onCommentAdd: () => Observable<CommentAddEventData>;
404
404
 
405
405
  /**
406
406
  * To get data when comment is updated.
407
- *
407
+ *
408
408
  * @legacy Use action specific events instead
409
409
  */
410
410
  public onCommentUpdate: () => Observable<CommentUpdateEventData>;
@@ -791,6 +791,28 @@ export declare class CommentElement {
791
791
  */
792
792
  public disableMultiThread: () => void;
793
793
 
794
+ /**
795
+ * To enable group multiple match
796
+ * @deprecated Use enableGroupMatchedComments instead
797
+ */
798
+ public enableGroupMultipleMatch: () => void;
799
+
800
+ /**
801
+ * To disable group multiple match
802
+ * @deprecated Use disableGroupMatchedComments instead
803
+ */
804
+ public disableGroupMultipleMatch: () => void;
805
+
806
+ /**
807
+ * To enable group matched comments
808
+ */
809
+ public enableGroupMatchedComments: () => void;
810
+
811
+ /**
812
+ * To disable group matched comments
813
+ */
814
+ public disableGroupMatchedComments: () => void;
815
+
794
816
  /**
795
817
  * To update context of comment annotation
796
818
  * @param annotationId Comment annotation id
@@ -1140,6 +1162,32 @@ export declare class CommentElement {
1140
1162
  * To disable draft mode
1141
1163
  */
1142
1164
  public disableDraftMode: () => void;
1165
+
1166
+ /**
1167
+ * To enable filter comments on dom
1168
+ */
1169
+ public enableFilterCommentsOnDom: () => void;
1170
+
1171
+ /**
1172
+ * To disable filter comments on dom
1173
+ */
1174
+ public disableFilterCommentsOnDom: () => void;
1175
+
1176
+ /**
1177
+ * To enable reply avatars
1178
+ */
1179
+ public enableReplyAvatars: () => void;
1180
+
1181
+ /**
1182
+ * To disable reply avatars
1183
+ */
1184
+ public disableReplyAvatars: () => void;
1185
+
1186
+ /**
1187
+ * To set max reply avatars
1188
+ */
1189
+ public setMaxReplyAvatars: (maxReplyAvatars: number) => void;
1190
+
1143
1191
  constructor();
1144
1192
  /**
1145
1193
  * Subscribe to comments on the current document.
@@ -1255,7 +1303,7 @@ export declare class CommentElement {
1255
1303
 
1256
1304
  /**
1257
1305
  * Subscribe to comment mode change.
1258
- *
1306
+ *
1259
1307
  * Returns Observable<boolean>.
1260
1308
  */
1261
1309
  private _onCommentModeChange;
@@ -1402,7 +1450,7 @@ export declare class CommentElement {
1402
1450
 
1403
1451
  /**
1404
1452
  * @description Sets custom status filters
1405
- * @param statuses
1453
+ * @param statuses
1406
1454
  */
1407
1455
  private _setCustomStatus;
1408
1456
 
@@ -1450,7 +1498,7 @@ export declare class CommentElement {
1450
1498
 
1451
1499
  /**
1452
1500
  * @description Sets the comment context provider
1453
- * @param provider
1501
+ * @param provider
1454
1502
  */
1455
1503
  private _setContextProvider;
1456
1504
 
@@ -1695,7 +1743,7 @@ export declare class CommentElement {
1695
1743
  */
1696
1744
  private _disableRecordingSummary;
1697
1745
 
1698
- /**
1746
+ /**
1699
1747
  * To enable recording transcription
1700
1748
  */
1701
1749
  private _enableRecordingTranscription;
@@ -1910,6 +1958,28 @@ export declare class CommentElement {
1910
1958
  */
1911
1959
  private _disableMultiThread;
1912
1960
 
1961
+ /**
1962
+ * To enable group multiple match
1963
+ * @deprecated Use enableGroupMatchedComments instead
1964
+ */
1965
+ private _enableGroupMultipleMatch;
1966
+
1967
+ /**
1968
+ * To disable group multiple match
1969
+ * @deprecated Use disableGroupMatchedComments instead
1970
+ */
1971
+ private _disableGroupMultipleMatch;
1972
+
1973
+ /**
1974
+ * To enable group matched comments
1975
+ */
1976
+ private _enableGroupMatchedComments;
1977
+
1978
+ /**
1979
+ * To disable group matched comments
1980
+ */
1981
+ private _disableGroupMatchedComments;
1982
+
1913
1983
  /**
1914
1984
  * To update context of comment annotation
1915
1985
  * @param annotationId Comment annotation id
@@ -1968,7 +2038,7 @@ export declare class CommentElement {
1968
2038
  */
1969
2039
  private _disableQueryParamsComments;
1970
2040
 
1971
- /**
2041
+ /**
1972
2042
  * To enable comment sidebar action button click
1973
2043
  */
1974
2044
  private _onCommentSidebarActionButtonClick;
@@ -2260,4 +2330,29 @@ export declare class CommentElement {
2260
2330
  * To disable draft mode
2261
2331
  */
2262
2332
  private _disableDraftMode;
2333
+
2334
+ /**
2335
+ * To enable filter comments on dom
2336
+ */
2337
+ private _enableFilterCommentsOnDom;
2338
+
2339
+ /**
2340
+ * To disable filter comments on dom
2341
+ */
2342
+ private _disableFilterCommentsOnDom;
2343
+
2344
+ /**
2345
+ * To enable reply avatars
2346
+ */
2347
+ private _enableReplyAvatars;
2348
+
2349
+ /**
2350
+ * To disable reply avatars
2351
+ */
2352
+ private _disableReplyAvatars;
2353
+
2354
+ /**
2355
+ * To set max reply avatars
2356
+ */
2357
+ private _setMaxReplyAvatars;
2263
2358
  }
@@ -0,0 +1,116 @@
1
+ // @ts-nocheck
2
+ export declare class CrdtElement {
3
+ /**
4
+ * Update data for a specific CRDT document
5
+ * @param id Document ID
6
+ * @param state State data as Uint8Array or number array
7
+ */
8
+ updateData: ({ id, state }: { id: string, state: Uint8Array | number[] }) => Promise<any>;
9
+
10
+ /**
11
+ * Subscribe to data changes for a specific CRDT document
12
+ * @param id Document ID
13
+ * @param callback Callback function to handle data changes
14
+ * @returns Unsubscribe function
15
+ */
16
+ onDataChange: ({ id, callback }: { id: string, callback: (data: any) => void }) => () => void;
17
+
18
+ /**
19
+ * Get data for a specific CRDT document
20
+ * @param id Document ID
21
+ */
22
+ getData: ({ id }: { id: string }) => Promise<any>;
23
+
24
+ /**
25
+ * Subscribe to state changes for a specific CRDT document
26
+ * @param id Document ID
27
+ * @param callback Callback function to handle state changes
28
+ * @returns Unsubscribe function
29
+ */
30
+ onStateChange: ({ id, callback }: { id: string, callback: (data: any) => void }) => () => void;
31
+
32
+ /**
33
+ * Update state for a specific CRDT document
34
+ * @param id Document ID
35
+ * @param state State data as Uint8Array or number array
36
+ */
37
+ updateState: ({ id, state }: { id: string, state: Uint8Array | number[] }) => Promise<any>;
38
+
39
+ /**
40
+ * Register a user for synchronization on a specific CRDT document
41
+ * @param id Document ID
42
+ */
43
+ registerSyncUser: ({ id }: { id: string }) => Promise<void>;
44
+
45
+ /**
46
+ * Set presence for a specific CRDT document
47
+ * @param id Document ID
48
+ */
49
+ setPresence: ({ id }: { id: string }) => Promise<void>;
50
+
51
+ /**
52
+ * Subscribe to presence changes for a specific CRDT document
53
+ * @param id Document ID
54
+ * @param callback Callback function to handle presence changes
55
+ * @returns Unsubscribe function
56
+ */
57
+ onPresenceChange: ({ id, callback }: { id: string, callback: (data: any) => void }) => () => void;
58
+
59
+ constructor();
60
+
61
+ /**
62
+ * Update data for a specific CRDT document
63
+ * @param id Document ID
64
+ * @param state State data as Uint8Array or number array
65
+ */
66
+ private _updateData;
67
+
68
+ /**
69
+ * Subscribe to data changes for a specific CRDT document
70
+ * @param id Document ID
71
+ * @param callback Callback function to handle data changes
72
+ * @returns Unsubscribe function
73
+ */
74
+ private _onDataChange;
75
+
76
+ /**
77
+ * Get data for a specific CRDT document
78
+ * @param id Document ID
79
+ */
80
+ private _getData;
81
+
82
+ /**
83
+ * Subscribe to state changes for a specific CRDT document
84
+ * @param id Document ID
85
+ * @param callback Callback function to handle state changes
86
+ * @returns Unsubscribe function
87
+ */
88
+ private _onStateChange;
89
+
90
+ /**
91
+ * Update state for a specific CRDT document
92
+ * @param id Document ID
93
+ * @param state State data as Uint8Array or number array
94
+ */
95
+ private _updateState;
96
+
97
+ /**
98
+ * Register a user for synchronization on a specific CRDT document
99
+ * @param id Document ID
100
+ */
101
+ private _registerSyncUser;
102
+
103
+ /**
104
+ * Set presence for a specific CRDT document
105
+ * @param id Document ID
106
+ */
107
+ private _setPresence;
108
+
109
+ /**
110
+ * Subscribe to presence changes for a specific CRDT document
111
+ * @param id Document ID
112
+ * @param callback Callback function to handle presence changes
113
+ * @returns Unsubscribe function
114
+ */
115
+ private _onPresenceChange;
116
+ }
@@ -1,6 +1,6 @@
1
1
  // @ts-nocheck
2
2
 
3
- import { Notification, NotificationTabConfig } from "../data/notification.model";
3
+ import { Notification, NotificationTabConfig, NotificationSettingsConfig, NotificationInitialSettingsConfig } from "../data/notification.model";
4
4
 
5
5
  export declare class NotificationElement {
6
6
  /**
@@ -58,6 +58,46 @@ export declare class NotificationElement {
58
58
  */
59
59
  markNotificationAsReadById: (notificationId: string) => void;
60
60
 
61
+ /**
62
+ * To set settings
63
+ */
64
+ setSettings: (config: NotificationSettingsConfig) => void;
65
+
66
+ /**
67
+ * To get settings
68
+ */
69
+ getSettings: () => Observable<NotificationSettingsConfig | null>;
70
+
71
+ /**
72
+ * To mute all notifications
73
+ */
74
+ muteAllNotifications: () => void;
75
+
76
+ /**
77
+ * To enable settings
78
+ */
79
+ enableSettings: () => void;
80
+
81
+ /**
82
+ * To disable settings
83
+ */
84
+ disableSettings: () => void;
85
+
86
+ /**
87
+ * To enable self notifications
88
+ */
89
+ enableSelfNotifications: () => void;
90
+
91
+ /**
92
+ * To disable self notifications
93
+ */
94
+ disableSelfNotifications: () => void;
95
+
96
+ /**
97
+ * To set settings initial config
98
+ */
99
+ setSettingsInitialConfig: (settings: NotificationInitialSettingsConfig[]) => void;
100
+
61
101
  constructor();
62
102
 
63
103
  /**
@@ -114,4 +154,44 @@ export declare class NotificationElement {
114
154
  * To mark notification as read by id
115
155
  */
116
156
  private _markNotificationAsReadById;
157
+
158
+ /**
159
+ * To set settings
160
+ */
161
+ private _setSettings;
162
+
163
+ /**
164
+ * To get settings
165
+ */
166
+ private _getSettings;
167
+
168
+ /**
169
+ * To mute all notifications
170
+ */
171
+ private _muteAllNotifications;
172
+
173
+ /**
174
+ * To enable settings
175
+ */
176
+ private _enableSettings;
177
+
178
+ /**
179
+ * To disable settings
180
+ */
181
+ private _disableSettings;
182
+
183
+ /**
184
+ * To enable self notifications
185
+ */
186
+ private _enableSelfNotifications;
187
+
188
+ /**
189
+ * To disable self notifications
190
+ */
191
+ private _disableSelfNotifications;
192
+
193
+ /**
194
+ * To set settings initial config
195
+ */
196
+ private _setSettingsInitialConfig;
117
197
  }
@@ -1,13 +1,16 @@
1
1
  // @ts-nocheck
2
2
  import { Observable } from "rxjs";
3
3
  import { PresenceUser } from "../data/presence-user.data.model";
4
- import { PresenceEventTypesMap } from "../data/presence-events.data.model";
4
+ import { GetPresenceDataResponse, PresenceEventTypesMap } from "../data/presence-events.data.model";
5
+ import { PresenceRequestQuery } from "../data/presence-actions.data.model";
6
+
5
7
  export declare class PresenceElement {
6
8
 
7
9
  /**
8
10
  * Subscribe to a list of all online users who are either active or inactive on the current document.
9
11
  *
10
12
  * Returns Observable<PresenceUser[] | null>.
13
+ * @deprecated This method is deprecated. Use `getData` method instead.
11
14
  */
12
15
  getOnlineUsersOnCurrentDocument: () => Observable<PresenceUser[] | null>;
13
16
 
@@ -38,6 +41,11 @@ export declare class PresenceElement {
38
41
  */
39
42
  disableSelf: () => void;
40
43
 
44
+ /**
45
+ * To get the presence data
46
+ */
47
+ getData: (query?: PresenceRequestQuery) => Observable<GetPresenceDataResponse>;
48
+
41
49
  /**
42
50
  * Subscribe to presence events
43
51
  */
@@ -47,6 +55,7 @@ export declare class PresenceElement {
47
55
  * Subscribe to a list of all online users who are either active or inactive on the current document.
48
56
  *
49
57
  * Returns Observable<PresenceUser[] | null>.
58
+ * @deprecated This method is deprecated. Use `getData` method instead.
50
59
  */
51
60
  private _getOnlineUsersOnCurrentDocument;
52
61
 
@@ -77,6 +86,11 @@ export declare class PresenceElement {
77
86
  */
78
87
  private _disableSelf;
79
88
 
89
+ /**
90
+ * To get the presence data
91
+ */
92
+ private _getData;
93
+
80
94
  /**
81
95
  * Subscribe to presence events
82
96
  */
@@ -84,6 +84,21 @@ export declare class RecorderElement {
84
84
  */
85
85
  setRecordingEncodingOptions: (options: RecorderEncodingOptions) => void;
86
86
 
87
+ /**
88
+ * To download latest video
89
+ */
90
+ downloadLatestVideo: (recorderId: string) => Promise<boolean>;
91
+
92
+ /**
93
+ * To enable recording mic
94
+ */
95
+ enableRecordingMic: () => void;
96
+
97
+ /**
98
+ * To disable recording mic
99
+ */
100
+ disableRecordingMic: () => void;
101
+
87
102
  constructor();
88
103
 
89
104
  private _initRecording;
@@ -163,4 +178,19 @@ export declare class RecorderElement {
163
178
  * To set recording encoding options
164
179
  */
165
180
  private _setRecordingEncodingOptions;
181
+
182
+ /**
183
+ * To download latest video
184
+ */
185
+ private _downloadLatestVideo;
186
+
187
+ /**
188
+ * To enable recording mic
189
+ */
190
+ private _enableRecordingMic;
191
+
192
+ /**
193
+ * To disable recording mic
194
+ */
195
+ private _disableRecordingMic;
166
196
  }
@@ -12,6 +12,7 @@ export declare class Constants {
12
12
  static FIREBASE_PARTIAL_PATH_ORGANIZATIONS: string;
13
13
  static FIREBASE_PARTIAL_PATH_FOLDERS: string;
14
14
  static FIREBASE_PARTIAL_PATH_DOCS: string;
15
+ static FIREBASE_PARTIAL_PATH_DOCUMENT_CONFIGURATIONS: string;
15
16
  static FIREBASE_PARTIAL_PATH_PRESENCE: string;
16
17
  static FIREBASE_PARTIAL_PATH_ORGANIZATION_USERS: string;
17
18
  static FIREBASE_PARTIAL_PATH_FOLDER_USERS: string;
@@ -44,6 +45,7 @@ export declare class Constants {
44
45
  static FIREBASE_PARTIAL_PATH_LIVE_STATE: string;
45
46
  static FIREBASE_PARTIAL_PATH_IAM: string;
46
47
  static FIREBASE_PARTIAL_PATH_REACTION: string;
48
+ static FIREBASE_PARTIAL_PATH_CRDT: string;
47
49
  static FIREBASE_PARTIAL_PATH_VIEWS: string;
48
50
  static FIREBASE_PARTIAL_PATH_COMMENT_VIEWS: string;
49
51
  static FIREBASE_PARTIAL_PATH_NOTIFICATION_VIEWS: string;
@@ -60,10 +60,13 @@ export declare const RecorderEventTypes: {
60
60
  readonly RECORDING_DONE: "recordingDone";
61
61
  readonly RECORDING_EDIT_DONE: "recordingEditDone";
62
62
  readonly DELETE_RECORDING: "deleteRecording";
63
+ readonly ERROR: "error";
64
+ readonly RECORDING_SAVE_INITIATED: "recordingSaveInitiated";
63
65
  };
64
66
  export declare const CoreEventTypes: {
65
67
  readonly VELT_BUTTON_CLICK: "veltButtonClick";
66
68
  readonly USER_UPDATE: "userUpdate";
69
+ readonly INIT_UPDATE: "initUpdate";
67
70
  readonly DOCUMENT_INIT: "documentInit";
68
71
  readonly ERROR: "error";
69
72
  };
@@ -78,12 +81,17 @@ export declare const LiveStateSyncEventTypes: {
78
81
  };
79
82
  export declare const PresenceEventTypes: {
80
83
  readonly MULTIPLE_USERS_ONLINE: "multipleUsersOnline";
84
+ readonly USER_STATE_CHANGE: "userStateChange";
85
+ };
86
+ export declare const NotificationEventTypes: {
87
+ readonly SETTINGS_UPDATED: "settingsUpdated";
81
88
  };
82
89
  export type CommentEventType = typeof CommentEventTypes[keyof typeof CommentEventTypes];
83
90
  export type RecorderEventType = typeof RecorderEventTypes[keyof typeof RecorderEventTypes];
84
91
  export type CoreEventType = typeof CoreEventTypes[keyof typeof CoreEventTypes];
85
92
  export type LiveStateSyncEventType = typeof LiveStateSyncEventTypes[keyof typeof LiveStateSyncEventTypes];
86
93
  export type PresenceEventType = typeof PresenceEventTypes[keyof typeof PresenceEventTypes];
94
+ export type NotificationEventType = typeof NotificationEventTypes[keyof typeof NotificationEventTypes];
87
95
  export declare enum TagStatus {
88
96
  ADDED = "added",
89
97
  UPDATED = "updated",
@@ -253,7 +261,7 @@ export type ReactionPinType = 'timeline' | 'comment';
253
261
  export type SidebarPosition = 'left' | 'right';
254
262
  export type SidebarSortingCriteria = 'date' | 'unread' | null;
255
263
  export type SidebarFilterCriteria = 'all' | 'read' | 'unread' | 'resolved';
256
- export type SidebarFilterSearchType = 'people' | 'assigned' | 'tagged' | 'pages' | 'statuses' | 'priorities' | 'categories' | 'versions';
264
+ export type SidebarFilterSearchType = 'people' | 'assigned' | 'tagged' | 'pages' | 'documents' | 'statuses' | 'priorities' | 'categories' | 'versions' | string;
257
265
  export type InlineSortingCriteria = 'createdFirst' | 'createdLast' | 'updatedFirst' | 'updatedLast';
258
266
  export type NotificationPanelMode = 'popover' | 'sidebar';
259
267
  export type SidebarActionButtonType = 'default' | 'toggle';
@@ -261,3 +269,11 @@ export declare enum CommentSidebarSystemFiltersOperator {
261
269
  AND = "and",
262
270
  OR = "or"
263
271
  }
272
+ /**
273
+ * Type for notification settings accordion types
274
+ */
275
+ export type NotificationSettingsAccordionType = 'inbox' | 'email' | string;
276
+ /**
277
+ * Type for notification settings item options
278
+ */
279
+ export type NotificationSettingsItemType = 'ALL' | 'MINE' | 'NONE' | string;
package/models.d.ts CHANGED
@@ -35,9 +35,11 @@ export * from './app/models/data/location.model';
35
35
  export * from './app/models/data/media-preview-config.data.model';
36
36
  export * from './app/models/data/multi-thread.data.model';
37
37
  export * from './app/models/data/notification.model';
38
+ export * from './app/models/data/notifications-events.data.model';
38
39
  export * from './app/models/data/page-info.model';
39
40
  export * from './app/models/data/permission.data.model';
40
41
  export * from './app/models/data/presence-user.data.model';
42
+ export * from './app/models/data/presence-actions.data.model';
41
43
  export * from './app/models/data/presence-events.data.model';
42
44
  export * from './app/models/data/recorder.model';
43
45
  export * from './app/models/data/recorder-annotation.data.model';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@veltdev/types",
3
- "version": "4.5.0-beta.4",
3
+ "version": "4.5.0-beta.40",
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": [
package/types.d.ts CHANGED
@@ -16,4 +16,5 @@ export * from './app/models/element/views-element.model';
16
16
  export * from './app/models/element/notification-element.model';
17
17
  export * from './app/models/element/autocomplete-element.model';
18
18
  export * from './app/models/element/reaction-element.model';
19
+ export * from './app/models/element/crdt-element.model';
19
20
  export * from './models';