@veltdev/sdk-staging 2.0.63 → 2.0.65
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.
package/README.md
CHANGED
|
@@ -1,44 +1,54 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
1
|
+
# Velt Collaboration SDK
|
|
2
|
+
|
|
3
|
+
<p>
|
|
4
|
+
<a href="https://npmjs.org/package/@veltdev/sdk">
|
|
5
|
+
<img src="https://img.shields.io/npm/v/@veltdev/sdk?style=flat&label=npm&color=09f" alt="NPM" />
|
|
6
|
+
</a>
|
|
7
|
+
</p>
|
|
8
|
+
|
|
9
|
+
With Velt SDK you can add powerful collaboration features to your product extremely fast.
|
|
10
|
+
|
|
11
|
+
The SDK provides **fullstack components**:
|
|
12
|
+
- UI and behavior are fully customizable to match your product's needs
|
|
13
|
+
- fully-managed on a scalable realtime backend
|
|
14
|
+
|
|
15
|
+
Features include:
|
|
16
|
+
* **Comments** like Figma, Frame.io, Google Docs, Sheets and more
|
|
17
|
+
* **Recording** like Loom (audio, video, screen)
|
|
18
|
+
* **Huddle** like Slack (audio, video, screensharing)
|
|
19
|
+
* In-app and off-app **notifications**
|
|
20
|
+
* **@mentions** and assignment
|
|
21
|
+
* **Presence**, **Cursors**, **Live Selection**
|
|
22
|
+
* **Live state sync** with Single Editor mode
|
|
23
|
+
* **Multiplayer editing** with conflict resolution
|
|
24
|
+
* **Follow mode** like Figma
|
|
25
|
+
* ... and so much more
|
|
26
|
+
|
|
27
|
+
## Installation
|
|
11
28
|
|
|
12
29
|
```
|
|
13
|
-
|
|
30
|
+
npm install @veltdev/sdk
|
|
14
31
|
```
|
|
15
32
|
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
**SDK documentation**
|
|
19
|
-
|
|
20
|
-
[https://sdk.snippyly.com/docs](https://sdk.snippyly.com/docs)
|
|
21
|
-
|
|
22
|
-
## React.js
|
|
33
|
+
## Documentation
|
|
23
34
|
|
|
24
|
-
|
|
35
|
+
- Read the [documentation](https://docs.velt.dev/get-started/overview) for guides and API references.
|
|
25
36
|
|
|
26
|
-
##
|
|
37
|
+
## Use cases
|
|
27
38
|
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
Please refer this [snippyly-demo-react](https://github.com/snippyly/snippyly-demo-react) demo to integrate Snippyly in React.js project.
|
|
39
|
+
- Explore [use cases](https://velt.dev/use-case) to learn how collaboration could look like on your product.
|
|
40
|
+
- [Figma Template](https://www.figma.com/community/file/1402312407969730816/velt-collaboration-kit): To visualize what collaboration features could look like on your product.
|
|
31
41
|
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
Please refer this [snippyly-demo-react-ts](https://github.com/snippyly/snippyly-demo-react-ts) demo to integrate Snippyly in React.js with TypeScript project.
|
|
42
|
+
## Releases
|
|
35
43
|
|
|
36
|
-
|
|
44
|
+
- See the [latest changes](https://docs.velt.dev/release-notes/).
|
|
37
45
|
|
|
38
|
-
|
|
46
|
+
## Security
|
|
47
|
+
- Velt is SOC2 Type 2 and HIPAA compliant. [Learn more](https://velt.dev/security)
|
|
39
48
|
|
|
40
|
-
##
|
|
49
|
+
## Community
|
|
41
50
|
|
|
42
|
-
|
|
51
|
+
- [X](https://x.com/veltjs): To receive updates, announcements,
|
|
52
|
+
and general Velt tips.
|
|
43
53
|
|
|
44
|
-
|
|
54
|
+
- [Discord](https://discord.gg/GupvcYH27h): To ask questions and share tips. (Less active).
|
|
@@ -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
|
+
}
|
|
@@ -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
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@veltdev/sdk-staging",
|
|
3
|
-
"version": "2.0.
|
|
3
|
+
"version": "2.0.65",
|
|
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": [
|