@veltdev/sdk 4.5.0-beta.12 → 4.5.0-beta.14

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.
@@ -7,6 +7,10 @@ export declare class DocumentPaths {
7
7
  * Presence path.
8
8
  */
9
9
  presence?: string;
10
+ /**
11
+ * User config path.
12
+ */
13
+ userConfig?: string;
10
14
  docs?: string;
11
15
  /**
12
16
  * Cursor path.
@@ -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
+ };
@@ -215,6 +215,7 @@ declare class RecorderDataAsset {
215
215
  */
216
216
  fileFormat?: RecorderFileFormat;
217
217
  thumbnailUrl?: string;
218
+ transcription: RecorderDataTranscription;
218
219
  }
219
220
  export declare class RecorderData {
220
221
  recorderId: string;
@@ -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,36 @@ 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
+
61
91
  constructor();
62
92
 
63
93
  /**
@@ -114,4 +144,34 @@ export declare class NotificationElement {
114
144
  * To mark notification as read by id
115
145
  */
116
146
  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;
117
177
  }
@@ -10,6 +10,7 @@ export declare class PresenceElement {
10
10
  * Subscribe to a list of all online users who are either active or inactive on the current document.
11
11
  *
12
12
  * Returns Observable<PresenceUser[] | null>.
13
+ * @deprecated This method is deprecated. Use `getData` method instead.
13
14
  */
14
15
  getOnlineUsersOnCurrentDocument: () => Observable<PresenceUser[] | null>;
15
16
 
@@ -54,6 +55,7 @@ export declare class PresenceElement {
54
55
  * Subscribe to a list of all online users who are either active or inactive on the current document.
55
56
  *
56
57
  * Returns Observable<PresenceUser[] | null>.
58
+ * @deprecated This method is deprecated. Use `getData` method instead.
57
59
  */
58
60
  private _getOnlineUsersOnCurrentDocument;
59
61
 
@@ -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;
@@ -82,11 +82,15 @@ export declare const PresenceEventTypes: {
82
82
  readonly MULTIPLE_USERS_ONLINE: "multipleUsersOnline";
83
83
  readonly USER_STATE_CHANGE: "userStateChange";
84
84
  };
85
+ export declare const NotificationEventTypes: {
86
+ readonly SETTINGS_UPDATED: "settingsUpdated";
87
+ };
85
88
  export type CommentEventType = typeof CommentEventTypes[keyof typeof CommentEventTypes];
86
89
  export type RecorderEventType = typeof RecorderEventTypes[keyof typeof RecorderEventTypes];
87
90
  export type CoreEventType = typeof CoreEventTypes[keyof typeof CoreEventTypes];
88
91
  export type LiveStateSyncEventType = typeof LiveStateSyncEventTypes[keyof typeof LiveStateSyncEventTypes];
89
92
  export type PresenceEventType = typeof PresenceEventTypes[keyof typeof PresenceEventTypes];
93
+ export type NotificationEventType = typeof NotificationEventTypes[keyof typeof NotificationEventTypes];
90
94
  export declare enum TagStatus {
91
95
  ADDED = "added",
92
96
  UPDATED = "updated",
@@ -264,3 +268,11 @@ export declare enum CommentSidebarSystemFiltersOperator {
264
268
  AND = "and",
265
269
  OR = "or"
266
270
  }
271
+ /**
272
+ * Type for notification settings accordion types
273
+ */
274
+ export type NotificationSettingsAccordionType = 'inbox' | 'email' | string;
275
+ /**
276
+ * Type for notification settings item options
277
+ */
278
+ export type NotificationSettingsItemType = 'ALL' | 'MINE' | 'NONE' | string;
package/models.d.ts CHANGED
@@ -35,6 +35,7 @@ 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';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@veltdev/sdk",
3
- "version": "4.5.0-beta.12",
3
+ "version": "4.5.0-beta.14",
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": [