@veltdev/sdk-staging 5.0.2-beta.7 → 5.0.2-beta.71

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/comment-element.model.d.ts

@@ -291,14 +291,14 @@ export declare class CommentElement {
   public disableStatus: () => any;
 
   /**
-   * To enable visibility option dropdown on comments
+   * To enable visibility options on comments
    */
-  public enableVisibilityOptionDropdown: () => any;
+  public enableVisibilityOptions: () => any;
 
   /**
-   * To disable visibility option dropdown on comments
+   * To disable visibility options on comments
    */
-  public disableVisibilityOptionDropdown: () => any;
+  public disableVisibilityOptions: () => any;
 
   /**
    * To enable feature to show resolve button
@@ -503,6 +503,16 @@ export declare class CommentElement {
    */
   public disableReactions: () => void;
 
+  /**
+   * To enable anonymous email mentions in comments
+   */
+  public enableAnonymousEmail: () => void;
+
+  /**
+   * To disable anonymous email mentions in comments
+   */
+  public disableAnonymousEmail: () => void;
+
   /**
    * To set allowed recordings in comments
    * @param allowedRecordings "all", "none" or "audio", "video", "screen"
@@ -1385,6 +1395,16 @@ export declare class CommentElement {
    */
   public getComposerData: (request: GetComposerDataRequest) => ComposerTextChangeEvent | null;
 
+  /**
+   * To enable pin drag
+   */
+  public enablePinDrag: () => void;
+
+  /**
+   * To disable pin drag
+   */
+  public disablePinDrag: () => void;
+
   constructor();
   /**
    * Subscribe to comments on the current document.
@@ -1626,14 +1646,14 @@ export declare class CommentElement {
   private _disableStatus;
 
   /**
-   * To enable visibility option dropdown on comments
+   * To enable visibility options on comments
    */
-  private _enableVisibilityOptionDropdown;
+  private _enableVisibilityOptions;
 
   /**
-   * To disable visibility option dropdown on comments
+   * To disable visibility options on comments
    */
-  private _disableVisibilityOptionDropdown;
+  private _disableVisibilityOptions;
 
   /**
    * To enable feature to show resolve button
@@ -1834,6 +1854,16 @@ export declare class CommentElement {
    */
   private _disableReactions;
 
+  /**
+   * To enable anonymous email mentions in comments
+   */
+  private _enableAnonymousEmail;
+
+  /**
+   * To disable anonymous email mentions in comments
+   */
+  private _disableAnonymousEmail;
+
   /**
    * To set allowed recordings in comments
    * @param allowedRecordings "all", "none" or "audio", "video", "screen"
@@ -2741,4 +2771,14 @@ export declare class CommentElement {
    * @param type 'dropdown' | 'checkbox'
    */
   private _setAssignToType;
+
+  /**
+   * To enable pin drag
+   */
+  private _enablePinDrag;
+
+  /**
+   * To disable pin drag
+   */
+  private _disablePinDrag;
 }

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/models/element/presence-element.model.d.ts

@@ -50,6 +50,21 @@ export declare class PresenceElement {
      * Subscribe to presence events
      */
     on: <T extends keyof PresenceEventTypesMap>(action: T) => Observable<PresenceEventTypesMap[T]>;
+
+    /**
+     * Add a custom user to the presence list (e.g., an AI agent).
+     * The user will appear in presence alongside real users.
+     * @param request Object containing user data with at least userId required.
+     */
+    addUser: (request: { user: Partial<PresenceUser>, localOnly?: boolean }) => void;
+
+    /**
+     * Remove a previously added custom user from the presence list.
+     * @param request Object containing user data with at least userId required, and optional localOnly flag.
+     * @param request.localOnly If true, user is only removed locally (not removed from DB). Default: false.
+     */
+    removeUser: (request: { user: Partial<PresenceUser>, localOnly?: boolean }) => void;
+
     constructor();
     /**
      * Subscribe to a list of all online users who are either active or inactive on the current document.
@@ -95,4 +110,14 @@ export declare class PresenceElement {
      * Subscribe to presence events
      */
     private _on;
+
+    /**
+     * Add a custom user to the presence list
+     */
+    private _addUser;
+
+    /**
+     * Remove a custom user from the presence list
+     */
+    private _removeUser;
 }

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

