@veltdev/sdk-staging 5.0.2-beta.2 → 5.0.2-beta.21

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

@@ -1,5 +1,5 @@
 // @ts-nocheck
-import { CrdtGetDataQuery, CrdtGetVersionQuery, CrdtOnDataChangeQuery, CrdtOnPresenceChangeQuery, CrdtOnRegisteredUserChangeQuery, CrdtOnStateChangeQuery, CrdtRegisterSyncUserQuery, CrdtSetPresenceQuery, CrdtSaveVersionQuery, CrdtUpdateDataQuery, CrdtUpdateStateQuery } from "../data/crdt.data.model";
+import { CrdtGetDataQuery, CrdtGetMessagesQuery, CrdtGetSnapshotQuery, CrdtGetVersionQuery, CrdtGetVersionsQuery, CrdtMessageData, CrdtOnDataChangeQuery, CrdtOnMessageQuery, CrdtOnPresenceChangeQuery, CrdtOnRegisteredUserChangeQuery, CrdtOnStateChangeQuery, CrdtPruneMessagesQuery, CrdtPushMessageQuery, CrdtRegisterSyncUserQuery, CrdtSaveSnapshotQuery, CrdtSetPresenceQuery, CrdtSaveVersionQuery, CrdtSnapshotData, CrdtUpdateDataQuery, CrdtUpdateStateQuery } from "../data/crdt.data.model";
 import { CrdtEventTypesMap } from "../data/crdt-events.data.model";
 
 export declare class CrdtElement {
@@ -80,6 +80,12 @@ export declare class CrdtElement {
      */
     getVersion: (getVersionQuery: CrdtGetVersionQuery) => Promise<any>;
 
+    /**
+     * Get all versions of a specific CRDT document
+     * @param id Document ID
+     */
+    getVersions: (getVersionsQuery: CrdtGetVersionsQuery) => Promise<any>;
+
     /**
      * Enable webhook
      */
@@ -96,6 +102,51 @@ export declare class CrdtElement {
      */
     setWebhookDebounceTime: (time: number) => void;
 
+    /**
+     * Push a lib0-encoded message to the unified message stream.
+     * Uses Firebase push() for chronologically-ordered keys.
+     * Carries both sync (type 0) and awareness (type 1) messages.
+     * @param pushMessageQuery - contains id, data (encoded bytes), yjsClientId (Y.Doc client ID), optional messageType and eventData
+     */
+    pushMessage: (pushMessageQuery: CrdtPushMessageQuery) => Promise<void>;
+    /**
+     * Subscribe to the unified message stream for real-time sync.
+     * Emits each new message individually as it arrives (streaming pattern).
+     * Returns an unsubscribe function.
+     * @param onMessageQuery - contains id, callback, and optional afterTs for filtering
+     */
+    onMessage: (onMessageQuery: CrdtOnMessageQuery) => () => void;
+    /**
+     * Fetch all messages after a given timestamp (one-time read).
+     * Used for message replay during initial load (y-redis pattern).
+     * @param getMessagesQuery - contains id and optional afterTs
+     */
+    getMessages: (getMessagesQuery: CrdtGetMessagesQuery) => Promise<CrdtMessageData[]>;
+    /**
+     * Get the latest full-state snapshot for a document.
+     * Used as the baseline for message replay during initial load.
+     * @param getSnapshotQuery - contains id
+     */
+    getSnapshot: (getSnapshotQuery: CrdtGetSnapshotQuery) => Promise<CrdtSnapshotData | null>;
+    /**
+     * Save a full-state snapshot (state + vector) for fast initial load.
+     * Called periodically to create checkpoints, enabling message pruning.
+     * @param saveSnapshotQuery - contains id, state (Y.Doc update), and vector (state vector)
+     */
+    saveSnapshot: (saveSnapshotQuery: CrdtSaveSnapshotQuery) => Promise<void>;
+    /**
+     * Remove messages older than the given timestamp from the message stream.
+     * Called after saving a snapshot to keep the message stream bounded.
+     * @param pruneMessagesQuery - contains id and beforeTs
+     */
+    pruneMessages: (pruneMessagesQuery: CrdtPruneMessagesQuery) => Promise<void>;
+
+    /**
+     * To set activity debounce time for batching CRDT edits (Default value is 10 minutes)
+     * @param time debounce time in milliseconds (minimum: 10 seconds)
+     */
+    setActivityDebounceTime: (time: number) => void;
+
     /**
      * Subscribe to crdt actions
      * @param action Action to subscribe to
@@ -188,6 +239,36 @@ export declare class CrdtElement {
      */
     private _getVersions;
 
+    /**
+     * Push a message to the unified message stream
+     */
+    private _pushMessage;
+
+    /**
+     * Subscribe to the unified message stream
+     */
+    private _onMessage;
+
+    /**
+     * Fetch all messages after a given timestamp
+     */
+    private _getMessages;
+
+    /**
+     * Get the latest snapshot for a document
+     */
+    private _getSnapshot;
+
+    /**
+     * Save a full-state snapshot
+     */
+    private _saveSnapshot;
+
+    /**
+     * Remove messages older than a given timestamp
+     */
+    private _pruneMessages;
+
     /**
      * Enable webhook
      */
@@ -204,6 +285,12 @@ export declare class CrdtElement {
      */
     private _setWebhookDebounceTime;
 
+    /**
+     * Set activity debounce time for batching CRDT edits
+     * @param time debounce time in milliseconds (minimum: 10 seconds)
+     */
+    private _setActivityDebounceTime;
+
     /**
      * Subscribe to crdt actions
      * @param action Action to subscribe to

package/app/utils/constants.d.ts

@@ -57,6 +57,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_ACTIVITIES: string;
+    static FIREBASE_PARTIAL_PATH_LAST_ACTIVITY_TIMESTAMP: string;
     static FIREBASE_PARTIAL_PATH_HEARTBEAT: string;
     static FIREBASE_PARTIAL_PATH_HEARTBEAT_BY_DOCUMENT: string;
     static FIREBASE_PARTIAL_PATH_USERS: string;
@@ -244,7 +246,36 @@ export declare class Constants {
         VELT_NOTIFICATIONS_HISTORY_PANEL: string;
         VELT_WIREFRAME: string;
         VELT_AUTOCOMPLETE: string;
+        VELT_AUTOCOMPLETE_PANEL: string;
+        VELT_AUTOCOMPLETE_OPTION: string;
+        VELT_AUTOCOMPLETE_OPTION_ICON: string;
+        VELT_AUTOCOMPLETE_OPTION_NAME: string;
+        VELT_AUTOCOMPLETE_OPTION_DESCRIPTION: string;
+        VELT_AUTOCOMPLETE_OPTION_ERROR_ICON: string;
+        VELT_AUTOCOMPLETE_GROUP_OPTION: string;
+        VELT_AUTOCOMPLETE_TOOL: string;
+        VELT_AUTOCOMPLETE_EMPTY: string;
         VELT_AUTOCOMPLETE_CHIP: string;
+        VELT_AUTOCOMPLETE_CHIP_TOOLTIP: string;
+        VELT_AUTOCOMPLETE_CHIP_TOOLTIP_ICON: string;
+        VELT_AUTOCOMPLETE_CHIP_TOOLTIP_NAME: string;
+        VELT_AUTOCOMPLETE_CHIP_TOOLTIP_DESCRIPTION: string;
+        VELT_AUTOCOMPLETE_CONTEXT_WRAPPER: string;
+        VELT_COMMENT_DIALOG_VISIBILITY_BANNER: string;
+        VELT_COMMENT_DIALOG_VISIBILITY_BANNER_ICON: string;
+        VELT_COMMENT_DIALOG_VISIBILITY_BANNER_TEXT: string;
+        VELT_COMMENT_DIALOG_VISIBILITY_BANNER_DROPDOWN: string;
+        VELT_COMMENT_DIALOG_VISIBILITY_BANNER_DROPDOWN_TRIGGER: string;
+        VELT_COMMENT_DIALOG_VISIBILITY_BANNER_DROPDOWN_TRIGGER_LABEL: string;
+        VELT_COMMENT_DIALOG_VISIBILITY_BANNER_DROPDOWN_TRIGGER_AVATAR_LIST: string;
+        VELT_COMMENT_DIALOG_VISIBILITY_BANNER_DROPDOWN_TRIGGER_AVATAR_LIST_ITEM: string;
+        VELT_COMMENT_DIALOG_VISIBILITY_BANNER_DROPDOWN_TRIGGER_AVATAR_LIST_REMAINING_COUNT: string;
+        VELT_COMMENT_DIALOG_VISIBILITY_BANNER_DROPDOWN_TRIGGER_ICON: string;
+        VELT_COMMENT_DIALOG_VISIBILITY_BANNER_DROPDOWN_CONTENT: string;
+        VELT_COMMENT_DIALOG_VISIBILITY_BANNER_DROPDOWN_CONTENT_ITEM: string;
+        VELT_COMMENT_DIALOG_VISIBILITY_BANNER_DROPDOWN_CONTENT_ITEM_ICON: string;
+        VELT_COMMENT_DIALOG_VISIBILITY_BANNER_DROPDOWN_CONTENT_ITEM_LABEL: string;
+        VELT_COMMENT_DIALOG_VISIBILITY_BANNER_DROPDOWN_CONTENT_USER_PICKER: string;
         VELT_COMMENT_COMPOSER: string;
         VELT_SKELETON_LOADER: string;
         VELT_SHADOW_DOM_INTERNAL: string;

package/app/utils/enums.d.ts

@@ -60,10 +60,13 @@ export declare const CommentEventTypes: {
     readonly COMMENT_PIN_CLICKED: "commentPinClicked";
     readonly COMMENT_BUBBLE_CLICKED: "commentBubbleClicked";
     readonly COMMENT_TOOL_CLICK: "commentToolClick";
+    readonly COMMENT_TOOL_CLICKED: "commentToolClicked";
     readonly SIDEBAR_BUTTON_CLICK: "sidebarButtonClick";
+    readonly SIDEBAR_BUTTON_CLICKED: "sidebarButtonClicked";
     readonly ATTACHMENT_DOWNLOAD_CLICKED: "attachmentDownloadClicked";
     readonly COMMENT_SAVED: "commentSaved";
-    readonly LOCATION_CLICKED: "locationClicked";
+    readonly COMMENT_SAVE_TRIGGERED: "commentSaveTriggered";
+    readonly VISIBILITY_OPTION_CLICKED: "visibilityOptionClicked";
 };
 export declare const RecorderEventTypes: {
     readonly TRANSCRIPTION_DONE: "transcriptionDone";
@@ -169,7 +172,8 @@ export declare enum Features {
     REWRITER = "rewriter",
     LIVE_SELECTION = "liveSelection",
     NOTIFICATION = "notification",
-    REACTION = "reaction"
+    REACTION = "reaction",
+    ACTIVITY = "activity"
 }
 export declare enum AnalyticsFeatures {
     AREA = "area",
@@ -191,7 +195,7 @@ export declare enum AnalyticsFeatures {
     INLINE_COMMENT = "inlineComment",
     COMMENT_SIDEBAR = "commentSidebar"
 }
-export type FeatureType = 'area' | 'arrow' | 'audioHuddle' | 'comment' | 'cursor' | 'huddle' | 'liveStateSync' | 'presence' | 'recorder' | 'rewriter' | 'tag' | 'liveSelection' | 'notification' | 'reaction' | 'multiThread';
+export type FeatureType = 'area' | 'arrow' | 'audioHuddle' | 'comment' | 'cursor' | 'huddle' | 'liveStateSync' | 'presence' | 'recorder' | 'rewriter' | 'tag' | 'liveSelection' | 'notification' | 'reaction' | 'multiThread' | 'activity';
 export type AssignToType = 'dropdown' | 'checkbox';
 export declare enum DeviceType {
     DESKTOP = "Desktop",
@@ -310,3 +314,13 @@ export type NotificationSettingsItemType = 'ALL' | 'MINE' | 'NONE' | string;
  * Type for notification settings layout
  */
 export type NotificationSettingsLayout = 'accordion' | 'dropdown';
+/**
+ * Enum for comment visibility options in the visibility banner dropdown
+ */
+export declare enum CommentVisibilityOption {
+    RESTRICTED_SELF = "restrictedSelf",
+    RESTRICTED_SELECTED_PEOPLE = "restrictedSelectedPeople",
+    ORGANIZATION_PRIVATE = "organizationPrivate",
+    PUBLIC = "public"
+}
+export type CommentVisibilityOptionType = `${CommentVisibilityOption}`;

package/models.d.ts

@@ -1,6 +1,7 @@
 export * from './app/utils/enums';
 export * from './app/models/data/anchor-record.data.model';
 export * from './app/models/data/attachment.model';
+export * from './app/models/data/activity.data.model';
 export * from './app/models/data/area-annotation.data.model';
 export * from './app/models/data/arrow-annotation.data.model';
 export * from './app/models/data/base-metadata.data.model';

package/package.json

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

package/types.d.ts

@@ -17,4 +17,5 @@ export * from './app/models/element/notification-element.model';
 export * from './app/models/element/autocomplete-element.model';
 export * from './app/models/element/reaction-element.model';
 export * from './app/models/element/crdt-element.model';
+export * from './app/models/element/activity-element.model';
 export * from './models';