@veltdev/sdk-staging 4.5.0-beta.27 → 4.5.0-beta.28

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.
@@ -31,7 +31,6 @@ import { FetchDocumentsResponse, FetchFoldersResponse } from "../models/data/doc
31
31
  import { UserDataProvider } from "../models/data/user-resolver.data.model";
32
32
  import { VeltDataProvider } from "../models/data/provider.data.model";
33
33
  import { VeltResetButtonStateConfig } from "../models/data/button.data.model";
34
- import { SetLocationsRequestOptions } from "../models/data/location.model";
35
34
 
36
35
  export declare class Snippyly {
37
36
  constructor();
@@ -49,22 +48,17 @@ export declare class Snippyly {
49
48
  * @param id unique document ID
50
49
  * @param documentMetadata Document Metadata
51
50
  */
52
- setDocument: (id: string, documentMetadata?: DocumentMetadata) => Promise<void>;
51
+ setDocument: (id: string, documentMetadata?: DocumentMetadata) => void;
53
52
  /**
54
53
  * Tell us the unique ID of the current document/resource on which you want to enable collaboration.
55
54
  * @param id unique document ID
56
55
  * @deprecated This method is deprecated. Use `setDocuments` method instead.
57
56
  */
58
- setDocumentId: (id: string) => Promise<void>;
57
+ setDocumentId: (id: string) => void;
59
58
  /**
60
59
  * To set multiple documents
61
60
  */
62
- setDocuments: (documents: Document[], options?: SetDocumentsRequestOptions) => Promise<void>;
63
- /**
64
- * To set the root document
65
- * @param document Document object
66
- */
67
- setRootDocument: (document: Document) => Promise<void>;
61
+ setDocuments: (documents: Document[], options?: SetDocumentsRequestOptions) => void;
68
62
  /**
69
63
  * To unset the document id
70
64
  * @deprecated This method is deprecated. Use `unsetDocuments` method instead.
@@ -106,39 +100,12 @@ export declare class Snippyly {
106
100
  * @param params Location
107
101
  * @param appendLocation Append location to existing location
108
102
  */
109
- setLocation: (params: Location, appendLocation?: boolean) => Promise<void>;
110
-
111
- /**
112
- * To set the root location
113
- * @param location Location object
114
- */
115
- setRootLocation: (location: Location) => Promise<void>;
116
-
117
- /**
118
- * To set multiple locations
119
- * @param locations Location objects
120
- * @param options Set locations options
121
- */
122
- setLocations: (locations: Location[], options?: SetLocationsRequestOptions) => Promise<void>;
123
-
103
+ setLocation: (params: Location, appendLocation?: boolean) => void;
124
104
  /**
125
105
  * To remove location from a User
126
106
  * @param location Location
127
107
  */
128
108
  removeLocation: (location?: Location) => void;
129
-
130
- /**
131
- * To remove multiple locations
132
- * @param locations Location objects
133
- */
134
- removeLocations: (locations?: Location[]) => void;
135
-
136
- /**
137
- * To remove location ids
138
- * @param locationIds Location ids
139
- */
140
- unsetLocationIds: (locationIds?: string[]) => void;
141
-
142
109
  /**
143
110
  * To exclude data of specific location ids
144
111
  * @param ids Location Ids
@@ -244,7 +211,7 @@ export declare class Snippyly {
244
211
  * @param location Location object
245
212
  * @deprecated This method is deprecated and will be removed in next release. Use `setLocation` method with `appendLocation: true` instead.
246
213
  */
247
- addLocation: (location: any) => Promise<any>;
214
+ addLocation: (location: any) => any;
248
215
  /**
249
216
  * To set the dark mode of Velt components.
250
217
  * @param value {boolean} true/false
@@ -348,5 +315,5 @@ export declare class Snippyly {
348
315
  /**
349
316
  * To reset the button toggle map.
350
317
  */
351
- resetVeltButtonState: (config?: VeltResetButtonStateConfig) => void;
318
+ resetVeltButtonState: (config?: VeltResetButtonStateConfig) => void;
352
319
  }
@@ -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
- }
@@ -7,7 +7,6 @@ declare class FilterTypeConfig {
7
7
  multiSelection?: boolean;
8
8
  enableGrouping?: boolean;
9
9
  order?: string[];
10
- placeholder?: string;
11
10
  }
