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

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

@@ -58,3 +58,54 @@ export interface CrdtDeleteVersionQuery {
     id: string;
     versionId: string;
 }
+export interface CrdtPushMessageQuery {
+    id: string;
+    data: number[];
+    yjsClientId: number;
+    messageType?: 'sync' | 'awareness';
+    /** User-facing value for event emission only (not stored in database) */
+    eventData?: unknown;
+    /** Yjs data type: 'text' | 'map' | 'array' | 'xml' | 'xmltext' */
+    type?: string;
+    /** Content key used in Y.Doc shared types */
+    contentKey?: string;
+    /** Editor/library source: 'tiptap', 'plate', 'codemirror', etc. */
+    source?: string;
+}
+export interface CrdtOnMessageQuery {
+    id: string;
+    callback: (message: CrdtMessageData) => void;
+    afterTs?: number;
+}
+export interface CrdtMessageData {
+    data: number[];
+    yjsClientId: number;
+    timestamp: number;
+}
+export interface CrdtSnapshotData {
+    state?: Uint8Array | number[];
+    vector?: Uint8Array | number[];
+    timestamp?: number;
+}
+export interface CrdtGetSnapshotQuery {
+    id: string;
+}
+export interface CrdtSaveSnapshotQuery {
+    id: string;
+    state: Uint8Array | number[];
+    vector: Uint8Array | number[];
+    /** Yjs data type: 'text' | 'map' | 'array' | 'xml' | 'xmltext' */
+    type?: string;
+    /** Content key used in Y.Doc shared types */
+    contentKey?: string;
+    /** Editor/library source: 'tiptap', 'plate', 'codemirror', etc. */
+    source?: string;
+}
+export interface CrdtGetMessagesQuery {
+    id: string;
+    afterTs?: number;
+}
+export interface CrdtPruneMessagesQuery {
+    id: string;
+    beforeTs: number;
+}

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
      */
@@ -95,6 +101,46 @@ export declare class CrdtElement {
      * @param time debounce time in milliseconds
      */
     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)
@@ -193,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
      */

package/package.json

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