@veltdev/sdk 2.0.26 → 2.0.28

package/README.md

@@ -0,0 +1,54 @@
+# Velt Collaboration SDK
+
+<p>
+  <a href="https://npmjs.org/package/@veltdev/sdk">
+    <img src="https://img.shields.io/npm/v/@veltdev/sdk?style=flat&label=npm&color=09f" alt="NPM" />
+  </a>
+</p>
+
+With Velt SDK you can add powerful collaboration features to your product extremely fast.
+
+The SDK provides **fullstack components**:
+- UI and behavior are fully customizable to match your product's needs
+- fully-managed on a scalable realtime backend
+
+Features include:
+* **Comments** like Figma, Frame.io, Google Docs, Sheets and more
+* **Recording** like Loom (audio, video, screen)
+* **Huddle** like Slack (audio, video, screensharing)
+* In-app and off-app **notifications**
+* **@mentions** and assignment
+* **Presence**, **Cursors**, **Live Selection**
+* **Live state sync** with Single Editor mode
+* **Multiplayer editing** with conflict resolution
+* **Follow mode** like Figma 
+* ... and so much more
+
+## Installation
+
+```
+npm install @veltdev/sdk
+```
+
+## Documentation
+
+- Read the [documentation](https://docs.velt.dev/get-started/overview) for guides and API references.
+
+## Use cases
+
+- Explore [use cases](https://velt.dev/use-case) to learn how collaboration could look like on your product.
+- [Figma Template](https://www.figma.com/community/file/1402312407969730816/velt-collaboration-kit): To visualize what collaboration features could look like on your product.
+
+## Releases
+
+- See the [latest changes](https://docs.velt.dev/release-notes/).
+
+## Security
+- Velt is SOC2 Type 2 and HIPAA compliant. [Learn more](https://velt.dev/security)
+
+## Community
+
+- [X](https://x.com/veltjs): To receive updates, announcements,
+  and general Velt tips.
+
+- [Discord](https://discord.gg/GupvcYH27h): To ask questions and share tips. (Less active).

package/app/client/snippyly.model.d.ts

@@ -22,6 +22,8 @@ import { AutocompleteElement } from "../models/element/autocomplete-element.mode
 import { TagElement } from "../models/element/tag-element.model";
 import { FeatureType } from "../utils/enums";
 import { UserContact } from "../models/data/user-contact.data.model";
+import { DocumentMetadata } from "../models/data/document-metadata.model";
+
 export declare class Snippyly {
   constructor();
   initConfig: (apiKey: string, config?: Config) => void;
@@ -33,6 +35,12 @@ export declare class Snippyly {
    * @deprecated This method is deprecated and will be removed in next release.
    */
   updateUser: (user: User) => void;
+  /**
+   * Tell us the unique ID of the current document/resource on which you want to enable collaboration.
+   * @param id unique document ID
+   * @param documentMetadata Document Metadata
+   */
+  setDocument: (id: string, documentMetadata?: DocumentMetadata) => void;
   /**
    * Tell us the unique ID of the current document/resource on which you want to enable collaboration.
    * @param id unique document ID

package/app/models/data/document-metadata.model.d.ts

@@ -10,6 +10,10 @@ export declare class DocumentMetadata {
      * Document id provided by client
      */
     clientDocumentId?: string | number;
+    /**
+     * Document name
+     */
+    documentName?: string;
     /**
      * Page metadata
      */
@@ -24,4 +28,5 @@ export declare class DocumentMetadata {
      * Document creator
      */
     creator?: User;
+    [key: string]: any;
 }

package/app/models/data/notification.model.d.ts

@@ -200,3 +200,13 @@ export declare class NotificationMetadata {
      */
     location?: Location;
 }
+export declare class NotificationTabConfigItem {
+    name?: string;
+    enable?: boolean;
+}
+export declare class NotificationTabConfig {
+    forYou?: NotificationTabConfigItem;
+    documents?: NotificationTabConfigItem;
+    all?: NotificationTabConfigItem;
+    people?: NotificationTabConfigItem;
+}

package/app/models/element/contact-element.model.d.ts

@@ -28,6 +28,13 @@ export declare class ContactElement {
    * @param scope ContactListScopeForOrganizationUsers[]
    */
   public updateContactListScopeForOrganizationUsers: (scope: ContactListScopeForOrganizationUsers[]) => void;
+
+  /**
+   * Update contact list.
+   * @param userContacts UserContact[]
+   * @param config {merge: boolean}
+   */
+  public updateContactList: (userContacts: UserContact[], config?: { merge: boolean }) => void;
   constructor();
   /**
    * Get if user is part of global contact or not.
@@ -54,4 +61,11 @@ export declare class ContactElement {
    * @param scope ContactListScopeForOrganizationUsers[]
    */
   private _updateContactListScopeForOrganizationUsers;
+
+  /**
+   * Update contact list.
+   * @param userContacts UserContact[]
+   * @param config {merge: boolean}
+   */
+  private _updateContactList;
 }

package/app/models/element/notification-element.model.d.ts

@@ -1,6 +1,6 @@
 // @ts-nocheck
 
-import { Notification } from "../data/notification.model";
+import { Notification, NotificationTabConfig } from "../data/notification.model";
 
 export declare class NotificationElement {
     /**
@@ -27,6 +27,11 @@ export declare class NotificationElement {
      * To set max days for notification history
      */
     setMaxDays: (days: number) => void;
+
+    /**
+     * To set tab configuration
+     */
+    setTabConfig: (tabConfig: NotificationTabConfig) => void;
     constructor();
 
     /**
@@ -53,4 +58,9 @@ export declare class NotificationElement {
      * To set max days for notification history
      */
     private _setMaxDays;
+
+    /**
+     * To set tab configuration
+     */
+    private _setTabConfig;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@veltdev/sdk",
-    "version": "2.0.26",
+    "version": "2.0.28",
     "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.",
     "homepage": "https://velt.dev",
     "keywords": [