12
11
  export declare class CommentSidebarFilterConfig {
13
12
  location?: FilterTypeConfig;
@@ -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.
@@ -8,7 +8,6 @@ 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;
@@ -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
- }
@@ -55,7 +55,6 @@ export declare class MultiThreadCommentAnnotation {
55
55
  isDraft?: boolean;
56
56
  sourceId?: string;
57
57
  metadata?: MultiThreadMetadata;
58
- isTemporary?: boolean;
59
58
  }
60
59
  export declare class MultiThreadMetadata extends BaseMetadata {
61
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,22 +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
- }
@@ -3,14 +3,18 @@ import { PresenceUser } from "./presence-user.data.model";
3
3
  export interface PresenceMultipleUsersOnlineEvent {
4
4
  users: PresenceUser[];
5
5
  }
6
- export interface PresenceUserStateChangeEvent {
6
+ export interface PresenceUserOnlineEvent {
7
+ user: PresenceUser;
8
+ }
9
+ export interface PresenceUserOfflineEvent {
10
+ user: PresenceUser;
11
+ }
12
+ export interface PresenceUserAwayEvent {
7
13
  user: PresenceUser;
8
- state: string;
9
14
  }
10
15
  export type PresenceEventTypesMap = {
11
16
  [PresenceEventTypes.MULTIPLE_USERS_ONLINE]: PresenceMultipleUsersOnlineEvent;
12
- [PresenceEventTypes.USER_STATE_CHANGE]: PresenceUserStateChangeEvent;
17
+ [PresenceEventTypes.USER_ONLINE]: PresenceUserOnlineEvent;
18
+ [PresenceEventTypes.USER_OFFLINE]: PresenceUserOfflineEvent;
19
+ [PresenceEventTypes.USER_AWAY]: PresenceUserAwayEvent;
13
20
  };
14
- export interface GetPresenceDataResponse {
15
- data: PresenceUser[] | null;
16
- }
@@ -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;
@@ -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;
@@ -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
  }
@@ -791,16 +791,6 @@ export declare class CommentElement {
791
791
  */
792
792
  public disableMultiThread: () => void;
793
793
 
794
- /**
795
- * To enable group multiple match
796
- */
797
- public enableGroupMultipleMatch: () => void;
798
-
799
- /**
800
- * To disable group multiple match
801
- */
802
- public disableGroupMultipleMatch: () => void;
803
-
804
794
  /**
805
795
  * To update context of comment annotation
806
796
  * @param annotationId Comment annotation id
@@ -1150,17 +1140,6 @@ export declare class CommentElement {
1150
1140
  * To disable draft mode
1151
1141
  */
1152
1142
  public disableDraftMode: () => void;
1153
-
1154
- /**
1155
- * To enable filter comments on dom
1156
- */
1157
- public enableFilterCommentsOnDom: () => void;
1158
-
1159
- /**
1160
- * To disable filter comments on dom
1161
- */
1162
- public disableFilterCommentsOnDom: () => void;
1163
-
1164
1143
  constructor();
1165
1144
  /**
1166
1145
  * Subscribe to comments on the current document.
@@ -1931,16 +1910,6 @@ export declare class CommentElement {
1931
1910
  */
1932
1911
  private _disableMultiThread;
1933
1912
 
1934
- /**
1935
- * To enable group multiple match
1936
- */
1937
- private _enableGroupMultipleMatch;
1938
-
1939
- /**
1940
- * To disable group multiple match
1941
- */
1942
- private _disableGroupMultipleMatch;
1943
-
1944
1913
  /**
1945
1914
  * To update context of comment annotation
1946
1915
  * @param annotationId Comment annotation id
@@ -2291,14 +2260,4 @@ export declare class CommentElement {
2291
2260
  * To disable draft mode
2292
2261
  */
2293
2262
  private _disableDraftMode;
2294
-
2295
- /**
2296
- * To enable filter comments on dom
2297
- */
2298
- private _enableFilterCommentsOnDom;
2299
-
2300
- /**
2301
- * To disable filter comments on dom
2302
- */
2303
- private _disableFilterCommentsOnDom;
2304
2263
  }