@@ -9,6 +9,16 @@ export declare class RewriterElement {
    * To disable rewriter feature
    */
   disableRewriter: () => void;
+
+  /**
+   * To enable the default rewriter UI on text selection
+   */
+  enableDefaultUI: () => void;
+
+  /**
+   * To disable the default rewriter UI on text selection
+   */
+  disableDefaultUI: () => void;
   constructor();
 
   /**
@@ -20,4 +30,14 @@ export declare class RewriterElement {
    * To disable rewriter feature
    */
   private _disableRewriter;
+
+  /**
+   * To enable the default rewriter UI on text selection
+   */
+  private _enableDefaultUI;
+
+  /**
+   * To disable the default rewriter UI on text selection
+   */
+  private _disableDefaultUI;
 }

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

@@ -0,0 +1,180 @@
+// @ts-nocheck
+import { Observable } from "rxjs";
+import { SuggestionEventType } from "../../utils/enums";
+import { SuggestionEventTypesMap } from "../data/suggestion-events.data.model";
+import { CommitSuggestionConfig, EnableSuggestionModeConfig, RegisterTargetConfig, Suggestion, SuggestionGetSuggestionsFilter } from "../data/suggestion.data.model";
+
+export declare class SuggestionElement {
+
+  /**
+   * Turn on suggestion mode for this user/session and (optionally) register
+   * the onTargetEditStart / onTargetEditCommit callbacks the SDK invokes
+   * during the auto-detect edit lifecycle.
+   *
+   * Re-calling with a new config replaces the previous callbacks.
+   */
+  enableSuggestionMode: (config?: EnableSuggestionModeConfig) => void;
+
+  /**
+   * Turn off suggestion mode and clear any registered callbacks.
+   */
+  disableSuggestionMode: () => void;
+
+  /**
+   * Synchronous read of the current enable flag.
+   */
+  isSuggestionModeEnabled: () => boolean;
+
+  /**
+   * Reactive enable-flag stream; deduplicated.
+   */
+  isSuggestionModeEnabled$: () => Observable<boolean>;
+
+  /**
+   * Register a getter that returns the current value of a tagged target.
+   * Required for non-primitive (wrapper) targets — the SDK calls this on
+   * focus to snapshot the pre-edit value, and again on commit for the diff.
+   *
+   * The getter must reflect edit-time state (typically read from the DOM),
+   * not the persisted customer state. See `RegisterTargetConfig`.
+   */
+  registerTarget: <T = unknown>(config: RegisterTargetConfig<T>) => void;
+
+  /**
+   * Drop the registered getter for a target.
+   */
+  unregisterTarget: (targetId: string) => void;
+
+  /**
+   * Manually capture the current value as the snapshot for a target.
+   * Use for non-focusable elements (custom widgets, virtualized rows)
+   * where the auto-focus snapshot does not fire.
+   */
+  startSuggestion: (targetId: string) => void;
+
+  /**
+   * Programmatically commit a suggestion. Resolves with the new annotation id.
+   * Rejects with one of: INVALID_CONFIG, MODE_NOT_SUGGESTING,
+   * TARGET_NOT_REGISTERED, NO_GETTER_FOR_COMPLEX, NO_CHANGE_TO_SUGGEST,
+   * SNAPSHOT_FAILED.
+   */
+  commitSuggestion: <T = unknown>(config: CommitSuggestionConfig<T>) => Promise<{ id: string }>;
+
+  /**
+   * Synchronous read of all suggestions on the current document, optionally filtered.
+   */
+  getSuggestions: (filter?: SuggestionGetSuggestionsFilter) => Suggestion[];
+
+  /**
+   * Reactive variant of getSuggestions. Re-emits on every annotation change,
+   * deduplicated via the SDK's standard distinct-until-changed comparator.
+   */
+  getSuggestions$: (filter?: SuggestionGetSuggestionsFilter) => Observable<Suggestion[]>;
+
+  /**
+   * Newest pending suggestion for a target, or null. Convenience for
+   * pending-overlay UX patterns where each input shows the proposed
+   * value while a suggestion is awaiting resolution.
+   */
+  getPendingSuggestion: <T = unknown>(targetId: string) => Suggestion<T> | null;
+
+  /**
+   * Reactive variant of getPendingSuggestion.
+   */
+  getPendingSuggestion$: <T = unknown>(targetId: string) => Observable<Suggestion<T> | null>;
+
+  /**
+   * Subscribe to a suggestion event. Customers call `.subscribe(handler)`
+   * on the returned Observable. Event names: 'suggestionCreated',
+   * 'suggestionApproved', 'suggestionRejected', 'suggestionStale',
+   * 'targetEditStart', 'targetEditCommit'.
+   */
+  on: <T extends SuggestionEventType>(action: T) => Observable<SuggestionEventTypesMap[T]>;
+
+  constructor();
+
+  /**
+   * Turn on suggestion mode for this user/session and (optionally) register
+   * the onTargetEditStart / onTargetEditCommit callbacks the SDK invokes
+   * during the auto-detect edit lifecycle.
+   *
+   * Re-calling with a new config replaces the previous callbacks.
+   */
+  private _enableSuggestionMode;
+
+  /**
+   * Turn off suggestion mode and clear any registered callbacks.
+   */
+  private _disableSuggestionMode;
+
+  /**
+   * Synchronous read of the current enable flag.
+   */
+  private _isSuggestionModeEnabled;
+
+  /**
+   * Reactive enable-flag stream; deduplicated.
+   */
+  private _isSuggestionModeEnabled$;
+
+  /**
+   * Register a getter that returns the current value of a tagged target.
+   * Required for non-primitive (wrapper) targets — the SDK calls this on
+   * focus to snapshot the pre-edit value, and again on commit for the diff.
+   *
+   * The getter must reflect edit-time state (typically read from the DOM),
+   * not the persisted customer state. See `RegisterTargetConfig`.
+   */
+  private _registerTarget;
+
+  /**
+   * Drop the registered getter for a target.
+   */
+  private _unregisterTarget;
+
+  /**
+   * Manually capture the current value as the snapshot for a target.
+   * Use for non-focusable elements (custom widgets, virtualized rows)
+   * where the auto-focus snapshot does not fire.
+   */
+  private _startSuggestion;
+
+  /**
+   * Programmatically commit a suggestion. Resolves with the new annotation id.
+   * Rejects with one of: INVALID_CONFIG, MODE_NOT_SUGGESTING,
+   * TARGET_NOT_REGISTERED, NO_GETTER_FOR_COMPLEX, NO_CHANGE_TO_SUGGEST,
+   * SNAPSHOT_FAILED.
+   */
+  private _commitSuggestion;
+
+  /**
+   * Synchronous read of all suggestions on the current document, optionally filtered.
+   */
+  private _getSuggestions;
+
+  /**
+   * Reactive variant of getSuggestions. Re-emits on every annotation change,
+   * deduplicated via the SDK's standard distinct-until-changed comparator.
+   */
+  private _getSuggestions$;
+
+  /**
+   * Newest pending suggestion for a target, or null. Convenience for
+   * pending-overlay UX patterns where each input shows the proposed
+   * value while a suggestion is awaiting resolution.
+   */
+  private _getPendingSuggestion;
+
+  /**
+   * Reactive variant of getPendingSuggestion.
+   */
+  private _getPendingSuggestion$;
+
+  /**
+   * Subscribe to a suggestion event. Customers call `.subscribe(handler)`
+   * on the returned Observable. Event names: 'suggestionCreated',
+   * 'suggestionApproved', 'suggestionRejected', 'suggestionStale',
+   * 'targetEditStart', 'targetEditCommit'.
+   */
+  private _on;
+}