@veltdev/types-dev 4.5.0-beta.158 → 4.5.0-beta.16

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 (36) hide show
  1. package/app/client/snippyly.model.d.ts +6 -44
  2. package/app/models/data/button.data.model.d.ts +0 -2
  3. package/app/models/data/comment-annotation.data.model.d.ts +0 -7
  4. package/app/models/data/comment-resolver.data.model.d.ts +0 -14
  5. package/app/models/data/comment-sidebar-config.model.d.ts +0 -26
  6. package/app/models/data/comment.data.model.d.ts +0 -1
  7. package/app/models/data/config.data.model.d.ts +0 -4
  8. package/app/models/data/core-events.data.model.d.ts +0 -9
  9. package/app/models/data/custom-filter.data.model.d.ts +0 -8
  10. package/app/models/data/document-paths.data.model.d.ts +0 -12
  11. package/app/models/data/document.data.model.d.ts +0 -2
  12. package/app/models/data/location.model.d.ts +0 -10
  13. package/app/models/data/media-preview-config.data.model.d.ts +0 -2
  14. package/app/models/data/multi-thread.data.model.d.ts +0 -2
  15. package/app/models/data/notification.model.d.ts +1 -23
  16. package/app/models/data/presence-events.data.model.d.ts +0 -8
  17. package/app/models/data/reaction-resolver.data.model.d.ts +2 -4
  18. package/app/models/data/recorder-annotation.data.model.d.ts +0 -3
  19. package/app/models/data/recorder-events.data.model.d.ts +0 -10
  20. package/app/models/data/recorder.model.d.ts +8 -6
  21. package/app/models/data/resolver.data.model.d.ts +0 -6
  22. package/app/models/data/user-iam.data.model.d.ts +0 -6
  23. package/app/models/data/user-resolver.data.model.d.ts +0 -2
  24. package/app/models/element/comment-element.model.d.ts +11 -116
  25. package/app/models/element/notification-element.model.d.ts +3 -103
  26. package/app/models/element/presence-element.model.d.ts +1 -15
  27. package/app/models/element/recorder-element.model.d.ts +158 -228
  28. package/app/utils/constants.d.ts +0 -44
  29. package/app/utils/enums.d.ts +1 -18
  30. package/models.d.ts +0 -3
  31. package/package.json +1 -1
  32. package/types.d.ts +0 -1
  33. package/app/models/data/crdt.data.model.d.ts +0 -52
  34. package/app/models/data/notifications-events.data.model.d.ts +0 -9
  35. package/app/models/data/presence-actions.data.model.d.ts +0 -5
  36. package/app/models/element/crdt-element.model.d.ts +0 -156
@@ -24,7 +24,6 @@ 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";
28
27
  import { VeltEventMetadata } from "../models/data/event-metadata.data.model";
29
28
  import { CoreEventTypesMap } from "../models/data/core-events.data.model";
30
29
  import { Document, SetDocumentsRequestOptions, FetchDocumentsRequest, FetchFoldersRequest, UpdateDocumentsRequest, UpdateLocationsRequest } from "../models/data/document.data.model";
@@ -32,7 +31,6 @@ import { FetchDocumentsResponse, FetchFoldersResponse } from "../models/data/doc
32
31
  import { UserDataProvider } from "../models/data/user-resolver.data.model";
33
32
  import { VeltDataProvider } from "../models/data/provider.data.model";
34
33
  import { VeltResetButtonStateConfig } from "../models/data/button.data.model";
35
- import { SetLocationsRequestOptions } from "../models/data/location.model";
36
34
 
