@veltdev/sdk 4.5.5 → 4.5.6-beta.10

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

@@ -3,7 +3,7 @@ import { Observable } from "rxjs";
 import { Config, DisableLogsConfig } from "../models/data/config.data.model";
 import { DocumentUser } from "../models/data/document-user.data.model";
 import { Location } from "../models/data/location.model";
-import { User, UserOptions, VeltAuthProvider } from "../models/data/user.data.model";
+import { User, UserOptions, VeltAuthProvider, VeltPermissionProvider } from "../models/data/user.data.model";
 import { CustomCss } from "../models/data/custom-css.data.model";
 import { AreaElement } from "../models/element/area-element.model";
 import { ArrowElement } from "../models/element/arrow-element.model";
@@ -100,6 +100,9 @@ export declare class Snippyly {
     * To set the data provider.
     */
    setDataProviders: (dataProvider: VeltDataProvider) => void;
+
+   setPermissionProvider: (permissionProvider: VeltPermissionProvider) => void;
+
    /**
     * To set the encryption provider.
     */

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

@@ -41,6 +41,14 @@ export declare class DocumentPaths {
      * Huddle path.
      */
     audioHuddle?: string;
+    /**
+     * Heartbeat path.
+     */
+    heartbeat?: string;
+    /**
+     * Heartbeat by document path.
+     */
+    heartbeatByDocument?: string;
     /**
      * Document Id provided by the user.
      */

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

@@ -0,0 +1,10 @@
+import { BaseMetadata } from "./base-metadata.data.model";
+export interface Heartbeat {
+    id: string;
+    createdTimestamp: number;
+    userId: string;
+    veltUserId: string;
+    tabId: string;
+    metadata: BaseMetadata;
+    lastUpdatedTimestamp: number;
+}

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

@@ -11,11 +11,12 @@ export declare class LiveStateDataMap {
      */
     default?: {
         singleEditor?: SingleEditorLiveStateData;
-        autoSyncState?: {
-            current?: LiveStateData;
-            history?: {
-                [liveStateDataId: string]: LiveStateData;
-            };
-        };
+        autoSyncState?: LiveStateAutoSyncState;
+    };
+}
+export declare class LiveStateAutoSyncState {
+    current?: LiveStateData;
+    history?: {
+        [liveStateDataId: string]: LiveStateData;
     };
 }

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

@@ -90,3 +90,9 @@ export interface LiveStateSingleEditorExternalUserPresence {
      */
     userIds?: string[];
 }
+export interface FetchLiveStateDataRequest {
+    /**
+     * Unique identifier to identify the state data you are syncing.
+     */
+    liveStateDataId?: string;
+}

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

@@ -17,6 +17,7 @@ export interface ResolverResponse<T> {
     message?: string;
     timestamp?: number;
     statusCode: number;
+    signature?: string;
 }
 export interface RetryConfig {
     retryCount?: number;

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

@@ -1,4 +1,6 @@
+import { ResolverResponse } from "./resolver.data.model";
 import { UserContact } from "./user-contact.data.model";
+import { UserPermissionAccessRole } from "./user-resolver.data.model";
 export declare class User {
     /**
      * Unique user identifier that you use to identify your user.
@@ -109,3 +111,23 @@ export interface VeltAuthProvider {
     retryConfig?: AuthRetryConfig;
     generateToken?: () => Promise<string>;
 }
+export interface VeltPermissionProvider {
+    onResourceAccessRequired: (requests: Array<PermissionQuery>) => Promise<ResolverResponse<PermissionResult[]>>;
+    retryConfig?: AuthRetryConfig;
+    forceRefresh?: boolean;
+}
+export interface PermissionQuery {
+    userId: string;
+    resource: {
+        id: string;
+        type: 'folder' | 'document' | 'organization';
+    };
+}
+export interface PermissionResult {
+    userId: string;
+    resourceId: string;
+    type: 'folder' | 'document' | 'organization';
+    accessRole?: UserPermissionAccessRole;
+    expiresAt?: number;
+    hasAccess: boolean;
+}

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

@@ -1,6 +1,6 @@
 // @ts-nocheck
 import { ServerConnectionState } from '../../utils/enums';
-import { EditorAccessTimer, LiveStateDataConfig, LiveStateSingleEditorExternalUserPresence, SetLiveStateDataConfig, SetUserAsEditorResponse, SingleEditorConfig, UserEditorAccess } from '../data/live-state-data.data.model';
+import { EditorAccessTimer, FetchLiveStateDataRequest, LiveStateDataConfig, LiveStateSingleEditorExternalUserPresence, SetLiveStateDataConfig, SetUserAsEditorResponse, SingleEditorConfig, UserEditorAccess } from '../data/live-state-data.data.model';
 import { LiveStateEventTypesMap } from '../data/live-state-events.data.model';
 import { User } from '../data/user.data.model';
 
@@ -20,6 +20,11 @@ export declare class LiveStateSyncElement {
      */
     getLiveStateData$: <T = unknown>(liveStateDataId?: string, liveStateDataConfig?: LiveStateDataConfig) => Observable<T>;
 
+    /**
+     * Fetches live state data.
+     */
+    fetchLiveStateData: <T = unknown>(request?: FetchLiveStateDataRequest) => Promise<T>;
+
     /**
      * Sets live state data for the provided ID and data.
      */
@@ -147,6 +152,16 @@ export declare class LiveStateSyncElement {
      */
     updateUserPresence: (userPresence: LiveStateSingleEditorExternalUserPresence) => void;
 
+    /**
+     * To enable heartbeat
+     */
+    enableHeartbeat: () => void;
+
+    /**
+     * To disable heartbeat
+     */
+    disableHeartbeat: () => void;
+
     /**
      * Subscribe to live state events
      */
@@ -168,6 +183,11 @@ export declare class LiveStateSyncElement {
      */
     private _getLiveStateData$;
 
+    /**
+     * Private method for fetching live state data.
+     */
+    private _fetchLiveStateData;
+
     /**
      * Private method for setting live state data.
      */
@@ -295,6 +315,16 @@ export declare class LiveStateSyncElement {
      */
     private _updateUserPresence;
 
+    /**
+     * To enable heartbeat
+     */
+    private _enableHeartbeat;
+
+    /**
+     * To disable heartbeat
+     */
+    private _disableHeartbeat;
+
     /**
      * Subscribe to live state events
      */

package/app/utils/constants.d.ts

@@ -54,6 +54,8 @@ export declare class Constants {
     static FIREBASE_PARTIAL_PATH_NOTIFICATIONS: string;
     static FIREBASE_PARTIAL_PATH_ORGANIZATION_NOTIFICATIONS: string;
     static FIREBASE_PARTIAL_PATH_LAST_NOTIFICATION_TIMESTAMP: string;
+    static FIREBASE_PARTIAL_PATH_HEARTBEAT: string;
+    static FIREBASE_PARTIAL_PATH_HEARTBEAT_BY_DOCUMENT: string;
     static FIREBASE_PARTIAL_PATH_USERS: string;
     static FIREBASE_PARTIAL_PATH_PERMISSIONS_USERS: string;
     static FIREBASE_PARTIAL_PATH_USER_REQUESTS: string;

package/models.d.ts

@@ -25,6 +25,7 @@ export * from './app/models/data/document-iam.data.model';
 export * from './app/models/data/document-metadata.model';
 export * from './app/models/data/document-paths.data.model';
 export * from './app/models/data/document-user.data.model';
+export * from './app/models/data/heartbeat.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';

package/package.json

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