@veltdev/sdk 5.0.2-beta.6 → 5.0.2-beta.8

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

@@ -5,6 +5,7 @@ import { DocumentUser } from "../models/data/document-user.data.model";
 import { Location } from "../models/data/location.model";
 import { User, UserOptions, VeltAuthProvider, VeltPermissionProvider } from "../models/data/user.data.model";
 import { CustomCss } from "../models/data/custom-css.data.model";
+import { ActivityElement } from "../models/element/activity-element.model";
 import { AreaElement } from "../models/element/area-element.model";
 import { ArrowElement } from "../models/element/arrow-element.model";
 import { CommentElement } from "../models/element/comment-element.model";
@@ -232,6 +233,10 @@ export declare class Snippyly {
     * Get the Autocomplete Object.
     */
    getAutocompleteElement: () => AutocompleteElement;
+   /**
+    * Get the Activity Element Object.
+    */
+   getActivityElement: () => ActivityElement;
    /**
     * Get the Area Object.
     */

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

@@ -0,0 +1,177 @@
+import { Observable } from 'rxjs';
+import { BaseMetadata } from './base-metadata.data.model';
+import { User } from './user.data.model';
+/**
+ * Feature types that can generate activities.
+ */
+export type ActivityFeatureType = 'comment' | 'reaction' | 'recorder' | 'crdt' | 'custom';
+/**
+ * Comment action type constants following the `entity_type.action` naming pattern.
+ * Annotation-level actions use `comment_annotation.*`, comment-level use `comment.*`.
+ */
+export declare const CommentActivityActionTypes: {
+    readonly ANNOTATION_ADD: "comment_annotation.add";
+    readonly ANNOTATION_DELETE: "comment_annotation.delete";
+    readonly COMMENT_ADD: "comment.add";
+    readonly COMMENT_UPDATE: "comment.update";
+    readonly COMMENT_DELETE: "comment.delete";
+    readonly STATUS_CHANGE: "comment_annotation.status_change";
+    readonly PRIORITY_CHANGE: "comment_annotation.priority_change";
+    readonly ASSIGN: "comment_annotation.assign";
+    readonly ACCESS_MODE_CHANGE: "comment_annotation.access_mode_change";
+    readonly CUSTOM_LIST_CHANGE: "comment_annotation.custom_list_change";
+    readonly APPROVE: "comment_annotation.approve";
+    readonly ACCEPT: "comment.accept";
+    readonly REJECT: "comment.reject";
+    readonly REACTION_ADD: "comment.reaction_add";
+    readonly REACTION_DELETE: "comment.reaction_delete";
+    readonly SUBSCRIBE: "comment_annotation.subscribe";
+    readonly UNSUBSCRIBE: "comment_annotation.unsubscribe";
+};
+export type CommentActivityActionType = typeof CommentActivityActionTypes[keyof typeof CommentActivityActionTypes];
+/**
+ * Recorder action type constants following the `recording.*` naming pattern.
+ */
+export declare const RecorderActivityActionTypes: {
+    readonly RECORDING_ADD: "recording.add";
+    readonly RECORDING_DELETE: "recording.delete";
+};
+export type RecorderActivityActionType = typeof RecorderActivityActionTypes[keyof typeof RecorderActivityActionTypes];
+/**
+ * Reaction action type constants following the `reaction.*` naming pattern.
+ */
+export declare const ReactionActivityActionTypes: {
+    readonly REACTION_ADD: "reaction.add";
+    readonly REACTION_DELETE: "reaction.delete";
+};
+export type ReactionActivityActionType = typeof ReactionActivityActionTypes[keyof typeof ReactionActivityActionTypes];
+/**
+ * CRDT action type constants following the `crdt.*` naming pattern.
+ */
+export declare const CrdtActivityActionTypes: {
+    readonly EDITOR_EDIT: "crdt.editor_edit";
+};
+export type CrdtActivityActionType = typeof CrdtActivityActionTypes[keyof typeof CrdtActivityActionTypes];
+/**
+ * Represents a single from/to change pair.
+ * `from` is always present (null for 'added' events) for uniform structure.
+ */
+export interface ActivityChange<T = unknown> {
+    from?: T | null;
+    to?: T | null;
+}
+/**
+ * Dynamic change tracking. Keys are domain-specific (e.g., 'status', 'commentText', 'assignedTo').
+ * No fixed keys — activities span multiple features.
+ */
+export interface ActivityChanges {
+    [key: string]: ActivityChange | undefined;
+}
+/**
+ * Metadata for activity records. Extends BaseMetadata with denormalized IDs
+ * for efficient querying at the organization level.
+ */
+export declare class ActivityMetadata extends BaseMetadata {
+    [key: string]: any;
+}
+/**
+ * Core activity record representing a single activity event.
+ *
+ * @typeParam TEntity - Type of the parent entity snapshot (e.g., CommentAnnotation)
+ * @typeParam TTarget - Type of the sub-entity snapshot (e.g., Comment)
+ */
+export declare class ActivityRecord<TEntity = unknown, TTarget = unknown> {
+    /** Auto-generated unique ID */
+    id: string;
+    /** Feature that generated this activity */
+    featureType: ActivityFeatureType;
+    /** Action that occurred, following `entity_type.action` pattern */
+    actionType: string;
+    /** Event type that occurred */
+    eventType?: string;
+    /** User who performed the action */
+    actionUser: User;
+    /** Server timestamp (set by backend) */
+    timestamp: number;
+    /** Denormalized IDs for querying */
+    metadata: ActivityMetadata;
+    /** ID of the parent entity (annotationId, recordingId, etc.) */
+    targetEntityId: string;
+    /** ID of the sub-entity acted on (commentId within annotation, null for entity-level actions) */
+    targetSubEntityId?: string | null;
+    /** Linear-style from/to change pairs */
+    changes?: ActivityChanges;
+    /** Full parent entity snapshot at time of action */
+    entityData?: TEntity;
+    /** Sub-entity snapshot (or user-provided data for custom activities) */
+    entityTargetData?: TTarget;
+    /** Display message template — ONLY for custom activities */
+    displayMessageTemplate?: string;
+    /** Template variable values — ONLY for custom activities */
+    displayMessageTemplateData?: Record<string, unknown>;
+    /** Computed display message (generated client-side, never stored in Firestore) */
+    displayMessage?: string;
+    /** Icon URL or identifier for display */
+    actionIcon?: string;
+    /** If true, this activity cannot be updated or deleted via REST API */
+    immutable?: boolean;
+}
+/**
+ * Configuration for subscribing to activities.
+ * Behavior is determined by the props passed:
+ * - No config → org-wide
+ * - documentIds → specific documents
+ * - currentDocumentOnly → current document only
+ */
+export interface ActivitySubscribeConfig {
+    /** Subscribe to activities for a specific organization (defaults to current org) */
+    organizationId?: string;
+    /** Subscribe to activities for specific document IDs */
+    documentIds?: string[];
+    /** Subscribe to activities for the current document only (auto-switches on setDocument) */
+    currentDocumentOnly?: boolean;
+    /** Only fetch activities from the last N days (default: 30) */
+    maxDays?: number;
+    /** Allowlist: only include activities with these feature types */
+    featureTypes?: ActivityFeatureType[];
+    /** Disallowlist: exclude activities with these feature types (ignored if featureTypes is set) */
+    excludeFeatureTypes?: ActivityFeatureType[];
+    /** Allowlist: only include activities with these action types */
+    actionTypes?: string[];
+    /** Disallowlist: exclude activities with these action types (ignored if actionTypes is set) */
+    excludeActionTypes?: string[];
+    /** Allowlist: only include activities by these user IDs */
+    userIds?: string[];
+    /** Disallowlist: exclude activities by these user IDs (ignored if userIds is set) */
+    excludeUserIds?: string[];
+}
+/**
+ * Represents an active activity subscription.
+ * Returned by `activityService.subscribe()`.
+ */
+export interface ActivitySubscription {
+    /** Observable stream of activities for this subscription's scope. null = not yet loaded. */
+    getActivities$(): Observable<ActivityRecord[] | null>;
+    /** Unsubscribe and clean up this subscription */
+    unsubscribe(): void;
+}
+/**
+ * Data required to create an activity.
+ * Used for all activity types: comment, reaction, recorder, custom, etc.
+ */
+export interface CreateActivityData<TEntity = unknown, TTarget = unknown> {
+    featureType: ActivityFeatureType;
+    actionType: string;
+    eventType?: string;
+    targetEntityId: string;
+    targetSubEntityId?: string | null;
+    changes?: ActivityChanges;
+    entityData?: TEntity;
+    entityTargetData?: TTarget;
+    /** Icon URL or identifier — typically used for custom activities */
+    actionIcon?: string;
+    /** Display message template — only for custom activities */
+    displayMessageTemplate?: string;
+    /** Template variable values — only for custom activities */
+    displayMessageTemplateData?: Record<string, unknown>;
+}

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

@@ -1,8 +1,8 @@
 import { ResolverActions } from "../../utils/enums";
 import { ResolverConfig, ResolverResponse } from "./resolver.data.model";
 export interface AttachmentDataProvider {
-    save: (request: SaveAttachmentResolverRequest) => Promise<ResolverResponse<SaveAttachmentResolverData>>;
-    delete: (request: DeleteAttachmentResolverRequest) => Promise<ResolverResponse<undefined>>;
+    save?: (request: SaveAttachmentResolverRequest) => Promise<ResolverResponse<SaveAttachmentResolverData>>;
+    delete?: (request: DeleteAttachmentResolverRequest) => Promise<ResolverResponse<undefined>>;
     config?: ResolverConfig;
 }
 export interface DeleteAttachmentResolverRequest {

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

@@ -53,6 +53,7 @@ export interface UploadFileOptions {
     file: File;
     useAttachmentResolver?: boolean;
     metadata?: any;
+    attachmentScope?: string;
 }
 export interface UploadFileData {
     files: File[];

package/app/models/data/base-metadata.data.model.d.ts

@@ -1,3 +1,4 @@
+import { DocumentMetadata } from './document-metadata.model';
 export declare class BaseMetadata {
     apiKey?: string;
     documentId?: string;
@@ -6,4 +7,6 @@ export declare class BaseMetadata {
     clientOrganizationId?: string;
     folderId?: string;
     veltFolderId?: string;
+    documentMetadata?: DocumentMetadata;
+    sdkVersion?: string | null;
 }

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

@@ -4,9 +4,9 @@ import { BaseMetadata } from "./base-metadata.data.model";
 import { CommentAnnotation } from "./comment-annotation.data.model";
 import { ResolverConfig, ResolverResponse } from "./resolver.data.model";
 export interface CommentAnnotationDataProvider {
-    get: (request: GetCommentResolverRequest) => Promise<ResolverResponse<Record<string, PartialCommentAnnotation>>>;
-    save: (request: SaveCommentResolverRequest) => Promise<ResolverResponse<undefined>>;
-    delete: (request: DeleteCommentResolverRequest) => Promise<ResolverResponse<undefined>>;
+    get?: (request: GetCommentResolverRequest) => Promise<ResolverResponse<Record<string, PartialCommentAnnotation>>>;
+    save?: (request: SaveCommentResolverRequest) => Promise<ResolverResponse<undefined>>;
+    delete?: (request: DeleteCommentResolverRequest) => Promise<ResolverResponse<undefined>>;
     config?: ResolverConfig;
 }
 export interface GetCommentResolverRequest {

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

@@ -76,4 +76,9 @@ export interface DisableLogsConfig {
 }
 export interface GetProjectConfigResponse {
     isPrivateCommentsEnabled: boolean;
+    activityConfig?: ActivityConfig;
+}
+export interface ActivityConfig {
+    immutable: boolean;
+    isEnabled: boolean;
 }

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

@@ -7,6 +7,7 @@ export type CoreEventTypesMap = {
     [CoreEventTypes.COMMENT_RESOLVER]: CommentResolverEvent;
     [CoreEventTypes.ATTACHMENT_RESOLVER]: AttachmentResolverEvent;
     [CoreEventTypes.REACTION_RESOLVER]: ReactionResolverEvent;
+    [CoreEventTypes.RECORDER_RESOLVER]: RecorderResolverEvent;
     [CoreEventTypes.VELT_BUTTON_CLICK]: VeltButtonClickEvent;
     [CoreEventTypes.USER_UPDATE]: UserUpdateEvent;
     [CoreEventTypes.DOCUMENT_INIT]: DocumentInitEvent;
@@ -147,6 +148,35 @@ export type ReactionResolverEventType = {
     REACTION_DELETE_RESULT: 'reactionDeleteResult';
     REACTION_DELETE_ERROR: 'reactionDeleteError';
 };
+export declare enum RecorderResolverSource {
+    RESOLVE_RECORDER_ANNOTATIONS = "resolveRecorderAnnotations",
+    SAVE_RECORDER_ANNOTATION = "saveRecorderAnnotation",
+    DELETE_RECORDER_ANNOTATION = "deleteRecorderAnnotation",
+    FORMAT_RESPONSE = "formatResponse",
+    INIT_DOCUMENTS = "initDocuments",
+    SET_DATA = "setData",
+    UPDATE_DATA = "updateData",
+    DELETE_DATA = "deleteData"
+}
+export declare enum RecorderResolverModuleName {
+    GET_RECORDER_ANNOTATIONS = "getRecorderAnnotations"
+}
+export type RecorderResolverEvent = BaseResolverEvent<RecorderResolverEventType, RecorderResolverSource, RecorderResolverModuleName>;
+export type RecorderResolverEventType = {
+    RECORDER_RESOLUTION_REQUEST_FORMED: 'recorderResolutionRequestFormed';
+    RECORDER_RESOLUTION_REQUEST_TRIGGERED: 'recorderResolutionRequestTriggered';
+    RECORDER_RESOLUTION_RESULT: 'recorderResolutionResult';
+    RECORDER_RESOLUTION_ERROR: 'recorderResolutionError';
+    RECORDER_RESOLUTION_RESULT_FROM_CACHE: 'recorderResolutionResultFromCache';
+    RECORDER_SAVE_REQUEST_FORMED: 'recorderSaveRequestFormed';
+    RECORDER_SAVE_REQUEST_TRIGGERED: 'recorderSaveRequestTriggered';
+    RECORDER_SAVE_RESULT: 'recorderSaveResult';
+    RECORDER_SAVE_ERROR: 'recorderSaveError';
+    RECORDER_DELETE_REQUEST_FORMED: 'recorderDeleteRequestFormed';
+    RECORDER_DELETE_REQUEST_TRIGGERED: 'recorderDeleteRequestTriggered';
+    RECORDER_DELETE_RESULT: 'recorderDeleteResult';
+    RECORDER_DELETE_ERROR: 'recorderDeleteError';
+};
 export type ErrorEvent = {
     event?: string;
     sourceMethod?: string;

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/data/provider.data.model.d.ts

@@ -1,6 +1,7 @@
 import { CommentAnnotationDataProvider } from "./comment-resolver.data.model";
 import { AttachmentDataProvider } from "./attachment-resolver.data.model";
 import { ReactionAnnotationDataProvider } from "./reaction-resolver.data.model";
+import { RecorderAnnotationDataProvider } from "./recorder-resolver.data.model";
 import { AnonymousUserDataProvider, UserDataProvider } from "./user-resolver.data.model";
 export interface VeltDataProvider {
     comment?: CommentAnnotationDataProvider;
@@ -8,4 +9,5 @@ export interface VeltDataProvider {
     reaction?: ReactionAnnotationDataProvider;
     attachment?: AttachmentDataProvider;
     anonymousUser?: AnonymousUserDataProvider;
+    recorder?: RecorderAnnotationDataProvider;
 }

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

@@ -4,9 +4,9 @@ import { PartialUser } from "./comment-resolver.data.model";
 import { ReactionAnnotation } from "./reaction-annotation.data.model";
 import { ResolverConfig, ResolverResponse } from "./resolver.data.model";
 export interface ReactionAnnotationDataProvider {
-    get: (request: GetReactionResolverRequest) => Promise<ResolverResponse<Record<string, PartialReactionAnnotation>>>;
-    save: (request: SaveReactionResolverRequest) => Promise<ResolverResponse<undefined>>;
-    delete: (request: DeleteReactionResolverRequest) => Promise<ResolverResponse<undefined>>;
+    get?: (request: GetReactionResolverRequest) => Promise<ResolverResponse<Record<string, PartialReactionAnnotation>>>;
+    save?: (request: SaveReactionResolverRequest) => Promise<ResolverResponse<undefined>>;
+    delete?: (request: DeleteReactionResolverRequest) => Promise<ResolverResponse<undefined>>;
     config?: ResolverConfig;
 }
 export interface GetReactionResolverRequest {

package/app/models/data/recorder-annotation.data.model.d.ts

@@ -150,6 +150,17 @@ export declare class RecorderAnnotation {
     chunkUrls?: {
         [key: number]: string;
     };
+    /**
+     * Whether the recorder resolver is used for this annotation.
+     * Used by UI components to show loading states while resolver data is being fetched.
+     */
+    isRecorderResolverUsed?: boolean;
+    /**
+     * Whether the real recording URL is available.
+     * Set to false when the annotation is first saved (URL is still a local blob),
+     * and true once the actual URL from storage is available after the async upload completes.
+     */
+    isUrlAvailable?: boolean;
 }
 export interface RecorderAnnotationEditVersion {
     from?: User;

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

@@ -0,0 +1,58 @@
+import { ResolverActions } from "../../utils/enums";
+import { AttachmentDataProvider } from "./attachment-resolver.data.model";
+import { BaseMetadata } from "./base-metadata.data.model";
+import { RecorderAnnotation } from "./recorder-annotation.data.model";
+import { ResolverConfig, ResolverResponse } from "./resolver.data.model";
+import { Attachment } from "./attachment.model";
+import { Transcription } from "./transcription.data.model";
+import { User } from "./user.data.model";
+export interface RecorderAnnotationDataProvider {
+    get?: (request: GetRecorderResolverRequest) => Promise<ResolverResponse<Record<string, PartialRecorderAnnotation>>>;
+    save?: (request: SaveRecorderResolverRequest) => Promise<ResolverResponse<SaveRecorderResolverData | undefined>>;
+    delete?: (request: DeleteRecorderResolverRequest) => Promise<ResolverResponse<undefined>>;
+    config?: ResolverConfig;
+    uploadChunks?: boolean;
+    storage?: AttachmentDataProvider;
+}
+export interface GetRecorderResolverRequest {
+    organizationId: string;
+    recorderAnnotationIds?: string[];
+    documentIds?: string[];
+}
+export interface SaveRecorderResolverRequest {
+    recorderAnnotation: Record<string, PartialRecorderAnnotation>;
+    event?: ResolverActions;
+    metadata?: BaseMetadata;
+}
+export interface SaveRecorderResolverData {
+    transcription?: Transcription;
+    attachment?: Attachment | null;
+    attachments?: Attachment[];
+}
+export interface DeleteRecorderResolverRequest {
+    recorderAnnotationId: string;
+    metadata?: BaseMetadata;
+    event?: ResolverActions;
+}
+export interface PartialRecorderAnnotation {
+    annotationId: string;
+    metadata?: BaseMetadata;
+    from?: User;
+    transcription?: Transcription;
+    attachment?: Attachment | null;
+    attachments?: Attachment[];
+    chunkUrls?: Record<number, string>;
+    recordingEditVersions?: Record<number, PartialRecorderAnnotationEditVersion>;
+    [key: string]: any;
+}
+export interface PartialRecorderAnnotationEditVersion {
+    from?: User;
+    attachment?: Attachment | null;
+    attachments?: Attachment[];
+    transcription?: Transcription;
+}
+export interface PartialRecorderAnnotationResult {
+    strippedData: Record<string, PartialRecorderAnnotation> | null;
+    originalData: RecorderAnnotation | null;
+    eventType?: ResolverActions;
+}

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

@@ -9,6 +9,7 @@ export interface ResolverConfig {
     getRetryConfig?: RetryConfig;
     resolveUsersConfig?: ResolveUsersConfig;
     fieldsToRemove?: string[];
+    additionalFields?: string[];
     getConfig?: ResolverEndpointConfig;
     saveConfig?: ResolverEndpointConfig;
     deleteConfig?: ResolverEndpointConfig;

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

@@ -0,0 +1,33 @@
+// @ts-nocheck
+import { Observable } from "rxjs";
+import { ActivityRecord, ActivitySubscribeConfig, CreateActivityData } from "../data/activity.data.model";
+
+export declare class ActivityElement {
+
+    /**
+     * Subscribe to activities with optional filtering configuration.
+     * Returns an Observable that, when unsubscribed, automatically cleans up the internal subscription.
+     * @param config Optional configuration to filter activities by scope, feature types, action types, etc.
+     * @returns Observable<ActivityRecord[] | null>
+     */
+    getAllActivities: (config?: ActivitySubscribeConfig) => Observable<ActivityRecord[] | null>;
+
+    /**
+     * Create a new activity record.
+     * @param data The activity data including feature type, action type, target entity, etc.
+     * @returns Promise<void>
+     */
+    createActivity: (data: CreateActivityData) => Promise<void>;
+
+    constructor();
+
+    /**
+     * Subscribe to activities with optional filtering configuration.
+     */
+    private _getAllActivities;
+
+    /**
+     * Create a new activity record.
+     */
+    private _createActivity;
+}

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;