37
35
  export declare class Snippyly {
38
36
  constructor();
@@ -50,22 +48,17 @@ export declare class Snippyly {
50
48
  * @param id unique document ID
51
49
  * @param documentMetadata Document Metadata
52
50
  */
53
- setDocument: (id: string, documentMetadata?: DocumentMetadata) => Promise<void>;
51
+ setDocument: (id: string, documentMetadata?: DocumentMetadata) => void;
54
52
  /**
55
53
  * Tell us the unique ID of the current document/resource on which you want to enable collaboration.
56
54
  * @param id unique document ID
57
55
  * @deprecated This method is deprecated. Use `setDocuments` method instead.
58
56
  */
59
- setDocumentId: (id: string) => Promise<void>;
57
+ setDocumentId: (id: string) => void;
60
58
  /**
61
59
  * To set multiple documents
62
60
  */
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>;
61
+ setDocuments: (documents: Document[], options?: SetDocumentsRequestOptions) => void;
69
62
  /**
70
63
  * To unset the document id
71
64
  * @deprecated This method is deprecated. Use `unsetDocuments` method instead.
@@ -107,39 +100,12 @@ export declare class Snippyly {
107
100
  * @param params Location
108
101
  * @param appendLocation Append location to existing location
109
102
  */
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
-
103
+ setLocation: (params: Location, appendLocation?: boolean) => void;
125
104
  /**
126
105
  * To remove location from a User
127
106
  * @param location Location
128
107
  */
129
108
  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
-
143
109
  /**
144
110
  * To exclude data of specific location ids
145
111
  * @param ids Location Ids
@@ -226,10 +192,6 @@ export declare class Snippyly {
226
192
  * Get the Area Object.
227
193
  */
228
194
  getReactionElement: () => ReactionElement;
229
- /**
230
- * Get the CRDT Element Object.
231
- */
232
- getCrdtElement: () => CrdtElement;
233
195
  /**
234
196
  * Get the metadata of the current resource.
235
197
  */
@@ -249,7 +211,7 @@ export declare class Snippyly {
249
211
  * @param location Location object
250
212
  * @deprecated This method is deprecated and will be removed in next release. Use `setLocation` method with `appendLocation: true` instead.
251
213
  */
252
- addLocation: (location: any) => Promise<any>;
214
+ addLocation: (location: any) => any;
253
215
  /**
254
216
  * To set the dark mode of Velt components.
255
217
  * @param value {boolean} true/false
@@ -353,5 +315,5 @@ export declare class Snippyly {
353
315
  /**
354
316
  * To reset the button toggle map.
355
317
  */
356
- resetVeltButtonState: (config?: VeltResetButtonStateConfig) => void;
318
+ resetVeltButtonState: (config?: VeltResetButtonStateConfig) => void;
357
319
  }
@@ -1,13 +1,11 @@
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";
5
4
  import { VeltEventMetadata } from "./event-metadata.data.model";
6
5
  import { Notification } from "./notification.model";
7
6
  export interface VeltButtonClickEvent extends VeltButtonData {
8
7
  buttonContext?: VeltButtonContext;
9
8
  metadata?: VeltEventMetadata;
10
- customFilters?: CustomFilters;
11
9
  }
12
10
  export interface VeltButtonContext {
13
11
  type?: string;
@@ -164,10 +164,6 @@ 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;
171
167
  iam: CommentIAMConfig;
172
168
  isPageAnnotation?: boolean;
173
169
  targetInlineCommentElementId?: string;
@@ -248,6 +244,3 @@ export declare class CommentAnnotationSubscribedGroups {
248
244
  export declare class UpdateContextConfig {
249
245
  merge?: boolean;
250
246
  }
251
- export interface ContextOptions {
252
- partialMatch?: boolean;
253
- }
@@ -29,14 +29,6 @@ export interface SaveCommentResolverRequest {
29
29
  metadata?: BaseMetadata;
30
30
  commentId?: string;
31
31
  }
32
- export interface PartialUser {
33
- userId: string;
34
- }
35
- export interface PartialTaggedUserContacts {
36
- userId: string;
37
- contact?: PartialUser;
38
- text?: string;
39
- }
40
32
  export interface PartialComment {
41
33
  commentId: string | number;
42
34
  commentHtml?: string;
@@ -44,9 +36,6 @@ export interface PartialComment {
44
36
  attachments?: {
45
37
  [attachmentId: number]: PartialAttachment;
46
38
  };
47
- from?: PartialUser;
48
- to?: PartialUser[];
49
- taggedUserContacts?: PartialTaggedUserContacts[];
50
39
  }
51
40
  export interface PartialCommentAnnotationResult {
52
41
  strippedData: {
@@ -61,7 +50,4 @@ export interface PartialCommentAnnotation {
61
50
  comments: {
62
51
  [commentId: string]: PartialComment;
63
52
  };
64
- from?: PartialUser;
65
- assignedTo?: PartialUser;
66
- resolvedByUserId?: string | null;
67
53
  }
@@ -1,35 +1,23 @@
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";
4
3
  import { Location } from "./location.model";
5
- declare class FilterOption {
6
- id: string;
7
- name: string;
8
- }
9
4
  declare class FilterTypeConfig {
10
5
  name?: string;
11
6
  enable?: boolean;
12
7
  multiSelection?: boolean;
13
8
  enableGrouping?: boolean;
14
9
  order?: string[];
15
- placeholder?: string;
16
- id?: string;
17
- type?: 'custom' | 'system';
18
- options?: FilterOption[];
19
10
  }
20
11
  export declare class CommentSidebarFilterConfig {
21
12
  location?: FilterTypeConfig;
22
- document?: FilterTypeConfig;
23
13
  people?: FilterTypeConfig;
24
14
  assigned?: FilterTypeConfig;
25
15
  tagged?: FilterTypeConfig;
26
- involved?: FilterTypeConfig;
27
16
  priority?: FilterTypeConfig;
28
17
  status?: FilterTypeConfig;
29
18
  category?: FilterTypeConfig;
30
19
  commentType?: FilterTypeConfig;
31
20
  version?: FilterTypeConfig;
32
- [key: string]: FilterTypeConfig | undefined;
33
21
  }
34
22
  export declare class CommentSidebarGroupConfig {
35
23
  enable?: boolean;
@@ -37,10 +25,6 @@ export declare class CommentSidebarGroupConfig {
37
25
  }
38
26
  export declare class CommentSidebarFilters {
39
27
  location?: Location[];
40
- document?: {
41
- id?: string;
42
- documentName?: string;
43
- }[];
44
28
  people?: {
45
29
  userId?: string;
46
30
  email?: string;
@@ -56,11 +40,6 @@ export declare class CommentSidebarFilters {
56
40
  email?: string;
57
41
  name?: string;
58
42
  }[];
59
- involved?: {
60
- userId?: string;
61
- email?: string;
62
- name?: string;
63
- }[];
64
43
  priority?: string[];
65
44
  status?: string[];
66
45
  category?: string[];
@@ -68,10 +47,6 @@ export declare class CommentSidebarFilters {
68
47
  id: string;
69
48
  name?: string;
70
49
  }[];
71
- [key: string]: {
72
- id?: string;
73
- name?: string;
74
- }[] | string[] | undefined;
75
50
  }
76
51
  export interface CommentSidebarCustomActionsState {
77
52
  [key: string]: boolean;
@@ -81,7 +56,6 @@ export interface CommentSidebarCustomActionEventData {
81
56
  data: CommentAnnotation[];
82
57
  unreadDataMap: UnreadCommentsMap;
83
58
  systemFilteredData: CommentAnnotation[];
84
- customFilters: CustomFilters;
85
59
  }
86
60
  export declare class CommentSidebarData {
87
61
  groupId?: string;
@@ -9,7 +9,6 @@ export declare class Comment {
9
9
  * Auto generated.
10
10
  */
11
11
  commentId: number;
12
- context?: any;
13
12
  /**
14
13
  * This determines the comment content type.
15
14
  *
@@ -49,10 +49,6 @@ export declare class Config {
49
49
  * Default: false
50
50
  */
51
51
  advancedQueriesDisabled?: boolean;
52
- /**
53
- * The domain of the API proxy.
54
- */
55
- apiProxyDomain?: string;
56
52
  }
57
53
  export interface ExtendedFirebaseOptions extends FirebaseOptions {
58
54
  storeDbId: string;
@@ -6,19 +6,10 @@ 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;
10
9
  };
11
10
  export type UserUpdateEvent = User | null;
12
11
  export type DocumentInitEvent = boolean | undefined;
13
12
  export type ErrorEvent = {
14
- error?: string;
15
13
  code: string;
16
14
  message?: string;
17
- source?: string;
18
- };
19
- export type InitUpdateEvent = {
20
- event: string;
21
- methodName?: string;
22
- source?: string;
23
- payload?: any;
24
15
  };
@@ -13,14 +13,6 @@ 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
- }
24
16
  export interface CustomCategory extends CustomFilter {
25
17
  }
26
18
  export interface CustomCategoryMap {
@@ -3,18 +3,10 @@ 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;
10
6
  /**
11
7
  * Presence path.
12
8
  */
13
9
  presence?: string;
14
- /**
15
- * User config path.
16
- */
17
- userConfig?: string;
18
10
  docs?: string;
19
11
  /**
20
12
  * Cursor path.
@@ -72,10 +64,6 @@ export declare class DocumentPaths {
72
64
  * User login path.
73
65
  */
74
66
  logins?: string;
75
- /**
76
- * CRDT path.
77
- */
78
- crdt?: string;
79
67
  /**
80
68
  * Selection path.
81
69
  */
@@ -8,11 +8,9 @@ export interface SetDocumentsRequestOptions {
8
8
  folderId?: string;
9
9
  allDocuments?: boolean;
10
10
  locationId?: string;
11
- rootDocumentId?: string;
12
11
  }
13
12
  export interface UpdateDocumentsRequest<T = unknown> {
14
13
  organizationId?: string;
15
- folderId?: string;
16
14
  documents?: UpdateDocumentMetadata<T>[];
17
15
  }
18
16
  export interface UpdateDocumentMetadata<T = unknown> {
@@ -23,13 +23,3 @@ 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
- }
@@ -2,13 +2,11 @@ export declare class MediaPreviewConfig {
2
2
  audio?: {
3
3
  enabled?: boolean;
4
4
  deviceId?: string;
5
- stream?: MediaStream;
6
5
  };
7
6
  video?: {
8
7
  enabled?: boolean;
9
8
  deviceId?: string;
10
9
  track?: MediaStreamTrack;
11
- stream?: MediaStream;
12
10
  };
13
11
  screen?: {
14
12
  enabled?: boolean;
@@ -55,8 +55,6 @@ export declare class MultiThreadCommentAnnotation {
55
55
  isDraft?: boolean;
56
56
  sourceId?: string;
57
57
  metadata?: MultiThreadMetadata;
58
- isTemporary?: boolean;
59
- context?: any;
60
58
  }
61
59
  export declare class MultiThreadMetadata extends BaseMetadata {
62
60
  [key: string]: any;
@@ -1,4 +1,4 @@
1
- import { AreaStatus, ArrowStatus, CommentStatus, HuddleActionTypes, NotificationSettingsItemType, NotificationSource, TagStatus, UserActionTypes } from "../../utils/enums";
1
+ import { AreaStatus, ArrowStatus, CommentStatus, HuddleActionTypes, 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,25 +230,3 @@ 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
- }
252
- export interface GetNotificationsDataQuery {
253
- type?: 'all' | 'forYou' | 'documents';
254
- }
@@ -3,14 +3,6 @@ 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
- }
10
6
  export type PresenceEventTypesMap = {
11
7
  [PresenceEventTypes.MULTIPLE_USERS_ONLINE]: PresenceMultipleUsersOnlineEvent;
12
- [PresenceEventTypes.USER_STATE_CHANGE]: PresenceUserStateChangeEvent;
13
8
  };
14
- export interface GetPresenceDataResponse {
15
- data: PresenceUser[] | null;
16
- }
@@ -1,8 +1,7 @@
1
- import { ResolverActions } from "../../utils/enums";
2
1
  import { BaseMetadata } from "./base-metadata.data.model";
3
- import { PartialUser } from "./comment-resolver.data.model";
4
2
  import { ReactionAnnotation } from "./reaction-annotation.data.model";
5
- import { ResolverConfig, ResolverResponse } from "./resolver.data.model";
3
+ import { ResolverResponse, ResolverConfig } from "./resolver.data.model";
4
+ import { ResolverActions } from "../../utils/enums";
6
5
  export interface ReactionAnnotationDataProvider {
7
6
  get: (request: GetReactionResolverRequest) => Promise<ResolverResponse<Record<string, PartialReactionAnnotation>>>;
8
7
  save: (request: SaveReactionResolverRequest) => Promise<ResolverResponse<undefined>>;
@@ -38,5 +37,4 @@ export interface PartialReactionAnnotation {
38
37
  annotationId: string;
39
38
  metadata?: BaseMetadata;
40
39
  icon?: string;
41
- from?: PartialUser;
42
40
  }
@@ -180,8 +180,6 @@ export interface RecorderBoundedScaleRange {
180
180
  centerY?: number;
181
181
  topLeftX?: number;
182
182
  topLeftY?: number;
183
- topLeftXPixels?: number;
184
- topLeftYPixels?: number;
185
183
  }
186
184
  export interface RecorderEditRange {
187
185
  trimRanges: RecorderBoundedTrimRange[];
@@ -215,7 +213,6 @@ declare class RecorderDataAsset {
215
213
  */
216
214
  fileFormat?: RecorderFileFormat;
217
215
  thumbnailUrl?: string;
218
- transcription: RecorderDataTranscription;
219
216
  }
220
217
  export declare class RecorderData {
221
218
  recorderId: string;
@@ -8,16 +8,6 @@ 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
- }
21
11
  export type RecorderEventTypesMap = {
22
12
  [RecorderEventTypes.TRANSCRIPTION_DONE]: TranscriptionDoneEvent;
23
13
  [RecorderEventTypes.RECORDING_DONE]: RecordingDoneEvent;
@@ -93,13 +93,15 @@ 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
- }
100
96
  export declare class RecorderQualityConstraints {
101
- safari?: RecorderQualityConstraintsOptions;
102
- other?: RecorderQualityConstraintsOptions;
97
+ safari?: {
98
+ video?: MediaTrackConstraints;
99
+ audio?: MediaTrackConstraints;
100
+ };
101
+ other?: {
102
+ video?: MediaTrackConstraints;
103
+ audio?: MediaTrackConstraints;
104
+ };
103
105
  }
104
106
  export declare class RecorderEncodingOptions {
105
107
  safari?: MediaRecorderOptions;
@@ -3,12 +3,6 @@ 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;
12
6
  }
13
7
  export interface ResolverResponse<T> {
14
8
  data?: T;
@@ -11,12 +11,6 @@ export declare class UserIAM {
11
11
  * The user's contact details
12
12
  */
13
13
  user: UserContact;
14
- documentIds?: string[];
15
- folderIds?: string[];
16
- organizationIds?: string[];
17
- documentIdsCount?: number;
18
- folderIdsCount?: number;
19
- organizationIdsCount?: number;
20
14
  /**
21
15
  * The user's role in the document
22
16
  */
@@ -1,7 +1,5 @@
1
- import { ResolverConfig } from "./resolver.data.model";
2
1
  import { User } from "./user.data.model";
3
2
  export interface UserDataProvider {
4
3
  get(userIds: string[]): Promise<Record<string, User>>;
5
- config?: ResolverConfig;
6
4
  resolveTimeout?: number;
7
5
  }