@veltdev/sdk 4.5.9 → 4.6.0-beta.2

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

@@ -34,6 +34,7 @@ import { VeltDataProvider } from "../models/data/provider.data.model";
 import { VeltEncryptionProvider } from "../models/data/encryption-provider.data.model";
 import { VeltResetButtonStateConfig } from "../models/data/button.data.model";
 import { SetLocationsRequestOptions } from "../models/data/location.model";
+import { HeartbeatConfig, Heartbeat, GetHeartbeatResponse } from "../models/data/heartbeat.data.model";
 
 export declare class Snippyly {
    constructor();
@@ -284,6 +285,11 @@ export declare class Snippyly {
     */
    getUser: () => User | null;
 
+   /**
+    * To get heartbeat.
+    */
+   getHeartbeat: (heartbeatConfig?: HeartbeatConfig) => Observable<GetHeartbeatResponse>;
+
    /**
     * To get user role in provided document.
     */

package/app/models/data/core-events.data.model.d.ts

@@ -1,7 +1,8 @@
 import { CoreEventTypes } from "../../utils/enums";
 import { VeltButtonClickEvent } from "./button.data.model";
-import { User } from "./user.data.model";
+import { PermissionSource, User } from "./user.data.model";
 export type CoreEventTypesMap = {
+    [CoreEventTypes.PERMISSION_PROVIDER]: PermissionProviderEvent;
     [CoreEventTypes.VELT_BUTTON_CLICK]: VeltButtonClickEvent;
     [CoreEventTypes.USER_UPDATE]: UserUpdateEvent;
     [CoreEventTypes.DOCUMENT_INIT]: DocumentInitEvent;
@@ -10,12 +11,47 @@ export type CoreEventTypesMap = {
 };
 export type UserUpdateEvent = User | null;
 export type DocumentInitEvent = boolean | undefined;
+export type PermissionProviderEvent = {
+    event: PermissionProviderEventType;
+    methodName?: PermissionSource;
+    source?: 'internal' | 'external';
+    timestamp?: number;
+    uniqueId?: string;
+    payload?: any;
+};
+export type PermissionProviderEventType = {
+    RESOURCE_ACCESS_REQUEST_FORMED: 'resourceAccessRequestFormed';
+    RESOURCE_ACCESS_REQUEST_TRIGGERED: 'resourceAccessRequestTriggered';
+    RESOURCE_ACCESS_RESULT: 'resourceAccessResult';
+    RESOURCE_ACCESS_ERROR: 'resourceAccessError';
+    RESOURCE_ACCESS_RESULT_FROM_CACHE: 'resourceAccessResultFromCache';
+};
 export type ErrorEvent = {
+    event?: string;
+    sourceMethod?: string;
+    documentIds?: string[];
+    userId?: string;
+    timestamp?: number;
     error?: string;
-    code: string;
+    code?: string;
     message?: string;
     source?: string;
 };
+export declare enum InitUpdateMethodNames {
+    SET_DOCUMENTS = "setDocuments",
+    SET_ROOT_DOCUMENT = "setRootDocument",
+    SET_DOCUMENT_ID = "setDocumentId",
+    UNSET_DOCUMENT_ID = "unsetDocumentId",
+    UNSET_DOCUMENTS = "unsetDocuments",
+    SET_LOCATION = "setLocation",
+    SET_LOCATIONS = "setLocations",
+    SET_ROOT_LOCATION = "setRootLocation",
+    ADD_LOCATION = "addLocation",
+    REMOVE_LOCATION = "removeLocation",
+    REMOVE_LOCATIONS = "removeLocations",
+    UNSET_LOCATION_IDS = "unsetLocationIds",
+    REMOVE_LOCATIONS_SUCCESS = "removeLocationsSuccess"
+}
 export type InitUpdateEvent = {
     event: string;
     methodName?: string;

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

@@ -8,3 +8,9 @@ export interface Heartbeat {
     metadata: BaseMetadata;
     lastUpdatedTimestamp: number;
 }
+export interface HeartbeatConfig {
+    userId?: string;
+}
+export interface GetHeartbeatResponse {
+    data: Heartbeat[] | null;
+}

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

@@ -124,7 +124,9 @@ export declare enum PermissionSource {
     SET_DOCUMENTS = "setDocuments",
     IDENTIFY = "identify",
     GET_NOTIFICATIONS = "getNotifications",
-    SET_NOTIFICATIONS = "setNotifications"
+    SET_NOTIFICATIONS = "setNotifications",
+    REVOKE_ACCESS_ON_USER_LOGOUT = "revokeAccessOnUserLogout",
+    REVOKE_ACCESS_ON_DOCUMENT_UNSET = "revokeAccessOnDocumentUnset"
 }
 export interface RevokeAccessOn {
     type: RevokeAccessOnType;

package/app/utils/constants.d.ts

@@ -361,6 +361,7 @@ export declare class Constants {
         VELT_COMMENT_SIDEBAR_CUSTOM_ACTIONS_STATE: string;
         VELT_CURSOR_MULTIPLE_USERS_DETECTED: string;
         VELT_PRESENCE_MULTIPLE_USERS_DETECTED: string;
+        VELT_PRESENCE_MULTIPLE_USERS_ONLINE: string;
         VELT_CUSTOM_PRIORITY_MAP: string;
         VELT_CUSTOM_STATUS_MAP: string;
         VELT_CUSTOM_CATEGORY_MAP: string;
@@ -369,6 +370,7 @@ export declare class Constants {
         SNIPPYLY_DEFAULT_MEDIA_SOURCE_OPTIONS: string;
         SNIPPYLY_QUEUED_COMMENT: string;
         VELT_USER: string;
+        VELT_IDENTIFY_USER: string;
         VELT_USER_FORCE_RE_LOGGED_IN: string;
         VELT_VERSION: string;
         VELT_ADVANCED_QUERIES: string;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@veltdev/sdk",
-    "version": "4.5.9",
+    "version": "4.6.0-beta.2",
     "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": [