@veltdev/sdk 2.0.27 → 2.0.29

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.
@@ -22,6 +22,8 @@ import { AutocompleteElement } from "../models/element/autocomplete-element.mode
22
22
  import { TagElement } from "../models/element/tag-element.model";
23
23
  import { FeatureType } from "../utils/enums";
24
24
  import { UserContact } from "../models/data/user-contact.data.model";
25
+ import { DocumentMetadata } from "../models/data/document-metadata.model";
26
+
25
27
  export declare class Snippyly {
26
28
  constructor();
27
29
  initConfig: (apiKey: string, config?: Config) => void;
@@ -33,6 +35,12 @@ export declare class Snippyly {
33
35
  * @deprecated This method is deprecated and will be removed in next release.
34
36
  */
35
37
  updateUser: (user: User) => void;
38
+ /**
39
+ * Tell us the unique ID of the current document/resource on which you want to enable collaboration.
40
+ * @param id unique document ID
41
+ * @param documentMetadata Document Metadata
42
+ */
43
+ setDocument: (id: string, documentMetadata?: DocumentMetadata) => void;
36
44
  /**
37
45
  * Tell us the unique ID of the current document/resource on which you want to enable collaboration.
38
46
  * @param id unique document ID
@@ -177,10 +177,10 @@ export declare class GhostComment {
177
177
  }
178
178
  export declare class CommentOnElementConfig {
179
179
  targetElement?: {
180
- targetText: string;
181
- occurrence: number;
182
- elementId: string;
183
- selectAllContent: boolean;
180
+ targetText?: string;
181
+ occurrence?: number;
182
+ elementId?: string;
183
+ selectAllContent?: boolean;
184
184
  };
185
185
  commentData?: {
186
186
  commentText: string;
@@ -191,6 +191,8 @@ export declare class CommentOnElementConfig {
191
191
  replaceContentText?: string;
192
192
  }[];
193
193
  status?: string;
194
+ context?: any;
195
+ openComment?: boolean;
194
196
  }
195
197
  export declare class CommentIAMConfig {
196
198
  accessMode?: CommentAccessMode;
@@ -10,6 +10,10 @@ export declare class DocumentMetadata {
10
10
  * Document id provided by client
11
11
  */
12
12
  clientDocumentId?: string | number;
13
+ /**
14
+ * Document name
15
+ */
16
+ documentName?: string;
13
17
  /**
14
18
  * Page metadata
15
19
  */
@@ -24,4 +28,5 @@ export declare class DocumentMetadata {
24
28
  * Document creator
25
29
  */
26
30
  creator?: User;
31
+ [key: string]: any;
27
32
  }
@@ -200,3 +200,13 @@ export declare class NotificationMetadata {
200
200
  */
201
201
  location?: Location;
202
202
  }
203
+ export declare class NotificationTabConfigItem {
204
+ name?: string;
205
+ enable?: boolean;
206
+ }
207
+ export declare class NotificationTabConfig {
208
+ forYou?: NotificationTabConfigItem;
209
+ documents?: NotificationTabConfigItem;
210
+ all?: NotificationTabConfigItem;
211
+ people?: NotificationTabConfigItem;
212
+ }
@@ -715,6 +715,16 @@ export declare class CommentElement {
715
715
  * @param data custom list data
716
716
  */
717
717
  public createCustomListDataOnComment: (data: AutocompleteData) => void;
718
+
719
+ /**
720
+ * To enable showing bubble on hover
721
+ */
722
+ public showBubbleOnHover: () => void;
723
+
724
+ /**
725
+ * To disable showing bubble on hover
726
+ */
727
+ public hideBubbleOnHover: () => void;
718
728
  constructor();
719
729
  /**
720
730
  * Subscribe to comments on the current document.
@@ -1418,4 +1428,14 @@ export declare class CommentElement {
1418
1428
  * @param data custom list data
1419
1429
  */
1420
1430
  private _createCustomListDataOnComment;
1431
+
1432
+ /**
1433
+ * To enable showing bubble on hover
1434
+ */
1435
+ private _showBubbleOnHover;
1436
+
1437
+ /**
1438
+ * To disable showing bubble on hover
1439
+ */
1440
+ private _hideBubbleOnHover;
1421
1441
  }
@@ -28,6 +28,13 @@ export declare class ContactElement {
28
28
  * @param scope ContactListScopeForOrganizationUsers[]
29
29
  */
30
30
  public updateContactListScopeForOrganizationUsers: (scope: ContactListScopeForOrganizationUsers[]) => void;
31
+
32
+ /**
33
+ * Update contact list.
34
+ * @param userContacts UserContact[]
35
+ * @param config {merge: boolean}
36
+ */
37
+ public updateContactList: (userContacts: UserContact[], config?: { merge: boolean }) => void;
31
38
  constructor();
32
39
  /**
33
40
  * Get if user is part of global contact or not.
@@ -54,4 +61,11 @@ export declare class ContactElement {
54
61
  * @param scope ContactListScopeForOrganizationUsers[]
55
62
  */
56
63
  private _updateContactListScopeForOrganizationUsers;
64
+
65
+ /**
66
+ * Update contact list.
67
+ * @param userContacts UserContact[]
68
+ * @param config {merge: boolean}
69
+ */
70
+ private _updateContactList;
57
71
  }
@@ -1,6 +1,6 @@
1
1
  // @ts-nocheck
2
2
 
3
- import { Notification } from "../data/notification.model";
3
+ import { Notification, NotificationTabConfig } from "../data/notification.model";
4
4
 
5
5
  export declare class NotificationElement {
6
6
  /**
@@ -27,6 +27,11 @@ export declare class NotificationElement {
27
27
  * To set max days for notification history
28
28
  */
29
29
  setMaxDays: (days: number) => void;
30
+
31
+ /**
32
+ * To set tab configuration
33
+ */
34
+ setTabConfig: (tabConfig: NotificationTabConfig) => void;
30
35
  constructor();
31
36
 
32
37
  /**
@@ -53,4 +58,9 @@ export declare class NotificationElement {
53
58
  * To set max days for notification history
54
59
  */
55
60
  private _setMaxDays;
61
+
62
+ /**
63
+ * To set tab configuration
64
+ */
65
+ private _setTabConfig;
56
66
  }
@@ -244,6 +244,7 @@ export declare class Constants {
244
244
  VELT_RECORDER_DISABLED: string;
245
245
  VELT_ANNOTATION_DRAFT: string;
246
246
  VELT_LOCATION: string;
247
+ VELT_LOCATION_ID: string;
247
248
  VELT_THEME: string;
248
249
  VELT_IGNORE: string;
249
250
  EMBED_MODE: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@veltdev/sdk",
3
- "version": "2.0.27",
3
+ "version": "2.0.29",
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": [