@veltdev/sdk 1.0.23 → 1.0.25

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

@@ -7,6 +7,7 @@ import { User, UserOptions } from "../models/data/user.data.model";
 import { CommentElement } from "../models/element/comment-element.model";
 import { ContactElement } from "../models/element/contact-element.model";
 import { CursorElement } from "../models/element/cursor-element.model";
+import { LiveStateSyncElement } from "../models/element/live-state-sync-element.model";
 import { PresenceElement } from "../models/element/presence-element.model";
 import { RecorderElement } from "../models/element/recorder-element.model";
 import { RewriterElement } from "../models/element/rewriter-element.model";
@@ -97,6 +98,10 @@ export declare class Snippyly {
    * Get the Rewriter Object.
    */
   getRewriterElement: () => RewriterElement;
+  /**
+   * Get the LiveStateSync Object.
+   */
+  getLiveStateSyncElement: () => LiveStateSyncElement;
   /**
    * To signout a user
    */

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

@@ -92,4 +92,6 @@ export declare class DocumentPaths {
      */
     flock?: string;
     syncVideoPlayer?: string;
+    liveState?: string;
+    liveStateSingleEditorMode?: string;
 }

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

@@ -1,7 +1,21 @@
-import { LiveStateData } from "./live-state-data.data.model";
+import { LiveStateData, SingleEditorLiveStateData } from "./live-state-data.data.model";
 export declare class LiveStateDataMap {
     /**
      * Map of all unique LiveStateData set by you on the given document.
      */
-    [liveStateDataId: string]: LiveStateData;
+    custom?: {
+        [liveStateDataId: string]: LiveStateData;
+    };
+    /**
+     * Map of all unique LiveStateData set by the default editor on the given document.
+     */
+    default?: {
+        singleEditor?: SingleEditorLiveStateData;
+        autoSyncState?: {
+            current?: LiveStateData;
+            history?: {
+                [liveStateDataId: string]: LiveStateData;
+            };
+        };
+    };
 }

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

@@ -1,4 +1,10 @@
+import { User } from "./user.data.model";
 export declare class LiveStateData {
+    /**
+     * Unique identifier to identify the document you are syncing.
+     * This id is md5 of liveStateDataId.
+     */
+    id: string;
     /**
      * Unique identifier to identify the state data you are syncing.
      */
@@ -8,4 +14,15 @@ export declare class LiveStateData {
      *
      */
     data: string | number | boolean | JSON;
+    lastUpdated: any;
+    updatedBy: User;
+}
+export declare class SingleEditorLiveStateData {
+    editor?: User | null;
+    requestEditorAccess?: {
+        user: User;
+        requestedAt: any;
+        status: 'pending' | 'accepted' | 'rejected';
+        waitTime: number;
+    } | null;
 }

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

@@ -0,0 +1,118 @@
+// @ts-nocheck
+
+/**
+ * Represents the synchronization element for live state.
+ */
+export declare class LiveStateSyncElement {
+
+    /**
+     * Gets live state data based on the provided ID.
+     */
+    getLiveStateData: (liveStateDataId?: string) => Observable<any>;
+
+    /**
+     * Gets live state data as an observable based on the provided ID.
+     * @deprecated Use `getLiveStateData` instead
+     */
+    getLiveStateData$: (liveStateDataId?: string) => Observable<any>;
+
+    /**
+     * Sets live state data for the provided ID and data.
+     */
+    setLiveStateData: (liveStateDataId: string, liveStateData: any) => any;
+
+    /**
+     * Enables the single editor mode.
+     */
+    enableSingleEditorMode: () => void;
+
+    /**
+     * Disables the single editor mode.
+     */
+    disableSingleEditorMode: () => void;
+
+    /**
+     * Checks if the current user is an editor. Returns an observable.
+     * @deprecated Use `isUserEditor` instead
+     */
+    isUserEditor$: () => Observable<boolean | null>;
+
+    /**
+     * Checks if the current user is an editor. Returns an observable.
+     */
+    isUserEditor: () => Observable<boolean | null>;
+
+    /**
+     * Sets the current user as an editor.
+     */
+    setUserAsEditor: () => void;
+
+    /**
+     * Resets the user access.
+     */
+    resetUserAccess: () => void;
+
+    /**
+     * To disable elements inside specific elements only when single editor mode is on
+     * @param elementIds Element ids
+     */
+    allowedElementIds: (elementIds: string[]) => void;
+
+    /**
+     * Constructor for LiveStateSyncElement.
+     */
+    constructor();
+
+    /**
+     * Private method for getting live state data as an observable.
+     */
+    private _getLiveStateData;
+
+    /**
+     * Private method for getting live state data as an observable.
+     * @deprecated Use `_getLiveStateData` instead
+     */
+    private _getLiveStateData$;
+
+    /**
+     * Private method for setting live state data.
+     */
+    private _setLiveStateData;
+
+    /**
+     * Private method to enable single editor mode.
+     */
+    private _enableSingleEditorMode;
+
+    /**
+     * Private method to disable single editor mode.
+     */
+    private _disableSingleEditorMode;
+
+    /**
+     * Private method to check if the user is an editor.
+     * @deprecated Use `_isUserEditor` instead
+     */
+    private _isUserEditor$;
+
+    /**
+     * Private method to check if the user is an editor.
+     */
+    private _isUserEditor;
+
+    /**
+     * Private method to set user as an editor.
+     */
+    private _setUserAsEditor;
+
+    /**
+     * Private method to reset user access.
+     */
+    private _resetUserAccess;
+
+    /**
+     * To disable elements inside specific elements only when single editor mode is on
+     * @param elementIds Element ids
+     */
+    private _allowedElementIds;
+}

package/app/utils/constants.d.ts

@@ -25,6 +25,7 @@ export declare class Constants {
     static FIREBASE_PARTIAL_PATH_RECORDER: string;
     static FIREBASE_PARTIAL_PATH_FOLLOW_ALONG: string;
     static FIREBASE_PARTIAL_PATH_SYNC_VIDEO_PLAYER: string;
+    static FIREBASE_PARTIAL_PATH_LIVE_STATE: string;
     static FIREBASE_PARTIAL_PATH_IAM: string;
     static FIREBASE_PARTIAL_PATH_USERS: string;
     static FIREBASE_PARTIAL_PATH_USER_REQUESTS: string;
@@ -233,6 +234,10 @@ export declare class Constants {
         SYNC_VIDEO_PLAYER: string;
         VELT_INLINE_COMMENT_ID: string;
         VELT_PDF_VIEWER: string;
+        VELT_SYNC_STATE: string;
+        VELT_SYNC_ACCESS: string;
+        VELT_SYNC_ACCESS_AUTO: string;
+        VELT_SYNC_ACCESS_DISABLED: string;
     };
     static INJECTION_STYLE_PROPS: {
         /**
@@ -291,6 +296,7 @@ export declare class Constants {
     static VELT_COLOR: string;
     static VELT_MIN_ARROW_LENGTH: number;
     static VELT_ARROW_VIEWPORT_PADDING: number;
+    static LIVE_STATE_REQUEST_EDITOR_ACCESS_WAIT_TIME: number;
     static CURSOR: {
         COMMENT_PIN: string;
         TAG_PIN: string;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@veltdev/sdk",
-    "version": "1.0.23",
+    "version": "1.0.25",
     "description": "",
     "main": "velt.js",
     "scripts": {