@@ -1,6 +1,6 @@
1
1
  // @ts-nocheck
2
2
 
3
- import { Notification, NotificationTabConfig, NotificationSettingsConfig, NotificationInitialSettingsConfig } from "../data/notification.model";
3
+ import { Notification, NotificationTabConfig } from "../data/notification.model";
4
4
 
5
5
  export declare class NotificationElement {
6
6
  /**
@@ -58,36 +58,6 @@ 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: () => NotificationSettingsConfig;
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 set settings initial config
88
- */
89
- setSettingsInitialConfig: (settings: NotificationInitialSettingsConfig[]) => void;
90
-
91
61
  constructor();
92
62
 
93
63
  /**
@@ -144,34 +114,4 @@ export declare class NotificationElement {
144
114
  * To mark notification as read by id
145
115
  */
146
116
  private _markNotificationAsReadById;
147
-
148
- /**
149
- * To set settings
150
- */
151
- private _setSettings;
152
-
153
- /**
154
- * To get settings
155
- */
156
- private _getSettings;
157
-
158
- /**
159
- * To mute all notifications
160
- */
161
- private _muteAllNotifications;
162
-
163
- /**
164
- * To enable settings
165
- */
166
- private _enableSettings;
167
-
168
- /**
169
- * To disable settings
170
- */
171
- private _disableSettings;
172
-
173
- /**
174
- * To set settings initial config
175
- */
176
- private _setSettingsInitialConfig;
177
117
  }
@@ -1,16 +1,13 @@
1
1
  // @ts-nocheck
2
2
  import { Observable } from "rxjs";
3
3
  import { PresenceUser } from "../data/presence-user.data.model";
