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

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/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/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/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/app/utils/enums.d.ts

@@ -25,7 +25,10 @@ export declare enum ResolverActions {
     REACTION_ADD = "reaction.add",
     REACTION_DELETE = "reaction.delete",
     ATTACHMENT_ADD = "attachment.add",
-    ATTACHMENT_DELETE = "attachment.delete"
+    ATTACHMENT_DELETE = "attachment.delete",
+    RECORDER_ANNOTATION_ADD = "recorder_annotation.add",
+    RECORDER_ANNOTATION_UPDATE = "recorder_annotation.update",
+    RECORDER_ANNOTATION_DELETE = "recorder_annotation.delete"
 }
 export declare const CommentEventTypes: {
     readonly ADD_COMMENT_ANNOTATION: "addCommentAnnotation";
@@ -87,6 +90,7 @@ export declare const CoreEventTypes: {
     readonly COMMENT_RESOLVER: "commentResolver";
     readonly ATTACHMENT_RESOLVER: "attachmentResolver";
     readonly REACTION_RESOLVER: "reactionResolver";
+    readonly RECORDER_RESOLVER: "recorderResolver";
     readonly VELT_BUTTON_CLICK: "veltButtonClick";
     readonly USER_UPDATE: "userUpdate";
     readonly INIT_UPDATE: "initUpdate";

package/models.d.ts

@@ -72,6 +72,7 @@ export * from './app/models/data/views.data.model';
 export * from './app/models/data/autocomplete.data.model';
 export * from './app/models/data/reaction-annotation.data.model';
 export * from './app/models/data/reaction-resolver.data.model';
+export * from './app/models/data/recorder-resolver.data.model';
 export * from './app/models/data/attachment-resolver.data.model';
 export * from './app/models/data/reaction.data.model';
 export * from './app/models/data/organization-groups.data.model';

package/package.json

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