@veltdev/sdk 1.0.108 → 1.0.109

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.
@@ -15,6 +15,7 @@ import { RecorderElement } from "../models/element/recorder-element.model";
15
15
  import { RewriterElement } from "../models/element/rewriter-element.model";
16
16
  import { SelectionElement } from "../models/element/selection-element.model";
17
17
  import { ViewsElement } from "../models/element/views-element.model";
18
+ import { NotificationElement } from "../models/element/notification-element.model";
18
19
  import { TagElement } from "../models/element/tag-element.model";
19
20
  import { FeatureType } from "../utils/enums";
20
21
  export declare class Snippyly {
@@ -115,6 +116,10 @@ export declare class Snippyly {
115
116
  * Get the Views Object.
116
117
  */
117
118
  getViewsElement: () => ViewsElement;
119
+ /**
120
+ * Get the Notification Object.
121
+ */
122
+ getNotificationElement: () => NotificationElement;
118
123
  /**
119
124
  * To signout a user
120
125
  */
@@ -97,4 +97,5 @@ export declare class DocumentPaths {
97
97
  reaction?: string;
98
98
  customerMetadata?: string;
99
99
  views?: string;
100
+ notifications?: string;
100
101
  }
@@ -1,17 +1,25 @@
1
1
  import { AreaStatus, ArrowStatus, CommentStatus, TagStatus, UserActionTypes } from "../../utils/enums";
2
2
  import { DocumentMetadata } from "./document-metadata.model";
3
3
  import { DocumentUser } from "./document-user.data.model";
4
+ import { Location } from "./location.model";
4
5
  import { UserContactUs } from "./user-contact-us.data.model";
5
6
  import { UserContact } from "./user-contact.data.model";
6
7
  import { UserFeedback } from "./user-feedback.data.model";
7
8
  import { UserReportBug } from "./user-report-bug.data.model";
8
9
  import { User } from "./user.data.model";
9
- export declare class Notification {
10
+ export declare class NotificationRawData {
11
+ /**
12
+ * Notification ID
13
+ */
14
+ id?: string;
10
15
  actionUser?: User;
16
+ location?: Location;
17
+ locationId?: number;
18
+ timestamp?: number;
11
19
  /**
12
20
  * Source of a notification
13
21
  */
14
- notificationSource?: 'area' | 'arrow' | 'comment' | 'tag' | 'huddle' | 'userInvite' | 'user' | 'recorder' | 'huddleInvite' | 'userFeedback' | 'userContactUs' | 'userReportBug' | 'documentViews';
22
+ notificationSource?: 'area' | 'arrow' | 'comment' | 'tag' | 'huddle' | 'userInvite' | 'user' | 'recorder' | 'huddleInvite' | 'userFeedback' | 'userContactUs' | 'userReportBug' | 'documentViews' | 'custom';
15
23
  /**
16
24
  * Type of notification like 'Added', 'Updated' etc.
17
25
  */
@@ -35,7 +43,7 @@ export declare class Notification {
35
43
  documentUser?: DocumentUser;
36
44
  oldAccess?: string;
37
45
  newAccess?: string;
38
- platform?: 'sf' | 'sdk';
46
+ platform?: 'sf' | 'sdk' | 'custom';
39
47
  userFeedback?: UserFeedback;
40
48
  userReportBug?: UserReportBug;
41
49
  userContactUs?: UserContactUs;
@@ -67,4 +75,55 @@ export declare class Notification {
67
75
  documentViews?: {
68
76
  emails: string[];
69
77
  };
78
+ displayHeadlineMessageTemplate?: string;
79
+ displayHeadlineMessageTemplateData?: {
80
+ actionUser: User;
81
+ recipientUser: User;
82
+ actionMessage: string;
83
+ project: string;
84
+ [key: string]: any;
85
+ };
86
+ displayBodyMessage?: string;
87
+ customData?: any;
88
+ notifyUsers?: {
89
+ [email: string]: boolean;
90
+ };
91
+ }
92
+ export declare class Notification {
93
+ /**
94
+ * Notification ID
95
+ */
96
+ id: string;
97
+ /**
98
+ * Notification source
99
+ */
100
+ notificationSource?: string;
101
+ /**
102
+ * Notification type
103
+ */
104
+ actionType?: string;
105
+ /**
106
+ * Notification is read or not for the user
107
+ */
108
+ isUnread?: boolean;
109
+ /**
110
+ * Action user of the notification
111
+ */
112
+ actionUser?: User;
113
+ /**
114
+ * Timestamp of the notification
115
+ */
116
+ timestamp?: number;
117
+ /**
118
+ * Notification headline message
119
+ */
120
+ displayHeadlineMessage?: string;
121
+ /**
122
+ * Notification body message
123
+ */
124
+ displayBodyMessage?: string;
125
+ /**
126
+ * Is notification for you
127
+ */
128
+ forYou?: boolean;
70
129
  }
@@ -14,6 +14,13 @@ export declare class Views {
14
14
  };
15
15
  };
16
16
  };
17
+ notification?: {
18
+ [notificationId: string]: {
19
+ views: {
20
+ [userSnippylyId: string]: View;
21
+ };
22
+ };
23
+ };
17
24
  documentViews?: {
18
25
  [documentId: string]: {
19
26
  users: ViewsByUser;
@@ -0,0 +1,34 @@
1
+ // @ts-nocheck
2
+
3
+ export declare class NotificationElement {
4
+ /**
5
+ * To open notification history
6
+ */
7
+ openNotificationHistory: () => void;
8
+
9
+ /**
10
+ * To close notification history
11
+ */
12
+ closeNotificationHistory: () => void;
13
+
14
+ /**
15
+ * To toggle notification history
16
+ */
17
+ toggleNotificationHistory: () => void;
18
+ constructor();
19
+
20
+ /**
21
+ * To open notification history
22
+ */
23
+ private _openNotificationHistory;
24
+
25
+ /**
26
+ * To close notification history
27
+ */
28
+ private _closeNotificationHistory;
29
+
30
+ /**
31
+ * To toggle notification history
32
+ */
33
+ private _toggleNotificationHistory;
34
+ }
@@ -29,6 +29,7 @@ export declare class Constants {
29
29
  static FIREBASE_PARTIAL_PATH_IAM: string;
30
30
  static FIREBASE_PARTIAL_PATH_REACTION: string;
31
31
  static FIREBASE_PARTIAL_PATH_VIEWS: string;
32
+ static FIREBASE_PARTIAL_PATH_NOTIFICATIONS: string;
32
33
  static FIREBASE_PARTIAL_PATH_USERS: string;
33
34
  static FIREBASE_PARTIAL_PATH_USER_REQUESTS: string;
34
35
  static FIREBASE_PARTIAL_PATH_FEEDBACK: string;
@@ -199,6 +200,9 @@ export declare class Constants {
199
200
  VELT_VIDEO_COMMENTS_TIMELINE: string;
200
201
  VELT_REACTION_TOOL: string;
201
202
  VELT_VIEW_ANALYTICS: string;
203
+ VELT_NOTIFICATIONS_TOOL: string;
204
+ VELT_NOTIFICATIONS_PANEL: string;
205
+ VELT_NOTIFICATIONS_HISTORY: string;
202
206
  };
203
207
  static ATTRIBUTES: {
204
208
  VELT_ID: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@veltdev/sdk",
3
- "version": "1.0.108",
3
+ "version": "1.0.109",
4
4
  "description": "",
5
5
  "main": "velt.js",
6
6
  "scripts": {