4
- import { GetPresenceDataResponse, PresenceEventTypesMap } from "../data/presence-events.data.model";
5
- import { PresenceRequestQuery } from "../data/presence-actions.data.model";
6
-
4
+ import { PresenceEventTypesMap } from "../data/presence-events.data.model";
7
5
  export declare class PresenceElement {
8
6
 
9
7
  /**
10
8
  * Subscribe to a list of all online users who are either active or inactive on the current document.
11
9
  *
12
10
  * Returns Observable<PresenceUser[] | null>.
13
- * @deprecated This method is deprecated. Use `getData` method instead.
14
11
  */
15
12
  getOnlineUsersOnCurrentDocument: () => Observable<PresenceUser[] | null>;
16
13
 
@@ -41,11 +38,6 @@ export declare class PresenceElement {
41
38
  */
42
39
  disableSelf: () => void;
43
40
 
44
- /**
45
- * To get the presence data
46
- */
47
- getData: (query?: PresenceRequestQuery) => Observable<GetPresenceDataResponse>;
48
-
49
41
  /**
50
42
  * Subscribe to presence events
51
43
  */
@@ -55,7 +47,6 @@ export declare class PresenceElement {
55
47
  * Subscribe to a list of all online users who are either active or inactive on the current document.
56
48
  *
57
49
  * Returns Observable<PresenceUser[] | null>.
58
- * @deprecated This method is deprecated. Use `getData` method instead.
59
50
  */
60
51
  private _getOnlineUsersOnCurrentDocument;
61
52
 
@@ -86,11 +77,6 @@ export declare class PresenceElement {
86
77
  */
87
78
  private _disableSelf;
88
79
 
89
- /**
90
- * To get the presence data
91
- */
92
- private _getData;
93
-
94
80
  /**
95
81
  * Subscribe to presence events
96
82
  */
@@ -83,12 +83,6 @@ export declare class RecorderElement {
83
83
  * To set recording encoding options
84
84
  */
85
85
  setRecordingEncodingOptions: (options: RecorderEncodingOptions) => void;
86
-
87
- /**
88
- * To download latest video
89
- */
90
- downloadLatestVideo: (recorderId: string) => Promise<boolean>;
91
-
92
86
  constructor();
93
87
 
94
88
  private _initRecording;
@@ -168,9 +162,4 @@ export declare class RecorderElement {
168
162
  * To set recording encoding options
169
163
  */
170
164
  private _setRecordingEncodingOptions;
171
-
172
- /**
173
- * To download latest video
174
- */
175
- private _downloadLatestVideo;
176
165
  }
@@ -12,7 +12,6 @@ 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;
16
15
  static FIREBASE_PARTIAL_PATH_PRESENCE: string;
17
16
  static FIREBASE_PARTIAL_PATH_ORGANIZATION_USERS: string;
18
17
  static FIREBASE_PARTIAL_PATH_FOLDER_USERS: string;
@@ -66,7 +66,6 @@ export declare const RecorderEventTypes: {
66
66
  export declare const CoreEventTypes: {
67
67
  readonly VELT_BUTTON_CLICK: "veltButtonClick";
68
68
  readonly USER_UPDATE: "userUpdate";
69
- readonly INIT_UPDATE: "initUpdate";
70
69
  readonly DOCUMENT_INIT: "documentInit";
71
70
  readonly ERROR: "error";
72
71
  };
@@ -81,17 +80,15 @@ export declare const LiveStateSyncEventTypes: {
81
80
  };
82
81
  export declare const PresenceEventTypes: {
83
82
  readonly MULTIPLE_USERS_ONLINE: "multipleUsersOnline";
84
- readonly USER_STATE_CHANGE: "userStateChange";
85
- };
86
- export declare const NotificationEventTypes: {
87
- readonly SETTINGS_UPDATED: "settingsUpdated";
83
+ readonly USER_ONLINE: "userOnline";
84
+ readonly USER_OFFLINE: "userOffline";
85
+ readonly USER_AWAY: "userAway";
88
86
  };
89
87
  export type CommentEventType = typeof CommentEventTypes[keyof typeof CommentEventTypes];
90
88
  export type RecorderEventType = typeof RecorderEventTypes[keyof typeof RecorderEventTypes];
91
89
  export type CoreEventType = typeof CoreEventTypes[keyof typeof CoreEventTypes];
92
90
  export type LiveStateSyncEventType = typeof LiveStateSyncEventTypes[keyof typeof LiveStateSyncEventTypes];
93
91
  export type PresenceEventType = typeof PresenceEventTypes[keyof typeof PresenceEventTypes];
94
- export type NotificationEventType = typeof NotificationEventTypes[keyof typeof NotificationEventTypes];
95
92
  export declare enum TagStatus {
96
93
  ADDED = "added",
97
94
  UPDATED = "updated",
@@ -269,11 +266,3 @@ export declare enum CommentSidebarSystemFiltersOperator {
269
266
  AND = "and",
270
267
  OR = "or"
271
268
  }
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,11 +35,9 @@ 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';
39
38
  export * from './app/models/data/page-info.model';
40
39
  export * from './app/models/data/permission.data.model';
41
40
  export * from './app/models/data/presence-user.data.model';
42
- export * from './app/models/data/presence-actions.data.model';
43
41
  export * from './app/models/data/presence-events.data.model';
44
42
  export * from './app/models/data/recorder.model';
45
43
  export * from './app/models/data/recorder-annotation.data.model';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@veltdev/sdk-staging",
3
- "version": "4.5.0-beta.27",
3
+ "version": "4.5.0-beta.28",
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": [