@veltdev/sdk 4.5.0-beta.1 → 4.5.0-beta.2

package/app/models/data/live-state-events.data.model.d.ts

@@ -0,0 +1,23 @@
+import { LiveStateSyncEventTypes } from "../../utils/enums";
+import { User } from "./user.data.model";
+export interface AccessRequestEvent {
+    viewer?: User;
+    editor?: User;
+    timestamp?: number;
+    status?: string;
+}
+export interface SEMEvent {
+    viewer?: User;
+    editor?: User;
+    timestamp?: number;
+    role?: string;
+}
+export type LiveStateEventTypesMap = {
+    [LiveStateSyncEventTypes.ACCESS_REQUESTED]: AccessRequestEvent;
+    [LiveStateSyncEventTypes.ACCESS_REQUEST_CANCELED]: AccessRequestEvent;
+    [LiveStateSyncEventTypes.ACCESS_ACCEPTED]: AccessRequestEvent;
+    [LiveStateSyncEventTypes.ACCESS_REJECTED]: AccessRequestEvent;
+    [LiveStateSyncEventTypes.EDITOR_ASSIGNED]: SEMEvent;
+    [LiveStateSyncEventTypes.VIEWER_ASSIGNED]: SEMEvent;
+    [LiveStateSyncEventTypes.EDITOR_ON_DIFFERENT_TAB_DETECTED]: SEMEvent;
+};

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

@@ -0,0 +1,8 @@
+import { PresenceEventTypes } from "../../utils/enums";
+import { PresenceUser } from "./presence-user.data.model";
+export interface PresenceMultipleUsersOnlineEvent {
+    users: PresenceUser[];
+}
+export type PresenceEventTypesMap = {
+    [PresenceEventTypes.MULTIPLE_USERS_ONLINE]: PresenceMultipleUsersOnlineEvent;
+};

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

@@ -81,4 +81,6 @@ export declare class PresenceUser {
     isAnonymous?: boolean;
     pageInfo: PageInfo;
     initial?: string;
+    isTabAway?: boolean;
+    isUserIdle?: boolean;
 }

package/app/models/element/live-state-sync-element.model.d.ts

@@ -2,6 +2,7 @@
 import { SingleEditorConfig, UserEditorAccess, EditorAccessTimer, LiveStateDataConfig, SetLiveStateDataConfig } from '../data/live-state-data.data.model';
 import { User } from '../data/user.data.model';
 import { ServerConnectionState } from '../../utils/enums';
+import { LiveStateEventTypesMap } from '../data/live-state-events.data.model';
 
 /**
  * Represents the synchronization element for live state.
@@ -141,6 +142,11 @@ export declare class LiveStateSyncElement {
      */
     onServerConnectionStateChange: () => Observable<ServerConnectionState>;
 
+    /**
+     * Subscribe to live state events
+     */
+    on: <T extends keyof LiveStateEventTypesMap>(action: T) => Observable<LiveStateEventTypesMap[T]>;
+
     /**
      * Constructor for LiveStateSyncElement.
      */
@@ -278,4 +284,9 @@ export declare class LiveStateSyncElement {
      * To get server connection state
      */
     private _onServerConnectionStateChange;
+
+    /**
+     * Subscribe to live state events
+     */
+    private _on;
 }

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

@@ -1,6 +1,7 @@
 // @ts-nocheck
 import { Observable } from "rxjs";
 import { PresenceUser } from "../data/presence-user.data.model";
+import { PresenceEventTypesMap } from "../data/presence-events.data.model";
 export declare class PresenceElement {
 
     /**
@@ -36,6 +37,11 @@ export declare class PresenceElement {
      * To disable adding self to the presence list
      */
     disableSelf: () => void;
+
+    /**
+     * Subscribe to presence events
+     */
+    on: <T extends keyof PresenceEventTypesMap>(action: T) => Observable<PresenceEventTypesMap[T]>;
     constructor();
     /**
      * Subscribe to a list of all online users who are either active or inactive on the current document.
@@ -70,4 +76,9 @@ export declare class PresenceElement {
      * To disable adding self to the presence list
      */
     private _disableSelf;
+
+    /**
+     * Subscribe to presence events
+     */
+    private _on;
 }

package/app/utils/enums.d.ts

@@ -67,9 +67,23 @@ export declare const CoreEventTypes: {
     readonly DOCUMENT_INIT: "documentInit";
     readonly ERROR: "error";
 };
+export declare const LiveStateSyncEventTypes: {
+    readonly ACCESS_REQUESTED: "accessRequested";
+    readonly ACCESS_REQUEST_CANCELED: "accessRequestCanceled";
+    readonly ACCESS_ACCEPTED: "accessAccepted";
+    readonly ACCESS_REJECTED: "accessRejected";
+    readonly EDITOR_ASSIGNED: "editorAssigned";
+    readonly VIEWER_ASSIGNED: "viewerAssigned";
+    readonly EDITOR_ON_DIFFERENT_TAB_DETECTED: "editorOnDifferentTabDetected";
+};
+export declare const PresenceEventTypes: {
+    readonly MULTIPLE_USERS_ONLINE: "multipleUsersOnline";
+};
 export type CommentEventType = typeof CommentEventTypes[keyof typeof CommentEventTypes];
 export type RecorderEventType = typeof RecorderEventTypes[keyof typeof RecorderEventTypes];
 export type CoreEventType = typeof CoreEventTypes[keyof typeof CoreEventTypes];
+export type LiveStateSyncEventType = typeof LiveStateSyncEventTypes[keyof typeof LiveStateSyncEventTypes];
+export type PresenceEventType = typeof PresenceEventTypes[keyof typeof PresenceEventTypes];
 export declare enum TagStatus {
     ADDED = "added",
     UPDATED = "updated",

package/models.d.ts

@@ -28,6 +28,7 @@ export * from './app/models/data/document-user.data.model';
 export * from './app/models/data/huddle.model';
 export * from './app/models/data/live-state-data-map.data.model';
 export * from './app/models/data/live-state-data.data.model';
+export * from './app/models/data/live-state-events.data.model';
 export * from './app/models/data/localstorage.data.model';
 export * from './app/models/data/location-metadata.model';
 export * from './app/models/data/location.model';
@@ -37,6 +38,7 @@ export * from './app/models/data/notification.model';
 export * from './app/models/data/page-info.model';
 export * from './app/models/data/permission.data.model';
 export * from './app/models/data/presence-user.data.model';
+export * from './app/models/data/presence-events.data.model';
 export * from './app/models/data/recorder.model';
 export * from './app/models/data/recorder-annotation.data.model';
 export * from './app/models/data/recorder-events.data.model';

package/package.json

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